diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Examples/code_examples_overlay.yaml b/docs/tools/sdk/powershell/Reference/Beta/docs/Examples/code_examples_overlay.yaml new file mode 100644 index 000000000..1d0dec385 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Examples/code_examples_overlay.yaml @@ -0,0 +1,14573 @@ +- path: /access-model-metadata/attributes/{key} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Key = "iscPrivacy" # String | Technical name of the Attribute. + + # Get Access Model Metadata Attribute + + try { + Get-BetaAccessModelMetadataAttribute-BetaKey $Key + + # Below is a request that includes all optional parameters + # Get-BetaAccessModelMetadataAttribute -BetaKey $Key + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute" + Write-Host $_.ErrorDetails + } +- path: /access-model-metadata/attributes/{key}/values/{value} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Key = "iscPrivacy" # String | Technical name of the Attribute. + $Value = "public" # String | Technical name of the Attribute value. + + # Get Access Model Metadata Value + + try { + Get-BetaAccessModelMetadataAttributeValue-BetaKey $Key -BetaValue $Value + + # Below is a request that includes all optional parameters + # Get-BetaAccessModelMetadataAttributeValue -BetaKey $Key -BetaValue $Value + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue" + Write-Host $_.ErrorDetails + } +- path: /access-model-metadata/attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "name eq "Privacy"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) + + # List Access Model Metadata Attributes + + try { + Get-BetaAccessModelMetadataAttribute + + # Below is a request that includes all optional parameters + # Get-BetaAccessModelMetadataAttribute -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute" + Write-Host $_.ErrorDetails + } +- path: /access-model-metadata/attributes/{key}/values + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Key = "iscPrivacy" # String | Technical name of the Attribute. + + # List Access Model Metadata Values + + try { + Get-BetaAccessModelMetadataAttributeValue-BetaKey $Key + + # Below is a request that includes all optional parameters + # Get-BetaAccessModelMetadataAttributeValue -BetaKey $Key + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue" + Write-Host $_.ErrorDetails + } +- path: /access-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessProfile = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "description" : "Collection of entitlements to read/write the employee database", + "source" : { + "name" : "ODS-AD-SOURCE", + "id" : "2c91809773dee3610173fdb0b6061ef4", + "type" : "SOURCE" + }, + "enabled" : true, + "revocationRequestConfig" : { + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ] + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "accessRequestConfig" : { + "commentsRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "name" : "Employee-database-read-write", + "provisioningCriteria" : { + "children" : [ { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, + "modified" : "2021-03-02T20:22:28.104Z", + "id" : "2c91808a7190d06e01719938fcd20792", + "requestable" : true + } + "@ + + # Create Access Profile + + try { + $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile + New-BetaAccessProfile-BetaAccessProfile $Result + + # Below is a request that includes all optional parameters + # New-BetaAccessProfile -BetaAccessProfile $AccessProfile + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete + + # Delete the specified Access Profile + + try { + Remove-BetaAccessProfile-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaAccessProfile -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessProfileBulkDeleteRequest = @" + { + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + } + "@ + + # Delete Access Profile(s) + + try { + $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest + Remove-BetaAccessProfilesInBulk-BetaAccessProfileBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaAccessProfilesInBulk -BetaAccessProfileBulkDeleteRequest $AccessProfileBulkDeleteRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfilesInBulk" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile + + # Get an Access Profile + + try { + Get-BetaAccessProfile-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccessProfile -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + + # List Access Profile's Entitlements + + try { + Get-BetaAccessProfileEntitlements-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccessProfileEntitlements -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfileEntitlements" + Write-Host $_.ErrorDetails + } +- path: /access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin. (optional) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + + # List Access Profiles + + try { + Get-BetaAccessProfiles + + # Below is a request that includes all optional parameters + # Get-BetaAccessProfiles -BetaForSubadmin $ForSubadmin -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -BetaForSegmentIds $ForSegmentIds -BetaIncludeUnsegmented $IncludeUnsegmented + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfiles" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Access Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaAccessProfile-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaAccessProfile -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/bulk-update-requestable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ + + + # Update Access Profile(s) requestable field. + + try { + $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner + Update-BetaAccessProfilesInBulk-BetaAccessProfileBulkUpdateRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaAccessProfilesInBulk -BetaAccessProfileBulkUpdateRequestInner $AccessProfileBulkUpdateRequestInner + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccessProfilesInBulk" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "author" : { + "name" : "Adam Kennedy", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2017-07-11T18:45:37.098Z", + "comment" : "This is a comment." + } + "@ + + # Approve Access Request Approval + + try { + $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto + Approve-BetaAccessRequest-BetaApprovalId $ApprovalId -BetaCommentDto $Result + + # Below is a request that includes all optional parameters + # Approve-BetaAccessRequest -BetaApprovalId $ApprovalId -BetaCommentDto $CommentDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $ForwardApprovalDto = @" + { + "newOwnerId" : "newOwnerId", + "comment" : "comment" + } + "@ + + # Forward Access Request Approval + + try { + $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto + Invoke-BetaForwardAccessRequest-BetaApprovalId $ApprovalId -BetaForwardApprovalDto $Result + + # Below is a request that includes all optional parameters + # Invoke-BetaForwardAccessRequest -BetaApprovalId $ApprovalId -BetaForwardApprovalDto $ForwardApprovalDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/approval-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + + # Get Access Requests Approvals Number + + try { + Get-BetaAccessRequestApprovalSummary + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestApprovalSummary -BetaOwnerId $OwnerId -BetaFromDate $FromDate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestApprovalSummary" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "MyOwnerId" # String | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Completed Access Request Approvals List + + try { + Get-BetaCompletedApprovals + + # Below is a request that includes all optional parameters + # Get-BetaCompletedApprovals -BetaOwnerId $OwnerId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedApprovals" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/pending + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "MyOwnerId" # String | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional) + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Pending Access Request Approvals List + + try { + Get-BetaPendingApprovals + + # Below is a request that includes all optional parameters + # Get-BetaPendingApprovals -BetaOwnerId $OwnerId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingApprovals" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/reject + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "author" : { + "name" : "Adam Kennedy", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2017-07-11T18:45:37.098Z", + "comment" : "This is a comment." + } + "@ + + # Reject Access Request Approval + + try { + $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto + Deny-BetaAccessRequest-BetaApprovalId $ApprovalId -BetaCommentDto $Result + + # Below is a request that includes all optional parameters + # Deny-BetaAccessRequest -BetaApprovalId $ApprovalId -BetaCommentDto $CommentDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID. + $RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID. + $Type = "ENTITLEMENT" # String | Requested access item's type. + + # Return access request identity metrics + + try { + Get-BetaAccessRequestIdentityMetrics-BetaIdentityId $IdentityId -BetaRequestedObjectId $RequestedObjectId -BetaType $Type + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestIdentityMetrics -BetaIdentityId $IdentityId -BetaRequestedObjectId $RequestedObjectId -BetaType $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestIdentityMetrics" + Write-Host $_.ErrorDetails + } +- path: /access-requests/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CancelAccessRequest = @" + { + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + } + "@ + + # Cancel Access Request + + try { + $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest + Suspend-BetaAccessRequest-BetaCancelAccessRequest $Result + + # Below is a request that includes all optional parameters + # Suspend-BetaAccessRequest -BetaCancelAccessRequest $CancelAccessRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-requests/close + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CloseAccessRequest = @" + { + "executionStatus" : "Terminated", + "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "completionStatus" : "Failure", + "message" : "The IdentityNow Administrator manually closed this request." + } + "@ + + # Close Access Request + + try { + $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest + Close-BetaAccessRequest-BetaCloseAccessRequest $Result + + # Below is a request that includes all optional parameters + # Close-BetaAccessRequest -BetaCloseAccessRequest $CloseAccessRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-BetaAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessRequest = @" + { + "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + } ] + } + "@ + + # Submit Access Request + + try { + $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest + New-BetaAccessRequest-BetaAccessRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaAccessRequest -BetaAccessRequest $AccessRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Access Request Configuration + + try { + Get-BetaAccessRequestConfig + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /access-request-status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) + $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) + $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + $Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) + $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + # Access Request Status + + try { + Get-BetaAccessRequestStatus + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestStatus -BetaRequestedFor $RequestedFor -BetaRequestedBy $RequestedBy -BetaRegardingIdentity $RegardingIdentity -BetaAssignedTo $AssignedTo -BetaCount $Count -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters -BetaSorters $Sorters -BetaRequestState $RequestState + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestStatus" + Write-Host $_.ErrorDetails + } +- path: /access-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessRequestConfig = @" + { + "requestOnBehalfOfConfig" : { + "allowRequestOnBehalfOfEmployeeByManager" : true, + "allowRequestOnBehalfOfAnyoneByAnyone" : true + }, + "approvalReminderAndEscalationConfig" : { + "fallbackApproverRef" : { + "name" : "Alison Ferguso", + "id" : "5168015d32f890ca15812c9180835d2e", + "type" : "IDENTITY", + "email" : "alison.ferguso@identitysoon.com" + }, + "maxReminders" : 1, + "daysUntilEscalation" : 0, + "daysBetweenReminders" : 0 + }, + "autoApprovalEnabled" : true, + "entitlementRequestConfig" : { + "requestCommentsRequired" : false, + "deniedCommentsRequired" : false, + "allowEntitlementRequest" : true, + "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + }, + "reauthorizationEnabled" : true, + "approvalsMustBeExternal" : true + } + "@ + + # Update Access Request Configuration + + try { + $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig + Set-BetaAccessRequestConfig-BetaAccessRequestConfig $Result + + # Below is a request that includes all optional parameters + # Set-BetaAccessRequestConfig -BetaAccessRequestConfig $AccessRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaAccessRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /account-activities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id + + # Get Account Activity + + try { + Get-BetaAccountActivity-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccountActivity -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountActivity" + Write-Host $_.ErrorDetails + } +- path: /account-activities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "MyRequestedFor" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "MyRequestedBy" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "MyRegardingIdentity" # String | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + $Type = "MyType" # String | The type of account activity. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) + + # List Account Activities + + try { + Get-BetaAccountActivities + + # Below is a request that includes all optional parameters + # Get-BetaAccountActivities -BetaRequestedFor $RequestedFor -BetaRequestedBy $RequestedBy -BetaRegardingIdentity $RegardingIdentity -BetaType $Type -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountActivities" + Write-Host $_.ErrorDetails + } +- path: /account-aggregations/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id + + # In-progress Account Aggregation status + + try { + Get-BetaAccountAggregationStatus-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccountAggregationStatus -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountAggregationStatus" + Write-Host $_.ErrorDetails + } +- path: /accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccountAttributesCreate = @" + { + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Create Account + + try { + $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate + New-BetaAccount-BetaAccountAttributesCreate $Result + + # Below is a request that includes all optional parameters + # New-BetaAccount -BetaAccountAttributesCreate $AccountAttributesCreate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Delete Account + + try { + Remove-BetaAccount-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaAccount -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id + + # Remove Account + + try { + Remove-BetaAccountAsync-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaAccountAsync -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccountAsync" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Disable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Disable-BetaAccount-BetaId $Id -BetaAccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Disable-BetaAccount -BetaId $Id -BetaAccountToggleRequest $AccountToggleRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccount" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/{id}/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808384203c2d018437e631158309" # String | The identity id. + + # Disable IDN Account for Identity + + try { + Disable-BetaAccountForIdentity-BetaId $Id + + # Below is a request that includes all optional parameters + # Disable-BetaAccountForIdentity -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccountForIdentity" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentitiesAccountsBulkRequest = @" + { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } + "@ + + # Disable IDN Accounts for Identities + + try { + $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest + Disable-BetaAccountsForIdentities-BetaIdentitiesAccountsBulkRequest $Result + + # Below is a request that includes all optional parameters + # Disable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccountsForIdentities" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Enable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Enable-BetaAccount-BetaId $Id -BetaAccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Enable-BetaAccount -BetaId $Id -BetaAccountToggleRequest $AccountToggleRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccount" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/{id}/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808384203c2d018437e631158309" # String | The identity id. + + # Enable IDN Account for Identity + + try { + Enable-BetaAccountForIdentity-BetaId $Id + + # Below is a request that includes all optional parameters + # Enable-BetaAccountForIdentity -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccountForIdentity" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentitiesAccountsBulkRequest = @" + { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } + "@ + + # Enable IDN Accounts for Identities + + try { + $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest + Enable-BetaAccountsForIdentities-BetaIdentitiesAccountsBulkRequest $Result + + # Below is a request that includes all optional parameters + # Enable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccountsForIdentities" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Account Details + + try { + Get-BetaAccount-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccount -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Account Entitlements + + try { + Get-BetaAccountEntitlements-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccountEntitlements -BetaId $Id -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountEntitlements" + Write-Host $_.ErrorDetails + } +- path: /accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + + # Accounts List + + try { + Get-BetaAccounts + + # Below is a request that includes all optional parameters + # Get-BetaAccounts -BetaDetailLevel $DetailLevel -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccounts" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $AccountAttributes = @" + { + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Update Account + + try { + $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes + Send-BetaAccount-BetaId $Id -BetaAccountAttributes $Result + + # Below is a request that includes all optional parameters + # Send-BetaAccount -BetaId $Id -BetaAccountAttributes $AccountAttributes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/reload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + + # Reload Account + + try { + Submit-BetaReloadAccount-BetaId $Id + + # Below is a request that includes all optional parameters + # Submit-BetaReloadAccount -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaReloadAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/unlock + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. + $AccountUnlockRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + } + "@ + + # Unlock Account + + try { + $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest + Unlock-BetaAccount-BetaId $Id -BetaAccountUnlockRequest $Result + + # Below is a request that includes all optional parameters + # Unlock-BetaAccount -BetaId $Id -BetaAccountUnlockRequest $AccountUnlockRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-BetaAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"{Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}}"@ + + + # Update Account + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaAccount-BetaId $Id -BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaAccount -BetaId $Id -BetaRequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccount" + Write-Host $_.ErrorDetails + } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-BetaUsagesByAccountId-BetaAccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-BetaUsagesByAccountId -BetaAccountId $AccountId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesByAccountId" + Write-Host $_.ErrorDetails + } +- path: /discovered-applications/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID. + + # Get Discovered Application by ID + + try { + Get-BetaDiscoveredApplicationByID-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaDiscoveredApplicationByID -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDiscoveredApplicationByID" + Write-Host $_.ErrorDetails + } +- path: /discovered-applications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) + $Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) + + # Retrieve discovered applications for tenant + + try { + Get-BetaDiscoveredApplications + + # Below is a request that includes all optional parameters + # Get-BetaDiscoveredApplications -BetaLimit $Limit -BetaOffset $Offset -BetaDetail $Detail -BetaFilter $Filter -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDiscoveredApplications" + Write-Host $_.ErrorDetails + } +- path: /manual-discover-applications-template + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Download CSV Template for Discovery + + try { + Get-BetaManualDiscoverApplicationsCsvTemplate + + # Below is a request that includes all optional parameters + # Get-BetaManualDiscoverApplicationsCsvTemplate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } +- path: /discovered-applications/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID. + $JsonPatchOperations = @"{ + "op" : "replace", + "path" : "/dismissed", + "value" : true + }"@ + + + # Patch Discovered Application by ID + + try { + Update-BetaDiscoveredApplicationByID-BetaId $Id + + # Below is a request that includes all optional parameters + # Update-BetaDiscoveredApplicationByID -BetaId $Id -BetaJsonPatchOperations $JsonPatchOperations + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaDiscoveredApplicationByID" + Write-Host $_.ErrorDetails + } +- path: /manual-discover-applications + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + + # Upload CSV to Discover Applications + + try { + Send-BetaManualDiscoverApplicationsCsvTemplate-BetaFile $File + + # Below is a request that includes all optional parameters + # Send-BetaManualDiscoverApplicationsCsvTemplate -BetaFile $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } +- path: /generic-approvals/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that to be returned. + + # Get Approval + + try { + Get-BetaApproval-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaApproval -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaApproval" + Write-Host $_.ErrorDetails + } +- path: /generic-approvals + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Mine = $true # Boolean | Returns the list of approvals for the current caller. (optional) + $RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID. (optional) + $Filters = "filters=status eq PENDING" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* (optional) + + # Get Approvals + + try { + Get-BetaApprovals + + # Below is a request that includes all optional parameters + # Get-BetaApprovals -BetaMine $Mine -BetaRequesterId $RequesterId -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaApprovals" + Write-Host $_.ErrorDetails + } +- path: /source-apps + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceAppCreateDto = @" + { + "name" : "my app", + "description" : "the source app for engineers", + "accountSource" : { + "name" : "ODS-AD-Source", + "id" : "2c9180827ca885d7017ca8ce28a000eb", + "type" : "SOURCE" + }, + "matchAllAccounts" : true + } + "@ + + # Create source app + + try { + $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto + New-BetaSourceApp-BetaSourceAppCreateDto $Result + + # Below is a request that includes all optional parameters + # New-BetaSourceApp -BetaSourceAppCreateDto $SourceAppCreateDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id}/access-profiles/bulk-remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ + + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + + # Bulk remove access profiles from the specified source app + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-BetaAccessProfilesFromSourceAppByBulk-BetaId $Id -BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-BetaAccessProfilesFromSourceAppByBulk -BetaId $Id -BetaRequestBody $RequestBody -BetaLimit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfilesFromSourceAppByBulk" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. + + # Delete source app by ID + + try { + Remove-BetaSourceApp-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSourceApp -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + + # Get source app by ID + + try { + Get-BetaSourceApp-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSourceApp -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id}/access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "name eq "developer access profile"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + # List access profiles for the specified source app + + try { + Get-BetaAccessProfilesForSourceApp-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccessProfilesForSourceApp -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfilesForSourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/all + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) + $Filters = "enabled eq true" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) + + # List all source apps + + try { + Get-BetaAllSourceApp + + # Below is a request that includes all optional parameters + # Get-BetaAllSourceApp -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllSourceApp" + Write-Host $_.ErrorDetails + } +- path: /user-apps/all + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List all user apps + + try { + Get-BetaAllUserApps-BetaFilters $Filters + + # Below is a request that includes all optional parameters + # Get-BetaAllUserApps -BetaFilters $Filters -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllUserApps" + Write-Host $_.ErrorDetails + } +- path: /source-apps/assigned + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (optional) + $Filters = "name eq "source app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + # List assigned source apps + + try { + Get-BetaAssignedSourceApp + + # Below is a request that includes all optional parameters + # Get-BetaAssignedSourceApp -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAssignedSourceApp" + Write-Host $_.ErrorDetails + } +- path: /user-apps/{id}/available-accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List available accounts for user app + + try { + Get-BetaAvailableAccountsForUserApp-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaAvailableAccountsForUserApp -BetaId $Id -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAvailableAccountsForUserApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) + $Filters = "name eq "source app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + # List available source apps + + try { + Get-BetaAvailableSourceApps + + # Below is a request that includes all optional parameters + # Get-BetaAvailableSourceApps -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAvailableSourceApps" + Write-Host $_.ErrorDetails + } +- path: /user-apps + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) + + # List owned user apps + + try { + Get-BetaOwnedUserApps + + # Below is a request that includes all optional parameters + # Get-BetaOwnedUserApps -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOwnedUserApps" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch source app by ID + + try { + Update-BetaSourceApp-BetaId $Id + + # Below is a request that includes all optional parameters + # Update-BetaSourceApp -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceApp" + Write-Host $_.ErrorDetails + } +- path: /user-apps/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch user app by ID + + try { + Update-BetaUserApp-BetaId $Id + + # Below is a request that includes all optional parameters + # Update-BetaUserApp -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaUserApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceAppBulkUpdateRequest = @" + { + "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : false + }, { + "op" : "replace", + "path" : "/matchAllAccounts", + "value" : false + } ] + } + "@ + + # Bulk update source apps + + try { + Update-BetaSourceAppsInBulk + + # Below is a request that includes all optional parameters + # Update-BetaSourceAppsInBulk -BetaSourceAppBulkUpdateRequest $SourceAppBulkUpdateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceAppsInBulk" + Write-Host $_.ErrorDetails + } +- path: /auth-profiles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to get. + + # Get Auth Profile. + + try { + Get-BetaProfileConfig-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaProfileConfig -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProfileConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get list of Auth Profiles. + + try { + Get-BetaProfileConfigList + + # Below is a request that includes all optional parameters + # Get-BetaProfileConfigList + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProfileConfigList" + Write-Host $_.ErrorDetails + } +- path: /auth-profiles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Auth Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaProfileConfig-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaProfileConfig -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProfileConfig" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/complete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $CompleteCampaignOptions = @" + { + "autoCompleteAction" : "REVOKE" + } + "@ + + # Complete a Campaign + + try { + Complete-BetaCampaign-BetaId $Id + + # Below is a request that includes all optional parameters + # Complete-BetaCampaign -BetaId $Id -BetaCompleteCampaignOptions $CompleteCampaignOptions + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaCampaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Campaign = @" + { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + } + "@ + + # Create Campaign + + try { + $Result = ConvertFrom-JsonToCampaign -Json $Campaign + New-BetaCampaign-BetaCampaign $Result + + # Below is a request that includes all optional parameters + # New-BetaCampaign -BetaCampaign $Campaign + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCampaign" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CampaignTemplate = @" + { + "ownerRef" : { + "name" : "Mister Manager", + "id" : "2c918086676d3e0601677611dbde220f", + "type" : "IDENTITY", + "email" : "mr.manager@example.com" + }, + "deadlineDuration" : "P2W", + "created" : "2020-03-05T22:44:00.364Z", + "scheduled" : false, + "name" : "Manager Campaign Template", + "description" : "Template for the annual manager campaign.", + "modified" : "2020-03-05T22:52:09.969Z", + "campaign" : { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }, + "id" : "2c9079b270a266a60170a277bb960008" + } + "@ + + # Create a Campaign Template + + try { + $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate + New-BetaCampaignTemplate-BetaCampaignTemplate $Result + + # Below is a request that includes all optional parameters + # New-BetaCampaignTemplate -BetaCampaignTemplate $CampaignTemplate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. + + # Delete a Campaign Template + + try { + Remove-BetaCampaignTemplate-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaCampaignTemplate -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. + + # Delete Campaign Template Schedule + + try { + Remove-BetaCampaignTemplateSchedule-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaCampaignTemplateSchedule -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaigns/delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $DeleteCampaignsRequest = @" + { + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + } + "@ + + # Delete Campaigns + + try { + $Result = ConvertFrom-JsonToDeleteCampaignsRequest -Json $DeleteCampaignsRequest + Remove-BetaCampaigns-BetaDeleteCampaignsRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaCampaigns -BetaDeleteCampaignsRequest $DeleteCampaignsRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaigns" + Write-Host $_.ErrorDetails + } +- path: /campaigns + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Manager Campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) + + # List Campaigns + + try { + Get-BetaActiveCampaigns + + # Below is a request that includes all optional parameters + # Get-BetaActiveCampaigns -BetaDetail $Detail -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaActiveCampaigns" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. + + # Get Campaign + + try { + Get-BetaCampaign-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaCampaign -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/reports + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. + + # Get Campaign Reports + + try { + Get-BetaCampaignReports-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaCampaignReports -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignReports" + Write-Host $_.ErrorDetails + } +- path: /campaigns/reports-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Campaign Reports Configuration + + try { + Get-BetaCampaignReportsConfig + + # Below is a request that includes all optional parameters + # Get-BetaCampaignReportsConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignReportsConfig" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. + + # Get a Campaign Template + + try { + Get-BetaCampaignTemplate-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaCampaignTemplate -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. + + # Get Campaign Template Schedule + + try { + Get-BetaCampaignTemplateSchedule-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaCampaignTemplateSchedule -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $Filters = "name eq "manager template"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + + # List Campaign Templates + + try { + Get-BetaCampaignTemplates + + # Below is a request that includes all optional parameters + # Get-BetaCampaignTemplates -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplates" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/reassign + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID + $AdminReviewReassign = @" + { + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } + } + "@ + + # Reassign Certifications + + try { + $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign + Move-Beta-BetaId $Id -BetaAdminReviewReassign $Result + + # Below is a request that includes all optional parameters + # Move-Beta -BetaId $Id -BetaAdminReviewReassign $AdminReviewReassign + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-Beta" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update a Campaign Template + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaCampaignTemplate-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaCampaignTemplate -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaigns/reports-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CampaignReportsConfig = @" + { + "identityAttributeColumns" : [ "firstname", "lastname" ] + } + "@ + + # Set Campaign Reports Configuration + + try { + $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig + Set-BetaCampaignReportsConfig-BetaCampaignReportsConfig $Result + + # Below is a request that includes all optional parameters + # Set-BetaCampaignReportsConfig -BetaCampaignReportsConfig $CampaignReportsConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaCampaignReportsConfig" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template being scheduled. + $Schedule = @" + { + "hours" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "months" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "timeZoneId" : "CST", + "days" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "expiration" : "2000-01-23T04:56:07.000+00:00", + "type" : "WEEKLY" + } + "@ + + # Set Campaign Template Schedule + + try { + Set-BetaCampaignTemplateSchedule-BetaId $Id + + # Below is a request that includes all optional parameters + # Set-BetaCampaignTemplateSchedule -BetaId $Id -BetaSchedule $Schedule + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaCampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/activate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $ActivateCampaignOptions = @" + { + "timeZone" : "-05:00" + } + "@ + + # Activate a Campaign + + try { + Start-BetaCampaign-BetaId $Id + + # Below is a request that includes all optional parameters + # Start-BetaCampaign -BetaId $Id -BetaActivateCampaignOptions $ActivateCampaignOptions + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/run-remediation-scan + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. + + # Run Campaign Remediation Scan + + try { + Start-BetaCampaignRemediationScan-BetaId $Id + + # Below is a request that includes all optional parameters + # Start-BetaCampaignRemediationScan -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaignRemediationScan" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/run-report/{type} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. + $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of report to run. + + # Run Campaign Report + + try { + Start-BetaCampaignReport-BetaId $Id -BetaType $Type + + # Below is a request that includes all optional parameters + # Start-BetaCampaignReport -BetaId $Id -BetaType $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaignReport" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/generate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. + + # Generate a Campaign from Template + + try { + Start-BetaGenerateCampaignTemplate-BetaId $Id + + # Below is a request that includes all optional parameters + # Start-BetaGenerateCampaignTemplate -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaGenerateCampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign being modified. + $RequestBody = # SystemCollectionsHashtable[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline + $RequestBody = @"[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]"@ + + + # Update a Campaign + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaCampaign-BetaId $Id -BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaCampaign -BetaId $Id -BetaRequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCampaign" + Write-Host $_.ErrorDetails + } +- path: /certifications/{certificationId}/access-review-items/{itemId}/permissions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID + $Filters = "target eq "SYS.OBJAUTH2"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Permissions for Entitlement Certification Item + + try { + Get-BetaIdentityCertificationItemPermissions-BetaCertificationId $CertificationId -BetaItemId $ItemId + + # Below is a request that includes all optional parameters + # Get-BetaIdentityCertificationItemPermissions -BetaCertificationId $CertificationId -BetaItemId $ItemId -BetaFilters $Filters -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationItemPermissions" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/tasks-pending + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "MyId" # String | The identity campaign certification ID + + # Pending Certification Tasks + + try { + Get-BetaIdentityCertificationPendingTasks-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentityCertificationPendingTasks -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationPendingTasks" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/tasks/{taskId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "MyId" # String | The identity campaign certification ID + $TaskId = "MyTaskId" # String | The certification task ID + + # Certification Task Status + + try { + Get-BetaIdentityCertificationTaskStatus-BetaId $Id -BetaTaskId $TaskId + + # Below is a request that includes all optional parameters + # Get-BetaIdentityCertificationTaskStatus -BetaId $Id -BetaTaskId $TaskId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationTaskStatus" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reviewers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) + + # List of Reviewers for certification + + try { + Get-BetaCertificationReviewers-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaCertificationReviewers -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCertificationReviewers" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reassign-async + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $ReviewReassign = @" + { + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + } + "@ + + # Reassign Certifications Asynchronously + + try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Submit-BetaReassignCertsAsync-BetaId $Id -BetaReviewReassign $Result + + # Below is a request that includes all optional parameters + # Submit-BetaReassignCertsAsync -BetaId $Id -BetaReviewReassign $ReviewReassign + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaReassignCertsAsync" + Write-Host $_.ErrorDetails + } +- path: /connector-rules + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ConnectorRuleCreateRequest = @" + { + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "type" : "BuildMap" + } + "@ + + # Create Connector Rule + + try { + $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest + New-BetaConnectorRule-BetaConnectorRuleCreateRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaConnectorRule -BetaConnectorRuleCreateRequest $ConnectorRuleCreateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete + + # Delete a Connector-Rule + + try { + Remove-BetaConnectorRule-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaConnectorRule -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to retrieve + + # Connector-Rule by ID + + try { + Get-BetaConnectorRule-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaConnectorRule -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Connector Rules + + try { + Get-BetaConnectorRuleList + + # Below is a request that includes all optional parameters + # Get-BetaConnectorRuleList + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorRuleList" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to update + $ConnectorRuleUpdateRequest = @" + { + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", + "type" : "BuildMap" + } + "@ + + # Update a Connector Rule + + try { + Update-BetaConnectorRule-BetaId $Id + + # Below is a request that includes all optional parameters + # Update-BetaConnectorRule -BetaId $Id -BetaConnectorRuleUpdateRequest $ConnectorRuleUpdateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/validate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceCode = @" + { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + } + "@ + + # Validate Connector Rule + + try { + $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode + Confirm-BetaConnectorRule-BetaSourceCode $Result + + # Below is a request that includes all optional parameters + # Confirm-BetaConnectorRule -BetaSourceCode $SourceCode + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Confirm-BetaConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connectors + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "directConnect eq "true"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Get Connector List + + try { + Get-BetaConnectorList + + # Below is a request that includes all optional parameters + # Get-BetaConnectorList -BetaFilters $Filters -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaLocale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorList" + Write-Host $_.ErrorDetails + } +- path: /form-definitions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreateFormDefinitionRequest = @" + { + "owner" : { + "name" : "Grant Smith", + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "formConditions" : [ { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + }, { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + } ], + "formInput" : [ { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + }, { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + } ], + "name" : "My form", + "description" : "My form description", + "usedBy" : [ { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + }, { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + } ], + "formElements" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + } ] + } + "@ + + # Creates a form definition. + + try { + New-BetaFormDefinition + + # Below is a request that includes all optional parameters + # New-BetaFormDefinition -BetaCreateFormDefinitionRequest $CreateFormDefinitionRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinition" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/template + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreateFormDefinitionRequest = @" + { + "owner" : { + "name" : "Grant Smith", + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "formConditions" : [ { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + }, { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + } ], + "formInput" : [ { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + }, { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + } ], + "name" : "My form", + "description" : "My form description", + "usedBy" : [ { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + }, { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + } ], + "formElements" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + } ] + } + "@ + + # Create a form definition by template. + + try { + New-BetaFormDefinitionByTemplate + + # Below is a request that includes all optional parameters + # New-BetaFormDefinitionByTemplate -BetaCreateFormDefinitionRequest $CreateFormDefinitionRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionByTemplate" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/forms-action-dynamic-schema + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Body = @" + { + "description" : "A description", + "attributes" : { + "formDefinitionId" : "00000000-0000-0000-0000-000000000000" + }, + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "action", + "versionNumber" : 1 + } + "@ + + # Generate JSON Schema dynamically. + + try { + New-BetaFormDefinitionDynamicSchema + + # Below is a request that includes all optional parameters + # New-BetaFormDefinitionDynamicSchema -BetaBody $Body + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionDynamicSchema" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID}/upload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID + $File = # System.IO.FileInfo | File specifying the multipart + + # Upload new form definition file. + + try { + New-BetaFormDefinitionFileRequest-BetaFormDefinitionID $FormDefinitionID -BetaFile $File + + # Below is a request that includes all optional parameters + # New-BetaFormDefinitionFileRequest -BetaFormDefinitionID $FormDefinitionID -BetaFile $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionFileRequest" + Write-Host $_.ErrorDetails + } +- path: /form-instances + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Body = @" + { + "formInput" : { + "input1" : "Sales" + }, + "standAloneForm" : false, + "createdBy" : { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "WORKFLOW_EXECUTION" + }, + "recipients" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + } ], + "expire" : "2023-08-12T20:14:57.74486Z", + "formDefinitionId" : "00000000-0000-0000-0000-000000000000", + "state" : "ASSIGNED", + "ttl" : 1571827560 + } + "@ + + # Creates a form instance. + + try { + New-BetaFormInstance + + # Below is a request that includes all optional parameters + # New-BetaFormInstance -BetaBody $Body + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormInstance" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + + # Deletes a form definition. + + try { + Remove-BetaFormDefinition-BetaFormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Remove-BetaFormDefinition -BetaFormDefinitionID $FormDefinitionID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaFormDefinition" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + $Filters = "name sw "my form"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") + + # List form definitions by tenant. + + try { + Export-BetaFormDefinitionsByTenant + + # Below is a request that includes all optional parameters + # Export-BetaFormDefinitionsByTenant -BetaOffset $Offset -BetaLimit $Limit -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaFormDefinitionsByTenant" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID}/file/{fileID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID Form definition ID + $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. + + # Download definition file by fileId. + + try { + Get-BetaFileFromS3-BetaFormDefinitionID $FormDefinitionID -BetaFileID $FileID + + # Below is a request that includes all optional parameters + # Get-BetaFileFromS3 -BetaFormDefinitionID $FormDefinitionID -BetaFileID $FileID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFileFromS3" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + + # Return a form definition. + + try { + Get-BetaFormDefinitionByKey-BetaFormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Get-BetaFormDefinitionByKey -BetaFormDefinitionID $FormDefinitionID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormDefinitionByKey" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID + + # Returns a form instance. + + try { + Get-BetaFormInstanceByKey-BetaFormInstanceID $FormInstanceID + + # Below is a request that includes all optional parameters + # Get-BetaFormInstanceByKey -BetaFormInstanceID $FormInstanceID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormInstanceByKey" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID}/file/{fileID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | FormInstanceID Form instance ID + $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. + + # Download instance file by fileId. + + try { + Get-BetaFormInstanceFile-BetaFormInstanceID $FormInstanceID -BetaFileID $FileID + + # Below is a request that includes all optional parameters + # Get-BetaFormInstanceFile -BetaFormInstanceID $FormInstanceID -BetaFileID $FileID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormInstanceFile" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + + + + + + $Body = @"[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]"@ + + + # Import form definitions from export. + + try { + Import-BetaFormDefinitions + + # Below is a request that includes all optional parameters + # Import-BetaFormDefinitions -BetaBody $Body + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaFormDefinitions" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) + $Body = @"[{op=replace, path=/description, value=test-description}]"@ + + + # Patch a form definition. + + try { + Update-BetaFormDefinition-BetaFormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Update-BetaFormDefinition -BetaFormDefinitionID $FormDefinitionID -BetaBody $Body + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaFormDefinition" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID + $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) + $Body = @"[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]"@ + + + # Patch a form instance. + + try { + Update-BetaFormInstance-BetaFormInstanceID $FormInstanceID + + # Below is a request that includes all optional parameters + # Update-BetaFormInstance -BetaFormInstanceID $FormInstanceID -BetaBody $Body + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaFormInstance" + Write-Host $_.ErrorDetails + } +- path: /form-definitions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 250 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + $Filters = "name sw "my form"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") + + # Export form definitions by tenant. + + try { + Search-BetaFormDefinitionsByTenant + + # Below is a request that includes all optional parameters + # Search-BetaFormDefinitionsByTenant -BetaOffset $Offset -BetaLimit $Limit -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormDefinitionsByTenant" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID}/data-source/{formElementID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID + $FormElementID = "1" # String | Form element ID + $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + $Filters = "value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) + $Query = "support" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) + + # Retrieves dynamic data by element. + + try { + Search-BetaFormElementDataByElementID-BetaFormInstanceID $FormInstanceID -BetaFormElementID $FormElementID + + # Below is a request that includes all optional parameters + # Search-BetaFormElementDataByElementID -BetaFormInstanceID $FormInstanceID -BetaFormElementID $FormElementID -BetaLimit $Limit -BetaFilters $Filters -BetaQuery $Query + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormElementDataByElementID" + Write-Host $_.ErrorDetails + } +- path: /form-instances + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List form instances by tenant. + + try { + Search-BetaFormInstancesByTenant + + # Below is a request that includes all optional parameters + # Search-BetaFormInstancesByTenant + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormInstancesByTenant" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/predefined-select-options + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List predefined select options. + + try { + Search-BetaPreDefinedSelectOptions + + # Below is a request that includes all optional parameters + # Search-BetaPreDefinedSelectOptions + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaPreDefinedSelectOptions" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID}/data-source + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + $Limit = 10 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) + $Filters = "value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) + $Query = "ac" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) + $FormElementPreviewRequest = @" + { + "dataSource" : { + "config" : { + "indices" : [ "identities" ], + "query" : "*", + "aggregationBucketField" : "attributes.cloudStatus.exact", + "objectType" : "IDENTITY" + }, + "dataSourceType" : "STATIC" + } + } + "@ + + # Preview form definition data source. + + try { + Show-BetaPreviewDataSource-BetaFormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Show-BetaPreviewDataSource -BetaFormDefinitionID $FormDefinitionID -BetaLimit $Limit -BetaFilters $Filters -BetaQuery $Query -BetaFormElementPreviewRequest $FormElementPreviewRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-BetaPreviewDataSource" + Write-Host $_.ErrorDetails + } +- path: /custom-password-instructions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CustomPasswordInstruction = @" + { + "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", + "pageId" : "change-password:enter-password", + "locale" : "en" + } + "@ + + # Create Custom Password Instructions + + try { + $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction + New-BetaCustomPasswordInstructions-BetaCustomPasswordInstruction $Result + + # Below is a request that includes all optional parameters + # New-BetaCustomPasswordInstructions -BetaCustomPasswordInstruction $CustomPasswordInstruction + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCustomPasswordInstructions" + Write-Host $_.ErrorDetails + } +- path: /custom-password-instructions/{pageId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to delete. + $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) + + # Delete Custom Password Instructions by page ID + + try { + Remove-BetaCustomPasswordInstructions-BetaPageId $PageId + + # Below is a request that includes all optional parameters + # Remove-BetaCustomPasswordInstructions -BetaPageId $PageId -BetaLocale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCustomPasswordInstructions" + Write-Host $_.ErrorDetails + } +- path: /custom-password-instructions/{pageId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to query. + $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) + + # Get Custom Password Instructions by Page ID + + try { + Get-BetaCustomPasswordInstructions-BetaPageId $PageId + + # Below is a request that includes all optional parameters + # Get-BetaCustomPasswordInstructions -BetaPageId $PageId -BetaLocale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomPasswordInstructions" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + + # Add metadata to an entitlement. + + try { + New-BetaAccessModelMetadataForEntitlement-BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue + + # Below is a request that includes all optional parameters + # New-BetaAccessModelMetadataForEntitlement -BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessModelMetadataForEntitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + + # Remove metadata from an entitlement. + + try { + Remove-BetaAccessModelMetadataFromEntitlement-BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue + + # Below is a request that includes all optional parameters + # Remove-BetaAccessModelMetadataFromEntitlement -BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessModelMetadataFromEntitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID + + # Get an entitlement + + try { + Get-BetaEntitlement-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaEntitlement -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/entitlement-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id + + # Get Entitlement Request Config + + try { + Get-BetaEntitlementRequestConfig-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementRequestConfig -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /entitlements/aggregate/sources/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id + $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) + + # Aggregate Entitlements + + try { + Import-BetaEntitlementsBySource-BetaId $Id + + # Below is a request that includes all optional parameters + # Import-BetaEntitlementsBySource -BetaId $Id -BetaCsvFile $CsvFile + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaEntitlementsBySource" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/children + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + # List of entitlements children + + try { + Get-BetaEntitlementChildren-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementChildren -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementChildren" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/parents + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + # List of entitlements parents + + try { + Get-BetaEntitlementParents-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementParents -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementParents" + Write-Host $_.ErrorDetails + } +- path: /entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (optional) + $SegmentedForIdentity = "me" # String | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) + $ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) + $IncludeUnsegmented = $true # Boolean | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to $true) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) + + # Gets a list of entitlements. + + try { + Get-BetaEntitlements + + # Below is a request that includes all optional parameters + # Get-BetaEntitlements -BetaAccountId $AccountId -BetaSegmentedForIdentity $SegmentedForIdentity -BetaForSegmentIds $ForSegmentIds -BetaIncludeUnsegmented $IncludeUnsegmented -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlements" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch an entitlement + + try { + Update-BetaEntitlement-BetaId $Id + + # Below is a request that includes all optional parameters + # Update-BetaEntitlement -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/entitlement-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID + $EntitlementRequestConfig = @" + { + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + } + "@ + + # Replace Entitlement Request Config + + try { + $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig + Send-BetaEntitlementRequestConfig-BetaId $Id -BetaEntitlementRequestConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaEntitlementRequestConfig -BetaId $Id -BetaEntitlementRequestConfig $EntitlementRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /entitlements/reset/sources/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset + + # Reset Source Entitlements + + try { + Reset-BetaSourceEntitlements-BetaId $Id + + # Below is a request that includes all optional parameters + # Reset-BetaSourceEntitlements -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-BetaSourceEntitlements" + Write-Host $_.ErrorDetails + } +- path: /entitlements/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $EntitlementBulkUpdateRequest = @" + { + "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/privileged", + "value" : false + }, { + "op" : "replace", + "path" : "/requestable", + "value" : false + } ] + } + "@ + + # Bulk update an entitlement list + + try { + $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest + Update-BetaEntitlementsInBulk-BetaEntitlementBulkUpdateRequest $Result + + # Below is a request that includes all optional parameters + # Update-BetaEntitlementsInBulk -BetaEntitlementBulkUpdateRequest $EntitlementBulkUpdateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlementsInBulk" + Write-Host $_.ErrorDetails + } +- path: /workgroups + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $WorkgroupDto = @" + { + "owner" : { + "emailAddress" : "support@sailpoint.com", + "displayName" : "Support", + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "connectionCount" : 1641498673000, + "created" : "2022-01-06T19:51:13Z", + "memberCount" : 1641498673000, + "name" : "DB Access Governance Group", + "description" : "Description of the Governance Group", + "modified" : "2022-01-06T19:51:13Z", + "id" : "2c91808568c529c60168cca6f90c1313" + } + "@ + + # Create a new Governance Group. + + try { + $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto + New-BetaWorkgroup-BetaWorkgroupDto $Result + + # Below is a request that includes all optional parameters + # New-BetaWorkgroup -BetaWorkgroupDto $WorkgroupDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + + # Delete a Governance Group + + try { + Remove-BetaWorkgroup-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaWorkgroup -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/members/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $BulkWorkgroupMembersRequestInner = @""@ + + + # Remove members from Governance Group + + try { + $Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner + Remove-BetaWorkgroupMembers-BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result + + # Below is a request that includes all optional parameters + # Remove-BetaWorkgroupMembers -BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $BulkWorkgroupMembersRequestInner + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroupMembers" + Write-Host $_.ErrorDetails + } +- path: /workgroups/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $WorkgroupBulkDeleteRequest = @" + { + "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] + } + "@ + + # Delete Governance Group(s) + + try { + $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest + Remove-BetaWorkgroupsInBulk-BetaWorkgroupBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaWorkgroupsInBulk -BetaWorkgroupBulkDeleteRequest $WorkgroupBulkDeleteRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroupsInBulk" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + + # Get Governance Group by Id + + try { + Get-BetaWorkgroup-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkgroup -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/connections + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + + # List connections for Governance Group + + try { + Get-BetaConnections-BetaWorkgroupId $WorkgroupId + + # Below is a request that includes all optional parameters + # Get-BetaConnections -BetaWorkgroupId $WorkgroupId -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnections" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/members + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + + # List Governance Group Members + + try { + Get-BetaWorkgroupMembers-BetaWorkgroupId $WorkgroupId + + # Below is a request that includes all optional parameters + # Get-BetaWorkgroupMembers -BetaWorkgroupId $WorkgroupId -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroupMembers" + Write-Host $_.ErrorDetails + } +- path: /workgroups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw "Test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional) + + # List Governance Groups + + try { + Get-BetaWorkgroups + + # Below is a request that includes all optional parameters + # Get-BetaWorkgroups -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroups" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Governance Group + + try { + Update-BetaWorkgroup-BetaId $Id + + # Below is a request that includes all optional parameters + # Update-BetaWorkgroup -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/members/bulk-add + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $BulkWorkgroupMembersRequestInner = @""@ + + + # Add members to Governance Group + + try { + $Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner + Update-BetaWorkgroupMembers-BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaWorkgroupMembers -BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $BulkWorkgroupMembersRequestInner + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkgroupMembers" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/ignored-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessRequestRecommendationActionItemDto = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Notification of Ignored Access Request Recommendations + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-BetaAccessRequestRecommendationsIgnoredItem-BetaAccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-BetaAccessRequestRecommendationsIgnoredItem -BetaAccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsIgnoredItem" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/requested-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessRequestRecommendationActionItemDto = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Notification of Requested Access Request Recommendations + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-BetaAccessRequestRecommendationsRequestedItem-BetaAccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-BetaAccessRequestRecommendationsRequestedItem -BetaAccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsRequestedItem" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/viewed-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessRequestRecommendationActionItemDto = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Notification of Viewed Access Request Recommendations + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-BetaAccessRequestRecommendationsViewedItem-BetaAccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-BetaAccessRequestRecommendationsViewedItem -BetaAccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsViewedItem" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/viewed-items/bulk-create + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessRequestRecommendationActionItemDto = @"{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }"@ + + + # Notification of Viewed Access Request Recommendations in Bulk + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-BetaAccessRequestRecommendationsViewedItems-BetaAccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-BetaAccessRequestRecommendationsViewedItems -BetaAccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsViewedItems" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "2c91808570313110017040b06f344ec9" # String | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") + $Limit = 56 # Int32 | Max number of results to return. (optional) (default to 15) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $IncludeTranslationMessages = $false # Boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to $false) + $Filters = "access.name co "admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) + + # Identity Access Request Recommendations + + try { + Get-BetaAccessRequestRecommendations + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestRecommendations -BetaIdentityId $IdentityId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaIncludeTranslationMessages $IncludeTranslationMessages -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendations" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/ignored-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "identityId eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + + # List of Ignored Access Request Recommendations + + try { + Get-BetaAccessRequestRecommendationsIgnoredItems + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestRecommendationsIgnoredItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsIgnoredItems" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/requested-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + + # List of Requested Access Request Recommendations + + try { + Get-BetaAccessRequestRecommendationsRequestedItems + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestRecommendationsRequestedItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsRequestedItems" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/viewed-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + + # List of Viewed Access Request Recommendations + + try { + Get-BetaAccessRequestRecommendationsViewedItems + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestRecommendationsViewedItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsViewedItems" + Write-Host $_.ErrorDetails + } +- path: /common-access + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CommonAccessItemRequest = @" + { + "access" : { + "ownerName" : "ownerName", + "name" : "name", + "description" : "description", + "id" : "id", + "type" : "ACCESS_PROFILE", + "ownerId" : "ownerId" + }, + "status" : "CONFIRMED" + } + "@ + + # Create common access items + + try { + $Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest + New-BetaCommonAccess-BetaCommonAccessItemRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaCommonAccess -BetaCommonAccessItemRequest $CommonAccessItemRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCommonAccess" + Write-Host $_.ErrorDetails + } +- path: /common-access + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.type eq "ROLE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) + + # Get a paginated list of common access + + try { + Get-BetaCommonAccess + + # Below is a request that includes all optional parameters + # Get-BetaCommonAccess -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCommonAccess" + Write-Host $_.ErrorDetails + } +- path: /common-access/update-status + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CommonAccessIDStatus = @"{ + "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], + "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] + }"@ + + + # Bulk update common access status + + try { + $Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus + Update-BetaCommonAccessStatusInBulk-BetaCommonAccessIDStatus $Result + + # Below is a request that includes all optional parameters + # Update-BetaCommonAccessStatusInBulk -BetaCommonAccessIDStatus $CommonAccessIDStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCommonAccessStatusInBulk" + Write-Host $_.ErrorDetails + } +- path: /translation-catalogs/{catalog-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CatalogId = "recommender" # String | The ID of the message catalog. + + # Get Message catalogs + + try { + Get-BetaMessageCatalogs-BetaCatalogId $CatalogId + + # Below is a request that includes all optional parameters + # Get-BetaMessageCatalogs -BetaCatalogId $CatalogId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMessageCatalogs" + Write-Host $_.ErrorDetails + } +- path: /outliers/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + + # IAI Identity Outliers Export + + try { + Export-BetaOutliersZip + + # Below is a request that includes all optional parameters + # Export-BetaOutliersZip -BetaType $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaOutliersZip" + Write-Host $_.ErrorDetails + } +- path: /outlier-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + $Filters = "snapshotDate ge "2022-02-07T20:13:29.356648026Z"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* (optional) + $Sorters = "snapshotDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** (optional) + + # IAI Identity Outliers Summary + + try { + Get-BetaIdentityOutlierSnapshots + + # Below is a request that includes all optional parameters + # Get-BetaIdentityOutlierSnapshots -BetaLimit $Limit -BetaOffset $Offset -BetaType $Type -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOutlierSnapshots" + Write-Host $_.ErrorDetails + } +- path: /outliers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + $Filters = "attributes.displayName sw "John" and certStatus eq "false"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) + $Sorters = "attributes.displayName,firstDetectionDate,-score" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** (optional) + + # IAI Get Identity Outliers + + try { + Get-BetaIdentityOutliers + + # Below is a request that includes all optional parameters + # Get-BetaIdentityOutliers -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaType $Type -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOutliers" + Write-Host $_.ErrorDetails + } +- path: /outlier-summaries/latest + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + + # IAI Identity Outliers Latest Summary + + try { + Get-BetaLatestIdentityOutlierSnapshots + + # Below is a request that includes all optional parameters + # Get-BetaLatestIdentityOutlierSnapshots -BetaType $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLatestIdentityOutlierSnapshots" + Write-Host $_.ErrorDetails + } +- path: /outlier-feature-summaries/{outlierFeatureId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OutlierFeatureId = "04654b66-7561-4090-94f9-abee0722a1af" # String | Contributing feature id + + # Get identity outlier contibuting feature summary + + try { + Get-BetaOutlierContributingFeatureSummary-BetaOutlierFeatureId $OutlierFeatureId + + # Below is a request that includes all optional parameters + # Get-BetaOutlierContributingFeatureSummary -BetaOutlierFeatureId $OutlierFeatureId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOutlierContributingFeatureSummary" + Write-Host $_.ErrorDetails + } +- path: /outliers/{outlierId}/contributing-features + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $IncludeTranslationMessages = "include-translation-messages=" # String | Whether or not to include translation messages object in returned response (optional) + $Sorters = "importance" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** (optional) + + # Get identity outlier's contibuting features + + try { + Get-BetaPeerGroupOutliersContributingFeatures-BetaOutlierId $OutlierId + + # Below is a request that includes all optional parameters + # Get-BetaPeerGroupOutliersContributingFeatures -BetaOutlierId $OutlierId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaIncludeTranslationMessages $IncludeTranslationMessages -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPeerGroupOutliersContributingFeatures" + Write-Host $_.ErrorDetails + } +- path: /outliers/ignore + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ + + + # IAI Identity Outliers Ignore + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Invoke-BetaIgnoreIdentityOutliers-BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Invoke-BetaIgnoreIdentityOutliers -BetaRequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaIgnoreIdentityOutliers" + Write-Host $_.ErrorDetails + } +- path: /outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id + $ContributingFeatureName = "radical_entitlement_count" # String | The name of contributing feature + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $AccessType = "ENTITLEMENT" # String | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) + $Sorters = "displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) + + # Gets a list of access items associated with each identity outlier contributing feature + + try { + Get-BetaOutliersContributingFeatureAccessItems-BetaOutlierId $OutlierId -BetaContributingFeatureName $ContributingFeatureName + + # Below is a request that includes all optional parameters + # Get-BetaOutliersContributingFeatureAccessItems -BetaOutlierId $OutlierId -BetaContributingFeatureName $ContributingFeatureName -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaAccessType $AccessType -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOutliersContributingFeatureAccessItems" + Write-Host $_.ErrorDetails + } +- path: /outliers/unignore + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ + + + # IAI Identity Outliers Unignore + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Invoke-BetaUnIgnoreIdentityOutliers-BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Invoke-BetaUnIgnoreIdentityOutliers -BetaRequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaUnIgnoreIdentityOutliers" + Write-Host $_.ErrorDetails + } +- path: /peer-group-strategies/{strategy}/identity-outliers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Strategy = "entitlement" # String | The strategy used to create peer groups. Currently, 'entitlement' is supported. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Identity Outliers List + + try { + Get-BetaPeerGroupOutliers-BetaStrategy $Strategy + + # Below is a request that includes all optional parameters + # Get-BetaPeerGroupOutliers -BetaStrategy $Strategy -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPeerGroupOutliers" + Write-Host $_.ErrorDetails + } +- path: /recommendations/request + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RecommendationRequestDto = @" + { + "prescribeMode" : false, + "excludeInterpretations" : false, + "requests" : [ { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + }, { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + } ], + "includeTranslationMessages" : false, + "includeDebugInformation" : true + } + "@ + + # Returns a Recommendation Based on Object + + try { + $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto + Get-BetaRecommendations-BetaRecommendationRequestDto $Result + + # Below is a request that includes all optional parameters + # Get-BetaRecommendations -BetaRecommendationRequestDto $RecommendationRequestDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRecommendations" + Write-Host $_.ErrorDetails + } +- path: /recommendations/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get certification recommendation config values + + try { + Get-BetaRecommendationsConfig + + # Below is a request that includes all optional parameters + # Get-BetaRecommendationsConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRecommendationsConfig" + Write-Host $_.ErrorDetails + } +- path: /recommendations/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RecommendationConfigDto = @" + { + "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], + "peerGroupPercentageThreshold" : 0.5, + "runAutoSelectOnce" : false, + "onlyTuneThreshold" : false + } + "@ + + # Update certification recommendation config values + + try { + $Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto + Update-BetaRecommendationsConfig-BetaRecommendationConfigDto $Result + + # Below is a request that includes all optional parameters + # Update-BetaRecommendationsConfig -BetaRecommendationConfigDto $RecommendationConfigDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRecommendationsConfig" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $MinEntitlementPopularity = 56 # Int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to $true) + $RoleMiningPotentialRoleProvisionRequest = @" + { + "includeIdentities" : true, + "roleName" : "Finance - Accounting", + "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", + "roleDescription" : "General access for accounting department", + "directlyAssignedEntitlements" : false + } + "@ + + # Create request to provision a potential role into an actual role. + + try { + New-BetaPotentialRoleProvisionRequest-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # New-BetaPotentialRoleProvisionRequest -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaMinEntitlementPopularity $MinEntitlementPopularity -BetaIncludeCommonAccess $IncludeCommonAccess -BetaRoleMiningPotentialRoleProvisionRequest $RoleMiningPotentialRoleProvisionRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPotentialRoleProvisionRequest" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleMiningSessionDto = @" + { + "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", + "prescribedPruneThreshold" : 10, + "pruneThreshold" : 50, + "saved" : true, + "potentialRolesReadyCount" : 0, + "scope" : { + "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], + "attributeFilterCriteria" : { + "displayName" : { + "untranslated" : "Location: Miami" + }, + "ariaLabel" : { + "untranslated" : "Location: Miami" + }, + "data" : { + "displayName" : { + "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" + }, + "name" : "location", + "operator" : "EQUALS", + "values" : [ "Miami" ] + } + }, + "criteria" : "source.name:DataScienceDataset" + }, + "potentialRoleCount" : 0, + "name" : "Saved RM Session - 07/10", + "minNumIdentitiesInPotentialRole" : 20, + "identityCount" : 0, + "type" : "SPECIALIZED" + } + "@ + + # Create a role mining session + + try { + $Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto + New-BetaRoleMiningSessions-BetaRoleMiningSessionDto $Result + + # Below is a request that includes all optional parameters + # New-BetaRoleMiningSessions -BetaRoleMiningSessionDto $RoleMiningSessionDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRoleMiningSessions" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session + $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role + + # Export (download) details for a potential role in a role mining session + + try { + Invoke-BetaDownloadRoleMiningPotentialRoleZip-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId + + # Below is a request that includes all optional parameters + # Invoke-BetaDownloadRoleMiningPotentialRoleZip -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaDownloadRoleMiningPotentialRoleZip" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + + # Export (download) details for a potential role in a role mining session + + try { + Export-BetaRoleMiningPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Export-BetaRoleMiningPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session + $RoleMiningPotentialRoleExportRequest = @" + { + "minEntitlementPopularity" : 0, + "includeCommonAccess" : true + } + "@ + + # Asynchronously export details for a potential role in a role mining session and upload to S3 + + try { + Export-BetaRoleMiningPotentialRoleAsync-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Export-BetaRoleMiningPotentialRoleAsync -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleExportRequest $RoleMiningPotentialRoleExportRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRoleAsync" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session + $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role + + # Retrieve status of a potential role export job + + try { + Export-BetaRoleMiningPotentialRoleStatus-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId + + # Below is a request that includes all optional parameters + # Export-BetaRoleMiningPotentialRoleStatus -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRoleStatus" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) + $Filters = "(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true))" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all potential role summaries + + try { + Get-BetaAllPotentialRoleSummaries + + # Below is a request that includes all optional parameters + # Get-BetaAllPotentialRoleSummaries -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllPotentialRoleSummaries" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) + + # Retrieves entitlement popularity distribution for a potential role in a role mining session + + try { + Get-BetaEntitlementDistributionPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementDistributionPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaIncludeCommonAccess $IncludeCommonAccess + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementDistributionPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) (default to $true) + $Sorters = "popularity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) + $Filters = "applicationName sw "AD"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves entitlements for a potential role in a role mining session + + try { + Get-BetaEntitlementsPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementsPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaIncludeCommonAccess $IncludeCommonAccess -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $Sorters = "populariity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** (optional) + $Filters = "applicationName sw "AD"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves excluded entitlements for a potential role in a role mining session + + try { + Get-BetaExcludedEntitlementsPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaExcludedEntitlementsPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaExcludedEntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves identities for a potential role in a role mining session + + try { + Get-BetaIdentitiesPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaIdentitiesPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitiesPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + + # Retrieve potential role in session + + try { + Get-BetaPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session + $Filters = "applicationName sw "test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves the applications of a potential role for a role mining session + + try { + Get-BetaPotentialRoleApplications-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRoleApplications -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleApplications" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session + $Filters = "entitlementRef.name sw "test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves the entitlements of a potential role for a role mining session + + try { + Get-BetaPotentialRoleEntitlements-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRoleEntitlements -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleEntitlements" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PotentialRoleId = "e0cc5d7d-bf7f-4f81-b2af-8885b09d9923" # String | A potential role id + $SourceId = "2c9180877620c1460176267f336a106f" # String | A source id + $Sorters = "-usageCount" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves potential role source usage + + try { + Get-BetaPotentialRoleSourceIdentityUsage-BetaPotentialRoleId $PotentialRoleId -BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRoleSourceIdentityUsage -BetaPotentialRoleId $PotentialRoleId -BetaSourceId $SourceId -BetaSorters $Sorters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleSourceIdentityUsage" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** (optional) + $Filters = "(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true))" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieve session's potential role summaries + + try { + Get-BetaPotentialRoleSummaries-BetaSessionId $SessionId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRoleSummaries -BetaSessionId $SessionId -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleSummaries" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/{potentialRoleId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id + + # Retrieves a specific potential role + + try { + Get-BetaRoleMiningPotentialRole-BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaRoleMiningPotentialRole -BetaPotentialRoleId $PotentialRoleId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be retrieved. + + # Get a role mining session + + try { + Get-BetaRoleMiningSession-BetaSessionId $SessionId + + # Below is a request that includes all optional parameters + # Get-BetaRoleMiningSession -BetaSessionId $SessionId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSession" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + + # Get role mining session status state + + try { + Get-BetaRoleMiningSessionStatus-BetaSessionId $SessionId + + # Below is a request that includes all optional parameters + # Get-BetaRoleMiningSessionStatus -BetaSessionId $SessionId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSessionStatus" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "saved eq "true" and name sw "RM Session"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* (optional) + $Sorters = "createdBy,createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all role mining sessions + + try { + Get-BetaRoleMiningSessions + + # Below is a request that includes all optional parameters + # Get-BetaRoleMiningSessions -BetaFilters $Filters -BetaSorters $Sorters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSessions" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/saved + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all saved potential roles + + try { + Get-BetaSavedPotentialRoles + + # Below is a request that includes all optional parameters + # Get-BetaSavedPotentialRoles -BetaSorters $Sorters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSavedPotentialRoles" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id + $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ + + + # Update a potential role in session + + try { + $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner + Update-BetaPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $PatchPotentialRoleRequestInner + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/{potentialRoleId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id + $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ + + + # Update a potential role + + try { + $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner + Update-BetaRoleMiningPotentialRole-BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaRoleMiningPotentialRole -BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $PatchPotentialRoleRequestInner + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRoleMiningPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be patched + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a role mining session + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaRoleMiningSession-BetaSessionId $SessionId -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaRoleMiningSession -BetaSessionId $SessionId -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRoleMiningSession" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $RoleMiningPotentialRoleEditEntitlements = @" + { + "ids" : [ "entId1", "entId2" ], + "exclude" : true + } + "@ + + # Edit entitlements for a potential role to exclude some entitlements + + try { + $Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements + Update-BetaEntitlementsPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleEditEntitlements $Result + + # Below is a request that includes all optional parameters + # Update-BetaEntitlementsPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleEditEntitlements $RoleMiningPotentialRoleEditEntitlements + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /icons/{objectType}/{objectId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ObjectType = "application" # String | Object type + $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. + + # Delete an icon + + try { + Remove-BetaIcon-BetaObjectType $ObjectType -BetaObjectId $ObjectId + + # Below is a request that includes all optional parameters + # Remove-BetaIcon -BetaObjectType $ObjectType -BetaObjectId $ObjectId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIcon" + Write-Host $_.ErrorDetails + } +- path: /icons/{objectType}/{objectId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ObjectType = "application" # String | Object type + $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. + $Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] + + # Update an icon + + try { + Set-BetaIcon-BetaObjectType $ObjectType -BetaObjectId $ObjectId -BetaImage $Image + + # Below is a request that includes all optional parameters + # Set-BetaIcon -BetaObjectType $ObjectType -BetaObjectId $ObjectId -BetaImage $Image + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaIcon" + Write-Host $_.ErrorDetails + } +- path: /identities/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + + # Delete identity + + try { + Remove-BetaIdentity-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaIdentity -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentity" + Write-Host $_.ErrorDetails + } +- path: /identities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + + # Identity Details + + try { + Get-BetaIdentity-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentity -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentity" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/ownership + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "ff8081814d2a8036014d701f3fbf53fa" # String | Identity ID. + + # Get ownership details + + try { + Get-BetaIdentityOwnershipDetails-BetaIdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Get-BetaIdentityOwnershipDetails -BetaIdentityId $IdentityId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOwnershipDetails" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/role-assignments/{assignmentId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + $AssignmentId = "1cbb0705b38c4226b1334eadd8874086" # String | Assignment Id + + # Role assignment details + + try { + Get-BetaRoleAssignment-BetaIdentityId $IdentityId -BetaAssignmentId $AssignmentId + + # Below is a request that includes all optional parameters + # Get-BetaRoleAssignment -BetaIdentityId $IdentityId -BetaAssignmentId $AssignmentId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignment" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/role-assignments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id to get the role assignments for + $RoleId = "e7697a1e96d04db1ac7b0f4544915d2c" # String | Role Id to filter the role assignments with (optional) + $RoleName = "Engineer" # String | Role name to filter the role assignments with (optional) + + # List role assignments + + try { + Get-BetaRoleAssignments-BetaIdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Get-BetaRoleAssignments -BetaIdentityId $IdentityId -BetaRoleId $RoleId -BetaRoleName $RoleName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignments" + Write-Host $_.ErrorDetails + } +- path: /identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) + $Sorters = "name,-cloudStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) + $DefaultFilter = "CORRELATED_ONLY" # String | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to "CORRELATED_ONLY") + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Identities + + try { + Get-BetaIdentities + + # Below is a request that includes all optional parameters + # Get-BetaIdentities -BetaFilters $Filters -BetaSorters $Sorters -BetaDefaultFilter $DefaultFilter -BetaCount $Count -BetaLimit $Limit -BetaOffset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentities" + Write-Host $_.ErrorDetails + } +- path: /identities/{id}/reset + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + + # Reset an identity + + try { + Reset-BetaIdentity-BetaIdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Reset-BetaIdentity -BetaIdentityId $IdentityId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-BetaIdentity" + Write-Host $_.ErrorDetails + } +- path: /identities/{id}/verification/account/send + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + $SendAccountVerificationRequest = @" + { + "sourceName" : "Active Directory Source", + "via" : "EMAIL_WORK" + } + "@ + + # Send password reset email + + try { + $Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest + Send-BetaIdentityVerificationAccountToken-BetaId $Id -BetaSendAccountVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaIdentityVerificationAccountToken -BetaId $Id -BetaSendAccountVerificationRequest $SendAccountVerificationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaIdentityVerificationAccountToken" + Write-Host $_.ErrorDetails + } +- path: /identities/invite + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $InviteIdentitiesRequest = @" + { + "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], + "uninvited" : false + } + "@ + + # Invite identities to register + + try { + $Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest + Start-BetaIdentitiesInvite-BetaInviteIdentitiesRequest $Result + + # Below is a request that includes all optional parameters + # Start-BetaIdentitiesInvite -BetaInviteIdentitiesRequest $InviteIdentitiesRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaIdentitiesInvite" + Write-Host $_.ErrorDetails + } +- path: /identities/process + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ProcessIdentitiesRequest = @" + { + "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] + } + "@ + + # Process a list of identityIds + + try { + $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest + Start-BetaIdentityProcessing-BetaProcessIdentitiesRequest $Result + + # Below is a request that includes all optional parameters + # Start-BetaIdentityProcessing -BetaProcessIdentitiesRequest $ProcessIdentitiesRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaIdentityProcessing" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/synchronize-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "MyIdentityId" # String | The Identity id + + # Attribute synchronization for single identity. + + try { + Sync-BetahronizeAttributesForIdentity-BetaIdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Sync-BetahronizeAttributesForIdentity -BetaIdentityId $IdentityId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetahronizeAttributesForIdentity" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityAttribute = @" + { + "standard" : false, + "system" : false, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + } + "@ + + # Create Identity Attribute + + try { + $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute + New-BetaIdentityAttribute-BetaIdentityAttribute $Result + + # Below is a request that includes all optional parameters + # New-BetaIdentityAttribute -BetaIdentityAttribute $IdentityAttribute + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "displayName" # String | The attribute's technical name. + + # Delete Identity Attribute + + try { + Remove-BetaIdentityAttribute-BetaName $Name + + # Below is a request that includes all optional parameters + # Remove-BetaIdentityAttribute -BetaName $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/bulk-delete + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityAttributeNames = @" + { + "ids" : [ "name", "displayName" ] + } + "@ + + # Bulk delete Identity Attributes + + try { + $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames + Remove-BetaIdentityAttributesInBulk-BetaIdentityAttributeNames $Result + + # Below is a request that includes all optional parameters + # Remove-BetaIdentityAttributesInBulk -BetaIdentityAttributeNames $IdentityAttributeNames + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttributesInBulk" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "displayName" # String | The attribute's technical name. + + # Get Identity Attribute + + try { + Get-BetaIdentityAttribute-BetaName $Name + + # Below is a request that includes all optional parameters + # Get-BetaIdentityAttribute -BetaName $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IncludeSystem = $false # Boolean | Include 'system' attributes in the response. (optional) (default to $false) + $IncludeSilent = $false # Boolean | Include 'silent' attributes in the response. (optional) (default to $false) + $SearchableOnly = $false # Boolean | Include only 'searchable' attributes in the response. (optional) (default to $false) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Identity Attributes + + try { + Get-BetaIdentityAttributes + + # Below is a request that includes all optional parameters + # Get-BetaIdentityAttributes -BetaIncludeSystem $IncludeSystem -BetaIncludeSilent $IncludeSilent -BetaSearchableOnly $SearchableOnly -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAttributes" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/{name} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "displayName" # String | The attribute's technical name. + $IdentityAttribute = @" + { + "standard" : false, + "system" : false, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + } + "@ + + # Update Identity Attribute + + try { + $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute + Send-BetaIdentityAttribute-BetaName $Name -BetaIdentityAttribute $Result + + # Below is a request that includes all optional parameters + # Send-BetaIdentityAttribute -BetaName $Name -BetaIdentityAttribute $IdentityAttribute + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaIdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/compare + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Snapshot1 = "2007-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) + $Snapshot2 = "2008-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) + $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) + + + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Gets a difference of count for each access item types for the given identity between 2 snapshots + + try { + Compare-BetaIdentitySnapshots-BetaId $Id + + # Below is a request that includes all optional parameters + # Compare-BetaIdentitySnapshots -BetaId $Id -BetaSnapshot1 $Snapshot1 -BetaSnapshot2 $Snapshot2 -BetaAccessItemTypes $AccessItemTypes -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-BetaIdentitySnapshots" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/compare/{access-type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $AccessType = "accessProfile" # String | The specific type which needs to be compared + $AccessAssociated = $false # Boolean | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) + $Snapshot1 = "2008-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) + $Snapshot2 = "2009-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Gets a list of differences of specific accessType for the given identity between 2 snapshots + + try { + Compare-BetaIdentitySnapshotsAccessType-BetaId $Id -BetaAccessType $AccessType + + # Below is a request that includes all optional parameters + # Compare-BetaIdentitySnapshotsAccessType -BetaId $Id -BetaAccessType $AccessType -BetaAccessAssociated $AccessAssociated -BetaSnapshot1 $Snapshot1 -BetaSnapshot2 $Snapshot2 -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-BetaIdentitySnapshotsAccessType" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + + # Get latest snapshot of identity + + try { + Get-BetaHistoricalIdentity-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaHistoricalIdentity -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentity" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/events + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $From = "2024-03-01T13:00:00Z" # String | The optional instant until which access events are returned (optional) + $EventTypes = "MyEventTypes" # String[] | An optional list of event types to return. If null or empty, all events are returned (optional) + + $EventTypes = @"[AccessAddedEvent, AccessRemovedEvent]"@ + $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) + + $AccessItemTypes = @"[entitlement, account]"@ + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Lists all events for the given identity + + try { + Get-BetaHistoricalIdentityEvents-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaHistoricalIdentityEvents -BetaId $Id -BetaFrom $From -BetaEventTypes $EventTypes -BetaAccessItemTypes $AccessItemTypes -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentityEvents" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshots/{date} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Date = "2007-03-01T13:00:00Z" # String | The specified date + + # Gets an identity snapshot at a given date + + try { + Get-BetaIdentitySnapshot-BetaId $Id -BetaDate $Date + + # Below is a request that includes all optional parameters + # Get-BetaIdentitySnapshot -BetaId $Id -BetaDate $Date + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshot" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshot-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Before = "2007-03-01T13:00:00Z" # String | The date before which snapshot summary is required (optional) + $Interval = "day" # String | The interval indicating day or month. Defaults to month if not specified (optional) + $TimeZone = "UTC" # String | The time zone. Defaults to UTC if not provided (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Gets the summary for the event count for a specific identity + + try { + Get-BetaIdentitySnapshotSummary-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentitySnapshotSummary -BetaId $Id -BetaBefore $Before -BetaInterval $Interval -BetaTimeZone $TimeZone -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshotSummary" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/start-date + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + + # Gets the start date of the identity + + try { + Get-BetaIdentityStartDate-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentityStartDate -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityStartDate" + Write-Host $_.ErrorDetails + } +- path: /historical-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $StartsWithQuery = "Ada" # String | This param is used for starts-with search for first, last and display name of the identity (optional) + $IsDeleted = $true # Boolean | Indicates if we want to only list down deleted identities or not. (optional) + $IsActive = $true # Boolean | Indicates if we want to only list active or inactive identities. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # Lists all the identities + + try { + Get-BetaHistoricalIdentities + + # Below is a request that includes all optional parameters + # Get-BetaHistoricalIdentities -BetaStartsWithQuery $StartsWithQuery -BetaIsDeleted $IsDeleted -BetaIsActive $IsActive -BetaLimit $Limit -BetaOffset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentities" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Type = "account" # String | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) + $Filters = "source eq "DataScienceDataset"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** (optional) + $Query = "Dr. Arden" # String | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Access Items by Identity + + try { + Get-BetaIdentityAccessItems-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentityAccessItems -BetaId $Id -BetaType $Type -BetaFilters $Filters -BetaSorters $Sorters -BetaQuery $Query -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAccessItems" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshots/{date}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Identity ID. + $Date = "2007-03-01T13:00:00Z" # String | Specified date. + $Type = "role" # String | Access item type. (optional) + + # Get Identity Access Items Snapshot + + try { + Get-BetaIdentitySnapshotAccessItems-BetaId $Id -BetaDate $Date + + # Below is a request that includes all optional parameters + # Get-BetaIdentitySnapshotAccessItems -BetaId $Id -BetaDate $Date -BetaType $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshotAccessItems" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshots + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Start = "2007-03-01T13:00:00Z" # String | The specified start date (optional) + $Interval = "day" # String | The interval indicating the range in day or month for the specified interval-name (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Lists all the snapshots for the identity + + try { + Get-BetaIdentitySnapshots-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentitySnapshots -BetaId $Id -BetaStart $Start -BetaInterval $Interval -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshots" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfile = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2023-01-03T21:16:22.432Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "id" : "id12345" + } + "@ + + # Create an Identity Profile + + try { + $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile + New-BetaIdentityProfile-BetaIdentityProfile $Result + + # Below is a request that includes all optional parameters + # New-BetaIdentityProfile -BetaIdentityProfile $IdentityProfile + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. + + # Delete an Identity Profile + + try { + Remove-BetaIdentityProfile-BetaIdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Remove-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body. + $RequestBody = @""@ + + + # Delete Identity Profiles + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-BetaIdentityProfiles-BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-BetaIdentityProfiles -BetaRequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq 8c190e6787aa4ed9a90bd9d5344523fb" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) + $Sorters = "name,-priority" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) + + # Export Identity Profiles + + try { + Export-BetaIdentityProfiles + + # Below is a request that includes all optional parameters + # Export-BetaIdentityProfiles -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaIdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + + # Default identity attribute config + + try { + Get-BetaDefaultIdentityAttributeConfig-BetaIdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-BetaDefaultIdentityAttributeConfig -BetaIdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultIdentityAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + + # Gets a single Identity Profile + + try { + Get-BetaIdentityProfile-BetaIdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + + + + + $IdentityProfileExportedObject = @"{ + "self" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "version" : 1, + "object" : { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + } + }"@ + + + # Import Identity Profiles + + try { + $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject + Import-BetaIdentityProfiles-BetaIdentityProfileExportedObject $Result + + # Below is a request that includes all optional parameters + # Import-BetaIdentityProfiles -BetaIdentityProfileExportedObject $IdentityProfileExportedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaIdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq 8c190e6787aa4ed9a90bd9d5344523fb" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional) + $Sorters = "name,-priority" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) + + # Identity Profiles List + + try { + Get-BetaIdentityProfiles + + # Below is a request that includes all optional parameters + # Get-BetaIdentityProfiles -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/identity-preview + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityPreviewRequest = @" + { + "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + } + } + "@ + + # Generate Identity Profile Preview + + try { + $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest + Show-BetaGenerateIdentityPreview-BetaIdentityPreviewRequest $Result + + # Below is a request that includes all optional parameters + # Show-BetaGenerateIdentityPreview -BetaIdentityPreviewRequest $IdentityPreviewRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-BetaGenerateIdentityPreview" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/process-identities + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed + + # Process identities under profile + + try { + Sync-BetaIdentityProfile-BetaIdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Sync-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetaIdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update the Identity Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaIdentityProfile-BetaIdentityProfileId $IdentityProfileId -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaIdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /launchers + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $LauncherRequest = @" + { + "reference" : { + "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", + "type" : "WORKFLOW" + }, + "name" : "Group Create", + "description" : "Create a new Active Directory Group", + "disabled" : false, + "type" : "INTERACTIVE_PROCESS", + "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" + } + "@ + + # Create launcher + + try { + $Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest + New-BetaLauncher-BetaLauncherRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaLauncher -BetaLauncherRequest $LauncherRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaLauncher" + Write-Host $_.ErrorDetails + } +- path: /launchers/{launcherID} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be deleted + + # Delete Launcher + + try { + Remove-BetaLauncher-BetaLauncherID $LauncherID + + # Below is a request that includes all optional parameters + # Remove-BetaLauncher -BetaLauncherID $LauncherID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaLauncher" + Write-Host $_.ErrorDetails + } +- path: /launchers/{launcherID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be retrieved + + # Get Launcher by ID + + try { + Get-BetaLauncher-BetaLauncherID $LauncherID + + # Below is a request that includes all optional parameters + # Get-BetaLauncher -BetaLauncherID $LauncherID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLauncher" + Write-Host $_.ErrorDetails + } +- path: /launchers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "disabled eq "true"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional) + $Next = "eyJuZXh0IjoxMjN9Cg==" # String | Pagination marker (optional) + $Limit = 42 # Int32 | Number of Launchers to return (optional) (default to 10) + + # List all Launchers for tenant + + try { + Get-BetaLaunchers + + # Below is a request that includes all optional parameters + # Get-BetaLaunchers -BetaFilters $Filters -BetaNext $Next -BetaLimit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLaunchers" + Write-Host $_.ErrorDetails + } +- path: /launchers/{launcherID} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be replaced + $LauncherRequest = @" + { + "reference" : { + "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", + "type" : "WORKFLOW" + }, + "name" : "Group Create", + "description" : "Create a new Active Directory Group", + "disabled" : false, + "type" : "INTERACTIVE_PROCESS", + "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" + } + "@ + + # Replace Launcher + + try { + $Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest + Send-BetaLauncher-BetaLauncherID $LauncherID -BetaLauncherRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaLauncher -BetaLauncherID $LauncherID -BetaLauncherRequest $LauncherRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaLauncher" + Write-Host $_.ErrorDetails + } +- path: /beta/launchers/{launcherID}/launch + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be launched + + # Launch a Launcher + + try { + Start-BetaLauncher-BetaLauncherID $LauncherID + + # Below is a request that includes all optional parameters + # Start-BetaLauncher -BetaLauncherID $LauncherID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaLauncher" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity Profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle State ID. + + # Get Lifecycle State + + try { + Get-BetaLifecycleStates-BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Get-BetaLifecycleStates -BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLifecycleStates" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity Profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle State ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Lifecycle State + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaLifecycleStates-BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaLifecycleStates -BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaLifecycleStates" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "aClientId" # String | ID of the Managed Client Status to get + $Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get + + # Specified Managed Client Status. + + try { + Get-BetaManagedClientStatus-BetaId $Id -BetaType $Type + + # Below is a request that includes all optional parameters + # Get-BetaManagedClientStatus -BetaId $Id -BetaType $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id}/status + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "aClientId" # String | ID of the Managed Client Status to update + $ManagedClientStatus = @" + { + "body" : { + "alertKey" : "", + "id" : "5678", + "clusterId" : "1234", + "ccg_etag" : "ccg_etag123xyz456", + "ccg_pin" : "NONE", + "cookbook_etag" : "20210420125956-20210511144538", + "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", + "internal_ip" : "127.0.0.1", + "lastSeen" : "1620843964604", + "sinceSeen" : "14708", + "sinceSeenMillis" : "14708", + "localDev" : false, + "stacktrace" : "", + "status" : "NORMAL", + "product" : "idn", + "platform_version" : "2", + "os_version" : "2345.3.1", + "os_type" : "flatcar", + "hypervisor" : "unknown" + }, + "type" : "CCG", + "status" : "NORMAL", + "timestamp" : "2020-01-01T00:00:00Z" + } + "@ + + # Handle status request from client + + try { + $Result = ConvertFrom-JsonToManagedClientStatus -Json $ManagedClientStatus + Update-BetaManagedClientStatus-BetaId $Id -BetaManagedClientStatus $Result + + # Below is a request that includes all optional parameters + # Update-BetaManagedClientStatus -BetaId $Id -BetaManagedClientStatus $ManagedClientStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "aClusterId" # String | ID of ManagedCluster to get log configuration for + + # Get managed cluster's log configuration + + try { + Get-BetaClientLogConfiguration-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaClientLogConfiguration -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "aClusterId" # String | ID of the ManagedCluster to get + + # Get a specified ManagedCluster. + + try { + Get-BetaManagedCluster-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaManagedCluster -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "operational eq operation" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + + # Retrieve all Managed Clusters. + + try { + Get-BetaManagedClusters + + # Below is a request that includes all optional parameters + # Get-BetaManagedClusters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClusters" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "aClusterId" # String | ID of ManagedCluster to update log configuration for + $ClientLogConfiguration = @" + { + "durationMinutes" : 120, + "rootLevel" : "INFO", + "clientId" : "aClientId", + "expiration" : "2020-12-15T19:13:36.079Z", + "logLevels" : "INFO" + } + "@ + + # Update managed cluster's log configuration + + try { + Send-BetaClientLogConfiguration-BetaId $Id -BetaClientLogConfiguration $Result + + # Below is a request that includes all optional parameters + # Send-BetaClientLogConfiguration -BetaId $Id -BetaClientLogConfiguration $ClientLogConfiguration + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/delete + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + # Delete MFA method configuration + + try { + Remove-BetaMFAConfig-BetaMethod $Method + + # Below is a request that includes all optional parameters + # Remove-BetaMFAConfig -BetaMethod $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaMFAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Configuration of Duo MFA method + + try { + Get-BetaMFADuoConfig + + # Below is a request that includes all optional parameters + # Get-BetaMFADuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + # Configuration of KBA MFA method + + try { + Get-BetaMFAKbaConfig + + # Below is a request that includes all optional parameters + # Get-BetaMFAKbaConfig -BetaAllLanguages $AllLanguages + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFAKbaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Configuration of Okta MFA method + + try { + Get-BetaMFAOktaConfig + + # Below is a request that includes all optional parameters + # Get-BetaMFAOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MfaDuoConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Duo MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-BetaMFADuoConfig-BetaMfaDuoConfig $Result + + # Below is a request that includes all optional parameters + # Set-BetaMFADuoConfig -BetaMfaDuoConfig $MfaDuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ + + + # Set MFA KBA configuration + + try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-BetaMFAKBAConfig-BetaKbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Set-BetaMFAKBAConfig -BetaKbaAnswerRequestItem $KbaAnswerRequestItem + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFAKBAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MfaOktaConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Okta MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-BetaMFAOktaConfig-BetaMfaOktaConfig $Result + + # Below is a request that includes all optional parameters + # Set-BetaMFAOktaConfig -BetaMfaOktaConfig $MfaOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + # MFA method's test configuration + + try { + Test-BetaMFAConfig-BetaMethod $Method + + # Below is a request that includes all optional parameters + # Test-BetaMFAConfig -BetaMethod $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaMFAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/token/send + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SendTokenRequest = @" + { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK" + } + "@ + + # Create and send user token + + try { + $Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest + New-BetaSendToken-BetaSendTokenRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaSendToken -BetaSendTokenRequest $SendTokenRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSendToken" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/poll + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' + $VerificationPollRequest = @" + { + "requestId" : "089899f13a8f4da7824996191587bab9" + } + "@ + + # Polling MFA method by VerificationPollRequest + + try { + $Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest + Ping-BetaVerificationStatus-BetaMethod $Method -BetaVerificationPollRequest $Result + + # Below is a request that includes all optional parameters + # Ping-BetaVerificationStatus -BetaMethod $Method -BetaVerificationPollRequest $VerificationPollRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-BetaVerificationStatus" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/verify + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $DuoVerificationRequest = @" + { + "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", + "userId" : "2c9180947f0ef465017f215cbcfd004b" + } + "@ + + # Verifying authentication via Duo method + + try { + $Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest + Send-BetaDuoVerifyRequest-BetaDuoVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaDuoVerifyRequest -BetaDuoVerificationRequest $DuoVerificationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaDuoVerifyRequest" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/authenticate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ + + + # Authenticate KBA provided MFA method + + try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Send-BetaKbaAnswers-BetaKbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Send-BetaKbaAnswers -BetaKbaAnswerRequestItem $KbaAnswerRequestItem + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaKbaAnswers" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/verify + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OktaVerificationRequest = @" + { + "userId" : "example@mail.com" + } + "@ + + # Verifying authentication via Okta method + + try { + $Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest + Send-BetaOktaVerifyRequest-BetaOktaVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaOktaVerifyRequest -BetaOktaVerificationRequest $OktaVerificationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaOktaVerifyRequest" + Write-Host $_.ErrorDetails + } +- path: /mfa/token/authenticate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TokenAuthRequest = @" + { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK", + "token" : "12345" + } + "@ + + # Authenticate Token provided MFA method + + try { + $Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest + Send-BetaTokenAuthRequest-BetaTokenAuthRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaTokenAuthRequest -BetaTokenAuthRequest $TokenAuthRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTokenAuthRequest" + Write-Host $_.ErrorDetails + } +- path: /multihosts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MultiHostIntegrationsCreate = @" + { + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "connector" : "multihost-microsoft-sql-server", + "connectorAttributes" : { + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "created" : "2022-02-08T14:50:03.827Z", + "name" : "My Multi-Host Integration", + "description" : "This is the Multi-Host Integration.", + "modified" : "2024-01-23T18:08:50.897Z" + } + "@ + + # Create Multi-Host Integration + + try { + $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate + New-BetaMultiHostIntegration-BetaMultiHostIntegrationsCreate $Result + + # Below is a request that includes all optional parameters + # New-BetaMultiHostIntegration -BetaMultiHostIntegrationsCreate $MultiHostIntegrationsCreate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaMultiHostIntegration" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. + $MultiHostIntegrationsCreateSources = @"{ + "connectorAttributes" : { + "authType" : "SQLAuthentication", + "url" : "jdbc:sqlserver://178.18.41.118:1433", + "user" : "username", + "driverClass" : "com.microsoft.sqlserver.jdbc.SQLServerDriver", + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "name" : "My Source", + "description" : "This is the corporate directory." + }"@ + + + # Create Sources Within Multi-Host Integration + + try { + $Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources + New-BetaSourcesWithinMultiHost-BetaId $Id -BetaMultiHostIntegrationsCreateSources $Result + + # Below is a request that includes all optional parameters + # New-BetaSourcesWithinMultiHost -BetaId $Id -BetaMultiHostIntegrationsCreateSources $MultiHostIntegrationsCreateSources + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourcesWithinMultiHost" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete. + + # Delete Multi-Host Integration + + try { + Remove-BetaMultiHost-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaMultiHost -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaMultiHost" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId}/acctAggregationGroups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update + + # Get Account Aggregation Groups Within Multi-Host Integration ID + + try { + Get-BetaAcctAggregationGroups-BetaMultiHostId $MultiHostId + + # Below is a request that includes all optional parameters + # Get-BetaAcctAggregationGroups -BetaMultiHostId $MultiHostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAcctAggregationGroups" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multiHostId}/entitlementAggregationGroups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update + + # Get Entitlement Aggregation Groups Within Multi-Host Integration ID + + try { + Get-BetaEntitlementAggregationGroups-BetaMultiHostId $MultiHostId + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementAggregationGroups -BetaMultiHostId $MultiHostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementAggregationGroups" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. + + # Get Multi-Host Integration By ID + + try { + Get-BetaMultiHostIntegrations-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaMultiHostIntegrations -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostIntegrations" + Write-Host $_.ErrorDetails + } +- path: /multihosts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *in* **forSubAdminId**: *in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + + # List All Existing Multi-Host Integrations + + try { + Get-BetaMultiHostIntegrationsList + + # Below is a request that includes all optional parameters + # Get-BetaMultiHostIntegrationsList -BetaOffset $Offset -BetaLimit $Limit -BetaSorters $Sorters -BetaFilters $Filters -BetaCount $Count -BetaForSubadmin $ForSubadmin + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostIntegrationsList" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multiHostId}/sources/errors + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration + + # List Multi-Host Source Creation Errors + + try { + Get-BetaMultiHostSourceCreationErrors-BetaMultiHostId $MultiHostId + + # Below is a request that includes all optional parameters + # Get-BetaMultiHostSourceCreationErrors -BetaMultiHostId $MultiHostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostSourceCreationErrors" + Write-Host $_.ErrorDetails + } +- path: /multihosts/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Multi-Host Integration Types + + try { + Get-BetaMultihostIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-BetaMultihostIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultihostIntegrationTypes" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{id}/sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Sources Within Multi-Host Integration + + try { + Get-BetaSourcesWithinMultiHost + + # Below is a request that includes all optional parameters + # Get-BetaSourcesWithinMultiHost -BetaOffset $Offset -BetaLimit $Limit -BetaSorters $Sorters -BetaFilters $Filters -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourcesWithinMultiHost" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihost_id}/sources/testConnection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration + + # Test Configuration For Multi-Host Integration + + try { + Test-BetaConnectionMultiHostSources-BetaMultihostId $MultihostId + + # Below is a request that includes all optional parameters + # Test-BetaConnectionMultiHostSources -BetaMultihostId $MultihostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaConnectionMultiHostSources" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihost_id}/sources/{sourceId}/testConnection + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration + $SourceId = "2c91808568c529f60168cca6f90c1324" # String | ID of the source within the Multi-Host Integration + + # Test Configuration For Multi-Host Integration's Single Source + + try { + Test-BetaSourceConnectionMultihost-BetaMultihostId $MultihostId -BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Test-BetaSourceConnectionMultihost -BetaMultihostId $MultihostId -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConnectionMultihost" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MultihostId = "anId" # String | ID of the Multi-Host Integration to update. + $UpdateMultiHostSourcesRequestInner = @"[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]"@ + + + # Update Multi-Host Integration + + try { + $Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner + Update-BetaMultiHostSources-BetaMultihostId $MultihostId -BetaUpdateMultiHostSourcesRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaMultiHostSources -BetaMultihostId $MultihostId -BetaUpdateMultiHostSourcesRequestInner $UpdateMultiHostSourcesRequestInner + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaMultiHostSources" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "MyId" # String | Non-Employee approval item id (UUID) + $NonEmployeeApprovalDecision = @" + { + "comment" : "comment" + } + "@ + + # Approve a Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision + Approve-BetaNonEmployeeRequest-BetaId $Id -BetaNonEmployeeApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Approve-BetaNonEmployeeRequest -BetaId $Id -BetaNonEmployeeApprovalDecision $NonEmployeeApprovalDecision + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Create Non-Employee Record + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-BetaNonEmployeeRecord-BetaNonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-BetaNonEmployeeRecord -BetaNonEmployeeRequestBody $NonEmployeeRequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Create Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-BetaNonEmployeeRequest-BetaNonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-BetaNonEmployeeRequest -BetaNonEmployeeRequestBody $NonEmployeeRequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $NonEmployeeSourceRequestBody = @" + { + "owner" : { + "id" : "2c91808570313110017040b06f344ec9" + }, + "managementWorkgroup" : "123299", + "accountManagers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ], + "name" : "Retail", + "description" : "Source description", + "approvers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ] + } + "@ + + # Create Non-Employee Source + + try { + $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody + New-BetaNonEmployeeSource-BetaNonEmployeeSourceRequestBody $Result + + # Below is a request that includes all optional parameters + # New-BetaNonEmployeeSource -BetaNonEmployeeSourceRequestBody $NonEmployeeSourceRequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id + $NonEmployeeSchemaAttributeBody = @" + { + "helpText" : "The unique identifier for the account", + "label" : "Account Name", + "placeholder" : "Enter a unique user name for this account.", + "type" : "TEXT", + "technicalName" : "account.name", + "required" : true + } + "@ + + # Create Non-Employee Source Schema Attribute + + try { + $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody + New-BetaNonEmployeeSourceSchemaAttributes-BetaSourceId $SourceId -BetaNonEmployeeSchemaAttributeBody $Result + + # Below is a request that includes all optional parameters + # New-BetaNonEmployeeSourceSchemaAttributes -BetaSourceId $SourceId -BetaNonEmployeeSchemaAttributeBody $NonEmployeeSchemaAttributeBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID) + + # Delete Non-Employee Record + + try { + Remove-BetaNonEmployeeRecord-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeRecord -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $DeleteNonEmployeeRecordInBulkRequest = @" + + "@ + + # Delete Multiple Non-Employee Records + + try { + $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordInBulkRequest -Json $DeleteNonEmployeeRecordInBulkRequest + Remove-BetaNonEmployeeRecordInBulk-BetaDeleteNonEmployeeRecordInBulkRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeRecordInBulk -BetaDeleteNonEmployeeRecordInBulkRequest $DeleteNonEmployeeRecordInBulkRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRecordInBulk" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id in the UUID format + + # Delete Non-Employee Request + + try { + Remove-BetaNonEmployeeRequest-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeRequest -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AttributeId = "2c91808b6ef1d43e016efba0ce470904" # String | The Schema Attribute Id (UUID) + $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id + + # Delete Non-Employee Source's Schema Attribute + + try { + Remove-BetaNonEmployeeSchemaAttribute-BetaAttributeId $AttributeId -BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeSchemaAttribute -BetaAttributeId $AttributeId -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id + + # Delete Non-Employee Source + + try { + Remove-BetaNonEmployeeSource-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeSource -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id + + # Delete all custom schema attributes + + try { + Remove-BetaNonEmployeeSourceSchemaAttributes-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeSourceSchemaAttributes -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employees/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID) + + # Exports Non-Employee Records to CSV + + try { + Export-BetaNonEmployeeRecords-BetaId $Id + + # Below is a request that includes all optional parameters + # Export-BetaNonEmployeeRecords -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaNonEmployeeRecords" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/schema-attributes-template/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID) + + # Exports Source Schema Template + + try { + Export-BetaNonEmployeeSourceSchemaTemplate-BetaId $Id + + # Below is a request that includes all optional parameters + # Export-BetaNonEmployeeSourceSchemaTemplate -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaNonEmployeeSourceSchemaTemplate" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | Non-Employee approval item id (UUID) + $IncludeDetail = "include-detail=false" # String | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) + + # Get a non-employee approval item detail + + try { + Get-BetaNonEmployeeApproval-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeApproval -BetaId $Id -BetaIncludeDetail $IncludeDetail + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApproval" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/summary/{requested-for} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + + # Get Summary of Non-Employee Approval Requests + + try { + Get-BetaNonEmployeeApprovalSummary-BetaRequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeApprovalSummary -BetaRequestedFor $RequestedFor + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApprovalSummary" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c918085842e69ae018432d22ccb212f" # String | Source ID (UUID) + + # Bulk upload status on source + + try { + Get-BetaNonEmployeeBulkUploadStatus-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeBulkUploadStatus -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeBulkUploadStatus" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID) + + # Get a Non-Employee Record + + try { + Get-BetaNonEmployeeRecord-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRecord -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id (UUID) + + # Get a Non-Employee Request + + try { + Get-BetaNonEmployeeRequest-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRequest -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/summary/{requested-for} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + + # Get Summary of Non-Employee Requests + + try { + Get-BetaNonEmployeeRequestSummary-BetaRequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRequestSummary -BetaRequestedFor $RequestedFor + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequestSummary" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AttributeId = "2c918085842e69ae018432d22ccb212f" # String | The Schema Attribute Id (UUID) + $SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id + + # Get Schema Attribute Non-Employee Source + + try { + Get-BetaNonEmployeeSchemaAttribute-BetaAttributeId $AttributeId -BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeSchemaAttribute -BetaAttributeId $AttributeId -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id + + # Get a Non-Employee Source + + try { + Get-BetaNonEmployeeSource-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeSource -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id + + # List Schema Attributes Non-Employee Source + + try { + Get-BetaNonEmployeeSourceSchemaAttributes-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeSourceSchemaAttributes -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) + $Data = # System.IO.FileInfo | + + # Imports, or Updates, Non-Employee Records + + try { + Import-BetaNonEmployeeRecordsInBulk-BetaId $Id -BetaData $Data + + # Below is a request that includes all optional parameters + # Import-BetaNonEmployeeRecordsInBulk -BetaId $Id -BetaData $Data + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaNonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity for whom the request was made. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "approvalStatus eq "PENDING"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Get List of Non-Employee Approval Requests + + try { + Get-BetaNonEmployeeApproval + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeApproval -BetaRequestedFor $RequestedFor -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApproval" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "accountName,sourceId" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) + $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + + # List Non-Employee Records + + try { + Get-BetaNonEmployeeRecords + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRecords -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRecords" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "approvalStatus,firstName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) + $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + + # List Non-Employee Requests + + try { + Get-BetaNonEmployeeRequests-BetaRequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRequests -BetaRequestedFor $RequestedFor -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequests" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. + $NonEmployeeCount = $false # Boolean | The flag to determine whether return a non-employee count associate with source. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) + + # List Non-Employee Sources + + try { + Get-BetaNonEmployeeSources-BetaRequestedFor $RequestedFor -BetaNonEmployeeCount $NonEmployeeCount + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeSources -BetaRequestedFor $RequestedFor -BetaNonEmployeeCount $NonEmployeeCount -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSources" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-employee record id (UUID) + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Non-Employee Record + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaNonEmployeeRecord-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaNonEmployeeRecord -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AttributeId = "2c91808b6ef1d43e016efba0ce470904" # String | The Schema Attribute Id (UUID) + $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Non-Employee Source's Schema Attribute + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaNonEmployeeSchemaAttribute-BetaAttributeId $AttributeId -BetaSourceId $SourceId -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaNonEmployeeSchemaAttribute -BetaAttributeId $AttributeId -BetaSourceId $SourceId -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Non-Employee Source + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaNonEmployeeSource-BetaSourceId $SourceId -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaNonEmployeeSource -BetaSourceId $SourceId -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id}/reject + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "MyId" # String | Non-Employee approval item id (UUID) + $NonEmployeeRejectApprovalDecision = @" + { + "comment" : "comment" + } + "@ + + # Reject a Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision + Deny-BetaNonEmployeeRequest-BetaId $Id -BetaNonEmployeeRejectApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Deny-BetaNonEmployeeRequest -BetaId $Id -BetaNonEmployeeRejectApprovalDecision $NonEmployeeRejectApprovalDecision + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-employee record id (UUID) + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Update Non-Employee Record + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + Update-BetaNonEmployeeRecord-BetaId $Id -BetaNonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaNonEmployeeRecord -BetaId $Id -BetaNonEmployeeRequestBody $NonEmployeeRequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /verified-domains + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $DomainAddress = @" + { + "domain" : "sailpoint.com" + } + "@ + + # Verify domain address via DKIM + + try { + $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress + New-BetaDomainDkim-BetaDomainAddress $Result + + # Below is a request that includes all optional parameters + # New-BetaDomainDkim -BetaDomainAddress $DomainAddress + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDomainDkim" + Write-Host $_.ErrorDetails + } +- path: /notification-templates + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TemplateDto = @" + { + "slackTemplate" : "slackTemplate", + "footer" : "footer", + "teamsTemplate" : "teamsTemplate", + "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", + "created" : "2020-01-01T00:00:00Z", + "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", + "medium" : "EMAIL", + "locale" : "en", + "body" : "Please go to the task manager", + "name" : "Task Manager Subscription", + "replyTo" : "$__global.emailFromAddress", + "header" : "header", + "modified" : "2020-01-01T00:00:00Z", + "from" : "$__global.emailFromAddress", + "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", + "key" : "cloud_manual_work_item_summary" + } + "@ + + # Create Notification Template + + try { + $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto + New-BetaNotificationTemplate-BetaTemplateDto $Result + + # Below is a request that includes all optional parameters + # New-BetaNotificationTemplate -BetaTemplateDto $TemplateDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNotificationTemplate" + Write-Host $_.ErrorDetails + } +- path: /verified-from-addresses + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $EmailStatusDto = @" + { + "isVerifiedByDomain" : false, + "verificationStatus" : "PENDING", + "id" : "id", + "email" : "sender@example.com" + } + "@ + + # Create Verified From Address + + try { + $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto + New-BetaVerifiedFromAddress-BetaEmailStatusDto $Result + + # Below is a request that includes all optional parameters + # New-BetaVerifiedFromAddress -BetaEmailStatusDto $EmailStatusDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaVerifiedFromAddress" + Write-Host $_.ErrorDetails + } +- path: /notification-templates/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TemplateBulkDeleteDto = @"{ + "medium" : "EMAIL", + "locale" : "en", + "key" : "cloud_manual_work_item_summary" + }"@ + + + # Bulk Delete Notification Templates + + try { + $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto + Remove-BetaNotificationTemplatesInBulk-BetaTemplateBulkDeleteDto $Result + + # Below is a request that includes all optional parameters + # Remove-BetaNotificationTemplatesInBulk -BetaTemplateBulkDeleteDto $TemplateBulkDeleteDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNotificationTemplatesInBulk" + Write-Host $_.ErrorDetails + } +- path: /verified-from-addresses/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "MyId" # String | + + # Delete Verified From Address + + try { + Remove-BetaVerifiedFromAddress-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaVerifiedFromAddress -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaVerifiedFromAddress" + Write-Host $_.ErrorDetails + } +- path: /verified-domains + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get DKIM Attributes + + try { + Get-BetaDkimAttributes + + # Below is a request that includes all optional parameters + # Get-BetaDkimAttributes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDkimAttributes" + Write-Host $_.ErrorDetails + } +- path: /mail-from-attributes/{identity} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status + + # Get MAIL FROM Attributes + + try { + Get-BetaMailFromAttributes-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaMailFromAttributes -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMailFromAttributes" + Write-Host $_.ErrorDetails + } +- path: /notification-templates/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template + + # Get Notification Template By Id + + try { + Get-BetaNotificationTemplate-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaNotificationTemplate -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplate" + Write-Host $_.ErrorDetails + } +- path: /notification-template-context + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Notification Template Context + + try { + Get-BetaNotificationsTemplateContext + + # Below is a request that includes all optional parameters + # Get-BetaNotificationsTemplateContext + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationsTemplateContext" + Write-Host $_.ErrorDetails + } +- path: /verified-from-addresses + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "email eq "john.doe@company.com"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* (optional) + $Sorters = "email" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) + + # List From Addresses + + try { + Get-BetaFromAddresses + + # Below is a request that includes all optional parameters + # Get-BetaFromAddresses -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFromAddresses" + Write-Host $_.ErrorDetails + } +- path: /notification-preferences/{key} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Notification Preferences for tenant. + + try { + Get-BetaNotificationPreferences + + # Below is a request that includes all optional parameters + # Get-BetaNotificationPreferences + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationPreferences" + Write-Host $_.ErrorDetails + } +- path: /notification-template-defaults + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "key eq "cloud_manual_work_item_summary"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + # List Notification Template Defaults + + try { + Get-BetaNotificationTemplateDefaults + + # Below is a request that includes all optional parameters + # Get-BetaNotificationTemplateDefaults -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplateDefaults" + Write-Host $_.ErrorDetails + } +- path: /notification-templates + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "medium eq "EMAIL"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + # List Notification Templates + + try { + Get-BetaNotificationTemplates + + # Below is a request that includes all optional parameters + # Get-BetaNotificationTemplates -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplates" + Write-Host $_.ErrorDetails + } +- path: /mail-from-attributes + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MailFromAttributesDto = @" + { + "identity" : "BobSmith@sailpoint.com", + "mailFromDomain" : "example.sailpoint.com" + } + "@ + + # Change MAIL FROM domain + + try { + $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto + Send-BetaMailFromAttributes-BetaMailFromAttributesDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaMailFromAttributes -BetaMailFromAttributesDto $MailFromAttributesDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaMailFromAttributes" + Write-Host $_.ErrorDetails + } +- path: /send-test-notification + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SendTestNotificationRequestDto = @" + { + "context" : "{}", + "medium" : "EMAIL", + "key" : "cloud_manual_work_item_summary" + } + "@ + + # Send Test Notification + + try { + $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto + Send-BetaTestNotification-BetaSendTestNotificationRequestDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaTestNotification -BetaSendTestNotificationRequestDto $SendTestNotificationRequestDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTestNotification" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreateOAuthClientRequest = @" + { + "internal" : false, + "businessName" : "Acme-Solar", + "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", + "refreshTokenValiditySeconds" : 86400, + "type" : "CONFIDENTIAL", + "redirectUris" : [ "http://localhost:12345", "http://localhost:67890" ], + "enabled" : true, + "accessType" : "OFFLINE", + "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], + "strongAuthSupported" : false, + "homepageUrl" : "http://localhost:12345", + "accessTokenValiditySeconds" : 750, + "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], + "name" : "Demo API Client", + "claimsSupported" : false + } + "@ + + # Create OAuth Client + + try { + $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest + New-BetaOauthClient-BetaCreateOAuthClientRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaOauthClient -BetaCreateOAuthClientRequest $CreateOAuthClientRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaOauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + + # Delete OAuth Client + + try { + Remove-BetaOauthClient-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaOauthClient -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaOauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + + # Get OAuth Client + + try { + Get-BetaOauthClient-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaOauthClient -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + + # List OAuth Clients + + try { + Get-BetaOauthClients + + # Below is a request that includes all optional parameters + # Get-BetaOauthClients -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOauthClients" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch OAuth Client + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaOauthClient-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaOauthClient -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaOauthClient" + Write-Host $_.ErrorDetails + } +- path: /org-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Org configuration settings + + try { + Get-BetaOrgConfig + + # Below is a request that includes all optional parameters + # Get-BetaOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /org-config/valid-time-zones + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get list of time zones + + try { + Get-BetaValidTimeZones + + # Below is a request that includes all optional parameters + # Get-BetaValidTimeZones + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaValidTimeZones" + Write-Host $_.ErrorDetails + } +- path: /org-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch an Org configuration property + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaOrgConfig-BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaOrgConfig -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Create Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + New-BetaPasswordOrgConfig-BetaPasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # New-BetaPasswordOrgConfig -BetaPasswordOrgConfig $PasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Password Org Config + + try { + Get-BetaPasswordOrgConfig + + # Below is a request that includes all optional parameters + # Get-BetaPasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Update Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + Send-BetaPasswordOrgConfig-BetaPasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaPasswordOrgConfig -BetaPasswordOrgConfig $PasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-dictionary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Password Dictionary + + try { + Get-BetaPasswordDictionary + + # Below is a request that includes all optional parameters + # Get-BetaPasswordDictionary + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordDictionary" + Write-Host $_.ErrorDetails + } +- path: /password-dictionary + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $File = # System.IO.FileInfo | (optional) + + # Update Password Dictionary + + try { + Send-BetaPasswordDictionary + + # Below is a request that includes all optional parameters + # Send-BetaPasswordDictionary -BetaFile $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPasswordDictionary" + Write-Host $_.ErrorDetails + } +- path: /generate-password-reset-token/digit + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordDigitTokenReset = @" + { + "durationMinutes" : 5, + "length" : 8, + "userId" : "Abby.Smith" + } + "@ + + # Generate a digit token + + try { + $Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset + New-BetaDigitToken-BetaPasswordDigitTokenReset $Result + + # Below is a request that includes all optional parameters + # New-BetaDigitToken -BetaPasswordDigitTokenReset $PasswordDigitTokenReset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDigitToken" + Write-Host $_.ErrorDetails + } +- path: /password-change-status/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "MyId" # String | + + # Get Password Change Request Status + + try { + Get-BetaIdentityPasswordChangeStatus-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentityPasswordChangeStatus -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityPasswordChangeStatus" + Write-Host $_.ErrorDetails + } +- path: /query-password-info + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordInfoQueryDTO = @" + { + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + } + "@ + + # Query Password Info + + try { + $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO + Search-BetaPasswordInfo-BetaPasswordInfoQueryDTO $Result + + # Below is a request that includes all optional parameters + # Search-BetaPasswordInfo -BetaPasswordInfoQueryDTO $PasswordInfoQueryDTO + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaPasswordInfo" + Write-Host $_.ErrorDetails + } +- path: /set-password + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordChangeRequest = @" + { + "sourceId" : "8a807d4c73c545510173c545d4b60246", + "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "identityId" : "8a807d4c73c545510173c545f0a002ff", + "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" + } + "@ + + # Set Identity's Password + + try { + $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest + Set-BetaIdentityPassword-BetaPasswordChangeRequest $Result + + # Below is a request that includes all optional parameters + # Set-BetaIdentityPassword -BetaPasswordChangeRequest $PasswordChangeRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaIdentityPassword" + Write-Host $_.ErrorDetails + } +- path: /password-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordPolicyV3Dto = @" + { + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + } + "@ + + # Create Password Policy + + try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + New-BetaPasswordPolicy-BetaPasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # New-BetaPasswordPolicy -BetaPasswordPolicyV3Dto $PasswordPolicyV3Dto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. + + # Delete Password Policy by ID + + try { + Remove-BetaPasswordPolicy-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaPasswordPolicy -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. + + # Get Password Policy by ID + + try { + Get-BetaPasswordPolicyById-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaPasswordPolicyById -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordPolicyById" + Write-Host $_.ErrorDetails + } +- path: /password-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Password Policies + + try { + Get-BetaPasswordPolicies + + # Below is a request that includes all optional parameters + # Get-BetaPasswordPolicies -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordPolicies" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update. + $PasswordPolicyV3Dto = @" + { + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + } + "@ + + # Update Password Policy by ID + + try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + Set-BetaPasswordPolicy-BetaId $Id -BetaPasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # Set-BetaPasswordPolicy -BetaId $Id -BetaPasswordPolicyV3Dto $PasswordPolicyV3Dto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaPasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordSyncGroup = @" + { + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } + "@ + + # Create Password Sync Group + + try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + New-BetaPasswordSyncGroup-BetaPasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # New-BetaPasswordSyncGroup -BetaPasswordSyncGroup $PasswordSyncGroup + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. + + # Delete Password Sync Group by ID + + try { + Remove-BetaPasswordSyncGroup-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaPasswordSyncGroup -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. + + # Get Password Sync Group by ID + + try { + Get-BetaPasswordSyncGroup-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaPasswordSyncGroup -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Get Password Sync Group List + + try { + Get-BetaPasswordSyncGroups + + # Below is a request that includes all optional parameters + # Get-BetaPasswordSyncGroups -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroups" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to update. + $PasswordSyncGroup = @" + { + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } + "@ + + # Update Password Sync Group by ID + + try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + Update-BetaPasswordSyncGroup-BetaId $Id -BetaPasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # Update-BetaPasswordSyncGroup -BetaId $Id -BetaPasswordSyncGroup $PasswordSyncGroup + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreatePersonalAccessTokenRequest = @" + { + "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], + "accessTokenValiditySeconds" : 36900, + "name" : "NodeJS Integration" + } + "@ + + # Create Personal Access Token + + try { + $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest + New-BetaPersonalAccessToken-BetaCreatePersonalAccessTokenRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaPersonalAccessToken -BetaCreatePersonalAccessTokenRequest $CreatePersonalAccessTokenRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id + + # Delete Personal Access Token + + try { + Remove-BetaPersonalAccessToken-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaPersonalAccessToken -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "2c9180867b50d088017b554662fb281e" # String | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) + $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + + # List Personal Access Tokens + + try { + Get-BetaPersonalAccessTokens + + # Below is a request that includes all optional parameters + # Get-BetaPersonalAccessTokens -BetaOwnerId $OwnerId -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPersonalAccessTokens" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Personal Access Token + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaPersonalAccessToken-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaPersonalAccessToken -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /public-identities-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Public Identity Config + + try { + Get-BetaPublicIdentityConfig + + # Below is a request that includes all optional parameters + # Get-BetaPublicIdentityConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPublicIdentityConfig" + Write-Host $_.ErrorDetails + } +- path: /public-identities-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PublicIdentityConfig = @" + { + "modified" : "2018-06-25T20:22:28.104Z", + "attributes" : [ { + "name" : "Country", + "key" : "country" + }, { + "name" : "Country", + "key" : "country" + } ], + "modifiedBy" : { + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + } + "@ + + # Update Public Identity Config + + try { + $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig + Update-BetaPublicIdentityConfig-BetaPublicIdentityConfig $Result + + # Below is a request that includes all optional parameters + # Update-BetaPublicIdentityConfig -BetaPublicIdentityConfig $PublicIdentityConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPublicIdentityConfig" + Write-Host $_.ErrorDetails + } +- path: /requestable-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) + $Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. (optional) + + $Types = @"ROLE,ACCESS_PROFILE"@ + $Term = "Finance Role" # String | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) + $Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional) + + $Statuses = @"[ASSIGNED, PENDING]"@ + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw "bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Requestable Objects List + + try { + Get-BetaRequestableObjects + + # Below is a request that includes all optional parameters + # Get-BetaRequestableObjects -BetaIdentityId $IdentityId -BetaTypes $Types -BetaTerm $Term -BetaStatuses $Statuses -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRequestableObjects" + Write-Host $_.ErrorDetails + } +- path: /role-insights/requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Generate insights for roles + + try { + New-BetaRoleInsightRequests + + # Below is a request that includes all optional parameters + # New-BetaRoleInsightRequests + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRoleInsightRequests" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/entitlement-changes/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $Sorters = "identitiesWithAccess" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) + $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + + # Download entitlement insights for a role + + try { + Invoke-BetaDownloadRoleInsightsEntitlementsChanges-BetaInsightId $InsightId + + # Below is a request that includes all optional parameters + # Invoke-BetaDownloadRoleInsightsEntitlementsChanges -BetaInsightId $InsightId -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaDownloadRoleInsightsEntitlementsChanges" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/entitlement-changes/{entitlementId}/identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $EntitlementId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The entitlement id + $HasEntitlement = $true # Boolean | Identity has this entitlement or not (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "name sw "Jan"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) + + # Get identities for a suggested entitlement (for a role) + + try { + Get-BetaEntitlementChangesIdentities-BetaInsightId $InsightId -BetaEntitlementId $EntitlementId + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementChangesIdentities -BetaInsightId $InsightId -BetaEntitlementId $EntitlementId -BetaHasEntitlement $HasEntitlement -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementChangesIdentities" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + + # Get a single role insight + + try { + Get-BetaRoleInsight-BetaInsightId $InsightId + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsight -BetaInsightId $InsightId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsight" + Write-Host $_.ErrorDetails + } +- path: /role-insights + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "numberOfUpdates" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) + $Filters = "name sw "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) + + # Get role insights + + try { + Get-BetaRoleInsights + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsights -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsights" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/current-entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + + # Get current entitlement for a role + + try { + Get-BetaRoleInsightsCurrentEntitlements-BetaInsightId $InsightId + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsightsCurrentEntitlements -BetaInsightId $InsightId -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsCurrentEntitlements" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/entitlement-changes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) + $Filters = "name sw "Admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + + # Get entitlement insights for a role + + try { + Get-BetaRoleInsightsEntitlementsChanges-BetaInsightId $InsightId + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsightsEntitlementsChanges -BetaInsightId $InsightId -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsEntitlementsChanges" + Write-Host $_.ErrorDetails + } +- path: /role-insights/requests/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insights request id + + # Returns metadata from prior request. + + try { + Get-BetaRoleInsightsRequests-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsightsRequests -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsRequests" + Write-Host $_.ErrorDetails + } +- path: /role-insights/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get role insights summary information + + try { + Get-BetaRoleInsightsSummary + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsightsSummary + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsSummary" + Write-Host $_.ErrorDetails + } +- path: /roles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Role = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "dimensional" : false, + "created" : "2021-03-01T22:32:58.104Z", + "dimensionRefs" : [ { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + }, { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + } ], + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "membership" : { + "identities" : [ { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } ], + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, + "type" : "IDENTITY_LIST" + }, + "enabled" : true, + "revocationRequestConfig" : { + "commentsRequired" : false, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : false + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "legacyMembershipInfo" : { + "type" : "IDENTITY_LIST" + }, + "accessRequestConfig" : { + "commentsRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "name" : "Role 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "accessModelMetadata" : { + "attributes" : [ { + "key" : "iscPrivacy", + "name" : "Privacy", + "multiselect" : false, + "status" : "active", + "type" : "governance", + "objectTypes" : [ "all" ], + "description" : "Specifies the level of privacy associated with an access item.", + "values" : [ { + "value" : "public", + "name" : "Public", + "status" : "active" + } ] + } ] + }, + "id" : "2c918086749d78830174a1a40e121518", + "requestable" : true + } + "@ + + # Create a Role + + try { + $Result = ConvertFrom-JsonToRole -Json $Role + New-BetaRole-BetaRole $Result + + # Below is a request that includes all optional parameters + # New-BetaRole -BetaRole $Role + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRole" + Write-Host $_.ErrorDetails + } +- path: /roles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleBulkDeleteRequest = @" + { + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } + "@ + + # Delete Role(s) + + try { + $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest + Remove-BetaBulkRoles-BetaRoleBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaBulkRoles -BetaRoleBulkDeleteRequest $RoleBulkDeleteRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaBulkRoles" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + + # Delete a Role + + try { + Remove-BetaRole-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaRole -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaRole" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + + # Get a Role + + try { + Get-BetaRole-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaRole -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRole" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/assigned-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role for which the assigned Identities are to be listed + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw Joe" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) + $Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) + + # Identities assigned a Role + + try { + Get-BetaRoleAssignedIdentities-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaRoleAssignedIdentities -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignedIdentities" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the containing role + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + + # List role's Entitlements + + try { + Get-BetaRoleEntitlements-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaRoleEntitlements -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleEntitlements" + Write-Host $_.ErrorDetails + } +- path: /roles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + + # List Roles + + try { + Get-BetaRoles + + # Below is a request that includes all optional parameters + # Get-BetaRoles -BetaForSubadmin $ForSubadmin -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -BetaForSegmentIds $ForSegmentIds -BetaIncludeUnsegmented $IncludeUnsegmented + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoles" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Role + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaRole-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaRole -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRole" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SearchAttributeConfig = @" + { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } + "@ + + # Create Extended Search Attributes + + try { + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-BetaSearchAttributeConfig-BetaSearchAttributeConfig $Result + + # Below is a request that includes all optional parameters + # New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $SearchAttributeConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. + + # Delete Extended Search Attribute + + try { + Remove-BetaSearchAttributeConfig-BetaName $Name + + # Below is a request that includes all optional parameters + # Remove-BetaSearchAttributeConfig -BetaName $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Extended Search Attributes + + try { + Get-BetaSearchAttributeConfig + + # Below is a request that includes all optional parameters + # Get-BetaSearchAttributeConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. + + # Get Extended Search Attribute + + try { + Get-BetaSingleSearchAttributeConfig-BetaName $Name + + # Below is a request that includes all optional parameters + # Get-BetaSingleSearchAttributeConfig -BetaName $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "promotedMailAttribute" # String | Name of the extended search attribute configuration to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Extended Search Attribute + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaSearchAttributeConfig-BetaName $Name -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaSearchAttributeConfig -BetaName $Name -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /segments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Segment = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + } + "@ + + # Create Segment + + try { + $Result = ConvertFrom-JsonToSegment -Json $Segment + New-BetaSegment-BetaSegment $Result + + # Below is a request that includes all optional parameters + # New-BetaSegment -BetaSegment $Segment + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + + # Delete Segment by ID + + try { + Remove-BetaSegment-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSegment -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + + # Get Segment by ID + + try { + Get-BetaSegment-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSegment -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /segments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Segments + + try { + Get-BetaSegments + + # Below is a request that includes all optional parameters + # Get-BetaSegments -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. + $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ + + + # Update Segment + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaSegment-BetaId $Id -BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaSegment -BetaId $Id -BetaRequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } + "@ + + # Create new Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-BetaServiceDeskIntegration-BetaServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $ServiceDeskIntegrationDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "anId" # String | ID of Service Desk integration to delete + + # Delete a Service Desk integration + + try { + Remove-BetaServiceDeskIntegration-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaServiceDeskIntegration -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "anId" # String | ID of the Service Desk integration to get + + # Get a Service Desk integration + + try { + Get-BetaServiceDeskIntegration-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegration -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List existing Service Desk integrations + + try { + Get-BetaServiceDeskIntegrationList + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationList -BetaOffset $Offset -BetaLimit $Limit -BetaSorters $Sorters -BetaFilters $Filters -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + + # Service Desk integration template by scriptName + + try { + Get-BetaServiceDeskIntegrationTemplate-BetaScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationTemplate -BetaScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTemplate" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Service Desk integration types + + try { + Get-BetaServiceDeskIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTypes" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get the time check configuration + + try { + Get-BetaStatusCheckDetails + + # Below is a request that includes all optional parameters + # Get-BetaStatusCheckDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $PatchServiceDeskIntegrationRequest = @" + + "@ + + # Patch a Service Desk Integration + + try { + $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest + Update-BetaServiceDeskIntegration-BetaId $Id -BetaPatchServiceDeskIntegrationRequest $Result + + # Below is a request that includes all optional parameters + # Update-BetaServiceDeskIntegration -BetaId $Id -BetaPatchServiceDeskIntegrationRequest $PatchServiceDeskIntegrationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } + "@ + + # Update a Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-BetaServiceDeskIntegration-BetaId $Id -BetaServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaServiceDeskIntegration -BetaId $Id -BetaServiceDeskIntegrationDto $ServiceDeskIntegrationDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $QueuedCheckConfigDetails = @" + { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } + "@ + + # Update the time check configuration + + try { + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-BetaStatusCheckDetails-BetaQueuedCheckConfigDetails $Result + + # Below is a request that includes all optional parameters + # Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $QueuedCheckConfigDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Create new SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-BetaSIMIntegration-BetaSimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # New-BetaSIMIntegration -BetaSimIntegrationDetails $SimIntegrationDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "12345" # String | The id of the integration to delete. + + # Delete a SIM integration + + try { + Remove-BetaSIMIntegration-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSIMIntegration -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "12345" # String | The id of the integration. + + # Get a SIM integration details. + + try { + Get-BetaSIMIntegration-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSIMIntegration -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List the existing SIM integrations. + + try { + Get-BetaSIMIntegrations + + # Below is a request that includes all optional parameters + # Get-BetaSIMIntegrations + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegrations" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "12345" # String | SIM integration id + $JsonPatch = @" + "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" + "@ + + # Patch a SIM beforeProvisioningRule attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-BetaBeforeProvisioningRule-BetaId $Id -BetaJsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-BetaBeforeProvisioningRule -BetaId $Id -BetaJsonPatch $JsonPatch + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaBeforeProvisioningRule" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "12345" # String | SIM integration id + $JsonPatch = @" + "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" + "@ + + # Patch a SIM attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-BetaSIMAttributes-BetaId $Id -BetaJsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-BetaSIMAttributes -BetaId $Id -BetaJsonPatch $JsonPatch + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSIMAttributes" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "12345" # String | The id of the integration. + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Update an existing SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + Send-BetaSIMIntegration-BetaId $Id -BetaSimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # Send-BetaSIMIntegration -BetaId $Id -BetaSimIntegrationDetails $SimIntegrationDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Create SOD policy + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-BetaSodPolicy-BetaSodPolicy $Result + + # Below is a request that includes all optional parameters + # New-BetaSodPolicy -BetaSodPolicy $SodPolicy + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-BetaSodPolicy-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSodPolicy -BetaId $Id -BetaLogical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-BetaSodPolicySchedule-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSodPolicySchedule -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. + + # Download custom violation report + + try { + Get-BetaCustomViolationReport-BetaReportResultId $ReportResultId -BetaFileName $FileName + + # Below is a request that includes all optional parameters + # Get-BetaCustomViolationReport -BetaReportResultId $ReportResultId -BetaFileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-BetaDefaultViolationReport-BetaReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-BetaDefaultViolationReport -BetaReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get multi-report run task status + + try { + Get-BetaSodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-BetaSodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodAllReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + + # Get SOD policy by ID + + try { + Get-BetaSodPolicy-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSodPolicy -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + + # Get SOD policy schedule + + try { + Get-BetaSodPolicySchedule-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSodPolicySchedule -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + + # Get violation report run status + + try { + Get-BetaSodViolationReportRunStatus-BetaReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-BetaSodViolationReportRunStatus -BetaReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + + # Get SOD violation report status + + try { + Get-BetaSodViolationReportStatus-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSodViolationReportStatus -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + + # List SOD policies + + try { + Get-BetaSodPolicies + + # Below is a request that includes all optional parameters + # Get-BetaSodPolicies -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicies" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The ID of the SOD policy being modified. + $RequestBody = # SystemCollectionsHashtable[] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + $RequestBody = @"[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]"@ + + + # Patch a SOD policy + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaSodPolicy-BetaId $Id -BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaSodPolicy -BetaId $Id -BetaRequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-BetaPolicySchedule-BetaId $Id -BetaSodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-BetaPolicySchedule -BetaId $Id -BetaSodPolicySchedule $SodPolicySchedule + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-BetaSodPolicy-BetaId $Id -BetaSodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-BetaSodPolicy -BetaId $Id -BetaSodPolicy $SodPolicy + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "filteredPolicyList", "filteredPolicyList" ] + } + "@ + + # Runs all policies for org + + try { + Start-BetaSodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-BetaSodAllPoliciesForOrg -BetaMultiPolicyRequest $MultiPolicyRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-BetaSodPolicy-BetaId $Id + + # Below is a request that includes all optional parameters + # Start-BetaSodPolicy -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityWithNewAccess = @" + { + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-BetaPredictSodViolations-BetaIdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-BetaPredictSodViolations -BetaIdentityWithNewAccess $IdentityWithNewAccess + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaPredictSodViolations" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + $ProvisioningPolicyDto = @" + { + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + } + "@ + + # Create Provisioning Policy + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + New-BetaProvisioningPolicy-BetaSourceId $SourceId -BetaProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # New-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaProvisioningPolicyDto $ProvisioningPolicyDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Source = @" + { + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + } + "@ + $ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) + + # Creates a source in IdentityNow. + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + New-BetaSource-BetaSource $Result + + # Below is a request that includes all optional parameters + # New-BetaSource -BetaSource $Source -BetaProvisionAsCsv $ProvisionAsCsv + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSource" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Create Schema on Source + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + New-BetaSourceSchema-BetaSourceId $SourceId -BetaSchema $Result + + # Below is a request that includes all optional parameters + # New-BetaSourceSchema -BetaSourceId $SourceId -BetaSchema $Schema + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Delete Source by ID + + try { + Remove-Beta-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-Beta -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Beta" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/remove-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ebbf35756e1140699ce52b233121384a" # String | The source id + + # Remove All Accounts in a Source + + try { + Remove-BetaAccountsAsync-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaAccountsAsync -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccountsAsync" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/native-change-detection-config + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + + # Delete Native Change Detection Configuration + + try { + Remove-BetaNativeChangeDetectionConfig-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaNativeChangeDetectionConfig -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + # Delete Provisioning Policy by UsageType + + try { + Remove-BetaProvisioningPolicy-BetaSourceId $SourceId -BetaUsageType $UsageType + + # Below is a request that includes all optional parameters + # Remove-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaUsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. + + # Delete Source Schema by ID + + try { + Remove-BetaSourceSchema-BetaSourceId $SourceId -BetaSchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Remove-BetaSourceSchema -BetaSourceId $SourceId -BetaSchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/correlation-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + + # Get Source Correlation Configuration + + try { + Get-BetaCorrelationConfig-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaCorrelationConfig -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCorrelationConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/native-change-detection-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + + # Native Change Detection Configuration + + try { + Get-BetaNativeChangeDetectionConfig-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaNativeChangeDetectionConfig -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + # Get Provisioning Policy by UsageType + + try { + Get-BetaProvisioningPolicy-BetaSourceId $SourceId -BetaUsageType $UsageType + + # Below is a request that includes all optional parameters + # Get-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaUsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Get Source by ID + + try { + Get-BetaSource-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSource -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSource" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + + # Downloads source accounts schema template + + try { + Get-BetaSourceAccountsSchema-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSourceAccountsSchema -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceAccountsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/attribute-sync-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + + # Attribute Sync Config + + try { + Get-BetaSourceAttrSyncConfig-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSourceAttrSyncConfig -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceAttrSyncConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/connectors/source-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "MyId" # String | The Source id + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Gets source config with language translations + + try { + Get-BetaSourceConfig-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSourceConfig -BetaId $Id -BetaLocale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/entitlement-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Source Entitlement Request Configuration + + try { + Get-BetaSourceEntitlementRequestConfig + + # Below is a request that includes all optional parameters + # Get-BetaSourceEntitlementRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + + # Downloads source entitlements schema template + + try { + Get-BetaSourceEntitlementsSchema-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSourceEntitlementsSchema -BetaId $Id -BetaSchemaName $SchemaName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceEntitlementsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. + + # Get Source Schema by ID + + try { + Get-BetaSourceSchema-BetaSourceId $SourceId -BetaSchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Get-BetaSourceSchema -BetaSourceId $SourceId -BetaSchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) + $IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional) + + # List Schemas on Source + + try { + Get-BetaSourceSchemas-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaSourceSchemas -BetaSourceId $SourceId -BetaIncludeTypes $IncludeTypes -BetaIncludeNames $IncludeNames + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceSchemas" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/load-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id + $File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) + $DisableOptimization = "true" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) + + # Account Aggregation + + try { + Import-BetaAccounts-BetaId $Id + + # Below is a request that includes all optional parameters + # Import-BetaAccounts -BetaId $Id -BetaFile $File -BetaDisableOptimization $DisableOptimization + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaAccounts" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/load-entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id + $File = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) + + # Entitlement Aggregation + + try { + Import-BetaEntitlements-BetaId $Id + + # Below is a request that includes all optional parameters + # Import-BetaEntitlements -BetaId $Id -BetaFile $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaEntitlements" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $File = # System.IO.FileInfo | (optional) + + # Uploads source accounts schema template + + try { + Import-BetaSourceAccountsSchema-BetaId $Id + + # Below is a request that includes all optional parameters + # Import-BetaSourceAccountsSchema -BetaId $Id -BetaFile $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceAccountsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/upload-connector-file + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $File = # System.IO.FileInfo | (optional) + + # Upload connector file to source + + try { + Import-BetaSourceConnectorFile-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-BetaSourceConnectorFile -BetaSourceId $SourceId -BetaFile $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceConnectorFile" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + $File = # System.IO.FileInfo | (optional) + + # Uploads source entitlements schema template + + try { + Import-BetaSourceEntitlementsSchema-BetaId $Id + + # Below is a request that includes all optional parameters + # Import-BetaSourceEntitlementsSchema -BetaId $Id -BetaSchemaName $SchemaName -BetaFile $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceEntitlementsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/load-uncorrelated-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id + $File = # System.IO.FileInfo | (optional) + + # Process Uncorrelated Accounts + + try { + Import-BetaUncorrelatedAccounts-BetaId $Id + + # Below is a request that includes all optional parameters + # Import-BetaUncorrelatedAccounts -BetaId $Id -BetaFile $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaUncorrelatedAccounts" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + + # Lists ProvisioningPolicies + + try { + Get-BetaProvisioningPolicies-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaProvisioningPolicies -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProvisioningPolicies" + Write-Host $_.ErrorDetails + } +- path: /sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Employees"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq* **modified**: *eq* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) + $ForSubadmin = "name" # String | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) + $IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false) + + # Lists all sources in IdentityNow. + + try { + Get-BetaSources + + # Below is a request that includes all optional parameters + # Get-BetaSources -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -BetaForSubadmin $ForSubadmin -BetaIncludeIDNSource $IncludeIDNSource + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSources" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/peek-resource-objects + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + $ResourceObjectsRequest = @" + { + "maxCount" : 100, + "objectType" : "group" + } + "@ + + # Peek source connector's resource objects + + try { + $Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest + Receive-BetaResourceObjects-BetaSourceId $SourceId -BetaResourceObjectsRequest $Result + + # Below is a request that includes all optional parameters + # Receive-BetaResourceObjects -BetaSourceId $SourceId -BetaResourceObjectsRequest $ResourceObjectsRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Receive-BetaResourceObjects" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/ping-cluster + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + + # Ping cluster for source connector + + try { + Ping-BetaCluster-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Ping-BetaCluster -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-BetaCluster" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/correlation-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $CorrelationConfig = @" + { + "attributeAssignments" : [ { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + }, { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + } ], + "name" : "Source [source] Account Correlation", + "id" : "2c9180835d191a86015d28455b4a2329" + } + "@ + + # Update Source Correlation Configuration + + try { + $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig + Send-BetaCorrelationConfig-BetaId $Id -BetaCorrelationConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaCorrelationConfig -BetaId $Id -BetaCorrelationConfig $CorrelationConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaCorrelationConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/native-change-detection-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $NativeChangeDetectionConfig = @" + { + "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], + "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], + "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], + "allNonEntitlementAttributes" : false, + "allEntitlements" : false, + "enabled" : true + } + "@ + + # Update Native Change Detection Configuration + + try { + $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig + Send-BetaNativeChangeDetectionConfig-BetaId $Id -BetaNativeChangeDetectionConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaNativeChangeDetectionConfig -BetaId $Id -BetaNativeChangeDetectionConfig $NativeChangeDetectionConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaNativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $ProvisioningPolicyDto = @" + { + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + } + "@ + + # Update Provisioning Policy by UsageType + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Send-BetaProvisioningPolicy-BetaSourceId $SourceId -BetaUsageType $UsageType -BetaProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaUsageType $UsageType -BetaProvisioningPolicyDto $ProvisioningPolicyDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Source = @" + { + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + } + "@ + + # Update Source (Full) + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + Send-BetaSource-BetaId $Id -BetaSource $Result + + # Below is a request that includes all optional parameters + # Send-BetaSource -BetaId $Id -BetaSource $Source + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSource" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/attribute-sync-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $AttrSyncSourceConfig = @" + { + "attributes" : [ { + "name" : "email", + "displayName" : "Email", + "enabled" : true, + "target" : "mail" + }, { + "name" : "firstname", + "displayName" : "First Name", + "enabled" : false, + "target" : "givenName" + } ], + "source" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + } + } + "@ + + # Update Attribute Sync Config + + try { + $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig + Send-BetaSourceAttrSyncConfig-BetaId $Id -BetaAttrSyncSourceConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaSourceAttrSyncConfig -BetaId $Id -BetaAttrSyncSourceConfig $AttrSyncSourceConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSourceAttrSyncConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Update Source Schema (Full) + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + Send-BetaSourceSchema-BetaSourceId $SourceId -BetaSchemaId $SchemaId -BetaSchema $Result + + # Below is a request that includes all optional parameters + # Send-BetaSourceSchema -BetaSourceId $SourceId -BetaSchemaId $SchemaId -BetaSchema $Schema + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/synchronize-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "MyId" # String | The Source id + + # Synchronize single source attributes. + + try { + Sync-BetaAttributesForSource-BetaId $Id + + # Below is a request that includes all optional parameters + # Sync-BetaAttributesForSource -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetaAttributesForSource" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/test-configuration + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + + # Test configuration for source connector + + try { + Test-BetaSourceConfiguration-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Test-BetaSourceConfiguration -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConfiguration" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/check-connection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source. + + # Check connection for source connector. + + try { + Test-BetaSourceConnection-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Test-BetaSourceConnection -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConnection" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ProvisioningPolicyDto = @"{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }"@ + + + # Bulk Update Provisioning Policies + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Update-BetaProvisioningPoliciesInBulk-BetaSourceId $SourceId -BetaProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Update-BetaProvisioningPoliciesInBulk -BetaSourceId $SourceId -BetaProvisioningPolicyDto $ProvisioningPolicyDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProvisioningPoliciesInBulk" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Partial update of Provisioning Policy + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaProvisioningPolicy-BetaSourceId $SourceId -BetaUsageType $UsageType -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaUsageType $UsageType -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaSource-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaSource -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSource" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/entitlement-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceEntitlementRequestConfig = @" + { + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + } + "@ + + # Update Source Entitlement Request Configuration + + try { + $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig + Update-BetaSourceEntitlementRequestConfig-BetaSourceEntitlementRequestConfig $Result + + # Below is a request that includes all optional parameters + # Update-BetaSourceEntitlementRequestConfig -BetaSourceEntitlementRequestConfig $SourceEntitlementRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source Schema (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaSourceSchema-BetaSourceId $SourceId -BetaSchemaId $SchemaId -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaSourceSchema -BetaSourceId $SourceId -BetaSchemaId $SchemaId -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceSchema" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-BetaStatusBySourceId-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaStatusBySourceId -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusBySourceId" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns source usage insights + + try { + Get-BetaUsagesBySourceId-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaUsagesBySourceId -BetaSourceId $SourceId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesBySourceId" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ExportPayload = @" + { + "description" : "Export Job 1 Test" + } + "@ + + # Initiates configuration objects export job + + try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-BetaSpConfig-BetaExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-BetaSpConfig -BetaExportPayload $ExportPayload + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. + + # Download export job result. + + try { + Get-BetaSpConfigExport-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigExport -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. + + # Get export job status + + try { + Get-BetaSpConfigExportStatus-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigExportStatus -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. + + # Download import job result + + try { + Get-BetaSpConfigImport-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigImport -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. + + # Get import job status + + try { + Get-BetaSpConfigImportStatus-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigImportStatus -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) + $Options = @" + "@ + + # Initiates configuration objects import job + + try { + Import-BetaSpConfig-BetaData $Data + + # Below is a request that includes all optional parameters + # Import-BetaSpConfig -BetaData $Data -BetaPreview $Preview -BetaOptions $Options + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get config object details + + try { + Get-BetaSpConfigObjects + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigObjects + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigObjects" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-batches/{batchId}/stats + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id + + # Submit Sed Batch Stats Request + + try { + Get-BetaSedBatchStats-BetaBatchId $BatchId + + # Below is a request that includes all optional parameters + # Get-BetaSedBatchStats -BetaBatchId $BatchId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSedBatchStats" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-batches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Sed Batch Request + + try { + Get-BetaSedBatches + + # Below is a request that includes all optional parameters + # Get-BetaSedBatches + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSedBatches" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-descriptions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = limit=25 # Int64 | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) + $Filters = "displayName co "Read and Write"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) + $Sorters = "sorters=displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) + $Count = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) + $CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) + $RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) + $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) + + # List Suggested Entitlement Descriptions + + try { + Get-BetaSeds + + # Below is a request that includes all optional parameters + # Get-BetaSeds -BetaLimit $Limit -BetaFilters $Filters -BetaSorters $Sorters -BetaCount $Count -BetaCountOnly $CountOnly -BetaRequestedByAnyone $RequestedByAnyone -BetaShowPendingStatusOnly $ShowPendingStatusOnly + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSeds" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-descriptions + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id + $SedPatch = @"{ + "op" : "replace", + "path" : "status", + "value" : "approved" + }"@ + + + # Patch Suggested Entitlement Description + + try { + $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch + Update-BetaSed-BetaId $Id -BetaSedPatch $Result + + # Below is a request that includes all optional parameters + # Update-BetaSed -BetaId $Id -BetaSedPatch $SedPatch + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSed" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-approvals + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SedApproval = @"{ + "items" : "016629d1-1d25-463f-97f3-c6686846650" + }"@ + + + # Submit Bulk Approval Request + + try { + $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval + Submit-BetaSedApproval-BetaSedApproval $Result + + # Below is a request that includes all optional parameters + # Submit-BetaSedApproval -BetaSedApproval $SedApproval + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedApproval" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-assignments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SedAssignment = @" + { + "assignee" : { + "type" : "SOURCE_OWNER", + "value" : "016629d1-1d25-463f-97f3-c6686846650" + }, + "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] + } + "@ + + # Submit Sed Assignment Request + + try { + $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment + Submit-BetaSedAssignment-BetaSedAssignment $Result + + # Below is a request that includes all optional parameters + # Submit-BetaSedAssignment -BetaSedAssignment $SedAssignment + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedAssignment" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-batches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SedBatchRequest = @" + { + "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + } + "@ + + # Submit Sed Batch Request + + try { + Submit-BetaSedBatchRequest + + # Below is a request that includes all optional parameters + # Submit-BetaSedBatchRequest -BetaSedBatchRequest $SedBatchRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedBatchRequest" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "ACCESS_PROFILE" # String | The type of object to delete tags from. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from. + + # Delete Object Tags + + try { + Remove-BetaTaggedObject-BetaType $Type -BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaTaggedObject -BetaType $Type -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/bulk-remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $BulkTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Remove Tags from Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject + Remove-BetaTagsToManyObject-BetaBulkTaggedObject $Result + + # Below is a request that includes all optional parameters + # Remove-BetaTagsToManyObject -BetaBulkTaggedObject $BulkTaggedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTagsToManyObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + + # Get Tagged Object + + try { + Get-BetaTaggedObject-BetaType $Type -BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaTaggedObject -BetaType $Type -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "tagName eq "BU_FINANCE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + + # List Tagged Objects + + try { + Get-BetaTaggedObjects + + # Below is a request that includes all optional parameters + # Get-BetaTaggedObjects -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObjects" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "objectRef.id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + + # List Tagged Objects by Type + + try { + Get-BetaTaggedObjectsByType-BetaType $Type + + # Below is a request that includes all optional parameters + # Get-BetaTaggedObjectsByType -BetaType $Type -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObjectsByType" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to update. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to update. + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Update Tagged Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Send-BetaTaggedObject-BetaType $Type -BetaId $Id -BetaTaggedObject $Result + + # Below is a request that includes all optional parameters + # Send-BetaTaggedObject -BetaType $Type -BetaId $Id -BetaTaggedObject $TaggedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Add Tag to Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Set-BetaTagToObject-BetaTaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-BetaTagToObject -BetaTaggedObject $TaggedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTagToObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/bulk-add + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $BulkTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Tag Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject + Set-BetaTagsToManyObjects-BetaBulkTaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-BetaTagsToManyObjects -BetaBulkTaggedObject $BulkTaggedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTagsToManyObjects" + Write-Host $_.ErrorDetails + } +- path: /tags + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Tag = @" + { + "created" : "2022-05-04T14:48:49Z", + "tagCategoryRefs" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "name" : "PCI", + "modified" : "2022-07-14T16:31:11Z", + "id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f" + } + "@ + + # Create Tag + + try { + $Result = ConvertFrom-JsonToTag -Json $Tag + New-BetaTag-BetaTag $Result + + # Below is a request that includes all optional parameters + # New-BetaTag -BetaTag $Tag + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTag" + Write-Host $_.ErrorDetails + } +- path: /tags/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to delete. + + # Delete Tag + + try { + Remove-BetaTagById-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaTagById -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTagById" + Write-Host $_.ErrorDetails + } +- path: /tags/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to retrieve. + + # Get Tag By Id + + try { + Get-BetaTagById-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaTagById -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTagById" + Write-Host $_.ErrorDetails + } +- path: /tags + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "27462f54-61c7-4140-b5da-d5dbe27fc6db"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified** (optional) + + # List Tags + + try { + Get-BetaTags + + # Below is a request that includes all optional parameters + # Get-BetaTags -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTags" + Write-Host $_.ErrorDetails + } +- path: /task-status/pending-tasks + method: HEAD + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieve Pending Task List Headers + + try { + Get-BetaPendingTaskHeaders + + # Below is a request that includes all optional parameters + # Get-BetaPendingTaskHeaders -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingTaskHeaders" + Write-Host $_.ErrorDetails + } +- path: /task-status/pending-tasks + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieve Pending Task Status List + + try { + Get-BetaPendingTasks + + # Below is a request that includes all optional parameters + # Get-BetaPendingTasks -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingTasks" + Write-Host $_.ErrorDetails + } +- path: /task-status/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. + + # Get Task Status by ID + + try { + Get-BetaTaskStatus-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaTaskStatus -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaskStatus" + Write-Host $_.ErrorDetails + } +- path: /task-status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "completionStatus eq "Success"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) + $Sorters = "-created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) + + # Retrieve Task Status List + + try { + Get-BetaTaskStatusList + + # Below is a request that includes all optional parameters + # Get-BetaTaskStatusList -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaskStatusList" + Write-Host $_.ErrorDetails + } +- path: /task-status/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Task Status by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaTaskStatus-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaTaskStatus -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaTaskStatus" + Write-Host $_.ErrorDetails + } +- path: /tenant + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Tenant Information. + + try { + Get-BetaTenant + + # Below is a request that includes all optional parameters + # Get-BetaTenant + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenant" + Write-Host $_.ErrorDetails + } +- path: /transforms + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Create transform + + try { + $Result = ConvertFrom-JsonToTransform -Json $Transform + New-BetaTransform-BetaTransform $Result + + # Below is a request that includes all optional parameters + # New-BetaTransform -BetaTransform $Transform + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTransform" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete + + # Delete a transform + + try { + Remove-BetaTransform-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaTransform -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTransform" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve + + # Transform by ID + + try { + Get-BetaTransform-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaTransform -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTransform" + Write-Host $_.ErrorDetails + } +- path: /transforms + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional) + $Filters = "name eq "Uppercase"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) + + # List transforms + + try { + Get-BetaTransforms + + # Below is a request that includes all optional parameters + # Get-BetaTransforms -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaName $Name -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTransforms" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Update a transform + + try { + Update-BetaTransform-BetaId $Id + + # Below is a request that includes all optional parameters + # Update-BetaTransform -BetaId $Id -BetaTransform $Transform + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaTransform" + Write-Host $_.ErrorDetails + } +- path: /trigger-invocations/{id}/complete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the invocation to complete. + $CompleteInvocation = @" + { + "output" : { + "approved" : false + }, + "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "error" : "Access request is denied." + } + "@ + + # Complete Trigger Invocation + + try { + $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation + Complete-BetaTriggerInvocation-BetaId $Id -BetaCompleteInvocation $Result + + # Below is a request that includes all optional parameters + # Complete-BetaTriggerInvocation -BetaId $Id -BetaCompleteInvocation $CompleteInvocation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaTriggerInvocation" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SubscriptionPostRequest = @" + { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "triggerId" : "idn:access-requested", + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + } + "@ + + # Create a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest + New-BetaSubscription-BetaSubscriptionPostRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaSubscription -BetaSubscriptionPostRequest $SubscriptionPostRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSubscription" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID + + # Delete a Subscription + + try { + Remove-BetaSubscription-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSubscription -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSubscription" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional) + $Sorters = "triggerName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) + + # List Subscriptions + + try { + Get-BetaSubscriptions + + # Below is a request that includes all optional parameters + # Get-BetaSubscriptions -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSubscriptions" + Write-Host $_.ErrorDetails + } +- path: /trigger-invocations/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "triggerId eq "idn:access-request-dynamic-approver"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) + + # List Latest Invocation Statuses + + try { + Get-BetaTriggerInvocationStatus + + # Below is a request that includes all optional parameters + # Get-BetaTriggerInvocationStatus -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTriggerInvocationStatus" + Write-Host $_.ErrorDetails + } +- path: /triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "idn:access-request-post-approval"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** (optional) + + # List Triggers + + try { + Get-BetaTriggers + + # Below is a request that includes all optional parameters + # Get-BetaTriggers -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTriggers" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription to patch + $SubscriptionPatchRequestInner = @""@ + + + # Patch a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner + Update-BetaSubscription-BetaId $Id -BetaSubscriptionPatchRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaSubscription -BetaId $Id -BetaSubscriptionPatchRequestInner $SubscriptionPatchRequestInner + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSubscription" + Write-Host $_.ErrorDetails + } +- path: /trigger-invocations/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TestInvocation = @" + { + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + }, + "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], + "triggerId" : "idn:access-request-post-approval", + "contentJson" : { + "workflowId" : 1234 + } + } + "@ + + # Start a Test Invocation + + try { + $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation + Start-BetaTestTriggerInvocation-BetaTestInvocation $Result + + # Below is a request that includes all optional parameters + # Start-BetaTestTriggerInvocation -BetaTestInvocation $TestInvocation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaTestTriggerInvocation" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/validate-filter + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ValidateFilterInputDto = @" + { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + } + } + "@ + + # Validate a Subscription Filter + + try { + $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto + Test-BetaSubscriptionFilter-BetaValidateFilterInputDto $Result + + # Below is a request that includes all optional parameters + # Test-BetaSubscriptionFilter -BetaValidateFilterInputDto $ValidateFilterInputDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSubscriptionFilter" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID + $SubscriptionPutRequest = @" + { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + } + "@ + + # Update a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest + Update-BetaSubscription-BetaId $Id -BetaSubscriptionPutRequest $Result + + # Below is a request that includes all optional parameters + # Update-BetaSubscription -BetaId $Id -BetaSubscriptionPutRequest $SubscriptionPutRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSubscription" + Write-Host $_.ErrorDetails + } +- path: /ui-metadata/tenant + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get a tenant UI metadata + + try { + Get-BetaTenantUiMetadata + + # Below is a request that includes all optional parameters + # Get-BetaTenantUiMetadata + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantUiMetadata" + Write-Host $_.ErrorDetails + } +- path: /ui-metadata/tenant + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TenantUiMetadataItemUpdateRequest = @" + { + "usernameEmptyText" : "Please provide your work email address...", + "usernameLabel" : "Email", + "iframeWhiteList" : "http://example.com http://example2.com" + } + "@ + + # Update tenant UI metadata + + try { + $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest + Set-BetaTenantUiMetadata-BetaTenantUiMetadataItemUpdateRequest $Result + + # Below is a request that includes all optional parameters + # Set-BetaTenantUiMetadata -BetaTenantUiMetadataItemUpdateRequest $TenantUiMetadataItemUpdateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTenantUiMetadata" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $VendorConnectorMapping = @" + { + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + } + "@ + + # Create Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + New-BetaVendorConnectorMapping-BetaVendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # New-BetaVendorConnectorMapping -BetaVendorConnectorMapping $VendorConnectorMapping + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaVendorConnectorMapping" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $VendorConnectorMapping = @" + { + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + } + "@ + + # Delete Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + Remove-BetaVendorConnectorMapping-BetaVendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # Remove-BetaVendorConnectorMapping -BetaVendorConnectorMapping $VendorConnectorMapping + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaVendorConnectorMapping" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Vendor Connector Mappings + + try { + Get-BetaVendorConnectorMappings + + # Below is a request that includes all optional parameters + # Get-BetaVendorConnectorMappings + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaVendorConnectorMappings" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-BetaWorkflowExecution-BetaId $Id + + # Below is a request that includes all optional parameters + # Suspend-BetaWorkflowExecution -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreateWorkflowRequest = @" + {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-BetaWorkflow-BetaCreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaWorkflow -BetaCreateWorkflowRequest $CreateWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-BetaWorkflow-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaWorkflow -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Get Workflow By Id + + try { + Get-BetaWorkflow-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflow -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-BetaWorkflowExecution-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecution -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + + # Get Workflow Execution History + + try { + Get-BetaWorkflowExecutionHistory-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecutionHistory -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-BetaWorkflowExecutions-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecutions -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Complete Workflow Library + + try { + Get-BetaCompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-BetaCompleteWorkflowLibrary -BetaLimit $Limit -BetaOffset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Actions + + try { + Get-BetaWorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryActions -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Workflow Library Operators + + try { + Get-BetaWorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Triggers + + try { + Get-BetaWorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryTriggers -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Workflows + + try { + Get-BetaWorkflows + + # Below is a request that includes all optional parameters + # Get-BetaWorkflows + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaWorkflow-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaWorkflow -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $PostExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + Submit-BetaExternalExecuteWorkflow-BetaId $Id + + # Below is a request that includes all optional parameters + # Submit-BetaExternalExecuteWorkflow -BetaId $Id -BetaPostExternalExecuteWorkflowRequest $PostExternalExecuteWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + Submit-BetaWorkflowExternalTrigger-BetaId $Id + + # Below is a request that includes all optional parameters + # Submit-BetaWorkflowExternalTrigger -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-BetaExternalExecuteWorkflow-BetaId $Id + + # Below is a request that includes all optional parameters + # Test-BetaExternalExecuteWorkflow -BetaId $Id -BetaTestExternalExecuteWorkflowRequest $TestExternalExecuteWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-BetaWorkflow-BetaId $Id -BetaTestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-BetaWorkflow -BetaId $Id -BetaTestWorkflowRequest $TestWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "description", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Update-BetaWorkflow-BetaId $Id -BetaWorkflowBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaWorkflow -BetaId $Id -BetaWorkflowBody $WorkflowBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Approve an Approval Item + + try { + Approve-BetaApprovalItem-BetaId $Id -BetaApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Approve-BetaApprovalItem -BetaId $Id -BetaApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk approve Approval Items + + try { + Approve-BetaApprovalItemsInBulk-BetaId $Id + + # Below is a request that includes all optional parameters + # Approve-BetaApprovalItemsInBulk -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Complete a Work Item + + try { + Complete-BetaWorkItem-BetaId $Id + + # Below is a request that includes all optional parameters + # Complete-BetaWorkItem -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaWorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $WorkItemForward = @" + { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } + "@ + + # Forward a Work Item + + try { + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Invoke-BetaForwardWorkItem-BetaId $Id -BetaWorkItemForward $Result + + # Below is a request that includes all optional parameters + # Invoke-BetaForwardWorkItem -BetaId $Id -BetaWorkItemForward $WorkItemForward + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardWorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "MyOwnerId" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Completed Work Items + + try { + Get-BetaCompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-BetaCompletedWorkItems -BetaOwnerId $OwnerId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + + # Count Completed Work Items + + try { + Get-BetaCountCompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-BetaCountCompletedWorkItems -BetaOwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountCompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + + # Count Work Items + + try { + Get-BetaCountWorkItems + + # Below is a request that includes all optional parameters + # Get-BetaCountWorkItems -BetaOwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "MyId" # String | ID of the work item. + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + + # Get a Work Item + + try { + Get-BetaWorkItem-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkItem -BetaId $Id -BetaOwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + + # Work Items Summary + + try { + Get-BetaWorkItemsSummary + + # Below is a request that includes all optional parameters + # Get-BetaWorkItemsSummary -BetaOwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItemsSummary" + Write-Host $_.ErrorDetails + } +- path: /work-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + + # List Work Items + + try { + Get-BetaWorkItems + + # Below is a request that includes all optional parameters + # Get-BetaWorkItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaOwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Reject an Approval Item + + try { + Deny-BetaApprovalItem-BetaId $Id -BetaApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Deny-BetaApprovalItem -BetaId $Id -BetaApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk reject Approval Items + + try { + Deny-BetaApprovalItemsInBulk-BetaId $Id + + # Below is a request that includes all optional parameters + # Deny-BetaApprovalItemsInBulk -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName + + # Submit Account Selections + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-BetaAccountSelection-BetaId $Id -BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Submit-BetaAccountSelection -BetaId $Id -BetaRequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaAccountSelection" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ + + # Create a Reassignment Configuration + + try { + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + New-BetaReassignmentConfiguration-BetaConfigurationItemRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaReassignmentConfiguration -BetaConfigurationItemRequest $ConfigurationItemRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId}/{configType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | + + # Delete Reassignment Configuration + + try { + Remove-BetaReassignmentConfiguration-BetaIdentityId $IdentityId -BetaConfigType $ConfigType + + # Below is a request that includes all optional parameters + # Remove-BetaReassignmentConfiguration -BetaIdentityId $IdentityId -BetaConfigType $ConfigType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId}/evaluate/{configType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type + $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) + + $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ + + # Evaluate Reassignment Configuration + + try { + Get-BetaEvaluateReassignmentConfiguration-BetaIdentityId $IdentityId -BetaConfigType $ConfigType + + # Below is a request that includes all optional parameters + # Get-BetaEvaluateReassignmentConfiguration -BetaIdentityId $IdentityId -BetaConfigType $ConfigType -BetaExclusionFilters $ExclusionFilters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEvaluateReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Reassignment Config Types + + try { + Get-BetaReassignmentConfigTypes + + # Below is a request that includes all optional parameters + # Get-BetaReassignmentConfigTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigTypes" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id + + # Get Reassignment Configuration + + try { + Get-BetaReassignmentConfiguration-BetaIdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Get-BetaReassignmentConfiguration -BetaIdentityId $IdentityId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/tenant-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Tenant-wide Reassignment Configuration settings + + try { + Get-BetaTenantConfigConfiguration + + # Below is a request that includes all optional parameters + # Get-BetaTenantConfigConfiguration + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantConfigConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Reassignment Configurations + + try { + Get-BetaReassignmentConfigurations + + # Below is a request that includes all optional parameters + # Get-BetaReassignmentConfigurations + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigurations" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ + + # Update Reassignment Configuration + + try { + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + Send-BetaReassignmentConfig-BetaIdentityId $IdentityId -BetaConfigurationItemRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaReassignmentConfig -BetaIdentityId $IdentityId -BetaConfigurationItemRequest $ConfigurationItemRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaReassignmentConfig" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/tenant-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TenantConfigurationRequest = @" + { + "configDetails" : { + "disabled" : true + } + } + "@ + + # Update Tenant-wide Reassignment Configuration settings + + try { + $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest + Send-BetaTenantConfiguration-BetaTenantConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaTenantConfiguration -BetaTenantConfigurationRequest $TenantConfigurationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTenantConfiguration" + Write-Host $_.ErrorDetails + } diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccessModelMetadataApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccessModelMetadataApi.md new file mode 100644 index 000000000..b3a486fee --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccessModelMetadataApi.md @@ -0,0 +1,205 @@ + +--- +id: beta-access-model-metadata +title: AccessModelMetadata +pagination_label: AccessModelMetadata +sidebar_label: AccessModelMetadata +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessModelMetadata', 'BetaAccessModelMetadata'] +slug: /tools/sdk/powershell/beta/methods/access-model-metadata +tags: ['SDK', 'Software Development Kit', 'AccessModelMetadata', 'BetaAccessModelMetadata'] +--- + +# AccessModelMetadata + Use this API to create and manage metadata attributes for your Access Model. +Access Model Metadata allows you to add contextual information to your ISC Access Model items using pre-defined metadata for risk, regulations, privacy levels, etc., or by creating your own metadata attributes to reflect the unique needs of your organization. This release of the API includes support for entitlement metadata. Support for role and access profile metadata will be introduced in a subsequent release. + +Common usages for Access Model metadata include: + +- Organizing and categorizing access items to make it easier for your users to search for and find the access rights they want to request, certify, or manage. + +- Providing richer information about access that is being acted on to allow stakeholders to make better decisions when approving, certifying, or managing access rights. + +- Identifying access that may requires additional approval requirements or be subject to more frequent review. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaAccessModelMetadataAttribute**](#get-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes/{key}` | Get Access Model Metadata Attribute +[**Get-BetaAccessModelMetadataAttributeValue**](#get-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values/{value}` | Get Access Model Metadata Value +[**Get-BetaAccessModelMetadataAttribute**](#list-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes` | List Access Model Metadata Attributes +[**Get-BetaAccessModelMetadataAttributeValue**](#list-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values` | List Access Model Metadata Values + +## get-access-model-metadata-attribute +Get single Access Model Metadata Attribute + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Key | **String** | True | Technical name of the Attribute. + +### Return type +[**AttributeDTO**](../models/attribute-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | OK | AttributeDTO +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Key = "iscPrivacy" # String | Technical name of the Attribute. + +# Get Access Model Metadata Attribute + +try { + Get-BetaAccessModelMetadataAttribute-BetaKey $Key + + # Below is a request that includes all optional parameters + # Get-BetaAccessModelMetadataAttribute -BetaKey $Key +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-access-model-metadata-attribute-value +Get single Access Model Metadata Attribute Value + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Key | **String** | True | Technical name of the Attribute. +Path | Value | **String** | True | Technical name of the Attribute value. + +### Return type +[**AttributeValueDTO**](../models/attribute-value-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | OK | AttributeValueDTO +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Key = "iscPrivacy" # String | Technical name of the Attribute. +$Value = "public" # String | Technical name of the Attribute value. + +# Get Access Model Metadata Value + +try { + Get-BetaAccessModelMetadataAttributeValue-BetaKey $Key -BetaValue $Value + + # Below is a request that includes all optional parameters + # Get-BetaAccessModelMetadataAttributeValue -BetaKey $Key -BetaValue $Value +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-access-model-metadata-attribute +Get a list of Access Model Metadata Attributes + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* + +### Return type +[**AttributeDTO[]**](../models/attribute-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | OK | AttributeDTO[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Filters = 'name eq "Privacy"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) + +# List Access Model Metadata Attributes + +try { + Get-BetaAccessModelMetadataAttribute + + # Below is a request that includes all optional parameters + # Get-BetaAccessModelMetadataAttribute -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-access-model-metadata-attribute-value +Get a list of Access Model Metadata Attribute Values + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Key | **String** | True | Technical name of the Attribute. + +### Return type +[**AttributeValueDTO[]**](../models/attribute-value-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | OK | AttributeValueDTO[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Key = "iscPrivacy" # String | Technical name of the Attribute. + +# List Access Model Metadata Values + +try { + Get-BetaAccessModelMetadataAttributeValue-BetaKey $Key + + # Below is a request that includes all optional parameters + # Get-BetaAccessModelMetadataAttributeValue -BetaKey $Key +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccessProfilesApi.md new file mode 100644 index 000000000..8c303063c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccessProfilesApi.md @@ -0,0 +1,546 @@ + +--- +id: beta-access-profiles +title: AccessProfiles +pagination_label: AccessProfiles +sidebar_label: AccessProfiles +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfiles', 'BetaAccessProfiles'] +slug: /tools/sdk/powershell/beta/methods/access-profiles +tags: ['SDK', 'Software Development Kit', 'AccessProfiles', 'BetaAccessProfiles'] +--- + +# AccessProfiles + Use this API to implement and customize access profile functionality. +With this functionality in place, administrators can create access profiles and configure them for use throughout Identity Security Cloud, enabling users to get the access they need quickly and securely. + +Access profiles group entitlements, which represent access rights on sources. + +For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +Access profiles are the most important units of access in Identity Security Cloud. Identity Security Cloud uses access profiles in many features, including the following: + +- Provisioning: When you use the Provisioning Service, lifecycle states and roles both grant access to users in the form of access profiles. + +- Certifications: You can approve or revoke access profiles in certification campaigns, just like entitlements. + +- Access Requests: You can assign access profiles to applications, and when a user requests access to the app associated with an access profile and someone approves the request, access is granted to both the application and its associated access profile. + +- Roles: You can group one or more access profiles into a role to quickly assign access items based on an identity's role. + +In Identity Security Cloud, administrators can use the Access drop-down menu and select Access Profiles to view, configure, and delete existing access profiles, as well as create new ones. +Administrators can enable and disable an access profile, and they can also make the following configurations: + +- Manage Entitlements: Manage the profile's access by adding and removing entitlements. + +- Access Requests: Configure access profiles to be requestable and establish an approval process for any requests that the access profile be granted or revoked. +Do not configure an access profile to be requestable without first establishing a secure access request approval process for the access profile. + +- Multiple Account Options: Define the logic Identity Security Cloud uses to provision access to an identity with multiple accounts on the source. + +Refer to [Managing Access Profiles](https://documentation.sailpoint.com/saas/help/access/access-profiles.html) for more information about access profiles. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaAccessProfile**](#create-access-profile) | **POST** `/access-profiles` | Create Access Profile +[**Remove-BetaAccessProfile**](#delete-access-profile) | **DELETE** `/access-profiles/{id}` | Delete the specified Access Profile +[**Remove-BetaAccessProfilesInBulk**](#delete-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-delete` | Delete Access Profile(s) +[**Get-BetaAccessProfile**](#get-access-profile) | **GET** `/access-profiles/{id}` | Get an Access Profile +[**Get-BetaAccessProfileEntitlements**](#get-access-profile-entitlements) | **GET** `/access-profiles/{id}/entitlements` | List Access Profile's Entitlements +[**Get-BetaAccessProfiles**](#list-access-profiles) | **GET** `/access-profiles` | List Access Profiles +[**Update-BetaAccessProfile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified Access Profile +[**Update-BetaAccessProfilesInBulk**](#update-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-update-requestable` | Update Access Profile(s) requestable field. + +## create-access-profile +Use this API to create an access profile. +A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source. +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | AccessProfile | [**AccessProfile**](../models/access-profile) | True | + +### Return type +[**AccessProfile**](../models/access-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Access profile created. | AccessProfile +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$AccessProfile = @"{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "description" : "Collection of entitlements to read/write the employee database", + "source" : { + "name" : "ODS-AD-SOURCE", + "id" : "2c91809773dee3610173fdb0b6061ef4", + "type" : "SOURCE" + }, + "enabled" : true, + "revocationRequestConfig" : { + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ] + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "accessRequestConfig" : { + "commentsRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "name" : "Employee-database-read-write", + "provisioningCriteria" : { + "children" : [ { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, + "modified" : "2021-03-02T20:22:28.104Z", + "id" : "2c91808a7190d06e01719938fcd20792", + "requestable" : true +}"@ + +# Create Access Profile + +try { + $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile + New-BetaAccessProfile-BetaAccessProfile $Result + + # Below is a request that includes all optional parameters + # New-BetaAccessProfile -BetaAccessProfile $AccessProfile +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-access-profile +This API deletes an existing Access Profile. + +The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. + +A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a SOURCE_SUBADMIN token must be able to administer the Source associated with the Access Profile. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Access Profile to delete + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Returned when an access profile cannot be deleted as it's being used. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete + +# Delete the specified Access Profile + +try { + Remove-BetaAccessProfile-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaAccessProfile -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-access-profiles-in-bulk +This endpoint initiates a bulk deletion of one or more access profiles. +When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. +This endpoint can only bulk delete up to a limit of 50 access profiles per request. +By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | AccessProfileBulkDeleteRequest | [**AccessProfileBulkDeleteRequest**](../models/access-profile-bulk-delete-request) | True | + +### Return type +[**AccessProfileBulkDeleteResponse**](../models/access-profile-bulk-delete-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returned only if **bestEffortOnly** is **false**, and one or more Access Profiles are in use. | AccessProfileBulkDeleteResponse +202 | Returned if at least one deletion will be performed. | AccessProfileBulkDeleteResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$AccessProfileBulkDeleteRequest = @"{ + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true +}"@ + +# Delete Access Profile(s) + +try { + $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest + Remove-BetaAccessProfilesInBulk-BetaAccessProfileBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaAccessProfilesInBulk -BetaAccessProfileBulkDeleteRequest $AccessProfileBulkDeleteRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfilesInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-access-profile +This API returns an Access Profile by its ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Access Profile + +### Return type +[**AccessProfile**](../models/access-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An AccessProfile | AccessProfile +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile + +# Get an Access Profile + +try { + Get-BetaAccessProfile-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccessProfile -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-access-profile-entitlements +Use this API to get a list of an access profile's entitlements. +A user with SOURCE_SUBADMIN authority must have access to the source associated with the specified access profile. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the access profile containing the entitlements. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** + +### Return type +[**Entitlement[]**](../models/entitlement) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of entitlements. | Entitlement[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements. +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'attribute eq "memberOf"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + +# List Access Profile's Entitlements + +try { + Get-BetaAccessProfileEntitlements-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccessProfileEntitlements -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfileEntitlements" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-access-profiles +Use this API to get a list of access profiles. +A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | ForSubadmin | **String** | (optional) | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin. + Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** + Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. + Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. + +### Return type +[**AccessProfile[]**](../models/access-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of access profiles. | AccessProfile[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin. (optional) +$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'name eq "SailPoint Support"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) +$ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) +$IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + +# List Access Profiles + +try { + Get-BetaAccessProfiles + + # Below is a request that includes all optional parameters + # Get-BetaAccessProfiles -BetaForSubadmin $ForSubadmin -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -BetaForSegmentIds $ForSegmentIds -BetaIncludeUnsegmented $IncludeUnsegmented +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfiles" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-access-profile +This API updates an existing Access Profile. The following fields are patchable: +**name**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria** +A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. +> The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. + +> You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Access Profile to patch + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**AccessProfile**](../models/access-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the Access Profile as updated. | AccessProfile +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | + + +# Patch a specified Access Profile + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaAccessProfile-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaAccessProfile -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccessProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-access-profiles-in-bulk +This API initiates a bulk update of field requestable for one or more Access Profiles. + +> If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** + list of the response.Requestable field of these Access Profiles marked as **true** or **false**. + +> If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. +A SOURCE_SUBADMIN user may only use this API to update Access Profiles which are associated with Sources they are able to administer. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | AccessProfileBulkUpdateRequestInner | [**[]AccessProfileBulkUpdateRequestInner**](../models/access-profile-bulk-update-request-inner) | True | + +### Return type +[**AccessProfileUpdateItem[]**](../models/access-profile-update-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +207 | List of updated and not updated Access Profiles. | AccessProfileUpdateItem[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +412 | Precondition Failed - Returned in response if API/Feature not enabled for an organization. | UpdateAccessProfilesInBulk412Response +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell + $AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ # AccessProfileBulkUpdateRequestInner[] | + + +# Update Access Profile(s) requestable field. + +try { + $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner + Update-BetaAccessProfilesInBulk-BetaAccessProfileBulkUpdateRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaAccessProfilesInBulk -BetaAccessProfileBulkUpdateRequestInner $AccessProfileBulkUpdateRequestInner +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccessProfilesInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccessRequestApprovalsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccessRequestApprovalsApi.md new file mode 100644 index 000000000..e52e4afaa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccessRequestApprovalsApi.md @@ -0,0 +1,347 @@ + +--- +id: beta-access-request-approvals +title: AccessRequestApprovals +pagination_label: AccessRequestApprovals +sidebar_label: AccessRequestApprovals +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestApprovals', 'BetaAccessRequestApprovals'] +slug: /tools/sdk/powershell/beta/methods/access-request-approvals +tags: ['SDK', 'Software Development Kit', 'AccessRequestApprovals', 'BetaAccessRequestApprovals'] +--- + +# AccessRequestApprovals + Use this API to implement and customize access request approval functionality. +With this functionality in place, administrators can delegate qualified users to review users' requests for access or managers' requests to revoke team members' access to applications, entitlements, or roles. +This enables more qualified users to review access requests and the others to spend their time on other tasks. + +In Identity Security Cloud, users can request access to applications, entitlements, and roles, and managers can request that team members' access be revoked. +For applications and entitlements, administrators can set access profiles to require approval from the access profile owner, the application owner, the source owner, the requesting user's manager, or a governance group for access to be granted or revoked. +For roles, administrators can also set roles to allow access requests and require approval from the role owner, the requesting user's manager, or a governance group for access to be granted or revoked. +If the administrator designates a governance group as the required approver, any governance group member can approve the requests. + +When a user submits an access request, Identity Security Cloud sends the first required approver in the queue an email notification, based on the access request configuration's approval and reminder escalation configuration. + +In Approvals in Identity Security Cloud, required approvers can view pending access requests under the Requested tab and approve or deny them, or the approvers can reassign the requests to different reviewers for approval. +If the required approver approves the request and is the only reviewer required, Identity Security Cloud grants or revokes access, based on the request. +If multiple reviewers are required, Identity Security Cloud sends the request to the next reviewer in the queue, based on the access request configuration's approval reminder and escalation configuration. +The required approver can then view any completed access requests under the Reviewed tab. + +Refer to [Access Requests](https://documentation.sailpoint.com/saas/help/requests/index.html) for more information about access request approvals. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Approve-BetaAccessRequest**](#approve-access-request) | **POST** `/access-request-approvals/{approvalId}/approve` | Approve Access Request Approval +[**Invoke-BetaForwardAccessRequest**](#forward-access-request) | **POST** `/access-request-approvals/{approvalId}/forward` | Forward Access Request Approval +[**Get-BetaAccessRequestApprovalSummary**](#get-access-request-approval-summary) | **GET** `/access-request-approvals/approval-summary` | Get Access Requests Approvals Number +[**Get-BetaCompletedApprovals**](#list-completed-approvals) | **GET** `/access-request-approvals/completed` | Completed Access Request Approvals List +[**Get-BetaPendingApprovals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending Access Request Approvals List +[**Deny-BetaAccessRequest**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval + +## approve-access-request +Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ApprovalId | **String** | True | Approval ID. + Body | CommentDto | [**CommentDto**](../models/comment-dto) | True | Reviewer's comment. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. +$CommentDto = @"{ + "author" : { + "name" : "Adam Kennedy", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2017-07-11T18:45:37.098Z", + "comment" : "This is a comment." +}"@ + +# Approve Access Request Approval + +try { + $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto + Approve-BetaAccessRequest-BetaApprovalId $ApprovalId -BetaCommentDto $Result + + # Below is a request that includes all optional parameters + # Approve-BetaAccessRequest -BetaApprovalId $ApprovalId -BetaCommentDto $CommentDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaAccessRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## forward-access-request +Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ApprovalId | **String** | True | Approval ID. + Body | ForwardApprovalDto | [**ForwardApprovalDto**](../models/forward-approval-dto) | True | Information about the forwarded approval. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. +$ForwardApprovalDto = @"{ + "newOwnerId" : "newOwnerId", + "comment" : "comment" +}"@ + +# Forward Access Request Approval + +try { + $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto + Invoke-BetaForwardAccessRequest-BetaApprovalId $ApprovalId -BetaForwardApprovalDto $Result + + # Below is a request that includes all optional parameters + # Invoke-BetaForwardAccessRequest -BetaApprovalId $ApprovalId -BetaForwardApprovalDto $ForwardApprovalDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardAccessRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-access-request-approval-summary +Use this API to return the number of pending, approved and rejected access requests approvals. See the "owner-id" query parameter for authorization information. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | OwnerId | **String** | (optional) | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. + Query | FromDate | **String** | (optional) | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. + +### Return type +[**ApprovalSummary**](../models/approval-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Number of pending, approved, rejected access request approvals. | ApprovalSummary +400 | Client Error - Returned if the query parameter is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OwnerId = "2c91808568c529c60168cca6f90c1313" # String | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) +$FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + +# Get Access Requests Approvals Number + +try { + Get-BetaAccessRequestApprovalSummary + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestApprovalSummary -BetaOwnerId $OwnerId -BetaFromDate $FromDate +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestApprovalSummary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-completed-approvals +This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | OwnerId | **String** | (optional) | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** + +### Return type +[**CompletedApproval[]**](../models/completed-approval) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Completed Approvals. | CompletedApproval[] +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OwnerId = "MyOwnerId" # String | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'MyFilters' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) +$Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + +# Completed Access Request Approvals List + +try { + Get-BetaCompletedApprovals + + # Below is a request that includes all optional parameters + # Get-BetaCompletedApprovals -BetaOwnerId $OwnerId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedApprovals" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-pending-approvals +This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | OwnerId | **String** | (optional) | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** + +### Return type +[**PendingApproval[]**](../models/pending-approval) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Pending Approvals. | PendingApproval[] +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OwnerId = "MyOwnerId" # String | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'MyFilters' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional) +$Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + +# Pending Access Request Approvals List + +try { + Get-BetaPendingApprovals + + # Below is a request that includes all optional parameters + # Get-BetaPendingApprovals -BetaOwnerId $OwnerId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingApprovals" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## reject-access-request +Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ApprovalId | **String** | True | Approval ID. + Body | CommentDto | [**CommentDto**](../models/comment-dto) | True | Reviewer's comment. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. +$CommentDto = @"{ + "author" : { + "name" : "Adam Kennedy", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2017-07-11T18:45:37.098Z", + "comment" : "This is a comment." +}"@ + +# Reject Access Request Approval + +try { + $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto + Deny-BetaAccessRequest-BetaApprovalId $ApprovalId -BetaCommentDto $Result + + # Below is a request that includes all optional parameters + # Deny-BetaAccessRequest -BetaApprovalId $ApprovalId -BetaCommentDto $CommentDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaAccessRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccessRequestIdentityMetricsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccessRequestIdentityMetricsApi.md new file mode 100644 index 000000000..f9fb44c8c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccessRequestIdentityMetricsApi.md @@ -0,0 +1,72 @@ + +--- +id: beta-access-request-identity-metrics +title: AccessRequestIdentityMetrics +pagination_label: AccessRequestIdentityMetrics +sidebar_label: AccessRequestIdentityMetrics +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestIdentityMetrics', 'BetaAccessRequestIdentityMetrics'] +slug: /tools/sdk/powershell/beta/methods/access-request-identity-metrics +tags: ['SDK', 'Software Development Kit', 'AccessRequestIdentityMetrics', 'BetaAccessRequestIdentityMetrics'] +--- + +# AccessRequestIdentityMetrics + Use this API to implement access request identity metrics functionality. +With this functionality in place, access request reviewers can see relevant details about the requested access item and associated source activity. +This allows reviewers to see how many of the identities who share a manager with the access requester have this same type of access and how many of them have had activity in the related source. +This additional context about whether the access has been granted before and how often it has been used can help those approving access requests make more informed decisions. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaAccessRequestIdentityMetrics**](#get-access-request-identity-metrics) | **GET** `/access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type}` | Return access request identity metrics + +## get-access-request-identity-metrics +Use this API to return information access metrics. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityId | **String** | True | Manager's identity ID. +Path | RequestedObjectId | **String** | True | Requested access item's ID. +Path | Type | **String** | True | Requested access item's type. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Summary of the resource access and source activity for the direct reports of the provided manager. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID. +$RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID. +$Type = "ENTITLEMENT" # String | Requested access item's type. + +# Return access request identity metrics + +try { + Get-BetaAccessRequestIdentityMetrics-BetaIdentityId $IdentityId -BetaRequestedObjectId $RequestedObjectId -BetaType $Type + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestIdentityMetrics -BetaIdentityId $IdentityId -BetaRequestedObjectId $RequestedObjectId -BetaType $Type +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestIdentityMetrics" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccessRequestsApi.md new file mode 100644 index 000000000..c93fda14a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccessRequestsApi.md @@ -0,0 +1,445 @@ + +--- +id: beta-access-requests +title: AccessRequests +pagination_label: AccessRequests +sidebar_label: AccessRequests +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequests', 'BetaAccessRequests'] +slug: /tools/sdk/powershell/beta/methods/access-requests +tags: ['SDK', 'Software Development Kit', 'AccessRequests', 'BetaAccessRequests'] +--- + +# AccessRequests + Use this API to implement and customize access request functionality. +With this functionality in place, users can request access to applications, entitlements, or roles, and managers can request that team members' access be revoked. +This allows users to get access to the tools they need quickly and securely, and it allows managers to take away access to those tools. + +Identity Security Cloud's Access Request service allows end users to request access that requires approval before it can be granted to users and enables qualified users to review those requests and approve or deny them. + +In the Request Center in Identity Security Cloud, users can view available applications, roles, and entitlements and request access to them. +If the requested tools requires approval, the requests appear as 'Pending' under the My Requests tab until the required approver approves, rejects, or cancels them. + +Users can use My Requests to track and/or cancel the requests. + +In My Team on the Identity Security Cloud Home, managers can submit requests to revoke their team members' access. +They can use the My Requests tab under Request Center to track and/or cancel the requests. + +Refer to [Requesting Access](https://documentation.sailpoint.com/saas/user-help/requests/requesting_access.html) for more information about access requests. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Suspend-BetaAccessRequest**](#cancel-access-request) | **POST** `/access-requests/cancel` | Cancel Access Request +[**Close-BetaAccessRequest**](#close-access-request) | **POST** `/access-requests/close` | Close Access Request +[**New-BetaAccessRequest**](#create-access-request) | **POST** `/access-requests` | Submit Access Request +[**Get-BetaAccessRequestConfig**](#get-access-request-config) | **GET** `/access-request-config` | Get Access Request Configuration +[**Get-BetaAccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status +[**Set-BetaAccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration + +## cancel-access-request +This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. +In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CancelAccessRequest | [**CancelAccessRequest**](../models/cancel-access-request) | True | + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CancelAccessRequest = @"{ + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." +}"@ + +# Cancel Access Request + +try { + $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest + Suspend-BetaAccessRequest-BetaCancelAccessRequest $Result + + # Below is a request that includes all optional parameters + # Suspend-BetaAccessRequest -BetaCancelAccessRequest $CancelAccessRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaAccessRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## close-access-request +This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). + +To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND "Access Request". Use the Column Chooser to select 'Tracking Number', and use the 'Download' button to export a CSV containing the tracking numbers. + +To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). + +Input the IDs from either source. + +To track the status of endpoint requests, navigate to Search and use this query: name:"Close Identity Requests". Search will include "Close Identity Requests Started" audits when requests are initiated and "Close Identity Requests Completed" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. + +This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/provisioning-completed/) for each access request that is closed. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CloseAccessRequest | [**CloseAccessRequest**](../models/close-access-request) | True | + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CloseAccessRequest = @"{ + "executionStatus" : "Terminated", + "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "completionStatus" : "Failure", + "message" : "The IdentityNow Administrator manually closed this request." +}"@ + +# Close Access Request + +try { + $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest + Close-BetaAccessRequest-BetaCloseAccessRequest $Result + + # Below is a request that includes all optional parameters + # Close-BetaAccessRequest -BetaCloseAccessRequest $CloseAccessRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-BetaAccessRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-access-request +Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. + +Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request +has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn't return an error +if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. + +It's best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can +be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also +use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting +an access request to ensure that you aren't requesting access that is already granted. If you use this API to request access that an identity already has, the API will ignore the request. +These ignored requests do not display when you use the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) API. + +There are two types of access request: + +__GRANT_ACCESS__ +* Can be requested for multiple identities in a single request. +* Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. +* Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. +* Roles, access profiles and entitlements can be requested. +* While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. + +__REVOKE_ACCESS__ +* Can only be requested for a single identity at a time. +* You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. +* Does not support self request. Only manager can request to revoke access for their directly managed employees. +* If a `removeDate` is specified, then the access will be removed on that date and time only for roles, access profiles and entitlements. +* Roles, access profiles, and entitlements can be requested for revocation. +* Revoke requests for entitlements are limited to 1 entitlement per access request currently. +* You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. +* Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | AccessRequest | [**AccessRequest**](../models/access-request) | True | + +### Return type +[**AccessRequestResponse**](../models/access-request-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Access Request Response. | AccessRequestResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$AccessRequest = @"{ + "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + } ] +}"@ + +# Submit Access Request + +try { + $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest + New-BetaAccessRequest-BetaAccessRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaAccessRequest -BetaAccessRequest $AccessRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-access-request-config +This endpoint returns the current access-request configuration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**AccessRequestConfig**](../models/access-request-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Access Request Configuration Details. | AccessRequestConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Access Request Configuration + +try { + Get-BetaAccessRequestConfig + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-access-request-status +Use this API to return a list of access request statuses based on the specified query parameters. +If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. +Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | RequestedFor | **String** | (optional) | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | RequestedBy | **String** | (optional) | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | RegardingIdentity | **String** | (optional) | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. + Query | AssignedTo | **String** | (optional) | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. + Query | Count | **Boolean** | (optional) (default to $false) | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. + Query | Offset | **Int32** | (optional) | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** + Query | RequestState | **String** | (optional) | Filter the results by the state of the request. The only valid value is *EXECUTING*. + +### Return type +[**RequestedItemStatus[]**](../models/requested-item-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of requested item statuses. | RequestedItemStatus[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) +$RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) +$RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) +$AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) +$Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) +$Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) +$Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) +$Filters = 'accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) +$Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) +$RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + +# Access Request Status + +try { + Get-BetaAccessRequestStatus + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestStatus -BetaRequestedFor $RequestedFor -BetaRequestedBy $RequestedBy -BetaRegardingIdentity $RegardingIdentity -BetaAssignedTo $AssignedTo -BetaCount $Count -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters -BetaSorters $Sorters -BetaRequestState $RequestState +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-access-request-config +This endpoint replaces the current access-request configuration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | AccessRequestConfig | [**AccessRequestConfig**](../models/access-request-config) | True | + +### Return type +[**AccessRequestConfig**](../models/access-request-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Access Request Configuration Details. | AccessRequestConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$AccessRequestConfig = @"{ + "requestOnBehalfOfConfig" : { + "allowRequestOnBehalfOfEmployeeByManager" : true, + "allowRequestOnBehalfOfAnyoneByAnyone" : true + }, + "approvalReminderAndEscalationConfig" : { + "fallbackApproverRef" : { + "name" : "Alison Ferguso", + "id" : "5168015d32f890ca15812c9180835d2e", + "type" : "IDENTITY", + "email" : "alison.ferguso@identitysoon.com" + }, + "maxReminders" : 1, + "daysUntilEscalation" : 0, + "daysBetweenReminders" : 0 + }, + "autoApprovalEnabled" : true, + "entitlementRequestConfig" : { + "requestCommentsRequired" : false, + "deniedCommentsRequired" : false, + "allowEntitlementRequest" : true, + "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + }, + "reauthorizationEnabled" : true, + "approvalsMustBeExternal" : true +}"@ + +# Update Access Request Configuration + +try { + $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig + Set-BetaAccessRequestConfig-BetaAccessRequestConfig $Result + + # Below is a request that includes all optional parameters + # Set-BetaAccessRequestConfig -BetaAccessRequestConfig $AccessRequestConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaAccessRequestConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccountActivitiesApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccountActivitiesApi.md new file mode 100644 index 000000000..1df84d2d4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccountActivitiesApi.md @@ -0,0 +1,157 @@ + +--- +id: beta-account-activities +title: AccountActivities +pagination_label: AccountActivities +sidebar_label: AccountActivities +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivities', 'BetaAccountActivities'] +slug: /tools/sdk/powershell/beta/methods/account-activities +tags: ['SDK', 'Software Development Kit', 'AccountActivities', 'BetaAccountActivities'] +--- + +# AccountActivities + Use this API to implement account activity tracking functionality. +With this functionality in place, users can track source account activity in Identity Security Cloud, which greatly improves traceability in the system. + +An account activity refers to a log of each action performed on a source account. This is useful for auditing the changes that occur on an account throughout its life. +In Identity Security Cloud's Search, users can search for account activities and select the activity's row to get an overview of the activity's account action and view its progress, its involved sources, and its most basic metadata, such as the identity requesting the option and the recipient. + +Account activity includes most actions Identity Security Cloud completes on source accounts. Users can search in Identity Security Cloud for the following account action types: + +- Access Request: These include any access requests the source account is involved in. + +- Account Attribute Updates: These include updates to a single attribute on an account on a source. + +- Account State Update: These include locking or unlocking actions on an account on a source. + +- Certification: These include actions removing an entitlement from an account on a source as a result of the entitlement's revocation during a certification. + +- Cloud Automated `Lifecyclestate`: These include automated lifecycle state changes that result in a source account's correlated identity being assigned to a different lifecycle state. +Identity Security Cloud replaces the `Lifecyclestate` variable with the name of the lifecycle state it has moved the account's identity to. + +- Identity Attribute Update: These include updates to a source account's correlated identity attributes as the result of a provisioning action. +When you update an identity attribute that also updates an identity's lifecycle state, the cloud automated `Lifecyclestate` event also displays. +Account Activity does not include attribute updates that occur as a result of aggregation. + +- Identity Refresh: These include correlated identity refreshes that occur for an account on a source whenever the account's correlated identity profile gets a new role or updates. +These also include refreshes that occur whenever Identity Security Cloud assigns an application to the account's correlated identity based on the application's being assigned to All Users From Source or Specific Users From Source. + +- Lifecycle State Refresh: These include the actions that took place when a lifecycle state changed. This event only occurs after a cloud automated `Lifecyclestate` change or a lifecycle state change. + +- Lifecycle State Change: These include the account activities that result from an identity's manual assignment to a null lifecycle state. + +- Password Change: These include password changes on sources. + +Refer to [Account Activity](https://documentation.sailpoint.com/saas/help/search/index.html#account-activity) for more information about account activities. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaAccountActivity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get Account Activity +[**Get-BetaAccountActivities**](#list-account-activities) | **GET** `/account-activities` | List Account Activities + +## get-account-activity +This gets a single account activity by its id. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The account activity id + +### Return type +[**CancelableAccountActivity**](../models/cancelable-account-activity) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An account activity object | CancelableAccountActivity +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id + +# Get Account Activity + +try { + Get-BetaAccountActivity-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccountActivity -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountActivity" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-account-activities +This gets a collection of account activities that satisfy the given query parameters. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | RequestedFor | **String** | (optional) | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | RequestedBy | **String** | (optional) | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | RegardingIdentity | **String** | (optional) | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. + Query | Type | **String** | (optional) | The type of account activity. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** + +### Return type +[**CancelableAccountActivity[]**](../models/cancelable-account-activity) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of account activities | CancelableAccountActivity[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RequestedFor = "MyRequestedFor" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) +$RequestedBy = "MyRequestedBy" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) +$RegardingIdentity = "MyRegardingIdentity" # String | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) +$Type = "MyType" # String | The type of account activity. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'MyFilters' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) +$Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) + +# List Account Activities + +try { + Get-BetaAccountActivities + + # Below is a request that includes all optional parameters + # Get-BetaAccountActivities -BetaRequestedFor $RequestedFor -BetaRequestedBy $RequestedBy -BetaRegardingIdentity $RegardingIdentity -BetaType $Type -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountActivities" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccountAggregationsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccountAggregationsApi.md new file mode 100644 index 000000000..0597d1edc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccountAggregationsApi.md @@ -0,0 +1,82 @@ + +--- +id: beta-account-aggregations +title: AccountAggregations +pagination_label: AccountAggregations +sidebar_label: AccountAggregations +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAggregations', 'BetaAccountAggregations'] +slug: /tools/sdk/powershell/beta/methods/account-aggregations +tags: ['SDK', 'Software Development Kit', 'AccountAggregations', 'BetaAccountAggregations'] +--- + +# AccountAggregations + Use this API to implement account aggregation progress tracking functionality. +With this functionality in place, administrators can view in-progress account aggregations, their statuses, and their relevant details. + +An account aggregation refers to the process Identity Security Cloud uses to gather and load account data from a source into Identity Security Cloud. + +Whenever Identity Security Cloud is in the process of aggregating a source, it adds an entry to the Aggregation Activity Log, along with its relevant details. +To view aggregation activity, administrators can select the Connections drop-down menu, select Sources, and select the relevant source, select its Import Data tab, and select Account Aggregation. +In Account Aggregation, administrators can view the account aggregations' statuses and details in the Account Activity Log. + +Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about account aggregations. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaAccountAggregationStatus**](#get-account-aggregation-status) | **GET** `/account-aggregations/{id}/status` | In-progress Account Aggregation status + +## get-account-aggregation-status +This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. + +Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. + +Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. + +*Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* + +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN or DASHBOARD authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The account aggregation id + +### Return type +[**AccountAggregationStatus**](../models/account-aggregation-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An account aggregation status object | AccountAggregationStatus +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id + +# In-progress Account Aggregation status + +try { + Get-BetaAccountAggregationStatus-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccountAggregationStatus -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountAggregationStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccountUsagesApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccountUsagesApi.md new file mode 100644 index 000000000..486a8f04e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccountUsagesApi.md @@ -0,0 +1,75 @@ + +--- +id: beta-account-usages +title: AccountUsages +pagination_label: AccountUsages +sidebar_label: AccountUsages +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUsages', 'BetaAccountUsages'] +slug: /tools/sdk/powershell/beta/methods/account-usages +tags: ['SDK', 'Software Development Kit', 'AccountUsages', 'BetaAccountUsages'] +--- + +# AccountUsages + Use this API to implement account usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' source accounts are being used. +This allows organizations to get the information they need to start optimizing and securing source account usage. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaUsagesByAccountId**](#get-usages-by-account-id) | **GET** `/account-usages/{accountId}/summaries` | Returns account usage insights + +## get-usages-by-account-id +This API returns a summary of account usage insights for past 12 months. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | AccountId | **String** | True | ID of IDN account + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** + +### Return type +[**AccountUsage[]**](../models/account-usage) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Summary of account usage insights for past 12 months. | AccountUsage[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + +# Returns account usage insights + +try { + Get-BetaUsagesByAccountId-BetaAccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-BetaUsagesByAccountId -BetaAccountId $AccountId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesByAccountId" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccountsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccountsApi.md new file mode 100644 index 000000000..cef8b3fbf --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAccountsApi.md @@ -0,0 +1,860 @@ + +--- +id: beta-accounts +title: Accounts +pagination_label: Accounts +sidebar_label: Accounts +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Accounts', 'BetaAccounts'] +slug: /tools/sdk/powershell/beta/methods/accounts +tags: ['SDK', 'Software Development Kit', 'Accounts', 'BetaAccounts'] +--- + +# Accounts + Use this API to implement and customize account functionality. +With this functionality in place, administrators can manage users' access across sources in Identity Security Cloud. + +In Identity Security Cloud, an account refers to a user's account on a supported source. +This typically includes a unique identifier for the user, a unique password, a set of permissions associated with the source and a set of attributes. Identity Security Cloud loads accounts through the creation of sources in Identity Security Cloud. + +Administrators can correlate users' identities with the users' accounts on the different sources they use. +This allows Identity Security Cloud to govern the access of identities and all their correlated accounts securely and cohesively. + +To view the accounts on a source and their correlated identities, administrators can use the Connections drop-down menu, select Sources, select the relevant source, and select its Account tab. + +To view and edit source account statuses for an identity in Identity Security Cloud, administrators can use the Identities drop-down menu, select Identity List, select the relevant identity, and select its Accounts tab. +Administrators can toggle an account's Actions to aggregate the account, enable/disable it, unlock it, or remove it from the identity. + +Accounts can have the following statuses: + +- Enabled: The account is enabled. The user can access it. + +- Disabled: The account is disabled, and the user cannot access it, but the identity is not disabled in Identity Security Cloud. This can occur when an administrator disables the account or when the user's lifecycle state changes. + +- Locked: The account is locked. This may occur when someone has entered an incorrect password for the account too many times. + +- Pending: The account is currently updating. This status typically lasts seconds. + +Administrators can select the source account to view its attributes, entitlements, and the last time the account's password was changed. + +Refer to [Managing User Accounts](https://documentation.sailpoint.com/saas/help/common/users/user_access.html#managing-user-accounts) for more information about accounts. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaAccount**](#create-account) | **POST** `/accounts` | Create Account +[**Remove-BetaAccount**](#delete-account) | **DELETE** `/accounts/{id}` | Delete Account +[**Remove-BetaAccountAsync**](#delete-account-async) | **POST** `/accounts/{id}/remove` | Remove Account +[**Disable-BetaAccount**](#disable-account) | **POST** `/accounts/{id}/disable` | Disable Account +[**Disable-BetaAccountForIdentity**](#disable-account-for-identity) | **POST** `/identities-accounts/{id}/disable` | Disable IDN Account for Identity +[**Disable-BetaAccountsForIdentities**](#disable-accounts-for-identities) | **POST** `/identities-accounts/disable` | Disable IDN Accounts for Identities +[**Enable-BetaAccount**](#enable-account) | **POST** `/accounts/{id}/enable` | Enable Account +[**Enable-BetaAccountForIdentity**](#enable-account-for-identity) | **POST** `/identities-accounts/{id}/enable` | Enable IDN Account for Identity +[**Enable-BetaAccountsForIdentities**](#enable-accounts-for-identities) | **POST** `/identities-accounts/enable` | Enable IDN Accounts for Identities +[**Get-BetaAccount**](#get-account) | **GET** `/accounts/{id}` | Account Details +[**Get-BetaAccountEntitlements**](#get-account-entitlements) | **GET** `/accounts/{id}/entitlements` | Account Entitlements +[**Get-BetaAccounts**](#list-accounts) | **GET** `/accounts` | Accounts List +[**Send-BetaAccount**](#put-account) | **PUT** `/accounts/{id}` | Update Account +[**Submit-BetaReloadAccount**](#submit-reload-account) | **POST** `/accounts/{id}/reload` | Reload Account +[**Unlock-BetaAccount**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account +[**Update-BetaAccount**](#update-account) | **PATCH** `/accounts/{id}` | Update Account + +## create-account +Submits an account creation task - the API then returns the task ID. + +The `sourceId` where this account will be created must be included in the `attributes` object. + +This endpoint creates an account on the source record in your ISC tenant. +This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. + +However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. +The endpoint doesn't actually provision the account on the target source, which means that if the account doesn't also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. + +By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | AccountAttributesCreate | [**AccountAttributesCreate**](../models/account-attributes-create) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Async task details. | AccountsAsyncResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$AccountAttributesCreate = @"{ + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } +}"@ + +# Create Account + +try { + $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate + New-BetaAccount-BetaAccountAttributesCreate $Result + + # Below is a request that includes all optional parameters + # New-BetaAccount -BetaAccountAttributesCreate $AccountAttributesCreate +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccount" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-account +Use this API to delete an account. +This endpoint submits an account delete task and returns the task ID. +This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. +>**NOTE:** You can only delete accounts from sources of the "DelimitedFile" type.** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Account ID. + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Async task details. | AccountsAsyncResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + +# Delete Account + +try { + Remove-BetaAccount-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaAccount -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccount" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-account-async +Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. + +This endpoint is good for: +* Removing accounts that no longer exist on the source. +* Removing accounts that won't be aggregated following updates to the source configuration. +* Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The account id + +### Return type +[**TaskResultDto**](../models/task-result-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted. Returns task result details of removal request. | TaskResultDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id + +# Remove Account + +try { + Remove-BetaAccountAsync-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaAccountAsync -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccountAsync" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## disable-account +This API submits a task to disable the account and returns the task ID. +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The account id + Body | AccountToggleRequest | [**AccountToggleRequest**](../models/account-toggle-request) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Async task details | AccountsAsyncResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id +$AccountToggleRequest = @"{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" +}"@ + +# Disable Account + +try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Disable-BetaAccount-BetaId $Id -BetaAccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Disable-BetaAccount -BetaId $Id -BetaAccountToggleRequest $AccountToggleRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccount" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## disable-account-for-identity +This API submits a task to disable IDN account for a single identity. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity id. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808384203c2d018437e631158309" # String | The identity id. + +# Disable IDN Account for Identity + +try { + Disable-BetaAccountForIdentity-BetaId $Id + + # Below is a request that includes all optional parameters + # Disable-BetaAccountForIdentity -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccountForIdentity" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## disable-accounts-for-identities +This API submits tasks to disable IDN account for each identity provided in the request body. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | IdentitiesAccountsBulkRequest | [**IdentitiesAccountsBulkRequest**](../models/identities-accounts-bulk-request) | True | + +### Return type +[**BulkIdentitiesAccountsResponse[]**](../models/bulk-identities-accounts-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +207 | Bulk response details. | BulkIdentitiesAccountsResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$IdentitiesAccountsBulkRequest = @"{ + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] +}"@ + +# Disable IDN Accounts for Identities + +try { + $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest + Disable-BetaAccountsForIdentities-BetaIdentitiesAccountsBulkRequest $Result + + # Below is a request that includes all optional parameters + # Disable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccountsForIdentities" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## enable-account +This API submits a task to enable account and returns the task ID. +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The account id + Body | AccountToggleRequest | [**AccountToggleRequest**](../models/account-toggle-request) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Async task details | AccountsAsyncResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id +$AccountToggleRequest = @"{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" +}"@ + +# Enable Account + +try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Enable-BetaAccount-BetaId $Id -BetaAccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Enable-BetaAccount -BetaId $Id -BetaAccountToggleRequest $AccountToggleRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccount" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## enable-account-for-identity +This API submits a task to enable IDN account for a single identity. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity id. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808384203c2d018437e631158309" # String | The identity id. + +# Enable IDN Account for Identity + +try { + Enable-BetaAccountForIdentity-BetaId $Id + + # Below is a request that includes all optional parameters + # Enable-BetaAccountForIdentity -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccountForIdentity" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## enable-accounts-for-identities +This API submits tasks to enable IDN account for each identity provided in the request body. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | IdentitiesAccountsBulkRequest | [**IdentitiesAccountsBulkRequest**](../models/identities-accounts-bulk-request) | True | + +### Return type +[**BulkIdentitiesAccountsResponse[]**](../models/bulk-identities-accounts-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +207 | Bulk response details. | BulkIdentitiesAccountsResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$IdentitiesAccountsBulkRequest = @"{ + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] +}"@ + +# Enable IDN Accounts for Identities + +try { + $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest + Enable-BetaAccountsForIdentities-BetaIdentitiesAccountsBulkRequest $Result + + # Below is a request that includes all optional parameters + # Enable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccountsForIdentities" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-account +Use this API to return the details for a single account by its ID. +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Account ID. + +### Return type +[**Account**](../models/account) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Account object. | Account +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + +# Account Details + +try { + Get-BetaAccount-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccount -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccount" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-account-entitlements +This API returns entitlements of the account. +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The account id + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**Entitlement[]**](../models/entitlement) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An array of account entitlements | Entitlement[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Account Entitlements + +try { + Get-BetaAccountEntitlements-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccountEntitlements -BetaId $Id -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountEntitlements" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-accounts +List accounts. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | DetailLevel | **String** | (optional) | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** + +### Return type +[**Account[]**](../models/account) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of account objects. | Account[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (optional) +$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + +# Accounts List + +try { + Get-BetaAccounts + + # Below is a request that includes all optional parameters + # Get-BetaAccounts -BetaDetailLevel $DetailLevel -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccounts" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-account +Use this API to update an account with a PUT request. + +This endpoint submits an account update task and returns the task ID. + +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +>**Note: You can only use this PUT endpoint to update accounts from flat file sources.** + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Account ID. + Body | AccountAttributes | [**AccountAttributes**](../models/account-attributes) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Async task details. | AccountsAsyncResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. +$AccountAttributes = @"{ + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } +}"@ + +# Update Account + +try { + $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes + Send-BetaAccount-BetaId $Id -BetaAccountAttributes $Result + + # Below is a request that includes all optional parameters + # Send-BetaAccount -BetaId $Id -BetaAccountAttributes $AccountAttributes +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaAccount" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## submit-reload-account +This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The account id + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Async task details | AccountsAsyncResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + +# Reload Account + +try { + Submit-BetaReloadAccount-BetaId $Id + + # Below is a request that includes all optional parameters + # Submit-BetaReloadAccount -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaReloadAccount" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## unlock-account +This API submits a task to unlock an account and returns the task ID. +To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The account ID. + Body | AccountUnlockRequest | [**AccountUnlockRequest**](../models/account-unlock-request) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Async task details | AccountsAsyncResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. +$AccountUnlockRequest = @"{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false +}"@ + +# Unlock Account + +try { + $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest + Unlock-BetaAccount-BetaId $Id -BetaAccountUnlockRequest $Result + + # Below is a request that includes all optional parameters + # Unlock-BetaAccount -BetaId $Id -BetaAccountUnlockRequest $AccountUnlockRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-BetaAccount" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-account +Use this API to update account details. +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +This API supports updating an account's correlation by modifying the `identityId` and `manuallyCorrelated` fields. +To reassign an account from one identity to another, replace the current `identityId` with a new value. +If the account you're assigning was provisioned by Identity Security Cloud (ISC), it's possible for ISC to create a new account +for the previous identity as soon as the account is moved. If the account you're assigning is authoritative, +this causes the previous identity to become uncorrelated and can even result in its deletion. +All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. + +>**Note:** The `attributes` field can only be modified for flat file accounts. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Account ID. + Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | True | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. +$RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"{Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}}"@ # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +# Update Account + +try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaAccount-BetaId $Id -BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaAccount -BetaId $Id -BetaRequestBody $RequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccount" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaApplicationDiscoveryApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaApplicationDiscoveryApi.md new file mode 100644 index 000000000..9131036d6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaApplicationDiscoveryApi.md @@ -0,0 +1,258 @@ + +--- +id: beta-application-discovery +title: ApplicationDiscovery +pagination_label: ApplicationDiscovery +sidebar_label: ApplicationDiscovery +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApplicationDiscovery', 'BetaApplicationDiscovery'] +slug: /tools/sdk/powershell/beta/methods/application-discovery +tags: ['SDK', 'Software Development Kit', 'ApplicationDiscovery', 'BetaApplicationDiscovery'] +--- + +# ApplicationDiscovery + Use this API to implement application discovery functionality. +With this functionality in place, you can discover applications within your Okta connector and receive connector recommendations by manually uploading application names. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaDiscoveredApplicationByID**](#get-discovered-application-by-id) | **GET** `/discovered-applications/{id}` | Get Discovered Application by ID +[**Get-BetaDiscoveredApplications**](#get-discovered-applications) | **GET** `/discovered-applications` | Retrieve discovered applications for tenant +[**Get-BetaManualDiscoverApplicationsCsvTemplate**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download CSV Template for Discovery +[**Update-BetaDiscoveredApplicationByID**](#patch-discovered-application-by-id) | **PATCH** `/discovered-applications/{id}` | Patch Discovered Application by ID +[**Send-BetaManualDiscoverApplicationsCsvTemplate**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload CSV to Discover Applications + +## get-discovered-application-by-id +Get the discovered application, along with with its associated sources, based on the provided ID. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Discovered application's ID. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns the discovered application, along with its associated sources. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID. + +# Get Discovered Application by ID + +try { + Get-BetaDiscoveredApplicationByID-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaDiscoveredApplicationByID -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDiscoveredApplicationByID" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-discovered-applications +Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Detail | **String** | (optional) | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. + Query | Filter | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** + +### Return type +[**GetDiscoveredApplications200ResponseInner[]**](../models/get-discovered-applications200-response-inner) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of discovered applications. By default, the API returns a list of SLIM discovered applications. | GetDiscoveredApplications200ResponseInner[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) +$Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) + +# Retrieve discovered applications for tenant + +try { + Get-BetaDiscoveredApplications + + # Below is a request that includes all optional parameters + # Get-BetaDiscoveredApplications -BetaLimit $Limit -BetaOffset $Offset -BetaDetail $Detail -BetaFilter $Filter -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDiscoveredApplications" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-manual-discover-applications-csv-template +Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values 'Example Application' and 'Example Description'. + +The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**ManualDiscoverApplicationsTemplate**](../models/manual-discover-applications-template) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A CSV file download was successful. | ManualDiscoverApplicationsTemplate +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: text/csv, application/json + +### Example +```powershell + +# Download CSV Template for Discovery + +try { + Get-BetaManualDiscoverApplicationsCsvTemplate + + # Below is a request that includes all optional parameters + # Get-BetaManualDiscoverApplicationsCsvTemplate +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-discovered-application-by-id +Update an existing discovered application by using a limited version of the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +You can patch these fields: - **associatedSources** - **dismissed** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Discovered application's ID. + Body | JsonPatchOperations | [**[]JsonPatchOperations**](../models/json-patch-operations) | (optional) | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns the single patched discovered application. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID. + $JsonPatchOperations = @"{ + "op" : "replace", + "path" : "/dismissed", + "value" : true +}"@ # JsonPatchOperations[] | (optional) + + +# Patch Discovered Application by ID + +try { + Update-BetaDiscoveredApplicationByID-BetaId $Id + + # Below is a request that includes all optional parameters + # Update-BetaDiscoveredApplicationByID -BetaId $Id -BetaJsonPatchOperations $JsonPatchOperations +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaDiscoveredApplicationByID" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## send-manual-discover-applications-csv-template +Upload a CSV file with application data for manual correlation to specific ISC connectors. +If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | File | **System.IO.FileInfo** | True | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The CSV has been successfully processed. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + +# Upload CSV to Discover Applications + +try { + Send-BetaManualDiscoverApplicationsCsvTemplate-BetaFile $File + + # Below is a request that includes all optional parameters + # Send-BetaManualDiscoverApplicationsCsvTemplate -BetaFile $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaApprovalsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaApprovalsApi.md new file mode 100644 index 000000000..b7c9ec47a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaApprovalsApi.md @@ -0,0 +1,115 @@ + +--- +id: beta-approvals +title: Approvals +pagination_label: Approvals +sidebar_label: Approvals +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Approvals', 'BetaApprovals'] +slug: /tools/sdk/powershell/beta/methods/approvals +tags: ['SDK', 'Software Development Kit', 'Approvals', 'BetaApprovals'] +--- + +# Approvals + Use this API to implement approval functionality. With this functionality in place, you can get generic approvals and modify them. + +The main advantages this API has vs [Access Request Approvals](https://developer.sailpoint.com/docs/api/beta/access-request-approvals) are that you can use it to get generic approvals individually or in batches and make changes to those approvals. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaApproval**](#get-approval) | **GET** `/generic-approvals/{id}` | Get Approval +[**Get-BetaApprovals**](#get-approvals) | **GET** `/generic-approvals` | Get Approvals + +## get-approval +Get a single approval for a given approval ID. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and doesn't include access-request-approvals. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the approval that to be returned. + +### Return type +[**Approval**](../models/approval) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Approval object | Approval +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that to be returned. + +# Get Approval + +try { + Get-BetaApproval-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaApproval -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaApproval" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-approvals +Get a list of approvals, which can be filtered by requester ID, status, or reference type. You can use the "Mine" query parameter to return all approvals for the current approver. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and does not include access-request-approvals. +Absence of all query parameters will will default to mine=true. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Mine | **Boolean** | (optional) | Returns the list of approvals for the current caller. + Query | RequesterId | **String** | (optional) | Returns the list of approvals for a given requester ID. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* + +### Return type +[**Approval[]**](../models/approval) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of approvals. | Approval[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Mine = $true # Boolean | Returns the list of approvals for the current caller. (optional) +$RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID. (optional) +$Filters = 'filters=status eq PENDING' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* (optional) + +# Get Approvals + +try { + Get-BetaApprovals + + # Below is a request that includes all optional parameters + # Get-BetaApprovals -BetaMine $Mine -BetaRequesterId $RequesterId -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaApprovals" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAppsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAppsApi.md new file mode 100644 index 000000000..cdcdb425b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAppsApi.md @@ -0,0 +1,727 @@ + +--- +id: beta-apps +title: Apps +pagination_label: Apps +sidebar_label: Apps +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Apps', 'BetaApps'] +slug: /tools/sdk/powershell/beta/methods/apps +tags: ['SDK', 'Software Development Kit', 'Apps', 'BetaApps'] +--- + +# Apps + Use this API to implement source application functionality. +With this functionality in place, you can create, customize, and manage applications within sources. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaSourceApp**](#create-source-app) | **POST** `/source-apps` | Create source app +[**Remove-BetaAccessProfilesFromSourceAppByBulk**](#delete-access-profiles-from-source-app-by-bulk) | **POST** `/source-apps/{id}/access-profiles/bulk-remove` | Bulk remove access profiles from the specified source app +[**Remove-BetaSourceApp**](#delete-source-app) | **DELETE** `/source-apps/{id}` | Delete source app by ID +[**Get-BetaSourceApp**](#get-source-app) | **GET** `/source-apps/{id}` | Get source app by ID +[**Get-BetaAccessProfilesForSourceApp**](#list-access-profiles-for-source-app) | **GET** `/source-apps/{id}/access-profiles` | List access profiles for the specified source app +[**Get-BetaAllSourceApp**](#list-all-source-app) | **GET** `/source-apps/all` | List all source apps +[**Get-BetaAllUserApps**](#list-all-user-apps) | **GET** `/user-apps/all` | List all user apps +[**Get-BetaAssignedSourceApp**](#list-assigned-source-app) | **GET** `/source-apps/assigned` | List assigned source apps +[**Get-BetaAvailableAccountsForUserApp**](#list-available-accounts-for-user-app) | **GET** `/user-apps/{id}/available-accounts` | List available accounts for user app +[**Get-BetaAvailableSourceApps**](#list-available-source-apps) | **GET** `/source-apps` | List available source apps +[**Get-BetaOwnedUserApps**](#list-owned-user-apps) | **GET** `/user-apps` | List owned user apps +[**Update-BetaSourceApp**](#patch-source-app) | **PATCH** `/source-apps/{id}` | Patch source app by ID +[**Update-BetaUserApp**](#patch-user-app) | **PATCH** `/user-apps/{id}` | Patch user app by ID +[**Update-BetaSourceAppsInBulk**](#update-source-apps-in-bulk) | **POST** `/source-apps/bulk-update` | Bulk update source apps + +## create-source-app +This endpoint creates a source app using the given source app payload + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | SourceAppCreateDto | [**SourceAppCreateDto**](../models/source-app-create-dto) | True | + +### Return type +[**SourceApp**](../models/source-app) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the source app as created. | SourceApp +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceAppCreateDto = @"{ + "name" : "my app", + "description" : "the source app for engineers", + "accountSource" : { + "name" : "ODS-AD-Source", + "id" : "2c9180827ca885d7017ca8ce28a000eb", + "type" : "SOURCE" + }, + "matchAllAccounts" : true +}"@ + +# Create source app + +try { + $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto + New-BetaSourceApp-BetaSourceAppCreateDto $Result + + # Below is a request that includes all optional parameters + # New-BetaSourceApp -BetaSourceAppCreateDto $SourceAppCreateDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceApp" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-access-profiles-from-source-app-by-bulk +This API returns the final list of access profiles for the specified source app after removing + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the source app + Body | RequestBody | **[]String** | True | + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**AccessProfileDetails[]**](../models/access-profile-details) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The final list of access profiles for the specified source app | AccessProfileDetails[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the source app +$RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ # String[] | + +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + +# Bulk remove access profiles from the specified source app + +try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-BetaAccessProfilesFromSourceAppByBulk-BetaId $Id -BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-BetaAccessProfilesFromSourceAppByBulk -BetaId $Id -BetaRequestBody $RequestBody -BetaLimit $Limit +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfilesFromSourceAppByBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-source-app +Use this API to delete a specific source app + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | source app ID. + +### Return type +[**SourceApp**](../models/source-app) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the source app as deleted. | SourceApp +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. + +# Delete source app by ID + +try { + Remove-BetaSourceApp-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSourceApp -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSourceApp" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-source-app +This API returns a source app by its ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the source app + +### Return type +[**SourceApp**](../models/source-app) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the source app. | SourceApp +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + +# Get source app by ID + +try { + Get-BetaSourceApp-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSourceApp -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceApp" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-access-profiles-for-source-app +This API returns the list of access profiles for the specified source app + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the source app + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* + +### Return type +[**AccessProfileDetails[]**](../models/access-profile-details) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of access profiles for the specified source app | AccessProfileDetails[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the source app +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Filters = 'name eq "developer access profile"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + +# List access profiles for the specified source app + +try { + Get-BetaAccessProfilesForSourceApp-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccessProfilesForSourceApp -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfilesForSourceApp" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-all-source-app +This API returns the list of all source apps for the org. + +A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* + +### Return type +[**SourceApp[]**](../models/source-app) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of source apps | SourceApp[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) +$Filters = 'enabled eq true' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) + +# List all source apps + +try { + Get-BetaAllSourceApp + + # Below is a request that includes all optional parameters + # Get-BetaAllSourceApp -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -BetaSorters $Sorters -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllSourceApp" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-all-user-apps +This API returns the list of all user apps with specified filters. +This API must be used with **filters** query parameter. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Filters | **String** | True | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**UserApp[]**](../models/user-app) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of user apps | UserApp[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Filters = 'name eq "user app name"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + +# List all user apps + +try { + Get-BetaAllUserApps-BetaFilters $Filters + + # Below is a request that includes all optional parameters + # Get-BetaAllUserApps -BetaFilters $Filters -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllUserApps" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-assigned-source-app +This API returns the list of source apps assigned for logged in user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* + +### Return type +[**SourceApp[]**](../models/source-app) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of source apps | SourceApp[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (optional) +$Filters = 'name eq "source app name"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + +# List assigned source apps + +try { + Get-BetaAssignedSourceApp + + # Below is a request that includes all optional parameters + # Get-BetaAssignedSourceApp -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -BetaSorters $Sorters -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAssignedSourceApp" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-available-accounts-for-user-app +This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the user app + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**AppAccountDetails[]**](../models/app-account-details) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of available accounts for the specified user app | AppAccountDetails[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the user app +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + +# List available accounts for user app + +try { + Get-BetaAvailableAccountsForUserApp-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaAvailableAccountsForUserApp -BetaId $Id -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAvailableAccountsForUserApp" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-available-source-apps +This API returns the list of source apps available for access request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* + +### Return type +[**SourceApp[]**](../models/source-app) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of source apps | SourceApp[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) +$Filters = 'name eq "source app name"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + +# List available source apps + +try { + Get-BetaAvailableSourceApps + + # Below is a request that includes all optional parameters + # Get-BetaAvailableSourceApps -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -BetaSorters $Sorters -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAvailableSourceApps" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-owned-user-apps +This API returns the list of user apps assigned to logged in user + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + +### Return type +[**UserApp[]**](../models/user-app) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of user apps | UserApp[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Filters = 'name eq "user app name"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) + +# List owned user apps + +try { + Get-BetaOwnedUserApps + + # Below is a request that includes all optional parameters + # Get-BetaOwnedUserApps -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOwnedUserApps" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-source-app +This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. +Name, description and owner can't be empty or null. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the source app to patch + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) | + +### Return type +[**SourceAppPatchDto**](../models/source-app-patch-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the source app as updated. | SourceAppPatchDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the source app to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | (optional) + + +# Patch source app by ID + +try { + Update-BetaSourceApp-BetaId $Id + + # Below is a request that includes all optional parameters + # Update-BetaSourceApp -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceApp" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-user-app +This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: **account** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the user app to patch + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) | + +### Return type +[**UserApp**](../models/user-app) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the user app as updated. | UserApp +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the user app to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | (optional) + + +# Patch user app by ID + +try { + Update-BetaUserApp-BetaId $Id + + # Below is a request that includes all optional parameters + # Update-BetaUserApp -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaUserApp" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-source-apps-in-bulk +This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. +The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. +Name, description and owner can't be empty or null. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | SourceAppBulkUpdateRequest | [**SourceAppBulkUpdateRequest**](../models/source-app-bulk-update-request) | (optional) | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceAppBulkUpdateRequest = @"{ + "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : false + }, { + "op" : "replace", + "path" : "/matchAllAccounts", + "value" : false + } ] +}"@ + +# Bulk update source apps + +try { + Update-BetaSourceAppsInBulk + + # Below is a request that includes all optional parameters + # Update-BetaSourceAppsInBulk -BetaSourceAppBulkUpdateRequest $SourceAppBulkUpdateRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceAppsInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAuthProfileApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAuthProfileApi.md new file mode 100644 index 000000000..132bdbba1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaAuthProfileApi.md @@ -0,0 +1,164 @@ + +--- +id: beta-auth-profile +title: AuthProfile +pagination_label: AuthProfile +sidebar_label: AuthProfile +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AuthProfile', 'BetaAuthProfile'] +slug: /tools/sdk/powershell/beta/methods/auth-profile +tags: ['SDK', 'Software Development Kit', 'AuthProfile', 'BetaAuthProfile'] +--- + +# AuthProfile + Use this API to implement Auth Profile functionality. +With this functionality in place, users can read authentication profiles and make changes to them. + +An authentication profile represents an identity profile's authentication configuration. +When the identity profile is created, its authentication profile is also created. +An authentication profile includes information like its authentication profile type (`BLOCK`, `MFA`, `NON_PTA`, PTA`) and settings controlling whether or not it blocks access from off network or untrusted geographies. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaProfileConfig**](#get-profile-config) | **GET** `/auth-profiles/{id}` | Get Auth Profile. +[**Get-BetaProfileConfigList**](#get-profile-config-list) | **GET** `/auth-profiles` | Get list of Auth Profiles. +[**Update-BetaProfileConfig**](#patch-profile-config) | **PATCH** `/auth-profiles/{id}` | Patch a specified Auth Profile + +## get-profile-config +This API returns auth profile information. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Auth Profile to get. + +### Return type +[**AuthProfile**](../models/auth-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Auth Profile | AuthProfile +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to get. + +# Get Auth Profile. + +try { + Get-BetaProfileConfig-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaProfileConfig -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProfileConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-profile-config-list +This API returns a list of auth profiles. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**AuthProfileSummary[]**](../models/auth-profile-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Auth Profiles | AuthProfileSummary[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get list of Auth Profiles. + +try { + Get-BetaProfileConfigList + + # Below is a request that includes all optional parameters + # Get-BetaProfileConfigList +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProfileConfigList" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-profile-config +This API updates an existing Auth Profile. The following fields are patchable: +**offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Auth Profile to patch. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**AuthProfile**](../models/auth-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the Auth Profile as updated. | AuthProfile +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | + + +# Patch a specified Auth Profile + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaProfileConfig-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaProfileConfig -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProfileConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaCertificationCampaignsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaCertificationCampaignsApi.md new file mode 100644 index 000000000..64ea76de4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaCertificationCampaignsApi.md @@ -0,0 +1,1446 @@ + +--- +id: beta-certification-campaigns +title: CertificationCampaigns +pagination_label: CertificationCampaigns +sidebar_label: CertificationCampaigns +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationCampaigns', 'BetaCertificationCampaigns'] +slug: /tools/sdk/powershell/beta/methods/certification-campaigns +tags: ['SDK', 'Software Development Kit', 'CertificationCampaigns', 'BetaCertificationCampaigns'] +--- + +# CertificationCampaigns + Use this API to implement certification campaign functionality. +With this functionality in place, administrators can create, customize, and manage certification campaigns for their organizations' use. +Certification campaigns provide Identity Security Cloud users with an interactive review process they can use to identify and verify access to systems. +Campaigns help organizations reduce risk of inappropriate access and satisfy audit requirements. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification campaign as a way of showing that a user's access has been reviewed and approved by multiple managers. +Once this campaign has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Identity Security Cloud provides two simple campaign types users can create without using search queries, Manager and Source Owner campaigns: + +You can create these types of campaigns without using any search queries in Identity Security Cloud: + +- ManagerCampaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access is certified by their managers. +You only need to provide a name and description to create one. + +- Source Owner Campaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access to a source is certified by its source owners. +You only need to provide a name and description to create one. +You can specify the sources whose owners you want involved or just run it across all sources. + +For more information about these campaign types, refer to [Starting a Manager or Source Owner Campaign](https://documentation.sailpoint.com/saas/help/certs/starting_campaign.html). + +One useful way to create certification campaigns in Identity Security Cloud is to use a specific search and then run a campaign on the results returned by that search. +This allows you to be much more specific about whom you are certifying in your campaigns and what access you are certifying in your campaigns. +For example, you can search for all identities who are managed by "Amanda.Ross" and also have the access to the "Accounting" role and then run a certification campaign based on that search to ensure that the returned identities are appropriately certified. + +You can use Identity Security Cloud search queries to create these types of campaigns: + +- Identities: Use this campaign type to review and revoke access items for specific identities. +You can either build a search query and create a campaign certifying all identities returned by that query, or you can search for individual identities and add those identities to the certification campaign. + +- Access Items: Use this campaign type to review and revoke a set of roles, access profiles, or entitlements from the identities that have them. +You can either build a search query and create a campaign certifying all access items returned by that query, or you can search for individual access items and add those items to the certification campaign. + +- Role Composition: Use this campaign type to review a role's composition, including its title, description, and membership criteria. +You can either build a search query and create a campaign certifying all roles returned by that query, or you can search for individual roles and add those roles to the certification campaign. + +- Uncorrelated Accounts: Use this campaign type to certify source accounts that aren't linked to an authoritative identity in Identity Security Cloud. +You can use this campaign type to view all the uncorrelated accounts for a source and certify them. + +For more information about search-based campaigns, refer to [Starting a Campaign from Search](https://documentation.sailpoint.com/saas/help/certs/starting_search_campaign.html). + +Once you have generated your campaign, it becomes available for preview. +An administrator can review the campaign and make changes, or if it's ready and accurate, activate it. + +Once the campaign is active, organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers. +Those reviewers can view any of the certifications they either need to review (active) or have already reviewed (completed). + +When a certification campaign is in progress, certification reviewers see the listed active certifications whose involved identities they can review. +Reviewers can then make decisions to grant or revoke access, as well as reassign the certification to another reviewer. If the reviewer chooses this option, they must provide a reason for reassignment in the form of a comment. + +Once a reviewer has made decisions on all the certification's involved access items, he or she must "Sign Off" to complete the review process. +Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. + +Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. +In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. +In this situation, the certification campaign completes once all the remediation requests are completed. + +The end of a certification campaign is determined by its deadline, its completion status, or by an administrator's decision. + +For more information about certifications and certification campaigns, refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html). + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Complete-BetaCampaign**](#complete-campaign) | **POST** `/campaigns/{id}/complete` | Complete a Campaign +[**New-BetaCampaign**](#create-campaign) | **POST** `/campaigns` | Create Campaign +[**New-BetaCampaignTemplate**](#create-campaign-template) | **POST** `/campaign-templates` | Create a Campaign Template +[**Remove-BetaCampaignTemplate**](#delete-campaign-template) | **DELETE** `/campaign-templates/{id}` | Delete a Campaign Template +[**Remove-BetaCampaignTemplateSchedule**](#delete-campaign-template-schedule) | **DELETE** `/campaign-templates/{id}/schedule` | Delete Campaign Template Schedule +[**Remove-BetaCampaigns**](#delete-campaigns) | **POST** `/campaigns/delete` | Delete Campaigns +[**Get-BetaActiveCampaigns**](#get-active-campaigns) | **GET** `/campaigns` | List Campaigns +[**Get-BetaCampaign**](#get-campaign) | **GET** `/campaigns/{id}` | Get Campaign +[**Get-BetaCampaignReports**](#get-campaign-reports) | **GET** `/campaigns/{id}/reports` | Get Campaign Reports +[**Get-BetaCampaignReportsConfig**](#get-campaign-reports-config) | **GET** `/campaigns/reports-configuration` | Get Campaign Reports Configuration +[**Get-BetaCampaignTemplate**](#get-campaign-template) | **GET** `/campaign-templates/{id}` | Get a Campaign Template +[**Get-BetaCampaignTemplateSchedule**](#get-campaign-template-schedule) | **GET** `/campaign-templates/{id}/schedule` | Get Campaign Template Schedule +[**Get-BetaCampaignTemplates**](#get-campaign-templates) | **GET** `/campaign-templates` | List Campaign Templates +[**Move-Beta**](#move) | **POST** `/campaigns/{id}/reassign` | Reassign Certifications +[**Update-BetaCampaignTemplate**](#patch-campaign-template) | **PATCH** `/campaign-templates/{id}` | Update a Campaign Template +[**Set-BetaCampaignReportsConfig**](#set-campaign-reports-config) | **PUT** `/campaigns/reports-configuration` | Set Campaign Reports Configuration +[**Set-BetaCampaignTemplateSchedule**](#set-campaign-template-schedule) | **PUT** `/campaign-templates/{id}/schedule` | Set Campaign Template Schedule +[**Start-BetaCampaign**](#start-campaign) | **POST** `/campaigns/{id}/activate` | Activate a Campaign +[**Start-BetaCampaignRemediationScan**](#start-campaign-remediation-scan) | **POST** `/campaigns/{id}/run-remediation-scan` | Run Campaign Remediation Scan +[**Start-BetaCampaignReport**](#start-campaign-report) | **POST** `/campaigns/{id}/run-report/{type}` | Run Campaign Report +[**Start-BetaGenerateCampaignTemplate**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a Campaign from Template +[**Update-BetaCampaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a Campaign + +## complete-campaign +:::caution + +This endpoint will run successfully for any campaigns that are **past due**. + +This endpoint will return a content error if the campaign is **not past due**. + +::: + +Use this API to complete a certification campaign. This functionality is provided to admins so that they +can complete a certification even if all items have not been completed. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/complete-campaign). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Campaign ID. + Body | CompleteCampaignOptions | [**CompleteCampaignOptions**](../models/complete-campaign-options) | (optional) | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. +$CompleteCampaignOptions = @"{ + "autoCompleteAction" : "REVOKE" +}"@ + +# Complete a Campaign + +try { + Complete-BetaCampaign-BetaId $Id + + # Below is a request that includes all optional parameters + # Complete-BetaCampaign -BetaId $Id -BetaCompleteCampaignOptions $CompleteCampaignOptions +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaCampaign" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-campaign +Use this API to create a certification campaign with the information provided in the request body. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Campaign | [**Campaign**](../models/campaign) | True | + +### Return type +[**Campaign**](../models/campaign) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | This response indicates that the requested campaign was successfully created, and the API returns its representation. | Campaign +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Campaign = @"{ + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" +}"@ + +# Create Campaign + +try { + $Result = ConvertFrom-JsonToCampaign -Json $Campaign + New-BetaCampaign-BetaCampaign $Result + + # Below is a request that includes all optional parameters + # New-BetaCampaign -BetaCampaign $Campaign +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCampaign" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-campaign-template +Use this API to create a campaign template based on campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign-template). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CampaignTemplate | [**CampaignTemplate**](../models/campaign-template) | True | + +### Return type +[**CampaignTemplate**](../models/campaign-template) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Created successfully. | CampaignTemplate +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CampaignTemplate = @"{ + "ownerRef" : { + "name" : "Mister Manager", + "id" : "2c918086676d3e0601677611dbde220f", + "type" : "IDENTITY", + "email" : "mr.manager@example.com" + }, + "deadlineDuration" : "P2W", + "created" : "2020-03-05T22:44:00.364Z", + "scheduled" : false, + "name" : "Manager Campaign Template", + "description" : "Template for the annual manager campaign.", + "modified" : "2020-03-05T22:52:09.969Z", + "campaign" : { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }, + "id" : "2c9079b270a266a60170a277bb960008" +}"@ + +# Create a Campaign Template + +try { + $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate + New-BetaCampaignTemplate-BetaCampaignTemplate $Result + + # Below is a request that includes all optional parameters + # New-BetaCampaignTemplate -BetaCampaignTemplate $CampaignTemplate +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCampaignTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-campaign-template +Use this API to delete a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign template being deleted. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. + +# Delete a Campaign Template + +try { + Remove-BetaCampaignTemplate-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaCampaignTemplate -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaignTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-campaign-template-schedule +Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template-schedule). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign template whose schedule is being deleted. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. + +# Delete Campaign Template Schedule + +try { + Remove-BetaCampaignTemplateSchedule-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaCampaignTemplateSchedule -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaignTemplateSchedule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-campaigns +Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaigns). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | DeleteCampaignsRequest | [**DeleteCampaignsRequest**](../models/delete-campaigns-request) | True | IDs of the campaigns to delete. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$DeleteCampaignsRequest = @"{ + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] +}"@ + +# Delete Campaigns + +try { + $Result = ConvertFrom-JsonToDeleteCampaignsRequest -Json $DeleteCampaignsRequest + Remove-BetaCampaigns-BetaDeleteCampaignsRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaCampaigns -BetaDeleteCampaignsRequest $DeleteCampaignsRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaigns" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-active-campaigns +Use this API to get a list of campaigns. The API can provide increased level of detail for each campaign for the correct provided query. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-active-campaigns). + +A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Detail | **String** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** + +### Return type +[**GetActiveCampaigns200ResponseInner[]**](../models/get-active-campaigns200-response-inner) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of campaign objects. By default, the API returns a list of SLIM campaigns. | GetActiveCampaigns200ResponseInner[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'name eq "Manager Campaign"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) + +# List Campaigns + +try { + Get-BetaActiveCampaigns + + # Below is a request that includes all optional parameters + # Get-BetaActiveCampaigns -BetaDetail $Detail -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaActiveCampaigns" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-campaign +Use this API to get information for an existing certification campaign by the campaign's ID. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign to be retrieved. + +### Return type +[**Slimcampaign**](../models/slimcampaign) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Campaign object. | Slimcampaign +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. + +# Get Campaign + +try { + Get-BetaCampaign-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaCampaign -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaign" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-campaign-reports +Use this API to fetch all reports for a certification campaign by campaign ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports). + +A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign whose reports are being fetched. + +### Return type +[**CampaignReport[]**](../models/campaign-report) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Array of campaign report objects. | CampaignReport[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. + +# Get Campaign Reports + +try { + Get-BetaCampaignReports-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaCampaignReports -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignReports" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-campaign-reports-config +Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports-config). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**CampaignReportsConfig**](../models/campaign-reports-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Campaign report configuration. | CampaignReportsConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Campaign Reports Configuration + +try { + Get-BetaCampaignReportsConfig + + # Below is a request that includes all optional parameters + # Get-BetaCampaignReportsConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignReportsConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-campaign-template +Use this API to fetch a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Requested campaign template's ID. + +### Return type +[**CampaignTemplate**](../models/campaign-template) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Data for the campaign matching the given ID. | CampaignTemplate +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. + +# Get a Campaign Template + +try { + Get-BetaCampaignTemplate-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaCampaignTemplate -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-campaign-template-schedule +Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template-schedule). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign template whose schedule is being fetched. + +### Return type +[**Schedule**](../models/schedule) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Current schedule for the campaign template. See the [Set Campaign Template Schedule endpoint documentation](https://developer.sailpoint.com/docs/api/beta/set-campaign-template-schedule) for more examples. | Schedule +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. + +# Get Campaign Template Schedule + +try { + Get-BetaCampaignTemplateSchedule-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaCampaignTemplateSchedule -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplateSchedule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-campaign-templates +Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/list-campaign-templates). + +The endpoint returns all campaign templates matching the query parameters. + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* + +### Return type +[**CampaignTemplate[]**](../models/campaign-template) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of campaign template objects. | CampaignTemplate[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) +$Filters = 'name eq "manager template"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + +# List Campaign Templates + +try { + Get-BetaCampaignTemplates + + # Below is a request that includes all optional parameters + # Get-BetaCampaignTemplates -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplates" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## move +This API reassigns the specified certifications from one identity to another. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/move). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The certification campaign ID + Body | AdminReviewReassign | [**AdminReviewReassign**](../models/admin-review-reassign) | True | + +### Return type +[**CertificationTask**](../models/certification-task) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | The reassign task that has been submitted. | CertificationTask +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID +$AdminReviewReassign = @"{ + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } +}"@ + +# Reassign Certifications + +try { + $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign + Move-Beta-BetaId $Id -BetaAdminReviewReassign $Result + + # Below is a request that includes all optional parameters + # Move-Beta -BetaId $Id -BetaAdminReviewReassign $AdminReviewReassign +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-Beta" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-campaign-template +Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/patch-campaign-template). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign template being modified. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) + +### Return type +[**CampaignTemplate**](../models/campaign-template) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | This response indicates that the PATCH operation succeeded, and the API returns the template's new representation. | CampaignTemplate +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) + + +# Update a Campaign Template + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaCampaignTemplate-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaCampaignTemplate -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCampaignTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-campaign-reports-config +Use this API to overwrite the configuration for campaign reports. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-reports-config). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CampaignReportsConfig | [**CampaignReportsConfig**](../models/campaign-reports-config) | True | Campaign report configuration. + +### Return type +[**CampaignReportsConfig**](../models/campaign-reports-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The persisted campaign report configuration. | CampaignReportsConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CampaignReportsConfig = @"{ + "identityAttributeColumns" : [ "firstname", "lastname" ] +}"@ + +# Set Campaign Reports Configuration + +try { + $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig + Set-BetaCampaignReportsConfig-BetaCampaignReportsConfig $Result + + # Below is a request that includes all optional parameters + # Set-BetaCampaignReportsConfig -BetaCampaignReportsConfig $CampaignReportsConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaCampaignReportsConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-campaign-template-schedule +Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. +Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign template being scheduled. + Body | Schedule | [**Schedule**](../models/schedule) | (optional) | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template being scheduled. +$Schedule = @"{ + "hours" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "months" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "timeZoneId" : "CST", + "days" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "expiration" : "2000-01-23T04:56:07.000+00:00", + "type" : "WEEKLY" +}"@ + +# Set Campaign Template Schedule + +try { + Set-BetaCampaignTemplateSchedule-BetaId $Id + + # Below is a request that includes all optional parameters + # Set-BetaCampaignTemplateSchedule -BetaId $Id -BetaSchedule $Schedule +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaCampaignTemplateSchedule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-campaign +Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Campaign ID. + Body | ActivateCampaignOptions | [**ActivateCampaignOptions**](../models/activate-campaign-options) | (optional) | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. +$ActivateCampaignOptions = @"{ + "timeZone" : "-05:00" +}"@ + +# Activate a Campaign + +try { + Start-BetaCampaign-BetaId $Id + + # Below is a request that includes all optional parameters + # Start-BetaCampaign -BetaId $Id -BetaActivateCampaignOptions $ActivateCampaignOptions +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaign" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-campaign-remediation-scan +Use this API to run a remediation scan task for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-remediation-scan). + +A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign the remediation scan is being run for. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. + +# Run Campaign Remediation Scan + +try { + Start-BetaCampaignRemediationScan-BetaId $Id + + # Below is a request that includes all optional parameters + # Start-BetaCampaignRemediationScan -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaignRemediationScan" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-campaign-report +Use this API to run a report for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-report). + +A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign the report is being run for. +Path | Type | [**ReportType**](../models/report-type) | True | Type of report to run. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. +$Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of report to run. + +# Run Campaign Report + +try { + Start-BetaCampaignReport-BetaId $Id -BetaType $Type + + # Below is a request that includes all optional parameters + # Start-BetaCampaignReport -BetaId $Id -BetaType $Type +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaignReport" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-generate-campaign-template +Use this API to generate a new certification campaign from a campaign template. + +The campaign object contained in the template has special formatting applied to its name and description +fields that determine the generated campaign's name/description. Placeholders in those fields are +formatted with the current date and time upon generation. + +Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For +example, "%Y" inserts the current year, and a campaign template named "Campaign for %y" generates a +campaign called "Campaign for 2020" (assuming the year at generation time is 2020). + +Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). + +Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-generate-campaign-template). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign template to use for generation. + +### Return type +[**CampaignReference**](../models/campaign-reference) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | This response indicates that a campaign was successfully generated from this template, and the API returns a reference to the new campaign. | CampaignReference +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. + +# Generate a Campaign from Template + +try { + Start-BetaGenerateCampaignTemplate-BetaId $Id + + # Below is a request that includes all optional parameters + # Start-BetaGenerateCampaignTemplate -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaGenerateCampaignTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-campaign +Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/update-campaign). + +A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign being modified. + Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | True | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline + +### Return type +[**Slimcampaign**](../models/slimcampaign) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | This response indicates that the PATCH operation succeeded, and the API returns the campaign's new representation. | Slimcampaign +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign being modified. +$RequestBody = # SystemCollectionsHashtable[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline + $RequestBody = @"[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]"@ # SystemCollectionsHashtable[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline + + +# Update a Campaign + +try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaCampaign-BetaId $Id -BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaCampaign -BetaId $Id -BetaRequestBody $RequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCampaign" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaCertificationsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaCertificationsApi.md new file mode 100644 index 000000000..f86d0d6d0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaCertificationsApi.md @@ -0,0 +1,291 @@ + +--- +id: beta-certifications +title: Certifications +pagination_label: Certifications +sidebar_label: Certifications +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Certifications', 'BetaCertifications'] +slug: /tools/sdk/powershell/beta/methods/certifications +tags: ['SDK', 'Software Development Kit', 'Certifications', 'BetaCertifications'] +--- + +# Certifications + Use this API to implement certification functionality. +This API provides specific functionality that improves an organization's ability to manage its certification process. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. +Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +This API enables administrators and reviewers to get useful information about certifications at a high level, such as the reviewers involved, and at a more granular level, such as the permissions affected by changes to entitlements within those certifications. +It also provides the useful ability to reassign identities and items within certifications to other reviewers, rather than [reassigning the entire certifications themselves](https://developer.sailpoint.com/idn/api/beta/submit-reassign-certs-async/). + +Refer to [Managing User Accounts](https://documentation.sailpoint.com/saas/help/common/users/user_access.html#managing-user-accounts) for more information about accounts. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaIdentityCertificationItemPermissions**](#get-identity-certification-item-permissions) | **GET** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for Entitlement Certification Item +[**Get-BetaIdentityCertificationPendingTasks**](#get-identity-certification-pending-tasks) | **GET** `/certifications/{id}/tasks-pending` | Pending Certification Tasks +[**Get-BetaIdentityCertificationTaskStatus**](#get-identity-certification-task-status) | **GET** `/certifications/{id}/tasks/{taskId}` | Certification Task Status +[**Get-BetaCertificationReviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of Reviewers for certification +[**Submit-BetaReassignCertsAsync**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously + +## get-identity-certification-item-permissions +This API returns the permissions associated with an entitlement certification item based on the certification item's ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | CertificationId | **String** | True | The certification ID +Path | ItemId | **String** | True | The certification item ID + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**PermissionDto[]**](../models/permission-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of permissions associated with the given itemId | PermissionDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID +$ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID +$Filters = 'target eq "SYS.OBJAUTH2"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Permissions for Entitlement Certification Item + +try { + Get-BetaIdentityCertificationItemPermissions-BetaCertificationId $CertificationId -BetaItemId $ItemId + + # Below is a request that includes all optional parameters + # Get-BetaIdentityCertificationItemPermissions -BetaCertificationId $CertificationId -BetaItemId $ItemId -BetaFilters $Filters -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationItemPermissions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-certification-pending-tasks +This API returns the status of all pending (`QUEUED` or `IN_PROGRESS`) tasks for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity campaign certification ID + +### Return type +[**IdentityCertificationTask[]**](../models/identity-certification-task) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of pending (`QUEUED` or `IN_PROGRESS`) certification task objects. | IdentityCertificationTask[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "MyId" # String | The identity campaign certification ID + +# Pending Certification Tasks + +try { + Get-BetaIdentityCertificationPendingTasks-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentityCertificationPendingTasks -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationPendingTasks" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-certification-task-status +This API returns the status of a certification task. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity campaign certification ID +Path | TaskId | **String** | True | The certification task ID + +### Return type +[**IdentityCertificationTask**](../models/identity-certification-task) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A certification task object. | IdentityCertificationTask +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "MyId" # String | The identity campaign certification ID +$TaskId = "MyTaskId" # String | The certification task ID + +# Certification Task Status + +try { + Get-BetaIdentityCertificationTaskStatus-BetaId $Id -BetaTaskId $TaskId + + # Below is a request that includes all optional parameters + # Get-BetaIdentityCertificationTaskStatus -BetaId $Id -BetaTaskId $TaskId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationTaskStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-certification-reviewers +This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The certification ID + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** + +### Return type +[**IdentityReferenceWithNameAndEmail[]**](../models/identity-reference-with-name-and-email) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of reviewers | IdentityReferenceWithNameAndEmail[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'name eq "Bob"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) + +# List of Reviewers for certification + +try { + Get-BetaCertificationReviewers-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaCertificationReviewers -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCertificationReviewers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## submit-reassign-certs-async +This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity campaign certification ID + Body | ReviewReassign | [**ReviewReassign**](../models/review-reassign) | True | + +### Return type +[**IdentityCertificationTask**](../models/identity-certification-task) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A certification task object for the reassignment which can be queried for status. | IdentityCertificationTask +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID +$ReviewReassign = @"{ + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] +}"@ + +# Reassign Certifications Asynchronously + +try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Submit-BetaReassignCertsAsync-BetaId $Id -BetaReviewReassign $Result + + # Below is a request that includes all optional parameters + # Submit-BetaReassignCertsAsync -BetaId $Id -BetaReviewReassign $ReviewReassign +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaReassignCertsAsync" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaConnectorRuleManagementApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaConnectorRuleManagementApi.md new file mode 100644 index 000000000..d1718d426 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaConnectorRuleManagementApi.md @@ -0,0 +1,350 @@ + +--- +id: beta-connector-rule-management +title: ConnectorRuleManagement +pagination_label: ConnectorRuleManagement +sidebar_label: ConnectorRuleManagement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorRuleManagement', 'BetaConnectorRuleManagement'] +slug: /tools/sdk/powershell/beta/methods/connector-rule-management +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleManagement', 'BetaConnectorRuleManagement'] +--- + +# ConnectorRuleManagement + Use this API to implement connector rule management functionality. +With this functionality in place, administrators can implement connector-executed rules in a programmatic, scalable way. + +In Identity Security Cloud (ISC), [rules](https://developer.sailpoint.com/docs/extensibility/rules) serve as a flexible configuration framework you can leverage to perform complex or advanced configurations. +[Connector-executed rules](https://developer.sailpoint.com/docs/extensibility/rules/connector-rules) are rules that are executed in the ISC virtual appliance (VA), usually extensions of the [connector](https://documentation.sailpoint.com/connectors/isc/landingpages/help/landingpages/isc_landing.html) itself, the bridge between the data source and ISC. +This API allows administrators to view existing connector-executed rules, make changes to them, delete them, and create new ones from the available types. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaConnectorRule**](#create-connector-rule) | **POST** `/connector-rules` | Create Connector Rule +[**Remove-BetaConnectorRule**](#delete-connector-rule) | **DELETE** `/connector-rules/{id}` | Delete a Connector-Rule +[**Get-BetaConnectorRule**](#get-connector-rule) | **GET** `/connector-rules/{id}` | Connector-Rule by ID +[**Get-BetaConnectorRuleList**](#get-connector-rule-list) | **GET** `/connector-rules` | List Connector Rules +[**Update-BetaConnectorRule**](#update-connector-rule) | **PUT** `/connector-rules/{id}` | Update a Connector Rule +[**Confirm-BetaConnectorRule**](#validate-connector-rule) | **POST** `/connector-rules/validate` | Validate Connector Rule + +## create-connector-rule +Creates a new connector rule. +A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | ConnectorRuleCreateRequest | [**ConnectorRuleCreateRequest**](../models/connector-rule-create-request) | True | The connector rule to create + +### Return type +[**ConnectorRuleResponse**](../models/connector-rule-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | The created connector rule | ConnectorRuleResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$ConnectorRuleCreateRequest = @"{ + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "type" : "BuildMap" +}"@ + +# Create Connector Rule + +try { + $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest + New-BetaConnectorRule-BetaConnectorRuleCreateRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaConnectorRule -BetaConnectorRuleCreateRequest $ConnectorRuleCreateRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaConnectorRule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-connector-rule +Deletes the connector rule specified by the given ID. +A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the connector rule to delete + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete + +# Delete a Connector-Rule + +try { + Remove-BetaConnectorRule-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaConnectorRule -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaConnectorRule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-connector-rule +Returns the connector rule specified by ID. +A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the connector rule to retrieve + +### Return type +[**ConnectorRuleResponse**](../models/connector-rule-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Connector rule with the given ID | ConnectorRuleResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to retrieve + +# Connector-Rule by ID + +try { + Get-BetaConnectorRule-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaConnectorRule -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorRule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-connector-rule-list +Returns the list of connector rules. +A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**ConnectorRuleResponse[]**](../models/connector-rule-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of connector rules | ConnectorRuleResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List Connector Rules + +try { + Get-BetaConnectorRuleList + + # Below is a request that includes all optional parameters + # Get-BetaConnectorRuleList +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorRuleList" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-connector-rule +Updates an existing connector rule with the one provided in the request body. Note that the fields 'id', 'name', and 'type' are immutable. +A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the connector rule to update + Body | ConnectorRuleUpdateRequest | [**ConnectorRuleUpdateRequest**](../models/connector-rule-update-request) | (optional) | The connector rule with updated data + +### Return type +[**ConnectorRuleResponse**](../models/connector-rule-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The updated connector rule | ConnectorRuleResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to update +$ConnectorRuleUpdateRequest = @"{ + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", + "type" : "BuildMap" +}"@ + +# Update a Connector Rule + +try { + Update-BetaConnectorRule-BetaId $Id + + # Below is a request that includes all optional parameters + # Update-BetaConnectorRule -BetaId $Id -BetaConnectorRuleUpdateRequest $ConnectorRuleUpdateRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaConnectorRule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## validate-connector-rule +Returns a list of issues within the code to fix, if any. +A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | SourceCode | [**SourceCode**](../models/source-code) | True | The code to validate + +### Return type +[**ConnectorRuleValidationResponse**](../models/connector-rule-validation-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The status of the code's eligibility as a connector rule | ConnectorRuleValidationResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceCode = @"{ + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" +}"@ + +# Validate Connector Rule + +try { + $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode + Confirm-BetaConnectorRule-BetaSourceCode $Result + + # Below is a request that includes all optional parameters + # Confirm-BetaConnectorRule -BetaSourceCode $SourceCode +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Confirm-BetaConnectorRule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaConnectorsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaConnectorsApi.md new file mode 100644 index 000000000..66069afba --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaConnectorsApi.md @@ -0,0 +1,87 @@ + +--- +id: beta-connectors +title: Connectors +pagination_label: Connectors +sidebar_label: Connectors +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Connectors', 'BetaConnectors'] +slug: /tools/sdk/powershell/beta/methods/connectors +tags: ['SDK', 'Software Development Kit', 'Connectors', 'BetaConnectors'] +--- + +# Connectors + Use this API to implement connector functionality. +With this functionality in place, administrators can view available connectors. + +Connectors are the bridges Identity Security Cloud uses to communicate with and aggregate data from sources. +For example, if it is necessary to set up a connection between Identity Security Cloud and the Active Directory source, a connector can bridge the two and enable Identity Security Cloud to synchronize data between the systems. +This ensures account entitlements and states are correct throughout the organization. + +In Identity Security Cloud, administrators can use the Connections drop-down menu and select Sources to view the available source connectors. + +Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about the connectors available in Identity Security Cloud. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity) for more information about the SaaS custom connectors that do not need VAs (virtual appliances) to communicate with their sources. + +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about using connectors in Identity Security Cloud. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaConnectorList**](#get-connector-list) | **GET** `/connectors` | Get Connector List + +## get-connector-list +Fetches list of connectors that have 'RELEASED' status using filtering and pagination. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Locale | **String** | (optional) | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + +### Return type +[**V3ConnectorDto[]**](../models/v3-connector-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A Connector Dto object | V3ConnectorDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Filters = 'directConnect eq "true"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + +# Get Connector List + +try { + Get-BetaConnectorList + + # Below is a request that includes all optional parameters + # Get-BetaConnectorList -BetaFilters $Filters -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaLocale $Locale +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorList" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaCustomFormsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaCustomFormsApi.md new file mode 100644 index 000000000..3640b2f6a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaCustomFormsApi.md @@ -0,0 +1,1167 @@ + +--- +id: beta-custom-forms +title: CustomForms +pagination_label: CustomForms +sidebar_label: CustomForms +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CustomForms', 'BetaCustomForms'] +slug: /tools/sdk/powershell/beta/methods/custom-forms +tags: ['SDK', 'Software Development Kit', 'CustomForms', 'BetaCustomForms'] +--- + +# CustomForms + Use this API to build and manage custom forms. +With this functionality in place, administrators can create and view form definitions and form instances. + +Forms are composed of sections and fields. Sections split the form into logical groups of fields and fields are the data collection points within the form. Configure conditions to modify elements of the form as the responder provides input. Create form inputs to pass information from a calling feature, like a workflow, to your form. + +Forms can be used within workflows as an action or as a trigger. The Form Action allows you to assign a form as a step in a running workflow, suspending the workflow until the form is submitted or times out, and the workflow resumes. The Form Submitted Trigger initiates a workflow when a form is submitted. The trigger can be configured to initiate on submission of a full form, a form element with any value, or a form element with a particular value. + +Refer to [Forms](https://documentation.sailpoint.com/saas/help/forms/index.html) for more information about using forms in Identity Security Cloud. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaFormDefinition**](#create-form-definition) | **POST** `/form-definitions` | Creates a form definition. +[**New-BetaFormDefinitionByTemplate**](#create-form-definition-by-template) | **POST** `/form-definitions/template` | Create a form definition by template. +[**New-BetaFormDefinitionDynamicSchema**](#create-form-definition-dynamic-schema) | **POST** `/form-definitions/forms-action-dynamic-schema` | Generate JSON Schema dynamically. +[**New-BetaFormDefinitionFileRequest**](#create-form-definition-file-request) | **POST** `/form-definitions/{formDefinitionID}/upload` | Upload new form definition file. +[**New-BetaFormInstance**](#create-form-instance) | **POST** `/form-instances` | Creates a form instance. +[**Remove-BetaFormDefinition**](#delete-form-definition) | **DELETE** `/form-definitions/{formDefinitionID}` | Deletes a form definition. +[**Export-BetaFormDefinitionsByTenant**](#export-form-definitions-by-tenant) | **GET** `/form-definitions/export` | List form definitions by tenant. +[**Get-BetaFileFromS3**](#get-file-from-s3) | **GET** `/form-definitions/{formDefinitionID}/file/{fileID}` | Download definition file by fileId. +[**Get-BetaFormDefinitionByKey**](#get-form-definition-by-key) | **GET** `/form-definitions/{formDefinitionID}` | Return a form definition. +[**Get-BetaFormInstanceByKey**](#get-form-instance-by-key) | **GET** `/form-instances/{formInstanceID}` | Returns a form instance. +[**Get-BetaFormInstanceFile**](#get-form-instance-file) | **GET** `/form-instances/{formInstanceID}/file/{fileID}` | Download instance file by fileId. +[**Import-BetaFormDefinitions**](#import-form-definitions) | **POST** `/form-definitions/import` | Import form definitions from export. +[**Update-BetaFormDefinition**](#patch-form-definition) | **PATCH** `/form-definitions/{formDefinitionID}` | Patch a form definition. +[**Update-BetaFormInstance**](#patch-form-instance) | **PATCH** `/form-instances/{formInstanceID}` | Patch a form instance. +[**Search-BetaFormDefinitionsByTenant**](#search-form-definitions-by-tenant) | **GET** `/form-definitions` | Export form definitions by tenant. +[**Search-BetaFormElementDataByElementID**](#search-form-element-data-by-element-id) | **GET** `/form-instances/{formInstanceID}/data-source/{formElementID}` | Retrieves dynamic data by element. +[**Search-BetaFormInstancesByTenant**](#search-form-instances-by-tenant) | **GET** `/form-instances` | List form instances by tenant. +[**Search-BetaPreDefinedSelectOptions**](#search-pre-defined-select-options) | **GET** `/form-definitions/predefined-select-options` | List predefined select options. +[**Show-BetaPreviewDataSource**](#show-preview-data-source) | **POST** `/form-definitions/{formDefinitionID}/data-source` | Preview form definition data source. + +## create-form-definition + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CreateFormDefinitionRequest | [**CreateFormDefinitionRequest**](../models/create-form-definition-request) | (optional) | Body is the request payload to create form definition request + +### Return type +[**FormDefinitionResponse**](../models/form-definition-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Returns a new form definition | FormDefinitionResponse +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CreateFormDefinitionRequest = @"{ + "owner" : { + "name" : "Grant Smith", + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "formConditions" : [ { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + }, { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + } ], + "formInput" : [ { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + }, { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + } ], + "name" : "My form", + "description" : "My form description", + "usedBy" : [ { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + }, { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + } ], + "formElements" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + } ] +}"@ + +# Creates a form definition. + +try { + New-BetaFormDefinition + + # Below is a request that includes all optional parameters + # New-BetaFormDefinition -BetaCreateFormDefinitionRequest $CreateFormDefinitionRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinition" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-form-definition-by-template + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CreateFormDefinitionRequest | [**CreateFormDefinitionRequest**](../models/create-form-definition-request) | (optional) | Body is the request payload to create form definition request + +### Return type +[**FormDefinitionResponse**](../models/form-definition-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Returns a new form definition | FormDefinitionResponse +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CreateFormDefinitionRequest = @"{ + "owner" : { + "name" : "Grant Smith", + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "formConditions" : [ { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + }, { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + } ], + "formInput" : [ { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + }, { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + } ], + "name" : "My form", + "description" : "My form description", + "usedBy" : [ { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + }, { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + } ], + "formElements" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + } ] +}"@ + +# Create a form definition by template. + +try { + New-BetaFormDefinitionByTemplate + + # Below is a request that includes all optional parameters + # New-BetaFormDefinitionByTemplate -BetaCreateFormDefinitionRequest $CreateFormDefinitionRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionByTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-form-definition-dynamic-schema + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Body | [**FormDefinitionDynamicSchemaRequest**](../models/form-definition-dynamic-schema-request) | (optional) | Body is the request payload to create a form definition dynamic schema + +### Return type +[**FormDefinitionDynamicSchemaResponse**](../models/form-definition-dynamic-schema-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns a form elements dynamic schema | FormDefinitionDynamicSchemaResponse +400 | An error with the request occurred | GetFormDefinitionByKey400Response +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response +404 | An error with the item not found | GetFormDefinitionByKey400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | GetFormDefinitionByKey400Response + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Body = @"{ + "description" : "A description", + "attributes" : { + "formDefinitionId" : "00000000-0000-0000-0000-000000000000" + }, + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "action", + "versionNumber" : 1 +}"@ + +# Generate JSON Schema dynamically. + +try { + New-BetaFormDefinitionDynamicSchema + + # Below is a request that includes all optional parameters + # New-BetaFormDefinitionDynamicSchema -BetaBody $Body +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionDynamicSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-form-definition-file-request +Parameter `{formDefinitionID}` should match a form definition ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | FormDefinitionID | **String** | True | FormDefinitionID String specifying FormDefinitionID + | File | **System.IO.FileInfo** | True | File specifying the multipart + +### Return type +[**FormDefinitionFileUploadResponse**](../models/form-definition-file-upload-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Returns a new form definition file | FormDefinitionFileUploadResponse +400 | An error with the request occurred | GetFormDefinitionByKey400Response +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response +404 | An error with the item not found | GetFormDefinitionByKey400Response +413 | An error with payload size too large | GetFormDefinitionByKey400Response +415 | An error with unsupported media type | GetFormDefinitionByKey400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | GetFormDefinitionByKey400Response +503 | An external service is not available | GetFormDefinitionByKey400Response + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID +$File = # System.IO.FileInfo | File specifying the multipart + +# Upload new form definition file. + +try { + New-BetaFormDefinitionFileRequest-BetaFormDefinitionID $FormDefinitionID -BetaFile $File + + # Below is a request that includes all optional parameters + # New-BetaFormDefinitionFileRequest -BetaFormDefinitionID $FormDefinitionID -BetaFile $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionFileRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-form-instance + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Body | [**CreateFormInstanceRequest**](../models/create-form-instance-request) | (optional) | Body is the request payload to create a form instance + +### Return type +[**FormInstanceResponse**](../models/form-instance-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Returns a new form instance | FormInstanceResponse +400 | An error with the request occurred | GetFormDefinitionByKey400Response +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | GetFormDefinitionByKey400Response + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Body = @"{ + "formInput" : { + "input1" : "Sales" + }, + "standAloneForm" : false, + "createdBy" : { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "WORKFLOW_EXECUTION" + }, + "recipients" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + } ], + "expire" : "2023-08-12T20:14:57.74486Z", + "formDefinitionId" : "00000000-0000-0000-0000-000000000000", + "state" : "ASSIGNED", + "ttl" : 1571827560 +}"@ + +# Creates a form instance. + +try { + New-BetaFormInstance + + # Below is a request that includes all optional parameters + # New-BetaFormInstance -BetaBody $Body +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormInstance" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-form-definition +Parameter `{formDefinitionID}` should match a form definition ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | FormDefinitionID | **String** | True | Form definition ID + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | Returns an empty body | SystemCollectionsHashtable +400 | An error with the request occurred | GetFormDefinitionByKey400Response +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response +404 | An error with the item not found | GetFormDefinitionByKey400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | GetFormDefinitionByKey400Response + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + +# Deletes a form definition. + +try { + Remove-BetaFormDefinition-BetaFormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Remove-BetaFormDefinition -BetaFormDefinitionID $FormDefinitionID +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaFormDefinition" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## export-form-definitions-by-tenant +No parameters required. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Offset | **Int64** | (optional) (default to 0) | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. + Query | Limit | **Int64** | (optional) (default to 250) | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* + Query | Sorters | **String** | (optional) (default to "name") | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** + +### Return type +[**ExportFormDefinitionsByTenant200ResponseInner[]**](../models/export-form-definitions-by-tenant200-response-inner) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns a list of form definition objects by tenant used by SP-Config | ExportFormDefinitionsByTenant200ResponseInner[] +400 | An error with the request occurred | GetFormDefinitionByKey400Response +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | GetFormDefinitionByKey400Response + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) +$Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) +$Filters = 'name sw "my form"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") + +# List form definitions by tenant. + +try { + Export-BetaFormDefinitionsByTenant + + # Below is a request that includes all optional parameters + # Export-BetaFormDefinitionsByTenant -BetaOffset $Offset -BetaLimit $Limit -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaFormDefinitionsByTenant" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-file-from-s3 + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | FormDefinitionID | **String** | True | FormDefinitionID Form definition ID +Path | FileID | **String** | True | FileID String specifying the hashed name of the uploaded file we are retrieving. + +### Return type +**System.IO.FileInfo** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns a file that is referred to by fileID and associated with the formDefinitionID | System.IO.FileInfo +400 | An error with the request occurred | GetFormDefinitionByKey400Response +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response +404 | An error with the item not found | GetFormDefinitionByKey400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | GetFormDefinitionByKey400Response +503 | An external service is not available | GetFormDefinitionByKey400Response + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json, image/jpeg, image/png, application/octet-stream + +### Example +```powershell +$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID Form definition ID +$FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. + +# Download definition file by fileId. + +try { + Get-BetaFileFromS3-BetaFormDefinitionID $FormDefinitionID -BetaFileID $FileID + + # Below is a request that includes all optional parameters + # Get-BetaFileFromS3 -BetaFormDefinitionID $FormDefinitionID -BetaFileID $FileID +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFileFromS3" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-form-definition-by-key +Parameter `{formDefinitionID}` should match a form definition ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | FormDefinitionID | **String** | True | Form definition ID + +### Return type +[**FormDefinitionResponse**](../models/form-definition-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns a form definition | FormDefinitionResponse +400 | An error with the request occurred | GetFormDefinitionByKey400Response +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response +404 | An error with the item not found | GetFormDefinitionByKey400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | GetFormDefinitionByKey400Response + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + +# Return a form definition. + +try { + Get-BetaFormDefinitionByKey-BetaFormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Get-BetaFormDefinitionByKey -BetaFormDefinitionID $FormDefinitionID +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormDefinitionByKey" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-form-instance-by-key +Parameter `{formInstanceID}` should match a form instance ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | FormInstanceID | **String** | True | Form instance ID + +### Return type +[**FormInstanceResponse**](../models/form-instance-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns a form instance by its key | FormInstanceResponse +400 | An error with the request occurred | GetFormDefinitionByKey400Response +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response +404 | An error with the item not found | GetFormDefinitionByKey400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | GetFormDefinitionByKey400Response + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID + +# Returns a form instance. + +try { + Get-BetaFormInstanceByKey-BetaFormInstanceID $FormInstanceID + + # Below is a request that includes all optional parameters + # Get-BetaFormInstanceByKey -BetaFormInstanceID $FormInstanceID +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormInstanceByKey" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-form-instance-file + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | FormInstanceID | **String** | True | FormInstanceID Form instance ID +Path | FileID | **String** | True | FileID String specifying the hashed name of the uploaded file we are retrieving. + +### Return type +**System.IO.FileInfo** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns a file that is referred to by fileID and associated with the formInstanceID | System.IO.FileInfo +400 | An error with the request occurred | GetFormDefinitionByKey400Response +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response +404 | An error with the item not found | GetFormDefinitionByKey400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | GetFormDefinitionByKey400Response +503 | An external service is not available | GetFormDefinitionByKey400Response + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json, image/jpeg, image/png, application/octet-stream + +### Example +```powershell +$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | FormInstanceID Form instance ID +$FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. + +# Download instance file by fileId. + +try { + Get-BetaFormInstanceFile-BetaFormInstanceID $FormInstanceID -BetaFileID $FileID + + # Below is a request that includes all optional parameters + # Get-BetaFormInstanceFile -BetaFormInstanceID $FormInstanceID -BetaFileID $FileID +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormInstanceFile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-form-definitions + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Body | [**[]ImportFormDefinitionsRequestInner**](../models/import-form-definitions-request-inner) | (optional) | Body is the request payload to import form definitions + +### Return type +[**ImportFormDefinitions202Response**](../models/import-form-definitions202-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Returns statuses of those form definition objects imported | ImportFormDefinitions202Response +400 | An error with the request occurred | GetFormDefinitionByKey400Response +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | GetFormDefinitionByKey400Response + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell + + + + + + + $Body = @"[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]"@ # ImportFormDefinitionsRequestInner[] | Body is the request payload to import form definitions (optional) + + +# Import form definitions from export. + +try { + Import-BetaFormDefinitions + + # Below is a request that includes all optional parameters + # Import-BetaFormDefinitions -BetaBody $Body +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaFormDefinitions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-form-definition +Parameter `{formDefinitionID}` should match a form definition ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | FormDefinitionID | **String** | True | Form definition ID + Body | Body | [**[]System.Collections.Hashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | (optional) | Body is the request payload to patch a form definition, check: https://jsonpatch.com + +### Return type +[**FormDefinitionResponse**](../models/form-definition-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns the form definition updated | FormDefinitionResponse +400 | An error with the request occurred | GetFormDefinitionByKey400Response +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response +404 | An error with the user permissions occurred | GetFormDefinitionByKey400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | GetFormDefinitionByKey400Response + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID +$Body = @{ key_example = } # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) + $Body = @"[{op=replace, path=/description, value=test-description}]"@ # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) + + +# Patch a form definition. + +try { + Update-BetaFormDefinition-BetaFormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Update-BetaFormDefinition -BetaFormDefinitionID $FormDefinitionID -BetaBody $Body +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaFormDefinition" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-form-instance +Parameter `{formInstanceID}` should match a form instance ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | FormInstanceID | **String** | True | Form instance ID + Body | Body | [**[]System.Collections.Hashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | (optional) | Body is the request payload to patch a form instance, check: https://jsonpatch.com + +### Return type +[**FormInstanceResponse**](../models/form-instance-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns the form instance updated | FormInstanceResponse +400 | An error with the request occurred | GetFormDefinitionByKey400Response +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response +404 | An error with the item not found | GetFormDefinitionByKey400Response +409 | An error with the request property conflicts with stored | GetFormDefinitionByKey400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | GetFormDefinitionByKey400Response + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID +$Body = @{ key_example = } # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) + $Body = @"[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]"@ # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) + + +# Patch a form instance. + +try { + Update-BetaFormInstance-BetaFormInstanceID $FormInstanceID + + # Below is a request that includes all optional parameters + # Update-BetaFormInstance -BetaFormInstanceID $FormInstanceID -BetaBody $Body +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaFormInstance" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## search-form-definitions-by-tenant +No parameters required. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Offset | **Int64** | (optional) (default to 0) | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. + Query | Limit | **Int64** | (optional) (default to 250) | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* + Query | Sorters | **String** | (optional) (default to "name") | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** + +### Return type +[**ListFormDefinitionsByTenantResponse**](../models/list-form-definitions-by-tenant-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns a list of form definitions by tenant | ListFormDefinitionsByTenantResponse +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Offset = 250 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) +$Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) +$Filters = 'name sw "my form"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") + +# Export form definitions by tenant. + +try { + Search-BetaFormDefinitionsByTenant + + # Below is a request that includes all optional parameters + # Search-BetaFormDefinitionsByTenant -BetaOffset $Offset -BetaLimit $Limit -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormDefinitionsByTenant" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## search-form-element-data-by-element-id +Parameter `{formInstanceID}` should match a form instance ID. +Parameter `{formElementID}` should match a form element ID at the data source configuration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | FormInstanceID | **String** | True | Form instance ID +Path | FormElementID | **String** | True | Form element ID + Query | Limit | **Int64** | (optional) (default to 250) | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` + Query | Query | **String** | (optional) | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. + +### Return type +[**ListFormElementDataByElementIDResponse**](../models/list-form-element-data-by-element-id-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Retrieves dynamic data to aid in correctly completing a valid form by form element ID from data source configuration | ListFormElementDataByElementIDResponse +400 | An error with the request occurred | GetFormDefinitionByKey400Response +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response +404 | An error with the item not found | GetFormDefinitionByKey400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | GetFormDefinitionByKey400Response + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID +$FormElementID = "1" # String | Form element ID +$Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) +$Filters = 'value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"')` (optional) +$Query = "support" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) + +# Retrieves dynamic data by element. + +try { + Search-BetaFormElementDataByElementID-BetaFormInstanceID $FormInstanceID -BetaFormElementID $FormElementID + + # Below is a request that includes all optional parameters + # Search-BetaFormElementDataByElementID -BetaFormInstanceID $FormInstanceID -BetaFormElementID $FormElementID -BetaLimit $Limit -BetaFilters $Filters -BetaQuery $Query +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormElementDataByElementID" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## search-form-instances-by-tenant +No parameters required. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**FormInstanceResponse[]**](../models/form-instance-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns a list of form instances by tenant | FormInstanceResponse[] +400 | An error with the request occurred | GetFormDefinitionByKey400Response +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | GetFormDefinitionByKey400Response + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List form instances by tenant. + +try { + Search-BetaFormInstancesByTenant + + # Below is a request that includes all optional parameters + # Search-BetaFormInstancesByTenant +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormInstancesByTenant" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## search-pre-defined-select-options +No parameters required. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**ListPredefinedSelectOptionsResponse**](../models/list-predefined-select-options-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns a list of available predefined select options | ListPredefinedSelectOptionsResponse +400 | An error with the request occurred | GetFormDefinitionByKey400Response +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | GetFormDefinitionByKey400Response + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List predefined select options. + +try { + Search-BetaPreDefinedSelectOptions + + # Below is a request that includes all optional parameters + # Search-BetaPreDefinedSelectOptions +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaPreDefinedSelectOptions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## show-preview-data-source + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | FormDefinitionID | **String** | True | Form definition ID + Query | Limit | **Int64** | (optional) (default to 10) | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` + Query | Query | **String** | (optional) | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. + Body | FormElementPreviewRequest | [**FormElementPreviewRequest**](../models/form-element-preview-request) | (optional) | Body is the request payload to create a form definition dynamic schema + +### Return type +[**PreviewDataSourceResponse**](../models/preview-data-source-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns a preview of a form definition data source | PreviewDataSourceResponse +400 | An error with the request occurred | GetFormDefinitionByKey400Response +401 | An error with the authorization occurred | GetFormDefinitionByKey400Response +403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response +404 | An error with the item not found | GetFormDefinitionByKey400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | GetFormDefinitionByKey400Response + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID +$Limit = 10 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) +$Filters = 'value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"')` (optional) +$Query = "ac" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) +$FormElementPreviewRequest = @"{ + "dataSource" : { + "config" : { + "indices" : [ "identities" ], + "query" : "*", + "aggregationBucketField" : "attributes.cloudStatus.exact", + "objectType" : "IDENTITY" + }, + "dataSourceType" : "STATIC" + } +}"@ + +# Preview form definition data source. + +try { + Show-BetaPreviewDataSource-BetaFormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Show-BetaPreviewDataSource -BetaFormDefinitionID $FormDefinitionID -BetaLimit $Limit -BetaFilters $Filters -BetaQuery $Query -BetaFormElementPreviewRequest $FormElementPreviewRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-BetaPreviewDataSource" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaCustomPasswordInstructionsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaCustomPasswordInstructionsApi.md new file mode 100644 index 000000000..6cd18a5d3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaCustomPasswordInstructionsApi.md @@ -0,0 +1,166 @@ + +--- +id: beta-custom-password-instructions +title: CustomPasswordInstructions +pagination_label: CustomPasswordInstructions +sidebar_label: CustomPasswordInstructions +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CustomPasswordInstructions', 'BetaCustomPasswordInstructions'] +slug: /tools/sdk/powershell/beta/methods/custom-password-instructions +tags: ['SDK', 'Software Development Kit', 'CustomPasswordInstructions', 'BetaCustomPasswordInstructions'] +--- + +# CustomPasswordInstructions + Use this API to implement custom password instruction functionality. +With this functionality in place, administrators can create custom password instructions to help users reset their passwords, change them, unlock their accounts, or recover their usernames. +This allows administrators to emphasize password policies or provide organization-specific instructions. + +Administrators must first use [Update Password Org Config](https://developer.sailpoint.com/docs/api/beta/put-password-org-config/) to set `customInstructionsEnabled` to `true`. + +Once they have enabled custom instructions, they can use [Create Custom Password Instructions](https://developer.sailpoint.com/docs/api/beta/create-custom-password-instructions/) to create custom page content for the specific pageId they select. + +For example, an administrator can use the pageId forget-username:user-email to set the custom text for the case when users forget their usernames and must enter their emails. + +Refer to [Creating Custom Instruction Text](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html#creating-custom-instruction-text) for more information about creating custom password instructions. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaCustomPasswordInstructions**](#create-custom-password-instructions) | **POST** `/custom-password-instructions` | Create Custom Password Instructions +[**Remove-BetaCustomPasswordInstructions**](#delete-custom-password-instructions) | **DELETE** `/custom-password-instructions/{pageId}` | Delete Custom Password Instructions by page ID +[**Get-BetaCustomPasswordInstructions**](#get-custom-password-instructions) | **GET** `/custom-password-instructions/{pageId}` | Get Custom Password Instructions by Page ID + +## create-custom-password-instructions +This API creates the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CustomPasswordInstruction | [**CustomPasswordInstruction**](../models/custom-password-instruction) | True | + +### Return type +[**CustomPasswordInstruction**](../models/custom-password-instruction) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the custom password instructions. | CustomPasswordInstruction +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CustomPasswordInstruction = @"{ + "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", + "pageId" : "change-password:enter-password", + "locale" : "en" +}"@ + +# Create Custom Password Instructions + +try { + $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction + New-BetaCustomPasswordInstructions-BetaCustomPasswordInstruction $Result + + # Below is a request that includes all optional parameters + # New-BetaCustomPasswordInstructions -BetaCustomPasswordInstruction $CustomPasswordInstruction +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCustomPasswordInstructions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-custom-password-instructions +This API delete the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | PageId | **String** | True | The page ID of custom password instructions to delete. + Query | Locale | **String** | (optional) | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$PageId = "change-password:enter-password" # String | The page ID of custom password instructions to delete. +$Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) + +# Delete Custom Password Instructions by page ID + +try { + Remove-BetaCustomPasswordInstructions-BetaPageId $PageId + + # Below is a request that includes all optional parameters + # Remove-BetaCustomPasswordInstructions -BetaPageId $PageId -BetaLocale $Locale +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCustomPasswordInstructions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-custom-password-instructions +This API returns the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | PageId | **String** | True | The page ID of custom password instructions to query. + Query | Locale | **String** | (optional) | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". + +### Return type +[**CustomPasswordInstruction**](../models/custom-password-instruction) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the custom password instructions. | CustomPasswordInstruction +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$PageId = "change-password:enter-password" # String | The page ID of custom password instructions to query. +$Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) + +# Get Custom Password Instructions by Page ID + +try { + Get-BetaCustomPasswordInstructions-BetaPageId $PageId + + # Below is a request that includes all optional parameters + # Get-BetaCustomPasswordInstructions -BetaPageId $PageId -BetaLocale $Locale +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomPasswordInstructions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaEntitlementsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaEntitlementsApi.md new file mode 100644 index 000000000..177686a44 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaEntitlementsApi.md @@ -0,0 +1,700 @@ + +--- +id: beta-entitlements +title: Entitlements +pagination_label: Entitlements +sidebar_label: Entitlements +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Entitlements', 'BetaEntitlements'] +slug: /tools/sdk/powershell/beta/methods/entitlements +tags: ['SDK', 'Software Development Kit', 'Entitlements', 'BetaEntitlements'] +--- + +# Entitlements + Use this API to implement and customize entitlement functionality. +With this functionality in place, administrators can view entitlements and configure them for use throughout Identity Security Cloud in certifications, access profiles, and roles. +Administrators in Identity Security Cloud can then grant users access to the entitlements or configure them so users themselves can request access to the entitlements whenever they need them. +With a good approval process, this entitlement functionality allows users to gain the specific access they need on sources quickly and securely. + +Entitlements represent access rights on sources. +Entitlements are the most granular form of access in Identity Security Cloud. +Entitlements are often grouped into access profiles, and access profiles themselves are often grouped into roles, the broadest form of access in Identity Security Cloud. + +For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +An administrator can then create an even broader set of access in the form of a role grouping the 'AD Developers' access profile with another profile, 'GitHub Developers,' grouping entitlements for the GitHub source. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +When users need both the 'AD Developers' access profile and the 'GitHub Developers' access profile, they can request access to the role grouping both. + +Administrators often use roles and access profiles within those roles to manage access so that users can gain access more quickly, but the hierarchy of access all starts with entitlements. + +Anywhere entitlements appear, you can select them to find more information about the following: + +- Cloud Access Details: These provide details about the cloud access entitlements on cloud-enabled sources. + +- Permissions: Permissions represent individual units of read/write/admin access to a system. + +- Relationships: These list each entitlement's parent and child relationships. + +- Type: This is the entitlement's type. Some sources support multiple types, each with a different attribute schema. + +Identity Security Cloud uses entitlements in many features, including the following: + +- Certifications: Entitlements can be revoked from an identity that no longer needs them. + +- Roles: Roles can group access profiles which themselves group entitlements. You can grant and revoke access on a broad level with roles. Role membership criteria can grant roles to identities based on whether they have certain entitlements or attributes. + +- Access Profiles: Access profiles group entitlements. +They are the most important units of access in Identity Security Cloud. +Identity Security Cloud uses them in provisioning, certifications, and access requests, and administrators can configure them to grant very broad or very granular access. + +You cannot delete entitlements directly from Identity Security Cloud. +Entitlements are deleted based on their inclusion in aggregations. + +Refer to [Deleting Entitlements](https://documentation.sailpoint.com/saas/help/access/entitlements.html#deleting-entitlements) more information about deleting entitlements. + +Refer to [Entitlements](https://documentation.sailpoint.com/saas/help/access/entitlements.html) for more information about entitlements. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaAccessModelMetadataForEntitlement**](#create-access-model-metadata-for-entitlement) | **POST** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add metadata to an entitlement. +[**Remove-BetaAccessModelMetadataFromEntitlement**](#delete-access-model-metadata-from-entitlement) | **DELETE** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove metadata from an entitlement. +[**Get-BetaEntitlement**](#get-entitlement) | **GET** `/entitlements/{id}` | Get an entitlement +[**Get-BetaEntitlementRequestConfig**](#get-entitlement-request-config) | **GET** `/entitlements/{id}/entitlement-request-config` | Get Entitlement Request Config +[**Import-BetaEntitlementsBySource**](#import-entitlements-by-source) | **POST** `/entitlements/aggregate/sources/{id}` | Aggregate Entitlements +[**Get-BetaEntitlementChildren**](#list-entitlement-children) | **GET** `/entitlements/{id}/children` | List of entitlements children +[**Get-BetaEntitlementParents**](#list-entitlement-parents) | **GET** `/entitlements/{id}/parents` | List of entitlements parents +[**Get-BetaEntitlements**](#list-entitlements) | **GET** `/entitlements` | Gets a list of entitlements. +[**Update-BetaEntitlement**](#patch-entitlement) | **PATCH** `/entitlements/{id}` | Patch an entitlement +[**Send-BetaEntitlementRequestConfig**](#put-entitlement-request-config) | **PUT** `/entitlements/{id}/entitlement-request-config` | Replace Entitlement Request Config +[**Reset-BetaSourceEntitlements**](#reset-source-entitlements) | **POST** `/entitlements/reset/sources/{id}` | Reset Source Entitlements +[**Update-BetaEntitlementsInBulk**](#update-entitlements-in-bulk) | **POST** `/entitlements/bulk-update` | Bulk update an entitlement list + +## create-access-model-metadata-for-entitlement +Add single Access Model Metadata to an entitlement. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The entitlement id. +Path | AttributeKey | **String** | True | Technical name of the Attribute. +Path | AttributeValue | **String** | True | Technical name of the Attribute Value. + +### Return type +[**Entitlement**](../models/entitlement) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | OK | Entitlement +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. +$AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. +$AttributeValue = "public" # String | Technical name of the Attribute Value. + +# Add metadata to an entitlement. + +try { + New-BetaAccessModelMetadataForEntitlement-BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue + + # Below is a request that includes all optional parameters + # New-BetaAccessModelMetadataForEntitlement -BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessModelMetadataForEntitlement" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-access-model-metadata-from-entitlement +Remove single Access Model Metadata from an entitlement. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The entitlement id. +Path | AttributeKey | **String** | True | Technical name of the Attribute. +Path | AttributeValue | **String** | True | Technical name of the Attribute Value. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | OK | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. +$AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. +$AttributeValue = "public" # String | Technical name of the Attribute Value. + +# Remove metadata from an entitlement. + +try { + Remove-BetaAccessModelMetadataFromEntitlement-BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue + + # Below is a request that includes all optional parameters + # Remove-BetaAccessModelMetadataFromEntitlement -BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessModelMetadataFromEntitlement" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-entitlement +This API returns an entitlement by its ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The entitlement ID + +### Return type +[**Entitlement**](../models/entitlement) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An entitlement | Entitlement +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID + +# Get an entitlement + +try { + Get-BetaEntitlement-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaEntitlement -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlement" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-entitlement-request-config +This API returns the entitlement request config for a specified entitlement. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Entitlement Id + +### Return type +[**EntitlementRequestConfig**](../models/entitlement-request-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An Entitlement Request Config | EntitlementRequestConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id + +# Get Entitlement Request Config + +try { + Get-BetaEntitlementRequestConfig-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementRequestConfig -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementRequestConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-entitlements-by-source +Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). + +If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. + +If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source Id + | CsvFile | **System.IO.FileInfo** | (optional) | The CSV file containing the source entitlements to aggregate. + +### Return type +[**LoadEntitlementTask**](../models/load-entitlement-task) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Aggregate Entitlements Task | LoadEntitlementTask +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id +$CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) + +# Aggregate Entitlements + +try { + Import-BetaEntitlementsBySource-BetaId $Id + + # Below is a request that includes all optional parameters + # Import-BetaEntitlementsBySource -BetaId $Id -BetaCsvFile $CsvFile +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaEntitlementsBySource" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-entitlement-children +This API returns a list of all child entitlements of a given entitlement. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Entitlement Id + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* + +### Return type +[**Entitlement[]**](../models/entitlement) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of entitlements children from an entitlement | Entitlement[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) +$Filters = 'attribute eq "memberOf"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + +# List of entitlements children + +try { + Get-BetaEntitlementChildren-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementChildren -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementChildren" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-entitlement-parents +This API returns a list of all parent entitlements of a given entitlement. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Entitlement Id + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* + +### Return type +[**Entitlement[]**](../models/entitlement) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of entitlements parents from an entitlement | Entitlement[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) +$Filters = 'attribute eq "memberOf"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + +# List of entitlements parents + +try { + Get-BetaEntitlementParents-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementParents -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementParents" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-entitlements +This API returns a list of entitlements. + +This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). + +Any authenticated token can call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | AccountId | **String** | (optional) | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. + Query | SegmentedForIdentity | **String** | (optional) | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. + Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). + Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* + +### Return type +[**Entitlement[]**](../models/entitlement) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of entitlements | Entitlement[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (optional) +$SegmentedForIdentity = "me" # String | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) +$ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) +$IncludeUnsegmented = $true # Boolean | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to $true) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) +$Filters = 'attribute eq "memberOf"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) + +# Gets a list of entitlements. + +try { + Get-BetaEntitlements + + # Below is a request that includes all optional parameters + # Get-BetaEntitlements -BetaAccountId $AccountId -BetaSegmentedForIdentity $SegmentedForIdentity -BetaForSegmentIds $ForSegmentIds -BetaIncludeUnsegmented $IncludeUnsegmented -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlements" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-entitlement +This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields** + +When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. + +A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the entitlement to patch + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) | + +### Return type +[**Entitlement**](../models/entitlement) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the entitlement as updated. | Entitlement +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | (optional) + + +# Patch an entitlement + +try { + Update-BetaEntitlement-BetaId $Id + + # Below is a request that includes all optional parameters + # Update-BetaEntitlement -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlement" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-entitlement-request-config +This API replaces the entitlement request config for a specified entitlement. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Entitlement ID + Body | EntitlementRequestConfig | [**EntitlementRequestConfig**](../models/entitlement-request-config) | True | + +### Return type +[**EntitlementRequestConfig**](../models/entitlement-request-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the entitlement request config as updated. | EntitlementRequestConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID +$EntitlementRequestConfig = @"{ + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } +}"@ + +# Replace Entitlement Request Config + +try { + $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig + Send-BetaEntitlementRequestConfig-BetaId $Id -BetaEntitlementRequestConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaEntitlementRequestConfig -BetaId $Id -BetaEntitlementRequestConfig $EntitlementRequestConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaEntitlementRequestConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## reset-source-entitlements +Remove all entitlements from a specific source. +To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Import Accounts](https://developer.sailpoint.com/docs/api/beta/import-accounts/) with `disableOptimization` = `true`. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of source for the entitlement reset + +### Return type +[**EntitlementSourceResetBaseReferenceDto**](../models/entitlement-source-reset-base-reference-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Entitlement source reset task result | EntitlementSourceResetBaseReferenceDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset + +# Reset Source Entitlements + +try { + Reset-BetaSourceEntitlements-BetaId $Id + + # Below is a request that includes all optional parameters + # Reset-BetaSourceEntitlements -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-BetaSourceEntitlements" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-entitlements-in-bulk +This API applies an update to every entitlement of the list. + + +The number of entitlements to update is limited to 50 items maximum. + + +The JsonPatch update follows the [JSON +Patch](https://tools.ietf.org/html/rfc6902) standard. allowed operations : +`**{ "op": "replace", "path": "/privileged", "value": boolean }** **{ "op": +"replace", "path": "/requestable","value": boolean }**` + + +A token with ORG_ADMIN or API authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | EntitlementBulkUpdateRequest | [**EntitlementBulkUpdateRequest**](../models/entitlement-bulk-update-request) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$EntitlementBulkUpdateRequest = @"{ + "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/privileged", + "value" : false + }, { + "op" : "replace", + "path" : "/requestable", + "value" : false + } ] +}"@ + +# Bulk update an entitlement list + +try { + $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest + Update-BetaEntitlementsInBulk-BetaEntitlementBulkUpdateRequest $Result + + # Below is a request that includes all optional parameters + # Update-BetaEntitlementsInBulk -BetaEntitlementBulkUpdateRequest $EntitlementBulkUpdateRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlementsInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaGovernanceGroupsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaGovernanceGroupsApi.md new file mode 100644 index 000000000..dd372a0d1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaGovernanceGroupsApi.md @@ -0,0 +1,539 @@ + +--- +id: beta-governance-groups +title: GovernanceGroups +pagination_label: GovernanceGroups +sidebar_label: GovernanceGroups +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GovernanceGroups', 'BetaGovernanceGroups'] +slug: /tools/sdk/powershell/beta/methods/governance-groups +tags: ['SDK', 'Software Development Kit', 'GovernanceGroups', 'BetaGovernanceGroups'] +--- + +# GovernanceGroups + Use this API to implement and customize Governance Group functionality. With this functionality in place, administrators can create Governance Groups and configure them for use throughout Identity Security Cloud. + +A governance group is a group of users that can make governance decisions about access. If your organization has the Access Request or Certifications service, you can configure governance groups to review access requests or certifications. A governance group can determine whether specific access is appropriate for a user. + +Refer to [Creating and Managing Governance Groups](https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html) for more information about how to build Governance Groups in the visual builder in the Identity Security Cloud UI. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaWorkgroup**](#create-workgroup) | **POST** `/workgroups` | Create a new Governance Group. +[**Remove-BetaWorkgroup**](#delete-workgroup) | **DELETE** `/workgroups/{id}` | Delete a Governance Group +[**Remove-BetaWorkgroupMembers**](#delete-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-delete` | Remove members from Governance Group +[**Remove-BetaWorkgroupsInBulk**](#delete-workgroups-in-bulk) | **POST** `/workgroups/bulk-delete` | Delete Governance Group(s) +[**Get-BetaWorkgroup**](#get-workgroup) | **GET** `/workgroups/{id}` | Get Governance Group by Id +[**Get-BetaConnections**](#list-connections) | **GET** `/workgroups/{workgroupId}/connections` | List connections for Governance Group +[**Get-BetaWorkgroupMembers**](#list-workgroup-members) | **GET** `/workgroups/{workgroupId}/members` | List Governance Group Members +[**Get-BetaWorkgroups**](#list-workgroups) | **GET** `/workgroups` | List Governance Groups +[**Update-BetaWorkgroup**](#patch-workgroup) | **PATCH** `/workgroups/{id}` | Patch a Governance Group +[**Update-BetaWorkgroupMembers**](#update-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-add` | Add members to Governance Group + +## create-workgroup +This API creates a new Governance Group. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | WorkgroupDto | [**WorkgroupDto**](../models/workgroup-dto) | True | + +### Return type +[**WorkgroupDto**](../models/workgroup-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Governance Group object created. | WorkgroupDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$WorkgroupDto = @"{ + "owner" : { + "emailAddress" : "support@sailpoint.com", + "displayName" : "Support", + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "connectionCount" : 1641498673000, + "created" : "2022-01-06T19:51:13Z", + "memberCount" : 1641498673000, + "name" : "DB Access Governance Group", + "description" : "Description of the Governance Group", + "modified" : "2022-01-06T19:51:13Z", + "id" : "2c91808568c529c60168cca6f90c1313" +}"@ + +# Create a new Governance Group. + +try { + $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto + New-BetaWorkgroup-BetaWorkgroupDto $Result + + # Below is a request that includes all optional parameters + # New-BetaWorkgroup -BetaWorkgroupDto $WorkgroupDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkgroup" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-workgroup +This API deletes a Governance Group by its ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Governance Group + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + +# Delete a Governance Group + +try { + Remove-BetaWorkgroup-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaWorkgroup -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroup" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-workgroup-members +This API removes one or more members from a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. + +> **Following field of Identity is an optional field in the request.** + +> **name** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | WorkgroupId | **String** | True | ID of the Governance Group. + Body | BulkWorkgroupMembersRequestInner | [**[]BulkWorkgroupMembersRequestInner**](../models/bulk-workgroup-members-request-inner) | True | List of identities to be removed from a Governance Group members list. + +### Return type +[**WorkgroupMemberDeleteItem[]**](../models/workgroup-member-delete-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +207 | List of deleted and not deleted identities from Governance Group members list. | WorkgroupMemberDeleteItem[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $BulkWorkgroupMembersRequestInner = @""@ # BulkWorkgroupMembersRequestInner[] | List of identities to be removed from a Governance Group members list. + + +# Remove members from Governance Group + +try { + $Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner + Remove-BetaWorkgroupMembers-BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result + + # Below is a request that includes all optional parameters + # Remove-BetaWorkgroupMembers -BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $BulkWorkgroupMembersRequestInner +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroupMembers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-workgroups-in-bulk + +This API initiates a bulk deletion of one or more Governance Groups. + +> If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. + +> If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. + +> If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. + +> If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. + +> **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | WorkgroupBulkDeleteRequest | [**WorkgroupBulkDeleteRequest**](../models/workgroup-bulk-delete-request) | True | + +### Return type +[**WorkgroupDeleteItem[]**](../models/workgroup-delete-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +207 | Governance Group bulk delete response. | WorkgroupDeleteItem[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$WorkgroupBulkDeleteRequest = @"{ + "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] +}"@ + +# Delete Governance Group(s) + +try { + $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest + Remove-BetaWorkgroupsInBulk-BetaWorkgroupBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaWorkgroupsInBulk -BetaWorkgroupBulkDeleteRequest $WorkgroupBulkDeleteRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroupsInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-workgroup +This API returns a Governance Groups by its ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Governance Group + +### Return type +[**WorkgroupDto**](../models/workgroup-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A Governance Group | WorkgroupDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + +# Get Governance Group by Id + +try { + Get-BetaWorkgroup-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkgroup -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroup" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-connections +This API returns list of connections associated with a Governance Group. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | WorkgroupId | **String** | True | ID of the Governance Group. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** + +### Return type +[**WorkgroupConnectionDto[]**](../models/workgroup-connection-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List all connections associated with a Governance Group. | WorkgroupConnectionDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + +# List connections for Governance Group + +try { + Get-BetaConnections-BetaWorkgroupId $WorkgroupId + + # Below is a request that includes all optional parameters + # Get-BetaConnections -BetaWorkgroupId $WorkgroupId -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnections" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-workgroup-members +This API returns list of members associated with a Governance Group. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | WorkgroupId | **String** | True | ID of the Governance Group. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** + +### Return type +[**ListWorkgroupMembers200ResponseInner[]**](../models/list-workgroup-members200-response-inner) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List all members associated with a Governance Group. | ListWorkgroupMembers200ResponseInner[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + +# List Governance Group Members + +try { + Get-BetaWorkgroupMembers-BetaWorkgroupId $WorkgroupId + + # Below is a request that includes all optional parameters + # Get-BetaWorkgroupMembers -BetaWorkgroupId $WorkgroupId -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroupMembers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-workgroups +This API returns list of Governance Groups + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** + +### Return type +[**WorkgroupDto[]**](../models/workgroup-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Governance Groups | WorkgroupDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'name sw "Test"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional) + +# List Governance Groups + +try { + Get-BetaWorkgroups + + # Below is a request that includes all optional parameters + # Get-BetaWorkgroups -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroups" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-workgroup +This API updates an existing governance group by ID. +The following fields and objects are patchable: + * name + * description + * owner + +A token with API or ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Governance Group + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) | + +### Return type +[**WorkgroupDto**](../models/workgroup-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A Governance Group. | WorkgroupDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | (optional) + + +# Patch a Governance Group + +try { + Update-BetaWorkgroup-BetaId $Id + + # Below is a request that includes all optional parameters + # Update-BetaWorkgroup -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkgroup" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-workgroup-members +This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. + +> **Following field of Identity is an optional field in the request.** + +> **name** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | WorkgroupId | **String** | True | ID of the Governance Group. + Body | BulkWorkgroupMembersRequestInner | [**[]BulkWorkgroupMembersRequestInner**](../models/bulk-workgroup-members-request-inner) | True | List of identities to be added to a Governance Group members list. + +### Return type +[**WorkgroupMemberAddItem[]**](../models/workgroup-member-add-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +207 | List of added and not added identities into Governance Group members list. | WorkgroupMemberAddItem[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $BulkWorkgroupMembersRequestInner = @""@ # BulkWorkgroupMembersRequestInner[] | List of identities to be added to a Governance Group members list. + + +# Add members to Governance Group + +try { + $Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner + Update-BetaWorkgroupMembers-BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaWorkgroupMembers -BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $BulkWorkgroupMembersRequestInner +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkgroupMembers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIAIAccessRequestRecommendationsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIAIAccessRequestRecommendationsApi.md new file mode 100644 index 000000000..8925ed041 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIAIAccessRequestRecommendationsApi.md @@ -0,0 +1,430 @@ + +--- +id: beta-iai-access-request-recommendations +title: IAIAccessRequestRecommendations +pagination_label: IAIAccessRequestRecommendations +sidebar_label: IAIAccessRequestRecommendations +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IAIAccessRequestRecommendations', 'BetaIAIAccessRequestRecommendations'] +slug: /tools/sdk/powershell/beta/methods/iai-access-request-recommendations +tags: ['SDK', 'Software Development Kit', 'IAIAccessRequestRecommendations', 'BetaIAIAccessRequestRecommendations'] +--- + +# IAIAccessRequestRecommendations + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Add-BetaAccessRequestRecommendationsIgnoredItem**](#add-access-request-recommendations-ignored-item) | **POST** `/ai-access-request-recommendations/ignored-items` | Notification of Ignored Access Request Recommendations +[**Add-BetaAccessRequestRecommendationsRequestedItem**](#add-access-request-recommendations-requested-item) | **POST** `/ai-access-request-recommendations/requested-items` | Notification of Requested Access Request Recommendations +[**Add-BetaAccessRequestRecommendationsViewedItem**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Notification of Viewed Access Request Recommendations +[**Add-BetaAccessRequestRecommendationsViewedItems**](#add-access-request-recommendations-viewed-items) | **POST** `/ai-access-request-recommendations/viewed-items/bulk-create` | Notification of Viewed Access Request Recommendations in Bulk +[**Get-BetaAccessRequestRecommendations**](#get-access-request-recommendations) | **GET** `/ai-access-request-recommendations` | Identity Access Request Recommendations +[**Get-BetaAccessRequestRecommendationsIgnoredItems**](#get-access-request-recommendations-ignored-items) | **GET** `/ai-access-request-recommendations/ignored-items` | List of Ignored Access Request Recommendations +[**Get-BetaAccessRequestRecommendationsRequestedItems**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List of Requested Access Request Recommendations +[**Get-BetaAccessRequestRecommendationsViewedItems**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List of Viewed Access Request Recommendations + +## add-access-request-recommendations-ignored-item +This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | AccessRequestRecommendationActionItemDto | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access item to ignore for an identity. + +### Return type +[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Recommendation successfully stored as ignored. | AccessRequestRecommendationActionItemResponseDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$AccessRequestRecommendationActionItemDto = @"{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" +}"@ + +# Notification of Ignored Access Request Recommendations + +try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-BetaAccessRequestRecommendationsIgnoredItem-BetaAccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-BetaAccessRequestRecommendationsIgnoredItem -BetaAccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsIgnoredItem" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## add-access-request-recommendations-requested-item +This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | AccessRequestRecommendationActionItemDto | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access item that was requested for an identity. + +### Return type +[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Notification successfully acknowledged. | AccessRequestRecommendationActionItemResponseDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$AccessRequestRecommendationActionItemDto = @"{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" +}"@ + +# Notification of Requested Access Request Recommendations + +try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-BetaAccessRequestRecommendationsRequestedItem-BetaAccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-BetaAccessRequestRecommendationsRequestedItem -BetaAccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsRequestedItem" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## add-access-request-recommendations-viewed-item +This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | AccessRequestRecommendationActionItemDto | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access that was viewed for an identity. + +### Return type +[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Recommendation successfully stored as viewed. | AccessRequestRecommendationActionItemResponseDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$AccessRequestRecommendationActionItemDto = @"{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" +}"@ + +# Notification of Viewed Access Request Recommendations + +try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-BetaAccessRequestRecommendationsViewedItem-BetaAccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-BetaAccessRequestRecommendationsViewedItem -BetaAccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsViewedItem" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## add-access-request-recommendations-viewed-items +This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | AccessRequestRecommendationActionItemDto | [**[]AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access items that were viewed for an identity. + +### Return type +[**AccessRequestRecommendationActionItemResponseDto[]**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Recommendations successfully stored as viewed. | AccessRequestRecommendationActionItemResponseDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell + $AccessRequestRecommendationActionItemDto = @"{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" +}"@ # AccessRequestRecommendationActionItemDto[] | The recommended access items that were viewed for an identity. + + +# Notification of Viewed Access Request Recommendations in Bulk + +try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-BetaAccessRequestRecommendationsViewedItems-BetaAccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-BetaAccessRequestRecommendationsViewedItems -BetaAccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsViewedItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-access-request-recommendations +This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | IdentityId | **String** | (optional) (default to "me") | Get access request recommendations for an identityId. *me* indicates the current user. + Query | Limit | **Int32** | (optional) (default to 15) | Max number of results to return. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | IncludeTranslationMessages | **Boolean** | (optional) (default to $false) | If *true* it will populate a list of translation messages in the response. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. + +### Return type +[**AccessRequestRecommendationItemDetail[]**](../models/access-request-recommendation-item-detail) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of access request recommendations for the identityId | AccessRequestRecommendationItemDetail[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "2c91808570313110017040b06f344ec9" # String | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") +$Limit = 56 # Int32 | Max number of results to return. (optional) (default to 15) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$IncludeTranslationMessages = $false # Boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to $false) +$Filters = 'access.name co "admin"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) +$Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) + +# Identity Access Request Recommendations + +try { + Get-BetaAccessRequestRecommendations + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestRecommendations -BetaIdentityId $IdentityId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaIncludeTranslationMessages $IncludeTranslationMessages -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendations" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-access-request-recommendations-ignored-items +This API returns the list of ignored access request recommendations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** + +### Return type +[**AccessRequestRecommendationActionItemResponseDto[]**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns list of ignored access request recommendations. | AccessRequestRecommendationActionItemResponseDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'identityId eq "2c9180846b0a0583016b299f210c1314"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) +$Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + +# List of Ignored Access Request Recommendations + +try { + Get-BetaAccessRequestRecommendationsIgnoredItems + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestRecommendationsIgnoredItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsIgnoredItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-access-request-recommendations-requested-items +This API returns a list of requested access request recommendations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** + +### Return type +[**AccessRequestRecommendationActionItemResponseDto[]**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns the list of requested access request recommendations. | AccessRequestRecommendationActionItemResponseDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'access.id eq "2c9180846b0a0583016b299f210c1314"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) +$Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + +# List of Requested Access Request Recommendations + +try { + Get-BetaAccessRequestRecommendationsRequestedItems + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestRecommendationsRequestedItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsRequestedItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-access-request-recommendations-viewed-items +This API returns the list of viewed access request recommendations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** + +### Return type +[**AccessRequestRecommendationActionItemResponseDto[]**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns list of viewed access request recommendations. | AccessRequestRecommendationActionItemResponseDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'access.id eq "2c9180846b0a0583016b299f210c1314"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) +$Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + +# List of Viewed Access Request Recommendations + +try { + Get-BetaAccessRequestRecommendationsViewedItems + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestRecommendationsViewedItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsViewedItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIAICommonAccessApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIAICommonAccessApi.md new file mode 100644 index 000000000..7de92755e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIAICommonAccessApi.md @@ -0,0 +1,173 @@ + +--- +id: beta-iai-common-access +title: IAICommonAccess +pagination_label: IAICommonAccess +sidebar_label: IAICommonAccess +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IAICommonAccess', 'BetaIAICommonAccess'] +slug: /tools/sdk/powershell/beta/methods/iai-common-access +tags: ['SDK', 'Software Development Kit', 'IAICommonAccess', 'BetaIAICommonAccess'] +--- + +# IAICommonAccess + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaCommonAccess**](#create-common-access) | **POST** `/common-access` | Create common access items +[**Get-BetaCommonAccess**](#get-common-access) | **GET** `/common-access` | Get a paginated list of common access +[**Update-BetaCommonAccessStatusInBulk**](#update-common-access-status-in-bulk) | **POST** `/common-access/update-status` | Bulk update common access status + +## create-common-access +This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CommonAccessItemRequest | [**CommonAccessItemRequest**](../models/common-access-item-request) | True | + +### Return type +[**CommonAccessItemResponse**](../models/common-access-item-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Returns details of the common access classification request. | CommonAccessItemResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CommonAccessItemRequest = @"{ + "access" : { + "ownerName" : "ownerName", + "name" : "name", + "description" : "description", + "id" : "id", + "type" : "ACCESS_PROFILE", + "ownerId" : "ownerId" + }, + "status" : "CONFIRMED" +}"@ + +# Create common access items + +try { + $Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest + New-BetaCommonAccess-BetaCommonAccessItemRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaCommonAccess -BetaCommonAccessItemRequest $CommonAccessItemRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCommonAccess" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-common-access +This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. + +### Return type +[**CommonAccessResponse[]**](../models/common-access-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of common access for a customer. | CommonAccessResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'access.type eq "ROLE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) +$Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) + +# Get a paginated list of common access + +try { + Get-BetaCommonAccess + + # Below is a request that includes all optional parameters + # Get-BetaCommonAccess -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCommonAccess" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-common-access-status-in-bulk +This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CommonAccessIDStatus | [**[]CommonAccessIDStatus**](../models/common-access-id-status) | True | Confirm or deny in bulk the common access ids that are (or aren't) common access + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell + $CommonAccessIDStatus = @"{ + "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], + "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] +}"@ # CommonAccessIDStatus[] | Confirm or deny in bulk the common access ids that are (or aren't) common access + + +# Bulk update common access status + +try { + $Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus + Update-BetaCommonAccessStatusInBulk-BetaCommonAccessIDStatus $Result + + # Below is a request that includes all optional parameters + # Update-BetaCommonAccessStatusInBulk -BetaCommonAccessIDStatus $CommonAccessIDStatus +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCommonAccessStatusInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIAIMessageCatalogsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIAIMessageCatalogsApi.md new file mode 100644 index 000000000..03d7ef80d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIAIMessageCatalogsApi.md @@ -0,0 +1,64 @@ + +--- +id: beta-iai-message-catalogs +title: IAIMessageCatalogs +pagination_label: IAIMessageCatalogs +sidebar_label: IAIMessageCatalogs +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IAIMessageCatalogs', 'BetaIAIMessageCatalogs'] +slug: /tools/sdk/powershell/beta/methods/iai-message-catalogs +tags: ['SDK', 'Software Development Kit', 'IAIMessageCatalogs', 'BetaIAIMessageCatalogs'] +--- + +# IAIMessageCatalogs + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaMessageCatalogs**](#get-message-catalogs) | **GET** `/translation-catalogs/{catalog-id}` | Get Message catalogs + +## get-message-catalogs +The getMessageCatalogs API returns message catalog based on the language headers in the requested object. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | CatalogId | **String** | True | The ID of the message catalog. + +### Return type +[**MessageCatalogDto[]**](../models/message-catalog-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The message catalogs based on the request headers | MessageCatalogDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$CatalogId = "recommender" # String | The ID of the message catalog. + +# Get Message catalogs + +try { + Get-BetaMessageCatalogs-BetaCatalogId $CatalogId + + # Below is a request that includes all optional parameters + # Get-BetaMessageCatalogs -BetaCatalogId $CatalogId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMessageCatalogs" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIAIOutliersApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIAIOutliersApi.md new file mode 100644 index 000000000..89f9ea290 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIAIOutliersApi.md @@ -0,0 +1,471 @@ + +--- +id: beta-iai-outliers +title: IAIOutliers +pagination_label: IAIOutliers +sidebar_label: IAIOutliers +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IAIOutliers', 'BetaIAIOutliers'] +slug: /tools/sdk/powershell/beta/methods/iai-outliers +tags: ['SDK', 'Software Development Kit', 'IAIOutliers', 'BetaIAIOutliers'] +--- + +# IAIOutliers + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Export-BetaOutliersZip**](#export-outliers-zip) | **GET** `/outliers/export` | IAI Identity Outliers Export +[**Get-BetaIdentityOutlierSnapshots**](#get-identity-outlier-snapshots) | **GET** `/outlier-summaries` | IAI Identity Outliers Summary +[**Get-BetaIdentityOutliers**](#get-identity-outliers) | **GET** `/outliers` | IAI Get Identity Outliers +[**Get-BetaLatestIdentityOutlierSnapshots**](#get-latest-identity-outlier-snapshots) | **GET** `/outlier-summaries/latest` | IAI Identity Outliers Latest Summary +[**Get-BetaOutlierContributingFeatureSummary**](#get-outlier-contributing-feature-summary) | **GET** `/outlier-feature-summaries/{outlierFeatureId}` | Get identity outlier contibuting feature summary +[**Get-BetaPeerGroupOutliersContributingFeatures**](#get-peer-group-outliers-contributing-features) | **GET** `/outliers/{outlierId}/contributing-features` | Get identity outlier's contibuting features +[**Invoke-BetaIgnoreIdentityOutliers**](#ignore-identity-outliers) | **POST** `/outliers/ignore` | IAI Identity Outliers Ignore +[**Get-BetaOutliersContributingFeatureAccessItems**](#list-outliers-contributing-feature-access-items) | **GET** `/outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items` | Gets a list of access items associated with each identity outlier contributing feature +[**Invoke-BetaUnIgnoreIdentityOutliers**](#un-ignore-identity-outliers) | **POST** `/outliers/unignore` | IAI Identity Outliers Unignore + +## export-outliers-zip +This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. + +Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Type | **String** | (optional) | Type of the identity outliers snapshot to filter on + +### Return type +**System.IO.FileInfo** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns zip of two CSVs to download. One CSV for ignored outliers and the other for non-ignored outliers. | System.IO.FileInfo +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example +```powershell +$Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + +# IAI Identity Outliers Export + +try { + Export-BetaOutliersZip + + # Below is a request that includes all optional parameters + # Export-BetaOutliersZip -BetaType $Type +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaOutliersZip" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-outlier-snapshots +This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Type | **String** | (optional) | Type of the identity outliers snapshot to filter on + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** + +### Return type +[**OutlierSummary[]**](../models/outlier-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers. | OutlierSummary[] +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) +$Filters = 'snapshotDate ge "2022-02-07T20:13:29.356648026Z"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* (optional) +$Sorters = "snapshotDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** (optional) + +# IAI Identity Outliers Summary + +try { + Get-BetaIdentityOutlierSnapshots + + # Below is a request that includes all optional parameters + # Get-BetaIdentityOutlierSnapshots -BetaLimit $Limit -BetaOffset $Offset -BetaType $Type -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOutlierSnapshots" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-outliers +This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Type | **String** | (optional) | Type of the identity outliers snapshot to filter on + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** + +### Return type +[**Outlier[]**](../models/outlier) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns list of objects. Each object contains information about outliers. | Outlier[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) +$Filters = 'attributes.displayName sw "John" and certStatus eq "false"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) +$Sorters = "attributes.displayName,firstDetectionDate,-score" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** (optional) + +# IAI Get Identity Outliers + +try { + Get-BetaIdentityOutliers + + # Below is a request that includes all optional parameters + # Get-BetaIdentityOutliers -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaType $Type -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOutliers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-latest-identity-outlier-snapshots +This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Type | **String** | (optional) | Type of the identity outliers snapshot to filter on + +### Return type +[**LatestOutlierSummary[]**](../models/latest-outlier-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers. | LatestOutlierSummary[] +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + +# IAI Identity Outliers Latest Summary + +try { + Get-BetaLatestIdentityOutlierSnapshots + + # Below is a request that includes all optional parameters + # Get-BetaLatestIdentityOutlierSnapshots -BetaType $Type +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLatestIdentityOutlierSnapshots" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-outlier-contributing-feature-summary +This API returns a summary of a contributing feature for an identity outlier. + +The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | OutlierFeatureId | **String** | True | Contributing feature id + +### Return type +[**OutlierFeatureSummary**](../models/outlier-feature-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns selected contributing feature summary for an outlier. | OutlierFeatureSummary +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OutlierFeatureId = "04654b66-7561-4090-94f9-abee0722a1af" # String | Contributing feature id + +# Get identity outlier contibuting feature summary + +try { + Get-BetaOutlierContributingFeatureSummary-BetaOutlierFeatureId $OutlierFeatureId + + # Below is a request that includes all optional parameters + # Get-BetaOutlierContributingFeatureSummary -BetaOutlierFeatureId $OutlierFeatureId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOutlierContributingFeatureSummary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-peer-group-outliers-contributing-features +This API returns a list of contributing feature objects for a single outlier. + +The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | OutlierId | **String** | True | The outlier id + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | IncludeTranslationMessages | **String** | (optional) | Whether or not to include translation messages object in returned response + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** + +### Return type +[**OutlierContributingFeature[]**](../models/outlier-contributing-feature) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns list of objects. Each object contains a feature and metadata about that feature. | OutlierContributingFeature[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$IncludeTranslationMessages = "include-translation-messages=" # String | Whether or not to include translation messages object in returned response (optional) +$Sorters = "importance" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** (optional) + +# Get identity outlier's contibuting features + +try { + Get-BetaPeerGroupOutliersContributingFeatures-BetaOutlierId $OutlierId + + # Below is a request that includes all optional parameters + # Get-BetaPeerGroupOutliersContributingFeatures -BetaOutlierId $OutlierId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaIncludeTranslationMessages $IncludeTranslationMessages -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPeerGroupOutliersContributingFeatures" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## ignore-identity-outliers +This API receives a list of identity IDs in the request, changes the outliers to be ignored. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | RequestBody | **[]String** | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ # String[] | + + +# IAI Identity Outliers Ignore + +try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Invoke-BetaIgnoreIdentityOutliers-BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Invoke-BetaIgnoreIdentityOutliers -BetaRequestBody $RequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaIgnoreIdentityOutliers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-outliers-contributing-feature-access-items +This API returns a list of the enriched access items associated with each feature filtered by the access item type. + +The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | OutlierId | **String** | True | The outlier id +Path | ContributingFeatureName | **String** | True | The name of contributing feature + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | AccessType | **String** | (optional) | The type of access item for the identity outlier contributing feature. If not provided, it returns all. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** + +### Return type +[**OutliersContributingFeatureAccessItems[]**](../models/outliers-contributing-feature-access-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The list of access items. | OutliersContributingFeatureAccessItems[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id +$ContributingFeatureName = "radical_entitlement_count" # String | The name of contributing feature +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$AccessType = "ENTITLEMENT" # String | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) +$Sorters = "displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) + +# Gets a list of access items associated with each identity outlier contributing feature + +try { + Get-BetaOutliersContributingFeatureAccessItems-BetaOutlierId $OutlierId -BetaContributingFeatureName $ContributingFeatureName + + # Below is a request that includes all optional parameters + # Get-BetaOutliersContributingFeatureAccessItems -BetaOutlierId $OutlierId -BetaContributingFeatureName $ContributingFeatureName -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaAccessType $AccessType -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOutliersContributingFeatureAccessItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## un-ignore-identity-outliers +This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | RequestBody | **[]String** | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ # String[] | + + +# IAI Identity Outliers Unignore + +try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Invoke-BetaUnIgnoreIdentityOutliers-BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Invoke-BetaUnIgnoreIdentityOutliers -BetaRequestBody $RequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaUnIgnoreIdentityOutliers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIAIPeerGroupStrategiesApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIAIPeerGroupStrategiesApi.md new file mode 100644 index 000000000..8c4200844 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIAIPeerGroupStrategiesApi.md @@ -0,0 +1,70 @@ + +--- +id: beta-iai-peer-group-strategies +title: IAIPeerGroupStrategies +pagination_label: IAIPeerGroupStrategies +sidebar_label: IAIPeerGroupStrategies +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IAIPeerGroupStrategies', 'BetaIAIPeerGroupStrategies'] +slug: /tools/sdk/powershell/beta/methods/iai-peer-group-strategies +tags: ['SDK', 'Software Development Kit', 'IAIPeerGroupStrategies', 'BetaIAIPeerGroupStrategies'] +--- + +# IAIPeerGroupStrategies + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaPeerGroupOutliers**](#get-peer-group-outliers) | **GET** `/peer-group-strategies/{strategy}/identity-outliers` | Identity Outliers List + +## get-peer-group-outliers +-- Deprecated : See 'IAI Outliers' This API will be used by Identity Governance systems to identify identities that are not included in an organization's peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Strategy | **String** | True | The strategy used to create peer groups. Currently, 'entitlement' is supported. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**PeerGroupMember[]**](../models/peer-group-member) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of identities that are not included in peer groups. | PeerGroupMember[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Strategy = "entitlement" # String | The strategy used to create peer groups. Currently, 'entitlement' is supported. +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Identity Outliers List + +try { + Get-BetaPeerGroupOutliers-BetaStrategy $Strategy + + # Below is a request that includes all optional parameters + # Get-BetaPeerGroupOutliers -BetaStrategy $Strategy -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPeerGroupOutliers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIAIRecommendationsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIAIRecommendationsApi.md new file mode 100644 index 000000000..24dca9ddb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIAIRecommendationsApi.md @@ -0,0 +1,171 @@ + +--- +id: beta-iai-recommendations +title: IAIRecommendations +pagination_label: IAIRecommendations +sidebar_label: IAIRecommendations +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IAIRecommendations', 'BetaIAIRecommendations'] +slug: /tools/sdk/powershell/beta/methods/iai-recommendations +tags: ['SDK', 'Software Development Kit', 'IAIRecommendations', 'BetaIAIRecommendations'] +--- + +# IAIRecommendations + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaRecommendations**](#get-recommendations) | **POST** `/recommendations/request` | Returns a Recommendation Based on Object +[**Get-BetaRecommendationsConfig**](#get-recommendations-config) | **GET** `/recommendations/config` | Get certification recommendation config values +[**Update-BetaRecommendationsConfig**](#update-recommendations-config) | **PUT** `/recommendations/config` | Update certification recommendation config values + +## get-recommendations +The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | RecommendationRequestDto | [**RecommendationRequestDto**](../models/recommendation-request-dto) | True | + +### Return type +[**RecommendationResponseDto**](../models/recommendation-response-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The recommendations for a customer | RecommendationResponseDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$RecommendationRequestDto = @"{ + "prescribeMode" : false, + "excludeInterpretations" : false, + "requests" : [ { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + }, { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + } ], + "includeTranslationMessages" : false, + "includeDebugInformation" : true +}"@ + +# Returns a Recommendation Based on Object + +try { + $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto + Get-BetaRecommendations-BetaRecommendationRequestDto $Result + + # Below is a request that includes all optional parameters + # Get-BetaRecommendations -BetaRecommendationRequestDto $RecommendationRequestDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRecommendations" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-recommendations-config +Retrieves configuration attributes used by certification recommendations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**RecommendationConfigDto**](../models/recommendation-config-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Cert recommendation configuration attributes | RecommendationConfigDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get certification recommendation config values + +try { + Get-BetaRecommendationsConfig + + # Below is a request that includes all optional parameters + # Get-BetaRecommendationsConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRecommendationsConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-recommendations-config +Updates configuration attributes used by certification recommendations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | RecommendationConfigDto | [**RecommendationConfigDto**](../models/recommendation-config-dto) | True | + +### Return type +[**RecommendationConfigDto**](../models/recommendation-config-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Cert recommendation configuration attributes after update | RecommendationConfigDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$RecommendationConfigDto = @"{ + "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], + "peerGroupPercentageThreshold" : 0.5, + "runAutoSelectOnce" : false, + "onlyTuneThreshold" : false +}"@ + +# Update certification recommendation config values + +try { + $Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto + Update-BetaRecommendationsConfig-BetaRecommendationConfigDto $Result + + # Below is a request that includes all optional parameters + # Update-BetaRecommendationsConfig -BetaRecommendationConfigDto $RecommendationConfigDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRecommendationsConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIAIRoleMiningApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIAIRoleMiningApi.md new file mode 100644 index 000000000..1b7a0addd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIAIRoleMiningApi.md @@ -0,0 +1,1310 @@ + +--- +id: beta-iai-role-mining +title: IAIRoleMining +pagination_label: IAIRoleMining +sidebar_label: IAIRoleMining +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IAIRoleMining', 'BetaIAIRoleMining'] +slug: /tools/sdk/powershell/beta/methods/iai-role-mining +tags: ['SDK', 'Software Development Kit', 'IAIRoleMining', 'BetaIAIRoleMining'] +--- + +# IAIRoleMining + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaPotentialRoleProvisionRequest**](#create-potential-role-provision-request) | **POST** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision` | Create request to provision a potential role into an actual role. +[**New-BetaRoleMiningSessions**](#create-role-mining-sessions) | **POST** `/role-mining-sessions` | Create a role mining session +[**Invoke-BetaDownloadRoleMiningPotentialRoleZip**](#download-role-mining-potential-role-zip) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download` | Export (download) details for a potential role in a role mining session +[**Export-BetaRoleMiningPotentialRole**](#export-role-mining-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export` | Export (download) details for a potential role in a role mining session +[**Export-BetaRoleMiningPotentialRoleAsync**](#export-role-mining-potential-role-async) | **POST** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async` | Asynchronously export details for a potential role in a role mining session and upload to S3 +[**Export-BetaRoleMiningPotentialRoleStatus**](#export-role-mining-potential-role-status) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}` | Retrieve status of a potential role export job +[**Get-BetaAllPotentialRoleSummaries**](#get-all-potential-role-summaries) | **GET** `/role-mining-potential-roles` | Retrieves all potential role summaries +[**Get-BetaEntitlementDistributionPotentialRole**](#get-entitlement-distribution-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution` | Retrieves entitlement popularity distribution for a potential role in a role mining session +[**Get-BetaEntitlementsPotentialRole**](#get-entitlements-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities` | Retrieves entitlements for a potential role in a role mining session +[**Get-BetaExcludedEntitlementsPotentialRole**](#get-excluded-entitlements-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements` | Retrieves excluded entitlements for a potential role in a role mining session +[**Get-BetaIdentitiesPotentialRole**](#get-identities-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities` | Retrieves identities for a potential role in a role mining session +[**Get-BetaPotentialRole**](#get-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}` | Retrieve potential role in session +[**Get-BetaPotentialRoleApplications**](#get-potential-role-applications) | **GET** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications` | Retrieves the applications of a potential role for a role mining session +[**Get-BetaPotentialRoleEntitlements**](#get-potential-role-entitlements) | **GET** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements` | Retrieves the entitlements of a potential role for a role mining session +[**Get-BetaPotentialRoleSourceIdentityUsage**](#get-potential-role-source-identity-usage) | **GET** `/role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage` | Retrieves potential role source usage +[**Get-BetaPotentialRoleSummaries**](#get-potential-role-summaries) | **GET** `/role-mining-sessions/{sessionId}/potential-role-summaries` | Retrieve session's potential role summaries +[**Get-BetaRoleMiningPotentialRole**](#get-role-mining-potential-role) | **GET** `/role-mining-potential-roles/{potentialRoleId}` | Retrieves a specific potential role +[**Get-BetaRoleMiningSession**](#get-role-mining-session) | **GET** `/role-mining-sessions/{sessionId}` | Get a role mining session +[**Get-BetaRoleMiningSessionStatus**](#get-role-mining-session-status) | **GET** `/role-mining-sessions/{sessionId}/status` | Get role mining session status state +[**Get-BetaRoleMiningSessions**](#get-role-mining-sessions) | **GET** `/role-mining-sessions` | Retrieves all role mining sessions +[**Get-BetaSavedPotentialRoles**](#get-saved-potential-roles) | **GET** `/role-mining-potential-roles/saved` | Retrieves all saved potential roles +[**Update-BetaPotentialRole**](#patch-potential-role) | **PATCH** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}` | Update a potential role in session +[**Update-BetaRoleMiningPotentialRole**](#patch-role-mining-potential-role) | **PATCH** `/role-mining-potential-roles/{potentialRoleId}` | Update a potential role +[**Update-BetaRoleMiningSession**](#patch-role-mining-session) | **PATCH** `/role-mining-sessions/{sessionId}` | Patch a role mining session +[**Update-BetaEntitlementsPotentialRole**](#update-entitlements-potential-role) | **POST** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements` | Edit entitlements for a potential role to exclude some entitlements + +## create-potential-role-provision-request +This method starts a job to provision a potential role + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session + Query | MinEntitlementPopularity | **Int32** | (optional) (default to 0) | Minimum popularity required for an entitlement to be included in the provisioned role. + Query | IncludeCommonAccess | **Boolean** | (optional) (default to $true) | Boolean determining whether common access entitlements will be included in the provisioned role. + Body | RoleMiningPotentialRoleProvisionRequest | [**RoleMiningPotentialRoleProvisionRequest**](../models/role-mining-potential-role-provision-request) | (optional) | Required information to create a new role + +### Return type +[**RoleMiningPotentialRoleSummary**](../models/role-mining-potential-role-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted. Returns a potential role summary including the status of the provison request | RoleMiningPotentialRoleSummary +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session +$MinEntitlementPopularity = 56 # Int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) +$IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to $true) +$RoleMiningPotentialRoleProvisionRequest = @"{ + "includeIdentities" : true, + "roleName" : "Finance - Accounting", + "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", + "roleDescription" : "General access for accounting department", + "directlyAssignedEntitlements" : false +}"@ + +# Create request to provision a potential role into an actual role. + +try { + New-BetaPotentialRoleProvisionRequest-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # New-BetaPotentialRoleProvisionRequest -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaMinEntitlementPopularity $MinEntitlementPopularity -BetaIncludeCommonAccess $IncludeCommonAccess -BetaRoleMiningPotentialRoleProvisionRequest $RoleMiningPotentialRoleProvisionRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPotentialRoleProvisionRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-role-mining-sessions +This submits a create role mining session request to the role mining application. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | RoleMiningSessionDto | [**RoleMiningSessionDto**](../models/role-mining-session-dto) | True | Role mining session parameters + +### Return type +[**RoleMiningSessionResponse**](../models/role-mining-session-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Submitted a role mining session request | RoleMiningSessionResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$RoleMiningSessionDto = @"{ + "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", + "prescribedPruneThreshold" : 10, + "pruneThreshold" : 50, + "saved" : true, + "potentialRolesReadyCount" : 0, + "scope" : { + "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], + "attributeFilterCriteria" : { + "displayName" : { + "untranslated" : "Location: Miami" + }, + "ariaLabel" : { + "untranslated" : "Location: Miami" + }, + "data" : { + "displayName" : { + "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" + }, + "name" : "location", + "operator" : "EQUALS", + "values" : [ "Miami" ] + } + }, + "criteria" : "source.name:DataScienceDataset" + }, + "potentialRoleCount" : 0, + "name" : "Saved RM Session - 07/10", + "minNumIdentitiesInPotentialRole" : 20, + "identityCount" : 0, + "type" : "SPECIALIZED" +}"@ + +# Create a role mining session + +try { + $Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto + New-BetaRoleMiningSessions-BetaRoleMiningSessionDto $Result + + # Below is a request that includes all optional parameters + # New-BetaRoleMiningSessions -BetaRoleMiningSessionDto $RoleMiningSessionDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRoleMiningSessions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## download-role-mining-potential-role-zip +This endpoint downloads a completed export of information for a potential role in a role mining session. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session +Path | ExportId | **String** | True | The id of a previously run export job for this potential role + +### Return type +**System.IO.FileInfo** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a zip file containing csv files for identities and entitlements for the potential role. | System.IO.FileInfo +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session +$ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role + +# Export (download) details for a potential role in a role mining session + +try { + Invoke-BetaDownloadRoleMiningPotentialRoleZip-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId + + # Below is a request that includes all optional parameters + # Invoke-BetaDownloadRoleMiningPotentialRoleZip -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaDownloadRoleMiningPotentialRoleZip" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## export-role-mining-potential-role +This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session + +### Return type +**System.IO.FileInfo** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a zip file containing csv files for identities and entitlements for the potential role. | System.IO.FileInfo +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + +# Export (download) details for a potential role in a role mining session + +try { + Export-BetaRoleMiningPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Export-BetaRoleMiningPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRole" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## export-role-mining-potential-role-async +This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session + Body | RoleMiningPotentialRoleExportRequest | [**RoleMiningPotentialRoleExportRequest**](../models/role-mining-potential-role-export-request) | (optional) | + +### Return type +[**RoleMiningPotentialRoleExportResponse**](../models/role-mining-potential-role-export-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Job Submitted. Returns a reportId that can be used to download the zip once complete | RoleMiningPotentialRoleExportResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session +$RoleMiningPotentialRoleExportRequest = @"{ + "minEntitlementPopularity" : 0, + "includeCommonAccess" : true +}"@ + +# Asynchronously export details for a potential role in a role mining session and upload to S3 + +try { + Export-BetaRoleMiningPotentialRoleAsync-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Export-BetaRoleMiningPotentialRoleAsync -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleExportRequest $RoleMiningPotentialRoleExportRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRoleAsync" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## export-role-mining-potential-role-status +This endpoint retrieves information about the current status of a potential role export. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session +Path | ExportId | **String** | True | The id of a previously run export job for this potential role + +### Return type +[**RoleMiningPotentialRoleExportResponse**](../models/role-mining-potential-role-export-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Success. Returns the current status of this export | RoleMiningPotentialRoleExportResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session +$ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role + +# Retrieve status of a potential role export job + +try { + Export-BetaRoleMiningPotentialRoleStatus-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId + + # Below is a request that includes all optional parameters + # Export-BetaRoleMiningPotentialRoleStatus -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRoleStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-all-potential-role-summaries +Returns all potential role summaries that match the query parameters + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**RoleMiningPotentialRoleSummary[]**](../models/role-mining-potential-role-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns all potential role summaries that match the query parameters. | RoleMiningPotentialRoleSummary[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) +$Filters = '(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true))' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Retrieves all potential role summaries + +try { + Get-BetaAllPotentialRoleSummaries + + # Below is a request that includes all optional parameters + # Get-BetaAllPotentialRoleSummaries -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllPotentialRoleSummaries" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-entitlement-distribution-potential-role +This method returns entitlement popularity distribution for a potential role in a role mining session. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session + Query | IncludeCommonAccess | **Boolean** | (optional) | Boolean determining whether common access entitlements will be included or not + +### Return type +**System.Collections.Hashtable** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a map containing entitlement popularity distribution for a potential role. | System.Collections.Hashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session +$IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) + +# Retrieves entitlement popularity distribution for a potential role in a role mining session + +try { + Get-BetaEntitlementDistributionPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementDistributionPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaIncludeCommonAccess $IncludeCommonAccess +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementDistributionPotentialRole" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-entitlements-potential-role +This method returns entitlements for a potential role in a role mining session. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session + Query | IncludeCommonAccess | **Boolean** | (optional) (default to $true) | Boolean determining whether common access entitlements will be included or not + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**RoleMiningEntitlement[]**](../models/role-mining-entitlement) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of entitlements for a potential role. | RoleMiningEntitlement[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session +$IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) (default to $true) +$Sorters = "popularity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) +$Filters = 'applicationName sw "AD"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Retrieves entitlements for a potential role in a role mining session + +try { + Get-BetaEntitlementsPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementsPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaIncludeCommonAccess $IncludeCommonAccess -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementsPotentialRole" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-excluded-entitlements-potential-role +This method returns excluded entitlements for a potential role in a role mining session. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**RoleMiningEntitlement[]**](../models/role-mining-entitlement) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of excluded entitlements for a potential roles. | RoleMiningEntitlement[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session +$Sorters = "populariity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** (optional) +$Filters = 'applicationName sw "AD"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Retrieves excluded entitlements for a potential role in a role mining session + +try { + Get-BetaExcludedEntitlementsPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaExcludedEntitlementsPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaExcludedEntitlementsPotentialRole" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identities-potential-role +This method returns identities for a potential role in a role mining session. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**RoleMiningIdentity[]**](../models/role-mining-identity) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of identities for a potential role. | RoleMiningIdentity[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) +$Filters = 'MyFilters' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Retrieves identities for a potential role in a role mining session + +try { + Get-BetaIdentitiesPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaIdentitiesPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitiesPotentialRole" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-potential-role +This method returns a specific potential role for a role mining session. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session + +### Return type +[**RoleMiningPotentialRole**](../models/role-mining-potential-role) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of potential roles for a role mining session. | RoleMiningPotentialRole +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + +# Retrieve potential role in session + +try { + Get-BetaPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRole" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-potential-role-applications +This method returns the applications of a potential role for a role mining session. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**RoleMiningPotentialRoleApplication[]**](../models/role-mining-potential-role-application) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of potential roles for a role mining session. | RoleMiningPotentialRoleApplication[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session +$Filters = 'applicationName sw "test"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* (optional) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Retrieves the applications of a potential role for a role mining session + +try { + Get-BetaPotentialRoleApplications-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRoleApplications -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleApplications" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-potential-role-entitlements +This method returns the entitlements of a potential role for a role mining session. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**RoleMiningPotentialRoleEntitlements[]**](../models/role-mining-potential-role-entitlements) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns the entitlements of a potential role for a role mining session. | RoleMiningPotentialRoleEntitlements[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session +$Filters = 'entitlementRef.name sw "test"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* (optional) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Retrieves the entitlements of a potential role for a role mining session + +try { + Get-BetaPotentialRoleEntitlements-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRoleEntitlements -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleEntitlements" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-potential-role-source-identity-usage +This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | PotentialRoleId | **String** | True | A potential role id +Path | SourceId | **String** | True | A source id + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**RoleMiningPotentialRoleSourceUsage[]**](../models/role-mining-potential-role-source-usage) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of source usage for the identities in a potential role. | RoleMiningPotentialRoleSourceUsage[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$PotentialRoleId = "e0cc5d7d-bf7f-4f81-b2af-8885b09d9923" # String | A potential role id +$SourceId = "2c9180877620c1460176267f336a106f" # String | A source id +$Sorters = "-usageCount" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (optional) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Retrieves potential role source usage + +try { + Get-BetaPotentialRoleSourceIdentityUsage-BetaPotentialRoleId $PotentialRoleId -BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRoleSourceIdentityUsage -BetaPotentialRoleId $PotentialRoleId -BetaSourceId $SourceId -BetaSorters $Sorters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleSourceIdentityUsage" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-potential-role-summaries +This method returns the potential role summaries for a role mining session. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**RoleMiningPotentialRoleSummary[]**](../models/role-mining-potential-role-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of potential role summaries for a role mining session. | RoleMiningPotentialRoleSummary[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** (optional) +$Filters = '(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true))' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Retrieve session's potential role summaries + +try { + Get-BetaPotentialRoleSummaries-BetaSessionId $SessionId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRoleSummaries -BetaSessionId $SessionId -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleSummaries" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-mining-potential-role +This method returns a specific potential role. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | PotentialRoleId | **String** | True | A potential role id + +### Return type +[**RoleMiningPotentialRole**](../models/role-mining-potential-role) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of potential roles for a role mining session. | RoleMiningPotentialRole +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id + +# Retrieves a specific potential role + +try { + Get-BetaRoleMiningPotentialRole-BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaRoleMiningPotentialRole -BetaPotentialRoleId $PotentialRoleId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningPotentialRole" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-mining-session +The method retrieves a role mining session. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id to be retrieved. + +### Return type +[**RoleMiningSessionResponse**](../models/role-mining-session-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns a role mining session | RoleMiningSessionResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be retrieved. + +# Get a role mining session + +try { + Get-BetaRoleMiningSession-BetaSessionId $SessionId + + # Below is a request that includes all optional parameters + # Get-BetaRoleMiningSession -BetaSessionId $SessionId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSession" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-mining-session-status +This method returns a role mining session status for a customer. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id + +### Return type +[**RoleMiningSessionStatus**](../models/role-mining-session-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns session status | RoleMiningSessionStatus +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + +# Get role mining session status state + +try { + Get-BetaRoleMiningSessionStatus-BetaSessionId $SessionId + + # Below is a request that includes all optional parameters + # Get-BetaRoleMiningSessionStatus -BetaSessionId $SessionId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSessionStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-mining-sessions +Returns all role mining sessions that match the query parameters + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**RoleMiningSessionResponse[]**](../models/role-mining-session-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns all role mining sessions that match the query parameters. | RoleMiningSessionResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Filters = 'saved eq "true" and name sw "RM Session"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* (optional) +$Sorters = "createdBy,createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** (optional) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Retrieves all role mining sessions + +try { + Get-BetaRoleMiningSessions + + # Below is a request that includes all optional parameters + # Get-BetaRoleMiningSessions -BetaFilters $Filters -BetaSorters $Sorters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSessions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-saved-potential-roles +This method returns all saved potential roles (draft roles). + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**RoleMiningSessionDraftRoleDto[]**](../models/role-mining-session-draft-role-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of draft roles for a role mining session. | RoleMiningSessionDraftRoleDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Retrieves all saved potential roles + +try { + Get-BetaSavedPotentialRoles + + # Below is a request that includes all optional parameters + # Get-BetaSavedPotentialRoles -BetaSorters $Sorters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSavedPotentialRoles" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-potential-role +This method updates an existing potential role using the role mining session id and the potential role summary id. + +The following fields can be modified: + +* `description` + +* `name` + +* `saved` + + +>**NOTE: All other fields cannot be modified.** + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | The potential role summary id + Body | PatchPotentialRoleRequestInner | [**[]PatchPotentialRoleRequestInner**](../models/patch-potential-role-request-inner) | True | + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns the potential role summary based on the potentialRoleId provided. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id + $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ # PatchPotentialRoleRequestInner[] | + + +# Update a potential role in session + +try { + $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner + Update-BetaPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $PatchPotentialRoleRequestInner +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPotentialRole" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-role-mining-potential-role +This method updates an existing potential role. + +The following fields can be modified: + +* `description` + +* `name` + +* `saved` + + +>**NOTE: All other fields cannot be modified.** + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | PotentialRoleId | **String** | True | The potential role summary id + Body | PatchPotentialRoleRequestInner | [**[]PatchPotentialRoleRequestInner**](../models/patch-potential-role-request-inner) | True | + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns the potential role summary based on the potentialRoleId provided. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id + $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ # PatchPotentialRoleRequestInner[] | + + +# Update a potential role + +try { + $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner + Update-BetaRoleMiningPotentialRole-BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaRoleMiningPotentialRole -BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $PatchPotentialRoleRequestInner +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRoleMiningPotentialRole" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-role-mining-session +The method updates an existing role mining session using PATCH. Supports op in {"replace"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id to be patched + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be patched + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. + + +# Patch a role mining session + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaRoleMiningSession-BetaSessionId $SessionId -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaRoleMiningSession -BetaSessionId $SessionId -BetaJsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRoleMiningSession" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-entitlements-potential-role +This endpoint adds or removes entitlements from an exclusion list for a potential role. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session + Body | RoleMiningPotentialRoleEditEntitlements | [**RoleMiningPotentialRoleEditEntitlements**](../models/role-mining-potential-role-edit-entitlements) | True | Role mining session parameters + +### Return type +[**RoleMiningPotentialRole**](../models/role-mining-potential-role) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Adds or removes entitlements from a potential role's entitlement exclusion list. | RoleMiningPotentialRole +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session +$RoleMiningPotentialRoleEditEntitlements = @"{ + "ids" : [ "entId1", "entId2" ], + "exclude" : true +}"@ + +# Edit entitlements for a potential role to exclude some entitlements + +try { + $Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements + Update-BetaEntitlementsPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleEditEntitlements $Result + + # Below is a request that includes all optional parameters + # Update-BetaEntitlementsPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleEditEntitlements $RoleMiningPotentialRoleEditEntitlements +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlementsPotentialRole" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIconsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIconsApi.md new file mode 100644 index 000000000..07fdb65e9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIconsApi.md @@ -0,0 +1,117 @@ + +--- +id: beta-icons +title: Icons +pagination_label: Icons +sidebar_label: Icons +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Icons', 'BetaIcons'] +slug: /tools/sdk/powershell/beta/methods/icons +tags: ['SDK', 'Software Development Kit', 'Icons', 'BetaIcons'] +--- + +# Icons + Use this API to implement functionality related to object icons (application icons for example). +With this functionality in place, administrators can set or remove an icon for specific object type for use throughout Identity Security Cloud. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Remove-BetaIcon**](#delete-icon) | **DELETE** `/icons/{objectType}/{objectId}` | Delete an icon +[**Set-BetaIcon**](#set-icon) | **PUT** `/icons/{objectType}/{objectId}` | Update an icon + +## delete-icon +This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ObjectType | **String** | True | Object type +Path | ObjectId | **String** | True | Object id. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$ObjectType = "application" # String | Object type +$ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. + +# Delete an icon + +try { + Remove-BetaIcon-BetaObjectType $ObjectType -BetaObjectId $ObjectId + + # Below is a request that includes all optional parameters + # Remove-BetaIcon -BetaObjectType $ObjectType -BetaObjectId $ObjectId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIcon" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-icon +This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ObjectType | **String** | True | Object type +Path | ObjectId | **String** | True | Object id. + | Image | **System.IO.FileInfo** | True | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] + +### Return type +[**SetIcon200Response**](../models/set-icon200-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Icon updated | SetIcon200Response +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$ObjectType = "application" # String | Object type +$ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. +$Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] + +# Update an icon + +try { + Set-BetaIcon-BetaObjectType $ObjectType -BetaObjectId $ObjectId -BetaImage $Image + + # Below is a request that includes all optional parameters + # Set-BetaIcon -BetaObjectType $ObjectType -BetaObjectId $ObjectId -BetaImage $Image +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaIcon" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIdentitiesApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIdentitiesApi.md new file mode 100644 index 000000000..ece059e32 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIdentitiesApi.md @@ -0,0 +1,566 @@ + +--- +id: beta-identities +title: Identities +pagination_label: Identities +sidebar_label: Identities +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Identities', 'BetaIdentities'] +slug: /tools/sdk/powershell/beta/methods/identities +tags: ['SDK', 'Software Development Kit', 'Identities', 'BetaIdentities'] +--- + +# Identities + Use this API to implement identity functionality. +With this functionality in place, administrators can synchronize an identity's attributes with its various source attributes. + +Identity Security Cloud uses identities as users' authoritative accounts. Identities can own other accounts, entitlements, and attributes. + +An identity has a variety of attributes, such as an account name, an email address, a job title, and more. +These identity attributes can be correlated with different attributes on different sources. +For example, the identity John.Smith can own an account in the GitHub source with the account name John-Smith-Org, and Identity Security Cloud knows they are the same person with the same access and attributes. + +In Identity Security Cloud, administrators often set up these synchronizations to get triggered automatically with a change or to run on a schedule. +To manually synchronize attributes for an identity, administrators can use the Identities drop-down menu and select Identity List to view the list of identities. +They can then select the identity they want to manually synchronize and use the hamburger menu to select 'Synchronize Attributes.' +Doing so immediately begins the attribute synchronization and analyzes all accounts for the selected identity. + +Refer to [Synchronizing Attributes](https://documentation.sailpoint.com/saas/help/provisioning/attr_sync.html) for more information about synchronizing attributes. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Remove-BetaIdentity**](#delete-identity) | **DELETE** `/identities/{id}` | Delete identity +[**Get-BetaIdentity**](#get-identity) | **GET** `/identities/{id}` | Identity Details +[**Get-BetaIdentityOwnershipDetails**](#get-identity-ownership-details) | **GET** `/identities/{identityId}/ownership` | Get ownership details +[**Get-BetaRoleAssignment**](#get-role-assignment) | **GET** `/identities/{identityId}/role-assignments/{assignmentId}` | Role assignment details +[**Get-BetaRoleAssignments**](#get-role-assignments) | **GET** `/identities/{identityId}/role-assignments` | List role assignments +[**Get-BetaIdentities**](#list-identities) | **GET** `/identities` | List Identities +[**Reset-BetaIdentity**](#reset-identity) | **POST** `/identities/{id}/reset` | Reset an identity +[**Send-BetaIdentityVerificationAccountToken**](#send-identity-verification-account-token) | **POST** `/identities/{id}/verification/account/send` | Send password reset email +[**Start-BetaIdentitiesInvite**](#start-identities-invite) | **POST** `/identities/invite` | Invite identities to register +[**Start-BetaIdentityProcessing**](#start-identity-processing) | **POST** `/identities/process` | Process a list of identityIds +[**Sync-BetahronizeAttributesForIdentity**](#synchronize-attributes-for-identity) | **POST** `/identities/{identityId}/synchronize-attributes` | Attribute synchronization for single identity. + +## delete-identity +The API returns successful response if the requested identity was deleted. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Identity Id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request is invalid. It may indicate that the specified identity is marked as protected and cannot be deleted. | IdentityAssociationDetails +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + +# Delete identity + +try { + Remove-BetaIdentity-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaIdentity -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentity" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity +This API returns a single identity using the Identity ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Identity Id + +### Return type +[**Identity**](../models/identity) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An identity object | Identity +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + +# Identity Details + +try { + Get-BetaIdentity-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentity -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentity" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-ownership-details +Use this API to return an identity's owned objects that will cause problems for deleting the identity. +Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. +For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity's owned objects. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityId | **String** | True | Identity ID. + +### Return type +[**IdentityOwnershipAssociationDetails**](../models/identity-ownership-association-details) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Identity's ownership association details. | IdentityOwnershipAssociationDetails +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "ff8081814d2a8036014d701f3fbf53fa" # String | Identity ID. + +# Get ownership details + +try { + Get-BetaIdentityOwnershipDetails-BetaIdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Get-BetaIdentityOwnershipDetails -BetaIdentityId $IdentityId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOwnershipDetails" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-assignment + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityId | **String** | True | Identity Id +Path | AssignmentId | **String** | True | Assignment Id + +### Return type +[**RoleAssignmentDto**](../models/role-assignment-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A role assignment object | RoleAssignmentDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id +$AssignmentId = "1cbb0705b38c4226b1334eadd8874086" # String | Assignment Id + +# Role assignment details + +try { + Get-BetaRoleAssignment-BetaIdentityId $IdentityId -BetaAssignmentId $AssignmentId + + # Below is a request that includes all optional parameters + # Get-BetaRoleAssignment -BetaIdentityId $IdentityId -BetaAssignmentId $AssignmentId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignment" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-assignments +This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityId | **String** | True | Identity Id to get the role assignments for + Query | RoleId | **String** | (optional) | Role Id to filter the role assignments with + Query | RoleName | **String** | (optional) | Role name to filter the role assignments with + +### Return type +[**GetRoleAssignments200ResponseInner[]**](../models/get-role-assignments200-response-inner) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A role assignment object | GetRoleAssignments200ResponseInner[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id to get the role assignments for +$RoleId = "e7697a1e96d04db1ac7b0f4544915d2c" # String | Role Id to filter the role assignments with (optional) +$RoleName = "Engineer" # String | Role name to filter the role assignments with (optional) + +# List role assignments + +try { + Get-BetaRoleAssignments-BetaIdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Get-BetaRoleAssignments -BetaIdentityId $IdentityId -BetaRoleId $RoleId -BetaRoleName $RoleName +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignments" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-identities +This API returns a list of identities. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** + Query | DefaultFilter | **String** | (optional) (default to "CORRELATED_ONLY") | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**Identity[]**](../models/identity) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of identities. | Identity[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Filters = 'id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) +$Sorters = "name,-cloudStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) +$DefaultFilter = "CORRELATED_ONLY" # String | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to "CORRELATED_ONLY") +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + +# List Identities + +try { + Get-BetaIdentities + + # Below is a request that includes all optional parameters + # Get-BetaIdentities -BetaFilters $Filters -BetaSorters $Sorters -BetaDefaultFilter $DefaultFilter -BetaCount $Count -BetaLimit $Limit -BetaOffset $Offset +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentities" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## reset-identity +Use this endpoint to reset a user's identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityId | **String** | True | Identity Id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted. The reset request accepted and is in progress. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + +# Reset an identity + +try { + Reset-BetaIdentity-BetaIdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Reset-BetaIdentity -BetaIdentityId $IdentityId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-BetaIdentity" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## send-identity-verification-account-token +This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Identity ID + Body | SendAccountVerificationRequest | [**SendAccountVerificationRequest**](../models/send-account-verification-request) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The email was successfully sent | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID +$SendAccountVerificationRequest = @"{ + "sourceName" : "Active Directory Source", + "via" : "EMAIL_WORK" +}"@ + +# Send password reset email + +try { + $Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest + Send-BetaIdentityVerificationAccountToken-BetaId $Id -BetaSendAccountVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaIdentityVerificationAccountToken -BetaId $Id -BetaSendAccountVerificationRequest $SendAccountVerificationRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaIdentityVerificationAccountToken" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-identities-invite +This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. + +This task will send an invitation email only for unregistered identities. + +The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | InviteIdentitiesRequest | [**InviteIdentitiesRequest**](../models/invite-identities-request) | True | + +### Return type +[**TaskStatus**](../models/task-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Responds with an initial TaskStatus for the executed task | TaskStatus +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$InviteIdentitiesRequest = @"{ + "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], + "uninvited" : false +}"@ + +# Invite identities to register + +try { + $Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest + Start-BetaIdentitiesInvite-BetaInviteIdentitiesRequest $Result + + # Below is a request that includes all optional parameters + # Start-BetaIdentitiesInvite -BetaInviteIdentitiesRequest $InviteIdentitiesRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaIdentitiesInvite" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-identity-processing +This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. + +This endpoint will perform the following tasks: +1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it's expected to change). +2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. +3. Enforce provisioning for any assigned accesses that haven't been fulfilled (e.g. failure due to source health). +4. Recalculate manager relationships. +5. Potentially clean-up identity processing errors, assuming the error has been resolved. + +A token with ORG_ADMIN or HELPDESK authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | ProcessIdentitiesRequest | [**ProcessIdentitiesRequest**](../models/process-identities-request) | True | + +### Return type +[**TaskResultResponse**](../models/task-result-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Object containing the DTO type TASK_RESULT and the job id for the task | TaskResultResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$ProcessIdentitiesRequest = @"{ + "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] +}"@ + +# Process a list of identityIds + +try { + $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest + Start-BetaIdentityProcessing-BetaProcessIdentitiesRequest $Result + + # Below is a request that includes all optional parameters + # Start-BetaIdentityProcessing -BetaProcessIdentitiesRequest $ProcessIdentitiesRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaIdentityProcessing" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## synchronize-attributes-for-identity +This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. A token with ORG_ADMIN or API authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityId | **String** | True | The Identity id + +### Return type +[**IdentitySyncJob**](../models/identity-sync-job) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | An Identity Sync job | IdentitySyncJob +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "MyIdentityId" # String | The Identity id + +# Attribute synchronization for single identity. + +try { + Sync-BetahronizeAttributesForIdentity-BetaIdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Sync-BetahronizeAttributesForIdentity -BetaIdentityId $IdentityId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetahronizeAttributesForIdentity" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIdentityAttributesApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIdentityAttributesApi.md new file mode 100644 index 000000000..63e3c2390 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIdentityAttributesApi.md @@ -0,0 +1,339 @@ + +--- +id: beta-identity-attributes +title: IdentityAttributes +pagination_label: IdentityAttributes +sidebar_label: IdentityAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributes', 'BetaIdentityAttributes'] +slug: /tools/sdk/powershell/beta/methods/identity-attributes +tags: ['SDK', 'Software Development Kit', 'IdentityAttributes', 'BetaIdentityAttributes'] +--- + +# IdentityAttributes + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaIdentityAttribute**](#create-identity-attribute) | **POST** `/identity-attributes` | Create Identity Attribute +[**Remove-BetaIdentityAttribute**](#delete-identity-attribute) | **DELETE** `/identity-attributes/{name}` | Delete Identity Attribute +[**Remove-BetaIdentityAttributesInBulk**](#delete-identity-attributes-in-bulk) | **DELETE** `/identity-attributes/bulk-delete` | Bulk delete Identity Attributes +[**Get-BetaIdentityAttribute**](#get-identity-attribute) | **GET** `/identity-attributes/{name}` | Get Identity Attribute +[**Get-BetaIdentityAttributes**](#list-identity-attributes) | **GET** `/identity-attributes` | List Identity Attributes +[**Send-BetaIdentityAttribute**](#put-identity-attribute) | **PUT** `/identity-attributes/{name}` | Update Identity Attribute + +## create-identity-attribute +Use this API to create a new identity attribute. A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | IdentityAttribute | [**IdentityAttribute**](../models/identity-attribute) | True | + +### Return type +[**IdentityAttribute**](../models/identity-attribute) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | The identity attribute was created successfully. | IdentityAttribute +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$IdentityAttribute = @"{ + "standard" : false, + "system" : false, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false +}"@ + +# Create Identity Attribute + +try { + $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute + New-BetaIdentityAttribute-BetaIdentityAttribute $Result + + # Below is a request that includes all optional parameters + # New-BetaIdentityAttribute -BetaIdentityAttribute $IdentityAttribute +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityAttribute" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-identity-attribute +This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Name | **String** | True | The attribute's technical name. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Name = "displayName" # String | The attribute's technical name. + +# Delete Identity Attribute + +try { + Remove-BetaIdentityAttribute-BetaName $Name + + # Below is a request that includes all optional parameters + # Remove-BetaIdentityAttribute -BetaName $Name +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttribute" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-identity-attributes-in-bulk +Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to 'false' before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | IdentityAttributeNames | [**IdentityAttributeNames**](../models/identity-attribute-names) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$IdentityAttributeNames = @"{ + "ids" : [ "name", "displayName" ] +}"@ + +# Bulk delete Identity Attributes + +try { + $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames + Remove-BetaIdentityAttributesInBulk-BetaIdentityAttributeNames $Result + + # Below is a request that includes all optional parameters + # Remove-BetaIdentityAttributesInBulk -BetaIdentityAttributeNames $IdentityAttributeNames +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttributesInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-attribute +This gets an identity attribute for a given technical name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Name | **String** | True | The attribute's technical name. + +### Return type +[**IdentityAttribute**](../models/identity-attribute) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The identity attribute with the given name | IdentityAttribute +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Name = "displayName" # String | The attribute's technical name. + +# Get Identity Attribute + +try { + Get-BetaIdentityAttribute-BetaName $Name + + # Below is a request that includes all optional parameters + # Get-BetaIdentityAttribute -BetaName $Name +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAttribute" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-identity-attributes +Use this API to get a collection of identity attributes. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | IncludeSystem | **Boolean** | (optional) (default to $false) | Include 'system' attributes in the response. + Query | IncludeSilent | **Boolean** | (optional) (default to $false) | Include 'silent' attributes in the response. + Query | SearchableOnly | **Boolean** | (optional) (default to $false) | Include only 'searchable' attributes in the response. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**IdentityAttribute[]**](../models/identity-attribute) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of identity attributes. | IdentityAttribute[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IncludeSystem = $false # Boolean | Include 'system' attributes in the response. (optional) (default to $false) +$IncludeSilent = $false # Boolean | Include 'silent' attributes in the response. (optional) (default to $false) +$SearchableOnly = $false # Boolean | Include only 'searchable' attributes in the response. (optional) (default to $false) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# List Identity Attributes + +try { + Get-BetaIdentityAttributes + + # Below is a request that includes all optional parameters + # Get-BetaIdentityAttributes -BetaIncludeSystem $IncludeSystem -BetaIncludeSilent $IncludeSilent -BetaSearchableOnly $SearchableOnly -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAttributes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-identity-attribute +This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Name | **String** | True | The attribute's technical name. + Body | IdentityAttribute | [**IdentityAttribute**](../models/identity-attribute) | True | + +### Return type +[**IdentityAttribute**](../models/identity-attribute) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The identity attribute was updated successfully | IdentityAttribute +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Name = "displayName" # String | The attribute's technical name. +$IdentityAttribute = @"{ + "standard" : false, + "system" : false, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false +}"@ + +# Update Identity Attribute + +try { + $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute + Send-BetaIdentityAttribute-BetaName $Name -BetaIdentityAttribute $Result + + # Below is a request that includes all optional parameters + # Send-BetaIdentityAttribute -BetaName $Name -BetaIdentityAttribute $IdentityAttribute +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaIdentityAttribute" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIdentityHistoryApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIdentityHistoryApi.md new file mode 100644 index 000000000..fea64b250 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIdentityHistoryApi.md @@ -0,0 +1,591 @@ + +--- +id: beta-identity-history +title: IdentityHistory +pagination_label: IdentityHistory +sidebar_label: IdentityHistory +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityHistory', 'BetaIdentityHistory'] +slug: /tools/sdk/powershell/beta/methods/identity-history +tags: ['SDK', 'Software Development Kit', 'IdentityHistory', 'BetaIdentityHistory'] +--- + +# IdentityHistory + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Compare-BetaIdentitySnapshots**](#compare-identity-snapshots) | **GET** `/historical-identities/{id}/compare` | Gets a difference of count for each access item types for the given identity between 2 snapshots +[**Compare-BetaIdentitySnapshotsAccessType**](#compare-identity-snapshots-access-type) | **GET** `/historical-identities/{id}/compare/{access-type}` | Gets a list of differences of specific accessType for the given identity between 2 snapshots +[**Get-BetaHistoricalIdentity**](#get-historical-identity) | **GET** `/historical-identities/{id}` | Get latest snapshot of identity +[**Get-BetaHistoricalIdentityEvents**](#get-historical-identity-events) | **GET** `/historical-identities/{id}/events` | Lists all events for the given identity +[**Get-BetaIdentitySnapshot**](#get-identity-snapshot) | **GET** `/historical-identities/{id}/snapshots/{date}` | Gets an identity snapshot at a given date +[**Get-BetaIdentitySnapshotSummary**](#get-identity-snapshot-summary) | **GET** `/historical-identities/{id}/snapshot-summary` | Gets the summary for the event count for a specific identity +[**Get-BetaIdentityStartDate**](#get-identity-start-date) | **GET** `/historical-identities/{id}/start-date` | Gets the start date of the identity +[**Get-BetaHistoricalIdentities**](#list-historical-identities) | **GET** `/historical-identities` | Lists all the identities +[**Get-BetaIdentityAccessItems**](#list-identity-access-items) | **GET** `/historical-identities/{id}/access-items` | List Access Items by Identity +[**Get-BetaIdentitySnapshotAccessItems**](#list-identity-snapshot-access-items) | **GET** `/historical-identities/{id}/snapshots/{date}/access-items` | Get Identity Access Items Snapshot +[**Get-BetaIdentitySnapshots**](#list-identity-snapshots) | **GET** `/historical-identities/{id}/snapshots` | Lists all the snapshots for the identity + +## compare-identity-snapshots +This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity id + Query | Snapshot1 | **String** | (optional) | The snapshot 1 of identity + Query | Snapshot2 | **String** | (optional) | The snapshot 2 of identity + Query | AccessItemTypes | **[]String** | (optional) | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**IdentityCompareResponse[]**](../models/identity-compare-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A IdentityCompare object with difference details for each access item type | IdentityCompareResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id +$Snapshot1 = "2007-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) +$Snapshot2 = "2008-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) +$AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) + + +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Gets a difference of count for each access item types for the given identity between 2 snapshots + +try { + Compare-BetaIdentitySnapshots-BetaId $Id + + # Below is a request that includes all optional parameters + # Compare-BetaIdentitySnapshots -BetaId $Id -BetaSnapshot1 $Snapshot1 -BetaSnapshot2 $Snapshot2 -BetaAccessItemTypes $AccessItemTypes -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-BetaIdentitySnapshots" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## compare-identity-snapshots-access-type +This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity id +Path | AccessType | **String** | True | The specific type which needs to be compared + Query | AccessAssociated | **Boolean** | (optional) | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed + Query | Snapshot1 | **String** | (optional) | The snapshot 1 of identity + Query | Snapshot2 | **String** | (optional) | The snapshot 2 of identity + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**AccessItemDiff[]**](../models/access-item-diff) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of events for the identity | AccessItemDiff[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id +$AccessType = "accessProfile" # String | The specific type which needs to be compared +$AccessAssociated = $false # Boolean | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) +$Snapshot1 = "2008-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) +$Snapshot2 = "2009-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Gets a list of differences of specific accessType for the given identity between 2 snapshots + +try { + Compare-BetaIdentitySnapshotsAccessType-BetaId $Id -BetaAccessType $AccessType + + # Below is a request that includes all optional parameters + # Compare-BetaIdentitySnapshotsAccessType -BetaId $Id -BetaAccessType $AccessType -BetaAccessAssociated $AccessAssociated -BetaSnapshot1 $Snapshot1 -BetaSnapshot2 $Snapshot2 -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-BetaIdentitySnapshotsAccessType" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-historical-identity +This method retrieves a specified identity Requires authorization scope of 'idn:identity-history:read' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity id + +### Return type +[**IdentityHistoryResponse**](../models/identity-history-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The identity object. | IdentityHistoryResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + +# Get latest snapshot of identity + +try { + Get-BetaHistoricalIdentity-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaHistoricalIdentity -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentity" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-historical-identity-events +This method retrieves all access events for the identity Requires authorization scope of 'idn:identity-history:read' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity id + Query | From | **String** | (optional) | The optional instant until which access events are returned + Query | EventTypes | **[]String** | (optional) | An optional list of event types to return. If null or empty, all events are returned + Query | AccessItemTypes | **[]String** | (optional) | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**GetHistoricalIdentityEvents200ResponseInner[]**](../models/get-historical-identity-events200-response-inner) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The list of events for the identity | GetHistoricalIdentityEvents200ResponseInner[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id +$From = "2024-03-01T13:00:00Z" # String | The optional instant until which access events are returned (optional) +$EventTypes = "MyEventTypes" # String[] | An optional list of event types to return. If null or empty, all events are returned (optional) + +$EventTypes = @"[AccessAddedEvent, AccessRemovedEvent]"@ # String[] | An optional list of event types to return. If null or empty, all events are returned (optional) +$AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) + +$AccessItemTypes = @"[entitlement, account]"@ # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Lists all events for the given identity + +try { + Get-BetaHistoricalIdentityEvents-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaHistoricalIdentityEvents -BetaId $Id -BetaFrom $From -BetaEventTypes $EventTypes -BetaAccessItemTypes $AccessItemTypes -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentityEvents" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-snapshot +This method retrieves a specified identity snapshot at a given date Requires authorization scope of 'idn:identity-history:read' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity id +Path | Date | **String** | True | The specified date + +### Return type +[**IdentityHistoryResponse**](../models/identity-history-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The identity object. | IdentityHistoryResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id +$Date = "2007-03-01T13:00:00Z" # String | The specified date + +# Gets an identity snapshot at a given date + +try { + Get-BetaIdentitySnapshot-BetaId $Id -BetaDate $Date + + # Below is a request that includes all optional parameters + # Get-BetaIdentitySnapshot -BetaId $Id -BetaDate $Date +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshot" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-snapshot-summary +This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of 'idn:identity-history:read' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity id + Query | Before | **String** | (optional) | The date before which snapshot summary is required + Query | Interval | **String** | (optional) | The interval indicating day or month. Defaults to month if not specified + Query | TimeZone | **String** | (optional) | The time zone. Defaults to UTC if not provided + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**MetricResponse[]**](../models/metric-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A summary list of identity changes in date histogram format. | MetricResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id +$Before = "2007-03-01T13:00:00Z" # String | The date before which snapshot summary is required (optional) +$Interval = "day" # String | The interval indicating day or month. Defaults to month if not specified (optional) +$TimeZone = "UTC" # String | The time zone. Defaults to UTC if not provided (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Gets the summary for the event count for a specific identity + +try { + Get-BetaIdentitySnapshotSummary-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentitySnapshotSummary -BetaId $Id -BetaBefore $Before -BetaInterval $Interval -BetaTimeZone $TimeZone -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshotSummary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-start-date +This method retrieves start date of the identity Requires authorization scope of 'idn:identity-history:read' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity id + +### Return type +**String** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The start date of the identity | String +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + +# Gets the start date of the identity + +try { + Get-BetaIdentityStartDate-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentityStartDate -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityStartDate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-historical-identities +This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of 'idn:identity-history:read' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | StartsWithQuery | **String** | (optional) | This param is used for starts-with search for first, last and display name of the identity + Query | IsDeleted | **Boolean** | (optional) | Indicates if we want to only list down deleted identities or not. + Query | IsActive | **Boolean** | (optional) | Indicates if we want to only list active or inactive identities. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**IdentityListItem[]**](../models/identity-list-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of identities for the customer. | IdentityListItem[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$StartsWithQuery = "Ada" # String | This param is used for starts-with search for first, last and display name of the identity (optional) +$IsDeleted = $true # Boolean | Indicates if we want to only list down deleted identities or not. (optional) +$IsActive = $true # Boolean | Indicates if we want to only list active or inactive identities. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + +# Lists all the identities + +try { + Get-BetaHistoricalIdentities + + # Below is a request that includes all optional parameters + # Get-BetaHistoricalIdentities -BetaStartsWithQuery $StartsWithQuery -BetaIsDeleted $IsDeleted -BetaIsActive $IsActive -BetaLimit $Limit -BetaOffset $Offset +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentities" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-identity-access-items +This method retrieves a list of access item for the identity filtered by the access item type + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity id + Query | Type | **String** | (optional) | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** + Query | Query | **String** | (optional) | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**ListIdentityAccessItems200ResponseInner[]**](../models/list-identity-access-items200-response-inner) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The list of access items. | ListIdentityAccessItems200ResponseInner[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id +$Type = "account" # String | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) +$Filters = 'source eq "DataScienceDataset"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq* (optional) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** (optional) +$Query = "Dr. Arden" # String | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + +# List Access Items by Identity + +try { + Get-BetaIdentityAccessItems-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentityAccessItems -BetaId $Id -BetaType $Type -BetaFilters $Filters -BetaSorters $Sorters -BetaQuery $Query -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAccessItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-identity-snapshot-access-items +Use this API to get a list of identity access items at a specified date, filtered by item type. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Identity ID. +Path | Date | **String** | True | Specified date. + Query | Type | **String** | (optional) | Access item type. + +### Return type +[**ListIdentityAccessItems200ResponseInner[]**](../models/list-identity-access-items200-response-inner) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Identity object. | ListIdentityAccessItems200ResponseInner[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Identity ID. +$Date = "2007-03-01T13:00:00Z" # String | Specified date. +$Type = "role" # String | Access item type. (optional) + +# Get Identity Access Items Snapshot + +try { + Get-BetaIdentitySnapshotAccessItems-BetaId $Id -BetaDate $Date + + # Below is a request that includes all optional parameters + # Get-BetaIdentitySnapshotAccessItems -BetaId $Id -BetaDate $Date -BetaType $Type +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshotAccessItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-identity-snapshots +This method retrieves all the snapshots for the identity Requires authorization scope of 'idn:identity-history:read' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity id + Query | Start | **String** | (optional) | The specified start date + Query | Interval | **String** | (optional) | The interval indicating the range in day or month for the specified interval-name + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**IdentitySnapshotSummaryResponse[]**](../models/identity-snapshot-summary-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of identity summary for each snapshot. | IdentitySnapshotSummaryResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id +$Start = "2007-03-01T13:00:00Z" # String | The specified start date (optional) +$Interval = "day" # String | The interval indicating the range in day or month for the specified interval-name (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Lists all the snapshots for the identity + +try { + Get-BetaIdentitySnapshots-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentitySnapshots -BetaId $Id -BetaStart $Start -BetaInterval $Interval -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshots" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIdentityProfilesApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIdentityProfilesApi.md new file mode 100644 index 000000000..51d8fc009 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaIdentityProfilesApi.md @@ -0,0 +1,713 @@ + +--- +id: beta-identity-profiles +title: IdentityProfiles +pagination_label: IdentityProfiles +sidebar_label: IdentityProfiles +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfiles', 'BetaIdentityProfiles'] +slug: /tools/sdk/powershell/beta/methods/identity-profiles +tags: ['SDK', 'Software Development Kit', 'IdentityProfiles', 'BetaIdentityProfiles'] +--- + +# IdentityProfiles + Use this API to implement and customize identity profile functionality. +With this functionality in place, administrators can manage identity profiles and configure them for use by identities throughout Identity Security Cloud. + +Identity profiles represent the configurations that can be applied to identities as a way of granting them a set of security and access, as well as defining the mappings between their identity attributes and their source attributes. +This allows administrators to save time by applying identity profiles to any number of similar identities rather than configuring each one individually. + +In Identity Security Cloud, administrators can use the Identities drop-down menu and select Identity Profiles to view the list of identity profiles. +This list shows some details about each identity profile, along with its status. They can select an identity profile to view and modify its settings, its mappings between identity attributes and correlating source account attributes, and its provisioning settings. +Administrators can also use this page to create new identity profiles or delete existing ones. + +Refer to [Creating Identity Profiles](https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html) for more information about identity profiles. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaIdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create an Identity Profile +[**Remove-BetaIdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete an Identity Profile +[**Remove-BetaIdentityProfiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete Identity Profiles +[**Export-BetaIdentityProfiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export Identity Profiles +[**Get-BetaDefaultIdentityAttributeConfig**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Default identity attribute config +[**Get-BetaIdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Gets a single Identity Profile +[**Import-BetaIdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles +[**Get-BetaIdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | Identity Profiles List +[**Show-BetaGenerateIdentityPreview**](#show-generate-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview +[**Sync-BetaIdentityProfile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile +[**Update-BetaIdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update the Identity Profile + +## create-identity-profile +This creates an Identity Profile. + +A token with ORG_ADMIN authority is required to call this API to create an Identity Profile. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | IdentityProfile | [**IdentityProfile**](../models/identity-profile) | True | + +### Return type +[**IdentityProfile**](../models/identity-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | The created Identity Profile | IdentityProfile +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$IdentityProfile = @"{ + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2023-01-03T21:16:22.432Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "id" : "id12345" +}"@ + +# Create an Identity Profile + +try { + $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile + New-BetaIdentityProfile-BetaIdentityProfile $Result + + # Below is a request that includes all optional parameters + # New-BetaIdentityProfile -BetaIdentityProfile $IdentityProfile +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-identity-profile +This deletes an Identity Profile based on ID. + +On success, this endpoint will return a reference to the bulk delete task result. + +A token with ORG_ADMIN authority is required to call this API. + +The following rights are required to access this endpoint: idn:identity-profile:delete + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | The Identity Profile ID. + +### Return type +[**TaskResultSimplified**](../models/task-result-simplified) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returns a TaskResult object referencing the bulk delete job created. | TaskResultSimplified +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. + +# Delete an Identity Profile + +try { + Remove-BetaIdentityProfile-BetaIdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Remove-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-identity-profiles +This deletes multiple Identity Profiles via a list of supplied IDs. + +On success, this endpoint will return a reference to the bulk delete task result. + +A token with ORG_ADMIN authority is required to call this API. + +The following rights are required to access this endpoint: idn:identity-profile:delete + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | RequestBody | **[]String** | True | Identity Profile bulk delete request body. + +### Return type +[**TaskResultSimplified**](../models/task-result-simplified) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returns a TaskResult object referencing the bulk delete job created. | TaskResultSimplified +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body. + $RequestBody = @""@ # String[] | Identity Profile bulk delete request body. + + +# Delete Identity Profiles + +try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-BetaIdentityProfiles-BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-BetaIdentityProfiles -BetaRequestBody $RequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityProfiles" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## export-identity-profiles +This exports existing identity profiles in the format specified by the sp-config service. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** + +### Return type +[**IdentityProfileExportedObject[]**](../models/identity-profile-exported-object) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of export objects with identity profiles. | IdentityProfileExportedObject[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq 8c190e6787aa4ed9a90bd9d5344523fb' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) +$Sorters = "name,-priority" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) + +# Export Identity Profiles + +try { + Export-BetaIdentityProfiles + + # Below is a request that includes all optional parameters + # Export-BetaIdentityProfiles -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaIdentityProfiles" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-default-identity-attribute-config +This returns the default identity attribute config +A token with ORG_ADMIN authority is required to call this API to get the default identity attribute config. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | The Identity Profile ID + +### Return type +[**IdentityAttributeConfig**](../models/identity-attribute-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An Identity Attribute Config object | IdentityAttributeConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + +# Default identity attribute config + +try { + Get-BetaDefaultIdentityAttributeConfig-BetaIdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-BetaDefaultIdentityAttributeConfig -BetaIdentityProfileId $IdentityProfileId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultIdentityAttributeConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-profile +This returns a single Identity Profile based on ID. + +A token with ORG_ADMIN or API authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | The Identity Profile ID + +### Return type +[**IdentityProfile**](../models/identity-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An Identity Profile object | IdentityProfile +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + +# Gets a single Identity Profile + +try { + Get-BetaIdentityProfile-BetaIdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-identity-profiles +This imports previously exported identity profiles. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | IdentityProfileExportedObject | [**[]IdentityProfileExportedObject**](../models/identity-profile-exported-object) | True | Previously exported Identity Profiles. + +### Return type +[**ObjectImportResult**](../models/object-import-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The result of importing Identity Profiles. | ObjectImportResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell + + + + + + $IdentityProfileExportedObject = @"{ + "self" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "version" : 1, + "object" : { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + } +}"@ # IdentityProfileExportedObject[] | Previously exported Identity Profiles. + + +# Import Identity Profiles + +try { + $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject + Import-BetaIdentityProfiles-BetaIdentityProfileExportedObject $Result + + # Below is a request that includes all optional parameters + # Import-BetaIdentityProfiles -BetaIdentityProfileExportedObject $IdentityProfileExportedObject +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaIdentityProfiles" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-identity-profiles +This returns a list of Identity Profiles based on the specified query parameters. +A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, in, le, lt, isnull, sw* **priority**: *eq, ne* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** + +### Return type +[**IdentityProfile[]**](../models/identity-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of identityProfiles. | IdentityProfile[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq 8c190e6787aa4ed9a90bd9d5344523fb' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional) +$Sorters = "name,-priority" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) + +# Identity Profiles List + +try { + Get-BetaIdentityProfiles + + # Below is a request that includes all optional parameters + # Get-BetaIdentityProfiles -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityProfiles" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## show-generate-identity-preview +Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body. +This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body. +A token with ORG_ADMIN authority is required to call this API to generate an identity preview. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | IdentityPreviewRequest | [**IdentityPreviewRequest**](../models/identity-preview-request) | True | Identity Preview request body. + +### Return type +[**IdentityPreviewResponse**](../models/identity-preview-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A preview of the identity attributes after applying identity attributes config sent in request body. | IdentityPreviewResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$IdentityPreviewRequest = @"{ + "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + } +}"@ + +# Generate Identity Profile Preview + +try { + $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest + Show-BetaGenerateIdentityPreview-BetaIdentityPreviewRequest $Result + + # Below is a request that includes all optional parameters + # Show-BetaGenerateIdentityPreview -BetaIdentityPreviewRequest $IdentityPreviewRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-BetaGenerateIdentityPreview" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## sync-identity-profile +Process identities under the profile +This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. +This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. +This operation will perform the following activities on all identities under the identity profile. +1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity's correct manager through manager correlation. 3. Updates the identity's access according to their assigned lifecycle state. 4. Updates the identity's access based on role assignment criteria. +A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | The Identity Profile ID to be processed + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed + +# Process identities under profile + +try { + Sync-BetaIdentityProfile-BetaIdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Sync-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetaIdentityProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-identity-profile +This updates the specified Identity Profile. + +A token with ORG_ADMIN authority is required to call this API to update the Identity Profile. + +Some fields of the Schema cannot be updated. These fields are listed below: +* id +* name +* created +* modified +* identityCount +* identityRefreshRequired +* Authoritative Source and Identity Attribute Configuration cannot be modified at once. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | The Identity Profile ID + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**IdentityProfile**](../models/identity-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The updated Identity Profile. | IdentityProfile +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +# Update the Identity Profile + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaIdentityProfile-BetaIdentityProfileId $IdentityProfileId -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId -BetaJsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaIdentityProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaLaunchersApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaLaunchersApi.md new file mode 100644 index 000000000..c073b10e2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaLaunchersApi.md @@ -0,0 +1,316 @@ + +--- +id: beta-launchers +title: Launchers +pagination_label: Launchers +sidebar_label: Launchers +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Launchers', 'BetaLaunchers'] +slug: /tools/sdk/powershell/beta/methods/launchers +tags: ['SDK', 'Software Development Kit', 'Launchers', 'BetaLaunchers'] +--- + +# Launchers + Use this API to manage Launchers. + +Launchers are objects that allow users to launch various tasks from ISC such as Privileged Workflows. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaLauncher**](#create-launcher) | **POST** `/launchers` | Create launcher +[**Remove-BetaLauncher**](#delete-launcher) | **DELETE** `/launchers/{launcherID}` | Delete Launcher +[**Get-BetaLauncher**](#get-launcher) | **GET** `/launchers/{launcherID}` | Get Launcher by ID +[**Get-BetaLaunchers**](#get-launchers) | **GET** `/launchers` | List all Launchers for tenant +[**Send-BetaLauncher**](#put-launcher) | **PUT** `/launchers/{launcherID}` | Replace Launcher +[**Start-BetaLauncher**](#start-launcher) | **POST** `/beta/launchers/{launcherID}/launch` | Launch a Launcher + +## create-launcher +Create a Launcher with given information + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | LauncherRequest | [**LauncherRequest**](../models/launcher-request) | True | Payload to create a Launcher + +### Return type +[**Launcher**](../models/launcher) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Launcher created successfully | Launcher +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$LauncherRequest = @"{ + "reference" : { + "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", + "type" : "WORKFLOW" + }, + "name" : "Group Create", + "description" : "Create a new Active Directory Group", + "disabled" : false, + "type" : "INTERACTIVE_PROCESS", + "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" +}"@ + +# Create launcher + +try { + $Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest + New-BetaLauncher-BetaLauncherRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaLauncher -BetaLauncherRequest $LauncherRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaLauncher" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-launcher +Delete the given Launcher ID + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | LauncherID | **String** | True | ID of the Launcher to be deleted + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | Launcher deleted successfully | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be deleted + +# Delete Launcher + +try { + Remove-BetaLauncher-BetaLauncherID $LauncherID + + # Below is a request that includes all optional parameters + # Remove-BetaLauncher -BetaLauncherID $LauncherID +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaLauncher" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-launcher +Get details for the given Launcher ID + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | LauncherID | **String** | True | ID of the Launcher to be retrieved + +### Return type +[**Launcher**](../models/launcher) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Launcher retrieved successfully | Launcher +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be retrieved + +# Get Launcher by ID + +try { + Get-BetaLauncher-BetaLauncherID $LauncherID + + # Below is a request that includes all optional parameters + # Get-BetaLauncher -BetaLauncherID $LauncherID +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLauncher" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-launchers +Return a list of Launchers for the authenticated tenant + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **description**: *sw* **disabled**: *eq* **name**: *sw* + Query | Next | **String** | (optional) | Pagination marker + Query | Limit | **Int32** | (optional) (default to 10) | Number of Launchers to return + +### Return type +[**GetLaunchers200Response**](../models/get-launchers200-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Launchers | GetLaunchers200Response +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Filters = 'disabled eq "true"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional) +$Next = "eyJuZXh0IjoxMjN9Cg==" # String | Pagination marker (optional) +$Limit = 42 # Int32 | Number of Launchers to return (optional) (default to 10) + +# List all Launchers for tenant + +try { + Get-BetaLaunchers + + # Below is a request that includes all optional parameters + # Get-BetaLaunchers -BetaFilters $Filters -BetaNext $Next -BetaLimit $Limit +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLaunchers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-launcher +Replace the given Launcher ID with given payload + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | LauncherID | **String** | True | ID of the Launcher to be replaced + Body | LauncherRequest | [**LauncherRequest**](../models/launcher-request) | True | Payload to replace Launcher + +### Return type +[**Launcher**](../models/launcher) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Launcher replaced successfully | Launcher +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be replaced +$LauncherRequest = @"{ + "reference" : { + "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", + "type" : "WORKFLOW" + }, + "name" : "Group Create", + "description" : "Create a new Active Directory Group", + "disabled" : false, + "type" : "INTERACTIVE_PROCESS", + "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" +}"@ + +# Replace Launcher + +try { + $Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest + Send-BetaLauncher-BetaLauncherID $LauncherID -BetaLauncherRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaLauncher -BetaLauncherID $LauncherID -BetaLauncherRequest $LauncherRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaLauncher" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-launcher +Launch the given Launcher ID + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | LauncherID | **String** | True | ID of the Launcher to be launched + +### Return type +[**StartLauncher200Response**](../models/start-launcher200-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Launcher launched successfully | StartLauncher200Response +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be launched + +# Launch a Launcher + +try { + Start-BetaLauncher-BetaLauncherID $LauncherID + + # Below is a request that includes all optional parameters + # Start-BetaLauncher -BetaLauncherID $LauncherID +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaLauncher" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaLifecycleStatesApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaLifecycleStatesApi.md new file mode 100644 index 000000000..a48acb0e1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaLifecycleStatesApi.md @@ -0,0 +1,161 @@ + +--- +id: beta-lifecycle-states +title: LifecycleStates +pagination_label: LifecycleStates +sidebar_label: LifecycleStates +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LifecycleStates', 'BetaLifecycleStates'] +slug: /tools/sdk/powershell/beta/methods/lifecycle-states +tags: ['SDK', 'Software Development Kit', 'LifecycleStates', 'BetaLifecycleStates'] +--- + +# LifecycleStates + Use this API to implement and customize lifecycle state functionality. +With this functionality in place, administrators can view and configure custom lifecycle states for use across their organizations, which is key to controlling which users have access, when they have access, and the access they have. + +A lifecycle state describes a user's status in a company. For example, two lifecycle states come by default with Identity Security Cloud: 'Active' and 'Inactive.' +When an active employee takes an extended leave of absence from a company, his or her lifecycle state may change to 'Inactive,' for security purposes. +The inactive employee would lose access to all the applications, sources, and sensitive data during the leave of absence, but when the employee returns and becomes active again, all that access would be restored. +This saves administrators the time that would otherwise be spent provisioning the employee's access to each individual tool, reviewing the employee's certification history, etc. + +Administrators must define the criteria for being in each lifecycle state, and they must define how Identity Security Cloud manages users' access to apps and sources for each lifecycle state. + +In Identity Security Cloud, administrators can manage lifecycle states by going to Admin > Identities > Identity Profile, selecting the identity profile whose lifecycle states they want to manage, selecting the 'Provisioning' tab, and using the left panel to select the lifecycle state they want to modify. + +In the 'Provisioning' tab, administrators can make the following access changes to an identity profile's lifecycle state: + +- Enable/disable the lifecycle state for the identity profile. + +- Enable/disable source accounts for the identity profile's lifecycle state. + +- Add existing access profiles to grant to the identity profiles in that lifecycle state. + +- Create a new access profile to grant to the identity profile in that lifecycle state. + +Access profiles granted in a previous lifecycle state are automatically revoked when the identity moves to a new lifecycle state. +To maintain access across multiple lifecycle states, administrators must grant the access profiles in each lifecycle state. +For example, if an administrator wants users with the 'HR Employee' identity profile to maintain their building access in both the 'Active' and 'Leave of Absence' lifecycle states, the administrator must grant the access profile for that building access to both lifecycle states. + +During scheduled refreshes, Identity Security Cloud evaluates lifecycle states to determine whether their assigned identities have the access defined in the lifecycle states' access profiles. +If the identities are missing access, Identity Security Cloud provisions that access. + +Administrators can also use the 'Provisioning' tab to configure email notifications for Identity Security Cloud to send whenever an identity with that identity profile has a lifecycle state change. +Refer to [Configuring Lifecycle State Notifications](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#configuring-lifecycle-state-notifications) for more information on how to do so. + +An identity's lifecycle state can have four different statuses: the lifecycle state's status can be 'Active,' it can be 'Not Set,' it can be 'Not Valid,' or it 'Does Not Match Technical Name Case.' +Refer to [Moving Identities into Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#moving-identities-into-lifecycle-states) for more information about these different lifecycle state statuses. + +Refer to [Setting Up Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html) for more information about lifecycle states. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaLifecycleStates**](#get-lifecycle-states) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State +[**Update-BetaLifecycleStates**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State + +## get-lifecycle-states +Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. + +A token with ORG_ADMIN or API authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | Identity Profile ID. +Path | LifecycleStateId | **String** | True | Lifecycle State ID. + +### Return type +[**LifecycleState**](../models/lifecycle-state) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Requested lifecycle state. | LifecycleState +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity Profile ID. +$LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle State ID. + +# Get Lifecycle State + +try { + Get-BetaLifecycleStates-BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Get-BetaLifecycleStates -BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLifecycleStates" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-lifecycle-states +Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +A token with ORG_ADMIN or API authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | Identity Profile ID. +Path | LifecycleStateId | **String** | True | Lifecycle State ID. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption + +### Return type +[**LifecycleState**](../models/lifecycle-state) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated lifecycle state. | LifecycleState +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity Profile ID. +$LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle State ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption + + +# Update Lifecycle State + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaLifecycleStates-BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaLifecycleStates -BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId -BetaJsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaLifecycleStates" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaMFAConfigurationApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaMFAConfigurationApi.md new file mode 100644 index 000000000..4c7e43cf0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaMFAConfigurationApi.md @@ -0,0 +1,384 @@ + +--- +id: beta-mfa-configuration +title: MFAConfiguration +pagination_label: MFAConfiguration +sidebar_label: MFAConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MFAConfiguration', 'BetaMFAConfiguration'] +slug: /tools/sdk/powershell/beta/methods/mfa-configuration +tags: ['SDK', 'Software Development Kit', 'MFAConfiguration', 'BetaMFAConfiguration'] +--- + +# MFAConfiguration + Configure and test multifactor authentication (MFA) methods + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Remove-BetaMFAConfig**](#delete-mfa-config) | **DELETE** `/mfa/{method}/delete` | Delete MFA method configuration +[**Get-BetaMFADuoConfig**](#get-mfa-duo-config) | **GET** `/mfa/duo-web/config` | Configuration of Duo MFA method +[**Get-BetaMFAKbaConfig**](#get-mfa-kba-config) | **GET** `/mfa/kba/config` | Configuration of KBA MFA method +[**Get-BetaMFAOktaConfig**](#get-mfa-okta-config) | **GET** `/mfa/okta-verify/config` | Configuration of Okta MFA method +[**Set-BetaMFADuoConfig**](#set-mfa-duo-config) | **PUT** `/mfa/duo-web/config` | Set Duo MFA configuration +[**Set-BetaMFAKBAConfig**](#set-mfakba-config) | **POST** `/mfa/kba/config/answers` | Set MFA KBA configuration +[**Set-BetaMFAOktaConfig**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set Okta MFA configuration +[**Test-BetaMFAConfig**](#test-mfa-config) | **GET** `/mfa/{method}/test` | MFA method's test configuration + +## delete-mfa-config +This API removes the configuration for the specified MFA method. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Method | **String** | True | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + +### Return type +[**MfaOktaConfig**](../models/mfa-okta-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | MFA configuration of an MFA method. | MfaOktaConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + +# Delete MFA method configuration + +try { + Remove-BetaMFAConfig-BetaMethod $Method + + # Below is a request that includes all optional parameters + # Remove-BetaMFAConfig -BetaMethod $Method +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaMFAConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-mfa-duo-config +This API returns the configuration of an Duo MFA method. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**MfaDuoConfig**](../models/mfa-duo-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The configuration of an Duo MFA method. | MfaDuoConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Configuration of Duo MFA method + +try { + Get-BetaMFADuoConfig + + # Below is a request that includes all optional parameters + # Get-BetaMFADuoConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFADuoConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-mfa-kba-config +This API returns the KBA configuration for MFA. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | AllLanguages | **Boolean** | (optional) | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false + +### Return type +[**KbaQuestion[]**](../models/kba-question) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The configuration for KBA MFA method. | KbaQuestion[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + +# Configuration of KBA MFA method + +try { + Get-BetaMFAKbaConfig + + # Below is a request that includes all optional parameters + # Get-BetaMFAKbaConfig -BetaAllLanguages $AllLanguages +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFAKbaConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-mfa-okta-config +This API returns the configuration of an Okta MFA method. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**MfaOktaConfig**](../models/mfa-okta-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The configuration of an Okta MFA method. | MfaOktaConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Configuration of Okta MFA method + +try { + Get-BetaMFAOktaConfig + + # Below is a request that includes all optional parameters + # Get-BetaMFAOktaConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFAOktaConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-mfa-duo-config +This API sets the configuration of an Duo MFA method. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | MfaDuoConfig | [**MfaDuoConfig**](../models/mfa-duo-config) | True | + +### Return type +[**MfaDuoConfig**](../models/mfa-duo-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | MFA configuration of an Duo MFA method. | MfaDuoConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$MfaDuoConfig = @"{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" +}"@ + +# Set Duo MFA configuration + +try { + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-BetaMFADuoConfig-BetaMfaDuoConfig $Result + + # Below is a request that includes all optional parameters + # Set-BetaMFADuoConfig -BetaMfaDuoConfig $MfaDuoConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFADuoConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-mfakba-config +This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | KbaAnswerRequestItem | [**[]KbaAnswerRequestItem**](../models/kba-answer-request-item) | True | + +### Return type +[**KbaAnswerResponseItem[]**](../models/kba-answer-response-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The new KBA configuration for the user. | KbaAnswerResponseItem[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" +}"@ # KbaAnswerRequestItem[] | + + +# Set MFA KBA configuration + +try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-BetaMFAKBAConfig-BetaKbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Set-BetaMFAKBAConfig -BetaKbaAnswerRequestItem $KbaAnswerRequestItem +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFAKBAConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-mfa-okta-config +This API sets the configuration of an Okta MFA method. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | MfaOktaConfig | [**MfaOktaConfig**](../models/mfa-okta-config) | True | + +### Return type +[**MfaOktaConfig**](../models/mfa-okta-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | MFA configuration of an Okta MFA method. | MfaOktaConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$MfaOktaConfig = @"{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" +}"@ + +# Set Okta MFA configuration + +try { + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-BetaMFAOktaConfig-BetaMfaOktaConfig $Result + + # Below is a request that includes all optional parameters + # Set-BetaMFAOktaConfig -BetaMfaOktaConfig $MfaOktaConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFAOktaConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## test-mfa-config +This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Method | **String** | True | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + +### Return type +[**MfaConfigTestResponse**](../models/mfa-config-test-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The result of configuration test for the MFA provider. | MfaConfigTestResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + +# MFA method's test configuration + +try { + Test-BetaMFAConfig-BetaMethod $Method + + # Below is a request that includes all optional parameters + # Test-BetaMFAConfig -BetaMethod $Method +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaMFAConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaMFAControllerApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaMFAControllerApi.md new file mode 100644 index 000000000..0a6b1b9ac --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaMFAControllerApi.md @@ -0,0 +1,305 @@ + +--- +id: beta-mfa-controller +title: MFAController +pagination_label: MFAController +sidebar_label: MFAController +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MFAController', 'BetaMFAController'] +slug: /tools/sdk/powershell/beta/methods/mfa-controller +tags: ['SDK', 'Software Development Kit', 'MFAController', 'BetaMFAController'] +--- + +# MFAController + This API used for multifactor authentication functionality belong to gov-multi-auth service. This controller allow you to verify authentication by specified method + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaSendToken**](#create-send-token) | **POST** `/mfa/token/send` | Create and send user token +[**Ping-BetaVerificationStatus**](#ping-verification-status) | **POST** `/mfa/{method}/poll` | Polling MFA method by VerificationPollRequest +[**Send-BetaDuoVerifyRequest**](#send-duo-verify-request) | **POST** `/mfa/duo-web/verify` | Verifying authentication via Duo method +[**Send-BetaKbaAnswers**](#send-kba-answers) | **POST** `/mfa/kba/authenticate` | Authenticate KBA provided MFA method +[**Send-BetaOktaVerifyRequest**](#send-okta-verify-request) | **POST** `/mfa/okta-verify/verify` | Verifying authentication via Okta method +[**Send-BetaTokenAuthRequest**](#send-token-auth-request) | **POST** `/mfa/token/authenticate` | Authenticate Token provided MFA method + +## create-send-token +This API send token request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | SendTokenRequest | [**SendTokenRequest**](../models/send-token-request) | True | + +### Return type +[**SendTokenResponse**](../models/send-token-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Token send status. | SendTokenResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SendTokenRequest = @"{ + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK" +}"@ + +# Create and send user token + +try { + $Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest + New-BetaSendToken-BetaSendTokenRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaSendToken -BetaSendTokenRequest $SendTokenRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSendToken" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## ping-verification-status +This API poll the VerificationPollRequest for the specified MFA method. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Method | **String** | True | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' + Body | VerificationPollRequest | [**VerificationPollRequest**](../models/verification-poll-request) | True | + +### Return type +[**VerificationResponse**](../models/verification-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | MFA VerificationPollRequest status an MFA method. | VerificationResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' +$VerificationPollRequest = @"{ + "requestId" : "089899f13a8f4da7824996191587bab9" +}"@ + +# Polling MFA method by VerificationPollRequest + +try { + $Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest + Ping-BetaVerificationStatus-BetaMethod $Method -BetaVerificationPollRequest $Result + + # Below is a request that includes all optional parameters + # Ping-BetaVerificationStatus -BetaMethod $Method -BetaVerificationPollRequest $VerificationPollRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-BetaVerificationStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## send-duo-verify-request +This API Authenticates the user via Duo-Web MFA method. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | DuoVerificationRequest | [**DuoVerificationRequest**](../models/duo-verification-request) | True | + +### Return type +[**VerificationResponse**](../models/verification-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The status of verification request. | VerificationResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$DuoVerificationRequest = @"{ + "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", + "userId" : "2c9180947f0ef465017f215cbcfd004b" +}"@ + +# Verifying authentication via Duo method + +try { + $Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest + Send-BetaDuoVerifyRequest-BetaDuoVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaDuoVerifyRequest -BetaDuoVerificationRequest $DuoVerificationRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaDuoVerifyRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## send-kba-answers +This API Authenticate user in KBA MFA method. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | KbaAnswerRequestItem | [**[]KbaAnswerRequestItem**](../models/kba-answer-request-item) | True | + +### Return type +[**KbaAuthResponse**](../models/kba-auth-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | KBA authenticated status. | KbaAuthResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" +}"@ # KbaAnswerRequestItem[] | + + +# Authenticate KBA provided MFA method + +try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Send-BetaKbaAnswers-BetaKbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Send-BetaKbaAnswers -BetaKbaAnswerRequestItem $KbaAnswerRequestItem +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaKbaAnswers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## send-okta-verify-request +This API Authenticates the user via Okta-Verify MFA method. Request requires a header called 'slpt-forwarding', and it must contain a remote IP Address of caller. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | OktaVerificationRequest | [**OktaVerificationRequest**](../models/okta-verification-request) | True | + +### Return type +[**VerificationResponse**](../models/verification-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The status of verification request. | VerificationResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$OktaVerificationRequest = @"{ + "userId" : "example@mail.com" +}"@ + +# Verifying authentication via Okta method + +try { + $Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest + Send-BetaOktaVerifyRequest-BetaOktaVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaOktaVerifyRequest -BetaOktaVerificationRequest $OktaVerificationRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaOktaVerifyRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## send-token-auth-request +This API Authenticate user in Token MFA method. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | TokenAuthRequest | [**TokenAuthRequest**](../models/token-auth-request) | True | + +### Return type +[**TokenAuthResponse**](../models/token-auth-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Token authenticated status. | TokenAuthResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$TokenAuthRequest = @"{ + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK", + "token" : "12345" +}"@ + +# Authenticate Token provided MFA method + +try { + $Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest + Send-BetaTokenAuthRequest-BetaTokenAuthRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaTokenAuthRequest -BetaTokenAuthRequest $TokenAuthRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTokenAuthRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaManagedClientsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaManagedClientsApi.md new file mode 100644 index 000000000..ea87bf1f0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaManagedClientsApi.md @@ -0,0 +1,141 @@ + +--- +id: beta-managed-clients +title: ManagedClients +pagination_label: ManagedClients +sidebar_label: ManagedClients +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClients', 'BetaManagedClients'] +slug: /tools/sdk/powershell/beta/methods/managed-clients +tags: ['SDK', 'Software Development Kit', 'ManagedClients', 'BetaManagedClients'] +--- + +# ManagedClients + Use this API to implement managed client functionality. +With this functionality in place, administrators can modify and delete existing managed clients, create new ones, and view and make changes to their log configurations. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaManagedClientStatus**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Specified Managed Client Status. +[**Update-BetaManagedClientStatus**](#update-managed-client-status) | **POST** `/managed-clients/{id}/status` | Handle status request from client + +## get-managed-client-status +Retrieve Managed Client Status by ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Managed Client Status to get + Query | Type | [**ManagedClientType**](../models/managed-client-type) | True | Type of the Managed Client Status to get + +### Return type +[**ManagedClientStatus**](../models/managed-client-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with Managed Client Status having the given ID and Type. | ManagedClientStatus +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "aClientId" # String | ID of the Managed Client Status to get +$Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get + +# Specified Managed Client Status. + +try { + Get-BetaManagedClientStatus-BetaId $Id -BetaType $Type + + # Below is a request that includes all optional parameters + # Get-BetaManagedClientStatus -BetaId $Id -BetaType $Type +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClientStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-managed-client-status +Update a status detail passed in from the client + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Managed Client Status to update + Body | ManagedClientStatus | [**ManagedClientStatus**](../models/managed-client-status) | True | + +### Return type +[**ManagedClientStatusAggResponse**](../models/managed-client-status-agg-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the updated Managed Client Status. | ManagedClientStatusAggResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "aClientId" # String | ID of the Managed Client Status to update +$ManagedClientStatus = @"{ + "body" : { + "alertKey" : "", + "id" : "5678", + "clusterId" : "1234", + "ccg_etag" : "ccg_etag123xyz456", + "ccg_pin" : "NONE", + "cookbook_etag" : "20210420125956-20210511144538", + "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", + "internal_ip" : "127.0.0.1", + "lastSeen" : "1620843964604", + "sinceSeen" : "14708", + "sinceSeenMillis" : "14708", + "localDev" : false, + "stacktrace" : "", + "status" : "NORMAL", + "product" : "idn", + "platform_version" : "2", + "os_version" : "2345.3.1", + "os_type" : "flatcar", + "hypervisor" : "unknown" + }, + "type" : "CCG", + "status" : "NORMAL", + "timestamp" : "2020-01-01T00:00:00Z" +}"@ + +# Handle status request from client + +try { + $Result = ConvertFrom-JsonToManagedClientStatus -Json $ManagedClientStatus + Update-BetaManagedClientStatus-BetaId $Id -BetaManagedClientStatus $Result + + # Below is a request that includes all optional parameters + # Update-BetaManagedClientStatus -BetaId $Id -BetaManagedClientStatus $ManagedClientStatus +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaManagedClientStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaManagedClustersApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaManagedClustersApi.md new file mode 100644 index 000000000..3b47bb2f0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaManagedClustersApi.md @@ -0,0 +1,212 @@ + +--- +id: beta-managed-clusters +title: ManagedClusters +pagination_label: ManagedClusters +sidebar_label: ManagedClusters +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusters', 'BetaManagedClusters'] +slug: /tools/sdk/powershell/beta/methods/managed-clusters +tags: ['SDK', 'Software Development Kit', 'ManagedClusters', 'BetaManagedClusters'] +--- + +# ManagedClusters + Use this API to implement managed cluster functionality. +With this functionality in place, administrators can modify and delete existing managed clients, get their statuses, and create new ones. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaClientLogConfiguration**](#get-client-log-configuration) | **GET** `/managed-clusters/{id}/log-config` | Get managed cluster's log configuration +[**Get-BetaManagedCluster**](#get-managed-cluster) | **GET** `/managed-clusters/{id}` | Get a specified ManagedCluster. +[**Get-BetaManagedClusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Retrieve all Managed Clusters. +[**Send-BetaClientLogConfiguration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update managed cluster's log configuration + +## get-client-log-configuration +Get managed cluster's log configuration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of ManagedCluster to get log configuration for + +### Return type +[**ClientLogConfiguration**](../models/client-log-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Log configuration of ManagedCluster matching given cluster ID | ClientLogConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "aClusterId" # String | ID of ManagedCluster to get log configuration for + +# Get managed cluster's log configuration + +try { + Get-BetaClientLogConfiguration-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaClientLogConfiguration -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaClientLogConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-managed-cluster +Retrieve a ManagedCluster by ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the ManagedCluster to get + +### Return type +[**ManagedCluster**](../models/managed-cluster) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with ManagedCluster having the given ID. | ManagedCluster +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "aClusterId" # String | ID of the ManagedCluster to get + +# Get a specified ManagedCluster. + +try { + Get-BetaManagedCluster-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaManagedCluster -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedCluster" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-managed-clusters +Retrieve all Managed Clusters for the current Org, based on request context. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* + +### Return type +[**ManagedCluster[]**](../models/managed-cluster) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with a list of ManagedCluster. | ManagedCluster[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'operational eq operation' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + +# Retrieve all Managed Clusters. + +try { + Get-BetaManagedClusters + + # Below is a request that includes all optional parameters + # Get-BetaManagedClusters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClusters" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-client-log-configuration +Update managed cluster's log configuration + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of ManagedCluster to update log configuration for + Body | ClientLogConfiguration | [**ClientLogConfiguration**](../models/client-log-configuration) | True | ClientLogConfiguration for given ManagedCluster + +### Return type +[**ClientLogConfiguration**](../models/client-log-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with updated ClientLogConfiguration for given ManagedCluster | ClientLogConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "aClusterId" # String | ID of ManagedCluster to update log configuration for +$ClientLogConfiguration = @"{ + "durationMinutes" : 120, + "rootLevel" : "INFO", + "clientId" : "aClientId", + "expiration" : "2020-12-15T19:13:36.079Z", + "logLevels" : "INFO" +}"@ + +# Update managed cluster's log configuration + +try { + Send-BetaClientLogConfiguration-BetaId $Id -BetaClientLogConfiguration $Result + + # Below is a request that includes all optional parameters + # Send-BetaClientLogConfiguration -BetaId $Id -BetaClientLogConfiguration $ClientLogConfiguration +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaMultiHostIntegrationApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaMultiHostIntegrationApi.md new file mode 100644 index 000000000..7cd3a5084 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaMultiHostIntegrationApi.md @@ -0,0 +1,685 @@ + +--- +id: beta-multi-host-integration +title: MultiHostIntegration +pagination_label: MultiHostIntegration +sidebar_label: MultiHostIntegration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegration', 'BetaMultiHostIntegration'] +slug: /tools/sdk/powershell/beta/methods/multi-host-integration +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegration', 'BetaMultiHostIntegration'] +--- + +# MultiHostIntegration + Use this API to build a Multi-Host Integration. +Multi-Host Integration will help customers to configure and manage similar type of target system in Identity Security Cloud. +In Identity Security Cloud, administrators can create a Multi-Host Integration by going to Admin > Connections > Multi-Host Sources and selecting 'Create.' + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaMultiHostIntegration**](#create-multi-host-integration) | **POST** `/multihosts` | Create Multi-Host Integration +[**New-BetaSourcesWithinMultiHost**](#create-sources-within-multi-host) | **POST** `/multihosts/{id}` | Create Sources Within Multi-Host Integration +[**Remove-BetaMultiHost**](#delete-multi-host) | **DELETE** `/multihosts/{id}` | Delete Multi-Host Integration +[**Get-BetaAcctAggregationGroups**](#get-acct-aggregation-groups) | **GET** `/multihosts/{multihostId}/acctAggregationGroups` | Get Account Aggregation Groups Within Multi-Host Integration ID +[**Get-BetaEntitlementAggregationGroups**](#get-entitlement-aggregation-groups) | **GET** `/multihosts/{multiHostId}/entitlementAggregationGroups` | Get Entitlement Aggregation Groups Within Multi-Host Integration ID +[**Get-BetaMultiHostIntegrations**](#get-multi-host-integrations) | **GET** `/multihosts/{id}` | Get Multi-Host Integration By ID +[**Get-BetaMultiHostIntegrationsList**](#get-multi-host-integrations-list) | **GET** `/multihosts` | List All Existing Multi-Host Integrations +[**Get-BetaMultiHostSourceCreationErrors**](#get-multi-host-source-creation-errors) | **GET** `/multihosts/{multiHostId}/sources/errors` | List Multi-Host Source Creation Errors +[**Get-BetaMultihostIntegrationTypes**](#get-multihost-integration-types) | **GET** `/multihosts/types` | List Multi-Host Integration Types +[**Get-BetaSourcesWithinMultiHost**](#get-sources-within-multi-host) | **GET** `/multihosts/{id}/sources` | List Sources Within Multi-Host Integration +[**Test-BetaConnectionMultiHostSources**](#test-connection-multi-host-sources) | **POST** `/multihosts/{multihost_id}/sources/testConnection` | Test Configuration For Multi-Host Integration +[**Test-BetaSourceConnectionMultihost**](#test-source-connection-multihost) | **GET** `/multihosts/{multihost_id}/sources/{sourceId}/testConnection` | Test Configuration For Multi-Host Integration's Single Source +[**Update-BetaMultiHostSources**](#update-multi-host-sources) | **PATCH** `/multihosts/{id}` | Update Multi-Host Integration + +## create-multi-host-integration +This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | MultiHostIntegrationsCreate | [**MultiHostIntegrationsCreate**](../models/multi-host-integrations-create) | True | The specifics of the Multi-Host Integration to create + +### Return type +[**MultiHostIntegrations**](../models/multi-host-integrations) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | OK. Returned if the request was successfully accepted into the system. | MultiHostIntegrations +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$MultiHostIntegrationsCreate = @"{ + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "connector" : "multihost-microsoft-sql-server", + "connectorAttributes" : { + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "created" : "2022-02-08T14:50:03.827Z", + "name" : "My Multi-Host Integration", + "description" : "This is the Multi-Host Integration.", + "modified" : "2024-01-23T18:08:50.897Z" +}"@ + +# Create Multi-Host Integration + +try { + $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate + New-BetaMultiHostIntegration-BetaMultiHostIntegrationsCreate $Result + + # Below is a request that includes all optional parameters + # New-BetaMultiHostIntegration -BetaMultiHostIntegrationsCreate $MultiHostIntegrationsCreate +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaMultiHostIntegration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-sources-within-multi-host +This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Multi-Host Integration. + Body | MultiHostIntegrationsCreateSources | [**[]MultiHostIntegrationsCreateSources**](../models/multi-host-integrations-create-sources) | True | The specifics of the sources to create within Multi-Host Integration. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | OK. Returned if the request was successfully accepted into the system. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. + $MultiHostIntegrationsCreateSources = @"{ + "connectorAttributes" : { + "authType" : "SQLAuthentication", + "url" : "jdbc:sqlserver://178.18.41.118:1433", + "user" : "username", + "driverClass" : "com.microsoft.sqlserver.jdbc.SQLServerDriver", + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "name" : "My Source", + "description" : "This is the corporate directory." +}"@ # MultiHostIntegrationsCreateSources[] | The specifics of the sources to create within Multi-Host Integration. + + +# Create Sources Within Multi-Host Integration + +try { + $Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources + New-BetaSourcesWithinMultiHost-BetaId $Id -BetaMultiHostIntegrationsCreateSources $Result + + # Below is a request that includes all optional parameters + # New-BetaSourcesWithinMultiHost -BetaId $Id -BetaMultiHostIntegrationsCreateSources $MultiHostIntegrationsCreateSources +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourcesWithinMultiHost" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-multi-host +Delete an existing Multi-Host Integration by ID. + +A token with Org Admin or Multi Host Admin authority is required to access this endpoint. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of Multi-Host Integration to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | OK. Returned if the request was successfully accepted into the system. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete. + +# Delete Multi-Host Integration + +try { + Remove-BetaMultiHost-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaMultiHost -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaMultiHost" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-acct-aggregation-groups +This API will return array of account aggregation groups within provided Multi-Host Integration ID. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | MultiHostId | **String** | True | ID of the Multi-Host Integration to update + +### Return type +[**MultiHostIntegrationsAggScheduleUpdate**](../models/multi-host-integrations-agg-schedule-update) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | OK. Returned if the request was successfully accepted into the system. | MultiHostIntegrationsAggScheduleUpdate +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update + +# Get Account Aggregation Groups Within Multi-Host Integration ID + +try { + Get-BetaAcctAggregationGroups-BetaMultiHostId $MultiHostId + + # Below is a request that includes all optional parameters + # Get-BetaAcctAggregationGroups -BetaMultiHostId $MultiHostId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAcctAggregationGroups" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-entitlement-aggregation-groups +This API will return array of aggregation groups within provided Multi-Host Integration ID. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | MultiHostId | **String** | True | ID of the Multi-Host Integration to update + +### Return type +[**MultiHostIntegrationsAggScheduleUpdate**](../models/multi-host-integrations-agg-schedule-update) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | OK. Returned if the request was successfully accepted into the system. | MultiHostIntegrationsAggScheduleUpdate +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update + +# Get Entitlement Aggregation Groups Within Multi-Host Integration ID + +try { + Get-BetaEntitlementAggregationGroups-BetaMultiHostId $MultiHostId + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementAggregationGroups -BetaMultiHostId $MultiHostId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementAggregationGroups" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-multi-host-integrations +Get an existing Multi-Host Integration. + +A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Multi-Host Integration. + +### Return type +[**MultiHostIntegrations**](../models/multi-host-integrations) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | OK. Returned if the request was successfully accepted into the system. | MultiHostIntegrations +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. + +# Get Multi-Host Integration By ID + +try { + Get-BetaMultiHostIntegrations-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaMultiHostIntegrations -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostIntegrations" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-multi-host-integrations-list +Get a list of Multi-Host Integrations. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *in* **forSubAdminId**: *in* + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | ForSubadmin | **String** | (optional) | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. + +### Return type +[**MultiHostIntegrations[]**](../models/multi-host-integrations) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | OK. Returned if the request was successfully accepted into the system. | MultiHostIntegrations[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) +$Filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *in* **forSubAdminId**: *in* (optional) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + +# List All Existing Multi-Host Integrations + +try { + Get-BetaMultiHostIntegrationsList + + # Below is a request that includes all optional parameters + # Get-BetaMultiHostIntegrationsList -BetaOffset $Offset -BetaLimit $Limit -BetaSorters $Sorters -BetaFilters $Filters -BetaCount $Count -BetaForSubadmin $ForSubadmin +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostIntegrationsList" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-multi-host-source-creation-errors +Get a list of sources creation errors within Multi-Host Integration ID. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | MultiHostId | **String** | True | ID of the Multi-Host Integration + +### Return type +[**SourceCreationErrors[]**](../models/source-creation-errors) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | OK. Returned if the request was successfully accepted into the system. | SourceCreationErrors[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration + +# List Multi-Host Source Creation Errors + +try { + Get-BetaMultiHostSourceCreationErrors-BetaMultiHostId $MultiHostId + + # Below is a request that includes all optional parameters + # Get-BetaMultiHostSourceCreationErrors -BetaMultiHostId $MultiHostId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostSourceCreationErrors" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-multihost-integration-types +This API endpoint returns the current list of supported Multi-Host Integration types. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**MultiHostIntegrationTemplateType[]**](../models/multi-host-integration-template-type) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | OK. Returned if the request was successfully accepted into the system. | MultiHostIntegrationTemplateType[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List Multi-Host Integration Types + +try { + Get-BetaMultihostIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-BetaMultihostIntegrationTypes +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultihostIntegrationTypes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sources-within-multi-host +Get a list of sources within Multi-Host Integration ID. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**MultiHostSources[]**](../models/multi-host-sources) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | OK. Returned if the request was successfully accepted into the system. | MultiHostSources[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) +$Filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* (optional) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# List Sources Within Multi-Host Integration + +try { + Get-BetaSourcesWithinMultiHost + + # Below is a request that includes all optional parameters + # Get-BetaSourcesWithinMultiHost -BetaOffset $Offset -BetaLimit $Limit -BetaSorters $Sorters -BetaFilters $Filters -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourcesWithinMultiHost" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## test-connection-multi-host-sources +This endpoint performs a more detailed validation of the Multi-Host Integration's configuration. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | MultihostId | **String** | True | ID of the Multi-Host Integration + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | OK. Returned if the request was successfully accepted into the system. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration + +# Test Configuration For Multi-Host Integration + +try { + Test-BetaConnectionMultiHostSources-BetaMultihostId $MultihostId + + # Below is a request that includes all optional parameters + # Test-BetaConnectionMultiHostSources -BetaMultihostId $MultihostId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaConnectionMultiHostSources" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## test-source-connection-multihost +This endpoint performs a more detailed validation of the source's configuration. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | MultihostId | **String** | True | ID of the Multi-Host Integration +Path | SourceId | **String** | True | ID of the source within the Multi-Host Integration + +### Return type +[**TestSourceConnectionMultihost200Response**](../models/test-source-connection-multihost200-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | OK. Returned if the request was successfully accepted into the system. | TestSourceConnectionMultihost200Response +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration +$SourceId = "2c91808568c529f60168cca6f90c1324" # String | ID of the source within the Multi-Host Integration + +# Test Configuration For Multi-Host Integration's Single Source + +try { + Test-BetaSourceConnectionMultihost-BetaMultihostId $MultihostId -BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Test-BetaSourceConnectionMultihost -BetaMultihostId $MultihostId -BetaSourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConnectionMultihost" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-multi-host-sources +Update existing sources within Multi-Host Integration. + +A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | MultihostId | **String** | True | ID of the Multi-Host Integration to update. + Body | UpdateMultiHostSourcesRequestInner | [**[]UpdateMultiHostSourcesRequestInner**](../models/update-multi-host-sources-request-inner) | True | This endpoint allows you to update a Multi-Host Integration. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | OK. Returned if the request was successfully accepted into the system. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$MultihostId = "anId" # String | ID of the Multi-Host Integration to update. + $UpdateMultiHostSourcesRequestInner = @"[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]"@ # UpdateMultiHostSourcesRequestInner[] | This endpoint allows you to update a Multi-Host Integration. + + +# Update Multi-Host Integration + +try { + $Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner + Update-BetaMultiHostSources-BetaMultihostId $MultihostId -BetaUpdateMultiHostSourcesRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaMultiHostSources -BetaMultihostId $MultihostId -BetaUpdateMultiHostSourcesRequestInner $UpdateMultiHostSourcesRequestInner +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaMultiHostSources" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaNonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaNonEmployeeLifecycleManagementApi.md new file mode 100644 index 000000000..af799dc61 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaNonEmployeeLifecycleManagementApi.md @@ -0,0 +1,1613 @@ + +--- +id: beta-non-employee-lifecycle-management +title: NonEmployeeLifecycleManagement +pagination_label: NonEmployeeLifecycleManagement +sidebar_label: NonEmployeeLifecycleManagement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeLifecycleManagement', 'BetaNonEmployeeLifecycleManagement'] +slug: /tools/sdk/powershell/beta/methods/non-employee-lifecycle-management +tags: ['SDK', 'Software Development Kit', 'NonEmployeeLifecycleManagement', 'BetaNonEmployeeLifecycleManagement'] +--- + +# NonEmployeeLifecycleManagement + Use this API to implement non-employee lifecycle management functionality. +With this functionality in place, administrators can create non-employee records and configure them for use in their organizations. +This allows organizations to provide secure access to non-employees and control that access. + +The 'non-employee' term refers to any consultant, contractor, intern, or other user in an organization who is not a full-time permanent employee. +Organizations can track non-employees' access and activity in Identity Security Cloud by creating and maintaining non-employee sources. +Organizations can have a maximum of 50 non-employee sources. + +By using SailPoint's Non-Employee Lifecycle Management functionality, you agree to the following: + +- SailPoint is not responsible for storing sensitive data. +You may only add account attributes to non-employee identities that are necessary for business operations and are consistent with your contractual limitations on data that may be sent or stored in Identity Security Cloud. + +- You are responsible for regularly downloading your list of non-employee accounts for all the sources you create and storing this list of accounts in a managed location to maintain an authoritative system of record and backup data for these accounts. + +To manage non-employees in Identity Security Cloud, administrators must create a non-employee source and add accounts to the source. + +To create a non-employee source in Identity Security Cloud, administrators must use the Admin panel to go to Connections > Sources. +They must then specify 'Non-Employee' in the 'Source Type' field. +Refer to [Creating a Non-Employee Source](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#creating-a-non-employee-source) for more details about how to create non-employee sources. + +To add accounts to a non-employee source in Identity Security Cloud, administrators can select the non-employee source and add the accounts. +They can also use the 'Manage Non-Employees' widget on their user dashboards to reach the list of sources and then select the non-employee source they want to add the accounts to. + +Administrators can either add accounts individually or in bulk. Each non-employee source can have a maximum of 20,000 accounts. +To add accounts in bulk, they must select the 'Bulk Upload' option and upload a CSV file. +Refer to [Adding Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#adding-accounts) for more details about how to add accounts to non-employee sources. + +Once administrators have created the non-employee source and added accounts to it, they can create identity profiles to generate identities for the non-employee accounts and manage the non-employee identities the same way they would any other identities. + +Refer to [Managing Non-Employee Sources and Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html) for more information about non-employee lifecycle management. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Approve-BetaNonEmployeeRequest**](#approve-non-employee-request) | **POST** `/non-employee-approvals/{id}/approve` | Approve a Non-Employee Request +[**New-BetaNonEmployeeRecord**](#create-non-employee-record) | **POST** `/non-employee-records` | Create Non-Employee Record +[**New-BetaNonEmployeeRequest**](#create-non-employee-request) | **POST** `/non-employee-requests` | Create Non-Employee Request +[**New-BetaNonEmployeeSource**](#create-non-employee-source) | **POST** `/non-employee-sources` | Create Non-Employee Source +[**New-BetaNonEmployeeSourceSchemaAttributes**](#create-non-employee-source-schema-attributes) | **POST** `/non-employee-sources/{sourceId}/schema-attributes` | Create Non-Employee Source Schema Attribute +[**Remove-BetaNonEmployeeRecord**](#delete-non-employee-record) | **DELETE** `/non-employee-records/{id}` | Delete Non-Employee Record +[**Remove-BetaNonEmployeeRecordInBulk**](#delete-non-employee-record-in-bulk) | **POST** `/non-employee-records/bulk-delete` | Delete Multiple Non-Employee Records +[**Remove-BetaNonEmployeeRequest**](#delete-non-employee-request) | **DELETE** `/non-employee-requests/{id}` | Delete Non-Employee Request +[**Remove-BetaNonEmployeeSchemaAttribute**](#delete-non-employee-schema-attribute) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete Non-Employee Source's Schema Attribute +[**Remove-BetaNonEmployeeSource**](#delete-non-employee-source) | **DELETE** `/non-employee-sources/{sourceId}` | Delete Non-Employee Source +[**Remove-BetaNonEmployeeSourceSchemaAttributes**](#delete-non-employee-source-schema-attributes) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes +[**Export-BetaNonEmployeeRecords**](#export-non-employee-records) | **GET** `/non-employee-sources/{id}/non-employees/download` | Exports Non-Employee Records to CSV +[**Export-BetaNonEmployeeSourceSchemaTemplate**](#export-non-employee-source-schema-template) | **GET** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports Source Schema Template +[**Get-BetaNonEmployeeApproval**](#get-non-employee-approval) | **GET** `/non-employee-approvals/{id}` | Get a non-employee approval item detail +[**Get-BetaNonEmployeeApprovalSummary**](#get-non-employee-approval-summary) | **GET** `/non-employee-approvals/summary/{requested-for}` | Get Summary of Non-Employee Approval Requests +[**Get-BetaNonEmployeeBulkUploadStatus**](#get-non-employee-bulk-upload-status) | **GET** `/non-employee-sources/{id}/non-employee-bulk-upload/status` | Bulk upload status on source +[**Get-BetaNonEmployeeRecord**](#get-non-employee-record) | **GET** `/non-employee-records/{id}` | Get a Non-Employee Record +[**Get-BetaNonEmployeeRequest**](#get-non-employee-request) | **GET** `/non-employee-requests/{id}` | Get a Non-Employee Request +[**Get-BetaNonEmployeeRequestSummary**](#get-non-employee-request-summary) | **GET** `/non-employee-requests/summary/{requested-for}` | Get Summary of Non-Employee Requests +[**Get-BetaNonEmployeeSchemaAttribute**](#get-non-employee-schema-attribute) | **GET** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get Schema Attribute Non-Employee Source +[**Get-BetaNonEmployeeSource**](#get-non-employee-source) | **GET** `/non-employee-sources/{sourceId}` | Get a Non-Employee Source +[**Get-BetaNonEmployeeSourceSchemaAttributes**](#get-non-employee-source-schema-attributes) | **GET** `/non-employee-sources/{sourceId}/schema-attributes` | List Schema Attributes Non-Employee Source +[**Import-BetaNonEmployeeRecordsInBulk**](#import-non-employee-records-in-bulk) | **POST** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or Updates, Non-Employee Records +[**Get-BetaNonEmployeeApproval**](#list-non-employee-approval) | **GET** `/non-employee-approvals` | Get List of Non-Employee Approval Requests +[**Get-BetaNonEmployeeRecords**](#list-non-employee-records) | **GET** `/non-employee-records` | List Non-Employee Records +[**Get-BetaNonEmployeeRequests**](#list-non-employee-requests) | **GET** `/non-employee-requests` | List Non-Employee Requests +[**Get-BetaNonEmployeeSources**](#list-non-employee-sources) | **GET** `/non-employee-sources` | List Non-Employee Sources +[**Update-BetaNonEmployeeRecord**](#patch-non-employee-record) | **PATCH** `/non-employee-records/{id}` | Patch Non-Employee Record +[**Update-BetaNonEmployeeSchemaAttribute**](#patch-non-employee-schema-attribute) | **PATCH** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch Non-Employee Source's Schema Attribute +[**Update-BetaNonEmployeeSource**](#patch-non-employee-source) | **PATCH** `/non-employee-sources/{sourceId}` | Patch a Non-Employee Source +[**Deny-BetaNonEmployeeRequest**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request +[**Update-BetaNonEmployeeRecord**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update Non-Employee Record + +## approve-non-employee-request +Approves a non-employee approval request and notifies the next approver. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-Employee approval item id (UUID) + Body | NonEmployeeApprovalDecision | [**NonEmployeeApprovalDecision**](../models/non-employee-approval-decision) | True | + +### Return type +[**NonEmployeeApprovalItem**](../models/non-employee-approval-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee approval item object. | NonEmployeeApprovalItem +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "MyId" # String | Non-Employee approval item id (UUID) +$NonEmployeeApprovalDecision = @"{ + "comment" : "comment" +}"@ + +# Approve a Non-Employee Request + +try { + $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision + Approve-BetaNonEmployeeRequest-BetaId $Id -BetaNonEmployeeApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Approve-BetaNonEmployeeRequest -BetaId $Id -BetaNonEmployeeApprovalDecision $NonEmployeeApprovalDecision +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-non-employee-record +This request will create a non-employee record. +Request will require the following security scope: +'idn:nesr:create' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | NonEmployeeRequestBody | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | True | Non-Employee record creation request body. + +### Return type +[**NonEmployeeRecord**](../models/non-employee-record) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Created non-employee record. | NonEmployeeRecord +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$NonEmployeeRequestBody = @"{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" +}"@ + +# Create Non-Employee Record + +try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-BetaNonEmployeeRecord-BetaNonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-BetaNonEmployeeRecord -BetaNonEmployeeRequestBody $NonEmployeeRequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-non-employee-request +This request will create a non-employee request and notify the approver + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | NonEmployeeRequestBody | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | True | Non-Employee creation request body + +### Return type +[**NonEmployeeRequest**](../models/non-employee-request) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee request creation object | NonEmployeeRequest +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$NonEmployeeRequestBody = @"{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" +}"@ + +# Create Non-Employee Request + +try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-BetaNonEmployeeRequest-BetaNonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-BetaNonEmployeeRequest -BetaNonEmployeeRequestBody $NonEmployeeRequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-non-employee-source +This request will create a non-employee source. +Request will require the following security scope: +'idn:nesr:create' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | NonEmployeeSourceRequestBody | [**NonEmployeeSourceRequestBody**](../models/non-employee-source-request-body) | True | Non-Employee source creation request body. + +### Return type +[**NonEmployeeSourceWithCloudExternalId**](../models/non-employee-source-with-cloud-external-id) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Created non-employee source. | NonEmployeeSourceWithCloudExternalId +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$NonEmployeeSourceRequestBody = @"{ + "owner" : { + "id" : "2c91808570313110017040b06f344ec9" + }, + "managementWorkgroup" : "123299", + "accountManagers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ], + "name" : "Retail", + "description" : "Source description", + "approvers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ] +}"@ + +# Create Non-Employee Source + +try { + $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody + New-BetaNonEmployeeSource-BetaNonEmployeeSourceRequestBody $Result + + # Below is a request that includes all optional parameters + # New-BetaNonEmployeeSource -BetaNonEmployeeSourceRequestBody $NonEmployeeSourceRequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSource" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-non-employee-source-schema-attributes +This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id + Body | NonEmployeeSchemaAttributeBody | [**NonEmployeeSchemaAttributeBody**](../models/non-employee-schema-attribute-body) | True | + +### Return type +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Schema Attribute created. | NonEmployeeSchemaAttribute +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id +$NonEmployeeSchemaAttributeBody = @"{ + "helpText" : "The unique identifier for the account", + "label" : "Account Name", + "placeholder" : "Enter a unique user name for this account.", + "type" : "TEXT", + "technicalName" : "account.name", + "required" : true +}"@ + +# Create Non-Employee Source Schema Attribute + +try { + $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody + New-BetaNonEmployeeSourceSchemaAttributes-BetaSourceId $SourceId -BetaNonEmployeeSchemaAttributeBody $Result + + # Below is a request that includes all optional parameters + # New-BetaNonEmployeeSourceSchemaAttributes -BetaSourceId $SourceId -BetaNonEmployeeSchemaAttributeBody $NonEmployeeSchemaAttributeBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-non-employee-record +This request will delete a non-employee record. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-Employee record id (UUID) + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID) + +# Delete Non-Employee Record + +try { + Remove-BetaNonEmployeeRecord-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeRecord -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-non-employee-record-in-bulk +This request will delete multiple non-employee records based on the non-employee ids provided. +Request will require the following scope: +'idn:nesr:delete' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | DeleteNonEmployeeRecordInBulkRequest | [**DeleteNonEmployeeRecordInBulkRequest**](../models/delete-non-employee-record-in-bulk-request) | True | Non-Employee bulk delete request body. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$DeleteNonEmployeeRecordInBulkRequest = @""@ + +# Delete Multiple Non-Employee Records + +try { + $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordInBulkRequest -Json $DeleteNonEmployeeRecordInBulkRequest + Remove-BetaNonEmployeeRecordInBulk-BetaDeleteNonEmployeeRecordInBulkRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeRecordInBulk -BetaDeleteNonEmployeeRecordInBulkRequest $DeleteNonEmployeeRecordInBulkRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRecordInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-non-employee-request +This request will delete a non-employee request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-Employee request id in the UUID format + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id in the UUID format + +# Delete Non-Employee Request + +try { + Remove-BetaNonEmployeeRequest-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeRequest -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-non-employee-schema-attribute +This end-point deletes a specific schema attribute for a non-employee source. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | AttributeId | **String** | True | The Schema Attribute Id (UUID) +Path | SourceId | **String** | True | The Source id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$AttributeId = "2c91808b6ef1d43e016efba0ce470904" # String | The Schema Attribute Id (UUID) +$SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id + +# Delete Non-Employee Source's Schema Attribute + +try { + Remove-BetaNonEmployeeSchemaAttribute-BetaAttributeId $AttributeId -BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeSchemaAttribute -BetaAttributeId $AttributeId -BetaSourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-non-employee-source +This request will delete a non-employee source. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | Source Id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id + +# Delete Non-Employee Source + +try { + Remove-BetaNonEmployeeSource-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeSource -BetaSourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSource" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-non-employee-source-schema-attributes +This end-point deletes all custom schema attributes for a non-employee source. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id + +# Delete all custom schema attributes + +try { + Remove-BetaNonEmployeeSourceSchemaAttributes-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeSourceSchemaAttributes -BetaSourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## export-non-employee-records +This requests a CSV download for all non-employees from a provided source. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source Id (UUID) + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Exported CSV | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: text/csv, application/json + +### Example +```powershell +$Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID) + +# Exports Non-Employee Records to CSV + +try { + Export-BetaNonEmployeeRecords-BetaId $Id + + # Below is a request that includes all optional parameters + # Export-BetaNonEmployeeRecords -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaNonEmployeeRecords" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## export-non-employee-source-schema-template +This requests a download for the Source Schema Template for a provided source. +Request will require the following security scope: +idn:nesr:read' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source Id (UUID) + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Exported Source Schema Template | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: text/csv, application/json + +### Example +```powershell +$Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID) + +# Exports Source Schema Template + +try { + Export-BetaNonEmployeeSourceSchemaTemplate-BetaId $Id + + # Below is a request that includes all optional parameters + # Export-BetaNonEmployeeSourceSchemaTemplate -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaNonEmployeeSourceSchemaTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-approval +Approves a non-employee approval request and notifies the next approver. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-Employee approval item id (UUID) + Query | IncludeDetail | **String** | (optional) | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* + +### Return type +[**NonEmployeeApprovalItemDetail**](../models/non-employee-approval-item-detail) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee approval item object. | NonEmployeeApprovalItemDetail +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | Non-Employee approval item id (UUID) +$IncludeDetail = "include-detail=false" # String | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) + +# Get a non-employee approval item detail + +try { + Get-BetaNonEmployeeApproval-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeApproval -BetaId $Id -BetaIncludeDetail $IncludeDetail +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApproval" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-approval-summary +This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id. 2. The current user is an approver, in which case "me" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | RequestedFor | **String** | True | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + +### Return type +[**NonEmployeeApprovalSummary**](../models/non-employee-approval-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | summary of non-employee approval requests | NonEmployeeApprovalSummary +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + +# Get Summary of Non-Employee Approval Requests + +try { + Get-BetaNonEmployeeApprovalSummary-BetaRequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeApprovalSummary -BetaRequestedFor $RequestedFor +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApprovalSummary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-bulk-upload-status +The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source ID (UUID) + +### Return type +[**NonEmployeeBulkUploadStatus**](../models/non-employee-bulk-upload-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Status of the newest bulk-upload job, if any. | NonEmployeeBulkUploadStatus +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c918085842e69ae018432d22ccb212f" # String | Source ID (UUID) + +# Bulk upload status on source + +try { + Get-BetaNonEmployeeBulkUploadStatus-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeBulkUploadStatus -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeBulkUploadStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-record +This gets a non-employee record. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-Employee record id (UUID) + +### Return type +[**NonEmployeeRecord**](../models/non-employee-record) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee record object | NonEmployeeRecord +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID) + +# Get a Non-Employee Record + +try { + Get-BetaNonEmployeeRecord-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRecord -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-request +This gets a non-employee request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-Employee request id (UUID) + +### Return type +[**NonEmployeeRequest**](../models/non-employee-request) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee request object. | NonEmployeeRequest +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id (UUID) + +# Get a Non-Employee Request + +try { + Get-BetaNonEmployeeRequest-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRequest -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-request-summary +This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id. 2. The current user is an account manager, in which case "me" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | RequestedFor | **String** | True | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + +### Return type +[**NonEmployeeRequestSummary**](../models/non-employee-request-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee request summary object. | NonEmployeeRequestSummary +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + +# Get Summary of Non-Employee Requests + +try { + Get-BetaNonEmployeeRequestSummary-BetaRequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRequestSummary -BetaRequestedFor $RequestedFor +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequestSummary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-schema-attribute +This API gets a schema attribute by Id for the specified Non-Employee SourceId. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | AttributeId | **String** | True | The Schema Attribute Id (UUID) +Path | SourceId | **String** | True | The Source id + +### Return type +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Schema Attribute | NonEmployeeSchemaAttribute +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$AttributeId = "2c918085842e69ae018432d22ccb212f" # String | The Schema Attribute Id (UUID) +$SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id + +# Get Schema Attribute Non-Employee Source + +try { + Get-BetaNonEmployeeSchemaAttribute-BetaAttributeId $AttributeId -BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeSchemaAttribute -BetaAttributeId $AttributeId -BetaSourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-source +This gets a non-employee source. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | Source Id + +### Return type +[**NonEmployeeSource**](../models/non-employee-source) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee source object. | NonEmployeeSource +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id + +# Get a Non-Employee Source + +try { + Get-BetaNonEmployeeSource-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeSource -BetaSourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSource" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-source-schema-attributes +This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id + +### Return type +[**NonEmployeeSchemaAttribute[]**](../models/non-employee-schema-attribute) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of Schema Attributes | NonEmployeeSchemaAttribute[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id + +# List Schema Attributes Non-Employee Source + +try { + Get-BetaNonEmployeeSourceSchemaAttributes-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeSourceSchemaAttributes -BetaSourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-non-employee-records-in-bulk +This post will import, or update, Non-Employee records found in the CSV. +Request will need the following security scope: +'idn:nesr:create' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source Id (UUID) + | Data | **System.IO.FileInfo** | True | + +### Return type +[**NonEmployeeBulkUploadJob**](../models/non-employee-bulk-upload-job) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | The CSV was accepted to be bulk inserted now or at a later time. | NonEmployeeBulkUploadJob +400 | Client Error - Returned if the request body is invalid. The response body will contain the list of specific errors with one on each line. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) +$Data = # System.IO.FileInfo | + +# Imports, or Updates, Non-Employee Records + +try { + Import-BetaNonEmployeeRecordsInBulk-BetaId $Id -BetaData $Data + + # Below is a request that includes all optional parameters + # Import-BetaNonEmployeeRecordsInBulk -BetaId $Id -BetaData $Data +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaNonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-non-employee-approval +This gets a list of non-employee approval requests. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | RequestedFor | **String** | (optional) | The identity for whom the request was made. *me* indicates the current user. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** + +### Return type +[**NonEmployeeApprovalItem[]**](../models/non-employee-approval-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of approval items. | NonEmployeeApprovalItem[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity for whom the request was made. *me* indicates the current user. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'approvalStatus eq "PENDING"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) +$Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + +# Get List of Non-Employee Approval Requests + +try { + Get-BetaNonEmployeeApproval + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeApproval -BetaRequestedFor $RequestedFor -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApproval" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-non-employee-records +This gets a list of non-employee records. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* + +### Return type +[**NonEmployeeRecord[]**](../models/non-employee-record) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee record objects | NonEmployeeRecord[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "accountName,sourceId" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) +$Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + +# List Non-Employee Records + +try { + Get-BetaNonEmployeeRecords + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRecords -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRecords" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-non-employee-requests +This gets a list of non-employee requests. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | RequestedFor | **String** | True | The identity for whom the request was made. *me* indicates the current user. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* + +### Return type +[**NonEmployeeRequest[]**](../models/non-employee-request) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of non-employee request objects. | NonEmployeeRequest[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "approvalStatus,firstName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) +$Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + +# List Non-Employee Requests + +try { + Get-BetaNonEmployeeRequests-BetaRequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRequests -BetaRequestedFor $RequestedFor -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequests" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-non-employee-sources +This gets a list of non-employee sources. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | RequestedFor | **String** | True | The identity for whom the request was made. *me* indicates the current user. + Query | NonEmployeeCount | **Boolean** | True | The flag to determine whether return a non-employee count associate with source. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** + +### Return type +[**NonEmployeeSourceWithNECount[]**](../models/non-employee-source-with-ne-count) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of non-employee sources objects. | NonEmployeeSourceWithNECount[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. +$NonEmployeeCount = $false # Boolean | The flag to determine whether return a non-employee count associate with source. +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) + +# List Non-Employee Sources + +try { + Get-BetaNonEmployeeSources-BetaRequestedFor $RequestedFor -BetaNonEmployeeCount $NonEmployeeCount + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeSources -BetaRequestedFor $RequestedFor -BetaNonEmployeeCount $NonEmployeeCount -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSources" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-non-employee-record +This request will patch a non-employee record. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-employee record id (UUID) + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + +### Return type +[**NonEmployeeRecord**](../models/non-employee-record) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A patched non-employee record. | NonEmployeeRecord +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-employee record id (UUID) + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + + +# Patch Non-Employee Record + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaNonEmployeeRecord-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaNonEmployeeRecord -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-non-employee-schema-attribute +This end-point patches a specific schema attribute for a non-employee SourceId. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | AttributeId | **String** | True | The Schema Attribute Id (UUID) +Path | SourceId | **String** | True | The Source id + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. + +### Return type +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Schema Attribute was successfully patched. | NonEmployeeSchemaAttribute +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$AttributeId = "2c91808b6ef1d43e016efba0ce470904" # String | The Schema Attribute Id (UUID) +$SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. + + +# Patch Non-Employee Source's Schema Attribute + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaNonEmployeeSchemaAttribute-BetaAttributeId $AttributeId -BetaSourceId $SourceId -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaNonEmployeeSchemaAttribute -BetaAttributeId $AttributeId -BetaSourceId $SourceId -BetaJsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-non-employee-source +patch a non-employee source. (Partial Update) Patchable field: **name, description, approvers, accountManagers** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | Source Id + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**NonEmployeeSource**](../models/non-employee-source) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A patched non-employee source object. | NonEmployeeSource +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +# Patch a Non-Employee Source + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaNonEmployeeSource-BetaSourceId $SourceId -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaNonEmployeeSource -BetaSourceId $SourceId -BetaJsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSource" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## reject-non-employee-request +This endpoint will reject an approval item request and notify user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-Employee approval item id (UUID) + Body | NonEmployeeRejectApprovalDecision | [**NonEmployeeRejectApprovalDecision**](../models/non-employee-reject-approval-decision) | True | + +### Return type +[**NonEmployeeApprovalItem**](../models/non-employee-approval-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee approval item object. | NonEmployeeApprovalItem +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "MyId" # String | Non-Employee approval item id (UUID) +$NonEmployeeRejectApprovalDecision = @"{ + "comment" : "comment" +}"@ + +# Reject a Non-Employee Request + +try { + $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision + Deny-BetaNonEmployeeRequest-BetaId $Id -BetaNonEmployeeRejectApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Deny-BetaNonEmployeeRequest -BetaId $Id -BetaNonEmployeeRejectApprovalDecision $NonEmployeeRejectApprovalDecision +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-non-employee-record +This request will update a non-employee record. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-employee record id (UUID) + Body | NonEmployeeRequestBody | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | True | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + +### Return type +[**NonEmployeeRecord**](../models/non-employee-record) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An updated non-employee record. | NonEmployeeRecord +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-employee record id (UUID) +$NonEmployeeRequestBody = @"{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" +}"@ + +# Update Non-Employee Record + +try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + Update-BetaNonEmployeeRecord-BetaId $Id -BetaNonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaNonEmployeeRecord -BetaId $Id -BetaNonEmployeeRequestBody $NonEmployeeRequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaNotificationsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaNotificationsApi.md new file mode 100644 index 000000000..466718b6d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaNotificationsApi.md @@ -0,0 +1,724 @@ + +--- +id: beta-notifications +title: Notifications +pagination_label: Notifications +sidebar_label: Notifications +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Notifications', 'BetaNotifications'] +slug: /tools/sdk/powershell/beta/methods/notifications +tags: ['SDK', 'Software Development Kit', 'Notifications', 'BetaNotifications'] +--- + +# Notifications + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaDomainDkim**](#create-domain-dkim) | **POST** `/verified-domains` | Verify domain address via DKIM +[**New-BetaNotificationTemplate**](#create-notification-template) | **POST** `/notification-templates` | Create Notification Template +[**New-BetaVerifiedFromAddress**](#create-verified-from-address) | **POST** `/verified-from-addresses` | Create Verified From Address +[**Remove-BetaNotificationTemplatesInBulk**](#delete-notification-templates-in-bulk) | **POST** `/notification-templates/bulk-delete` | Bulk Delete Notification Templates +[**Remove-BetaVerifiedFromAddress**](#delete-verified-from-address) | **DELETE** `/verified-from-addresses/{id}` | Delete Verified From Address +[**Get-BetaDkimAttributes**](#get-dkim-attributes) | **GET** `/verified-domains` | Get DKIM Attributes +[**Get-BetaMailFromAttributes**](#get-mail-from-attributes) | **GET** `/mail-from-attributes/{identity}` | Get MAIL FROM Attributes +[**Get-BetaNotificationTemplate**](#get-notification-template) | **GET** `/notification-templates/{id}` | Get Notification Template By Id +[**Get-BetaNotificationsTemplateContext**](#get-notifications-template-context) | **GET** `/notification-template-context` | Get Notification Template Context +[**Get-BetaFromAddresses**](#list-from-addresses) | **GET** `/verified-from-addresses` | List From Addresses +[**Get-BetaNotificationPreferences**](#list-notification-preferences) | **GET** `/notification-preferences/{key}` | List Notification Preferences for tenant. +[**Get-BetaNotificationTemplateDefaults**](#list-notification-template-defaults) | **GET** `/notification-template-defaults` | List Notification Template Defaults +[**Get-BetaNotificationTemplates**](#list-notification-templates) | **GET** `/notification-templates` | List Notification Templates +[**Send-BetaMailFromAttributes**](#put-mail-from-attributes) | **PUT** `/mail-from-attributes` | Change MAIL FROM domain +[**Send-BetaTestNotification**](#send-test-notification) | **POST** `/send-test-notification` | Send Test Notification + +## create-domain-dkim +Create a domain to be verified via DKIM (DomainKeys Identified Mail) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | DomainAddress | [**DomainAddress**](../models/domain-address) | True | + +### Return type +[**DomainStatusDto**](../models/domain-status-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of DKIM tokens required for the verification process. | DomainStatusDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +405 | Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method. | CreateDomainDkim405Response +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$DomainAddress = @"{ + "domain" : "sailpoint.com" +}"@ + +# Verify domain address via DKIM + +try { + $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress + New-BetaDomainDkim-BetaDomainAddress $Result + + # Below is a request that includes all optional parameters + # New-BetaDomainDkim -BetaDomainAddress $DomainAddress +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDomainDkim" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-notification-template +This creates a template for your site. + +You can also use this endpoint to update a template. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | TemplateDto | [**TemplateDto**](../models/template-dto) | True | + +### Return type +[**TemplateDto**](../models/template-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A template object for your site | TemplateDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$TemplateDto = @"{ + "slackTemplate" : "slackTemplate", + "footer" : "footer", + "teamsTemplate" : "teamsTemplate", + "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", + "created" : "2020-01-01T00:00:00Z", + "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", + "medium" : "EMAIL", + "locale" : "en", + "body" : "Please go to the task manager", + "name" : "Task Manager Subscription", + "replyTo" : "$__global.emailFromAddress", + "header" : "header", + "modified" : "2020-01-01T00:00:00Z", + "from" : "$__global.emailFromAddress", + "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", + "key" : "cloud_manual_work_item_summary" +}"@ + +# Create Notification Template + +try { + $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto + New-BetaNotificationTemplate-BetaTemplateDto $Result + + # Below is a request that includes all optional parameters + # New-BetaNotificationTemplate -BetaTemplateDto $TemplateDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNotificationTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-verified-from-address +Create a new sender email address and initiate verification process. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | EmailStatusDto | [**EmailStatusDto**](../models/email-status-dto) | True | + +### Return type +[**EmailStatusDto**](../models/email-status-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | New Verified Email Status | EmailStatusDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$EmailStatusDto = @"{ + "isVerifiedByDomain" : false, + "verificationStatus" : "PENDING", + "id" : "id", + "email" : "sender@example.com" +}"@ + +# Create Verified From Address + +try { + $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto + New-BetaVerifiedFromAddress-BetaEmailStatusDto $Result + + # Below is a request that includes all optional parameters + # New-BetaVerifiedFromAddress -BetaEmailStatusDto $EmailStatusDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaVerifiedFromAddress" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-notification-templates-in-bulk +This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, please contact support to enable usage. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | TemplateBulkDeleteDto | [**[]TemplateBulkDeleteDto**](../models/template-bulk-delete-dto) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell + $TemplateBulkDeleteDto = @"{ + "medium" : "EMAIL", + "locale" : "en", + "key" : "cloud_manual_work_item_summary" +}"@ # TemplateBulkDeleteDto[] | + + +# Bulk Delete Notification Templates + +try { + $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto + Remove-BetaNotificationTemplatesInBulk-BetaTemplateBulkDeleteDto $Result + + # Below is a request that includes all optional parameters + # Remove-BetaNotificationTemplatesInBulk -BetaTemplateBulkDeleteDto $TemplateBulkDeleteDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNotificationTemplatesInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-verified-from-address +Delete a verified sender email address + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "MyId" # String | + +# Delete Verified From Address + +try { + Remove-BetaVerifiedFromAddress-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaVerifiedFromAddress -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaVerifiedFromAddress" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-dkim-attributes +Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants' AWS SES identities. Limits retrieval to 100 identities per call. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**DkimAttributes[]**](../models/dkim-attributes) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of DKIM Attributes | DkimAttributes[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get DKIM Attributes + +try { + Get-BetaDkimAttributes + + # Below is a request that includes all optional parameters + # Get-BetaDkimAttributes +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDkimAttributes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-mail-from-attributes +Retrieve MAIL FROM attributes for a given AWS SES identity. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Id | **String** | True | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status + +### Return type +[**MailFromAttributes**](../models/mail-from-attributes) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | MAIL FROM Attributes object | MailFromAttributes +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status + +# Get MAIL FROM Attributes + +try { + Get-BetaMailFromAttributes-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaMailFromAttributes -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMailFromAttributes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-notification-template +This gets a template that you have modified for your site by Id. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the Notification Template + +### Return type +[**TemplateDto[]**](../models/template-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A template object for your site | TemplateDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template + +# Get Notification Template By Id + +try { + Get-BetaNotificationTemplate-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaNotificationTemplate -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-notifications-template-context +The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called "Global Context" (a.k.a. notification template context). It defines a set of attributes + that will be available per tenant (organization). + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**NotificationTemplateContext**](../models/notification-template-context) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Notification template context attributes for a specific tenant. | NotificationTemplateContext +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Notification Template Context + +try { + Get-BetaNotificationsTemplateContext + + # Below is a request that includes all optional parameters + # Get-BetaNotificationsTemplateContext +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationsTemplateContext" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-from-addresses +Retrieve a list of sender email addresses and their verification statuses + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** + +### Return type +[**EmailStatusDto[]**](../models/email-status-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Email Status | EmailStatusDto[] +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'email eq "john.doe@company.com"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* (optional) +$Sorters = "email" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) + +# List From Addresses + +try { + Get-BetaFromAddresses + + # Below is a request that includes all optional parameters + # Get-BetaFromAddresses -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFromAddresses" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-notification-preferences +Returns a list of notification preferences for tenant. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**PreferencesDto[]**](../models/preferences-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Return preference for the given notification key. | PreferencesDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List Notification Preferences for tenant. + +try { + Get-BetaNotificationPreferences + + # Below is a request that includes all optional parameters + # Get-BetaNotificationPreferences +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationPreferences" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-notification-template-defaults +This lists the default templates used for notifications, such as emails from IdentityNow. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* + +### Return type +[**TemplateDtoDefault[]**](../models/template-dto-default) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of the default template objects | TemplateDtoDefault[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Filters = 'key eq "cloud_manual_work_item_summary"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + +# List Notification Template Defaults + +try { + Get-BetaNotificationTemplateDefaults + + # Below is a request that includes all optional parameters + # Get-BetaNotificationTemplateDefaults -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplateDefaults" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-notification-templates +This lists the templates that you have modified for your site. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* + +### Return type +[**TemplateDto[]**](../models/template-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of template objects for your site | TemplateDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Filters = 'medium eq "EMAIL"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + +# List Notification Templates + +try { + Get-BetaNotificationTemplates + + # Below is a request that includes all optional parameters + # Get-BetaNotificationTemplates -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplates" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-mail-from-attributes +Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller's DNS + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | MailFromAttributesDto | [**MailFromAttributesDto**](../models/mail-from-attributes-dto) | True | + +### Return type +[**MailFromAttributes**](../models/mail-from-attributes) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | MAIL FROM Attributes required to verify the change | MailFromAttributes +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$MailFromAttributesDto = @"{ + "identity" : "BobSmith@sailpoint.com", + "mailFromDomain" : "example.sailpoint.com" +}"@ + +# Change MAIL FROM domain + +try { + $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto + Send-BetaMailFromAttributes-BetaMailFromAttributesDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaMailFromAttributes -BetaMailFromAttributesDto $MailFromAttributesDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaMailFromAttributes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## send-test-notification +Send a Test Notification + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | SendTestNotificationRequestDto | [**SendTestNotificationRequestDto**](../models/send-test-notification-request-dto) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SendTestNotificationRequestDto = @"{ + "context" : "{}", + "medium" : "EMAIL", + "key" : "cloud_manual_work_item_summary" +}"@ + +# Send Test Notification + +try { + $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto + Send-BetaTestNotification-BetaSendTestNotificationRequestDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaTestNotification -BetaSendTestNotificationRequestDto $SendTestNotificationRequestDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTestNotification" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaOAuthClientsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaOAuthClientsApi.md new file mode 100644 index 000000000..6b3d0f2db --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaOAuthClientsApi.md @@ -0,0 +1,269 @@ + +--- +id: beta-o-auth-clients +title: OAuthClients +pagination_label: OAuthClients +sidebar_label: OAuthClients +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OAuthClients', 'BetaOAuthClients'] +slug: /tools/sdk/powershell/beta/methods/o-auth-clients +tags: ['SDK', 'Software Development Kit', 'OAuthClients', 'BetaOAuthClients'] +--- + +# OAuthClients + Use this API to implement OAuth client functionality. +With this functionality in place, users with the appropriate security scopes can create and configure OAuth clients to use as a way to obtain authorization to use the Identity Security Cloud REST API. +Refer to [Authentication](https://developer.sailpoint.com/docs/api/authentication/) for more information about OAuth and how it works with the Identity Security Cloud REST API. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaOauthClient**](#create-oauth-client) | **POST** `/oauth-clients` | Create OAuth Client +[**Remove-BetaOauthClient**](#delete-oauth-client) | **DELETE** `/oauth-clients/{id}` | Delete OAuth Client +[**Get-BetaOauthClient**](#get-oauth-client) | **GET** `/oauth-clients/{id}` | Get OAuth Client +[**Get-BetaOauthClients**](#list-oauth-clients) | **GET** `/oauth-clients` | List OAuth Clients +[**Update-BetaOauthClient**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch OAuth Client + +## create-oauth-client +This creates an OAuth client. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CreateOAuthClientRequest | [**CreateOAuthClientRequest**](../models/create-o-auth-client-request) | True | + +### Return type +[**CreateOAuthClientResponse**](../models/create-o-auth-client-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Request succeeded. | CreateOAuthClientResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CreateOAuthClientRequest = @"{ + "internal" : false, + "businessName" : "Acme-Solar", + "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", + "refreshTokenValiditySeconds" : 86400, + "type" : "CONFIDENTIAL", + "redirectUris" : [ "http://localhost:12345", "http://localhost:67890" ], + "enabled" : true, + "accessType" : "OFFLINE", + "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], + "strongAuthSupported" : false, + "homepageUrl" : "http://localhost:12345", + "accessTokenValiditySeconds" : 750, + "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], + "name" : "Demo API Client", + "claimsSupported" : false +}"@ + +# Create OAuth Client + +try { + $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest + New-BetaOauthClient-BetaCreateOAuthClientRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaOauthClient -BetaCreateOAuthClientRequest $CreateOAuthClientRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaOauthClient" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-oauth-client +This deletes an OAuth client. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The OAuth client id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + +# Delete OAuth Client + +try { + Remove-BetaOauthClient-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaOauthClient -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaOauthClient" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-oauth-client +This gets details of an OAuth client. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The OAuth client id + +### Return type +[**GetOAuthClientResponse**](../models/get-o-auth-client-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Request succeeded. | GetOAuthClientResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + +# Get OAuth Client + +try { + Get-BetaOauthClient-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaOauthClient -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOauthClient" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-oauth-clients +This gets a list of OAuth clients. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* + +### Return type +[**GetOAuthClientResponse[]**](../models/get-o-auth-client-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of OAuth clients. | GetOAuthClientResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + +# List OAuth Clients + +try { + Get-BetaOauthClients + + # Below is a request that includes all optional parameters + # Get-BetaOauthClients -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOauthClients" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-oauth-client +This performs a targeted update to the field(s) of an OAuth client. +Request will require a security scope of +- sp:oauth-client:manage + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The OAuth client id + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported + +### Return type +[**GetOAuthClientResponse**](../models/get-o-auth-client-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Indicates the PATCH operation succeeded, and returns the OAuth client's new representation. | GetOAuthClientResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported + + +# Patch OAuth Client + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaOauthClient-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaOauthClient -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaOauthClient" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaOrgConfigApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaOrgConfigApi.md new file mode 100644 index 000000000..ec0499b45 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaOrgConfigApi.md @@ -0,0 +1,156 @@ + +--- +id: beta-org-config +title: OrgConfig +pagination_label: OrgConfig +sidebar_label: OrgConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OrgConfig', 'BetaOrgConfig'] +slug: /tools/sdk/powershell/beta/methods/org-config +tags: ['SDK', 'Software Development Kit', 'OrgConfig', 'BetaOrgConfig'] +--- + +# OrgConfig + Use this API to implement organization configuration functionality. +Administrators can use this functionality to manage organization settings, such as time zones. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaOrgConfig**](#get-org-config) | **GET** `/org-config` | Get Org configuration settings +[**Get-BetaValidTimeZones**](#get-valid-time-zones) | **GET** `/org-config/valid-time-zones` | Get list of time zones +[**Update-BetaOrgConfig**](#patch-org-config) | **PATCH** `/org-config` | Patch an Org configuration property + +## get-org-config +Get org configuration with only external (org admin) accessible properties for the current org. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**OrgConfig**](../models/org-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Request succeeded. | OrgConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Org configuration settings + +try { + Get-BetaOrgConfig + + # Below is a request that includes all optional parameters + # Get-BetaOrgConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOrgConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-valid-time-zones +Get a list of valid time zones that can be set in org configurations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +**String[]** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Request successful | String[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get list of time zones + +try { + Get-BetaValidTimeZones + + # Below is a request that includes all optional parameters + # Get-BetaValidTimeZones +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaValidTimeZones" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-org-config +Patch configuration of the current org using http://jsonpatch.com/ syntax. Commonly used for changing the time zone of an org. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**OrgConfig**](../models/org-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Org was successfully patched. | OrgConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +# Patch an Org configuration property + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaOrgConfig-BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaOrgConfig -BetaJsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaOrgConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaPasswordConfigurationApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaPasswordConfigurationApi.md new file mode 100644 index 000000000..16384b0d3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaPasswordConfigurationApi.md @@ -0,0 +1,170 @@ + +--- +id: beta-password-configuration +title: PasswordConfiguration +pagination_label: PasswordConfiguration +sidebar_label: PasswordConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordConfiguration', 'BetaPasswordConfiguration'] +slug: /tools/sdk/powershell/beta/methods/password-configuration +tags: ['SDK', 'Software Development Kit', 'PasswordConfiguration', 'BetaPasswordConfiguration'] +--- + +# PasswordConfiguration + Use this API to implement organization password configuration functionality. +With this functionality in place, organization administrators can create organization-specific password configurations. + +These configurations include details like custom password instructions, as well as digit token length and duration. + +Refer to [Configuring User Authentication for Password Resets](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html) for more information about organization password configuration functionality. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaPasswordOrgConfig**](#create-password-org-config) | **POST** `/password-org-config` | Create Password Org Config +[**Get-BetaPasswordOrgConfig**](#get-password-org-config) | **GET** `/password-org-config` | Get Password Org Config +[**Send-BetaPasswordOrgConfig**](#put-password-org-config) | **PUT** `/password-org-config` | Update Password Org Config + +## create-password-org-config +This API creates the password org config. Unspecified fields will use default value. +To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true". +Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | PasswordOrgConfig | [**PasswordOrgConfig**](../models/password-org-config) | True | + +### Return type +[**PasswordOrgConfig**](../models/password-org-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password org config. | PasswordOrgConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$PasswordOrgConfig = @"{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true +}"@ + +# Create Password Org Config + +try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + New-BetaPasswordOrgConfig-BetaPasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # New-BetaPasswordOrgConfig -BetaPasswordOrgConfig $PasswordOrgConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordOrgConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-password-org-config +This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**PasswordOrgConfig**](../models/password-org-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password org config. | PasswordOrgConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Password Org Config + +try { + Get-BetaPasswordOrgConfig + + # Below is a request that includes all optional parameters + # Get-BetaPasswordOrgConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordOrgConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-password-org-config +This API updates the password org config for specified fields. Other fields will keep original value. +You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions. +Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | PasswordOrgConfig | [**PasswordOrgConfig**](../models/password-org-config) | True | + +### Return type +[**PasswordOrgConfig**](../models/password-org-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password org config. | PasswordOrgConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$PasswordOrgConfig = @"{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true +}"@ + +# Update Password Org Config + +try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + Send-BetaPasswordOrgConfig-BetaPasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaPasswordOrgConfig -BetaPasswordOrgConfig $PasswordOrgConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPasswordOrgConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaPasswordDictionaryApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaPasswordDictionaryApi.md new file mode 100644 index 000000000..6db7a8c21 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaPasswordDictionaryApi.md @@ -0,0 +1,211 @@ + +--- +id: beta-password-dictionary +title: PasswordDictionary +pagination_label: PasswordDictionary +sidebar_label: PasswordDictionary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordDictionary', 'BetaPasswordDictionary'] +slug: /tools/sdk/powershell/beta/methods/password-dictionary +tags: ['SDK', 'Software Development Kit', 'PasswordDictionary', 'BetaPasswordDictionary'] +--- + +# PasswordDictionary + Use this API to implement password dictionary functionality. +With this functionality in place, administrators can create password dictionaries to prevent users from using certain words or characters in their passwords. + +A password dictionary is a list of words or characters that users are prevented from including in their passwords. +This can help protect users from themselves and force them to create passwords that are not easy to break. + +A password dictionary must meet the following requirements to for the API to handle them correctly: + +- It must be in .txt format. + +- All characters must be UTF-8 characters. + +- Each line must contain a single word or character with no spaces or whitespace characters. + +- It must contain at least one line other than the locale string. + +- Each line must not exceed 128 characters. + +- The file must not exceed 2500 lines. + +Administrators should also consider the following when they create their dictionaries: + +- Lines starting with a # represent comments. + +- All words in the password dictionary are case-insensitive. +For example, adding the word "password" to the dictionary also disallows the following: PASSWORD, Password, and PassWord. + +- The dictionary uses substring matching. +For example, adding the word "spring" to the dictionary also disallows the following: Spring124, 345SprinG, and 8spring. +Users can then select 'Change Password' to update their passwords. + +Administrators must do the following to create a password dictionary: + +- Create the text file that will contain the prohibited password values. + +- If the dictionary is not in English, they must add a locale string to the top line: locale:`languageCode`_`countryCode` + +The languageCode value refers to the language's 2-letter ISO 639-1 code. +The countryCode value refers to the country's 2-letter ISO 3166-1 code. + +Refer to this list https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html to see all the available ISO 639-1 language codes and ISO 3166-1 country codes. + +- Upload the .txt file to Identity Security Cloud with [Update Password Dictionary](https://developer.sailpoint.com/docs/api/beta/put-password-dictionary). Uploading a new file always overwrites the previous dictionary file. + +Administrators can then specify which password policies check new passwords against the password dictionary by doing the following: In the Admin panel, they can use the Password Mgmt dropdown menu to select Policies, select the policy, and select the 'Prevent use of words in this site's password dictionary' checkbox beside it. + +Refer to [Configuring Advanced Password Management Options](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html) for more information about password dictionaries. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaPasswordDictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get Password Dictionary +[**Send-BetaPasswordDictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update Password Dictionary + +## get-password-dictionary +This gets password dictionary for the organization. +The password dictionary file can contain lines that are: +1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing +2. empty lines +3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines +4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + +Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + +# Sample password text file + +``` + +# Password dictionary small test file + +locale=en_US + +# Password dictionary prohibited words + +qwerty +abcd +aaaaa +password +qazxsws + +``` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +**String** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A password dictionary response | String +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: text/plain, application/json + +### Example +```powershell + +# Get Password Dictionary + +try { + Get-BetaPasswordDictionary + + # Below is a request that includes all optional parameters + # Get-BetaPasswordDictionary +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordDictionary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-password-dictionary +This updates password dictionary for the organization. +The password dictionary file can contain lines that are: +1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing +2. empty lines +3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines +4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + +Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + +# Sample password text file + +``` + +# Password dictionary small test file + +locale=en_US + +# Password dictionary prohibited words + +qwerty +abcd +aaaaa +password +qazxsws + +``` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | File | **System.IO.FileInfo** | (optional) | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully updated. | +201 | Created. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$File = # System.IO.FileInfo | (optional) + +# Update Password Dictionary + +try { + Send-BetaPasswordDictionary + + # Below is a request that includes all optional parameters + # Send-BetaPasswordDictionary -BetaFile $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPasswordDictionary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaPasswordManagementApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaPasswordManagementApi.md new file mode 100644 index 000000000..ed6978699 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaPasswordManagementApi.md @@ -0,0 +1,284 @@ + +--- +id: beta-password-management +title: PasswordManagement +pagination_label: PasswordManagement +sidebar_label: PasswordManagement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordManagement', 'BetaPasswordManagement'] +slug: /tools/sdk/powershell/beta/methods/password-management +tags: ['SDK', 'Software Development Kit', 'PasswordManagement', 'BetaPasswordManagement'] +--- + +# PasswordManagement + Use this API to implement password management functionality. +With this functionality in place, users can manage their identity passwords for all their applications. + +In Identity Security Cloud, users can select their names in the upper right corner of the page and use the drop-down menu to select Password Manager. +Password Manager lists the user's identity's applications, possibly grouped to share passwords. +Users can then select 'Change Password' to update their passwords. + +Grouping passwords allows users to update their passwords more broadly, rather than requiring them to update each password individually. +Password Manager may list the applications and sources in the following groups: + +- Password Group: This refers to a group of applications that share a password. +For example, a user can use the same password for Google Drive, Google Mail, and YouTube. +Updating the password for the password group updates the password for all its included applications. + +- Multi-Application Source: This refers to a source with multiple applications that share a password. +For example, a user can have a source, G Suite, that includes the Google Calendar, Google Drive, and Google Mail applications. +Updating the password for the multi-application source updates the password for all its included applications. + +- Applications: These are applications that do not share passwords with other applications. + +An organization may require some authentication for users to update their passwords. +Users may be required to answer security questions or use a third-party authenticator before they can confirm their updates. + +Refer to [Managing Passwords](https://documentation.sailpoint.com/saas/user-help/accounts/passwords.html) for more information about password management. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaDigitToken**](#create-digit-token) | **POST** `/generate-password-reset-token/digit` | Generate a digit token +[**Get-BetaIdentityPasswordChangeStatus**](#get-identity-password-change-status) | **GET** `/password-change-status/{id}` | Get Password Change Request Status +[**Search-BetaPasswordInfo**](#query-password-info) | **POST** `/query-password-info` | Query Password Info +[**Set-BetaIdentityPassword**](#set-identity-password) | **POST** `/set-password` | Set Identity's Password + +## create-digit-token +This API is used to generate a digit token for password management. Requires authorization scope of "idn:password-digit-token:create". + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | PasswordDigitTokenReset | [**PasswordDigitTokenReset**](../models/password-digit-token-reset) | True | + +### Return type +[**PasswordDigitToken**](../models/password-digit-token) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The digit token for password management. | PasswordDigitToken +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$PasswordDigitTokenReset = @"{ + "durationMinutes" : 5, + "length" : 8, + "userId" : "Abby.Smith" +}"@ + +# Generate a digit token + +try { + $Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset + New-BetaDigitToken-BetaPasswordDigitTokenReset $Result + + # Below is a request that includes all optional parameters + # New-BetaDigitToken -BetaPasswordDigitTokenReset $PasswordDigitTokenReset +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDigitToken" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-password-change-status +This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | + +### Return type +[**PasswordStatus**](../models/password-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Status of the password change request | PasswordStatus +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "MyId" # String | + +# Get Password Change Request Status + +try { + Get-BetaIdentityPasswordChangeStatus-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentityPasswordChangeStatus -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityPasswordChangeStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## query-password-info +This API is used to query password related information. + +A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) +is required to call this API. "API authority" refers to a token that only has the "client_credentials" +grant type, and therefore no user context. A [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) +or a token generated with the [authorization_code](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) +grant type will **NOT** work on this endpoint, and a `403 Forbidden` response +will be returned. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | PasswordInfoQueryDTO | [**PasswordInfoQueryDTO**](../models/password-info-query-dto) | True | + +### Return type +[**PasswordInfo**](../models/password-info) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password info. | PasswordInfo +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$PasswordInfoQueryDTO = @"{ + "sourceName" : "My-AD", + "userName" : "Abby.Smith" +}"@ + +# Query Password Info + +try { + $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO + Search-BetaPasswordInfo-BetaPasswordInfoQueryDTO $Result + + # Below is a request that includes all optional parameters + # Search-BetaPasswordInfo -BetaPasswordInfoQueryDTO $PasswordInfoQueryDTO +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaPasswordInfo" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-identity-password +This API is used to set a password for an identity. + +An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). + +A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity's password or the password of any of the identity's accounts. +"API authority" refers to a token that only has the "client_credentials" grant type. + +>**Note: If you want to set an identity's source account password, you must enable `PASSWORD` as one of the source's features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** + +You can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). +To do so, follow these steps: + +1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. + +2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. + +3. Use [Set Identity's Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password: + +```java +import javax.crypto.Cipher; +import java.security.KeyFactory; +import java.security.PublicKey; +import java.security.spec.X509EncodedKeySpec; +import java util.Base64; + +String encrypt(String publicKey, String toEncrypt) throws Exception { + byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey); + byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes("UTF-8")); + return Base64.getEncoder().encodeToString(encryptedBytes); +} + +private byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception { + PublicKey key = KeyFactory.getInstance("RSA").generatePublic(new X509EncodedKeySpec(publicKeyBytes)); + String transformation = "RSA/ECB/PKCS1Padding"; + Cipher cipher = Cipher.getInstance(transformation); + cipher.init(1, key); + return cipher.doFinal(toEncryptBytes); +} +``` + +In this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. + +You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | PasswordChangeRequest | [**PasswordChangeRequest**](../models/password-change-request) | True | + +### Return type +[**PasswordChangeResponse**](../models/password-change-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Reference to the password change. | PasswordChangeResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$PasswordChangeRequest = @"{ + "sourceId" : "8a807d4c73c545510173c545d4b60246", + "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "identityId" : "8a807d4c73c545510173c545f0a002ff", + "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" +}"@ + +# Set Identity's Password + +try { + $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest + Set-BetaIdentityPassword-BetaPasswordChangeRequest $Result + + # Below is a request that includes all optional parameters + # Set-BetaIdentityPassword -BetaPasswordChangeRequest $PasswordChangeRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaIdentityPassword" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaPasswordPoliciesApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaPasswordPoliciesApi.md new file mode 100644 index 000000000..c9f607d12 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaPasswordPoliciesApi.md @@ -0,0 +1,322 @@ + +--- +id: beta-password-policies +title: PasswordPolicies +pagination_label: PasswordPolicies +sidebar_label: PasswordPolicies +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordPolicies', 'BetaPasswordPolicies'] +slug: /tools/sdk/powershell/beta/methods/password-policies +tags: ['SDK', 'Software Development Kit', 'PasswordPolicies', 'BetaPasswordPolicies'] +--- + +# PasswordPolicies + Use these APIs to implement password policies functionality. +These APIs allow you to define the policy parameters for choosing passwords. + +IdentityNow comes with a default policy that you can modify to define the password requirements your users must meet to log in to IdentityNow, such as requiring a minimum password length, including special characters, and disallowing certain patterns. +If you have licensed Password Management, you can create additional password policies beyond the default one to manage passwords for supported sources in your org. + +In the Identity Security Cloud Admin panel, administrators can use the Password Mgmt dropdown menu to select Sync Groups. + +Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/pwd_policies/pwd_policies.html) for more information about password policies. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaPasswordPolicy**](#create-password-policy) | **POST** `/password-policies` | Create Password Policy +[**Remove-BetaPasswordPolicy**](#delete-password-policy) | **DELETE** `/password-policies/{id}` | Delete Password Policy by ID +[**Get-BetaPasswordPolicyById**](#get-password-policy-by-id) | **GET** `/password-policies/{id}` | Get Password Policy by ID +[**Get-BetaPasswordPolicies**](#list-password-policies) | **GET** `/password-policies` | List Password Policies +[**Set-BetaPasswordPolicy**](#set-password-policy) | **PUT** `/password-policies/{id}` | Update Password Policy by ID + +## create-password-policy +This API creates the specified password policy. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | PasswordPolicyV3Dto | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | True | + +### Return type +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password policy. | PasswordPolicyV3Dto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$PasswordPolicyV3Dto = @"{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 +}"@ + +# Create Password Policy + +try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + New-BetaPasswordPolicy-BetaPasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # New-BetaPasswordPolicy -BetaPasswordPolicyV3Dto $PasswordPolicyV3Dto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-password-policy +This API deletes the specified password policy. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of password policy to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. + +# Delete Password Policy by ID + +try { + Remove-BetaPasswordPolicy-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaPasswordPolicy -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-password-policy-by-id +This API returns the password policy for the specified ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of password policy to retrieve. + +### Return type +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password policy. | PasswordPolicyV3Dto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. + +# Get Password Policy by ID + +try { + Get-BetaPasswordPolicyById-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaPasswordPolicyById -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordPolicyById" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-password-policies +This gets list of all Password Policies. +Requires role of ORG_ADMIN + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**PasswordPolicyV3Dto[]**](../models/password-policy-v3-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of all Password Policies. | PasswordPolicyV3Dto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# List Password Policies + +try { + Get-BetaPasswordPolicies + + # Below is a request that includes all optional parameters + # Get-BetaPasswordPolicies -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordPolicies" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-password-policy +This API updates the specified password policy. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of password policy to update. + Body | PasswordPolicyV3Dto | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | True | + +### Return type +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password policy. | PasswordPolicyV3Dto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update. +$PasswordPolicyV3Dto = @"{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 +}"@ + +# Update Password Policy by ID + +try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + Set-BetaPasswordPolicy-BetaId $Id -BetaPasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # Set-BetaPasswordPolicy -BetaId $Id -BetaPasswordPolicyV3Dto $PasswordPolicyV3Dto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaPasswordPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaPasswordSyncGroupsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaPasswordSyncGroupsApi.md new file mode 100644 index 000000000..34b507516 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaPasswordSyncGroupsApi.md @@ -0,0 +1,292 @@ + +--- +id: beta-password-sync-groups +title: PasswordSyncGroups +pagination_label: PasswordSyncGroups +sidebar_label: PasswordSyncGroups +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordSyncGroups', 'BetaPasswordSyncGroups'] +slug: /tools/sdk/powershell/beta/methods/password-sync-groups +tags: ['SDK', 'Software Development Kit', 'PasswordSyncGroups', 'BetaPasswordSyncGroups'] +--- + +# PasswordSyncGroups + Use this API to implement password sync group functionality. +With this functionality in place, administrators can group sources into password sync groups so that all their applications share the same password. +This allows users to update the password for all the applications in a sync group if they want, rather than updating each password individually. + +A password sync group is a group of applications that shares a password. +Administrators create these groups by grouping the applications' sources. +For example, an administrator can group the ActiveDirectory, GitHub, and G Suite sources together so that all those sources' applications can also be grouped to share a password. +A user can then update his or her password for ActiveDirectory, GitHub, Gmail, Google Drive, and Google Calendar all at once, rather then updating each one individually. + +The following are required for administrators to create a password sync group in Identity Security Cloud: + +- At least two direct connect sources connected to Identity Security Cloud and configured for Password Management. + +- Each authentication source in a sync group must have at least one application. Refer to [Adding and Resetting Application Passwords](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html#adding-and-resetting-application-passwords) for more information about adding applications to sources. + +- At least one password policy. Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/policies.html) for more information about password policies. + +In the Admin panel in Identity Security Cloud, administrators can use the Password Mgmt dropdown menu to select Sync Groups. +To create a sync group, administrators must provide a name, choose a password policy to be enforced across the sources in the sync group, and select the sources to include in the sync group. + +Administrators can also delete sync groups in Identity Security Cloud, but they should know the following before they do: + +- Passwords related to the associated sources will become independent, so changing one will not change the others anymore. + +- Passwords for the sources' connected applications will also become independent. + +- Password policies assigned to the sync group are then assigned directly to the associated sources. +To change the password policy for a source, administrators must edit it directly. + +Once the password sync group has been created, users can update the password for the group in Password Manager. + +Refer to [Managing Password Sync Groups](https://documentation.sailpoint.com/saas/help/pwd/sync_grps.html) for more information about password sync groups. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaPasswordSyncGroup**](#create-password-sync-group) | **POST** `/password-sync-groups` | Create Password Sync Group +[**Remove-BetaPasswordSyncGroup**](#delete-password-sync-group) | **DELETE** `/password-sync-groups/{id}` | Delete Password Sync Group by ID +[**Get-BetaPasswordSyncGroup**](#get-password-sync-group) | **GET** `/password-sync-groups/{id}` | Get Password Sync Group by ID +[**Get-BetaPasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get Password Sync Group List +[**Update-BetaPasswordSyncGroup**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update Password Sync Group by ID + +## create-password-sync-group +This API creates a password sync group based on the specifications provided. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | PasswordSyncGroup | [**PasswordSyncGroup**](../models/password-sync-group) | True | + +### Return type +[**PasswordSyncGroup**](../models/password-sync-group) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password sync group. | PasswordSyncGroup +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$PasswordSyncGroup = @"{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] +}"@ + +# Create Password Sync Group + +try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + New-BetaPasswordSyncGroup-BetaPasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # New-BetaPasswordSyncGroup -BetaPasswordSyncGroup $PasswordSyncGroup +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordSyncGroup" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-password-sync-group +This API deletes the specified password sync group. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of password sync group to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. + +# Delete Password Sync Group by ID + +try { + Remove-BetaPasswordSyncGroup-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaPasswordSyncGroup -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordSyncGroup" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-password-sync-group +This API returns the sync group for the specified ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of password sync group to retrieve. + +### Return type +[**PasswordSyncGroup**](../models/password-sync-group) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password sync group. | PasswordSyncGroup +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. + +# Get Password Sync Group by ID + +try { + Get-BetaPasswordSyncGroup-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaPasswordSyncGroup -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroup" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-password-sync-groups +This API returns a list of password sync groups. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**PasswordSyncGroup[]**](../models/password-sync-group) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of password sync groups. | PasswordSyncGroup[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Get Password Sync Group List + +try { + Get-BetaPasswordSyncGroups + + # Below is a request that includes all optional parameters + # Get-BetaPasswordSyncGroups -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroups" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-password-sync-group +This API updates the specified password sync group. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of password sync group to update. + Body | PasswordSyncGroup | [**PasswordSyncGroup**](../models/password-sync-group) | True | + +### Return type +[**PasswordSyncGroup**](../models/password-sync-group) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password sync group. | PasswordSyncGroup +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to update. +$PasswordSyncGroup = @"{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] +}"@ + +# Update Password Sync Group by ID + +try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + Update-BetaPasswordSyncGroup-BetaId $Id -BetaPasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # Update-BetaPasswordSyncGroup -BetaId $Id -BetaPasswordSyncGroup $PasswordSyncGroup +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPasswordSyncGroup" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaPersonalAccessTokensApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaPersonalAccessTokensApi.md new file mode 100644 index 000000000..b828a2296 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaPersonalAccessTokensApi.md @@ -0,0 +1,221 @@ + +--- +id: beta-personal-access-tokens +title: PersonalAccessTokens +pagination_label: PersonalAccessTokens +sidebar_label: PersonalAccessTokens +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PersonalAccessTokens', 'BetaPersonalAccessTokens'] +slug: /tools/sdk/powershell/beta/methods/personal-access-tokens +tags: ['SDK', 'Software Development Kit', 'PersonalAccessTokens', 'BetaPersonalAccessTokens'] +--- + +# PersonalAccessTokens + Use this API to implement personal access token (PAT) functionality. +With this functionality in place, users can use PATs as an alternative to passwords for authentication in Identity Security Cloud. + +PATs embed user information into the client ID and secret. +This replaces the API clients' need to store and provide a username and password to establish a connection, improving Identity Security Cloud organizations' integration security. + +In Identity Security Cloud, users can do the following to create and manage their PATs: Select the dropdown menu under their names, select Preferences, and then select Personal Access Tokens. +They must then provide a description about the token's purpose. +They can then select 'Create Token' at the bottom of the page to generate and view the Secret and Client ID. + +Refer to [Managing Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/generate_tokens.html) for more information about PATs. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaPersonalAccessToken**](#create-personal-access-token) | **POST** `/personal-access-tokens` | Create Personal Access Token +[**Remove-BetaPersonalAccessToken**](#delete-personal-access-token) | **DELETE** `/personal-access-tokens/{id}` | Delete Personal Access Token +[**Get-BetaPersonalAccessTokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List Personal Access Tokens +[**Update-BetaPersonalAccessToken**](#patch-personal-access-token) | **PATCH** `/personal-access-tokens/{id}` | Patch Personal Access Token + +## create-personal-access-token +This creates a personal access token. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CreatePersonalAccessTokenRequest | [**CreatePersonalAccessTokenRequest**](../models/create-personal-access-token-request) | True | Name and scope of personal access token. + +### Return type +[**CreatePersonalAccessTokenResponse**](../models/create-personal-access-token-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Created. Note - this is the only time Personal Access Tokens' secret attribute will be displayed. | CreatePersonalAccessTokenResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CreatePersonalAccessTokenRequest = @"{ + "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], + "accessTokenValiditySeconds" : 36900, + "name" : "NodeJS Integration" +}"@ + +# Create Personal Access Token + +try { + $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest + New-BetaPersonalAccessToken-BetaCreatePersonalAccessTokenRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaPersonalAccessToken -BetaCreatePersonalAccessTokenRequest $CreatePersonalAccessTokenRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPersonalAccessToken" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-personal-access-token +This deletes a personal access token. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The personal access token id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id + +# Delete Personal Access Token + +try { + Remove-BetaPersonalAccessToken-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaPersonalAccessToken -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPersonalAccessToken" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-personal-access-tokens +This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | OwnerId | **String** | (optional) | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* + +### Return type +[**GetPersonalAccessTokenResponse[]**](../models/get-personal-access-token-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of personal access tokens. | GetPersonalAccessTokenResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OwnerId = "2c9180867b50d088017b554662fb281e" # String | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) +$Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + +# List Personal Access Tokens + +try { + Get-BetaPersonalAccessTokens + + # Below is a request that includes all optional parameters + # Get-BetaPersonalAccessTokens -BetaOwnerId $OwnerId -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPersonalAccessTokens" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-personal-access-token +This performs a targeted update to the field(s) of a Personal Access Token. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The Personal Access Token id + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope + +### Return type +[**GetPersonalAccessTokenResponse**](../models/get-personal-access-token-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Indicates the PATCH operation succeeded, and returns the PAT's new representation. | GetPersonalAccessTokenResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope + + +# Patch Personal Access Token + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaPersonalAccessToken-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaPersonalAccessToken -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPersonalAccessToken" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaPublicIdentitiesConfigApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaPublicIdentitiesConfigApi.md new file mode 100644 index 000000000..269ad9262 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaPublicIdentitiesConfigApi.md @@ -0,0 +1,130 @@ + +--- +id: beta-public-identities-config +title: PublicIdentitiesConfig +pagination_label: PublicIdentitiesConfig +sidebar_label: PublicIdentitiesConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PublicIdentitiesConfig', 'BetaPublicIdentitiesConfig'] +slug: /tools/sdk/powershell/beta/methods/public-identities-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentitiesConfig', 'BetaPublicIdentitiesConfig'] +--- + +# PublicIdentitiesConfig + Use this API to implement public identity configuration functionality. +With this functionality in place, administrators can make up to 5 identity attributes publicly visible so other non-administrator users can see the relevant information they need to make decisions. +This can be helpful for access approvers, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. + +By default, non-administrators can select an identity and view the following attributes: email, lifecycle state, and manager. +However, it may be helpful for a non-administrator reviewer to see other identity attributes like department, region, title, etc. +Administrators can use this API to make those necessary identity attributes public to non-administrators. + +For example, a non-administrator deciding whether to approve another identity's request for access to the Workday application, whose access may be restricted to members of the HR department, would want to know whether the identity is a member of the HR department. +If an administrator has used [Update Public Identity Config](https://developer.sailpoint.com/docs/api/beta/update-public-identity-config/) to make the "department" attribute public, the approver can see the department and make a decision without requesting any more information. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaPublicIdentityConfig**](#get-public-identity-config) | **GET** `/public-identities-config` | Get Public Identity Config +[**Update-BetaPublicIdentityConfig**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update Public Identity Config + +## get-public-identity-config +This gets details of public identity config. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**PublicIdentityConfig**](../models/public-identity-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Request succeeded. | PublicIdentityConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Public Identity Config + +try { + Get-BetaPublicIdentityConfig + + # Below is a request that includes all optional parameters + # Get-BetaPublicIdentityConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPublicIdentityConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-public-identity-config +This updates the details of public identity config. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | PublicIdentityConfig | [**PublicIdentityConfig**](../models/public-identity-config) | True | + +### Return type +[**PublicIdentityConfig**](../models/public-identity-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Request succeeded. | PublicIdentityConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$PublicIdentityConfig = @"{ + "modified" : "2018-06-25T20:22:28.104Z", + "attributes" : [ { + "name" : "Country", + "key" : "country" + }, { + "name" : "Country", + "key" : "country" + } ], + "modifiedBy" : { + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } +}"@ + +# Update Public Identity Config + +try { + $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig + Update-BetaPublicIdentityConfig-BetaPublicIdentityConfig $Result + + # Below is a request that includes all optional parameters + # Update-BetaPublicIdentityConfig -BetaPublicIdentityConfig $PublicIdentityConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPublicIdentityConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaRequestableObjectsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaRequestableObjectsApi.md new file mode 100644 index 000000000..f29a7ae3d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaRequestableObjectsApi.md @@ -0,0 +1,88 @@ + +--- +id: beta-requestable-objects +title: RequestableObjects +pagination_label: RequestableObjects +sidebar_label: RequestableObjects +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestableObjects', 'BetaRequestableObjects'] +slug: /tools/sdk/powershell/beta/methods/requestable-objects +tags: ['SDK', 'Software Development Kit', 'RequestableObjects', 'BetaRequestableObjects'] +--- + +# RequestableObjects + Use this API to implement requestable object functionality. +With this functionality in place, administrators can determine which access items can be requested with the [Access Request APIs](https://developer.sailpoint.com/docs/api/beta/access-requests/), along with their statuses. +This can be helpful for administrators who are implementing and customizing access request functionality as a way of checking which items are requestable as they are created, assigned, and made available. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaRequestableObjects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable Objects List + +## list-requestable-objects +This endpoint returns a list of acccess items that that can be requested through the Access Request endpoints. Access items are marked with AVAILABLE, PENDING or ASSIGNED with respect to the identity provided using *identity-id* query param. +Any authenticated token can call this endpoint to see their requestable access items. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | IdentityId | **String** | (optional) | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. + Query | Types | [**[]RequestableObjectType**](../models/requestable-object-type) | (optional) | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. + Query | Term | **String** | (optional) | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. + Query | Statuses | [**[]RequestableObjectRequestStatus**](../models/requestable-object-request-status) | (optional) | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** + +### Return type +[**RequestableObject[]**](../models/requestable-object) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of requestable objects | RequestableObject[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) +$Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. (optional) + +$Types = @"ROLE,ACCESS_PROFILE"@ # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. (optional) +$Term = "Finance Role" # String | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) +$Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional) + +$Statuses = @"[ASSIGNED, PENDING]"@ # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'name sw "bob"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + +# Requestable Objects List + +try { + Get-BetaRequestableObjects + + # Below is a request that includes all optional parameters + # Get-BetaRequestableObjects -BetaIdentityId $IdentityId -BetaTypes $Types -BetaTerm $Term -BetaStatuses $Statuses -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRequestableObjects" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaRoleInsightsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaRoleInsightsApi.md new file mode 100644 index 000000000..e0edac38e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaRoleInsightsApi.md @@ -0,0 +1,429 @@ + +--- +id: beta-role-insights +title: RoleInsights +pagination_label: RoleInsights +sidebar_label: RoleInsights +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsights', 'BetaRoleInsights'] +slug: /tools/sdk/powershell/beta/methods/role-insights +tags: ['SDK', 'Software Development Kit', 'RoleInsights', 'BetaRoleInsights'] +--- + +# RoleInsights + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaRoleInsightRequests**](#create-role-insight-requests) | **POST** `/role-insights/requests` | Generate insights for roles +[**Invoke-BetaDownloadRoleInsightsEntitlementsChanges**](#download-role-insights-entitlements-changes) | **GET** `/role-insights/{insightId}/entitlement-changes/download` | Download entitlement insights for a role +[**Get-BetaEntitlementChangesIdentities**](#get-entitlement-changes-identities) | **GET** `/role-insights/{insightId}/entitlement-changes/{entitlementId}/identities` | Get identities for a suggested entitlement (for a role) +[**Get-BetaRoleInsight**](#get-role-insight) | **GET** `/role-insights/{insightId}` | Get a single role insight +[**Get-BetaRoleInsights**](#get-role-insights) | **GET** `/role-insights` | Get role insights +[**Get-BetaRoleInsightsCurrentEntitlements**](#get-role-insights-current-entitlements) | **GET** `/role-insights/{insightId}/current-entitlements` | Get current entitlement for a role +[**Get-BetaRoleInsightsEntitlementsChanges**](#get-role-insights-entitlements-changes) | **GET** `/role-insights/{insightId}/entitlement-changes` | Get entitlement insights for a role +[**Get-BetaRoleInsightsRequests**](#get-role-insights-requests) | **GET** `/role-insights/requests/{id}` | Returns metadata from prior request. +[**Get-BetaRoleInsightsSummary**](#get-role-insights-summary) | **GET** `/role-insights/summary` | Get role insights summary information + +## create-role-insight-requests +Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**RoleInsightsResponse**](../models/role-insights-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Submitted a role insights generation request | RoleInsightsResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Generate insights for roles + +try { + New-BetaRoleInsightRequests + + # Below is a request that includes all optional parameters + # New-BetaRoleInsightRequests +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRoleInsightRequests" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## download-role-insights-entitlements-changes +This endpoint returns the entitlement insights for a role. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | InsightId | **String** | True | The role insight id + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* + +### Return type +**String** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a csv file containing a list of entitlements to be added for a role. | String +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: text/csv, application/json + +### Example +```powershell +$InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id +$Sorters = "identitiesWithAccess" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) +$Filters = 'name sw "r"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + +# Download entitlement insights for a role + +try { + Invoke-BetaDownloadRoleInsightsEntitlementsChanges-BetaInsightId $InsightId + + # Below is a request that includes all optional parameters + # Invoke-BetaDownloadRoleInsightsEntitlementsChanges -BetaInsightId $InsightId -BetaSorters $Sorters -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaDownloadRoleInsightsEntitlementsChanges" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-entitlement-changes-identities +Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | InsightId | **String** | True | The role insight id +Path | EntitlementId | **String** | True | The entitlement id + Query | HasEntitlement | **Boolean** | (optional) (default to $false) | Identity has this entitlement or not + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* + +### Return type +[**RoleInsightsIdentities[]**](../models/role-insights-identities) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of identities with or without the entitlement. | RoleInsightsIdentities[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id +$EntitlementId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The entitlement id +$HasEntitlement = $true # Boolean | Identity has this entitlement or not (optional) (default to $false) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) +$Filters = 'name sw "Jan"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) + +# Get identities for a suggested entitlement (for a role) + +try { + Get-BetaEntitlementChangesIdentities-BetaInsightId $InsightId -BetaEntitlementId $EntitlementId + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementChangesIdentities -BetaInsightId $InsightId -BetaEntitlementId $EntitlementId -BetaHasEntitlement $HasEntitlement -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementChangesIdentities" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-insight +This endpoint gets role insights information for a role. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | InsightId | **String** | True | The role insight id + +### Return type +[**RoleInsight**](../models/role-insight) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns information about insights for a single role. | RoleInsight +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + +# Get a single role insight + +try { + Get-BetaRoleInsight-BetaInsightId $InsightId + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsight -BetaInsightId $InsightId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsight" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-insights +This method returns detailed role insights for each role. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* + +### Return type +[**RoleInsight[]**](../models/role-insight) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of roles with information about insights for each role. | RoleInsight[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "numberOfUpdates" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) +$Filters = 'name sw "John"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) + +# Get role insights + +try { + Get-BetaRoleInsights + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsights -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsights" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-insights-current-entitlements +This endpoint gets the entitlements for a role. The term "current" is to distinguish from the entitlement(s) an insight might recommend adding. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | InsightId | **String** | True | The role insight id + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* + +### Return type +[**RoleInsightsEntitlement[]**](../models/role-insights-entitlement) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of current or pre-existing entitlements for a role. | RoleInsightsEntitlement[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id +$Filters = 'name sw "r"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + +# Get current entitlement for a role + +try { + Get-BetaRoleInsightsCurrentEntitlements-BetaInsightId $InsightId + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsightsCurrentEntitlements -BetaInsightId $InsightId -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsCurrentEntitlements" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-insights-entitlements-changes +This endpoint returns entitlement insights for a role. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | InsightId | **String** | True | The role insight id + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* + +### Return type +[**RoleInsightsEntitlementChanges[]**](../models/role-insights-entitlement-changes) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of entitlements to be added for a role. | RoleInsightsEntitlementChanges[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id +$Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) +$Filters = 'name sw "Admin"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + +# Get entitlement insights for a role + +try { + Get-BetaRoleInsightsEntitlementsChanges-BetaInsightId $InsightId + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsightsEntitlementsChanges -BetaInsightId $InsightId -BetaSorters $Sorters -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsEntitlementsChanges" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-insights-requests +This endpoint returns details of a prior role insights request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The role insights request id + +### Return type +[**RoleInsightsResponse**](../models/role-insights-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns details of an earlier role insights request. | RoleInsightsResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insights request id + +# Returns metadata from prior request. + +try { + Get-BetaRoleInsightsRequests-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsightsRequests -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsRequests" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-insights-summary +This method returns high level summary information for role insights for a customer. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**RoleInsightsSummary**](../models/role-insights-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns high level counts. | RoleInsightsSummary +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get role insights summary information + +try { + Get-BetaRoleInsightsSummary + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsightsSummary +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsSummary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaRolesApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaRolesApi.md new file mode 100644 index 000000000..da17abc47 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaRolesApi.md @@ -0,0 +1,641 @@ + +--- +id: beta-roles +title: Roles +pagination_label: Roles +sidebar_label: Roles +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Roles', 'BetaRoles'] +slug: /tools/sdk/powershell/beta/methods/roles +tags: ['SDK', 'Software Development Kit', 'Roles', 'BetaRoles'] +--- + +# Roles + Use this API to implement and customize role functionality. +With this functionality in place, administrators can create roles and configure them for use throughout Identity Security Cloud. +Identity Security Cloud can use established criteria to automatically assign the roles to qualified users. This enables users to get all the access they need quickly and securely and administrators to spend their time on other tasks. + +Entitlements represent the most granular level of access in Identity Security Cloud. +Access profiles represent the next level and often group entitlements. +Roles represent the broadest level of access and often group access profiles. + +For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +An administrator can then create an even broader set of access in the form of a role grouping the 'AD Developers' access profile with another profile, 'GitHub Developers,' grouping entitlements for the GitHub source. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +When users need both the 'AD Developers' access profile and the 'GitHub Developers' access profile, they can request access to the role grouping both. + +Roles often represent positions within organizations. +For example, an organization's accountant can access all the tools the organization's accountants need with the 'Accountant' role. +If the accountant switches to engineering, a qualified member of the organization can quickly revoke the accountant's 'Accountant' access and grant access to the 'Engineer' role instead, granting access to all the tools the organization's engineers need. + +In Identity Security Cloud, adminstrators can use the Access drop-down menu and select Roles to view, configure, and delete existing roles, as well as create new ones. +Administrators can enable and disable the role, and they can also make the following configurations: + +- Manage Access: Manage the role's access by adding or removing access profiles. + +- Define Assignment: Define the criteria Identity Security Cloud uses to assign the role to identities. +Use the first option, 'Standard Criteria,' to provide specific criteria for assignment like specific account attributes, entitlements, or identity attributes. +Use the second, 'Identity List,' to specify the identities for assignment. + +- Access Requests: Configure roles to be requestable and establish an approval process for any requests that the role be granted or revoked. +Do not configure a role to be requestable without establishing a secure access request approval process for that role first. + +Refer to [Working with Roles](https://documentation.sailpoint.com/saas/help/access/roles.html) for more information about roles. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaRole**](#create-role) | **POST** `/roles` | Create a Role +[**Remove-BetaBulkRoles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete Role(s) +[**Remove-BetaRole**](#delete-role) | **DELETE** `/roles/{id}` | Delete a Role +[**Get-BetaRole**](#get-role) | **GET** `/roles/{id}` | Get a Role +[**Get-BetaRoleAssignedIdentities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | Identities assigned a Role +[**Get-BetaRoleEntitlements**](#get-role-entitlements) | **GET** `/roles/{id}/entitlements` | List role's Entitlements +[**Get-BetaRoles**](#list-roles) | **GET** `/roles` | List Roles +[**Update-BetaRole**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified Role + +## create-role +This API creates a role. + +You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. + +In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. + +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Role | [**Role**](../models/role) | True | + +### Return type +[**Role**](../models/role) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Role created | Role +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Role = @"{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "dimensional" : false, + "created" : "2021-03-01T22:32:58.104Z", + "dimensionRefs" : [ { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + }, { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + } ], + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "membership" : { + "identities" : [ { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } ], + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, + "type" : "IDENTITY_LIST" + }, + "enabled" : true, + "revocationRequestConfig" : { + "commentsRequired" : false, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : false + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "legacyMembershipInfo" : { + "type" : "IDENTITY_LIST" + }, + "accessRequestConfig" : { + "commentsRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "name" : "Role 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "accessModelMetadata" : { + "attributes" : [ { + "key" : "iscPrivacy", + "name" : "Privacy", + "multiselect" : false, + "status" : "active", + "type" : "governance", + "objectTypes" : [ "all" ], + "description" : "Specifies the level of privacy associated with an access item.", + "values" : [ { + "value" : "public", + "name" : "Public", + "status" : "active" + } ] + } ] + }, + "id" : "2c918086749d78830174a1a40e121518", + "requestable" : true +}"@ + +# Create a Role + +try { + $Result = ConvertFrom-JsonToRole -Json $Role + New-BetaRole-BetaRole $Result + + # Below is a request that includes all optional parameters + # New-BetaRole -BetaRole $Role +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRole" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-bulk-roles +This endpoint initiates a bulk deletion of one or more roles. +When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. +This endpoint can only bulk delete up to a limit of 50 roles per request. +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | RoleBulkDeleteRequest | [**RoleBulkDeleteRequest**](../models/role-bulk-delete-request) | True | + +### Return type +[**TaskResultDto**](../models/task-result-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Returns an object with the id of the task performing the delete operation. | TaskResultDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$RoleBulkDeleteRequest = @"{ + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] +}"@ + +# Delete Role(s) + +try { + $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest + Remove-BetaBulkRoles-BetaRoleBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaBulkRoles -BetaRoleBulkDeleteRequest $RoleBulkDeleteRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaBulkRoles" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-role +This API deletes a Role by its ID. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Role + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + +# Delete a Role + +try { + Remove-BetaRole-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaRole -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaRole" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role +This API returns a Role by its ID. +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Role + +### Return type +[**Role**](../models/role) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of all Roles | Role +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + +# Get a Role + +try { + Get-BetaRole-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaRole -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRole" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-assigned-identities + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Role for which the assigned Identities are to be listed + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** + +### Return type +[**RoleIdentity[]**](../models/role-identity) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Identities assigned the Role | RoleIdentity[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role for which the assigned Identities are to be listed +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'name sw Joe' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) +$Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) + +# Identities assigned a Role + +try { + Get-BetaRoleAssignedIdentities-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaRoleAssignedIdentities -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignedIdentities" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-entitlements +This API lists the Entitlements associated with a given role. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the containing role + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** + +### Return type +[**Entitlement[]**](../models/entitlement) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Entitlements | Entitlement[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121919ecca" # String | ID of the containing role +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'attribute eq "memberOf"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + +# List role's Entitlements + +try { + Get-BetaRoleEntitlements-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaRoleEntitlements -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleEntitlements" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-roles +This API returns a list of Roles. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | ForSubadmin | **String** | (optional) | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. + Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** + Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. + Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. + +### Return type +[**Role[]**](../models/role) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Roles | Role[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) +$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'requestable eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) +$ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) +$IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + +# List Roles + +try { + Get-BetaRoles + + # Below is a request that includes all optional parameters + # Get-BetaRoles -BetaForSubadmin $ForSubadmin -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -BetaForSegmentIds $ForSegmentIds -BetaIncludeUnsegmented $IncludeUnsegmented +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoles" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-role +This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +The following fields are patchable: + +* name +* description +* enabled +* owner +* accessProfiles +* entitlements +* membership +* requestable +* accessRequestConfig +* revokeRequestConfig +* segments +* accessModelMetadata +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Role to patch + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**Role**](../models/role) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the Role as updated. | Role +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | + + +# Patch a specified Role + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaRole-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaRole -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRole" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSIMIntegrationsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSIMIntegrationsApi.md new file mode 100644 index 000000000..5dfd7ffc0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSIMIntegrationsApi.md @@ -0,0 +1,378 @@ + +--- +id: beta-sim-integrations +title: SIMIntegrations +pagination_label: SIMIntegrations +sidebar_label: SIMIntegrations +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SIMIntegrations', 'BetaSIMIntegrations'] +slug: /tools/sdk/powershell/beta/methods/sim-integrations +tags: ['SDK', 'Software Development Kit', 'SIMIntegrations', 'BetaSIMIntegrations'] +--- + +# SIMIntegrations + Use this API to administer IdentityNow's Service Integration Module, or SIM integration with ServiceNow, so that it converts IdentityNow provisioning actions into tickets in ServiceNow. + +ServiceNow is a software platform that supports IT service management and automates common business processes for requesting and fulfilling service requests across a business enterprise. + +You must have an IdentityNow ServiceNow ServiceDesk license to use this integration. Contact your Customer Success Manager for more information. + +Service Desk integration for IdentityNow and in deprecation - not available for new implementation, as of July 21st, 2021. As per SailPoint’s [support policy](https://community.sailpoint.com/t5/Connector-Directory/SailPoint-Support-Policy-for-Connectivity/ta-p/79422), all existing SailPoint IdentityNow customers using this legacy integration will be supported until July 2022. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaSIMIntegration**](#create-sim-integration) | **POST** `/sim-integrations` | Create new SIM integration +[**Remove-BetaSIMIntegration**](#delete-sim-integration) | **DELETE** `/sim-integrations/{id}` | Delete a SIM integration +[**Get-BetaSIMIntegration**](#get-sim-integration) | **GET** `/sim-integrations/{id}` | Get a SIM integration details. +[**Get-BetaSIMIntegrations**](#get-sim-integrations) | **GET** `/sim-integrations` | List the existing SIM integrations. +[**Update-BetaBeforeProvisioningRule**](#patch-before-provisioning-rule) | **PATCH** `/sim-integrations/{id}/beforeProvisioningRule` | Patch a SIM beforeProvisioningRule attribute. +[**Update-BetaSIMAttributes**](#patch-sim-attributes) | **PATCH** `/sim-integrations/{id}` | Patch a SIM attribute. +[**Send-BetaSIMIntegration**](#put-sim-integration) | **PUT** `/sim-integrations/{id}` | Update an existing SIM integration + +## create-sim-integration +Create a new SIM Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | SimIntegrationDetails | [**SimIntegrationDetails**](../models/sim-integration-details) | True | DTO containing the details of the SIM integration + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | details of the created integration | ServiceDeskIntegrationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SimIntegrationDetails = @"{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } +}"@ + +# Create new SIM integration + +try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-BetaSIMIntegration-BetaSimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # New-BetaSIMIntegration -BetaSimIntegrationDetails $SimIntegrationDetails +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSIMIntegration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-sim-integration +Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The id of the integration to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | No content response | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "12345" # String | The id of the integration to delete. + +# Delete a SIM integration + +try { + Remove-BetaSIMIntegration-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSIMIntegration -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSIMIntegration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sim-integration +Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The id of the integration. + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The DTO containing the details of the SIM integration | ServiceDeskIntegrationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "12345" # String | The id of the integration. + +# Get a SIM integration details. + +try { + Get-BetaSIMIntegration-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSIMIntegration -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sim-integrations +List the existing SIM integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The DTO containing the details of the SIM integration | ServiceDeskIntegrationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List the existing SIM integrations. + +try { + Get-BetaSIMIntegrations + + # Below is a request that includes all optional parameters + # Get-BetaSIMIntegrations +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegrations" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-before-provisioning-rule +Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | SIM integration id + Body | JsonPatch | [**JsonPatch**](../models/json-patch) | True | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The updated DTO containing the details of the SIM integration. | ServiceDeskIntegrationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "12345" # String | SIM integration id +$JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]""@ + +# Patch a SIM beforeProvisioningRule attribute. + +try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-BetaBeforeProvisioningRule-BetaId $Id -BetaJsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-BetaBeforeProvisioningRule -BetaId $Id -BetaJsonPatch $JsonPatch +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaBeforeProvisioningRule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-sim-attributes +Patch a SIM attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | SIM integration id + Body | JsonPatch | [**JsonPatch**](../models/json-patch) | True | The JsonPatch object that describes the changes of SIM + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The updated DTO containing the details of the SIM integration. | ServiceDeskIntegrationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "12345" # String | SIM integration id +$JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]""@ + +# Patch a SIM attribute. + +try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-BetaSIMAttributes-BetaId $Id -BetaJsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-BetaSIMAttributes -BetaId $Id -BetaJsonPatch $JsonPatch +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSIMAttributes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-sim-integration +Update an existing SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The id of the integration. + Body | SimIntegrationDetails | [**SimIntegrationDetails**](../models/sim-integration-details) | True | The full DTO of the integration containing the updated model + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | details of the updated integration | ServiceDeskIntegrationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "12345" # String | The id of the integration. +$SimIntegrationDetails = @"{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } +}"@ + +# Update an existing SIM integration + +try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + Send-BetaSIMIntegration-BetaId $Id -BetaSimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # Send-BetaSIMIntegration -BetaId $Id -BetaSimIntegrationDetails $SimIntegrationDetails +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSIMIntegration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSODPoliciesApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSODPoliciesApi.md new file mode 100644 index 000000000..451c7d73b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSODPoliciesApi.md @@ -0,0 +1,981 @@ + +--- +id: beta-sod-policies +title: SODPolicies +pagination_label: SODPolicies +sidebar_label: SODPolicies +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SODPolicies', 'BetaSODPolicies'] +slug: /tools/sdk/powershell/beta/methods/sod-policies +tags: ['SDK', 'Software Development Kit', 'SODPolicies', 'BetaSODPolicies'] +--- + +# SODPolicies + Use this API to implement and manage "separation of duties" (SOD) policies. +With SOD policy functionality in place, administrators can organize the access in their tenants to prevent individuals from gaining conflicting or excessive access. + +"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. +For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. +Any changes to major system configurations should be approved by someone other than the person requesting the change. + +Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. +These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + +To create SOD policies in Identity Security Cloud, administrators use 'Search' and then access 'Policies'. +To create a policy, they must configure two lists of access items. Each access item can only be added to one of the two lists. +They can search for the entitlements they want to add to these access lists. + +>Note: You can have a maximum of 500 policies of any type (including general policies) in your organization. In each access-based SOD policy, you can have a maximum of 50 entitlements in each access list. + +Once a SOD policy is in place, if an identity has access items on both lists, a SOD violation will trigger. +These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. +The other users can then better help to enforce these SOD policies. + +To create a subscription to a SOD policy in Identity Security Cloud, administrators use 'Search' and then access 'Layers'. +They can create a subscription to the policy and schedule it to run at a regular interval. + +Refer to [Managing Policies](https://documentation.sailpoint.com/saas/help/sod/manage-policies.html) for more information about SOD policies. + +Refer to [Subscribe to a SOD Policy](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html#subscribe-to-an-sod-policy) for more information about SOD policy subscriptions. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaSodPolicy**](#create-sod-policy) | **POST** `/sod-policies` | Create SOD policy +[**Remove-BetaSodPolicy**](#delete-sod-policy) | **DELETE** `/sod-policies/{id}` | Delete SOD policy by ID +[**Remove-BetaSodPolicySchedule**](#delete-sod-policy-schedule) | **DELETE** `/sod-policies/{id}/schedule` | Delete SOD policy schedule +[**Get-BetaCustomViolationReport**](#get-custom-violation-report) | **GET** `/sod-violation-report/{reportResultId}/download/{fileName}` | Download custom violation report +[**Get-BetaDefaultViolationReport**](#get-default-violation-report) | **GET** `/sod-violation-report/{reportResultId}/download` | Download violation report +[**Get-BetaSodAllReportRunStatus**](#get-sod-all-report-run-status) | **GET** `/sod-violation-report` | Get multi-report run task status +[**Get-BetaSodPolicy**](#get-sod-policy) | **GET** `/sod-policies/{id}` | Get SOD policy by ID +[**Get-BetaSodPolicySchedule**](#get-sod-policy-schedule) | **GET** `/sod-policies/{id}/schedule` | Get SOD policy schedule +[**Get-BetaSodViolationReportRunStatus**](#get-sod-violation-report-run-status) | **GET** `/sod-policies/sod-violation-report-status/{reportResultId}` | Get violation report run status +[**Get-BetaSodViolationReportStatus**](#get-sod-violation-report-status) | **GET** `/sod-policies/{id}/violation-report` | Get SOD violation report status +[**Get-BetaSodPolicies**](#list-sod-policies) | **GET** `/sod-policies` | List SOD policies +[**Update-BetaSodPolicy**](#patch-sod-policy) | **PATCH** `/sod-policies/{id}` | Patch a SOD policy +[**Send-BetaPolicySchedule**](#put-policy-schedule) | **PUT** `/sod-policies/{id}/schedule` | Update SOD Policy schedule +[**Send-BetaSodPolicy**](#put-sod-policy) | **PUT** `/sod-policies/{id}` | Update SOD policy by ID +[**Start-BetaSodAllPoliciesForOrg**](#start-sod-all-policies-for-org) | **POST** `/sod-violation-report/run` | Runs all policies for org +[**Start-BetaSodPolicy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report + +## create-sod-policy +This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. +Requires role of ORG_ADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | SodPolicy | [**SodPolicy**](../models/sod-policy) | True | + +### Return type +[**SodPolicy**](../models/sod-policy) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | SOD policy created | SodPolicy +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SodPolicy = @"{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" +}"@ + +# Create SOD policy + +try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-BetaSodPolicy-BetaSodPolicy $Result + + # Below is a request that includes all optional parameters + # New-BetaSodPolicy -BetaSodPolicy $SodPolicy +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSodPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-sod-policy +This deletes a specified SOD policy. +Requires role of ORG_ADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the SOD Policy to delete. + Query | Logical | **Boolean** | (optional) (default to $true) | Indicates whether this is a soft delete (logical true) or a hard delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD Policy to delete. +$Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. (optional) (default to $true) + +# Delete SOD policy by ID + +try { + Remove-BetaSodPolicy-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSodPolicy -BetaId $Id -BetaLogical $Logical +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-sod-policy-schedule +This deletes schedule for a specified SOD policy. +Requires role of ORG_ADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the SOD policy the schedule must be deleted for. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + +# Delete SOD policy schedule + +try { + Remove-BetaSodPolicySchedule-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSodPolicySchedule -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicySchedule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-custom-violation-report +This allows to download a specified named violation report for a given report reference. +Requires role of ORG_ADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ReportResultId | **String** | True | The ID of the report reference to download. +Path | FileName | **String** | True | Custom Name for the file. + +### Return type +**System.IO.FileInfo** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns the zip file with given custom name that contains the violation report file. | System.IO.FileInfo +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example +```powershell +$ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. +$FileName = "custom-name" # String | Custom Name for the file. + +# Download custom violation report + +try { + Get-BetaCustomViolationReport-BetaReportResultId $ReportResultId -BetaFileName $FileName + + # Below is a request that includes all optional parameters + # Get-BetaCustomViolationReport -BetaReportResultId $ReportResultId -BetaFileName $FileName +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomViolationReport" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-default-violation-report +This allows to download a violation report for a given report reference. +Requires role of ORG_ADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ReportResultId | **String** | True | The ID of the report reference to download. + +### Return type +**System.IO.FileInfo** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns the PolicyReport.zip that contains the violation report file. | System.IO.FileInfo +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example +```powershell +$ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + +# Download violation report + +try { + Get-BetaDefaultViolationReport-BetaReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-BetaDefaultViolationReport -BetaReportResultId $ReportResultId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultViolationReport" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sod-all-report-run-status +This endpoint gets the status for a violation report for all policy run. +Requires role of ORG_ADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Status of the violation report run task for all policy run. | ReportResultReference +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get multi-report run task status + +try { + Get-BetaSodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-BetaSodAllReportRunStatus +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodAllReportRunStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sod-policy +This gets specified SOD policy. +Requires role of ORG_ADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the object reference to retrieve. + +### Return type +[**SodPolicy**](../models/sod-policy) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | SOD policy ID. | SodPolicy +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + +# Get SOD policy by ID + +try { + Get-BetaSodPolicy-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSodPolicy -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sod-policy-schedule +This endpoint gets a specified SOD policy's schedule. +Requires the role of ORG_ADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the object reference to retrieve. + +### Return type +[**SodPolicySchedule**](../models/sod-policy-schedule) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | SOD policy ID. | SodPolicySchedule +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + +# Get SOD policy schedule + +try { + Get-BetaSodPolicySchedule-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSodPolicySchedule -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicySchedule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sod-violation-report-run-status +This gets the status for a violation report run task that has already been invoked. +Requires role of ORG_ADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ReportResultId | **String** | True | The ID of the report reference to retrieve. + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Status of the violation report run task. | ReportResultReference +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + +# Get violation report run status + +try { + Get-BetaSodViolationReportRunStatus-BetaReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-BetaSodViolationReportRunStatus -BetaReportResultId $ReportResultId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportRunStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sod-violation-report-status +This gets the status for a violation report run task that has already been invoked. +Requires role of ORG_ADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the object reference to retrieve. + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Status of the violation report run task. | ReportResultReference +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + +# Get SOD violation report status + +try { + Get-BetaSodViolationReportStatus-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSodViolationReportStatus -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-sod-policies +This gets list of all SOD policies. +Requires role of ORG_ADMIN + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** + +### Return type +[**SodPolicy[]**](../models/sod-policy) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of all SOD policies. | SodPolicy[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq "bc693f07e7b645539626c25954c58554"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) +$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + +# List SOD policies + +try { + Get-BetaSodPolicies + + # Below is a request that includes all optional parameters + # Get-BetaSodPolicies -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicies" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-sod-policy +Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +Requires role of ORG_ADMIN. +This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the SOD policy being modified. + Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | True | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + +### Return type +[**SodPolicy**](../models/sod-policy) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Indicates the PATCH operation succeeded, and returns the SOD policy's new representation. | SodPolicy +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | The ID of the SOD policy being modified. +$RequestBody = # SystemCollectionsHashtable[] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + $RequestBody = @"[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]"@ # SystemCollectionsHashtable[] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + + +# Patch a SOD policy + +try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaSodPolicy-BetaId $Id -BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaSodPolicy -BetaId $Id -BetaRequestBody $RequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSodPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-policy-schedule +This updates schedule for a specified SOD policy. +Requires role of ORG_ADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the SOD policy to update its schedule. + Body | SodPolicySchedule | [**SodPolicySchedule**](../models/sod-policy-schedule) | True | + +### Return type +[**SodPolicySchedule**](../models/sod-policy-schedule) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | SOD policy by ID. | SodPolicySchedule +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy to update its schedule. +$SodPolicySchedule = @"{ + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false +}"@ + +# Update SOD Policy schedule + +try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-BetaPolicySchedule-BetaId $Id -BetaSodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-BetaPolicySchedule -BetaId $Id -BetaSodPolicySchedule $SodPolicySchedule +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPolicySchedule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-sod-policy +This updates a specified SOD policy. +Requires role of ORG_ADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the SOD policy to update. + Body | SodPolicy | [**SodPolicy**](../models/sod-policy) | True | + +### Return type +[**SodPolicy**](../models/sod-policy) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | SOD Policy by ID | SodPolicy +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy to update. +$SodPolicy = @"{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" +}"@ + +# Update SOD policy by ID + +try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-BetaSodPolicy-BetaId $Id -BetaSodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-BetaSodPolicy -BetaId $Id -BetaSodPolicy $SodPolicy +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSodPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-sod-all-policies-for-org +Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. +Requires role of ORG_ADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | MultiPolicyRequest | [**MultiPolicyRequest**](../models/multi-policy-request) | (optional) | + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the violation report run task. | ReportResultReference +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$MultiPolicyRequest = @"{ + "filteredPolicyList" : [ "filteredPolicyList", "filteredPolicyList" ] +}"@ + +# Runs all policies for org + +try { + Start-BetaSodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-BetaSodAllPoliciesForOrg -BetaMultiPolicyRequest $MultiPolicyRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodAllPoliciesForOrg" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-sod-policy +This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. +Requires role of ORG_ADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The SOD policy ID to run. + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the violation report run task. | ReportResultReference +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The SOD policy ID to run. + +# Runs SOD policy violation report + +try { + Start-BetaSodPolicy-BetaId $Id + + # Below is a request that includes all optional parameters + # Start-BetaSodPolicy -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSODViolationsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSODViolationsApi.md new file mode 100644 index 000000000..0ac9be728 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSODViolationsApi.md @@ -0,0 +1,97 @@ + +--- +id: beta-sod-violations +title: SODViolations +pagination_label: SODViolations +sidebar_label: SODViolations +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SODViolations', 'BetaSODViolations'] +slug: /tools/sdk/powershell/beta/methods/sod-violations +tags: ['SDK', 'Software Development Kit', 'SODViolations', 'BetaSODViolations'] +--- + +# SODViolations + Use this API to check for current "separation of duties" (SOD) policy violations as well as potential future SOD policy violations. +With SOD violation functionality in place, administrators can get information about current SOD policy violations and predict whether an access change will trigger new violations, which helps to prevent them from occurring at all. + +"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. +For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. +Any changes to major system configurations should be approved by someone other than the person requesting the change. + +Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. +These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + +Once a SOD policy is in place, if an identity has conflicting access items, a SOD violation will trigger. +These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. +The other users can then better help to enforce these SOD policies. + +Administrators can use the SOD violations APIs to check a set of identities for any current SOD violations, and they can use them to check whether adding an access item would potentially trigger a SOD violation. +This second option is a good way to prevent SOD violations from triggering at all. + +Refer to [Handling Policy Violations](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html) for more information about SOD policy violations. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Start-BetaPredictSodViolations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict SOD violations for identity. + +## start-predict-sod-violations +This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. + +A token with ORG_ADMIN or API authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | IdentityWithNewAccess | [**IdentityWithNewAccess**](../models/identity-with-new-access) | True | + +### Return type +[**ViolationPrediction**](../models/violation-prediction) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Violation Contexts | ViolationPrediction +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$IdentityWithNewAccess = @"{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] +}"@ + +# Predict SOD violations for identity. + +try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-BetaPredictSodViolations-BetaIdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-BetaPredictSodViolations -BetaIdentityWithNewAccess $IdentityWithNewAccess +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaPredictSodViolations" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSPConfigApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSPConfigApi.md new file mode 100644 index 000000000..9fecd4a06 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSPConfigApi.md @@ -0,0 +1,352 @@ + +--- +id: beta-sp-config +title: SPConfig +pagination_label: SPConfig +sidebar_label: SPConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SPConfig', 'BetaSPConfig'] +slug: /tools/sdk/powershell/beta/methods/sp-config +tags: ['SDK', 'Software Development Kit', 'SPConfig', 'BetaSPConfig'] +--- + +# SPConfig + Import and export configuration for some objects between tenants. + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Export-BetaSpConfig**](#export-sp-config) | **POST** `/sp-config/export` | Initiates configuration objects export job +[**Get-BetaSpConfigExport**](#get-sp-config-export) | **GET** `/sp-config/export/{id}/download` | Download export job result. +[**Get-BetaSpConfigExportStatus**](#get-sp-config-export-status) | **GET** `/sp-config/export/{id}` | Get export job status +[**Get-BetaSpConfigImport**](#get-sp-config-import) | **GET** `/sp-config/import/{id}/download` | Download import job result +[**Get-BetaSpConfigImportStatus**](#get-sp-config-import-status) | **GET** `/sp-config/import/{id}` | Get import job status +[**Import-BetaSpConfig**](#import-sp-config) | **POST** `/sp-config/import` | Initiates configuration objects import job +[**Get-BetaSpConfigObjects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | Get config object details + +## export-sp-config +This post will export objects from the tenant to a JSON configuration file. +For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects). + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | ExportPayload | [**ExportPayload**](../models/export-payload) | True | Export options control what will be included in the export. + +### Return type +[**SpConfigExportJob**](../models/sp-config-export-job) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Export job accepted and queued for processing. | SpConfigExportJob +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$ExportPayload = @"{ + "description" : "Export Job 1 Test" +}"@ + +# Initiates configuration objects export job + +try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-BetaSpConfig-BetaExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-BetaSpConfig -BetaExportPayload $ExportPayload +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sp-config-export +This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. +The request will need one of the following security scopes: +- sp:config:read - sp:config:manage + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the export job whose results will be downloaded. + +### Return type +[**SpConfigExportResults**](../models/sp-config-export-results) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Exported JSON objects. | SpConfigExportResults +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. + +# Download export job result. + +try { + Get-BetaSpConfigExport-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigExport -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExport" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sp-config-export-status +This gets the status of the export job identified by the `id` parameter. +The request will need one of the following security scopes: +- sp:config:read - sp:config:manage + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the export job whose status will be returned. + +### Return type +[**SpConfigExportJobStatus**](../models/sp-config-export-job-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Export job status successfully returned. | SpConfigExportJobStatus +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. + +# Get export job status + +try { + Get-BetaSpConfigExportStatus-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigExportStatus -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExportStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sp-config-import +This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. +The request will need the following security scope: +- sp:config:manage + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the import job whose results will be downloaded. + +### Return type +[**SpConfigImportResults**](../models/sp-config-import-results) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Import results JSON object, containing detailed results of the import operation. | SpConfigImportResults +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. + +# Download import job result + +try { + Get-BetaSpConfigImport-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigImport -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImport" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sp-config-import-status +This gets the status of the import job identified by the `id` parameter. +For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects). + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the import job whose status will be returned. + +### Return type +[**SpConfigImportJobStatus**](../models/sp-config-import-job-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Import job status successfully returned. | SpConfigImportJobStatus +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. + +# Get import job status + +try { + Get-BetaSpConfigImportStatus-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigImportStatus -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImportStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-sp-config +This post will import objects from a JSON configuration file into a tenant. +By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. +The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. +The backup can be skipped by setting "excludeBackup" to true in the import options. +If a backup is performed, the id of the backup will be provided in the ImportResult as the "exportJobId". This can be downloaded +using the `/sp-config/export/{exportJobId}/download` endpoint. + +You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. + +For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects). + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | Data | **System.IO.FileInfo** | True | JSON file containing the objects to be imported. + Query | Preview | **Boolean** | (optional) (default to $false) | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. + | Options | [**ImportOptions**](../models/import-options) | (optional) | + +### Return type +[**SpConfigJob**](../models/sp-config-job) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Import job accepted and queued for processing. | SpConfigJob +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$Data = # System.IO.FileInfo | JSON file containing the objects to be imported. +$Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) +$Options = @""@ + +# Initiates configuration objects import job + +try { + Import-BetaSpConfig-BetaData $Data + + # Below is a request that includes all optional parameters + # Import-BetaSpConfig -BetaData $Data -BetaPreview $Preview -BetaOptions $Options +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-sp-config-objects +This gets the list of object configurations which are known to the tenant export/import service. Object configurations that contain "importUrl" and "exportUrl" are available for export/import. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**SpConfigObject[]**](../models/sp-config-object) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Object configurations returned successfully. | SpConfigObject[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get config object details + +try { + Get-BetaSpConfigObjects + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigObjects +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigObjects" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSearchAttributeConfigurationApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSearchAttributeConfigurationApi.md new file mode 100644 index 000000000..19f4761a4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSearchAttributeConfigurationApi.md @@ -0,0 +1,274 @@ + +--- +id: beta-search-attribute-configuration +title: SearchAttributeConfiguration +pagination_label: SearchAttributeConfiguration +sidebar_label: SearchAttributeConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchAttributeConfiguration', 'BetaSearchAttributeConfiguration'] +slug: /tools/sdk/powershell/beta/methods/search-attribute-configuration +tags: ['SDK', 'Software Development Kit', 'SearchAttributeConfiguration', 'BetaSearchAttributeConfiguration'] +--- + +# SearchAttributeConfiguration + Use this API to implement search attribute configuration functionality, along with [Search](https://developer.sailpoint.com/docs/api/v3/search). +With this functionality in place, administrators can create custom search attributes that and run extended searches based on those attributes to further narrow down their searches and get the information and insights they want. + +Identity Security Cloud (ISC) enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential. +Its search goes through all those sources and finds the results quickly and specifically. + +The search query is flexible - it can be very broad or very narrow. +The search only returns results for searchable objects it is filtering for. +The following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities. +By default, no filter is applied, so a search for "Ad" returns both the identity "Adam.Archer" as well as the role "Administrator." + +Users can further narrow their results by using ISC's specific syntax and punctuation to structure their queries. +For example, the query "attributes.location:austin AND NOT manager.name:amanda.ross" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross. +Refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries. + +Refer to [Using Search](https://documentation.sailpoint.com/saas/help/search/index.html) for more information about ISC's search and its different possibilities. + +With Search Attribute Configuration, administrators can create, manage, and run searches based on the attributes they want to search. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaSearchAttributeConfig**](#create-search-attribute-config) | **POST** `/accounts/search-attribute-config` | Create Extended Search Attributes +[**Remove-BetaSearchAttributeConfig**](#delete-search-attribute-config) | **DELETE** `/accounts/search-attribute-config/{name}` | Delete Extended Search Attribute +[**Get-BetaSearchAttributeConfig**](#get-search-attribute-config) | **GET** `/accounts/search-attribute-config` | List Extended Search Attributes +[**Get-BetaSingleSearchAttributeConfig**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute +[**Update-BetaSearchAttributeConfig**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute + +## create-search-attribute-config +Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create and attribute promotion configuration in the Link ObjectConfig. +A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | SearchAttributeConfig | [**SearchAttributeConfig**](../models/search-attribute-config) | True | + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SearchAttributeConfig = @"{ + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } +}"@ + +# Create Extended Search Attributes + +try { + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-BetaSearchAttributeConfig-BetaSearchAttributeConfig $Result + + # Below is a request that includes all optional parameters + # New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $SearchAttributeConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-search-attribute-config +Delete an extended attribute configuration by name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Name | **String** | True | Name of the extended search attribute configuration to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. + +# Delete Extended Search Attribute + +try { + Remove-BetaSearchAttributeConfig-BetaName $Name + + # Below is a request that includes all optional parameters + # Remove-BetaSearchAttributeConfig -BetaName $Name +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-search-attribute-config +Get a list of attribute/application associates currently configured in Identity Security Cloud (ISC). +A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**SearchAttributeConfig[]**](../models/search-attribute-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of attribute configurations in ISC. | SearchAttributeConfig[] +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List Extended Search Attributes + +try { + Get-BetaSearchAttributeConfig + + # Below is a request that includes all optional parameters + # Get-BetaSearchAttributeConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-single-search-attribute-config +Get an extended attribute configuration by name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Name | **String** | True | Name of the extended search attribute configuration to get. + +### Return type +[**SearchAttributeConfig[]**](../models/search-attribute-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Specific attribute configuration in IdentityNow. | SearchAttributeConfig[] +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. + +# Get Extended Search Attribute + +try { + Get-BetaSingleSearchAttributeConfig-BetaName $Name + + # Below is a request that includes all optional parameters + # Get-BetaSingleSearchAttributeConfig -BetaName $Name +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-search-attribute-config +Update an existing search attribute configuration. +You can patch these fields: +* name * displayName * applicationAttributes + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Name | **String** | True | Name of the extended search attribute configuration to patch. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**SearchAttributeConfig**](../models/search-attribute-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the search attribute configuration as updated. | SearchAttributeConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Name = "promotedMailAttribute" # String | Name of the extended search attribute configuration to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | + + +# Update Extended Search Attribute + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaSearchAttributeConfig-BetaName $Name -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaSearchAttributeConfig -BetaName $Name -BetaJsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSegmentsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSegmentsApi.md new file mode 100644 index 000000000..f9e343c28 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSegmentsApi.md @@ -0,0 +1,297 @@ + +--- +id: beta-segments +title: Segments +pagination_label: Segments +sidebar_label: Segments +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Segments', 'BetaSegments'] +slug: /tools/sdk/powershell/beta/methods/segments +tags: ['SDK', 'Software Development Kit', 'Segments', 'BetaSegments'] +--- + +# Segments + Use this API to implement and customize access request segment functionality. +With this functionality in place, administrators can create and manage access request segments. +Segments provide organizations with a way to make the access their users have even more granular - this can simply the access request process for the organization's users and improves security by reducing the risk of overprovisoning access. + +Segments represent sets of identities, all grouped by specified identity attributes, who are only able to see and access the access items associated with their segments. +For example, administrators could group all their organization's London office employees into one segment, "London Office Employees," by their shared location. +The administrators could then define the access items the London employees would need, and the identities in the "London Office Employees" would then only be able to see and access those items. + +In Identity Security Cloud, administrators can use the 'Access' drop-down menu and select 'Segments' to reach the 'Access Requests Segments' page. +This page lists all the existing access request segments, along with their statuses, enabled or disabled. +Administrators can use this page to create, edit, enable, disable, and delete segments. +To create a segment, an administrator must provide a name, define the identities grouped in the segment, and define the items the identities in the segment can access. +These items can be access profiles, roles, or entitlements. + +When administrators use the API to create and manage segments, they use a JSON expression in the `visibilityCriteria` object to define the segment's identities and access items. + +Refer to [Managing Access Request Segments](https://documentation.sailpoint.com/saas/help/requests/segments.html) for more information about segments in Identity Security Cloud. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaSegment**](#create-segment) | **POST** `/segments` | Create Segment +[**Remove-BetaSegment**](#delete-segment) | **DELETE** `/segments/{id}` | Delete Segment by ID +[**Get-BetaSegment**](#get-segment) | **GET** `/segments/{id}` | Get Segment by ID +[**Get-BetaSegments**](#list-segments) | **GET** `/segments` | List Segments +[**Update-BetaSegment**](#patch-segment) | **PATCH** `/segments/{id}` | Update Segment + +## create-segment +This API creates a segment. +>**Note:** Segment definitions may take time to propagate to all identities. +A token with ORG_ADMIN or API authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Segment | [**Segment**](../models/segment) | True | + +### Return type +[**Segment**](../models/segment) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Segment created | Segment +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Segment = @"{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" +}"@ + +# Create Segment + +try { + $Result = ConvertFrom-JsonToSegment -Json $Segment + New-BetaSegment-BetaSegment $Result + + # Below is a request that includes all optional parameters + # New-BetaSegment -BetaSegment $Segment +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-segment +This API deletes the segment specified by the given ID. +>**Note:** Segment deletion may take some time to go into effect. +A token with ORG_ADMIN or API authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The segment ID to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + +# Delete Segment by ID + +try { + Remove-BetaSegment-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSegment -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-segment +This API returns the segment specified by the given ID. +A token with ORG_ADMIN or API authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The segment ID to retrieve. + +### Return type +[**Segment**](../models/segment) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Segment | Segment +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + +# Get Segment by ID + +try { + Get-BetaSegment-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSegment -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-segments +This API returns a list of all segments. +A token with ORG_ADMIN or API authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**Segment[]**](../models/segment) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of all segments | Segment[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# List Segments + +try { + Get-BetaSegments + + # Below is a request that includes all optional parameters + # Get-BetaSegments -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-segment +Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +>**Note:** Changes to a segment may take some time to propagate to all identities. +A token with ORG_ADMIN or API authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The segment ID to modify. + Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | True | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + +### Return type +[**Segment**](../models/segment) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Indicates the PATCH operation succeeded, and returns the segment's new representation. | Segment +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. +$RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + + +# Update Segment + +try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaSegment-BetaId $Id -BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaSegment -BetaId $Id -BetaRequestBody $RequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSegment" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaServiceDeskIntegrationApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaServiceDeskIntegrationApi.md new file mode 100644 index 000000000..b660ca01a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaServiceDeskIntegrationApi.md @@ -0,0 +1,560 @@ + +--- +id: beta-service-desk-integration +title: ServiceDeskIntegration +pagination_label: ServiceDeskIntegration +sidebar_label: ServiceDeskIntegration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskIntegration', 'BetaServiceDeskIntegration'] +slug: /tools/sdk/powershell/beta/methods/service-desk-integration +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegration', 'BetaServiceDeskIntegration'] +--- + +# ServiceDeskIntegration + Use this API to build an integration between Identity Security Cloud and a service desk ITSM (IT service management) solution. +Once an administrator builds this integration between Identity Security Cloud and a service desk, users can use Identity Security Cloud to raise and track tickets that are synchronized between Identity Security Cloud and the service desk. + +In Identity Security Cloud, administrators can create a service desk integration (sometimes also called an SDIM, or Service Desk Integration Module) by going to Admin > Connections > Service Desk and selecting 'Create.' + +To create a Generic Service Desk integration, for example, administrators must provide the required information on the General Settings page, the Connectivity and Authentication information, Ticket Creation information, Status Mapping information, and Requester Source information on the Configure page. +Refer to [Integrating SailPoint with Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) for more information about the process of setting up a Generic Service Desk in Identity Security Cloud. + +Administrators can create various service desk integrations, all with their own nuances. +The following service desk integrations are available: + +- [Atlassian Cloud Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_cloud/help/integrating_jira_cloud_sd/introduction.html) + +- [Atlassian Server Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_server/help/integrating_jira_server_sd/introduction.html) + +- [BMC Helix ITSM Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_ITSM_sd/help/integrating_bmc_helix_itsm_sd/intro.html) + +- [BMC Helix Remedyforce Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_remedyforce_sd/help/integrating_bmc_helix_remedyforce_sd/intro.html) + +- [Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) + +- [ServiceNow Service Desk](https://documentation.sailpoint.com/connectors/servicenow/sdim/help/integrating_servicenow_sdim/intro.html) + +- [Zendesk Service Desk](https://documentation.sailpoint.com/connectors/zendesk/help/integrating_zendesk_sd/introduction.html) + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaServiceDeskIntegration**](#create-service-desk-integration) | **POST** `/service-desk-integrations` | Create new Service Desk integration +[**Remove-BetaServiceDeskIntegration**](#delete-service-desk-integration) | **DELETE** `/service-desk-integrations/{id}` | Delete a Service Desk integration +[**Get-BetaServiceDeskIntegration**](#get-service-desk-integration) | **GET** `/service-desk-integrations/{id}` | Get a Service Desk integration +[**Get-BetaServiceDeskIntegrationList**](#get-service-desk-integration-list) | **GET** `/service-desk-integrations` | List existing Service Desk integrations +[**Get-BetaServiceDeskIntegrationTemplate**](#get-service-desk-integration-template) | **GET** `/service-desk-integrations/templates/{scriptName}` | Service Desk integration template by scriptName +[**Get-BetaServiceDeskIntegrationTypes**](#get-service-desk-integration-types) | **GET** `/service-desk-integrations/types` | List Service Desk integration types +[**Get-BetaStatusCheckDetails**](#get-status-check-details) | **GET** `/service-desk-integrations/status-check-configuration` | Get the time check configuration +[**Update-BetaServiceDeskIntegration**](#patch-service-desk-integration) | **PATCH** `/service-desk-integrations/{id}` | Patch a Service Desk Integration +[**Send-BetaServiceDeskIntegration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a Service Desk integration +[**Update-BetaStatusCheckDetails**](#update-status-check-details) | **PUT** `/service-desk-integrations/status-check-configuration` | Update the time check configuration + +## create-service-desk-integration +Create a new Service Desk integration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | ServiceDeskIntegrationDto | [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) | True | The specifics of a new integration to create + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Details of the created integration | ServiceDeskIntegrationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$ServiceDeskIntegrationDto = @"{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" +}"@ + +# Create new Service Desk integration + +try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-BetaServiceDeskIntegration-BetaServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $ServiceDeskIntegrationDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-service-desk-integration +Delete an existing Service Desk integration by ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of Service Desk integration to delete + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | Service Desk integration with the given ID successfully deleted | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "anId" # String | ID of Service Desk integration to delete + +# Delete a Service Desk integration + +try { + Remove-BetaServiceDeskIntegration-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaServiceDeskIntegration -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-service-desk-integration +Get an existing Service Desk integration by ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Service Desk integration to get + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | ServiceDeskIntegrationDto with the given ID | ServiceDeskIntegrationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "anId" # String | ID of the Service Desk integration to get + +# Get a Service Desk integration + +try { + Get-BetaServiceDeskIntegration-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegration -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-service-desk-integration-list +Get a list of Service Desk integration objects. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**ServiceDeskIntegrationDto[]**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of ServiceDeskIntegrationDto | ServiceDeskIntegrationDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) +$Filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# List existing Service Desk integrations + +try { + Get-BetaServiceDeskIntegrationList + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationList -BetaOffset $Offset -BetaLimit $Limit -BetaSorters $Sorters -BetaFilters $Filters -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-service-desk-integration-template +This API endpoint returns an existing Service Desk integration template by scriptName. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ScriptName | **String** | True | The scriptName value of the Service Desk integration template to get + +### Return type +[**ServiceDeskIntegrationTemplateDto**](../models/service-desk-integration-template-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName. | ServiceDeskIntegrationTemplateDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + +# Service Desk integration template by scriptName + +try { + Get-BetaServiceDeskIntegrationTemplate-BetaScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationTemplate -BetaScriptName $ScriptName +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-service-desk-integration-types +This API endpoint returns the current list of supported Service Desk integration types. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**ServiceDeskIntegrationTemplateType[]**](../models/service-desk-integration-template-type) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with an array of the currently supported Service Desk integration types. | ServiceDeskIntegrationTemplateType[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List Service Desk integration types + +try { + Get-BetaServiceDeskIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationTypes +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTypes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-status-check-details +Get the time check configuration of queued SDIM tickets. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**QueuedCheckConfigDetails**](../models/queued-check-config-details) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | QueuedCheckConfigDetails containing the configured values | QueuedCheckConfigDetails +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get the time check configuration + +try { + Get-BetaStatusCheckDetails + + # Below is a request that includes all optional parameters + # Get-BetaStatusCheckDetails +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusCheckDetails" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-service-desk-integration +Update an existing Service Desk integration by ID with a PATCH request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Service Desk integration to update + Body | PatchServiceDeskIntegrationRequest | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | ServiceDeskIntegrationDto as updated | ServiceDeskIntegrationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "anId" # String | ID of the Service Desk integration to update +$PatchServiceDeskIntegrationRequest = @""@ + +# Patch a Service Desk Integration + +try { + $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest + Update-BetaServiceDeskIntegration-BetaId $Id -BetaPatchServiceDeskIntegrationRequest $Result + + # Below is a request that includes all optional parameters + # Update-BetaServiceDeskIntegration -BetaId $Id -BetaPatchServiceDeskIntegrationRequest $PatchServiceDeskIntegrationRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-service-desk-integration +Update an existing Service Desk integration by ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Service Desk integration to update + Body | ServiceDeskIntegrationDto | [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) | True | The specifics of the integration to update + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | ServiceDeskIntegrationDto as updated | ServiceDeskIntegrationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "anId" # String | ID of the Service Desk integration to update +$ServiceDeskIntegrationDto = @"{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" +}"@ + +# Update a Service Desk integration + +try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-BetaServiceDeskIntegration-BetaId $Id -BetaServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaServiceDeskIntegration -BetaId $Id -BetaServiceDeskIntegrationDto $ServiceDeskIntegrationDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-status-check-details +Update the time check configuration of queued SDIM tickets. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | QueuedCheckConfigDetails | [**QueuedCheckConfigDetails**](../models/queued-check-config-details) | True | The modified time check configuration + +### Return type +[**QueuedCheckConfigDetails**](../models/queued-check-config-details) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | QueuedCheckConfigDetails as updated | QueuedCheckConfigDetails +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$QueuedCheckConfigDetails = @"{ + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" +}"@ + +# Update the time check configuration + +try { + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-BetaStatusCheckDetails-BetaQueuedCheckConfigDetails $Result + + # Below is a request that includes all optional parameters + # Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $QueuedCheckConfigDetails +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSourceUsagesApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSourceUsagesApi.md new file mode 100644 index 000000000..7fa54bb8e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSourceUsagesApi.md @@ -0,0 +1,118 @@ + +--- +id: beta-source-usages +title: SourceUsages +pagination_label: SourceUsages +sidebar_label: SourceUsages +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceUsages', 'BetaSourceUsages'] +slug: /tools/sdk/powershell/beta/methods/source-usages +tags: ['SDK', 'Software Development Kit', 'SourceUsages', 'BetaSourceUsages'] +--- + +# SourceUsages + Use this API to implement source usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' sources are being used. +This allows organizations to get the information they need to start optimizing and securing source usage. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaStatusBySourceId**](#get-status-by-source-id) | **GET** `/source-usages/{sourceId}/status` | Finds status of source usage +[**Get-BetaUsagesBySourceId**](#get-usages-by-source-id) | **GET** `/source-usages/{sourceId}/summaries` | Returns source usage insights + +## get-status-by-source-id +This API returns the status of the source usage insights setup by IDN source ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | ID of IDN source + +### Return type +[**SourceUsageStatus**](../models/source-usage-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Status of the source usage insights setup by IDN source ID. | SourceUsageStatus +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + +# Finds status of source usage + +try { + Get-BetaStatusBySourceId-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaStatusBySourceId -BetaSourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusBySourceId" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-usages-by-source-id +This API returns a summary of source usage insights for past 12 months. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | ID of IDN source + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** + +### Return type +[**SourceUsage[]**](../models/source-usage) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Summary of source usage insights for past 12 months. | SourceUsage[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + +# Returns source usage insights + +try { + Get-BetaUsagesBySourceId-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaUsagesBySourceId -BetaSourceId $SourceId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesBySourceId" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSourcesApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSourcesApi.md new file mode 100644 index 000000000..4d624a0a9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSourcesApi.md @@ -0,0 +1,2588 @@ + +--- +id: beta-sources +title: Sources +pagination_label: Sources +sidebar_label: Sources +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Sources', 'BetaSources'] +slug: /tools/sdk/powershell/beta/methods/sources +tags: ['SDK', 'Software Development Kit', 'Sources', 'BetaSources'] +--- + +# Sources + Use this API to implement and customize source functionality. +With source functionality in place, organizations can use Identity Security Cloud to connect their various sources and user data sets and manage access across all those different sources in a secure, scalable way. + +[Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) refer to the Identity Security Cloud representations for external applications, databases, and directory management systems that maintain their own sets of users, like Dropbox, GitHub, and Workday, for example. +Organizations may use hundreds, if not thousands, of different source systems, and any one employee within an organization likely has a different user record on each source, often with different permissions on many of those records. +Connecting these sources to Identity Security Cloud makes it possible to manage user access across them all. +Then, if a new hire starts at an organization, Identity Security Cloud can grant the new hire access to all the sources they need. +If an employee moves to a new department and needs access to new sources but no longer needs access to others, Identity Security Cloud can grant the necessary access and revoke the unnecessary access for all the employee's various sources. +If an employee leaves the company, Identity Security Cloud can revoke access to all the employee's various source accounts immediately. +These are just a few examples of the many ways that source functionality makes identity governance easier, more efficient, and more secure. + +In Identity Security Cloud, administrators can create configure, manage, and edit sources, and they can designate other users as source admins to be able to do so. +They can also designate users as source sub-admins, who can perform the same source actions but only on sources associated with their governance groups. +Admins go to Connections > Sources to see a list of the existing source representations in their organizations. +They can create new sources or select existing ones. + +To create a new source, the following must be specified: Source Name, Description, Source Owner, and Connection Type. +Refer to [Configuring a Source](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html#configuring-a-source) for more information about the source configuration process. + +Identity Security Cloud connects with its sources either by a direct communication with the source server (connection information specific to the source must be provided) or a flat file feed, a CSV file containing all the relevant information about the accounts to be loaded in. +Different sources use different connectors to share data with Identity Security Cloud, and each connector's setup process is specific to that connector. +SailPoint has built a number of connectors to come out of the box and connect to the most common sources, and SailPoint actively maintains these connectors. +Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about these SailPoint supported connectors. +Refer to the following links for more information about two useful connectors: + +- [JDBC Connector](https://documentation.sailpoint.com/connectors/jdbc/help/integrating_jdbc/introduction.html): This customizable connector an directly connect to databases that support JDBC (Java Database Connectivity). + +- [Web Services Connector](https://documentation.sailpoint.com/connectors/webservices/help/integrating_webservices/introduction.html): This connector can directly connect to databases that support Web Services. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/) for more information about SailPoint's new connectivity framework that makes it easy to build and manage custom connectors to SaaS sources. + +When admins select existing sources, they can view the following information about the source: + +- Associated connections (any associated identity profiles, apps, or references to the source in a transform). + +- Associated user accounts. These accounts are linked to their identities - this provides a more complete picture of each user's access across sources. + +- Associated entitlements (sets of access rights on sources). + +- Associated access profiles (groupings of entitlements). + +The user account data and the entitlements update with each data aggregation from the source. +Organizations generally run scheduled, automated data aggregations to ensure that their data is always in sync between their sources and their Identity Security Cloud tenants so an access change on a source is detected quickly in Identity Security Cloud. +Admins can view a history of these aggregations, and they can also run manual imports. +Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about manual and scheduled aggregations. + +Admins can also make changes to determine which user account data Identity Security Cloud collects from the source and how it correlates that account data with identity data. +To define which account attributes the source shares with Identity Security Cloud, admins can edit the account schema on the source. +Refer to [Managing Source Account Schemas](https://documentation.sailpoint.com/saas/help/accounts/schema.html) for more information about source account schemas and how to edit them. +To define the mapping between the source account attributes and their correlating identity attributes, admins can edit the correlation configuration on the source. +Refer to [Assigning Source Accounts to Identities](https://documentation.sailpoint.com/saas/help/accounts/correlation.html) for more information about this correlation process between source accounts and identities. + +Admins can also delete sources, but they must first ensure that the sources no longer have any active connections: the source must not be associated with any identity profile or any app, and it must not be referenced by any transform. +Refer to [Deleting Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html#deleting-sources) for more information about deleting sources. + +Well organized, mapped out connections between sources and Identity Security Cloud are essential to achieving comprehensive identity access governance across all the source systems organizations need. +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about all the different things admins can do with sources once they are connected. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaProvisioningPolicy**](#create-provisioning-policy) | **POST** `/sources/{sourceId}/provisioning-policies` | Create Provisioning Policy +[**New-BetaSource**](#create-source) | **POST** `/sources` | Creates a source in IdentityNow. +[**New-BetaSourceSchema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create Schema on Source +[**Remove-Beta**](#delete) | **DELETE** `/sources/{id}` | Delete Source by ID +[**Remove-BetaAccountsAsync**](#delete-accounts-async) | **POST** `/sources/{id}/remove-accounts` | Remove All Accounts in a Source +[**Remove-BetaNativeChangeDetectionConfig**](#delete-native-change-detection-config) | **DELETE** `/sources/{sourceId}/native-change-detection-config` | Delete Native Change Detection Configuration +[**Remove-BetaProvisioningPolicy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete Provisioning Policy by UsageType +[**Remove-BetaSourceSchema**](#delete-source-schema) | **DELETE** `/sources/{sourceId}/schemas/{schemaId}` | Delete Source Schema by ID +[**Get-BetaCorrelationConfig**](#get-correlation-config) | **GET** `/sources/{id}/correlation-config` | Get Source Correlation Configuration +[**Get-BetaNativeChangeDetectionConfig**](#get-native-change-detection-config) | **GET** `/sources/{sourceId}/native-change-detection-config` | Native Change Detection Configuration +[**Get-BetaProvisioningPolicy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType +[**Get-BetaSource**](#get-source) | **GET** `/sources/{id}` | Get Source by ID +[**Get-BetaSourceAccountsSchema**](#get-source-accounts-schema) | **GET** `/sources/{id}/schemas/accounts` | Downloads source accounts schema template +[**Get-BetaSourceAttrSyncConfig**](#get-source-attr-sync-config) | **GET** `/sources/{id}/attribute-sync-config` | Attribute Sync Config +[**Get-BetaSourceConfig**](#get-source-config) | **GET** `/sources/{id}/connectors/source-config` | Gets source config with language translations +[**Get-BetaSourceEntitlementRequestConfig**](#get-source-entitlement-request-config) | **GET** `/sources/{id}/entitlement-request-config` | Get Source Entitlement Request Configuration +[**Get-BetaSourceEntitlementsSchema**](#get-source-entitlements-schema) | **GET** `/sources/{id}/schemas/entitlements` | Downloads source entitlements schema template +[**Get-BetaSourceSchema**](#get-source-schema) | **GET** `/sources/{sourceId}/schemas/{schemaId}` | Get Source Schema by ID +[**Get-BetaSourceSchemas**](#get-source-schemas) | **GET** `/sources/{sourceId}/schemas` | List Schemas on Source +[**Import-BetaAccounts**](#import-accounts) | **POST** `/sources/{id}/load-accounts` | Account Aggregation +[**Import-BetaEntitlements**](#import-entitlements) | **POST** `/sources/{id}/load-entitlements` | Entitlement Aggregation +[**Import-BetaSourceAccountsSchema**](#import-source-accounts-schema) | **POST** `/sources/{id}/schemas/accounts` | Uploads source accounts schema template +[**Import-BetaSourceConnectorFile**](#import-source-connector-file) | **POST** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source +[**Import-BetaSourceEntitlementsSchema**](#import-source-entitlements-schema) | **POST** `/sources/{id}/schemas/entitlements` | Uploads source entitlements schema template +[**Import-BetaUncorrelatedAccounts**](#import-uncorrelated-accounts) | **POST** `/sources/{id}/load-uncorrelated-accounts` | Process Uncorrelated Accounts +[**Get-BetaProvisioningPolicies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies +[**Get-BetaSources**](#list-sources) | **GET** `/sources` | Lists all sources in IdentityNow. +[**Receive-BetaResourceObjects**](#peek-resource-objects) | **POST** `/sources/{sourceId}/connector/peek-resource-objects` | Peek source connector's resource objects +[**Ping-BetaCluster**](#ping-cluster) | **POST** `/sources/{sourceId}/connector/ping-cluster` | Ping cluster for source connector +[**Send-BetaCorrelationConfig**](#put-correlation-config) | **PUT** `/sources/{id}/correlation-config` | Update Source Correlation Configuration +[**Send-BetaNativeChangeDetectionConfig**](#put-native-change-detection-config) | **PUT** `/sources/{sourceId}/native-change-detection-config` | Update Native Change Detection Configuration +[**Send-BetaProvisioningPolicy**](#put-provisioning-policy) | **PUT** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update Provisioning Policy by UsageType +[**Send-BetaSource**](#put-source) | **PUT** `/sources/{id}` | Update Source (Full) +[**Send-BetaSourceAttrSyncConfig**](#put-source-attr-sync-config) | **PUT** `/sources/{id}/attribute-sync-config` | Update Attribute Sync Config +[**Send-BetaSourceSchema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full) +[**Sync-BetaAttributesForSource**](#sync-attributes-for-source) | **POST** `/sources/{id}/synchronize-attributes` | Synchronize single source attributes. +[**Test-BetaSourceConfiguration**](#test-source-configuration) | **POST** `/sources/{sourceId}/connector/test-configuration` | Test configuration for source connector +[**Test-BetaSourceConnection**](#test-source-connection) | **POST** `/sources/{sourceId}/connector/check-connection` | Check connection for source connector. +[**Update-BetaProvisioningPoliciesInBulk**](#update-provisioning-policies-in-bulk) | **POST** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk Update Provisioning Policies +[**Update-BetaProvisioningPolicy**](#update-provisioning-policy) | **PATCH** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of Provisioning Policy +[**Update-BetaSource**](#update-source) | **PATCH** `/sources/{id}` | Update Source (Partial) +[**Update-BetaSourceEntitlementRequestConfig**](#update-source-entitlement-request-config) | **PUT** `/sources/{id}/entitlement-request-config` | Update Source Entitlement Request Configuration +[**Update-BetaSourceSchema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial) + +## create-provisioning-policy +This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id + Body | ProvisioningPolicyDto | [**ProvisioningPolicyDto**](../models/provisioning-policy-dto) | True | + +### Return type +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Created ProvisioningPolicyDto object | ProvisioningPolicyDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id +$ProvisioningPolicyDto = @"{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" +}"@ + +# Create Provisioning Policy + +try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + New-BetaProvisioningPolicy-BetaSourceId $SourceId -BetaProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # New-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaProvisioningPolicyDto $ProvisioningPolicyDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-source +This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Source | [**Source**](../models/source) | True | + Query | ProvisionAsCsv | **Boolean** | (optional) | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Created Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design. | Source +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Source = @"{ + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" +}"@ +$ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) + +# Creates a source in IdentityNow. + +try { + $Result = ConvertFrom-JsonToSource -Json $Source + New-BetaSource-BetaSource $Result + + # Below is a request that includes all optional parameters + # New-BetaSource -BetaSource $Source -BetaProvisionAsCsv $ProvisionAsCsv +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSource" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-source-schema +Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | Source ID. + Body | Schema | [**Schema**](../models/schema) | True | + +### Return type +[**Schema**](../models/schema) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | The schema was successfully created on the specified source. | Schema +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. +$Schema = @"{ + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" +}"@ + +# Create Schema on Source + +try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + New-BetaSourceSchema-BetaSourceId $SourceId -BetaSchema $Result + + # Below is a request that includes all optional parameters + # New-BetaSourceSchema -BetaSourceId $SourceId -BetaSchema $Schema +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete +Use this API to delete a specific source in Identity Security Cloud (ISC). +The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source ID. + +### Return type +[**Delete202Response**](../models/delete202-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | Delete202Response +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + +# Delete Source by ID + +try { + Remove-Beta-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-Beta -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Beta" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-accounts-async +Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. + +This endpoint is good for: +* Removing accounts that no longer exist on the source. +* Removing accounts that won't be aggregated following updates to the source configuration. +* Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The source id + +### Return type +[**TaskResultDto**](../models/task-result-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted. Returns task result details of removal request. | TaskResultDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ebbf35756e1140699ce52b233121384a" # String | The source id + +# Remove All Accounts in a Source + +try { + Remove-BetaAccountsAsync-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaAccountsAsync -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccountsAsync" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-native-change-detection-config +Deletes the native change detection configuration for the source specified by the given ID. +A token with API, or ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The source id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + +# Delete Native Change Detection Configuration + +try { + Remove-BetaNativeChangeDetectionConfig-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaNativeChangeDetectionConfig -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNativeChangeDetectionConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-provisioning-policy +Deletes the provisioning policy with the specified usage on an application. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source ID. +Path | UsageType | [**UsageType**](../models/usage-type) | True | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. +$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + +# Delete Provisioning Policy by UsageType + +try { + Remove-BetaProvisioningPolicy-BetaSourceId $SourceId -BetaUsageType $UsageType + + # Below is a request that includes all optional parameters + # Remove-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaUsageType $UsageType +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-source-schema + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source ID. +Path | SchemaId | **String** | True | The Schema ID. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. +$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. + +# Delete Source Schema by ID + +try { + Remove-BetaSourceSchema-BetaSourceId $SourceId -BetaSchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Remove-BetaSourceSchema -BetaSourceId $SourceId -BetaSchemaId $SchemaId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSourceSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-correlation-config +This API returns the existing correlation configuration for a source specified by the given ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The source id + +### Return type +[**CorrelationConfig**](../models/correlation-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Correlation configuration for a source | CorrelationConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + +# Get Source Correlation Configuration + +try { + Get-BetaCorrelationConfig-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaCorrelationConfig -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCorrelationConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-native-change-detection-config +This API returns the existing native change detection configuration for a source specified by the given ID. +A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The source id + +### Return type +[**NativeChangeDetectionConfig**](../models/native-change-detection-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Native change detection configuration for a source | NativeChangeDetectionConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + +# Native Change Detection Configuration + +try { + Get-BetaNativeChangeDetectionConfig-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaNativeChangeDetectionConfig -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNativeChangeDetectionConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-provisioning-policy +This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source ID. +Path | UsageType | [**UsageType**](../models/usage-type) | True | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + +### Return type +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The requested ProvisioningPolicyDto was successfully retrieved. | ProvisioningPolicyDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. +$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + +# Get Provisioning Policy by UsageType + +try { + Get-BetaProvisioningPolicy-BetaSourceId $SourceId -BetaUsageType $UsageType + + # Below is a request that includes all optional parameters + # Get-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaUsageType $UsageType +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-source +Use this API to get a source by a specified ID in Identity Security Cloud (ISC). +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source ID. + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Source object. | Source +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + +# Get Source by ID + +try { + Get-BetaSource-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSource -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSource" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-source-accounts-schema + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The Source id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully downloaded the file | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: text/csv, application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + +# Downloads source accounts schema template + +try { + Get-BetaSourceAccountsSchema-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSourceAccountsSchema -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceAccountsSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-source-attr-sync-config +This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. +A token with ORG_ADMIN or HELPDESK authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The source id + +### Return type +[**AttrSyncSourceConfig**](../models/attr-sync-source-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Attribute synchronization configuration for a source | AttrSyncSourceConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + +# Attribute Sync Config + +try { + Get-BetaSourceAttrSyncConfig-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSourceAttrSyncConfig -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceAttrSyncConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-source-config +Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. +A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The Source id + Query | Locale | **String** | (optional) | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + +### Return type +[**ConnectorDetail**](../models/connector-detail) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A Connector Detail object | ConnectorDetail +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "MyId" # String | The Source id +$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + +# Gets source config with language translations + +try { + Get-BetaSourceConfig-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSourceConfig -BetaId $Id -BetaLocale $Locale +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-source-entitlement-request-config +This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. + +Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. +- During access request, this source-level entitlement request configuration overrides the global organization-level configuration. +- However, the entitlement-level configuration (if defined) overrides this source-level configuration. + +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**SourceEntitlementRequestConfig**](../models/source-entitlement-request-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Source Entitlement Request Configuration Details. | SourceEntitlementRequestConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Source Entitlement Request Configuration + +try { + Get-BetaSourceEntitlementRequestConfig + + # Below is a request that includes all optional parameters + # Get-BetaSourceEntitlementRequestConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceEntitlementRequestConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-source-entitlements-schema + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The Source id + Query | SchemaName | **String** | (optional) | Name of entitlement schema + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully downloaded the file | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: text/csv, application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id +$SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + +# Downloads source entitlements schema template + +try { + Get-BetaSourceEntitlementsSchema-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSourceEntitlementsSchema -BetaId $Id -BetaSchemaName $SchemaName +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceEntitlementsSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-source-schema +Get the Source Schema by ID in IdentityNow. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source ID. +Path | SchemaId | **String** | True | The Schema ID. + +### Return type +[**Schema**](../models/schema) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The requested Schema was successfully retrieved. | Schema +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. +$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. + +# Get Source Schema by ID + +try { + Get-BetaSourceSchema-BetaSourceId $SourceId -BetaSchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Get-BetaSourceSchema -BetaSourceId $SourceId -BetaSchemaId $SchemaId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-source-schemas +Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | Source ID. + Query | IncludeTypes | **String** | (optional) | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. + Query | IncludeNames | **String** | (optional) | A comma-separated list of schema names to filter result. + +### Return type +[**Schema[]**](../models/schema) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The schemas were successfully retrieved. | Schema[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. +$IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) +$IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional) + +# List Schemas on Source + +try { + Get-BetaSourceSchemas-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaSourceSchemas -BetaSourceId $SourceId -BetaIncludeTypes $IncludeTypes -BetaIncludeNames $IncludeNames +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceSchemas" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-accounts +Starts an account aggregation on the specified source. +If the target source is a delimited file source, then the CSV file needs to be included in the request body. +You will also need to set the Content-Type header to `multipart/form-data`. +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source Id + | File | **System.IO.FileInfo** | (optional) | The CSV file containing the source accounts to aggregate. + | DisableOptimization | **String** | (optional) | Use this flag to reprocess every account whether or not the data has changed. + +### Return type +[**LoadAccountsTask**](../models/load-accounts-task) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Aggregate Accounts Task | LoadAccountsTask +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id +$File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) +$DisableOptimization = "true" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) + +# Account Aggregation + +try { + Import-BetaAccounts-BetaId $Id + + # Below is a request that includes all optional parameters + # Import-BetaAccounts -BetaId $Id -BetaFile $File -BetaDisableOptimization $DisableOptimization +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaAccounts" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-entitlements +Starts an entitlement aggregation on the specified source. +If the target source is a delimited file source, then the CSV file needs to be included in the request body. +You will also need to set the Content-Type header to `multipart/form-data`. +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source Id + | File | **System.IO.FileInfo** | (optional) | The CSV file containing the source entitlements to aggregate. + +### Return type +[**LoadEntitlementTask**](../models/load-entitlement-task) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Aggregate Entitlements Task | LoadEntitlementTask +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id +$File = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) + +# Entitlement Aggregation + +try { + Import-BetaEntitlements-BetaId $Id + + # Below is a request that includes all optional parameters + # Import-BetaEntitlements -BetaId $Id -BetaFile $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaEntitlements" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-source-accounts-schema +This API uploads a source schema template file to configure a source's account attributes. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The Source id + | File | **System.IO.FileInfo** | (optional) | + +### Return type +[**Schema**](../models/schema) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully uploaded the file | Schema +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id +$File = # System.IO.FileInfo | (optional) + +# Uploads source accounts schema template + +try { + Import-BetaSourceAccountsSchema-BetaId $Id + + # Below is a request that includes all optional parameters + # Import-BetaSourceAccountsSchema -BetaId $Id -BetaFile $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceAccountsSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-source-connector-file +This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events. +A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id + | File | **System.IO.FileInfo** | (optional) | + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Uploaded the file successfully and sent all post-upload events | Source +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id +$File = # System.IO.FileInfo | (optional) + +# Upload connector file to source + +try { + Import-BetaSourceConnectorFile-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-BetaSourceConnectorFile -BetaSourceId $SourceId -BetaFile $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceConnectorFile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-source-entitlements-schema +This API uploads a source schema template file to configure a source's entitlement attributes. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The Source id + Query | SchemaName | **String** | (optional) | Name of entitlement schema + | File | **System.IO.FileInfo** | (optional) | + +### Return type +[**Schema**](../models/schema) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully uploaded the file | Schema +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id +$SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) +$File = # System.IO.FileInfo | (optional) + +# Uploads source entitlements schema template + +try { + Import-BetaSourceEntitlementsSchema-BetaId $Id + + # Below is a request that includes all optional parameters + # Import-BetaSourceEntitlementsSchema -BetaId $Id -BetaSchemaName $SchemaName -BetaFile $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceEntitlementsSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-uncorrelated-accounts +File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source Id + | File | **System.IO.FileInfo** | (optional) | + +### Return type +[**LoadUncorrelatedAccountsTask**](../models/load-uncorrelated-accounts-task) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Uncorrelated Accounts Task | LoadUncorrelatedAccountsTask +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$Id = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id +$File = # System.IO.FileInfo | (optional) + +# Process Uncorrelated Accounts + +try { + Import-BetaUncorrelatedAccounts-BetaId $Id + + # Below is a request that includes all optional parameters + # Import-BetaUncorrelatedAccounts -BetaId $Id -BetaFile $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaUncorrelatedAccounts" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-provisioning-policies +This end-point lists all the ProvisioningPolicies in IdentityNow. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id + +### Return type +[**ProvisioningPolicyDto[]**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of ProvisioningPolicyDto objects | ProvisioningPolicyDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + +# Lists ProvisioningPolicies + +try { + Get-BetaProvisioningPolicies-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaProvisioningPolicies -BetaSourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProvisioningPolicies" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-sources +This end-point lists all the sources in IdentityNow. + +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq* **modified**: *eq* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** + Query | ForSubadmin | **String** | (optional) | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. + Query | IncludeIDNSource | **Boolean** | (optional) (default to $false) | Include the IdentityNow source in the response. + +### Return type +[**Source[]**](../models/source) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Source objects | Source[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'name eq "Employees"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq* **modified**: *eq* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) +$ForSubadmin = "name" # String | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) +$IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false) + +# Lists all sources in IdentityNow. + +try { + Get-BetaSources + + # Below is a request that includes all optional parameters + # Get-BetaSources -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -BetaForSubadmin $ForSubadmin -BetaIncludeIDNSource $IncludeIDNSource +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSources" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## peek-resource-objects +Retrieves a sample of data returned from account and group aggregation requests. +A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The ID of the Source + Body | ResourceObjectsRequest | [**ResourceObjectsRequest**](../models/resource-objects-request) | True | + +### Return type +[**ResourceObjectsResponse**](../models/resource-objects-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of resource objects that was fetched from the source connector. | ResourceObjectsResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source +$ResourceObjectsRequest = @"{ + "maxCount" : 100, + "objectType" : "group" +}"@ + +# Peek source connector's resource objects + +try { + $Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest + Receive-BetaResourceObjects-BetaSourceId $SourceId -BetaResourceObjectsRequest $Result + + # Below is a request that includes all optional parameters + # Receive-BetaResourceObjects -BetaSourceId $SourceId -BetaResourceObjectsRequest $ResourceObjectsRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Receive-BetaResourceObjects" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## ping-cluster +This endpoint validates that the cluster being used by the source is reachable from IdentityNow. +A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The ID of the Source + +### Return type +[**StatusResponse**](../models/status-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The result of pinging connection with the source connector. | StatusResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + +# Ping cluster for source connector + +try { + Ping-BetaCluster-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Ping-BetaCluster -BetaSourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-BetaCluster" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-correlation-config +Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The source id + Body | CorrelationConfig | [**CorrelationConfig**](../models/correlation-config) | True | + +### Return type +[**CorrelationConfig**](../models/correlation-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated correlation configuration for a source | CorrelationConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id +$CorrelationConfig = @"{ + "attributeAssignments" : [ { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + }, { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + } ], + "name" : "Source [source] Account Correlation", + "id" : "2c9180835d191a86015d28455b4a2329" +}"@ + +# Update Source Correlation Configuration + +try { + $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig + Send-BetaCorrelationConfig-BetaId $Id -BetaCorrelationConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaCorrelationConfig -BetaId $Id -BetaCorrelationConfig $CorrelationConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaCorrelationConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-native-change-detection-config +Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. + +A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The source id + Body | NativeChangeDetectionConfig | [**NativeChangeDetectionConfig**](../models/native-change-detection-config) | True | + +### Return type +[**NativeChangeDetectionConfig**](../models/native-change-detection-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated native change detection configuration for a source | NativeChangeDetectionConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id +$NativeChangeDetectionConfig = @"{ + "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], + "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], + "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], + "allNonEntitlementAttributes" : false, + "allEntitlements" : false, + "enabled" : true +}"@ + +# Update Native Change Detection Configuration + +try { + $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig + Send-BetaNativeChangeDetectionConfig-BetaId $Id -BetaNativeChangeDetectionConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaNativeChangeDetectionConfig -BetaId $Id -BetaNativeChangeDetectionConfig $NativeChangeDetectionConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaNativeChangeDetectionConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-provisioning-policy +This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source ID. +Path | UsageType | [**UsageType**](../models/usage-type) | True | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + Body | ProvisioningPolicyDto | [**ProvisioningPolicyDto**](../models/provisioning-policy-dto) | True | + +### Return type +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The ProvisioningPolicyDto was successfully replaced. | ProvisioningPolicyDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. +$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. +$ProvisioningPolicyDto = @"{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" +}"@ + +# Update Provisioning Policy by UsageType + +try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Send-BetaProvisioningPolicy-BetaSourceId $SourceId -BetaUsageType $UsageType -BetaProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaUsageType $UsageType -BetaProvisioningPolicyDto $ProvisioningPolicyDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-source +Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. + +These fields are immutable, so they cannot be changed: + +* id +* type +* authoritative +* connector +* connectorClass +* passwordPolicies + +Attempts to modify these fields will result in a 400 error. + +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source ID. + Body | Source | [**Source**](../models/source) | True | + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated Source object. Any passwords will only show the the encrypted cipher-text so that they aren't decryptable in Identity Security Cloud (ISC) cloud-based services, per ISC security design. | Source +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. +$Source = @"{ + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" +}"@ + +# Update Source (Full) + +try { + $Result = ConvertFrom-JsonToSource -Json $Source + Send-BetaSource-BetaId $Id -BetaSource $Result + + # Below is a request that includes all optional parameters + # Send-BetaSource -BetaId $Id -BetaSource $Source +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSource" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-source-attr-sync-config +Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the "enabled" field of the values in the "attributes" array is mutable. Attempting to change other attributes or add new values to the "attributes" array will result in an error. + +A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The source id + Body | AttrSyncSourceConfig | [**AttrSyncSourceConfig**](../models/attr-sync-source-config) | True | + +### Return type +[**AttrSyncSourceConfig**](../models/attr-sync-source-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated attribute synchronization configuration for a source | AttrSyncSourceConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id +$AttrSyncSourceConfig = @"{ + "attributes" : [ { + "name" : "email", + "displayName" : "Email", + "enabled" : true, + "target" : "mail" + }, { + "name" : "firstname", + "displayName" : "First Name", + "enabled" : false, + "target" : "givenName" + } ], + "source" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + } +}"@ + +# Update Attribute Sync Config + +try { + $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig + Send-BetaSourceAttrSyncConfig-BetaId $Id -BetaAttrSyncSourceConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaSourceAttrSyncConfig -BetaId $Id -BetaAttrSyncSourceConfig $AttrSyncSourceConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSourceAttrSyncConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-source-schema +This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. +* id +* name +* created +* modified +Any attempt to modify these fields will result in an error response with a status code of 400. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source ID. +Path | SchemaId | **String** | True | The Schema ID. + Body | Schema | [**Schema**](../models/schema) | True | + +### Return type +[**Schema**](../models/schema) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Schema was successfully replaced. | Schema +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. +$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. +$Schema = @"{ + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" +}"@ + +# Update Source Schema (Full) + +try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + Send-BetaSourceSchema-BetaSourceId $SourceId -BetaSchemaId $SchemaId -BetaSchema $Result + + # Below is a request that includes all optional parameters + # Send-BetaSourceSchema -BetaSourceId $SourceId -BetaSchemaId $SchemaId -BetaSchema $Schema +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSourceSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## sync-attributes-for-source +This end-point performs attribute synchronization for a selected source. +A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The Source id + +### Return type +[**SourceSyncJob**](../models/source-sync-job) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | A Source Sync job | SourceSyncJob +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "MyId" # String | The Source id + +# Synchronize single source attributes. + +try { + Sync-BetaAttributesForSource-BetaId $Id + + # Below is a request that includes all optional parameters + # Sync-BetaAttributesForSource -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetaAttributesForSource" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## test-source-configuration +This endpoint performs a more detailed validation of the source's configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. +A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The ID of the Source + +### Return type +[**StatusResponse**](../models/status-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The result of testing source connector configuration with response from it. | StatusResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + +# Test configuration for source connector + +try { + Test-BetaSourceConfiguration-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Test-BetaSourceConfiguration -BetaSourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## test-source-connection +This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. +A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The ID of the Source. + +### Return type +[**StatusResponse**](../models/status-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The result of checking connection to the source connector with response from it. | StatusResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source. + +# Check connection for source connector. + +try { + Test-BetaSourceConnection-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Test-BetaSourceConnection -BetaSourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConnection" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-provisioning-policies-in-bulk +This end-point updates a list of provisioning policies on the specified source in IdentityNow. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id. + Body | ProvisioningPolicyDto | [**[]ProvisioningPolicyDto**](../models/provisioning-policy-dto) | True | + +### Return type +[**ProvisioningPolicyDto[]**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of the ProvisioningPolicyDto was successfully replaced. | ProvisioningPolicyDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ProvisioningPolicyDto = @"{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" +}"@ # ProvisioningPolicyDto[] | + + +# Bulk Update Provisioning Policies + +try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Update-BetaProvisioningPoliciesInBulk-BetaSourceId $SourceId -BetaProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Update-BetaProvisioningPoliciesInBulk -BetaSourceId $SourceId -BetaProvisioningPolicyDto $ProvisioningPolicyDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProvisioningPoliciesInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-provisioning-policy +This API selectively updates an existing Provisioning Policy using a JSONPatch payload. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id. +Path | UsageType | [**UsageType**](../models/usage-type) | True | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the schema. + +### Return type +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The ProvisioningPolicyDto was successfully updated. | ProvisioningPolicyDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. +$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | The JSONPatch payload used to update the schema. + + +# Partial update of Provisioning Policy + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaProvisioningPolicy-BetaSourceId $SourceId -BetaUsageType $UsageType -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaUsageType $UsageType -BetaJsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-source +Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the +[JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +These fields are immutable, so they cannot be changed: +* id +* type +* authoritative +* created +* modified +* connector +* connectorClass +* passwordPolicies + +Attempts to modify these fields will result in a 400 error. + +A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or API authority is required to call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source ID. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated Source object. Any passwords will only show the the encrypted cipher-text so that they are not decryptable in Identity Security Cloud cloud-based services, per ISC security design. | Source +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). + + +# Update Source (Partial) + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaSource-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaSource -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSource" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-source-entitlement-request-config +This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. + +Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. +- During access request, this source-level entitlement request configuration overrides the global organization-level configuration. +- However, the entitlement-level configuration (if defined) overrides this source-level configuration. + +A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | SourceEntitlementRequestConfig | [**SourceEntitlementRequestConfig**](../models/source-entitlement-request-config) | True | + +### Return type +[**SourceEntitlementRequestConfig**](../models/source-entitlement-request-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Source Entitlement Request Configuration Details. | SourceEntitlementRequestConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceEntitlementRequestConfig = @"{ + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } +}"@ + +# Update Source Entitlement Request Configuration + +try { + $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig + Update-BetaSourceEntitlementRequestConfig-BetaSourceEntitlementRequestConfig $Result + + # Below is a request that includes all optional parameters + # Update-BetaSourceEntitlementRequestConfig -BetaSourceEntitlementRequestConfig $SourceEntitlementRequestConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceEntitlementRequestConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-source-schema +Use this API to selectively update an existing Schema using a JSONPatch payload. + +The following schema fields are immutable and cannot be updated: + +- id +- name +- created +- modified + + +To switch an account attribute to a group entitlement, you need to have the following in place: + +- `isEntitlement: true` +- Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/beta/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: +```json +{ + "name": "groups", + "type": "STRING", + "schema": { + "type": "CONNECTOR_SCHEMA", + "id": "2c9180887671ff8c01767b4671fc7d60", + "name": "group" + }, + "description": "The groups, roles etc. that reference account group objects", + "isMulti": true, + "isEntitlement": true, + "isGroup": true +} +``` + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id. +Path | SchemaId | **String** | True | The Schema id. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the schema. + +### Return type +[**Schema**](../models/schema) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Schema was successfully updated. | Schema +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. +$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | The JSONPatch payload used to update the schema. + + +# Update Source Schema (Partial) + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaSourceSchema-BetaSourceId $SourceId -BetaSchemaId $SchemaId -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaSourceSchema -BetaSourceId $SourceId -BetaSchemaId $SchemaId -BetaJsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSuggestedEntitlementDescriptionApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSuggestedEntitlementDescriptionApi.md new file mode 100644 index 000000000..10330dffd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaSuggestedEntitlementDescriptionApi.md @@ -0,0 +1,389 @@ + +--- +id: beta-suggested-entitlement-description +title: SuggestedEntitlementDescription +pagination_label: SuggestedEntitlementDescription +sidebar_label: SuggestedEntitlementDescription +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SuggestedEntitlementDescription', 'BetaSuggestedEntitlementDescription'] +slug: /tools/sdk/powershell/beta/methods/suggested-entitlement-description +tags: ['SDK', 'Software Development Kit', 'SuggestedEntitlementDescription', 'BetaSuggestedEntitlementDescription'] +--- + +# SuggestedEntitlementDescription + Use this API to implement Suggested Entitlement Description (SED) functionality. +SED functionality leverages the power of LLM to generate suggested entitlement descriptions. +Refer to [GenAI Entitlement Descriptions](https://documentation.sailpoint.com/saas/help/access/entitlements.html#genai-entitlement-descriptions) to learn more about SED in Identity Security Cloud (ISC). + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaSedBatchStats**](#get-sed-batch-stats) | **GET** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit Sed Batch Stats Request +[**Get-BetaSedBatches**](#get-sed-batches) | **GET** `/suggested-entitlement-description-batches` | List Sed Batch Request +[**Get-BetaSeds**](#list-seds) | **GET** `/suggested-entitlement-descriptions` | List Suggested Entitlement Descriptions +[**Update-BetaSed**](#patch-sed) | **PATCH** `/suggested-entitlement-descriptions` | Patch Suggested Entitlement Description +[**Submit-BetaSedApproval**](#submit-sed-approval) | **POST** `/suggested-entitlement-description-approvals` | Submit Bulk Approval Request +[**Submit-BetaSedAssignment**](#submit-sed-assignment) | **POST** `/suggested-entitlement-description-assignments` | Submit Sed Assignment Request +[**Submit-BetaSedBatchRequest**](#submit-sed-batch-request) | **POST** `/suggested-entitlement-description-batches` | Submit Sed Batch Request + +## get-sed-batch-stats +Submit Sed Batch Stats Request. + +Submits batchId in the path param `(e.g. {batchId}/stats)`. +API responses with stats of the batchId. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | BatchId | **String** | True | Batch Id + +### Return type +[**SedBatchStats**](../models/sed-batch-stats) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Stats of Sed batch. | SedBatchStats +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id + +# Submit Sed Batch Stats Request + +try { + Get-BetaSedBatchStats-BetaBatchId $BatchId + + # Below is a request that includes all optional parameters + # Get-BetaSedBatchStats -BetaBatchId $BatchId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSedBatchStats" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sed-batches +List Sed Batches. +API responses with Sed Batch Status + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**SedBatchStatus**](../models/sed-batch-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Status of batch | SedBatchStatus +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List Sed Batch Request + +try { + Get-BetaSedBatches + + # Below is a request that includes all optional parameters + # Get-BetaSedBatches +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSedBatches" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-seds +List of Suggested Entitlement Descriptions (SED) + +SED field descriptions: + +**batchId**: the ID of the batch of entitlements that are submitted for description generation + +**displayName**: the display name of the entitlement that we are generating a description for + +**sourceName**: the name of the source associated with the entitlement that we are generating the description for + +**sourceId**: the ID of the source associated with the entitlement that we are generating the description for + +**status**: the status of the suggested entitlement description, valid status options: "requested", "suggested", "not_suggested", "failed", "assigned", "approved", "denied" + +**fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int64** | (optional) | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** + Query | Count | **Boolean** | (optional) | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. + Query | CountOnly | **Boolean** | (optional) | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. + Query | RequestedByAnyone | **Boolean** | (optional) | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested + Query | ShowPendingStatusOnly | **Boolean** | (optional) | Will limit records to items that are in ""suggested"" or ""approved"" status + +### Return type +[**Sed[]**](../models/sed) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Suggested Entitlement Details | Sed[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = limit=25 # Int64 | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) +$Filters = 'displayName co "Read and Write"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) +$Sorters = "sorters=displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) +$Count = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) +$CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) +$RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) +$ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) + +# List Suggested Entitlement Descriptions + +try { + Get-BetaSeds + + # Below is a request that includes all optional parameters + # Get-BetaSeds -BetaLimit $Limit -BetaFilters $Filters -BetaSorters $Sorters -BetaCount $Count -BetaCountOnly $CountOnly -BetaRequestedByAnyone $RequestedByAnyone -BetaShowPendingStatusOnly $ShowPendingStatusOnly +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSeds" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-sed +Patch Suggested Entitlement Description + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | id is sed id + Body | SedPatch | [**[]SedPatch**](../models/sed-patch) | True | Sed Patch Request + +### Return type +[**Sed**](../models/sed) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | detail of patched sed | Sed +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id + $SedPatch = @"{ + "op" : "replace", + "path" : "status", + "value" : "approved" +}"@ # SedPatch[] | Sed Patch Request + + +# Patch Suggested Entitlement Description + +try { + $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch + Update-BetaSed-BetaId $Id -BetaSedPatch $Result + + # Below is a request that includes all optional parameters + # Update-BetaSed -BetaId $Id -BetaSedPatch $SedPatch +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSed" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## submit-sed-approval +Submit Bulk Approval Request for SED. +Request body takes list of SED Ids. API responses with list of SED Approval Status + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | SedApproval | [**[]SedApproval**](../models/sed-approval) | True | Sed Approval + +### Return type +[**SedApprovalStatus[]**](../models/sed-approval-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of SED Approval Status | SedApprovalStatus[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell + $SedApproval = @"{ + "items" : "016629d1-1d25-463f-97f3-c6686846650" +}"@ # SedApproval[] | Sed Approval + + +# Submit Bulk Approval Request + +try { + $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval + Submit-BetaSedApproval-BetaSedApproval $Result + + # Below is a request that includes all optional parameters + # Submit-BetaSedApproval -BetaSedApproval $SedApproval +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedApproval" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## submit-sed-assignment +Submit Assignment Request. +Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | SedAssignment | [**SedAssignment**](../models/sed-assignment) | True | Sed Assignment Request + +### Return type +[**SedAssignmentResponse**](../models/sed-assignment-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Sed Assignment Response | SedAssignmentResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$SedAssignment = @"{ + "assignee" : { + "type" : "SOURCE_OWNER", + "value" : "016629d1-1d25-463f-97f3-c6686846650" + }, + "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] +}"@ + +# Submit Sed Assignment Request + +try { + $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment + Submit-BetaSedAssignment-BetaSedAssignment $Result + + # Below is a request that includes all optional parameters + # Submit-BetaSedAssignment -BetaSedAssignment $SedAssignment +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedAssignment" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## submit-sed-batch-request +Submit Sed Batch Request. +Request body has one of the following: + - a list of entitlement Ids + - a list of SED Ids +that user wants to have description generated by LLM. API responses with batchId that groups Ids together + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | SedBatchRequest | [**SedBatchRequest**](../models/sed-batch-request) | (optional) | Sed Batch Request + +### Return type +[**SedBatchResponse**](../models/sed-batch-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Sed Batch Response | SedBatchResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$SedBatchRequest = @"{ + "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] +}"@ + +# Submit Sed Batch Request + +try { + Submit-BetaSedBatchRequest + + # Below is a request that includes all optional parameters + # Submit-BetaSedBatchRequest -BetaSedBatchRequest $SedBatchRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedBatchRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaTaggedObjectsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaTaggedObjectsApi.md new file mode 100644 index 000000000..330d8c579 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaTaggedObjectsApi.md @@ -0,0 +1,492 @@ + +--- +id: beta-tagged-objects +title: TaggedObjects +pagination_label: TaggedObjects +sidebar_label: TaggedObjects +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaggedObjects', 'BetaTaggedObjects'] +slug: /tools/sdk/powershell/beta/methods/tagged-objects +tags: ['SDK', 'Software Development Kit', 'TaggedObjects', 'BetaTaggedObjects'] +--- + +# TaggedObjects + Use this API to implement object tagging functionality. +With object tagging functionality in place, any user in an organization can use tags as a way to group objects together and find them more quickly when the user searches Identity Security Cloud. + +In Identity Security Cloud, users can search their tenants for information and add tags objects they find. +Tagging an object provides users with a way of grouping objects together and makes it easier to find these objects in the future. + +For example, if a user is searching for an entitlement that grants a risky level of access to Active Directory, it's possible that the user may have to search through hundreds of entitlements to find the correct one. +Once the user finds that entitlement, the user can add a tag to the entitlement, "AD_RISKY" to make it easier to find the entitlement again. +The user can add the same tag to multiple objects the user wants to group together for an easy future search, and the user can also do so in bulk. +When the user wants to find that tagged entitlement again, the user can search for "tags:AD_RISKY" to find all objects with that tag. + +With the API, you can tag even more different object types than you can in Identity Security Cloud (access profiles, entitlements, identities, and roles). +You can use the API to tag all these objects: + +- Access profiles + +- Applications + +- Certification campaigns + +- Entitlements + +- Identities + +- Roles + +- SOD (separation of duties) policies + +- Sources + +You can also use the API to directly find, create, and manage tagged objects without using search queries. + +There are limits to tags: + +- You can have up to 500 different tags in your tenant. + +- You can apply up to 30 tags to one object. + +- You can have up to 10,000 tag associations, pairings of 1 tag to 1 object, in your tenant. + +Because of these limits, it is recommended that you work with your governance experts and security teams to establish a list of tags that are most expressive of governance objects and access managed by Identity Security Cloud. + +These are the types of information often expressed in tags: + +- Affected departments + +- Compliance and regulatory categories + +- Remediation urgency levels + +- Risk levels + +Refer to [Tagging Items in Search](https://documentation.sailpoint.com/saas/help/search/index.html?h=tags#tagging-items-in-search) for more information about tagging objects in Identity Security Cloud. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Remove-BetaTaggedObject**](#delete-tagged-object) | **DELETE** `/tagged-objects/{type}/{id}` | Delete Object Tags +[**Remove-BetaTagsToManyObject**](#delete-tags-to-many-object) | **POST** `/tagged-objects/bulk-remove` | Remove Tags from Multiple Objects +[**Get-BetaTaggedObject**](#get-tagged-object) | **GET** `/tagged-objects/{type}/{id}` | Get Tagged Object +[**Get-BetaTaggedObjects**](#list-tagged-objects) | **GET** `/tagged-objects` | List Tagged Objects +[**Get-BetaTaggedObjectsByType**](#list-tagged-objects-by-type) | **GET** `/tagged-objects/{type}` | List Tagged Objects by Type +[**Send-BetaTaggedObject**](#put-tagged-object) | **PUT** `/tagged-objects/{type}/{id}` | Update Tagged Object +[**Set-BetaTagToObject**](#set-tag-to-object) | **POST** `/tagged-objects` | Add Tag to Object +[**Set-BetaTagsToManyObjects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag Multiple Objects + +## delete-tagged-object +Delete all tags from a tagged object. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Type | **String** | True | The type of object to delete tags from. +Path | Id | **String** | True | The ID of the object to delete tags from. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Type = "ACCESS_PROFILE" # String | The type of object to delete tags from. +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from. + +# Delete Object Tags + +try { + Remove-BetaTaggedObject-BetaType $Type -BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaTaggedObject -BetaType $Type -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTaggedObject" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-tags-to-many-object +This API removes tags from multiple objects. + +A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | BulkTaggedObject | [**BulkTaggedObject**](../models/bulk-tagged-object) | True | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$BulkTaggedObject = @"{ + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] +}"@ + +# Remove Tags from Multiple Objects + +try { + $Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject + Remove-BetaTagsToManyObject-BetaBulkTaggedObject $Result + + # Below is a request that includes all optional parameters + # Remove-BetaTagsToManyObject -BetaBulkTaggedObject $BulkTaggedObject +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTagsToManyObject" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-tagged-object +This gets a tagged object for the specified type. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Type | **String** | True | The type of tagged object to retrieve. +Path | Id | **String** | True | The ID of the object reference to retrieve. + +### Return type +[**TaggedObject**](../models/tagged-object) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Tagged object by type and ID. | TaggedObject +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + +# Get Tagged Object + +try { + Get-BetaTaggedObject-BetaType $Type -BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaTaggedObject -BetaType $Type -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObject" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-tagged-objects +This API returns a list of all tagged objects. + +Any authenticated token may be used to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* + +### Return type +[**TaggedObject[]**](../models/tagged-object) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of all tagged objects. | TaggedObject[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'tagName eq "BU_FINANCE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + +# List Tagged Objects + +try { + Get-BetaTaggedObjects + + # Below is a request that includes all optional parameters + # Get-BetaTaggedObjects -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObjects" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-tagged-objects-by-type +This API returns a list of all tagged objects by type. + +Any authenticated token may be used to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Type | **String** | True | The type of tagged object to retrieve. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* + +### Return type +[**TaggedObject[]**](../models/tagged-object) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of all tagged objects for specified type. | TaggedObject[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'objectRef.id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + +# List Tagged Objects by Type + +try { + Get-BetaTaggedObjectsByType-BetaType $Type + + # Below is a request that includes all optional parameters + # Get-BetaTaggedObjectsByType -BetaType $Type -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObjectsByType" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-tagged-object +This updates a tagged object for the specified type. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Type | **String** | True | The type of tagged object to update. +Path | Id | **String** | True | The ID of the object reference to update. + Body | TaggedObject | [**TaggedObject**](../models/tagged-object) | True | + +### Return type +[**TaggedObject**](../models/tagged-object) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Tagged object by type and ID. | TaggedObject +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Type = "ACCESS_PROFILE" # String | The type of tagged object to update. +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to update. +$TaggedObject = @"{ + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] +}"@ + +# Update Tagged Object + +try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Send-BetaTaggedObject-BetaType $Type -BetaId $Id -BetaTaggedObject $Result + + # Below is a request that includes all optional parameters + # Send-BetaTaggedObject -BetaType $Type -BetaId $Id -BetaTaggedObject $TaggedObject +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTaggedObject" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-tag-to-object +This adds a tag to an object. + +Any authenticated token may be used to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | TaggedObject | [**TaggedObject**](../models/tagged-object) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Created. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$TaggedObject = @"{ + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] +}"@ + +# Add Tag to Object + +try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Set-BetaTagToObject-BetaTaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-BetaTagToObject -BetaTaggedObject $TaggedObject +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTagToObject" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-tags-to-many-objects +This API adds tags to multiple objects. + +A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | BulkTaggedObject | [**BulkTaggedObject**](../models/bulk-tagged-object) | True | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + +### Return type +[**BulkTaggedObject**](../models/bulk-tagged-object) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Request succeeded. | BulkTaggedObject +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$BulkTaggedObject = @"{ + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] +}"@ + +# Tag Multiple Objects + +try { + $Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject + Set-BetaTagsToManyObjects-BetaBulkTaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-BetaTagsToManyObjects -BetaBulkTaggedObject $BulkTaggedObject +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTagsToManyObjects" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaTagsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaTagsApi.md new file mode 100644 index 000000000..ed3c50fc4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaTagsApi.md @@ -0,0 +1,226 @@ + +--- +id: beta-tags +title: Tags +pagination_label: Tags +sidebar_label: Tags +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Tags', 'BetaTags'] +slug: /tools/sdk/powershell/beta/methods/tags +tags: ['SDK', 'Software Development Kit', 'Tags', 'BetaTags'] +--- + +# Tags + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaTag**](#create-tag) | **POST** `/tags` | Create Tag +[**Remove-BetaTagById**](#delete-tag-by-id) | **DELETE** `/tags/{id}` | Delete Tag +[**Get-BetaTagById**](#get-tag-by-id) | **GET** `/tags/{id}` | Get Tag By Id +[**Get-BetaTags**](#list-tags) | **GET** `/tags` | List Tags + +## create-tag +This API creates new tag. + +A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Tag | [**Tag**](../models/tag) | True | + +### Return type +[**Tag**](../models/tag) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Created tag. | Tag +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Tag = @"{ + "created" : "2022-05-04T14:48:49Z", + "tagCategoryRefs" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "name" : "PCI", + "modified" : "2022-07-14T16:31:11Z", + "id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f" +}"@ + +# Create Tag + +try { + $Result = ConvertFrom-JsonToTag -Json $Tag + New-BetaTag-BetaTag $Result + + # Below is a request that includes all optional parameters + # New-BetaTag -BetaTag $Tag +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTag" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-tag-by-id +This API deletes a tag by specified id. + +A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the object reference to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to delete. + +# Delete Tag + +try { + Remove-BetaTagById-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaTagById -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTagById" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-tag-by-id +Returns a tag by its id. + +A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the object reference to retrieve. + +### Return type +[**Tag**](../models/tag) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Tag | Tag +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to retrieve. + +# Get Tag By Id + +try { + Get-BetaTagById-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaTagById -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTagById" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-tags +This API returns a list of tags. + +A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified** + +### Return type +[**Tag[]**](../models/tag) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of all tags. | Tag[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq "27462f54-61c7-4140-b5da-d5dbe27fc6db"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified** (optional) + +# List Tags + +try { + Get-BetaTags + + # Below is a request that includes all optional parameters + # Get-BetaTags -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTags" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaTaskManagementApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaTaskManagementApi.md new file mode 100644 index 000000000..98e00a474 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaTaskManagementApi.md @@ -0,0 +1,266 @@ + +--- +id: beta-task-management +title: TaskManagement +pagination_label: TaskManagement +sidebar_label: TaskManagement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskManagement', 'BetaTaskManagement'] +slug: /tools/sdk/powershell/beta/methods/task-management +tags: ['SDK', 'Software Development Kit', 'TaskManagement', 'BetaTaskManagement'] +--- + +# TaskManagement + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaPendingTaskHeaders**](#get-pending-task-headers) | **HEAD** `/task-status/pending-tasks` | Retrieve Pending Task List Headers +[**Get-BetaPendingTasks**](#get-pending-tasks) | **GET** `/task-status/pending-tasks` | Retrieve Pending Task Status List +[**Get-BetaTaskStatus**](#get-task-status) | **GET** `/task-status/{id}` | Get Task Status by ID +[**Get-BetaTaskStatusList**](#get-task-status-list) | **GET** `/task-status` | Retrieve Task Status List +[**Update-BetaTaskStatus**](#update-task-status) | **PATCH** `/task-status/{id}` | Update Task Status by ID + +## get-pending-task-headers +Responds with headers only for list of task statuses for pending tasks. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Retrieve headers for a list of TaskStatus for pending tasks. | +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Retrieve Pending Task List Headers + +try { + Get-BetaPendingTaskHeaders + + # Below is a request that includes all optional parameters + # Get-BetaPendingTaskHeaders -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingTaskHeaders" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-pending-tasks +Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**TaskStatus[]**](../models/task-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with a list of TaskStatus for pending tasks. | TaskStatus[] +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Retrieve Pending Task Status List + +try { + Get-BetaPendingTasks + + # Below is a request that includes all optional parameters + # Get-BetaPendingTasks -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingTasks" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-task-status +Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Task ID. + +### Return type +[**TaskStatus**](../models/task-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with a TaskStatus for the task with the given task ID. | TaskStatus +403 | Forbidden, generally due to a lack of security rights | +404 | TaskStatus with the given id was not found. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. + +# Get Task Status by ID + +try { + Get-BetaTaskStatus-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaTaskStatus -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaskStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-task-status-list +Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/beta/get-pending-tasks) endpoint. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** + +### Return type +[**TaskStatus[]**](../models/task-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with a TaskStatus for the task with the given task ID. | TaskStatus[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'completionStatus eq "Success"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) +$Sorters = "-created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) + +# Retrieve Task Status List + +try { + Get-BetaTaskStatusList + + # Below is a request that includes all optional parameters + # Get-BetaTaskStatusList -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaskStatusList" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-task-status +Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Task ID. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the object. + +### Return type +[**TaskStatus**](../models/task-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | This response indicates the PATCH operation succeeded, and the API returns the updated task object. | TaskStatus +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | The JSONPatch payload used to update the object. + + +# Update Task Status by ID + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaTaskStatus-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaTaskStatus -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaTaskStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaTenantApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaTenantApi.md new file mode 100644 index 000000000..efe3800b1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaTenantApi.md @@ -0,0 +1,63 @@ + +--- +id: beta-tenant +title: Tenant +pagination_label: Tenant +sidebar_label: Tenant +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Tenant', 'BetaTenant'] +slug: /tools/sdk/powershell/beta/methods/tenant +tags: ['SDK', 'Software Development Kit', 'Tenant', 'BetaTenant'] +--- + +# Tenant + API for reading tenant details. + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaTenant**](#get-tenant) | **GET** `/tenant` | Get Tenant Information. + +## get-tenant +This rest endpoint can be used to retrieve tenant details. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**Tenant**](../models/tenant) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Tenant Info | Tenant +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Tenant Information. + +try { + Get-BetaTenant + + # Below is a request that includes all optional parameters + # Get-BetaTenant +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenant" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaTransformsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaTransformsApi.md new file mode 100644 index 000000000..4acc9f199 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaTransformsApi.md @@ -0,0 +1,296 @@ + +--- +id: beta-transforms +title: Transforms +pagination_label: Transforms +sidebar_label: Transforms +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Transforms', 'BetaTransforms'] +slug: /tools/sdk/powershell/beta/methods/transforms +tags: ['SDK', 'Software Development Kit', 'Transforms', 'BetaTransforms'] +--- + +# Transforms + Operations for creating, managing, and deleting transforms. + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaTransform**](#create-transform) | **POST** `/transforms` | Create transform +[**Remove-BetaTransform**](#delete-transform) | **DELETE** `/transforms/{id}` | Delete a transform +[**Get-BetaTransform**](#get-transform) | **GET** `/transforms/{id}` | Transform by ID +[**Get-BetaTransforms**](#list-transforms) | **GET** `/transforms` | List transforms +[**Update-BetaTransform**](#update-transform) | **PUT** `/transforms/{id}` | Update a transform + +## create-transform +Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. A token with transform write authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Transform | [**Transform**](../models/transform) | True | The transform to be created. + +### Return type +[**TransformRead**](../models/transform-read) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Indicates the transform was successfully created and returns its representation. | TransformRead +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Transform = @"{ + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" +}"@ + +# Create transform + +try { + $Result = ConvertFrom-JsonToTransform -Json $Transform + New-BetaTransform-BetaTransform $Result + + # Below is a request that includes all optional parameters + # New-BetaTransform -BetaTransform $Transform +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTransform" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-transform +Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. +A token with transform delete authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the transform to delete + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete + +# Delete a transform + +try { + Remove-BetaTransform-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaTransform -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTransform" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-transform +This API returns the transform specified by the given ID. +A token with transform read authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the transform to retrieve + +### Return type +[**TransformRead**](../models/transform-read) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Transform with the given ID | TransformRead +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve + +# Transform by ID + +try { + Get-BetaTransform-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaTransform -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTransform" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-transforms +Gets a list of all saved transform objects. +A token with transforms-list read authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Name | **String** | (optional) | Name of the transform to retrieve from the list. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* + +### Return type +[**TransformRead[]**](../models/transform-read) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of transforms matching the given criteria. | TransformRead[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional) +$Filters = 'name eq "Uppercase"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) + +# List transforms + +try { + Get-BetaTransforms + + # Below is a request that includes all optional parameters + # Get-BetaTransforms -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaName $Name -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTransforms" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-transform +Replaces the transform specified by the given ID with the transform provided in the request body. Only the "attributes" field is mutable. Attempting to change other properties (ex. "name" and "type") will result in an error. +A token with transform write authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the transform to update + Body | Transform | [**Transform**](../models/transform) | (optional) | The updated transform object. Must include ""name"", ""type"", and ""attributes"" fields, but ""name"" and ""type"" must not be modified. + +### Return type +[**TransformRead**](../models/transform-read) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Indicates the transform was successfully updated and returns its new representation. | TransformRead +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update +$Transform = @"{ + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" +}"@ + +# Update a transform + +try { + Update-BetaTransform-BetaId $Id + + # Below is a request that includes all optional parameters + # Update-BetaTransform -BetaId $Id -BetaTransform $Transform +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaTransform" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaTriggersApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaTriggersApi.md new file mode 100644 index 000000000..0249c8c0d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaTriggersApi.md @@ -0,0 +1,616 @@ + +--- +id: beta-triggers +title: Triggers +pagination_label: Triggers +sidebar_label: Triggers +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Triggers', 'BetaTriggers'] +slug: /tools/sdk/powershell/beta/methods/triggers +tags: ['SDK', 'Software Development Kit', 'Triggers', 'BetaTriggers'] +--- + +# Triggers + Event Triggers provide real-time updates to changes in Identity Security Cloud so you can take action as soon as an event occurs, rather than poll an API endpoint for updates. Identity Security Cloud provides a user interface within the admin console to create and manage trigger subscriptions. These endpoints allow for programatically creating and managing trigger subscriptions. + +There are two types of event triggers: + * `FIRE_AND_FORGET`: This trigger type will send a payload to each subscriber without needing a response. Each trigger of this type has a limit of **50 subscriptions**. + * `REQUEST_RESPONSE`: This trigger type will send a payload to a subscriber and expect a response back. Each trigger of this type may only have **one subscription**. + +## Available Event Triggers +Production ready event triggers that are available in all tenants. + +| Name | ID | Type | Trigger condition | +|-|-|-|-| +| [Access Request Dynamic Approval](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-dynamic-approval/) | idn:access-request-dynamic-approver | REQUEST_RESPONSE |After an access request is submitted. Expects the subscriber to respond with the ID of an identity or workgroup to add to the approval workflow. | +| [Access Request Decision](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-decision/) | idn:access-request-post-approval | FIRE_AND_FORGET | After an access request is approved. | +| [Access Request Submitted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-submitted/) | idn:access-request-pre-approval | REQUEST_RESPONSE | After an access request is submitted. Expects the subscriber to respond with an approval decision. | +| [Account Aggregation Completed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/account-aggregation-completed/) | idn:account-aggregation-completed | FIRE_AND_FORGET | After an account aggregation completed, terminated, failed. | +| Account Attributes Changed | idn:account-attributes-changed | FIRE_AND_FORGET | After an account aggregation, and one or more account attributes have changed. | +| Account Correlated | idn:account-correlated | FIRE_AND_FORGET | After an account is added to an identity. | +| Accounts Collected for Aggregation | idn:aggregation-accounts-collected | FIRE_AND_FORGET | New, changed, and deleted accounts have been gathered during an aggregation and are being processed. | +| Account Uncorrelated | idn:account-uncorrelated | FIRE_AND_FORGET | After an account is removed from an identity. | +| Campaign Activated | idn:campaign-activated | FIRE_AND_FORGET | After a campaign is activated. | +| Campaign Ended | idn:campaign-ended | FIRE_AND_FORGET | After a campaign ends. | +| Campaign Generated | idn:campaign-generated | FIRE_AND_FORGET | After a campaign finishes generating. | +| Certification Signed Off | idn:certification-signed-off | FIRE_AND_FORGET | After a certification is signed off by its reviewer. | +| [Identity Attributes Changed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/account-aggregation-completed/) | idn:identity-attributes-changed | FIRE_AND_FORGET | After One or more identity attributes changed. | +| [Identity Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/identity-created/) | idn:identity-created | FIRE_AND_FORGET | After an identity is created. | +| [Provisioning Action Completed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) | idn:post-provisioning | FIRE_AND_FORGET | After a provisioning action completed on a source. | +| [Scheduled Search](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/scheduled-search/) | idn:saved-search-complete | FIRE_AND_FORGET | After a scheduled search completed. | +| [Source Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-created/) | idn:source-created | FIRE_AND_FORGET | After a source is created. | +| [Source Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-deleted/) | idn:source-deleted | FIRE_AND_FORGET | After a source is deleted. | +| [Source Updated](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-updated/) | idn:source-updated | FIRE_AND_FORGET | After configuration changes have been made to a source. | +| [VA Cluster Status Change](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/va-cluster-status-change/) | idn:va-cluster-status-change | FIRE_AND_FORGET | After the status of a VA cluster has changed. | + +## Early Access Event Triggers +Triggers that are in-development and not ready for production use. Please contact support to enable these triggers in your tenant. + +| Name | ID | Type | Trigger condition | +|-|-|-|-| +| [Identity Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/identity-deleted/) | idn:identity-deleted | FIRE_AND_FORGET | After an identity is deleted. | +| [Source Account Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-created/) | idn:source-account-created | FIRE_AND_FORGET | After a source account is created. | +| [Source Account Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-deleted/) | idn:source-account-deleted | FIRE_AND_FORGET | After a source account is deleted. | +| [Source Account Updated](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-updated/) | idn:source-account-updated | FIRE_AND_FORGET | After a source account is changed. | + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Complete-BetaTriggerInvocation**](#complete-trigger-invocation) | **POST** `/trigger-invocations/{id}/complete` | Complete Trigger Invocation +[**New-BetaSubscription**](#create-subscription) | **POST** `/trigger-subscriptions` | Create a Subscription +[**Remove-BetaSubscription**](#delete-subscription) | **DELETE** `/trigger-subscriptions/{id}` | Delete a Subscription +[**Get-BetaSubscriptions**](#list-subscriptions) | **GET** `/trigger-subscriptions` | List Subscriptions +[**Get-BetaTriggerInvocationStatus**](#list-trigger-invocation-status) | **GET** `/trigger-invocations/status` | List Latest Invocation Statuses +[**Get-BetaTriggers**](#list-triggers) | **GET** `/triggers` | List Triggers +[**Update-BetaSubscription**](#patch-subscription) | **PATCH** `/trigger-subscriptions/{id}` | Patch a Subscription +[**Start-BetaTestTriggerInvocation**](#start-test-trigger-invocation) | **POST** `/trigger-invocations/test` | Start a Test Invocation +[**Test-BetaSubscriptionFilter**](#test-subscription-filter) | **POST** `/trigger-subscriptions/validate-filter` | Validate a Subscription Filter +[**Update-BetaSubscription**](#update-subscription) | **PUT** `/trigger-subscriptions/{id}` | Update a Subscription + +## complete-trigger-invocation +Completes an invocation to a REQUEST_RESPONSE type trigger. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the invocation to complete. + Body | CompleteInvocation | [**CompleteInvocation**](../models/complete-invocation) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the invocation to complete. +$CompleteInvocation = @"{ + "output" : { + "approved" : false + }, + "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "error" : "Access request is denied." +}"@ + +# Complete Trigger Invocation + +try { + $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation + Complete-BetaTriggerInvocation-BetaId $Id -BetaCompleteInvocation $Result + + # Below is a request that includes all optional parameters + # Complete-BetaTriggerInvocation -BetaId $Id -BetaCompleteInvocation $CompleteInvocation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaTriggerInvocation" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-subscription +This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: +* HTTP subscriptions require httpConfig +* EventBridge subscriptions require eventBridgeConfig + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | SubscriptionPostRequest | [**SubscriptionPostRequest**](../models/subscription-post-request) | True | + +### Return type +[**Subscription**](../models/subscription) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | New subscription to a trigger. The trigger can now be invoked by the method defined in the subscription. | Subscription +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SubscriptionPostRequest = @"{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "triggerId" : "idn:access-requested", + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true +}"@ + +# Create a Subscription + +try { + $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest + New-BetaSubscription-BetaSubscriptionPostRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaSubscription -BetaSubscriptionPostRequest $SubscriptionPostRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSubscription" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-subscription +Deletes an existing subscription to a trigger. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Subscription ID + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID + +# Delete a Subscription + +try { + Remove-BetaSubscription-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSubscription -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSubscription" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-subscriptions +Gets a list of all trigger subscriptions. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** + +### Return type +[**Subscription[]**](../models/subscription) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of subscriptions. | Subscription[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional) +$Sorters = "triggerName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) + +# List Subscriptions + +try { + Get-BetaSubscriptions + + # Below is a request that includes all optional parameters + # Get-BetaSubscriptions -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSubscriptions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-trigger-invocation-status +Gets a list of latest invocation statuses. +Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. +This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** + +### Return type +[**InvocationStatus[]**](../models/invocation-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of latest invocation statuses. | InvocationStatus[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'triggerId eq "idn:access-request-dynamic-approver"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* (optional) +$Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) + +# List Latest Invocation Statuses + +try { + Get-BetaTriggerInvocationStatus + + # Below is a request that includes all optional parameters + # Get-BetaTriggerInvocationStatus -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTriggerInvocationStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-triggers +Gets a list of triggers that are available in the tenant. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** + +### Return type +[**Trigger[]**](../models/trigger) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of triggers. | Trigger[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq "idn:access-request-post-approval"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* (optional) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** (optional) + +# List Triggers + +try { + Get-BetaTriggers + + # Below is a request that includes all optional parameters + # Get-BetaTriggers -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTriggers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-subscription +This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: + +**name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Subscription to patch + Body | SubscriptionPatchRequestInner | [**[]SubscriptionPatchRequestInner**](../models/subscription-patch-request-inner) | True | + +### Return type +[**Subscription**](../models/subscription) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated subscription. | Subscription +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription to patch + $SubscriptionPatchRequestInner = @""@ # SubscriptionPatchRequestInner[] | + + +# Patch a Subscription + +try { + $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner + Update-BetaSubscription-BetaId $Id -BetaSubscriptionPatchRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaSubscription -BetaId $Id -BetaSubscriptionPatchRequestInner $SubscriptionPatchRequestInner +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSubscription" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-test-trigger-invocation +Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | TestInvocation | [**TestInvocation**](../models/test-invocation) | True | + +### Return type +[**Invocation[]**](../models/invocation) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Test trigger invocations that have been started for specified subscription(s). | Invocation[] +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$TestInvocation = @"{ + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + }, + "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], + "triggerId" : "idn:access-request-post-approval", + "contentJson" : { + "workflowId" : 1234 + } +}"@ + +# Start a Test Invocation + +try { + $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation + Start-BetaTestTriggerInvocation-BetaTestInvocation $Result + + # Below is a request that includes all optional parameters + # Start-BetaTestTriggerInvocation -BetaTestInvocation $TestInvocation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaTestTriggerInvocation" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## test-subscription-filter +Validates a JSONPath filter expression against a provided mock input. +Request requires a security scope of: + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | ValidateFilterInputDto | [**ValidateFilterInputDto**](../models/validate-filter-input-dto) | True | + +### Return type +[**ValidateFilterOutputDto**](../models/validate-filter-output-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Boolean whether specified filter expression is valid against the input. | ValidateFilterOutputDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$ValidateFilterInputDto = @"{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + } +}"@ + +# Validate a Subscription Filter + +try { + $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto + Test-BetaSubscriptionFilter-BetaValidateFilterInputDto $Result + + # Below is a request that includes all optional parameters + # Test-BetaSubscriptionFilter -BetaValidateFilterInputDto $ValidateFilterInputDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSubscriptionFilter" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-subscription +This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing + Subscription is completely replaced. The following fields are immutable: + + + * id + + * triggerId + + + Attempts to modify these fields result in 400. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Subscription ID + Body | SubscriptionPutRequest | [**SubscriptionPutRequest**](../models/subscription-put-request) | True | + +### Return type +[**Subscription**](../models/subscription) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated subscription. | Subscription +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID +$SubscriptionPutRequest = @"{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true +}"@ + +# Update a Subscription + +try { + $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest + Update-BetaSubscription-BetaId $Id -BetaSubscriptionPutRequest $Result + + # Below is a request that includes all optional parameters + # Update-BetaSubscription -BetaId $Id -BetaSubscriptionPutRequest $SubscriptionPutRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSubscription" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaUIMetadataApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaUIMetadataApi.md new file mode 100644 index 000000000..cb4648861 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaUIMetadataApi.md @@ -0,0 +1,115 @@ + +--- +id: beta-ui-metadata +title: UIMetadata +pagination_label: UIMetadata +sidebar_label: UIMetadata +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UIMetadata', 'BetaUIMetadata'] +slug: /tools/sdk/powershell/beta/methods/ui-metadata +tags: ['SDK', 'Software Development Kit', 'UIMetadata', 'BetaUIMetadata'] +--- + +# UIMetadata + API for managing UI Metadata. Use this API to manage metadata about your User Interface. +For example you can set the iFrameWhitelist parameter to permit another domain to encapsulate IDN within an iframe or set the usernameEmptyText to change the placeholder text for Username on your tenant's login screen. + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-BetaTenantUiMetadata**](#get-tenant-ui-metadata) | **GET** `/ui-metadata/tenant` | Get a tenant UI metadata +[**Set-BetaTenantUiMetadata**](#set-tenant-ui-metadata) | **PUT** `/ui-metadata/tenant` | Update tenant UI metadata + +## get-tenant-ui-metadata +This API endpoint retrieves UI metadata configured for your tenant. +A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**TenantUiMetadataItemResponse**](../models/tenant-ui-metadata-item-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A tenant UI metadata object | TenantUiMetadataItemResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get a tenant UI metadata + +try { + Get-BetaTenantUiMetadata + + # Below is a request that includes all optional parameters + # Get-BetaTenantUiMetadata +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantUiMetadata" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-tenant-ui-metadata +This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. +A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | TenantUiMetadataItemUpdateRequest | [**TenantUiMetadataItemUpdateRequest**](../models/tenant-ui-metadata-item-update-request) | True | + +### Return type +[**TenantUiMetadataItemResponse**](../models/tenant-ui-metadata-item-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A tenant UI metadata object | TenantUiMetadataItemResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$TenantUiMetadataItemUpdateRequest = @"{ + "usernameEmptyText" : "Please provide your work email address...", + "usernameLabel" : "Email", + "iframeWhiteList" : "http://example.com http://example2.com" +}"@ + +# Update tenant UI metadata + +try { + $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest + Set-BetaTenantUiMetadata-BetaTenantUiMetadataItemUpdateRequest $Result + + # Below is a request that includes all optional parameters + # Set-BetaTenantUiMetadata -BetaTenantUiMetadataItemUpdateRequest $TenantUiMetadataItemUpdateRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTenantUiMetadata" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaVendorConnectorMappingsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaVendorConnectorMappingsApi.md new file mode 100644 index 000000000..5bcf4f7f7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaVendorConnectorMappingsApi.md @@ -0,0 +1,204 @@ + +--- +id: beta-vendor-connector-mappings +title: VendorConnectorMappings +pagination_label: VendorConnectorMappings +sidebar_label: VendorConnectorMappings +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMappings', 'BetaVendorConnectorMappings'] +slug: /tools/sdk/powershell/beta/methods/vendor-connector-mappings +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappings', 'BetaVendorConnectorMappings'] +--- + +# VendorConnectorMappings + Vendors use ISC connectors to connect their source data to ISC, but the data in their source and the data in ISC may be stored in different formats. +Connector mappings allow vendors to match their data on both sides of the connection. +The vendors can then track and manage access across their sources from ISC. +This API allows you to create and manage these vendor connector mappings. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaVendorConnectorMapping**](#create-vendor-connector-mapping) | **POST** `/vendor-connector-mappings` | Create Vendor Connector Mapping +[**Remove-BetaVendorConnectorMapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete Vendor Connector Mapping +[**Get-BetaVendorConnectorMappings**](#get-vendor-connector-mappings) | **GET** `/vendor-connector-mappings` | List Vendor Connector Mappings + +## create-vendor-connector-mapping +Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | VendorConnectorMapping | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | True | + +### Return type +[**VendorConnectorMapping**](../models/vendor-connector-mapping) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully created a new vendor connector mapping. | VendorConnectorMapping +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +405 | Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method. | CreateDomainDkim405Response +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$VendorConnectorMapping = @"{ + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } +}"@ + +# Create Vendor Connector Mapping + +try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + New-BetaVendorConnectorMapping-BetaVendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # New-BetaVendorConnectorMapping -BetaVendorConnectorMapping $VendorConnectorMapping +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaVendorConnectorMapping" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-vendor-connector-mapping +Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | VendorConnectorMapping | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | True | + +### Return type +[**DeleteVendorConnectorMapping200Response**](../models/delete-vendor-connector-mapping200-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully deleted the specified vendor connector mapping. | DeleteVendorConnectorMapping200Response +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$VendorConnectorMapping = @"{ + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } +}"@ + +# Delete Vendor Connector Mapping + +try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + Remove-BetaVendorConnectorMapping-BetaVendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # Remove-BetaVendorConnectorMapping -BetaVendorConnectorMapping $VendorConnectorMapping +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaVendorConnectorMapping" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-vendor-connector-mappings +Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**VendorConnectorMapping[]**](../models/vendor-connector-mapping) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully retrieved list. | VendorConnectorMapping[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +405 | Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method. | CreateDomainDkim405Response +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List Vendor Connector Mappings + +try { + Get-BetaVendorConnectorMappings + + # Below is a request that includes all optional parameters + # Get-BetaVendorConnectorMappings +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaVendorConnectorMappings" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaWorkItemsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaWorkItemsApi.md new file mode 100644 index 000000000..76ce90430 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaWorkItemsApi.md @@ -0,0 +1,598 @@ + +--- +id: beta-work-items +title: WorkItems +pagination_label: WorkItems +sidebar_label: WorkItems +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItems', 'BetaWorkItems'] +slug: /tools/sdk/powershell/beta/methods/work-items +tags: ['SDK', 'Software Development Kit', 'WorkItems', 'BetaWorkItems'] +--- + +# WorkItems + Use this API to implement work item functionality. +With this functionality in place, users can manage their work items (tasks). + +Work items refer to the tasks users see in Identity Security Cloud's Task Manager. +They can see the pending work items they need to complete, as well as the work items they have already completed. +Task Manager lists the work items along with the involved sources, identities, accounts, and the timestamp when the work item was created. +For example, a user may see a pending 'Create an Account' work item for the identity Fred.Astaire in GitHub for Fred's GitHub account, fred-astaire-sp. +Once the user completes the work item, the work item will be listed with his or her other completed work items. + +To complete work items, users can use their dashboards and select the 'My Tasks' widget. +The widget will list any work items they need to complete, and they can select the work item from the list to review its details. +When they complete the work item, they can select 'Mark Complete' to add it to their list of completed work items. + +Refer to [Task Manager](https://documentation.sailpoint.com/saas/user-help/task_manager.html) for more information about work items, including the different types of work items users may need to complete. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Approve-BetaApprovalItem**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item +[**Approve-BetaApprovalItemsInBulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items +[**Complete-BetaWorkItem**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a Work Item +[**Invoke-BetaForwardWorkItem**](#forward-work-item) | **POST** `/work-items/{id}/forward` | Forward a Work Item +[**Get-BetaCompletedWorkItems**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed Work Items +[**Get-BetaCountCompletedWorkItems**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count Completed Work Items +[**Get-BetaCountWorkItems**](#get-count-work-items) | **GET** `/work-items/count` | Count Work Items +[**Get-BetaWorkItem**](#get-work-item) | **GET** `/work-items/{id}` | Get a Work Item +[**Get-BetaWorkItemsSummary**](#get-work-items-summary) | **GET** `/work-items/summary` | Work Items Summary +[**Get-BetaWorkItems**](#list-work-items) | **GET** `/work-items` | List Work Items +[**Deny-BetaApprovalItem**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item +[**Deny-BetaApprovalItemsInBulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items +[**Submit-BetaAccountSelection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections + +## approve-approval-item +This API approves an Approval Item. Either an admin, or the owning/current user must make this request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the work item +Path | ApprovalItemId | **String** | True | The ID of the approval item. + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A work items details object. | WorkItems +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item +$ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + +# Approve an Approval Item + +try { + Approve-BetaApprovalItem-BetaId $Id -BetaApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Approve-BetaApprovalItem -BetaId $Id -BetaApprovalItemId $ApprovalItemId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItem" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## approve-approval-items-in-bulk +This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the work item + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A work items details object. | WorkItems +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + +# Bulk approve Approval Items + +try { + Approve-BetaApprovalItemsInBulk-BetaId $Id + + # Below is a request that includes all optional parameters + # Approve-BetaApprovalItemsInBulk -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItemsInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## complete-work-item +This API completes a work item. Either an admin, or the owning/current user must make this request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the work item + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A WorkItems object | WorkItems +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + +# Complete a Work Item + +try { + Complete-BetaWorkItem-BetaId $Id + + # Below is a request that includes all optional parameters + # Complete-BetaWorkItem -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaWorkItem" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## forward-work-item +This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the work item + Body | WorkItemForward | [**WorkItemForward**](../models/work-item-forward) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Success, but no data is returned. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item +$WorkItemForward = @"{ + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true +}"@ + +# Forward a Work Item + +try { + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Invoke-BetaForwardWorkItem-BetaId $Id -BetaWorkItemForward $Result + + # Below is a request that includes all optional parameters + # Invoke-BetaForwardWorkItem -BetaId $Id -BetaWorkItemForward $WorkItemForward +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardWorkItem" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-completed-work-items +This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | OwnerId | **String** | (optional) | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**WorkItems[]**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of completed work items. | WorkItems[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OwnerId = "MyOwnerId" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Completed Work Items + +try { + Get-BetaCompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-BetaCompletedWorkItems -BetaOwnerId $OwnerId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedWorkItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-count-completed-work-items +This gets a count of completed work items belonging to either the specified user(admin required), or the current user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | OwnerId | **String** | (optional) | ID of the work item owner. + +### Return type +[**WorkItemsCount[]**](../models/work-items-count) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of work items | WorkItemsCount[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + +# Count Completed Work Items + +try { + Get-BetaCountCompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-BetaCountCompletedWorkItems -BetaOwnerId $OwnerId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountCompletedWorkItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-count-work-items +This gets a count of work items belonging to either the specified user(admin required), or the current user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | OwnerId | **String** | (optional) | ID of the work item owner. + +### Return type +[**WorkItemsCount**](../models/work-items-count) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of work items | WorkItemsCount +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + +# Count Work Items + +try { + Get-BetaCountWorkItems + + # Below is a request that includes all optional parameters + # Get-BetaCountWorkItems -BetaOwnerId $OwnerId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountWorkItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-work-item +This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the work item. + Query | OwnerId | **String** | (optional) | ID of the work item owner. + +### Return type +[**WorkItems[]**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The work item with the given ID. | WorkItems[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "MyId" # String | ID of the work item. +$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + +# Get a Work Item + +try { + Get-BetaWorkItem-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkItem -BetaId $Id -BetaOwnerId $OwnerId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItem" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-work-items-summary +This gets a summary of work items belonging to either the specified user(admin required), or the current user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | OwnerId | **String** | (optional) | ID of the work item owner. + +### Return type +[**WorkItemsSummary**](../models/work-items-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of work items | WorkItemsSummary +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + +# Work Items Summary + +try { + Get-BetaWorkItemsSummary + + # Below is a request that includes all optional parameters + # Get-BetaWorkItemsSummary -BetaOwnerId $OwnerId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItemsSummary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-work-items +This gets a collection of work items belonging to either the specified user(admin required), or the current user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | OwnerId | **String** | (optional) | ID of the work item owner. + +### Return type +[**WorkItems[]**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of work items | WorkItems[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + +# List Work Items + +try { + Get-BetaWorkItems + + # Below is a request that includes all optional parameters + # Get-BetaWorkItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaOwnerId $OwnerId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## reject-approval-item +This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the work item +Path | ApprovalItemId | **String** | True | The ID of the approval item. + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A work items details object. | WorkItems +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item +$ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + +# Reject an Approval Item + +try { + Deny-BetaApprovalItem-BetaId $Id -BetaApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Deny-BetaApprovalItem -BetaId $Id -BetaApprovalItemId $ApprovalItemId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItem" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## reject-approval-items-in-bulk +This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the work item + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A work items details object. | WorkItems +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + +# Bulk reject Approval Items + +try { + Deny-BetaApprovalItemsInBulk-BetaId $Id + + # Below is a request that includes all optional parameters + # Deny-BetaApprovalItemsInBulk -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItemsInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## submit-account-selection +This API submits account selections. Either an admin, or the owning/current user must make this request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the work item + Body | RequestBody | [**map[string]AnyType**](https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4) | True | Account Selection Data map, keyed on fieldName + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A work items details object. | WorkItems +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item +$RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName + +# Submit Account Selections + +try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-BetaAccountSelection-BetaId $Id -BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Submit-BetaAccountSelection -BetaId $Id -BetaRequestBody $RequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaAccountSelection" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaWorkReassignmentApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaWorkReassignmentApi.md new file mode 100644 index 000000000..6aadcaa16 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaWorkReassignmentApi.md @@ -0,0 +1,444 @@ + +--- +id: beta-work-reassignment +title: WorkReassignment +pagination_label: WorkReassignment +sidebar_label: WorkReassignment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkReassignment', 'BetaWorkReassignment'] +slug: /tools/sdk/powershell/beta/methods/work-reassignment +tags: ['SDK', 'Software Development Kit', 'WorkReassignment', 'BetaWorkReassignment'] +--- + +# WorkReassignment + Use this API to implement work reassignment functionality. + +Work Reassignment allows access request reviews, certifications, and manual provisioning tasks assigned to a user to be reassigned to a different user. This is primarily used for: + +- Temporarily redirecting work for users who are out of office, such as on vacation or sick leave +- Permanently redirecting work for users who should not be assigned these tasks at all, such as senior executives or service identities + +Users can define reassignments for themselves, managers can add them for their team members, and administrators can configure them on any user’s behalf. Work assigned during the specified reassignment timeframes will be automatically reassigned to the designated user as it is created. + +Refer to [Work Reassignment](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html) for more information about this topic. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BetaReassignmentConfiguration**](#create-reassignment-configuration) | **POST** `/reassignment-configurations` | Create a Reassignment Configuration +[**Remove-BetaReassignmentConfiguration**](#delete-reassignment-configuration) | **DELETE** `/reassignment-configurations/{identityId}/{configType}` | Delete Reassignment Configuration +[**Get-BetaEvaluateReassignmentConfiguration**](#get-evaluate-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}/evaluate/{configType}` | Evaluate Reassignment Configuration +[**Get-BetaReassignmentConfigTypes**](#get-reassignment-config-types) | **GET** `/reassignment-configurations/types` | List Reassignment Config Types +[**Get-BetaReassignmentConfiguration**](#get-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}` | Get Reassignment Configuration +[**Get-BetaTenantConfigConfiguration**](#get-tenant-config-configuration) | **GET** `/reassignment-configurations/tenant-config` | Get Tenant-wide Reassignment Configuration settings +[**Get-BetaReassignmentConfigurations**](#list-reassignment-configurations) | **GET** `/reassignment-configurations` | List Reassignment Configurations +[**Send-BetaReassignmentConfig**](#put-reassignment-config) | **PUT** `/reassignment-configurations/{identityId}` | Update Reassignment Configuration +[**Send-BetaTenantConfiguration**](#put-tenant-configuration) | **PUT** `/reassignment-configurations/tenant-config` | Update Tenant-wide Reassignment Configuration settings + +## create-reassignment-configuration +Creates a new Reassignment Configuration for the specified identity. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | ConfigurationItemRequest | [**ConfigurationItemRequest**](../models/configuration-item-request) | True | + +### Return type +[**ConfigurationItemResponse**](../models/configuration-item-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | The newly created Reassignment Configuration object | ConfigurationItemResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$ConfigurationItemRequest = @"{ + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" +}"@ + +# Create a Reassignment Configuration + +try { + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + New-BetaReassignmentConfiguration-BetaConfigurationItemRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaReassignmentConfiguration -BetaConfigurationItemRequest $ConfigurationItemRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaReassignmentConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-reassignment-configuration +Deletes a single reassignment configuration for the specified identity + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityId | **String** | True | unique identity id +Path | ConfigType | [**ConfigTypeEnum**](../models/config-type-enum) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | Reassignment Configuration deleted | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id +$ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | + +# Delete Reassignment Configuration + +try { + Remove-BetaReassignmentConfiguration-BetaIdentityId $IdentityId -BetaConfigType $ConfigType + + # Below is a request that includes all optional parameters + # Remove-BetaReassignmentConfiguration -BetaIdentityId $IdentityId -BetaConfigType $ConfigType +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaReassignmentConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-evaluate-reassignment-configuration +Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityId | **String** | True | unique identity id +Path | ConfigType | [**ConfigTypeEnum**](../models/config-type-enum) | True | Reassignment work type + Query | ExclusionFilters | **[]String** | (optional) | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments + +### Return type +[**EvaluateResponse[]**](../models/evaluate-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Evaluated Reassignment Configuration | EvaluateResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id +$ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type +$ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) + +$ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) + +# Evaluate Reassignment Configuration + +try { + Get-BetaEvaluateReassignmentConfiguration-BetaIdentityId $IdentityId -BetaConfigType $ConfigType + + # Below is a request that includes all optional parameters + # Get-BetaEvaluateReassignmentConfiguration -BetaIdentityId $IdentityId -BetaConfigType $ConfigType -BetaExclusionFilters $ExclusionFilters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEvaluateReassignmentConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-reassignment-config-types +Gets a collection of types which are available in the Reassignment Configuration UI. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**ConfigType[]**](../models/config-type) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Reassignment Configuration Types | ConfigType[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List Reassignment Config Types + +try { + Get-BetaReassignmentConfigTypes + + # Below is a request that includes all optional parameters + # Get-BetaReassignmentConfigTypes +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigTypes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-reassignment-configuration +Gets the Reassignment Configuration for an identity. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityId | **String** | True | unique identity id + +### Return type +[**ConfigurationResponse**](../models/configuration-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reassignment Configuration for an identity | ConfigurationResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id + +# Get Reassignment Configuration + +try { + Get-BetaReassignmentConfiguration-BetaIdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Get-BetaReassignmentConfiguration -BetaIdentityId $IdentityId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-tenant-config-configuration +Gets the global Reassignment Configuration settings for the requestor's tenant. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**TenantConfigurationResponse**](../models/tenant-configuration-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Tenant-wide Reassignment Configuration settings | TenantConfigurationResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Tenant-wide Reassignment Configuration settings + +try { + Get-BetaTenantConfigConfiguration + + # Below is a request that includes all optional parameters + # Get-BetaTenantConfigConfiguration +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantConfigConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-reassignment-configurations +Gets all Reassignment configuration for the current org. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**ConfigurationResponse[]**](../models/configuration-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of Reassignment Configurations for an org | ConfigurationResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List Reassignment Configurations + +try { + Get-BetaReassignmentConfigurations + + # Below is a request that includes all optional parameters + # Get-BetaReassignmentConfigurations +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigurations" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-reassignment-config +Replaces existing Reassignment configuration for an identity with the newly provided configuration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityId | **String** | True | unique identity id + Body | ConfigurationItemRequest | [**ConfigurationItemRequest**](../models/configuration-item-request) | True | + +### Return type +[**ConfigurationItemResponse**](../models/configuration-item-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reassignment Configuration updated | ConfigurationItemResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id +$ConfigurationItemRequest = @"{ + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" +}"@ + +# Update Reassignment Configuration + +try { + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + Send-BetaReassignmentConfig-BetaIdentityId $IdentityId -BetaConfigurationItemRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaReassignmentConfig -BetaIdentityId $IdentityId -BetaConfigurationItemRequest $ConfigurationItemRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaReassignmentConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-tenant-configuration +Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | TenantConfigurationRequest | [**TenantConfigurationRequest**](../models/tenant-configuration-request) | True | + +### Return type +[**TenantConfigurationResponse**](../models/tenant-configuration-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Tenant-wide Reassignment Configuration settings | TenantConfigurationResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$TenantConfigurationRequest = @"{ + "configDetails" : { + "disabled" : true + } +}"@ + +# Update Tenant-wide Reassignment Configuration settings + +try { + $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest + Send-BetaTenantConfiguration-BetaTenantConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaTenantConfiguration -BetaTenantConfigurationRequest $TenantConfigurationRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTenantConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaWorkflowsApi.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaWorkflowsApi.md new file mode 100644 index 000000000..f7acf15aa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Methods/BetaWorkflowsApi.md @@ -0,0 +1,882 @@ + +--- +id: beta-workflows +title: Workflows +pagination_label: Workflows +sidebar_label: Workflows +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Workflows', 'BetaWorkflows'] +slug: /tools/sdk/powershell/beta/methods/workflows +tags: ['SDK', 'Software Development Kit', 'Workflows', 'BetaWorkflows'] +--- + +# Workflows + Workflows allow administrators to create custom automation scripts directly within Identity Security Cloud. These automation scripts respond to [event triggers](https://developer.sailpoint.com/docs/extensibility/event-triggers/#how-to-get-started-with-event-triggers) and perform a series of actions to perform tasks that are either too cumbersome or not available in the Identity Security Cloud UI. Workflows can be configured via a graphical user interface within Identity Security Cloud, or by creating and uploading a JSON formatted script to the Workflow service. The Workflows API collection provides the necessary functionality to create, manage, and test your workflows via REST. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/beta* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Suspend-BetaWorkflowExecution**](#cancel-workflow-execution) | **POST** `/workflow-executions/{id}/cancel` | Cancel Workflow Execution by ID +[**New-BetaWorkflow**](#create-workflow) | **POST** `/workflows` | Create Workflow +[**Remove-BetaWorkflow**](#delete-workflow) | **DELETE** `/workflows/{id}` | Delete Workflow By Id +[**Get-BetaWorkflow**](#get-workflow) | **GET** `/workflows/{id}` | Get Workflow By Id +[**Get-BetaWorkflowExecution**](#get-workflow-execution) | **GET** `/workflow-executions/{id}` | Get Workflow Execution +[**Get-BetaWorkflowExecutionHistory**](#get-workflow-execution-history) | **GET** `/workflow-executions/{id}/history` | Get Workflow Execution History +[**Get-BetaWorkflowExecutions**](#get-workflow-executions) | **GET** `/workflows/{id}/executions` | List Workflow Executions +[**Get-BetaCompleteWorkflowLibrary**](#list-complete-workflow-library) | **GET** `/workflow-library` | List Complete Workflow Library +[**Get-BetaWorkflowLibraryActions**](#list-workflow-library-actions) | **GET** `/workflow-library/actions` | List Workflow Library Actions +[**Get-BetaWorkflowLibraryOperators**](#list-workflow-library-operators) | **GET** `/workflow-library/operators` | List Workflow Library Operators +[**Get-BetaWorkflowLibraryTriggers**](#list-workflow-library-triggers) | **GET** `/workflow-library/triggers` | List Workflow Library Triggers +[**Get-BetaWorkflows**](#list-workflows) | **GET** `/workflows` | List Workflows +[**Update-BetaWorkflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch Workflow +[**Submit-BetaExternalExecuteWorkflow**](#post-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger +[**Submit-BetaWorkflowExternalTrigger**](#post-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client +[**Test-BetaExternalExecuteWorkflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger +[**Test-BetaWorkflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id +[**Update-BetaWorkflow**](#update-workflow) | **PUT** `/workflows/{id}` | Update Workflow + +## cancel-workflow-execution +Use this API to cancel a running workflow execution. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The workflow execution ID + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + +# Cancel Workflow Execution by ID + +try { + Suspend-BetaWorkflowExecution-BetaId $Id + + # Below is a request that includes all optional parameters + # Suspend-BetaWorkflowExecution -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-workflow +Create a new workflow with the desired trigger and steps specified in the request body. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CreateWorkflowRequest | [**CreateWorkflowRequest**](../models/create-workflow-request) | True | + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Workflow object | Workflow +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CreateWorkflowRequest = @"{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}"@ + +# Create Workflow + +try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-BetaWorkflow-BetaCreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaWorkflow -BetaCreateWorkflowRequest $CreateWorkflowRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-workflow +Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the Workflow + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + +# Delete Workflow By Id + +try { + Remove-BetaWorkflow-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaWorkflow -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-workflow +Get a single workflow by id. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the workflow + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The workflow object | Workflow +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + +# Get Workflow By Id + +try { + Get-BetaWorkflow-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflow -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-workflow-execution +Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Workflow execution ID. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Workflow execution. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + +# Get Workflow Execution + +try { + Get-BetaWorkflowExecution-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecution -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-workflow-execution-history +Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the workflow execution + +### Return type +[**WorkflowExecutionEvent[]**](../models/workflow-execution-event) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of workflow execution events for the given workflow execution | WorkflowExecutionEvent[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + +# Get Workflow Execution History + +try { + Get-BetaWorkflowExecutionHistory-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecutionHistory -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-workflow-executions +Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: +1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. +2. Get your workflow ID from the response. +3. You can then do either of the following: + + - Filter to find relevant workflow executions. + For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq "Failed"` + + - Paginate through results with the `offset` parameter. + For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. + Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Workflow ID. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* + +### Return type +[**WorkflowExecution[]**](../models/workflow-execution) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of workflow executions for the specified workflow. | WorkflowExecution[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'status eq "Failed"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + +# List Workflow Executions + +try { + Get-BetaWorkflowExecutions-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecutions -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-complete-workflow-library +This lists all triggers, actions, and operators in the library + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**ListCompleteWorkflowLibrary200ResponseInner[]**](../models/list-complete-workflow-library200-response-inner) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of workflow steps | ListCompleteWorkflowLibrary200ResponseInner[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + +# List Complete Workflow Library + +try { + Get-BetaCompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-BetaCompleteWorkflowLibrary -BetaLimit $Limit -BetaOffset $Offset +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-workflow-library-actions +This lists the workflow actions available to you. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* + +### Return type +[**WorkflowLibraryAction[]**](../models/workflow-library-action) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of workflow actions | WorkflowLibraryAction[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Filters = 'id eq "sp:create-campaign"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + +# List Workflow Library Actions + +try { + Get-BetaWorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryActions -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-workflow-library-operators +This lists the workflow operators available to you + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**WorkflowLibraryOperator[]**](../models/workflow-library-operator) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of workflow operators | WorkflowLibraryOperator[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List Workflow Library Operators + +try { + Get-BetaWorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryOperators +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryOperators" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-workflow-library-triggers +This lists the workflow triggers available to you + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* + +### Return type +[**WorkflowLibraryTrigger[]**](../models/workflow-library-trigger) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of workflow triggers | WorkflowLibraryTrigger[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Filters = 'id eq "idn:identity-attributes-changed"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + +# List Workflow Library Triggers + +try { + Get-BetaWorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryTriggers -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-workflows +List all workflows in the tenant. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**Workflow[]**](../models/workflow) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of workflows | Workflow[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List Workflows + +try { + Get-BetaWorkflows + + # Below is a request that includes all optional parameters + # Get-BetaWorkflows +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-workflow +Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the Workflow + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Workflow object | Workflow +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | + + +# Patch Workflow + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaWorkflow-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaWorkflow -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## post-external-execute-workflow +This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the workflow + Body | PostExternalExecuteWorkflowRequest | [**PostExternalExecuteWorkflowRequest**](../models/post-external-execute-workflow-request) | (optional) | + +### Return type +[**PostExternalExecuteWorkflow200Response**](../models/post-external-execute-workflow200-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Workflow object | PostExternalExecuteWorkflow200Response +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow +$PostExternalExecuteWorkflowRequest = @""@ + +# Execute Workflow via External Trigger + +try { + Submit-BetaExternalExecuteWorkflow-BetaId $Id + + # Below is a request that includes all optional parameters + # Submit-BetaExternalExecuteWorkflow -BetaId $Id -BetaPostExternalExecuteWorkflowRequest $PostExternalExecuteWorkflowRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## post-workflow-external-trigger +Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the workflow + +### Return type +[**WorkflowOAuthClient**](../models/workflow-o-auth-client) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The OAuth Client object | WorkflowOAuthClient +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + +# Generate External Trigger OAuth Client + +try { + Submit-BetaWorkflowExternalTrigger-BetaId $Id + + # Below is a request that includes all optional parameters + # Submit-BetaWorkflowExternalTrigger -BetaId $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## test-external-execute-workflow +Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the workflow + Body | TestExternalExecuteWorkflowRequest | [**TestExternalExecuteWorkflowRequest**](../models/test-external-execute-workflow-request) | (optional) | + +### Return type +[**TestExternalExecuteWorkflow200Response**](../models/test-external-execute-workflow200-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the test input | TestExternalExecuteWorkflow200Response +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow +$TestExternalExecuteWorkflowRequest = @""@ + +# Test Workflow via External Trigger + +try { + Test-BetaExternalExecuteWorkflow-BetaId $Id + + # Below is a request that includes all optional parameters + # Test-BetaExternalExecuteWorkflow -BetaId $Id -BetaTestExternalExecuteWorkflowRequest $TestExternalExecuteWorkflowRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## test-workflow +Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow. +This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. +**This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the workflow + Body | TestWorkflowRequest | [**TestWorkflowRequest**](../models/test-workflow-request) | True | + +### Return type +[**TestWorkflow200Response**](../models/test-workflow200-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Workflow object | TestWorkflow200Response +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow +$TestWorkflowRequest = @"{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}"@ + +# Test Workflow By Id + +try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-BetaWorkflow-BetaId $Id -BetaTestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-BetaWorkflow -BetaId $Id -BetaTestWorkflowRequest $TestWorkflowRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-workflow +Perform a full update of a workflow. The updated workflow object is returned in the response. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the Workflow + Body | WorkflowBody | [**WorkflowBody**](../models/workflow-body) | True | + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Workflow object | Workflow +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow +$WorkflowBody = @"{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "description", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false +}"@ + +# Update Workflow + +try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Update-BetaWorkflow-BetaId $Id -BetaWorkflowBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaWorkflow -BetaId $Id -BetaWorkflowBody $WorkflowBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessConstraint.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessConstraint.md new file mode 100644 index 000000000..5ed189075 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessConstraint.md @@ -0,0 +1,39 @@ +--- +id: beta-access-constraint +title: AccessConstraint +pagination_label: AccessConstraint +sidebar_label: AccessConstraint +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessConstraint', 'BetaAccessConstraint'] +slug: /tools/sdk/powershell/beta/models/access-constraint +tags: ['SDK', 'Software Development Kit', 'AccessConstraint', 'BetaAccessConstraint'] +--- + + +# AccessConstraint + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessConstraint = Initialize-PSSailpoint.BetaAccessConstraint -Type ENTITLEMENT ` + -Ids [2c90ad2a70ace7d50170acf22ca90010] ` + -Operator SELECTED +``` + +- Convert the resource to JSON +```powershell +$AccessConstraint | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessCriteria.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessCriteria.md new file mode 100644 index 000000000..261d9c9fe --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessCriteria.md @@ -0,0 +1,37 @@ +--- +id: beta-access-criteria +title: AccessCriteria +pagination_label: AccessCriteria +sidebar_label: AccessCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessCriteria', 'BetaAccessCriteria'] +slug: /tools/sdk/powershell/beta/models/access-criteria +tags: ['SDK', 'Software Development Kit', 'AccessCriteria', 'BetaAccessCriteria'] +--- + + +# AccessCriteria + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessCriteria = Initialize-PSSailpoint.BetaAccessCriteria -Name money-in ` + -CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}] +``` + +- Convert the resource to JSON +```powershell +$AccessCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessCriteriaCriteriaListInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessCriteriaCriteriaListInner.md new file mode 100644 index 000000000..010650a17 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessCriteriaCriteriaListInner.md @@ -0,0 +1,39 @@ +--- +id: beta-access-criteria-criteria-list-inner +title: AccessCriteriaCriteriaListInner +pagination_label: AccessCriteriaCriteriaListInner +sidebar_label: AccessCriteriaCriteriaListInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessCriteriaCriteriaListInner', 'BetaAccessCriteriaCriteriaListInner'] +slug: /tools/sdk/powershell/beta/models/access-criteria-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'AccessCriteriaCriteriaListInner', 'BetaAccessCriteriaCriteriaListInner'] +--- + + +# AccessCriteriaCriteriaListInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | DTO type | [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] + +## Examples + +- Prepare the resource +```powershell +$AccessCriteriaCriteriaListInner = Initialize-PSSailpoint.BetaAccessCriteriaCriteriaListInner -Type ENTITLEMENT ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name Administrator +``` + +- Convert the resource to JSON +```powershell +$AccessCriteriaCriteriaListInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemAccessProfileResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemAccessProfileResponse.md new file mode 100644 index 000000000..391382af5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemAccessProfileResponse.md @@ -0,0 +1,57 @@ +--- +id: beta-access-item-access-profile-response +title: AccessItemAccessProfileResponse +pagination_label: AccessItemAccessProfileResponse +sidebar_label: AccessItemAccessProfileResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemAccessProfileResponse', 'BetaAccessItemAccessProfileResponse'] +slug: /tools/sdk/powershell/beta/models/access-item-access-profile-response +tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponse', 'BetaAccessItemAccessProfileResponse'] +--- + + +# AccessItemAccessProfileResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **String** | the access item type. accessProfile in this case | [optional] +**Id** | Pointer to **String** | the access item id | [optional] +**Name** | Pointer to **String** | the access profile name | [optional] +**SourceName** | Pointer to **String** | the name of the source | [optional] +**SourceId** | Pointer to **String** | the id of the source | [optional] +**Description** | Pointer to **String** | the description for the access profile | [optional] +**DisplayName** | Pointer to **String** | the display name of the identity | [optional] +**EntitlementCount** | Pointer to **String** | the number of entitlements the access profile will create | [optional] +**AppDisplayName** | Pointer to **String** | the name of | [optional] +**RemoveDate** | Pointer to **String** | the date the access profile is no longer assigned to the specified identity | [optional] +**Standalone** | **Boolean** | indicates whether the access profile is standalone | [required] +**Revocable** | **Boolean** | indicates whether the access profile is | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessItemAccessProfileResponse = Initialize-PSSailpoint.BetaAccessItemAccessProfileResponse -AccessType accessProfile ` + -Id 2c918087763e69d901763e72e97f006f ` + -Name sample ` + -SourceName DataScienceDataset ` + -SourceId 2793o32dwd ` + -Description AccessProfile - Workday/Citizenship access ` + -DisplayName Dr. Arden Rogahn MD ` + -EntitlementCount 12 ` + -AppDisplayName AppName ` + -RemoveDate 2024-07-01T06:00:00.00Z ` + -Standalone false ` + -Revocable true +``` + +- Convert the resource to JSON +```powershell +$AccessItemAccessProfileResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemAccountResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemAccountResponse.md new file mode 100644 index 000000000..62e662c42 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemAccountResponse.md @@ -0,0 +1,47 @@ +--- +id: beta-access-item-account-response +title: AccessItemAccountResponse +pagination_label: AccessItemAccountResponse +sidebar_label: AccessItemAccountResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemAccountResponse', 'BetaAccessItemAccountResponse'] +slug: /tools/sdk/powershell/beta/models/access-item-account-response +tags: ['SDK', 'Software Development Kit', 'AccessItemAccountResponse', 'BetaAccessItemAccountResponse'] +--- + + +# AccessItemAccountResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **String** | the access item type. account in this case | [optional] +**Id** | Pointer to **String** | the access item id | [optional] +**NativeIdentity** | Pointer to **String** | the native identifier used to uniquely identify an acccount | [optional] +**SourceName** | Pointer to **String** | the name of the source | [optional] +**SourceId** | Pointer to **String** | the id of the source | [optional] +**EntitlementCount** | Pointer to **String** | the number of entitlements the account will create | [optional] +**DisplayName** | Pointer to **String** | the display name of the identity | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessItemAccountResponse = Initialize-PSSailpoint.BetaAccessItemAccountResponse -AccessType account ` + -Id 2c918087763e69d901763e72e97f006f ` + -NativeIdentity dr.arden.ogahn.d ` + -SourceName DataScienceDataset ` + -SourceId 2793o32dwd ` + -EntitlementCount 12 ` + -DisplayName Dr. Arden Rogahn MD +``` + +- Convert the resource to JSON +```powershell +$AccessItemAccountResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemAppResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemAppResponse.md new file mode 100644 index 000000000..11689e9f8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemAppResponse.md @@ -0,0 +1,43 @@ +--- +id: beta-access-item-app-response +title: AccessItemAppResponse +pagination_label: AccessItemAppResponse +sidebar_label: AccessItemAppResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemAppResponse', 'BetaAccessItemAppResponse'] +slug: /tools/sdk/powershell/beta/models/access-item-app-response +tags: ['SDK', 'Software Development Kit', 'AccessItemAppResponse', 'BetaAccessItemAppResponse'] +--- + + +# AccessItemAppResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **String** | the access item type. entitlement in this case | [optional] +**Id** | Pointer to **String** | the access item id | [optional] +**DisplayName** | Pointer to **String** | the access item display name | [optional] +**SourceName** | Pointer to **String** | the associated source name if it exists | [optional] +**AppRoleId** | Pointer to **String** | the app role id | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessItemAppResponse = Initialize-PSSailpoint.BetaAccessItemAppResponse -AccessType app ` + -Id 2c918087763e69d901763e72e97f006f ` + -DisplayName Display Name ` + -SourceName appName ` + -AppRoleId 2c918087763e69d901763e72e97f006f +``` + +- Convert the resource to JSON +```powershell +$AccessItemAppResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemApproverDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemApproverDto.md new file mode 100644 index 000000000..2bcbfb185 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemApproverDto.md @@ -0,0 +1,39 @@ +--- +id: beta-access-item-approver-dto +title: AccessItemApproverDto +pagination_label: AccessItemApproverDto +sidebar_label: AccessItemApproverDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemApproverDto', 'BetaAccessItemApproverDto'] +slug: /tools/sdk/powershell/beta/models/access-item-approver-dto +tags: ['SDK', 'Software Development Kit', 'AccessItemApproverDto', 'BetaAccessItemApproverDto'] +--- + + +# AccessItemApproverDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | DTO type of identity who approved the access item request. | [optional] +**Id** | Pointer to **String** | ID of identity who approved the access item request. | [optional] +**Name** | Pointer to **String** | Human-readable display name of identity who approved the access item request. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessItemApproverDto = Initialize-PSSailpoint.BetaAccessItemApproverDto -Type IDENTITY ` + -Id 2c3780a46faadee4016fb4e018c20652 ` + -Name Allen Albertson +``` + +- Convert the resource to JSON +```powershell +$AccessItemApproverDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemAssociated.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemAssociated.md new file mode 100644 index 000000000..98a13e791 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemAssociated.md @@ -0,0 +1,43 @@ +--- +id: beta-access-item-associated +title: AccessItemAssociated +pagination_label: AccessItemAssociated +sidebar_label: AccessItemAssociated +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemAssociated', 'BetaAccessItemAssociated'] +slug: /tools/sdk/powershell/beta/models/access-item-associated +tags: ['SDK', 'Software Development Kit', 'AccessItemAssociated', 'BetaAccessItemAssociated'] +--- + + +# AccessItemAssociated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessItem** | Pointer to [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional] +**IdentityId** | Pointer to **String** | the identity id | [optional] +**EventType** | Pointer to **String** | the event type | [optional] +**Dt** | Pointer to **String** | the date of event | [optional] +**GovernanceEvent** | Pointer to [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessItemAssociated = Initialize-PSSailpoint.BetaAccessItemAssociated -AccessItem null ` + -IdentityId 8c190e6787aa4ed9a90bd9d5344523fb ` + -EventType AccessItemAssociated ` + -Dt 2019-03-08T22:37:33.901Z ` + -GovernanceEvent null +``` + +- Convert the resource to JSON +```powershell +$AccessItemAssociated | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemAssociatedAccessItem.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemAssociatedAccessItem.md new file mode 100644 index 000000000..1d787fc04 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemAssociatedAccessItem.md @@ -0,0 +1,71 @@ +--- +id: beta-access-item-associated-access-item +title: AccessItemAssociatedAccessItem +pagination_label: AccessItemAssociatedAccessItem +sidebar_label: AccessItemAssociatedAccessItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemAssociatedAccessItem', 'BetaAccessItemAssociatedAccessItem'] +slug: /tools/sdk/powershell/beta/models/access-item-associated-access-item +tags: ['SDK', 'Software Development Kit', 'AccessItemAssociatedAccessItem', 'BetaAccessItemAssociatedAccessItem'] +--- + + +# AccessItemAssociatedAccessItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **String** | the access item type. role in this case | [optional] +**Id** | Pointer to **String** | the access item id | [optional] +**Name** | Pointer to **String** | the access profile name | [optional] +**SourceName** | Pointer to **String** | the associated source name if it exists | [optional] +**SourceId** | Pointer to **String** | the id of the source | [optional] +**Description** | Pointer to **String** | the description for the role | [optional] +**DisplayName** | Pointer to **String** | the role display name | [optional] +**EntitlementCount** | Pointer to **String** | the number of entitlements the account will create | [optional] +**AppDisplayName** | Pointer to **String** | the name of | [optional] +**RemoveDate** | Pointer to **String** | the date the role is no longer assigned to the specified identity | [optional] +**Standalone** | **Boolean** | indicates whether the entitlement is standalone | [required] +**Revocable** | **Boolean** | indicates whether the role is revocable | [required] +**NativeIdentity** | Pointer to **String** | the native identifier used to uniquely identify an acccount | [optional] +**AppRoleId** | Pointer to **String** | the app role id | [optional] +**Attribute** | Pointer to **String** | the entitlement attribute | [optional] +**Value** | Pointer to **String** | the associated value | [optional] +**EntitlementType** | Pointer to **String** | the type of entitlement | [optional] +**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required] +**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessItemAssociatedAccessItem = Initialize-PSSailpoint.BetaAccessItemAssociatedAccessItem -AccessType role ` + -Id 2c918087763e69d901763e72e97f006f ` + -Name sample ` + -SourceName Source Name ` + -SourceId 2793o32dwd ` + -Description Role - Workday/Citizenship access ` + -DisplayName sample ` + -EntitlementCount 12 ` + -AppDisplayName AppName ` + -RemoveDate 2024-07-01T06:00:00.00Z ` + -Standalone true ` + -Revocable true ` + -NativeIdentity dr.arden.ogahn.d ` + -AppRoleId 2c918087763e69d901763e72e97f006f ` + -Attribute groups ` + -Value Upward mobility access ` + -EntitlementType entitlement ` + -Privileged false ` + -CloudGoverned true +``` + +- Convert the resource to JSON +```powershell +$AccessItemAssociatedAccessItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemDiff.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemDiff.md new file mode 100644 index 000000000..29706481f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemDiff.md @@ -0,0 +1,41 @@ +--- +id: beta-access-item-diff +title: AccessItemDiff +pagination_label: AccessItemDiff +sidebar_label: AccessItemDiff +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemDiff', 'BetaAccessItemDiff'] +slug: /tools/sdk/powershell/beta/models/access-item-diff +tags: ['SDK', 'Software Development Kit', 'AccessItemDiff', 'BetaAccessItemDiff'] +--- + + +# AccessItemDiff + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | the id of the access item | [optional] +**EventType** | Pointer to **Enum** [ "ADD", "REMOVE" ] | | [optional] +**DisplayName** | Pointer to **String** | the display name of the access item | [optional] +**SourceName** | Pointer to **String** | the source name of the access item | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessItemDiff = Initialize-PSSailpoint.BetaAccessItemDiff -Id null ` + -EventType null ` + -DisplayName null ` + -SourceName null +``` + +- Convert the resource to JSON +```powershell +$AccessItemDiff | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemEntitlementResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemEntitlementResponse.md new file mode 100644 index 000000000..42aa8cde8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemEntitlementResponse.md @@ -0,0 +1,57 @@ +--- +id: beta-access-item-entitlement-response +title: AccessItemEntitlementResponse +pagination_label: AccessItemEntitlementResponse +sidebar_label: AccessItemEntitlementResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemEntitlementResponse', 'BetaAccessItemEntitlementResponse'] +slug: /tools/sdk/powershell/beta/models/access-item-entitlement-response +tags: ['SDK', 'Software Development Kit', 'AccessItemEntitlementResponse', 'BetaAccessItemEntitlementResponse'] +--- + + +# AccessItemEntitlementResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **String** | the access item type. entitlement in this case | [optional] +**Id** | Pointer to **String** | the access item id | [optional] +**Attribute** | Pointer to **String** | the entitlement attribute | [optional] +**Value** | Pointer to **String** | the associated value | [optional] +**EntitlementType** | Pointer to **String** | the type of entitlement | [optional] +**SourceName** | Pointer to **String** | the name of the source | [optional] +**SourceId** | Pointer to **String** | the id of the source | [optional] +**Description** | Pointer to **String** | the description for the entitlment | [optional] +**DisplayName** | Pointer to **String** | the display name of the identity | [optional] +**Standalone** | **Boolean** | indicates whether the entitlement is standalone | [required] +**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required] +**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessItemEntitlementResponse = Initialize-PSSailpoint.BetaAccessItemEntitlementResponse -AccessType entitlement ` + -Id 2c918087763e69d901763e72e97f006f ` + -Attribute groups ` + -Value Upward mobility access ` + -EntitlementType entitlement ` + -SourceName DataScienceDataset ` + -SourceId 2793o32dwd ` + -Description Entitlement - Workday/Citizenship access ` + -DisplayName Dr. Arden Rogahn MD ` + -Standalone true ` + -Privileged false ` + -CloudGoverned true +``` + +- Convert the resource to JSON +```powershell +$AccessItemEntitlementResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemOwnerDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemOwnerDto.md new file mode 100644 index 000000000..f0d0f44f4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemOwnerDto.md @@ -0,0 +1,39 @@ +--- +id: beta-access-item-owner-dto +title: AccessItemOwnerDto +pagination_label: AccessItemOwnerDto +sidebar_label: AccessItemOwnerDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemOwnerDto', 'BetaAccessItemOwnerDto'] +slug: /tools/sdk/powershell/beta/models/access-item-owner-dto +tags: ['SDK', 'Software Development Kit', 'AccessItemOwnerDto', 'BetaAccessItemOwnerDto'] +--- + + +# AccessItemOwnerDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Access item owner's DTO type. | [optional] +**Id** | Pointer to **String** | Access item owner's identity ID. | [optional] +**Name** | Pointer to **String** | Access item owner's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessItemOwnerDto = Initialize-PSSailpoint.BetaAccessItemOwnerDto -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Support +``` + +- Convert the resource to JSON +```powershell +$AccessItemOwnerDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemRef.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemRef.md new file mode 100644 index 000000000..4d8e418cb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemRef.md @@ -0,0 +1,37 @@ +--- +id: beta-access-item-ref +title: AccessItemRef +pagination_label: AccessItemRef +sidebar_label: AccessItemRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRef', 'BetaAccessItemRef'] +slug: /tools/sdk/powershell/beta/models/access-item-ref +tags: ['SDK', 'Software Development Kit', 'AccessItemRef', 'BetaAccessItemRef'] +--- + + +# AccessItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the access item to retrieve the recommendation for. | [optional] +**Type** | Pointer to **Enum** [ "ENTITLEMENT", "ACCESS_PROFILE", "ROLE" ] | Access item's type. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessItemRef = Initialize-PSSailpoint.BetaAccessItemRef -Id 2c938083633d259901633d2623ec0375 ` + -Type ENTITLEMENT +``` + +- Convert the resource to JSON +```powershell +$AccessItemRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemRemoved.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemRemoved.md new file mode 100644 index 000000000..c7cf90796 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemRemoved.md @@ -0,0 +1,43 @@ +--- +id: beta-access-item-removed +title: AccessItemRemoved +pagination_label: AccessItemRemoved +sidebar_label: AccessItemRemoved +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRemoved', 'BetaAccessItemRemoved'] +slug: /tools/sdk/powershell/beta/models/access-item-removed +tags: ['SDK', 'Software Development Kit', 'AccessItemRemoved', 'BetaAccessItemRemoved'] +--- + + +# AccessItemRemoved + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessItem** | Pointer to [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional] +**IdentityId** | Pointer to **String** | the identity id | [optional] +**EventType** | Pointer to **String** | the event type | [optional] +**Dt** | Pointer to **String** | the date of event | [optional] +**GovernanceEvent** | Pointer to [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessItemRemoved = Initialize-PSSailpoint.BetaAccessItemRemoved -AccessItem null ` + -IdentityId 8c190e6787aa4ed9a90bd9d5344523fb ` + -EventType AccessItemRemoved ` + -Dt 2019-03-08T22:37:33.901Z ` + -GovernanceEvent null +``` + +- Convert the resource to JSON +```powershell +$AccessItemRemoved | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemRequestedForDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemRequestedForDto.md new file mode 100644 index 000000000..0115567e0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemRequestedForDto.md @@ -0,0 +1,39 @@ +--- +id: beta-access-item-requested-for-dto +title: AccessItemRequestedForDto +pagination_label: AccessItemRequestedForDto +sidebar_label: AccessItemRequestedForDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRequestedForDto', 'BetaAccessItemRequestedForDto'] +slug: /tools/sdk/powershell/beta/models/access-item-requested-for-dto +tags: ['SDK', 'Software Development Kit', 'AccessItemRequestedForDto', 'BetaAccessItemRequestedForDto'] +--- + + +# AccessItemRequestedForDto + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessItemRequestedForDto = Initialize-PSSailpoint.BetaAccessItemRequestedForDto -Type IDENTITY ` + -Id 2c4180a46faadee4016fb4e018c20626 ` + -Name Robert Robinson +``` + +- Convert the resource to JSON +```powershell +$AccessItemRequestedForDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemRequester.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemRequester.md new file mode 100644 index 000000000..ffde2e080 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemRequester.md @@ -0,0 +1,39 @@ +--- +id: beta-access-item-requester +title: AccessItemRequester +pagination_label: AccessItemRequester +sidebar_label: AccessItemRequester +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRequester', 'BetaAccessItemRequester'] +slug: /tools/sdk/powershell/beta/models/access-item-requester +tags: ['SDK', 'Software Development Kit', 'AccessItemRequester', 'BetaAccessItemRequester'] +--- + + +# AccessItemRequester + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessItemRequester = Initialize-PSSailpoint.BetaAccessItemRequester -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20648 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$AccessItemRequester | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemRequesterDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemRequesterDto.md new file mode 100644 index 000000000..469304b3f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemRequesterDto.md @@ -0,0 +1,39 @@ +--- +id: beta-access-item-requester-dto +title: AccessItemRequesterDto +pagination_label: AccessItemRequesterDto +sidebar_label: AccessItemRequesterDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRequesterDto', 'BetaAccessItemRequesterDto'] +slug: /tools/sdk/powershell/beta/models/access-item-requester-dto +tags: ['SDK', 'Software Development Kit', 'AccessItemRequesterDto', 'BetaAccessItemRequesterDto'] +--- + + +# AccessItemRequesterDto + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessItemRequesterDto = Initialize-PSSailpoint.BetaAccessItemRequesterDto -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20648 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$AccessItemRequesterDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemReviewedBy.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemReviewedBy.md new file mode 100644 index 000000000..3140e0a92 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemReviewedBy.md @@ -0,0 +1,39 @@ +--- +id: beta-access-item-reviewed-by +title: AccessItemReviewedBy +pagination_label: AccessItemReviewedBy +sidebar_label: AccessItemReviewedBy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemReviewedBy', 'BetaAccessItemReviewedBy'] +slug: /tools/sdk/powershell/beta/models/access-item-reviewed-by +tags: ['SDK', 'Software Development Kit', 'AccessItemReviewedBy', 'BetaAccessItemReviewedBy'] +--- + + +# AccessItemReviewedBy + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessItemReviewedBy = Initialize-PSSailpoint.BetaAccessItemReviewedBy -Type IDENTITY ` + -Id 2c3780a46faadee4016fb4e018c20652 ` + -Name Allen Albertson +``` + +- Convert the resource to JSON +```powershell +$AccessItemReviewedBy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemRoleResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemRoleResponse.md new file mode 100644 index 000000000..cfd645bc4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessItemRoleResponse.md @@ -0,0 +1,47 @@ +--- +id: beta-access-item-role-response +title: AccessItemRoleResponse +pagination_label: AccessItemRoleResponse +sidebar_label: AccessItemRoleResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRoleResponse', 'BetaAccessItemRoleResponse'] +slug: /tools/sdk/powershell/beta/models/access-item-role-response +tags: ['SDK', 'Software Development Kit', 'AccessItemRoleResponse', 'BetaAccessItemRoleResponse'] +--- + + +# AccessItemRoleResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **String** | the access item type. role in this case | [optional] +**Id** | Pointer to **String** | the access item id | [optional] +**DisplayName** | Pointer to **String** | the role display name | [optional] +**Description** | Pointer to **String** | the description for the role | [optional] +**SourceName** | Pointer to **String** | the associated source name if it exists | [optional] +**RemoveDate** | Pointer to **String** | the date the role is no longer assigned to the specified identity | [optional] +**Revocable** | **Boolean** | indicates whether the role is revocable | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessItemRoleResponse = Initialize-PSSailpoint.BetaAccessItemRoleResponse -AccessType role ` + -Id 2c918087763e69d901763e72e97f006f ` + -DisplayName sample ` + -Description Role - Workday/Citizenship access ` + -SourceName Source Name ` + -RemoveDate 2024-07-01T06:00:00.00Z ` + -Revocable true +``` + +- Convert the resource to JSON +```powershell +$AccessItemRoleResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfile.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfile.md new file mode 100644 index 000000000..24ee2a76b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfile.md @@ -0,0 +1,61 @@ +--- +id: beta-access-profile +title: AccessProfile +pagination_label: AccessProfile +sidebar_label: AccessProfile +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfile', 'BetaAccessProfile'] +slug: /tools/sdk/powershell/beta/models/access-profile +tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'BetaAccessProfile'] +--- + + +# AccessProfile + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfile = Initialize-PSSailpoint.BetaAccessProfile -Id 2c91808a7190d06e01719938fcd20792 ` + -Name Employee-database-read-write ` + -Description Collection of entitlements to read/write the employee database ` + -Created 2021-03-01T22:32:58.104Z ` + -Modified 2021-03-02T20:22:28.104Z ` + -Enabled true ` + -Owner null ` + -Source null ` + -Entitlements null ` + -Requestable true ` + -AccessRequestConfig null ` + -RevocationRequestConfig null ` + -Segments [f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a] ` + -ProvisioningCriteria null +``` + +- Convert the resource to JSON +```powershell +$AccessProfile | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileApprovalScheme.md new file mode 100644 index 000000000..acacb969c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileApprovalScheme.md @@ -0,0 +1,37 @@ +--- +id: beta-access-profile-approval-scheme +title: AccessProfileApprovalScheme +pagination_label: AccessProfileApprovalScheme +sidebar_label: AccessProfileApprovalScheme +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileApprovalScheme', 'BetaAccessProfileApprovalScheme'] +slug: /tools/sdk/powershell/beta/models/access-profile-approval-scheme +tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'BetaAccessProfileApprovalScheme'] +--- + + +# AccessProfileApprovalScheme + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileApprovalScheme = Initialize-PSSailpoint.BetaAccessProfileApprovalScheme -ApproverType GOVERNANCE_GROUP ` + -ApproverId 46c79819-a69f-49a2-becb-12c971ae66c6 +``` + +- Convert the resource to JSON +```powershell +$AccessProfileApprovalScheme | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileBulkDeleteRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileBulkDeleteRequest.md new file mode 100644 index 000000000..5a3bf1186 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileBulkDeleteRequest.md @@ -0,0 +1,37 @@ +--- +id: beta-access-profile-bulk-delete-request +title: AccessProfileBulkDeleteRequest +pagination_label: AccessProfileBulkDeleteRequest +sidebar_label: AccessProfileBulkDeleteRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileBulkDeleteRequest', 'BetaAccessProfileBulkDeleteRequest'] +slug: /tools/sdk/powershell/beta/models/access-profile-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteRequest', 'BetaAccessProfileBulkDeleteRequest'] +--- + + +# AccessProfileBulkDeleteRequest + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileBulkDeleteRequest = Initialize-PSSailpoint.BetaAccessProfileBulkDeleteRequest -AccessProfileIds [2c9180847812e0b1017817051919ecca, 2c9180887812e0b201781e129f151816] ` + -BestEffortOnly true +``` + +- Convert the resource to JSON +```powershell +$AccessProfileBulkDeleteRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileBulkDeleteResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileBulkDeleteResponse.md new file mode 100644 index 000000000..66ceea8e3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileBulkDeleteResponse.md @@ -0,0 +1,39 @@ +--- +id: beta-access-profile-bulk-delete-response +title: AccessProfileBulkDeleteResponse +pagination_label: AccessProfileBulkDeleteResponse +sidebar_label: AccessProfileBulkDeleteResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileBulkDeleteResponse', 'BetaAccessProfileBulkDeleteResponse'] +slug: /tools/sdk/powershell/beta/models/access-profile-bulk-delete-response +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteResponse', 'BetaAccessProfileBulkDeleteResponse'] +--- + + +# AccessProfileBulkDeleteResponse + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileBulkDeleteResponse = Initialize-PSSailpoint.BetaAccessProfileBulkDeleteResponse -TaskId 2c9180867817ac4d017817c491119a20 ` + -Pending [2c91808876438bbb017668c21919ecca, 2c91808876438bb201766e129f151816] ` + -InUse null +``` + +- Convert the resource to JSON +```powershell +$AccessProfileBulkDeleteResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileBulkUpdateRequestInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileBulkUpdateRequestInner.md new file mode 100644 index 000000000..08d817d67 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileBulkUpdateRequestInner.md @@ -0,0 +1,37 @@ +--- +id: beta-access-profile-bulk-update-request-inner +title: AccessProfileBulkUpdateRequestInner +pagination_label: AccessProfileBulkUpdateRequestInner +sidebar_label: AccessProfileBulkUpdateRequestInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileBulkUpdateRequestInner', 'BetaAccessProfileBulkUpdateRequestInner'] +slug: /tools/sdk/powershell/beta/models/access-profile-bulk-update-request-inner +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkUpdateRequestInner', 'BetaAccessProfileBulkUpdateRequestInner'] +--- + + +# AccessProfileBulkUpdateRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Access Profile ID. | [optional] +**Requestable** | Pointer to **Boolean** | Access Profile is requestable or not. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileBulkUpdateRequestInner = Initialize-PSSailpoint.BetaAccessProfileBulkUpdateRequestInner -Id 464ae7bf-791e-49fd-b746-06a2e4a8 ` + -Requestable false +``` + +- Convert the resource to JSON +```powershell +$AccessProfileBulkUpdateRequestInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileDetails.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileDetails.md new file mode 100644 index 000000000..3f8adca39 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileDetails.md @@ -0,0 +1,79 @@ +--- +id: beta-access-profile-details +title: AccessProfileDetails +pagination_label: AccessProfileDetails +sidebar_label: AccessProfileDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileDetails', 'BetaAccessProfileDetails'] +slug: /tools/sdk/powershell/beta/models/access-profile-details +tags: ['SDK', 'Software Development Kit', 'AccessProfileDetails', 'BetaAccessProfileDetails'] +--- + + +# AccessProfileDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of the Access Profile | [optional] +**Name** | Pointer to **String** | Name of the Access Profile | [optional] +**Description** | Pointer to **String** | Information about the Access Profile | [optional] +**Created** | Pointer to **System.DateTime** | Date the Access Profile was created | [optional] +**Modified** | Pointer to **System.DateTime** | Date the Access Profile was last modified. | [optional] +**Disabled** | Pointer to **Boolean** | Whether the Access Profile is enabled. | [optional] [default to $true] +**Requestable** | Pointer to **Boolean** | Whether the Access Profile is requestable via access request. | [optional] [default to $false] +**Protected** | Pointer to **Boolean** | Whether the Access Profile is protected. | [optional] [default to $false] +**OwnerId** | Pointer to **String** | The owner ID of the Access Profile | [optional] +**SourceId** | Pointer to **Int64** | The source ID of the Access Profile | [optional] +**SourceName** | Pointer to **String** | The source name of the Access Profile | [optional] +**AppId** | Pointer to **Int64** | The source app ID of the Access Profile | [optional] +**AppName** | Pointer to **String** | The source app name of the Access Profile | [optional] +**ApplicationId** | Pointer to **String** | The id of the application | [optional] +**Type** | Pointer to **String** | The type of the access profile | [optional] +**Entitlements** | Pointer to **[]String** | List of IDs of entitlements | [optional] +**EntitlementCount** | Pointer to **Int32** | The number of entitlements in the access profile | [optional] +**Segments** | Pointer to **[]String** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**ApprovalSchemes** | Pointer to **String** | Comma-separated list of approval schemes. Each approval scheme is one of - manager - appOwner - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [optional] +**RevokeRequestApprovalSchemes** | Pointer to **String** | Comma-separated list of revoke request approval schemes. Each approval scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [optional] +**RequestCommentsRequired** | Pointer to **Boolean** | Whether the access profile require request comment for access request. | [optional] [default to $false] +**DeniedCommentsRequired** | Pointer to **Boolean** | Whether denied comment is required when access request is denied. | [optional] [default to $false] +**AccountSelector** | Pointer to [**AccessProfileDetailsAccountSelector**](access-profile-details-account-selector) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileDetails = Initialize-PSSailpoint.BetaAccessProfileDetails -Id 2c91808a7190d06e01719938fcd20792 ` + -Name Employee-database-read-write ` + -Description Collection of entitlements to read/write the employee database ` + -Created 2021-03-01T22:32:58.104Z ` + -Modified 2021-03-02T20:22:28.104Z ` + -Disabled true ` + -Requestable true ` + -Protected false ` + -OwnerId 9870808a7190d06e01719938fcd20792 ` + -SourceId 10360661 ` + -SourceName AD Source ` + -AppId 10360661 ` + -AppName mail app ` + -ApplicationId edcb0951812949d085b60cd8bf35bc78 ` + -Type source ` + -Entitlements [2c9180857725c14301772a93bb77242d, c9dc28e148a24d65b3ccb5fb8ca5ddd9] ` + -EntitlementCount 12 ` + -Segments [f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a] ` + -ApprovalSchemes accessProfileOwner ` + -RevokeRequestApprovalSchemes accessProfileOwner ` + -RequestCommentsRequired true ` + -DeniedCommentsRequired true ` + -AccountSelector null +``` + +- Convert the resource to JSON +```powershell +$AccessProfileDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileDetailsAccountSelector.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileDetailsAccountSelector.md new file mode 100644 index 000000000..ceed5f8a5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileDetailsAccountSelector.md @@ -0,0 +1,35 @@ +--- +id: beta-access-profile-details-account-selector +title: AccessProfileDetailsAccountSelector +pagination_label: AccessProfileDetailsAccountSelector +sidebar_label: AccessProfileDetailsAccountSelector +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileDetailsAccountSelector', 'BetaAccessProfileDetailsAccountSelector'] +slug: /tools/sdk/powershell/beta/models/access-profile-details-account-selector +tags: ['SDK', 'Software Development Kit', 'AccessProfileDetailsAccountSelector', 'BetaAccessProfileDetailsAccountSelector'] +--- + + +# AccessProfileDetailsAccountSelector + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Selectors** | Pointer to [**[]Selector**](selector) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileDetailsAccountSelector = Initialize-PSSailpoint.BetaAccessProfileDetailsAccountSelector -Selectors null +``` + +- Convert the resource to JSON +```powershell +$AccessProfileDetailsAccountSelector | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileRef.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileRef.md new file mode 100644 index 000000000..7446c2488 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileRef.md @@ -0,0 +1,39 @@ +--- +id: beta-access-profile-ref +title: AccessProfileRef +pagination_label: AccessProfileRef +sidebar_label: AccessProfileRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileRef', 'BetaAccessProfileRef'] +slug: /tools/sdk/powershell/beta/models/access-profile-ref +tags: ['SDK', 'Software Development Kit', 'AccessProfileRef', 'BetaAccessProfileRef'] +--- + + +# AccessProfileRef + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileRef = Initialize-PSSailpoint.BetaAccessProfileRef -Id ff808081751e6e129f1518161919ecca ` + -Type ACCESS_PROFILE ` + -Name Access Profile 2567 +``` + +- Convert the resource to JSON +```powershell +$AccessProfileRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileSourceRef.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileSourceRef.md new file mode 100644 index 000000000..749493422 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileSourceRef.md @@ -0,0 +1,39 @@ +--- +id: beta-access-profile-source-ref +title: AccessProfileSourceRef +pagination_label: AccessProfileSourceRef +sidebar_label: AccessProfileSourceRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileSourceRef', 'BetaAccessProfileSourceRef'] +slug: /tools/sdk/powershell/beta/models/access-profile-source-ref +tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'BetaAccessProfileSourceRef'] +--- + + +# AccessProfileSourceRef + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileSourceRef = Initialize-PSSailpoint.BetaAccessProfileSourceRef -Id 2c91809773dee3610173fdb0b6061ef4 ` + -Type SOURCE ` + -Name ODS-AD-SOURCE +``` + +- Convert the resource to JSON +```powershell +$AccessProfileSourceRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileUpdateItem.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileUpdateItem.md new file mode 100644 index 000000000..242dcaa6e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileUpdateItem.md @@ -0,0 +1,45 @@ +--- +id: beta-access-profile-update-item +title: AccessProfileUpdateItem +pagination_label: AccessProfileUpdateItem +sidebar_label: AccessProfileUpdateItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileUpdateItem', 'BetaAccessProfileUpdateItem'] +slug: /tools/sdk/powershell/beta/models/access-profile-update-item +tags: ['SDK', 'Software Development Kit', 'AccessProfileUpdateItem', 'BetaAccessProfileUpdateItem'] +--- + + +# AccessProfileUpdateItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Identifier of Access Profile in bulk update request. | [required] +**Requestable** | **Boolean** | Access Profile requestable or not. | [required] +**Status** | **String** | The HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation. > 201 - Access profile is updated successfully. > 404 - Access profile not found. | [required] +**Description** | Pointer to **String** | Human readable status description and containing additional context information about success or failures etc. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileUpdateItem = Initialize-PSSailpoint.BetaAccessProfileUpdateItem -Id 2c7180a46faadee4016fb4e018c20642 ` + -Requestable false ` + -Status 201 ` + -Description +> Access profile is updated successfully. + +> Referenced Access profile with Id "2c7180a46faadee4016fb4e018c20642" was not found. + +``` + +- Convert the resource to JSON +```powershell +$AccessProfileUpdateItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileUsage.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileUsage.md new file mode 100644 index 000000000..b0a45aa36 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileUsage.md @@ -0,0 +1,37 @@ +--- +id: beta-access-profile-usage +title: AccessProfileUsage +pagination_label: AccessProfileUsage +sidebar_label: AccessProfileUsage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileUsage', 'BetaAccessProfileUsage'] +slug: /tools/sdk/powershell/beta/models/access-profile-usage +tags: ['SDK', 'Software Development Kit', 'AccessProfileUsage', 'BetaAccessProfileUsage'] +--- + + +# AccessProfileUsage + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileUsage = Initialize-PSSailpoint.BetaAccessProfileUsage -AccessProfileId 2c91808876438bbb017668c21919ecca ` + -UsedBy null +``` + +- Convert the resource to JSON +```powershell +$AccessProfileUsage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileUsageUsedByInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileUsageUsedByInner.md new file mode 100644 index 000000000..b4264f897 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessProfileUsageUsedByInner.md @@ -0,0 +1,39 @@ +--- +id: beta-access-profile-usage-used-by-inner +title: AccessProfileUsageUsedByInner +pagination_label: AccessProfileUsageUsedByInner +sidebar_label: AccessProfileUsageUsedByInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileUsageUsedByInner', 'BetaAccessProfileUsageUsedByInner'] +slug: /tools/sdk/powershell/beta/models/access-profile-usage-used-by-inner +tags: ['SDK', 'Software Development Kit', 'AccessProfileUsageUsedByInner', 'BetaAccessProfileUsageUsedByInner'] +--- + + +# AccessProfileUsageUsedByInner + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileUsageUsedByInner = Initialize-PSSailpoint.BetaAccessProfileUsageUsedByInner -Type ROLE ` + -Id 2c8180857a9b3da0017aa03418480f9d ` + -Name Manager Role +``` + +- Convert the resource to JSON +```powershell +$AccessProfileUsageUsedByInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRecommendationMessage.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRecommendationMessage.md new file mode 100644 index 000000000..d3699d185 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRecommendationMessage.md @@ -0,0 +1,35 @@ +--- +id: beta-access-recommendation-message +title: AccessRecommendationMessage +pagination_label: AccessRecommendationMessage +sidebar_label: AccessRecommendationMessage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRecommendationMessage', 'BetaAccessRecommendationMessage'] +slug: /tools/sdk/powershell/beta/models/access-recommendation-message +tags: ['SDK', 'Software Development Kit', 'AccessRecommendationMessage', 'BetaAccessRecommendationMessage'] +--- + + +# AccessRecommendationMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Interpretation** | Pointer to **String** | Information about why the access item was recommended. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRecommendationMessage = Initialize-PSSailpoint.BetaAccessRecommendationMessage -Interpretation 95% of your peers have this access. +``` + +- Convert the resource to JSON +```powershell +$AccessRecommendationMessage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequest.md new file mode 100644 index 000000000..4e37293a2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequest.md @@ -0,0 +1,41 @@ +--- +id: beta-access-request +title: AccessRequest +pagination_label: AccessRequest +sidebar_label: AccessRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequest', 'BetaAccessRequest'] +slug: /tools/sdk/powershell/beta/models/access-request +tags: ['SDK', 'Software Development Kit', 'AccessRequest', 'BetaAccessRequest'] +--- + + +# AccessRequest + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessRequest = Initialize-PSSailpoint.BetaAccessRequest -RequestedFor null ` + -RequestType null ` + -RequestedItems null ` + -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} +``` + +- Convert the resource to JSON +```powershell +$AccessRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestConfig.md new file mode 100644 index 000000000..0542ea46e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestConfig.md @@ -0,0 +1,45 @@ +--- +id: beta-access-request-config +title: AccessRequestConfig +pagination_label: AccessRequestConfig +sidebar_label: AccessRequestConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestConfig', 'BetaAccessRequestConfig'] +slug: /tools/sdk/powershell/beta/models/access-request-config +tags: ['SDK', 'Software Development Kit', 'AccessRequestConfig', 'BetaAccessRequestConfig'] +--- + + +# AccessRequestConfig + +## Properties + +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 [**EntitlementRequestConfig1**](entitlement-request-config1) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestConfig = Initialize-PSSailpoint.BetaAccessRequestConfig -ApprovalsMustBeExternal true ` + -AutoApprovalEnabled true ` + -ReauthorizationEnabled true ` + -RequestOnBehalfOfConfig null ` + -ApprovalReminderAndEscalationConfig null ` + -EntitlementRequestConfig null +``` + +- Convert the resource to JSON +```powershell +$AccessRequestConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestContext.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestContext.md new file mode 100644 index 000000000..5eecec812 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestContext.md @@ -0,0 +1,35 @@ +--- +id: beta-access-request-context +title: AccessRequestContext +pagination_label: AccessRequestContext +sidebar_label: AccessRequestContext +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestContext', 'BetaAccessRequestContext'] +slug: /tools/sdk/powershell/beta/models/access-request-context +tags: ['SDK', 'Software Development Kit', 'AccessRequestContext', 'BetaAccessRequestContext'] +--- + + +# AccessRequestContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ContextAttributes** | Pointer to [**[]ContextAttributeDto**](context-attribute-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestContext = Initialize-PSSailpoint.BetaAccessRequestContext -ContextAttributes null +``` + +- Convert the resource to JSON +```powershell +$AccessRequestContext | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestDynamicApprover.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestDynamicApprover.md new file mode 100644 index 000000000..3abaf8493 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestDynamicApprover.md @@ -0,0 +1,41 @@ +--- +id: beta-access-request-dynamic-approver +title: AccessRequestDynamicApprover +pagination_label: AccessRequestDynamicApprover +sidebar_label: AccessRequestDynamicApprover +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestDynamicApprover', 'BetaAccessRequestDynamicApprover'] +slug: /tools/sdk/powershell/beta/models/access-request-dynamic-approver +tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover', 'BetaAccessRequestDynamicApprover'] +--- + + +# AccessRequestDynamicApprover + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestId** | **String** | The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-request-status) to get the status of the request. | [required] +**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required] +**RequestedItems** | [**[]AccessRequestDynamicApproverRequestedItemsInner**](access-request-dynamic-approver-requested-items-inner) | The access items that are being requested. | [required] +**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestDynamicApprover = Initialize-PSSailpoint.BetaAccessRequestDynamicApprover -AccessRequestId 4b4d982dddff4267ab12f0f1e72b5a6d ` + -RequestedFor null ` + -RequestedItems null ` + -RequestedBy null +``` + +- Convert the resource to JSON +```powershell +$AccessRequestDynamicApprover | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestDynamicApprover1.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestDynamicApprover1.md new file mode 100644 index 000000000..638873836 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestDynamicApprover1.md @@ -0,0 +1,39 @@ +--- +id: beta-access-request-dynamic-approver1 +title: AccessRequestDynamicApprover1 +pagination_label: AccessRequestDynamicApprover1 +sidebar_label: AccessRequestDynamicApprover1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestDynamicApprover1', 'BetaAccessRequestDynamicApprover1'] +slug: /tools/sdk/powershell/beta/models/access-request-dynamic-approver1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover1', 'BetaAccessRequestDynamicApprover1'] +--- + + +# AccessRequestDynamicApprover1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the identity to add to the approver list for the access request. | [required] +**Name** | **String** | The name of the identity to add to the approver list for the access request. | [required] +**Type** | **Enum** [ "IDENTITY", "GOVERNANCE_GROUP" ] | The type of object being referenced. | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestDynamicApprover1 = Initialize-PSSailpoint.BetaAccessRequestDynamicApprover1 -Id 2c91808b6ef1d43e016efba0ce470906 ` + -Name Adam Adams ` + -Type IDENTITY +``` + +- Convert the resource to JSON +```powershell +$AccessRequestDynamicApprover1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestDynamicApproverRequestedItemsInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestDynamicApproverRequestedItemsInner.md new file mode 100644 index 000000000..2699a7c74 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestDynamicApproverRequestedItemsInner.md @@ -0,0 +1,45 @@ +--- +id: beta-access-request-dynamic-approver-requested-items-inner +title: AccessRequestDynamicApproverRequestedItemsInner +pagination_label: AccessRequestDynamicApproverRequestedItemsInner +sidebar_label: AccessRequestDynamicApproverRequestedItemsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestDynamicApproverRequestedItemsInner', 'BetaAccessRequestDynamicApproverRequestedItemsInner'] +slug: /tools/sdk/powershell/beta/models/access-request-dynamic-approver-requested-items-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApproverRequestedItemsInner', 'BetaAccessRequestDynamicApproverRequestedItemsInner'] +--- + + +# AccessRequestDynamicApproverRequestedItemsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the access item. | [required] +**Name** | **String** | Human friendly name of the access item. | [required] +**Description** | Pointer to **String** | Extended description of the access item. | [optional] +**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of access item being requested. | [required] +**Operation** | **Enum** [ "Add", "Remove" ] | Grant or revoke the access item | [required] +**Comment** | Pointer to **String** | A comment from the requestor on why the access is needed. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestDynamicApproverRequestedItemsInner = Initialize-PSSailpoint.BetaAccessRequestDynamicApproverRequestedItemsInner -Id 2c91808b6ef1d43e016efba0ce470904 ` + -Name Engineering Access ` + -Description Engineering Access ` + -Type ACCESS_PROFILE ` + -Operation Add ` + -Comment William needs this access for his day to day job activities. +``` + +- Convert the resource to JSON +```powershell +$AccessRequestDynamicApproverRequestedItemsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestItem.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestItem.md new file mode 100644 index 000000000..9db8d18d2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestItem.md @@ -0,0 +1,43 @@ +--- +id: beta-access-request-item +title: AccessRequestItem +pagination_label: AccessRequestItem +sidebar_label: AccessRequestItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestItem', 'BetaAccessRequestItem'] +slug: /tools/sdk/powershell/beta/models/access-request-item +tags: ['SDK', 'Software Development Kit', 'AccessRequestItem', 'BetaAccessRequestItem'] +--- + + +# AccessRequestItem + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestItem = Initialize-PSSailpoint.BetaAccessRequestItem -Type ACCESS_PROFILE ` + -Id 2c9180835d2e5168015d32f890ca1581 ` + -Comment Requesting access profile for John Doe ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -RemoveDate 2020-07-11T21:23:15Z +``` + +- Convert the resource to JSON +```powershell +$AccessRequestItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestItemResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestItemResponse.md new file mode 100644 index 000000000..7e39e7e52 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestItemResponse.md @@ -0,0 +1,49 @@ +--- +id: beta-access-request-item-response +title: AccessRequestItemResponse +pagination_label: AccessRequestItemResponse +sidebar_label: AccessRequestItemResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestItemResponse', 'BetaAccessRequestItemResponse'] +slug: /tools/sdk/powershell/beta/models/access-request-item-response +tags: ['SDK', 'Software Development Kit', 'AccessRequestItemResponse', 'BetaAccessRequestItemResponse'] +--- + + +# AccessRequestItemResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to **String** | the access request item operation | [optional] +**AccessItemType** | Pointer to **String** | the access item type | [optional] +**Name** | Pointer to **String** | the name of access request item | [optional] +**Decision** | Pointer to **Enum** [ "APPROVED", "REJECTED" ] | the final decision for the access request | [optional] +**Description** | Pointer to **String** | the description of access request item | [optional] +**SourceId** | Pointer to **String** | the source id | [optional] +**SourceName** | Pointer to **String** | the source Name | [optional] +**ApprovalInfos** | Pointer to [**[]ApprovalInfoResponse**](approval-info-response) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestItemResponse = Initialize-PSSailpoint.BetaAccessRequestItemResponse -Operation Add ` + -AccessItemType role ` + -Name Role-1 ` + -Decision APPROVED ` + -Description The role descrition ` + -SourceId 8a80828f643d484f01643e14202e206f ` + -SourceName Source1 ` + -ApprovalInfos [{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}] +``` + +- Convert the resource to JSON +```powershell +$AccessRequestItemResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestPhases.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestPhases.md new file mode 100644 index 000000000..032d67d23 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestPhases.md @@ -0,0 +1,45 @@ +--- +id: beta-access-request-phases +title: AccessRequestPhases +pagination_label: AccessRequestPhases +sidebar_label: AccessRequestPhases +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPhases', 'BetaAccessRequestPhases'] +slug: /tools/sdk/powershell/beta/models/access-request-phases +tags: ['SDK', 'Software Development Kit', 'AccessRequestPhases', 'BetaAccessRequestPhases'] +--- + + +# AccessRequestPhases + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestPhases = Initialize-PSSailpoint.BetaAccessRequestPhases -Started 2020-07-11T00:00Z ` + -Finished 2020-07-12T00:00Z ` + -Name APPROVAL_PHASE ` + -State COMPLETED ` + -Result SUCCESSFUL ` + -PhaseReference approvalDetails +``` + +- Convert the resource to JSON +```powershell +$AccessRequestPhases | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestPostApproval.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestPostApproval.md new file mode 100644 index 000000000..fa191b2e5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestPostApproval.md @@ -0,0 +1,41 @@ +--- +id: beta-access-request-post-approval +title: AccessRequestPostApproval +pagination_label: AccessRequestPostApproval +sidebar_label: AccessRequestPostApproval +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPostApproval', 'BetaAccessRequestPostApproval'] +slug: /tools/sdk/powershell/beta/models/access-request-post-approval +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApproval', 'BetaAccessRequestPostApproval'] +--- + + +# AccessRequestPostApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestId** | **String** | The unique ID of the access request. | [required] +**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required] +**RequestedItemsStatus** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details on the outcome of each access item. | [required] +**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestPostApproval = Initialize-PSSailpoint.BetaAccessRequestPostApproval -AccessRequestId 2c91808b6ef1d43e016efba0ce470904 ` + -RequestedFor null ` + -RequestedItemsStatus null ` + -RequestedBy null +``` + +- Convert the resource to JSON +```powershell +$AccessRequestPostApproval | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md new file mode 100644 index 000000000..0f284ee9d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md @@ -0,0 +1,49 @@ +--- +id: beta-access-request-post-approval-requested-items-status-inner +title: AccessRequestPostApprovalRequestedItemsStatusInner +pagination_label: AccessRequestPostApprovalRequestedItemsStatusInner +sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInner', 'BetaAccessRequestPostApprovalRequestedItemsStatusInner'] +slug: /tools/sdk/powershell/beta/models/access-request-post-approval-requested-items-status-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInner', 'BetaAccessRequestPostApprovalRequestedItemsStatusInner'] +--- + + +# AccessRequestPostApprovalRequestedItemsStatusInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the access item being requested. | [required] +**Name** | **String** | The human friendly name of the access item. | [required] +**Description** | Pointer to **String** | Detailed description of the access item. | [optional] +**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of access item. | [required] +**Operation** | **Enum** [ "Add", "Remove" ] | The action to perform on the access item. | [required] +**Comment** | Pointer to **String** | A comment from the identity requesting the access. | [optional] +**ClientMetadata** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Additional customer defined metadata about the access item. | [optional] +**ApprovalInfo** | [**[]AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner**](access-request-post-approval-requested-items-status-inner-approval-info-inner) | A list of one or more approvers for the access request. | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestPostApprovalRequestedItemsStatusInner = Initialize-PSSailpoint.BetaAccessRequestPostApprovalRequestedItemsStatusInner -Id 2c91808b6ef1d43e016efba0ce470904 ` + -Name Engineering Access ` + -Description Access to engineering database ` + -Type ACCESS_PROFILE ` + -Operation Add ` + -Comment William needs this access to do his job. ` + -ClientMetadata {applicationName=My application} ` + -ApprovalInfo null +``` + +- Convert the resource to JSON +```powershell +$AccessRequestPostApprovalRequestedItemsStatusInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md new file mode 100644 index 000000000..337dcf8bc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md @@ -0,0 +1,41 @@ +--- +id: beta-access-request-post-approval-requested-items-status-inner-approval-info-inner +title: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner +pagination_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner +sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner', 'BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner'] +slug: /tools/sdk/powershell/beta/models/access-request-post-approval-requested-items-status-inner-approval-info-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner', 'BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner'] +--- + + +# AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalComment** | Pointer to **String** | A comment left by the approver. | [optional] +**ApprovalDecision** | **Enum** [ "APPROVED", "DENIED" ] | The final decision of the approver. | [required] +**ApproverName** | **String** | The name of the approver | [required] +**Approver** | [**AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover**](access-request-post-approval-requested-items-status-inner-approval-info-inner-approver) | | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner = Initialize-PSSailpoint.BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner -ApprovalComment This access looks good. Approved. ` + -ApprovalDecision APPROVED ` + -ApproverName Stephen.Austin ` + -Approver null +``` + +- Convert the resource to JSON +```powershell +$AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md new file mode 100644 index 000000000..1f16f7843 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md @@ -0,0 +1,39 @@ +--- +id: beta-access-request-post-approval-requested-items-status-inner-approval-info-inner-approver +title: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover +pagination_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover +sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover', 'BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover'] +slug: /tools/sdk/powershell/beta/models/access-request-post-approval-requested-items-status-inner-approval-info-inner-approver +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover', 'BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover'] +--- + + +# AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | The type of object that is referenced | [required] +**Id** | **String** | ID of identity who approved the access item request. | [required] +**Name** | **String** | Human-readable display name of identity who approved the access item request. | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover = Initialize-PSSailpoint.BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover -Type IDENTITY ` + -Id 2c3780a46faadee4016fb4e018c20652 ` + -Name Allen Albertson +``` + +- Convert the resource to JSON +```powershell +$AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestPreApproval.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestPreApproval.md new file mode 100644 index 000000000..49745c932 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestPreApproval.md @@ -0,0 +1,41 @@ +--- +id: beta-access-request-pre-approval +title: AccessRequestPreApproval +pagination_label: AccessRequestPreApproval +sidebar_label: AccessRequestPreApproval +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPreApproval', 'BetaAccessRequestPreApproval'] +slug: /tools/sdk/powershell/beta/models/access-request-pre-approval +tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApproval', 'BetaAccessRequestPreApproval'] +--- + + +# AccessRequestPreApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestId** | **String** | The unique ID of the access request. | [required] +**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required] +**RequestedItems** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details of the access items being requested. | [required] +**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestPreApproval = Initialize-PSSailpoint.BetaAccessRequestPreApproval -AccessRequestId 2c91808b6ef1d43e016efba0ce470904 ` + -RequestedFor null ` + -RequestedItems null ` + -RequestedBy null +``` + +- Convert the resource to JSON +```powershell +$AccessRequestPreApproval | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestPreApproval1.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestPreApproval1.md new file mode 100644 index 000000000..26f22f2ba --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestPreApproval1.md @@ -0,0 +1,39 @@ +--- +id: beta-access-request-pre-approval1 +title: AccessRequestPreApproval1 +pagination_label: AccessRequestPreApproval1 +sidebar_label: AccessRequestPreApproval1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPreApproval1', 'BetaAccessRequestPreApproval1'] +slug: /tools/sdk/powershell/beta/models/access-request-pre-approval1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApproval1', 'BetaAccessRequestPreApproval1'] +--- + + +# AccessRequestPreApproval1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Approved** | **Boolean** | Whether or not to approve the access request. | [required] +**Comment** | **String** | A comment about the decision to approve or deny the request. | [required] +**Approver** | **String** | The name of the entity that approved or denied the request. | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestPreApproval1 = Initialize-PSSailpoint.BetaAccessRequestPreApproval1 -Approved false ` + -Comment This access should be denied, because this will cause an SOD violation. ` + -Approver AcmeCorpExternalIntegration +``` + +- Convert the resource to JSON +```powershell +$AccessRequestPreApproval1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestPreApprovalRequestedItemsInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestPreApprovalRequestedItemsInner.md new file mode 100644 index 000000000..946e8c2eb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestPreApprovalRequestedItemsInner.md @@ -0,0 +1,45 @@ +--- +id: beta-access-request-pre-approval-requested-items-inner +title: AccessRequestPreApprovalRequestedItemsInner +pagination_label: AccessRequestPreApprovalRequestedItemsInner +sidebar_label: AccessRequestPreApprovalRequestedItemsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPreApprovalRequestedItemsInner', 'BetaAccessRequestPreApprovalRequestedItemsInner'] +slug: /tools/sdk/powershell/beta/models/access-request-pre-approval-requested-items-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApprovalRequestedItemsInner', 'BetaAccessRequestPreApprovalRequestedItemsInner'] +--- + + +# AccessRequestPreApprovalRequestedItemsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the access item being requested. | [required] +**Name** | **String** | The human friendly name of the access item. | [required] +**Description** | Pointer to **String** | Detailed description of the access item. | [optional] +**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of access item. | [required] +**Operation** | **Enum** [ "Add", "Remove" ] | The action to perform on the access item. | [required] +**Comment** | Pointer to **String** | A comment from the identity requesting the access. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestPreApprovalRequestedItemsInner = Initialize-PSSailpoint.BetaAccessRequestPreApprovalRequestedItemsInner -Id 2c91808b6ef1d43e016efba0ce470904 ` + -Name Engineering Access ` + -Description Access to engineering database ` + -Type ACCESS_PROFILE ` + -Operation Add ` + -Comment William needs this access to do his job. +``` + +- Convert the resource to JSON +```powershell +$AccessRequestPreApprovalRequestedItemsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestRecommendationActionItemDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestRecommendationActionItemDto.md new file mode 100644 index 000000000..0508b6e29 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestRecommendationActionItemDto.md @@ -0,0 +1,37 @@ +--- +id: beta-access-request-recommendation-action-item-dto +title: AccessRequestRecommendationActionItemDto +pagination_label: AccessRequestRecommendationActionItemDto +sidebar_label: AccessRequestRecommendationActionItemDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationActionItemDto', 'BetaAccessRequestRecommendationActionItemDto'] +slug: /tools/sdk/powershell/beta/models/access-request-recommendation-action-item-dto +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationActionItemDto', 'BetaAccessRequestRecommendationActionItemDto'] +--- + + +# AccessRequestRecommendationActionItemDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **String** | The identity ID taking the action. | [required] +**Access** | [**AccessRequestRecommendationItem**](access-request-recommendation-item) | | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestRecommendationActionItemDto = Initialize-PSSailpoint.BetaAccessRequestRecommendationActionItemDto -IdentityId 2c91808570313110017040b06f344ec9 ` + -Access null +``` + +- Convert the resource to JSON +```powershell +$AccessRequestRecommendationActionItemDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestRecommendationActionItemResponseDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestRecommendationActionItemResponseDto.md new file mode 100644 index 000000000..36344b3b5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestRecommendationActionItemResponseDto.md @@ -0,0 +1,39 @@ +--- +id: beta-access-request-recommendation-action-item-response-dto +title: AccessRequestRecommendationActionItemResponseDto +pagination_label: AccessRequestRecommendationActionItemResponseDto +sidebar_label: AccessRequestRecommendationActionItemResponseDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationActionItemResponseDto', 'BetaAccessRequestRecommendationActionItemResponseDto'] +slug: /tools/sdk/powershell/beta/models/access-request-recommendation-action-item-response-dto +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationActionItemResponseDto', 'BetaAccessRequestRecommendationActionItemResponseDto'] +--- + + +# AccessRequestRecommendationActionItemResponseDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **String** | The identity ID taking the action. | [optional] +**Access** | Pointer to [**AccessRequestRecommendationItem**](access-request-recommendation-item) | | [optional] +**Timestamp** | Pointer to **System.DateTime** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestRecommendationActionItemResponseDto = Initialize-PSSailpoint.BetaAccessRequestRecommendationActionItemResponseDto -IdentityId 2c91808570313110017040b06f344ec9 ` + -Access null ` + -Timestamp 2017-07-11T18:45:37.098Z +``` + +- Convert the resource to JSON +```powershell +$AccessRequestRecommendationActionItemResponseDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestRecommendationItem.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestRecommendationItem.md new file mode 100644 index 000000000..559b27eca --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestRecommendationItem.md @@ -0,0 +1,37 @@ +--- +id: beta-access-request-recommendation-item +title: AccessRequestRecommendationItem +pagination_label: AccessRequestRecommendationItem +sidebar_label: AccessRequestRecommendationItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationItem', 'BetaAccessRequestRecommendationItem'] +slug: /tools/sdk/powershell/beta/models/access-request-recommendation-item +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItem', 'BetaAccessRequestRecommendationItem'] +--- + + +# AccessRequestRecommendationItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of access item being recommended. | [optional] +**Type** | Pointer to [**AccessRequestRecommendationItemType**](access-request-recommendation-item-type) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestRecommendationItem = Initialize-PSSailpoint.BetaAccessRequestRecommendationItem -Id 2c9180835d2e5168015d32f890ca1581 ` + -Type null +``` + +- Convert the resource to JSON +```powershell +$AccessRequestRecommendationItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestRecommendationItemDetail.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestRecommendationItemDetail.md new file mode 100644 index 000000000..c8a309bd1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestRecommendationItemDetail.md @@ -0,0 +1,47 @@ +--- +id: beta-access-request-recommendation-item-detail +title: AccessRequestRecommendationItemDetail +pagination_label: AccessRequestRecommendationItemDetail +sidebar_label: AccessRequestRecommendationItemDetail +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationItemDetail', 'BetaAccessRequestRecommendationItemDetail'] +slug: /tools/sdk/powershell/beta/models/access-request-recommendation-item-detail +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemDetail', 'BetaAccessRequestRecommendationItemDetail'] +--- + + +# AccessRequestRecommendationItemDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **String** | Identity ID for the recommendation | [optional] +**Access** | Pointer to [**AccessRequestRecommendationItemDetailAccess**](access-request-recommendation-item-detail-access) | | [optional] +**Ignored** | Pointer to **Boolean** | Whether or not the identity has already chosen to ignore this recommendation. | [optional] +**Requested** | Pointer to **Boolean** | Whether or not the identity has already chosen to request this recommendation. | [optional] +**Viewed** | Pointer to **Boolean** | Whether or not the identity reportedly viewed this recommendation. | [optional] +**Messages** | Pointer to [**[]AccessRecommendationMessage**](access-recommendation-message) | | [optional] +**TranslationMessages** | Pointer to [**[]TranslationMessage**](translation-message) | The list of translation messages | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestRecommendationItemDetail = Initialize-PSSailpoint.BetaAccessRequestRecommendationItemDetail -IdentityId 2c91808570313110017040b06f344ec9 ` + -Access null ` + -Ignored true ` + -Requested true ` + -Viewed true ` + -Messages null ` + -TranslationMessages [{key=recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values=[75, department]}] +``` + +- Convert the resource to JSON +```powershell +$AccessRequestRecommendationItemDetail | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestRecommendationItemDetailAccess.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestRecommendationItemDetailAccess.md new file mode 100644 index 000000000..4109e514a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestRecommendationItemDetailAccess.md @@ -0,0 +1,41 @@ +--- +id: beta-access-request-recommendation-item-detail-access +title: AccessRequestRecommendationItemDetailAccess +pagination_label: AccessRequestRecommendationItemDetailAccess +sidebar_label: AccessRequestRecommendationItemDetailAccess +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationItemDetailAccess', 'BetaAccessRequestRecommendationItemDetailAccess'] +slug: /tools/sdk/powershell/beta/models/access-request-recommendation-item-detail-access +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemDetailAccess', 'BetaAccessRequestRecommendationItemDetailAccess'] +--- + + +# AccessRequestRecommendationItemDetailAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of access item being recommended. | [optional] +**Type** | Pointer to [**AccessRequestRecommendationItemType**](access-request-recommendation-item-type) | | [optional] +**Name** | Pointer to **String** | Name of the access item | [optional] +**Description** | Pointer to **String** | Description of the access item | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestRecommendationItemDetailAccess = Initialize-PSSailpoint.BetaAccessRequestRecommendationItemDetailAccess -Id 2c9180835d2e5168015d32f890ca1581 ` + -Type null ` + -Name Employee-database-read-write ` + -Description This item grants an employee read and write access to the database +``` + +- Convert the resource to JSON +```powershell +$AccessRequestRecommendationItemDetailAccess | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestRecommendationItemType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestRecommendationItemType.md new file mode 100644 index 000000000..f68fa045c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestRecommendationItemType.md @@ -0,0 +1,24 @@ +--- +id: beta-access-request-recommendation-item-type +title: AccessRequestRecommendationItemType +pagination_label: AccessRequestRecommendationItemType +sidebar_label: AccessRequestRecommendationItemType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationItemType', 'BetaAccessRequestRecommendationItemType'] +slug: /tools/sdk/powershell/beta/models/access-request-recommendation-item-type +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemType', 'BetaAccessRequestRecommendationItemType'] +--- + + +# AccessRequestRecommendationItemType + +## Enum + + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ROLE` (value: `"ROLE"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestResponse.md new file mode 100644 index 000000000..ee7032949 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestResponse.md @@ -0,0 +1,37 @@ +--- +id: beta-access-request-response +title: AccessRequestResponse +pagination_label: AccessRequestResponse +sidebar_label: AccessRequestResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestResponse', 'BetaAccessRequestResponse'] +slug: /tools/sdk/powershell/beta/models/access-request-response +tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse', 'BetaAccessRequestResponse'] +--- + + +# AccessRequestResponse + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestResponse = Initialize-PSSailpoint.BetaAccessRequestResponse -NewRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ENTITLEMENT, id=779c6fd7171540bba1184e5946112c28}], attributesHash=-1928438224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdb]}] ` + -ExistingRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ROLE, id=779c6fd7171540bbc1184e5946112c28}], attributesHash=2843118224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdc]}] +``` + +- Convert the resource to JSON +```powershell +$AccessRequestResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestResponse1.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestResponse1.md new file mode 100644 index 000000000..59d073ef3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestResponse1.md @@ -0,0 +1,39 @@ +--- +id: beta-access-request-response1 +title: AccessRequestResponse1 +pagination_label: AccessRequestResponse1 +sidebar_label: AccessRequestResponse1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestResponse1', 'BetaAccessRequestResponse1'] +slug: /tools/sdk/powershell/beta/models/access-request-response1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse1', 'BetaAccessRequestResponse1'] +--- + + +# AccessRequestResponse1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequesterId** | Pointer to **String** | the requester Id | [optional] +**RequesterName** | Pointer to **String** | the requesterName | [optional] +**Items** | Pointer to [**[]AccessRequestItemResponse**](access-request-item-response) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestResponse1 = Initialize-PSSailpoint.BetaAccessRequestResponse1 -RequesterId 2c91808a77ff216301782327a50f09bf ` + -RequesterName Bing C ` + -Items [{operation=Add, accessItemType=role, name=Role-1, decision=APPROVED, description=The role descrition, sourceId=8a80828f643d484f01643e14202e206f, sourceName=Source1, approvalInfos=[{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}]}] +``` + +- Convert the resource to JSON +```powershell +$AccessRequestResponse1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestTracking.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestTracking.md new file mode 100644 index 000000000..25d390ddb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestTracking.md @@ -0,0 +1,44 @@ +--- +id: beta-access-request-tracking +title: AccessRequestTracking +pagination_label: AccessRequestTracking +sidebar_label: AccessRequestTracking +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestTracking', 'BetaAccessRequestTracking'] +slug: /tools/sdk/powershell/beta/models/access-request-tracking +tags: ['SDK', 'Software Development Kit', 'AccessRequestTracking', 'BetaAccessRequestTracking'] +--- + + +# AccessRequestTracking + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestTracking = Initialize-PSSailpoint.BetaAccessRequestTracking -RequestedFor 2c918084660f45d6016617daa9210584 ` + -RequestedItemsDetails { +"type": "ENTITLEMENT", +"id": "779c6fd7171540bba1184e5946112c28" + } ` + -AttributesHash -1928438224 ` + -AccessRequestIds [5d3118c518a44ec7805450d53479ccdb] +``` + +- Convert the resource to JSON +```powershell +$AccessRequestTracking | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestType.md new file mode 100644 index 000000000..feb9f00e3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequestType.md @@ -0,0 +1,24 @@ +--- +id: beta-access-request-type +title: AccessRequestType +pagination_label: AccessRequestType +sidebar_label: AccessRequestType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestType', 'BetaAccessRequestType'] +slug: /tools/sdk/powershell/beta/models/access-request-type +tags: ['SDK', 'Software Development Kit', 'AccessRequestType', 'BetaAccessRequestType'] +--- + + +# AccessRequestType + +## Enum + + +* `GRANT_ACCESS` (value: `"GRANT_ACCESS"`) + +* `REVOKE_ACCESS` (value: `"REVOKE_ACCESS"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequested.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequested.md new file mode 100644 index 000000000..968190aa8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessRequested.md @@ -0,0 +1,41 @@ +--- +id: beta-access-requested +title: AccessRequested +pagination_label: AccessRequested +sidebar_label: AccessRequested +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequested', 'BetaAccessRequested'] +slug: /tools/sdk/powershell/beta/models/access-requested +tags: ['SDK', 'Software Development Kit', 'AccessRequested', 'BetaAccessRequested'] +--- + + +# AccessRequested + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequest** | Pointer to [**AccessRequestResponse1**](access-request-response1) | | [optional] +**IdentityId** | Pointer to **String** | the identity id | [optional] +**EventType** | Pointer to **String** | the event type | [optional] +**Dt** | Pointer to **String** | the date of event | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequested = Initialize-PSSailpoint.BetaAccessRequested -AccessRequest null ` + -IdentityId 8a80828f643d484f01643e14202e206f ` + -EventType AccessRequested ` + -Dt 2019-03-08T22:37:33.901Z +``` + +- Convert the resource to JSON +```powershell +$AccessRequested | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessType.md new file mode 100644 index 000000000..7f35975ee --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccessType.md @@ -0,0 +1,24 @@ +--- +id: beta-access-type +title: AccessType +pagination_label: AccessType +sidebar_label: AccessType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessType', 'BetaAccessType'] +slug: /tools/sdk/powershell/beta/models/access-type +tags: ['SDK', 'Software Development Kit', 'AccessType', 'BetaAccessType'] +--- + + +# AccessType + +## Enum + + +* `ONLINE` (value: `"ONLINE"`) + +* `OFFLINE` (value: `"OFFLINE"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Account.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Account.md new file mode 100644 index 000000000..e5aa74fab --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Account.md @@ -0,0 +1,89 @@ +--- +id: beta-account +title: Account +pagination_label: Account +sidebar_label: Account +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Account', 'BetaAccount'] +slug: /tools/sdk/powershell/beta/models/account +tags: ['SDK', 'Software Development Kit', 'Account', 'BetaAccount'] +--- + + +# Account + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$Account = Initialize-PSSailpoint.BetaAccount -Id id12345 ` + -Name aName ` + -Created 2023-01-03T21:16:22.432Z ` + -Modified 2023-01-03T21:16:22.432Z ` + -SourceId 2c9180835d2e5168015d32f890ca1581 ` + -SourceName Employees ` + -IdentityId 2c9180835d2e5168015d32f890ca1581 ` + -CloudLifecycleState active ` + -IdentityState ACTIVE ` + -ConnectionType direct ` + -IsMachine true ` + -Recommendation null ` + -Attributes {firstName=SailPoint, lastName=Support, displayName=SailPoint Support} ` + -Authoritative false ` + -Description null ` + -Disabled false ` + -Locked false ` + -NativeIdentity 552775 ` + -SystemAccount false ` + -Uncorrelated false ` + -Uuid {b0dce506-d6d4-44d2-8a32-d9a5b21fb175} ` + -ManuallyCorrelated false ` + -HasEntitlements true ` + -Identity null ` + -SourceOwner null ` + -Features ENABLE ` + -Origin AGGREGATED ` + -OwnerIdentity null +``` + +- Convert the resource to JSON +```powershell +$Account | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAction.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAction.md new file mode 100644 index 000000000..2dfaf5f3f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAction.md @@ -0,0 +1,37 @@ +--- +id: beta-account-action +title: AccountAction +pagination_label: AccountAction +sidebar_label: AccountAction +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAction', 'BetaAccountAction'] +slug: /tools/sdk/powershell/beta/models/account-action +tags: ['SDK', 'Software Development Kit', 'AccountAction', 'BetaAccountAction'] +--- + + +# AccountAction + +## Properties + +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 source IDs. The sources must have the ENABLE feature or flat file source. See ""/sources"" endpoint for source features. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountAction = Initialize-PSSailpoint.BetaAccountAction -Action ENABLE ` + -SourceIds [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500] +``` + +- Convert the resource to JSON +```powershell +$AccountAction | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountActivityApprovalStatus.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountActivityApprovalStatus.md new file mode 100644 index 000000000..c192530e2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountActivityApprovalStatus.md @@ -0,0 +1,32 @@ +--- +id: beta-account-activity-approval-status +title: AccountActivityApprovalStatus +pagination_label: AccountActivityApprovalStatus +sidebar_label: AccountActivityApprovalStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivityApprovalStatus', 'BetaAccountActivityApprovalStatus'] +slug: /tools/sdk/powershell/beta/models/account-activity-approval-status +tags: ['SDK', 'Software Development Kit', 'AccountActivityApprovalStatus', 'BetaAccountActivityApprovalStatus'] +--- + + +# AccountActivityApprovalStatus + +## Enum + + +* `FINISHED` (value: `"FINISHED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `RETURNED` (value: `"RETURNED"`) + +* `EXPIRED` (value: `"EXPIRED"`) + +* `PENDING` (value: `"PENDING"`) + +* `CANCELED` (value: `"CANCELED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountActivityItem.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountActivityItem.md new file mode 100644 index 000000000..87c7c7f06 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountActivityItem.md @@ -0,0 +1,65 @@ +--- +id: beta-account-activity-item +title: AccountActivityItem +pagination_label: AccountActivityItem +sidebar_label: AccountActivityItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivityItem', 'BetaAccountActivityItem'] +slug: /tools/sdk/powershell/beta/models/account-activity-item +tags: ['SDK', 'Software Development Kit', 'AccountActivityItem', 'BetaAccountActivityItem'] +--- + + +# AccountActivityItem + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountActivityItem = Initialize-PSSailpoint.BetaAccountActivityItem -Id 48c545831b264409a81befcabb0e3c5a ` + -Name 48c545831b264409a81befcabb0e3c5a ` + -Requested 2017-07-11T18:45:37.098Z ` + -ApprovalStatus null ` + -ProvisioningStatus null ` + -RequesterComment null ` + -ReviewerIdentitySummary null ` + -ReviewerComment null ` + -Operation null ` + -Attribute detectedRoles ` + -Value Treasury Analyst [AccessProfile-1529010191212] ` + -NativeIdentity Sandie.Camero ` + -SourceId 2c91808363ef85290164000587130c0c ` + -AccountRequestInfo null ` + -ClientMetadata {customKey1=custom value 1, customKey2=custom value 2} ` + -RemoveDate 2020-07-11T00:00Z +``` + +- Convert the resource to JSON +```powershell +$AccountActivityItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountActivityItemOperation.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountActivityItemOperation.md new file mode 100644 index 000000000..b4812279a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountActivityItemOperation.md @@ -0,0 +1,40 @@ +--- +id: beta-account-activity-item-operation +title: AccountActivityItemOperation +pagination_label: AccountActivityItemOperation +sidebar_label: AccountActivityItemOperation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivityItemOperation', 'BetaAccountActivityItemOperation'] +slug: /tools/sdk/powershell/beta/models/account-activity-item-operation +tags: ['SDK', 'Software Development Kit', 'AccountActivityItemOperation', 'BetaAccountActivityItemOperation'] +--- + + +# AccountActivityItemOperation + +## Enum + + +* `ADD` (value: `"ADD"`) + +* `CREATE` (value: `"CREATE"`) + +* `MODIFY` (value: `"MODIFY"`) + +* `DELETE` (value: `"DELETE"`) + +* `DISABLE` (value: `"DISABLE"`) + +* `ENABLE` (value: `"ENABLE"`) + +* `UNLOCK` (value: `"UNLOCK"`) + +* `LOCK` (value: `"LOCK"`) + +* `REMOVE` (value: `"REMOVE"`) + +* `SET` (value: `"SET"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAggregation.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAggregation.md new file mode 100644 index 000000000..7109fade8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAggregation.md @@ -0,0 +1,41 @@ +--- +id: beta-account-aggregation +title: AccountAggregation +pagination_label: AccountAggregation +sidebar_label: AccountAggregation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAggregation', 'BetaAccountAggregation'] +slug: /tools/sdk/powershell/beta/models/account-aggregation +tags: ['SDK', 'Software Development Kit', 'AccountAggregation', 'BetaAccountAggregation'] +--- + + +# AccountAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Start** | Pointer to **System.DateTime** | When the aggregation started. | [optional] +**Status** | Pointer to **Enum** [ "STARTED", "ACCOUNTS_COLLECTED", "COMPLETED", "CANCELLED", "RETRIED", "TERMINATED" ] | STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. | [optional] +**TotalAccounts** | Pointer to **Int32** | The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional] +**ProcessedAccounts** | Pointer to **Int32** | The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountAggregation = Initialize-PSSailpoint.BetaAccountAggregation -Start 2021-01-31T14:30:05.104Z ` + -Status ACCOUNTS_COLLECTED ` + -TotalAccounts 520 ` + -ProcessedAccounts 150 +``` + +- Convert the resource to JSON +```powershell +$AccountAggregation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAggregationCompleted.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAggregationCompleted.md new file mode 100644 index 000000000..0991ce3b2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAggregationCompleted.md @@ -0,0 +1,47 @@ +--- +id: beta-account-aggregation-completed +title: AccountAggregationCompleted +pagination_label: AccountAggregationCompleted +sidebar_label: AccountAggregationCompleted +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAggregationCompleted', 'BetaAccountAggregationCompleted'] +slug: /tools/sdk/powershell/beta/models/account-aggregation-completed +tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompleted', 'BetaAccountAggregationCompleted'] +--- + + +# AccountAggregationCompleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | [**AccountAggregationCompletedSource**](account-aggregation-completed-source) | | [required] +**Status** | **Enum** [ "Success", "Failed", "Terminated" ] | The overall status of the aggregation. | [required] +**Started** | **System.DateTime** | The date and time when the account aggregation started. | [required] +**Completed** | **System.DateTime** | The date and time when the account aggregation finished. | [required] +**Errors** | **[]String** | A list of errors that occurred during the aggregation. | [required] +**Warnings** | **[]String** | A list of warnings that occurred during the aggregation. | [required] +**Stats** | [**AccountAggregationCompletedStats**](account-aggregation-completed-stats) | | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountAggregationCompleted = Initialize-PSSailpoint.BetaAccountAggregationCompleted -Source null ` + -Status Success ` + -Started 2020-06-29T22:01:50.474Z ` + -Completed 2020-06-29T22:02:04.090Z ` + -Errors null ` + -Warnings null ` + -Stats null +``` + +- Convert the resource to JSON +```powershell +$AccountAggregationCompleted | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAggregationCompletedSource.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAggregationCompletedSource.md new file mode 100644 index 000000000..0727227f8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAggregationCompletedSource.md @@ -0,0 +1,39 @@ +--- +id: beta-account-aggregation-completed-source +title: AccountAggregationCompletedSource +pagination_label: AccountAggregationCompletedSource +sidebar_label: AccountAggregationCompletedSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAggregationCompletedSource', 'BetaAccountAggregationCompletedSource'] +slug: /tools/sdk/powershell/beta/models/account-aggregation-completed-source +tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedSource', 'BetaAccountAggregationCompletedSource'] +--- + + +# AccountAggregationCompletedSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "SOURCE" ] | The DTO type of the source the accounts are being aggregated from. | [required] +**Id** | **String** | The ID of the source the accounts are being aggregated from. | [required] +**Name** | **String** | Display name of the source the accounts are being aggregated from. | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountAggregationCompletedSource = Initialize-PSSailpoint.BetaAccountAggregationCompletedSource -Type SOURCE ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name HR Active Directory +``` + +- Convert the resource to JSON +```powershell +$AccountAggregationCompletedSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAggregationCompletedStats.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAggregationCompletedStats.md new file mode 100644 index 000000000..f1ce75998 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAggregationCompletedStats.md @@ -0,0 +1,43 @@ +--- +id: beta-account-aggregation-completed-stats +title: AccountAggregationCompletedStats +pagination_label: AccountAggregationCompletedStats +sidebar_label: AccountAggregationCompletedStats +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAggregationCompletedStats', 'BetaAccountAggregationCompletedStats'] +slug: /tools/sdk/powershell/beta/models/account-aggregation-completed-stats +tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedStats', 'BetaAccountAggregationCompletedStats'] +--- + + +# AccountAggregationCompletedStats + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Scanned** | **Int32** | The number of accounts which were scanned / iterated over. | [required] +**Unchanged** | **Int32** | The number of accounts which existed before, but had no changes. | [required] +**Changed** | **Int32** | The number of accounts which existed before, but had changes. | [required] +**Added** | **Int32** | The number of accounts which are new - have not existed before. | [required] +**Removed** | **Int32** | The number accounts which existed before, but no longer exist (thus getting removed). | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountAggregationCompletedStats = Initialize-PSSailpoint.BetaAccountAggregationCompletedStats -Scanned 200 ` + -Unchanged 190 ` + -Changed 6 ` + -Added 4 ` + -Removed 3 +``` + +- Convert the resource to JSON +```powershell +$AccountAggregationCompletedStats | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAggregationStatus.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAggregationStatus.md new file mode 100644 index 000000000..f2dd840d4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAggregationStatus.md @@ -0,0 +1,41 @@ +--- +id: beta-account-aggregation-status +title: AccountAggregationStatus +pagination_label: AccountAggregationStatus +sidebar_label: AccountAggregationStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAggregationStatus', 'BetaAccountAggregationStatus'] +slug: /tools/sdk/powershell/beta/models/account-aggregation-status +tags: ['SDK', 'Software Development Kit', 'AccountAggregationStatus', 'BetaAccountAggregationStatus'] +--- + + +# AccountAggregationStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Start** | Pointer to **System.DateTime** | When the aggregation started. | [optional] +**Status** | Pointer to **Enum** [ "STARTED", "ACCOUNTS_COLLECTED", "COMPLETED", "CANCELLED", "RETRIED", "TERMINATED" ] | STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. | [optional] +**TotalAccounts** | Pointer to **Int32** | The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional] +**ProcessedAccounts** | Pointer to **Int32** | The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountAggregationStatus = Initialize-PSSailpoint.BetaAccountAggregationStatus -Start 2021-01-31T14:30:05.104Z ` + -Status ACCOUNTS_COLLECTED ` + -TotalAccounts 520 ` + -ProcessedAccounts 150 +``` + +- Convert the resource to JSON +```powershell +$AccountAggregationStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttribute.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttribute.md new file mode 100644 index 000000000..1e33e1bc6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttribute.md @@ -0,0 +1,51 @@ +--- +id: beta-account-attribute +title: AccountAttribute +pagination_label: AccountAttribute +sidebar_label: AccountAttribute +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttribute', 'BetaAccountAttribute'] +slug: /tools/sdk/powershell/beta/models/account-attribute +tags: ['SDK', 'Software Development Kit', 'AccountAttribute', 'BetaAccountAttribute'] +--- + + +# AccountAttribute + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountAttribute = Initialize-PSSailpoint.BetaAccountAttribute -SourceName Workday ` + -AttributeName DEPARTMENT ` + -AccountSortAttribute created ` + -AccountSortDescending false ` + -AccountReturnFirstLink false ` + -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` + -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$AccountAttribute | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributes.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributes.md new file mode 100644 index 000000000..110fd2c8e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributes.md @@ -0,0 +1,35 @@ +--- +id: beta-account-attributes +title: AccountAttributes +pagination_label: AccountAttributes +sidebar_label: AccountAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributes', 'BetaAccountAttributes'] +slug: /tools/sdk/powershell/beta/models/account-attributes +tags: ['SDK', 'Software Development Kit', 'AccountAttributes', 'BetaAccountAttributes'] +--- + + +# AccountAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The schema attribute values for the account | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountAttributes = Initialize-PSSailpoint.BetaAccountAttributes -Attributes {city=Austin, displayName=John Doe, userName=jdoe, sAMAccountName=jDoe, mail=john.doe@sailpoint.com} +``` + +- Convert the resource to JSON +```powershell +$AccountAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesChanged.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesChanged.md new file mode 100644 index 000000000..7c4986891 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesChanged.md @@ -0,0 +1,41 @@ +--- +id: beta-account-attributes-changed +title: AccountAttributesChanged +pagination_label: AccountAttributesChanged +sidebar_label: AccountAttributesChanged +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChanged', 'BetaAccountAttributesChanged'] +slug: /tools/sdk/powershell/beta/models/account-attributes-changed +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChanged', 'BetaAccountAttributesChanged'] +--- + + +# AccountAttributesChanged + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**AccountAttributesChangedIdentity**](account-attributes-changed-identity) | | [required] +**Source** | [**AccountAttributesChangedSource**](account-attributes-changed-source) | | [required] +**Account** | [**AccountAttributesChangedAccount**](account-attributes-changed-account) | | [required] +**Changes** | [**[]AccountAttributesChangedChangesInner**](account-attributes-changed-changes-inner) | A list of attributes that changed. | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountAttributesChanged = Initialize-PSSailpoint.BetaAccountAttributesChanged -Identity null ` + -Source null ` + -Account null ` + -Changes null +``` + +- Convert the resource to JSON +```powershell +$AccountAttributesChanged | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesChangedAccount.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesChangedAccount.md new file mode 100644 index 000000000..05438fef2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesChangedAccount.md @@ -0,0 +1,43 @@ +--- +id: beta-account-attributes-changed-account +title: AccountAttributesChangedAccount +pagination_label: AccountAttributesChangedAccount +sidebar_label: AccountAttributesChangedAccount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChangedAccount', 'BetaAccountAttributesChangedAccount'] +slug: /tools/sdk/powershell/beta/models/account-attributes-changed-account +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedAccount', 'BetaAccountAttributesChangedAccount'] +--- + + +# AccountAttributesChangedAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | SailPoint generated unique identifier. | [required] +**Uuid** | **String** | The source's unique identifier for the account. UUID is generated by the source system. | [required] +**Name** | **String** | Name of the account. | [required] +**NativeIdentity** | **String** | Unique ID of the account on the source. | [required] +**Type** | **Enum** [ "ACCOUNT" ] | The type of the account | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountAttributesChangedAccount = Initialize-PSSailpoint.BetaAccountAttributesChangedAccount -Id 52170a74-ca89-11ea-87d0-0242ac130003 ` + -Uuid 1cb1f07d-3e5a-4431-becd-234fa4306108 ` + -Name john.doe ` + -NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com ` + -Type ACCOUNT +``` + +- Convert the resource to JSON +```powershell +$AccountAttributesChangedAccount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesChangedChangesInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesChangedChangesInner.md new file mode 100644 index 000000000..1de4373ad --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesChangedChangesInner.md @@ -0,0 +1,39 @@ +--- +id: beta-account-attributes-changed-changes-inner +title: AccountAttributesChangedChangesInner +pagination_label: AccountAttributesChangedChangesInner +sidebar_label: AccountAttributesChangedChangesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChangedChangesInner', 'BetaAccountAttributesChangedChangesInner'] +slug: /tools/sdk/powershell/beta/models/account-attributes-changed-changes-inner +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInner', 'BetaAccountAttributesChangedChangesInner'] +--- + + +# AccountAttributesChangedChangesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attribute** | **String** | The name of the attribute. | [required] +**OldValue** | [**AccountAttributesChangedChangesInnerOldValue**](account-attributes-changed-changes-inner-old-value) | | [required] +**NewValue** | [**AccountAttributesChangedChangesInnerNewValue**](account-attributes-changed-changes-inner-new-value) | | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountAttributesChangedChangesInner = Initialize-PSSailpoint.BetaAccountAttributesChangedChangesInner -Attribute sn ` + -OldValue null ` + -NewValue null +``` + +- Convert the resource to JSON +```powershell +$AccountAttributesChangedChangesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesChangedChangesInnerNewValue.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesChangedChangesInnerNewValue.md new file mode 100644 index 000000000..8eb6d03f9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesChangedChangesInnerNewValue.md @@ -0,0 +1,34 @@ +--- +id: beta-account-attributes-changed-changes-inner-new-value +title: AccountAttributesChangedChangesInnerNewValue +pagination_label: AccountAttributesChangedChangesInnerNewValue +sidebar_label: AccountAttributesChangedChangesInnerNewValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChangedChangesInnerNewValue', 'BetaAccountAttributesChangedChangesInnerNewValue'] +slug: /tools/sdk/powershell/beta/models/account-attributes-changed-changes-inner-new-value +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInnerNewValue', 'BetaAccountAttributesChangedChangesInnerNewValue'] +--- + + +# AccountAttributesChangedChangesInnerNewValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$AccountAttributesChangedChangesInnerNewValue = Initialize-PSSailpoint.BetaAccountAttributesChangedChangesInnerNewValue +``` + +- Convert the resource to JSON +```powershell +$AccountAttributesChangedChangesInnerNewValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesChangedChangesInnerOldValue.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesChangedChangesInnerOldValue.md new file mode 100644 index 000000000..e1a816a87 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesChangedChangesInnerOldValue.md @@ -0,0 +1,34 @@ +--- +id: beta-account-attributes-changed-changes-inner-old-value +title: AccountAttributesChangedChangesInnerOldValue +pagination_label: AccountAttributesChangedChangesInnerOldValue +sidebar_label: AccountAttributesChangedChangesInnerOldValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChangedChangesInnerOldValue', 'BetaAccountAttributesChangedChangesInnerOldValue'] +slug: /tools/sdk/powershell/beta/models/account-attributes-changed-changes-inner-old-value +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInnerOldValue', 'BetaAccountAttributesChangedChangesInnerOldValue'] +--- + + +# AccountAttributesChangedChangesInnerOldValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$AccountAttributesChangedChangesInnerOldValue = Initialize-PSSailpoint.BetaAccountAttributesChangedChangesInnerOldValue +``` + +- Convert the resource to JSON +```powershell +$AccountAttributesChangedChangesInnerOldValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesChangedIdentity.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesChangedIdentity.md new file mode 100644 index 000000000..3e88c7dcb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesChangedIdentity.md @@ -0,0 +1,39 @@ +--- +id: beta-account-attributes-changed-identity +title: AccountAttributesChangedIdentity +pagination_label: AccountAttributesChangedIdentity +sidebar_label: AccountAttributesChangedIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChangedIdentity', 'BetaAccountAttributesChangedIdentity'] +slug: /tools/sdk/powershell/beta/models/account-attributes-changed-identity +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedIdentity', 'BetaAccountAttributesChangedIdentity'] +--- + + +# AccountAttributesChangedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | DTO type of the identity whose account attributes were updated. | [required] +**Id** | **String** | ID of the identity whose account attributes were updated. | [required] +**Name** | **String** | Display name of the identity whose account attributes were updated. | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountAttributesChangedIdentity = Initialize-PSSailpoint.BetaAccountAttributesChangedIdentity -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$AccountAttributesChangedIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesChangedSource.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesChangedSource.md new file mode 100644 index 000000000..a5fc4039e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesChangedSource.md @@ -0,0 +1,39 @@ +--- +id: beta-account-attributes-changed-source +title: AccountAttributesChangedSource +pagination_label: AccountAttributesChangedSource +sidebar_label: AccountAttributesChangedSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChangedSource', 'BetaAccountAttributesChangedSource'] +slug: /tools/sdk/powershell/beta/models/account-attributes-changed-source +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedSource', 'BetaAccountAttributesChangedSource'] +--- + + +# AccountAttributesChangedSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | ID of the object to which this reference applies | [required] +**Type** | **Enum** [ "SOURCE" ] | The type of object that is referenced | [required] +**Name** | **String** | Human-readable display name of the object to which this reference applies | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountAttributesChangedSource = Initialize-PSSailpoint.BetaAccountAttributesChangedSource -Id 4e4d982dddff4267ab12f0f1e72b5a6d ` + -Type SOURCE ` + -Name Corporate Active Directory +``` + +- Convert the resource to JSON +```powershell +$AccountAttributesChangedSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesCreate.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesCreate.md new file mode 100644 index 000000000..f4335ac99 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesCreate.md @@ -0,0 +1,35 @@ +--- +id: beta-account-attributes-create +title: AccountAttributesCreate +pagination_label: AccountAttributesCreate +sidebar_label: AccountAttributesCreate +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesCreate', 'BetaAccountAttributesCreate'] +slug: /tools/sdk/powershell/beta/models/account-attributes-create +tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreate', 'BetaAccountAttributesCreate'] +--- + + +# AccountAttributesCreate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | [**AccountAttributesCreateAttributes**](account-attributes-create-attributes) | | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountAttributesCreate = Initialize-PSSailpoint.BetaAccountAttributesCreate -Attributes null +``` + +- Convert the resource to JSON +```powershell +$AccountAttributesCreate | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesCreateAttributes.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesCreateAttributes.md new file mode 100644 index 000000000..be981ffcd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountAttributesCreateAttributes.md @@ -0,0 +1,35 @@ +--- +id: beta-account-attributes-create-attributes +title: AccountAttributesCreateAttributes +pagination_label: AccountAttributesCreateAttributes +sidebar_label: AccountAttributesCreateAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesCreateAttributes', 'BetaAccountAttributesCreateAttributes'] +slug: /tools/sdk/powershell/beta/models/account-attributes-create-attributes +tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreateAttributes', 'BetaAccountAttributesCreateAttributes'] +--- + + +# AccountAttributesCreateAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceId** | **String** | Target source to create an account | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountAttributesCreateAttributes = Initialize-PSSailpoint.BetaAccountAttributesCreateAttributes -SourceId 34bfcbe116c9407464af37acbaf7a4dc +``` + +- Convert the resource to JSON +```powershell +$AccountAttributesCreateAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountCorrelated.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountCorrelated.md new file mode 100644 index 000000000..6c71cb7ea --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountCorrelated.md @@ -0,0 +1,43 @@ +--- +id: beta-account-correlated +title: AccountCorrelated +pagination_label: AccountCorrelated +sidebar_label: AccountCorrelated +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountCorrelated', 'BetaAccountCorrelated'] +slug: /tools/sdk/powershell/beta/models/account-correlated +tags: ['SDK', 'Software Development Kit', 'AccountCorrelated', 'BetaAccountCorrelated'] +--- + + +# AccountCorrelated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**AccountCorrelatedIdentity**](account-correlated-identity) | | [required] +**Source** | [**AccountCorrelatedSource**](account-correlated-source) | | [required] +**Account** | [**AccountCorrelatedAccount**](account-correlated-account) | | [required] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes associated with the account. Attributes are unique per source. | [required] +**EntitlementCount** | Pointer to **Int32** | The number of entitlements associated with this account. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountCorrelated = Initialize-PSSailpoint.BetaAccountCorrelated -Identity null ` + -Source null ` + -Account null ` + -Attributes {sn=doe, givenName=john, memberOf=[cn=g1,ou=groups,dc=acme,dc=com, cn=g2,ou=groups,dc=acme,dc=com, cn=g3,ou=groups,dc=acme,dc=com]} ` + -EntitlementCount 0 +``` + +- Convert the resource to JSON +```powershell +$AccountCorrelated | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountCorrelatedAccount.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountCorrelatedAccount.md new file mode 100644 index 000000000..d39067e17 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountCorrelatedAccount.md @@ -0,0 +1,43 @@ +--- +id: beta-account-correlated-account +title: AccountCorrelatedAccount +pagination_label: AccountCorrelatedAccount +sidebar_label: AccountCorrelatedAccount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountCorrelatedAccount', 'BetaAccountCorrelatedAccount'] +slug: /tools/sdk/powershell/beta/models/account-correlated-account +tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedAccount', 'BetaAccountCorrelatedAccount'] +--- + + +# AccountCorrelatedAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "ACCOUNT" ] | The correlated account's DTO type. | [required] +**Id** | **String** | The correlated account's ID. | [required] +**Name** | **String** | The correlated account's display name. | [required] +**NativeIdentity** | **String** | Unique ID of the account on the source. | [required] +**Uuid** | Pointer to **String** | The source's unique identifier for the account. UUID is generated by the source system. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountCorrelatedAccount = Initialize-PSSailpoint.BetaAccountCorrelatedAccount -Type ACCOUNT ` + -Id 98da47c31df444558c211f9b205184f6 ` + -Name Brian Mendoza ` + -NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com ` + -Uuid 1cb1f07d-3e5a-4431-becd-234fa4306108 +``` + +- Convert the resource to JSON +```powershell +$AccountCorrelatedAccount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountCorrelatedIdentity.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountCorrelatedIdentity.md new file mode 100644 index 000000000..49712e6a3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountCorrelatedIdentity.md @@ -0,0 +1,39 @@ +--- +id: beta-account-correlated-identity +title: AccountCorrelatedIdentity +pagination_label: AccountCorrelatedIdentity +sidebar_label: AccountCorrelatedIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountCorrelatedIdentity', 'BetaAccountCorrelatedIdentity'] +slug: /tools/sdk/powershell/beta/models/account-correlated-identity +tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedIdentity', 'BetaAccountCorrelatedIdentity'] +--- + + +# AccountCorrelatedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | DTO type of the identity the account is correlated with. | [required] +**Id** | **String** | ID of the identity the account is correlated with. | [required] +**Name** | **String** | Display name of the identity the account is correlated with. | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountCorrelatedIdentity = Initialize-PSSailpoint.BetaAccountCorrelatedIdentity -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$AccountCorrelatedIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountCorrelatedSource.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountCorrelatedSource.md new file mode 100644 index 000000000..58b1072bc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountCorrelatedSource.md @@ -0,0 +1,39 @@ +--- +id: beta-account-correlated-source +title: AccountCorrelatedSource +pagination_label: AccountCorrelatedSource +sidebar_label: AccountCorrelatedSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountCorrelatedSource', 'BetaAccountCorrelatedSource'] +slug: /tools/sdk/powershell/beta/models/account-correlated-source +tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedSource', 'BetaAccountCorrelatedSource'] +--- + + +# AccountCorrelatedSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "SOURCE" ] | The DTO type of the source the accounts are being correlated from. | [required] +**Id** | **String** | The ID of the source the accounts are being correlated from. | [required] +**Name** | **String** | Display name of the source the accounts are being correlated from. | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountCorrelatedSource = Initialize-PSSailpoint.BetaAccountCorrelatedSource -Type SOURCE ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name HR Active Directory +``` + +- Convert the resource to JSON +```powershell +$AccountCorrelatedSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountInfoDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountInfoDto.md new file mode 100644 index 000000000..0300d448a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountInfoDto.md @@ -0,0 +1,39 @@ +--- +id: beta-account-info-dto +title: AccountInfoDto +pagination_label: AccountInfoDto +sidebar_label: AccountInfoDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountInfoDto', 'BetaAccountInfoDto'] +slug: /tools/sdk/powershell/beta/models/account-info-dto +tags: ['SDK', 'Software Development Kit', 'AccountInfoDto', 'BetaAccountInfoDto'] +--- + + +# AccountInfoDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NativeIdentity** | Pointer to **String** | The unique ID of the account generated by the source system | [optional] +**DisplayName** | Pointer to **String** | Display name for this account | [optional] +**Uuid** | Pointer to **String** | UUID associated with this account | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountInfoDto = Initialize-PSSailpoint.BetaAccountInfoDto -NativeIdentity CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` + -DisplayName Abby.Smith ` + -Uuid {ad9fc391-246d-40af-b248-b6556a2b7c01} +``` + +- Convert the resource to JSON +```powershell +$AccountInfoDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountRequestInfo.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountRequestInfo.md new file mode 100644 index 000000000..d990af622 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountRequestInfo.md @@ -0,0 +1,39 @@ +--- +id: beta-account-request-info +title: AccountRequestInfo +pagination_label: AccountRequestInfo +sidebar_label: AccountRequestInfo +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountRequestInfo', 'BetaAccountRequestInfo'] +slug: /tools/sdk/powershell/beta/models/account-request-info +tags: ['SDK', 'Software Development Kit', 'AccountRequestInfo', 'BetaAccountRequestInfo'] +--- + + +# AccountRequestInfo + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountRequestInfo = Initialize-PSSailpoint.BetaAccountRequestInfo -RequestedObjectId 2c91808563ef85690164001c31140c0c ` + -RequestedObjectName Treasury Analyst ` + -RequestedObjectType null +``` + +- Convert the resource to JSON +```powershell +$AccountRequestInfo | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountStatusChanged.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountStatusChanged.md new file mode 100644 index 000000000..742a173df --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountStatusChanged.md @@ -0,0 +1,43 @@ +--- +id: beta-account-status-changed +title: AccountStatusChanged +pagination_label: AccountStatusChanged +sidebar_label: AccountStatusChanged +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountStatusChanged', 'BetaAccountStatusChanged'] +slug: /tools/sdk/powershell/beta/models/account-status-changed +tags: ['SDK', 'Software Development Kit', 'AccountStatusChanged', 'BetaAccountStatusChanged'] +--- + + +# AccountStatusChanged + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EventType** | Pointer to **String** | the event type | [optional] +**IdentityId** | Pointer to **String** | the identity id | [optional] +**Dt** | Pointer to **String** | the date of event | [optional] +**Account** | Pointer to [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional] +**StatusChange** | Pointer to [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountStatusChanged = Initialize-PSSailpoint.BetaAccountStatusChanged -EventType null ` + -IdentityId null ` + -Dt null ` + -Account null ` + -StatusChange null +``` + +- Convert the resource to JSON +```powershell +$AccountStatusChanged | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountStatusChangedAccount.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountStatusChangedAccount.md new file mode 100644 index 000000000..70c623faa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountStatusChangedAccount.md @@ -0,0 +1,47 @@ +--- +id: beta-account-status-changed-account +title: AccountStatusChangedAccount +pagination_label: AccountStatusChangedAccount +sidebar_label: AccountStatusChangedAccount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountStatusChangedAccount', 'BetaAccountStatusChangedAccount'] +slug: /tools/sdk/powershell/beta/models/account-status-changed-account +tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedAccount', 'BetaAccountStatusChangedAccount'] +--- + + +# AccountStatusChangedAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | the ID of the account in the database | [optional] +**NativeIdentity** | Pointer to **String** | the native identifier of the account | [optional] +**DisplayName** | Pointer to **String** | the display name of the account | [optional] +**SourceId** | Pointer to **String** | the ID of the source for this account | [optional] +**SourceName** | Pointer to **String** | the name of the source for this account | [optional] +**EntitlementCount** | Pointer to **Int32** | the number of entitlements on this account | [optional] +**AccessType** | Pointer to **String** | this value is always ""account"" | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountStatusChangedAccount = Initialize-PSSailpoint.BetaAccountStatusChangedAccount -Id null ` + -NativeIdentity null ` + -DisplayName null ` + -SourceId null ` + -SourceName null ` + -EntitlementCount null ` + -AccessType null +``` + +- Convert the resource to JSON +```powershell +$AccountStatusChangedAccount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountStatusChangedStatusChange.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountStatusChangedStatusChange.md new file mode 100644 index 000000000..c700a33a0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountStatusChangedStatusChange.md @@ -0,0 +1,37 @@ +--- +id: beta-account-status-changed-status-change +title: AccountStatusChangedStatusChange +pagination_label: AccountStatusChangedStatusChange +sidebar_label: AccountStatusChangedStatusChange +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountStatusChangedStatusChange', 'BetaAccountStatusChangedStatusChange'] +slug: /tools/sdk/powershell/beta/models/account-status-changed-status-change +tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedStatusChange', 'BetaAccountStatusChangedStatusChange'] +--- + + +# AccountStatusChangedStatusChange + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PreviousStatus** | Pointer to **Enum** [ "enabled", "disabled", "locked" ] | the previous status of the account | [optional] +**NewStatus** | Pointer to **Enum** [ "enabled", "disabled", "locked" ] | the new status of the account | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountStatusChangedStatusChange = Initialize-PSSailpoint.BetaAccountStatusChangedStatusChange -PreviousStatus null ` + -NewStatus null +``` + +- Convert the resource to JSON +```powershell +$AccountStatusChangedStatusChange | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountToggleRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountToggleRequest.md new file mode 100644 index 000000000..cecb03382 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountToggleRequest.md @@ -0,0 +1,37 @@ +--- +id: beta-account-toggle-request +title: AccountToggleRequest +pagination_label: AccountToggleRequest +sidebar_label: AccountToggleRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountToggleRequest', 'BetaAccountToggleRequest'] +slug: /tools/sdk/powershell/beta/models/account-toggle-request +tags: ['SDK', 'Software Development Kit', 'AccountToggleRequest', 'BetaAccountToggleRequest'] +--- + + +# AccountToggleRequest + +## Properties + +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. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountToggleRequest = Initialize-PSSailpoint.BetaAccountToggleRequest -ExternalVerificationId 3f9180835d2e5168015d32f890ca1581 ` + -ForceProvisioning false +``` + +- Convert the resource to JSON +```powershell +$AccountToggleRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountUncorrelated.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountUncorrelated.md new file mode 100644 index 000000000..d64ba4943 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountUncorrelated.md @@ -0,0 +1,41 @@ +--- +id: beta-account-uncorrelated +title: AccountUncorrelated +pagination_label: AccountUncorrelated +sidebar_label: AccountUncorrelated +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUncorrelated', 'BetaAccountUncorrelated'] +slug: /tools/sdk/powershell/beta/models/account-uncorrelated +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelated', 'BetaAccountUncorrelated'] +--- + + +# AccountUncorrelated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**AccountUncorrelatedIdentity**](account-uncorrelated-identity) | | [required] +**Source** | [**AccountUncorrelatedSource**](account-uncorrelated-source) | | [required] +**Account** | [**AccountUncorrelatedAccount**](account-uncorrelated-account) | | [required] +**EntitlementCount** | Pointer to **Int32** | The number of entitlements associated with this account. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountUncorrelated = Initialize-PSSailpoint.BetaAccountUncorrelated -Identity null ` + -Source null ` + -Account null ` + -EntitlementCount 0 +``` + +- Convert the resource to JSON +```powershell +$AccountUncorrelated | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountUncorrelatedAccount.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountUncorrelatedAccount.md new file mode 100644 index 000000000..6a8e538de --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountUncorrelatedAccount.md @@ -0,0 +1,43 @@ +--- +id: beta-account-uncorrelated-account +title: AccountUncorrelatedAccount +pagination_label: AccountUncorrelatedAccount +sidebar_label: AccountUncorrelatedAccount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUncorrelatedAccount', 'BetaAccountUncorrelatedAccount'] +slug: /tools/sdk/powershell/beta/models/account-uncorrelated-account +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedAccount', 'BetaAccountUncorrelatedAccount'] +--- + + +# AccountUncorrelatedAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "ACCOUNT" ] | Uncorrelated account's DTO type. | [required] +**Id** | **String** | Uncorrelated account's ID. | [required] +**Name** | **String** | Uncorrelated account's display name. | [required] +**NativeIdentity** | **String** | Unique ID of the account on the source. | [required] +**Uuid** | Pointer to **String** | The source's unique identifier for the account. UUID is generated by the source system. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountUncorrelatedAccount = Initialize-PSSailpoint.BetaAccountUncorrelatedAccount -Type ACCOUNT ` + -Id 4dd497e3723e439991cb6d0e478375dd ` + -Name Sadie Jensen ` + -NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com ` + -Uuid 1cb1f07d-3e5a-4431-becd-234fa4306108 +``` + +- Convert the resource to JSON +```powershell +$AccountUncorrelatedAccount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountUncorrelatedIdentity.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountUncorrelatedIdentity.md new file mode 100644 index 000000000..535f5187d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountUncorrelatedIdentity.md @@ -0,0 +1,39 @@ +--- +id: beta-account-uncorrelated-identity +title: AccountUncorrelatedIdentity +pagination_label: AccountUncorrelatedIdentity +sidebar_label: AccountUncorrelatedIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUncorrelatedIdentity', 'BetaAccountUncorrelatedIdentity'] +slug: /tools/sdk/powershell/beta/models/account-uncorrelated-identity +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedIdentity', 'BetaAccountUncorrelatedIdentity'] +--- + + +# AccountUncorrelatedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | DTO type of the identity the account is uncorrelated with. | [required] +**Id** | **String** | ID of the identity the account is uncorrelated with. | [required] +**Name** | **String** | Display name of the identity the account is uncorrelated with. | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountUncorrelatedIdentity = Initialize-PSSailpoint.BetaAccountUncorrelatedIdentity -Type IDENTITY ` + -Id 2c3780a46faadee4016fb4e018c20652 ` + -Name Allen Albertson +``` + +- Convert the resource to JSON +```powershell +$AccountUncorrelatedIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountUncorrelatedSource.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountUncorrelatedSource.md new file mode 100644 index 000000000..372eceaca --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountUncorrelatedSource.md @@ -0,0 +1,39 @@ +--- +id: beta-account-uncorrelated-source +title: AccountUncorrelatedSource +pagination_label: AccountUncorrelatedSource +sidebar_label: AccountUncorrelatedSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUncorrelatedSource', 'BetaAccountUncorrelatedSource'] +slug: /tools/sdk/powershell/beta/models/account-uncorrelated-source +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedSource', 'BetaAccountUncorrelatedSource'] +--- + + +# AccountUncorrelatedSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "SOURCE" ] | The DTO type of the source the accounts are uncorrelated from. | [required] +**Id** | **String** | The ID of the source the accounts are uncorrelated from. | [required] +**Name** | **String** | Display name of the source the accounts are uncorrelated from. | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountUncorrelatedSource = Initialize-PSSailpoint.BetaAccountUncorrelatedSource -Type SOURCE ` + -Id 2c6180835d191a86015d28455b4b231b ` + -Name Corporate Directory +``` + +- Convert the resource to JSON +```powershell +$AccountUncorrelatedSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountUnlockRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountUnlockRequest.md new file mode 100644 index 000000000..3c749d175 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountUnlockRequest.md @@ -0,0 +1,39 @@ +--- +id: beta-account-unlock-request +title: AccountUnlockRequest +pagination_label: AccountUnlockRequest +sidebar_label: AccountUnlockRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUnlockRequest', 'BetaAccountUnlockRequest'] +slug: /tools/sdk/powershell/beta/models/account-unlock-request +tags: ['SDK', 'Software Development Kit', 'AccountUnlockRequest', 'BetaAccountUnlockRequest'] +--- + + +# AccountUnlockRequest + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountUnlockRequest = Initialize-PSSailpoint.BetaAccountUnlockRequest -ExternalVerificationId 3f9180835d2e5168015d32f890ca1581 ` + -UnlockIDNAccount false ` + -ForceProvisioning false +``` + +- Convert the resource to JSON +```powershell +$AccountUnlockRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountUsage.md new file mode 100644 index 000000000..48598478e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountUsage.md @@ -0,0 +1,37 @@ +--- +id: beta-account-usage +title: AccountUsage +pagination_label: AccountUsage +sidebar_label: AccountUsage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUsage', 'BetaAccountUsage'] +slug: /tools/sdk/powershell/beta/models/account-usage +tags: ['SDK', 'Software Development Kit', 'AccountUsage', 'BetaAccountUsage'] +--- + + +# AccountUsage + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` + -Count 10 +``` + +- Convert the resource to JSON +```powershell +$AccountUsage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountsAsyncResult.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountsAsyncResult.md new file mode 100644 index 000000000..dbd89faa1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountsAsyncResult.md @@ -0,0 +1,35 @@ +--- +id: beta-accounts-async-result +title: AccountsAsyncResult +pagination_label: AccountsAsyncResult +sidebar_label: AccountsAsyncResult +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsAsyncResult', 'BetaAccountsAsyncResult'] +slug: /tools/sdk/powershell/beta/models/accounts-async-result +tags: ['SDK', 'Software Development Kit', 'AccountsAsyncResult', 'BetaAccountsAsyncResult'] +--- + + +# AccountsAsyncResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | id of the task | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountsAsyncResult = Initialize-PSSailpoint.BetaAccountsAsyncResult -Id 2c91808474683da6017468693c260195 +``` + +- Convert the resource to JSON +```powershell +$AccountsAsyncResult | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountsCollectedForAggregation.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountsCollectedForAggregation.md new file mode 100644 index 000000000..8b374885e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountsCollectedForAggregation.md @@ -0,0 +1,47 @@ +--- +id: beta-accounts-collected-for-aggregation +title: AccountsCollectedForAggregation +pagination_label: AccountsCollectedForAggregation +sidebar_label: AccountsCollectedForAggregation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsCollectedForAggregation', 'BetaAccountsCollectedForAggregation'] +slug: /tools/sdk/powershell/beta/models/accounts-collected-for-aggregation +tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregation', 'BetaAccountsCollectedForAggregation'] +--- + + +# AccountsCollectedForAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | [**AccountsCollectedForAggregationSource**](accounts-collected-for-aggregation-source) | | [required] +**Status** | **Enum** [ "Success", "Failed", "Terminated" ] | The overall status of the collection. | [required] +**Started** | **System.DateTime** | The date and time when the account collection started. | [required] +**Completed** | **System.DateTime** | The date and time when the account collection finished. | [required] +**Errors** | **[]String** | A list of errors that occurred during the collection. | [required] +**Warnings** | **[]String** | A list of warnings that occurred during the collection. | [required] +**Stats** | [**AccountsCollectedForAggregationStats**](accounts-collected-for-aggregation-stats) | | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountsCollectedForAggregation = Initialize-PSSailpoint.BetaAccountsCollectedForAggregation -Source null ` + -Status Success ` + -Started 2020-06-29T22:01:50.474Z ` + -Completed 2020-06-29T22:02:04.090Z ` + -Errors null ` + -Warnings null ` + -Stats null +``` + +- Convert the resource to JSON +```powershell +$AccountsCollectedForAggregation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountsCollectedForAggregationSource.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountsCollectedForAggregationSource.md new file mode 100644 index 000000000..447ebc319 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountsCollectedForAggregationSource.md @@ -0,0 +1,39 @@ +--- +id: beta-accounts-collected-for-aggregation-source +title: AccountsCollectedForAggregationSource +pagination_label: AccountsCollectedForAggregationSource +sidebar_label: AccountsCollectedForAggregationSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsCollectedForAggregationSource', 'BetaAccountsCollectedForAggregationSource'] +slug: /tools/sdk/powershell/beta/models/accounts-collected-for-aggregation-source +tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregationSource', 'BetaAccountsCollectedForAggregationSource'] +--- + + +# AccountsCollectedForAggregationSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | ID of the object to which this reference applies | [required] +**Type** | **Enum** [ "SOURCE" ] | The type of object that is referenced | [required] +**Name** | **String** | Human-readable display name of the object to which this reference applies | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountsCollectedForAggregationSource = Initialize-PSSailpoint.BetaAccountsCollectedForAggregationSource -Id 4e4d982dddff4267ab12f0f1e72b5a6d ` + -Type SOURCE ` + -Name Corporate Active Directory +``` + +- Convert the resource to JSON +```powershell +$AccountsCollectedForAggregationSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountsCollectedForAggregationStats.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountsCollectedForAggregationStats.md new file mode 100644 index 000000000..5efb5d608 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AccountsCollectedForAggregationStats.md @@ -0,0 +1,43 @@ +--- +id: beta-accounts-collected-for-aggregation-stats +title: AccountsCollectedForAggregationStats +pagination_label: AccountsCollectedForAggregationStats +sidebar_label: AccountsCollectedForAggregationStats +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsCollectedForAggregationStats', 'BetaAccountsCollectedForAggregationStats'] +slug: /tools/sdk/powershell/beta/models/accounts-collected-for-aggregation-stats +tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregationStats', 'BetaAccountsCollectedForAggregationStats'] +--- + + +# AccountsCollectedForAggregationStats + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Scanned** | **Int32** | The number of accounts which were scanned / iterated over. | [required] +**Unchanged** | **Int32** | The number of accounts which existed before, but had no changes. | [required] +**Changed** | **Int32** | The number of accounts which existed before, but had changes. | [required] +**Added** | **Int32** | The number of accounts which are new - have not existed before. | [required] +**Removed** | **Int32** | The number accounts which existed before, but no longer exist (thus getting removed). | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountsCollectedForAggregationStats = Initialize-PSSailpoint.BetaAccountsCollectedForAggregationStats -Scanned 200 ` + -Unchanged 190 ` + -Changed 6 ` + -Added 4 ` + -Removed 3 +``` + +- Convert the resource to JSON +```powershell +$AccountsCollectedForAggregationStats | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ActivateCampaignOptions.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ActivateCampaignOptions.md new file mode 100644 index 000000000..d7f448799 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ActivateCampaignOptions.md @@ -0,0 +1,35 @@ +--- +id: beta-activate-campaign-options +title: ActivateCampaignOptions +pagination_label: ActivateCampaignOptions +sidebar_label: ActivateCampaignOptions +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ActivateCampaignOptions', 'BetaActivateCampaignOptions'] +slug: /tools/sdk/powershell/beta/models/activate-campaign-options +tags: ['SDK', 'Software Development Kit', 'ActivateCampaignOptions', 'BetaActivateCampaignOptions'] +--- + + +# ActivateCampaignOptions + +## Properties + +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"] + +## Examples + +- Prepare the resource +```powershell +$ActivateCampaignOptions = Initialize-PSSailpoint.BetaActivateCampaignOptions -TimeZone -05:00 +``` + +- Convert the resource to JSON +```powershell +$ActivateCampaignOptions | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AdminReviewReassign.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AdminReviewReassign.md new file mode 100644 index 000000000..11da38632 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AdminReviewReassign.md @@ -0,0 +1,39 @@ +--- +id: beta-admin-review-reassign +title: AdminReviewReassign +pagination_label: AdminReviewReassign +sidebar_label: AdminReviewReassign +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AdminReviewReassign', 'BetaAdminReviewReassign'] +slug: /tools/sdk/powershell/beta/models/admin-review-reassign +tags: ['SDK', 'Software Development Kit', 'AdminReviewReassign', 'BetaAdminReviewReassign'] +--- + + +# AdminReviewReassign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CertificationIds** | Pointer to **[]String** | List of certification IDs to reassign | [optional] +**ReassignTo** | Pointer to [**AdminReviewReassignReassignTo**](admin-review-reassign-reassign-to) | | [optional] +**Reason** | Pointer to **String** | Comment to explain why the certification was reassigned | [optional] + +## Examples + +- Prepare the resource +```powershell +$AdminReviewReassign = Initialize-PSSailpoint.BetaAdminReviewReassign -CertificationIds [af3859464779471211bb8424a563abc1, af3859464779471211bb8424a563abc2, af3859464779471211bb8424a563abc3] ` + -ReassignTo null ` + -Reason reassigned for some reason +``` + +- Convert the resource to JSON +```powershell +$AdminReviewReassign | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AdminReviewReassignReassignTo.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AdminReviewReassignReassignTo.md new file mode 100644 index 000000000..fe938f093 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AdminReviewReassignReassignTo.md @@ -0,0 +1,37 @@ +--- +id: beta-admin-review-reassign-reassign-to +title: AdminReviewReassignReassignTo +pagination_label: AdminReviewReassignReassignTo +sidebar_label: AdminReviewReassignReassignTo +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AdminReviewReassignReassignTo', 'BetaAdminReviewReassignReassignTo'] +slug: /tools/sdk/powershell/beta/models/admin-review-reassign-reassign-to +tags: ['SDK', 'Software Development Kit', 'AdminReviewReassignReassignTo', 'BetaAdminReviewReassignReassignTo'] +--- + + +# AdminReviewReassignReassignTo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The identity ID to which the review is being assigned. | [optional] +**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of the ID provided. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AdminReviewReassignReassignTo = Initialize-PSSailpoint.BetaAdminReviewReassignReassignTo -Id ef38f94347e94562b5bb8424a56397d8 ` + -Type IDENTITY +``` + +- Convert the resource to JSON +```powershell +$AdminReviewReassignReassignTo | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AppAccountDetails.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AppAccountDetails.md new file mode 100644 index 000000000..8430edc73 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AppAccountDetails.md @@ -0,0 +1,39 @@ +--- +id: beta-app-account-details +title: AppAccountDetails +pagination_label: AppAccountDetails +sidebar_label: AppAccountDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AppAccountDetails', 'BetaAppAccountDetails'] +slug: /tools/sdk/powershell/beta/models/app-account-details +tags: ['SDK', 'Software Development Kit', 'AppAccountDetails', 'BetaAppAccountDetails'] +--- + + +# AppAccountDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AppId** | Pointer to **String** | The source app ID | [optional] +**AppDisplayName** | Pointer to **String** | The source app display name | [optional] +**SourceAccount** | Pointer to [**AppAccountDetailsSourceAccount**](app-account-details-source-account) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AppAccountDetails = Initialize-PSSailpoint.BetaAppAccountDetails -AppId fbf4f72280304f1a8bc808fc2a3bcf7b ` + -AppDisplayName AD source app ` + -SourceAccount null +``` + +- Convert the resource to JSON +```powershell +$AppAccountDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AppAccountDetailsSourceAccount.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AppAccountDetailsSourceAccount.md new file mode 100644 index 000000000..12b944185 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AppAccountDetailsSourceAccount.md @@ -0,0 +1,43 @@ +--- +id: beta-app-account-details-source-account +title: AppAccountDetailsSourceAccount +pagination_label: AppAccountDetailsSourceAccount +sidebar_label: AppAccountDetailsSourceAccount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AppAccountDetailsSourceAccount', 'BetaAppAccountDetailsSourceAccount'] +slug: /tools/sdk/powershell/beta/models/app-account-details-source-account +tags: ['SDK', 'Software Development Kit', 'AppAccountDetailsSourceAccount', 'BetaAppAccountDetailsSourceAccount'] +--- + + +# AppAccountDetailsSourceAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The account ID | [optional] +**NativeIdentity** | Pointer to **String** | The native identity of account | [optional] +**DisplayName** | Pointer to **String** | The display name of account | [optional] +**SourceId** | Pointer to **String** | The source ID of account | [optional] +**SourceDisplayName** | Pointer to **String** | The source name of account | [optional] + +## Examples + +- Prepare the resource +```powershell +$AppAccountDetailsSourceAccount = Initialize-PSSailpoint.BetaAppAccountDetailsSourceAccount -Id fbf4f72280304f1a8bc808fc2a3bcf7b ` + -NativeIdentity CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` + -DisplayName Abby Smith ` + -SourceId 10efa58ea3954883b52bf74f489ce8f9 ` + -SourceDisplayName ODS-AD-SOURCE +``` + +- Convert the resource to JSON +```powershell +$AppAccountDetailsSourceAccount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Approval.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Approval.md new file mode 100644 index 000000000..e58803923 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Approval.md @@ -0,0 +1,67 @@ +--- +id: beta-approval +title: Approval +pagination_label: Approval +sidebar_label: Approval +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Approval', 'BetaApproval'] +slug: /tools/sdk/powershell/beta/models/approval +tags: ['SDK', 'Software Development Kit', 'Approval', 'BetaApproval'] +--- + + +# Approval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalId** | Pointer to **String** | The Approval ID | [optional] +**Approvers** | Pointer to [**[]ApprovalIdentity**](approval-identity) | Object representation of an approver of an approval | [optional] +**CreatedDate** | Pointer to **String** | Date the approval was created | [optional] +**Type** | Pointer to **String** | Type of approval | [optional] +**Name** | Pointer to [**[]ApprovalName**](approval-name) | The name of the approval for a given locale | [optional] +**BatchRequest** | Pointer to [**ApprovalBatch**](approval-batch) | The name of the approval for a given locale | [optional] +**Description** | Pointer to [**[]ApprovalDescription**](approval-description) | The description of the approval for a given locale | [optional] +**Priority** | Pointer to **Enum** [ "HIGH", "MEDIUM", "LOW" ] | The priority of the approval | [optional] +**Requester** | Pointer to [**ApprovalIdentity**](approval-identity) | Object representation of the requester of the approval | [optional] +**Comments** | Pointer to [**[]ApprovalComment**](approval-comment) | Object representation of a comment on the approval | [optional] +**ApprovedBy** | Pointer to [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have approved the approval | [optional] +**RejectedBy** | Pointer to [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have rejected the approval | [optional] +**CompletedDate** | Pointer to **String** | Date the approval was completed | [optional] +**ApprovalCriteria** | Pointer to **Enum** [ "SINGLE", "DOUBLE", "TRIPLE", "QUARTER", "HALF", "ALL" ] | Criteria that needs to be met for an approval to be marked as approved | [optional] +**Status** | Pointer to **Enum** [ "PENDING", "APPROVED", "REJECTED" ] | The current status of the approval | [optional] +**AdditionalAttributes** | Pointer to **String** | Json string representing additional attributes known about the object to be approved. | [optional] +**ReferenceData** | Pointer to [**[]ApprovalReference**](approval-reference) | Reference data related to the approval | [optional] + +## Examples + +- Prepare the resource +```powershell +$Approval = Initialize-PSSailpoint.BetaApproval -ApprovalId 38453251-6be2-5f8f-df93-5ce19e295837 ` + -Approvers null ` + -CreatedDate 2023-04-12T23:20:50.52Z ` + -Type ENTITLEMENT_DESCRIPTIONS ` + -Name null ` + -BatchRequest {batchId=38453251-6be2-5f8f-df93-5ce19e295837, batchSize=100} ` + -Description null ` + -Priority HIGH ` + -Requester {id=85d173e7d57e496569df763231d6deb6a, type=IDENTITY, name=John Doe} ` + -Comments null ` + -ApprovedBy null ` + -RejectedBy null ` + -CompletedDate 2023-04-12T23:20:50.52Z ` + -ApprovalCriteria SINGLE ` + -Status PENDING ` + -AdditionalAttributes { "llm_description": "generated description" } ` + -ReferenceData null +``` + +- Convert the resource to JSON +```powershell +$Approval | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalBatch.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalBatch.md new file mode 100644 index 000000000..c8f846d70 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalBatch.md @@ -0,0 +1,37 @@ +--- +id: beta-approval-batch +title: ApprovalBatch +pagination_label: ApprovalBatch +sidebar_label: ApprovalBatch +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalBatch', 'BetaApprovalBatch'] +slug: /tools/sdk/powershell/beta/models/approval-batch +tags: ['SDK', 'Software Development Kit', 'ApprovalBatch', 'BetaApprovalBatch'] +--- + + +# ApprovalBatch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchId** | Pointer to **String** | ID of the batch | [optional] +**BatchSize** | Pointer to **Int64** | How many approvals are going to be in this batch. Defaults to 1 if not provided. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalBatch = Initialize-PSSailpoint.BetaApprovalBatch -BatchId 38453251-6be2-5f8f-df93-5ce19e295837 ` + -BatchSize 100 +``` + +- Convert the resource to JSON +```powershell +$ApprovalBatch | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalComment.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalComment.md new file mode 100644 index 000000000..052897d8d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalComment.md @@ -0,0 +1,39 @@ +--- +id: beta-approval-comment +title: ApprovalComment +pagination_label: ApprovalComment +sidebar_label: ApprovalComment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalComment', 'BetaApprovalComment'] +slug: /tools/sdk/powershell/beta/models/approval-comment +tags: ['SDK', 'Software Development Kit', 'ApprovalComment', 'BetaApprovalComment'] +--- + + +# ApprovalComment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Author** | Pointer to [**ApprovalIdentity**](approval-identity) | | [optional] +**Comment** | Pointer to **String** | Comment to be left on an approval | [optional] +**CreatedDate** | Pointer to **String** | Date the comment was created | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalComment = Initialize-PSSailpoint.BetaApprovalComment -Author null ` + -Comment Looks good ` + -CreatedDate 2023-04-12T23:20:50.52Z +``` + +- Convert the resource to JSON +```powershell +$ApprovalComment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalDescription.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalDescription.md new file mode 100644 index 000000000..74ae3474f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalDescription.md @@ -0,0 +1,37 @@ +--- +id: beta-approval-description +title: ApprovalDescription +pagination_label: ApprovalDescription +sidebar_label: ApprovalDescription +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalDescription', 'BetaApprovalDescription'] +slug: /tools/sdk/powershell/beta/models/approval-description +tags: ['SDK', 'Software Development Kit', 'ApprovalDescription', 'BetaApprovalDescription'] +--- + + +# ApprovalDescription + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **String** | The description of what the approval is asking for | [optional] +**Locale** | Pointer to **String** | What locale the description of the approval is using | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalDescription = Initialize-PSSailpoint.BetaApprovalDescription -Value This access allows viewing and editing of workflow resource ` + -Locale en_US +``` + +- Convert the resource to JSON +```powershell +$ApprovalDescription | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalForwardHistory.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalForwardHistory.md new file mode 100644 index 000000000..7a87691f1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalForwardHistory.md @@ -0,0 +1,45 @@ +--- +id: beta-approval-forward-history +title: ApprovalForwardHistory +pagination_label: ApprovalForwardHistory +sidebar_label: ApprovalForwardHistory +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalForwardHistory', 'BetaApprovalForwardHistory'] +slug: /tools/sdk/powershell/beta/models/approval-forward-history +tags: ['SDK', 'Software Development Kit', 'ApprovalForwardHistory', 'BetaApprovalForwardHistory'] +--- + + +# ApprovalForwardHistory + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OldApproverName** | Pointer to **String** | Display name of approver from whom the approval was forwarded. | [optional] +**NewApproverName** | Pointer to **String** | Display name of approver to whom the approval was forwarded. | [optional] +**Comment** | Pointer to **String** | Comment made while forwarding. | [optional] +**Modified** | Pointer to **System.DateTime** | Time at which approval was forwarded. | [optional] +**ForwarderName** | Pointer to **String** | Display name of forwarder who forwarded the approval. | [optional] +**ReassignmentType** | Pointer to [**ReassignmentType**](reassignment-type) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalForwardHistory = Initialize-PSSailpoint.BetaApprovalForwardHistory -OldApproverName Frank Mir ` + -NewApproverName Al Volta ` + -Comment Forwarding from Frank to Al ` + -Modified 2019-08-23T18:52:57.398Z ` + -ForwarderName William Wilson ` + -ReassignmentType null +``` + +- Convert the resource to JSON +```powershell +$ApprovalForwardHistory | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalIdentity.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalIdentity.md new file mode 100644 index 000000000..0b532fda8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalIdentity.md @@ -0,0 +1,39 @@ +--- +id: beta-approval-identity +title: ApprovalIdentity +pagination_label: ApprovalIdentity +sidebar_label: ApprovalIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalIdentity', 'BetaApprovalIdentity'] +slug: /tools/sdk/powershell/beta/models/approval-identity +tags: ['SDK', 'Software Development Kit', 'ApprovalIdentity', 'BetaApprovalIdentity'] +--- + + +# ApprovalIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The identity ID | [optional] +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Indication of what group the identity belongs to. Ie, IDENTITY, GOVERNANCE_GROUP, etc | [optional] +**Name** | Pointer to **String** | Name of the identity | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalIdentity = Initialize-PSSailpoint.BetaApprovalIdentity -Id 85d173e7d57e496569df763231d6deb6a ` + -Type IDENTITY ` + -Name John Doe +``` + +- Convert the resource to JSON +```powershell +$ApprovalIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalInfoResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalInfoResponse.md new file mode 100644 index 000000000..f46d95a6c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalInfoResponse.md @@ -0,0 +1,39 @@ +--- +id: beta-approval-info-response +title: ApprovalInfoResponse +pagination_label: ApprovalInfoResponse +sidebar_label: ApprovalInfoResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalInfoResponse', 'BetaApprovalInfoResponse'] +slug: /tools/sdk/powershell/beta/models/approval-info-response +tags: ['SDK', 'Software Development Kit', 'ApprovalInfoResponse', 'BetaApprovalInfoResponse'] +--- + + +# ApprovalInfoResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | the id of approver | [optional] +**Name** | Pointer to **String** | the name of approver | [optional] +**Status** | Pointer to **String** | the status of the approval request | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalInfoResponse = Initialize-PSSailpoint.BetaApprovalInfoResponse -Id 8a80828f643d484f01643e14202e2000 ` + -Name John Snow ` + -Status Approved +``` + +- Convert the resource to JSON +```powershell +$ApprovalInfoResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalItemDetails.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalItemDetails.md new file mode 100644 index 000000000..5ca923871 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalItemDetails.md @@ -0,0 +1,47 @@ +--- +id: beta-approval-item-details +title: ApprovalItemDetails +pagination_label: ApprovalItemDetails +sidebar_label: ApprovalItemDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalItemDetails', 'BetaApprovalItemDetails'] +slug: /tools/sdk/powershell/beta/models/approval-item-details +tags: ['SDK', 'Software Development Kit', 'ApprovalItemDetails', 'BetaApprovalItemDetails'] +--- + + +# ApprovalItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The approval item's ID | [optional] +**Account** | Pointer to **String** | The account referenced by the approval item | [optional] +**Application** | Pointer to **String** | The name of the application/source | [optional] +**Name** | Pointer to **String** | The attribute's name | [optional] +**Operation** | Pointer to **String** | The attribute's operation | [optional] +**Value** | Pointer to **String** | The attribute's value | [optional] +**State** | Pointer to [**WorkItemState**](work-item-state) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalItemDetails = Initialize-PSSailpoint.BetaApprovalItemDetails -Id 2c9180835d2e5168015d32f890ca1581 ` + -Account john.smith ` + -Application Active Directory ` + -Name emailAddress ` + -Operation update ` + -Value a@b.com ` + -State null +``` + +- Convert the resource to JSON +```powershell +$ApprovalItemDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalItems.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalItems.md new file mode 100644 index 000000000..82630355e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalItems.md @@ -0,0 +1,47 @@ +--- +id: beta-approval-items +title: ApprovalItems +pagination_label: ApprovalItems +sidebar_label: ApprovalItems +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalItems', 'BetaApprovalItems'] +slug: /tools/sdk/powershell/beta/models/approval-items +tags: ['SDK', 'Software Development Kit', 'ApprovalItems', 'BetaApprovalItems'] +--- + + +# ApprovalItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The approval item's ID | [optional] +**Account** | Pointer to **String** | The account referenced by the approval item | [optional] +**Application** | Pointer to **String** | The name of the application/source | [optional] +**Name** | Pointer to **String** | The attribute's name | [optional] +**Operation** | Pointer to **String** | The attribute's operation | [optional] +**Value** | Pointer to **String** | The attribute's value | [optional] +**State** | Pointer to [**WorkItemState**](work-item-state) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalItems = Initialize-PSSailpoint.BetaApprovalItems -Id 2c9180835d2e5168015d32f890ca1581 ` + -Account john.smith ` + -Application Active Directory ` + -Name emailAddress ` + -Operation update ` + -Value a@b.com ` + -State null +``` + +- Convert the resource to JSON +```powershell +$ApprovalItems | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalName.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalName.md new file mode 100644 index 000000000..cf322278e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalName.md @@ -0,0 +1,37 @@ +--- +id: beta-approval-name +title: ApprovalName +pagination_label: ApprovalName +sidebar_label: ApprovalName +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalName', 'BetaApprovalName'] +slug: /tools/sdk/powershell/beta/models/approval-name +tags: ['SDK', 'Software Development Kit', 'ApprovalName', 'BetaApprovalName'] +--- + + +# ApprovalName + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **String** | Name of the approval | [optional] +**Locale** | Pointer to **String** | What locale the name of the approval is using | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalName = Initialize-PSSailpoint.BetaApprovalName -Value Audit DB Access ` + -Locale en_US +``` + +- Convert the resource to JSON +```powershell +$ApprovalName | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalReference.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalReference.md new file mode 100644 index 000000000..38af6bf91 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalReference.md @@ -0,0 +1,37 @@ +--- +id: beta-approval-reference +title: ApprovalReference +pagination_label: ApprovalReference +sidebar_label: ApprovalReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalReference', 'BetaApprovalReference'] +slug: /tools/sdk/powershell/beta/models/approval-reference +tags: ['SDK', 'Software Development Kit', 'ApprovalReference', 'BetaApprovalReference'] +--- + + +# ApprovalReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the reference object | [optional] +**Type** | Pointer to **String** | What reference object does this ID correspond to | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalReference = Initialize-PSSailpoint.BetaApprovalReference -Id 64012350-8fd9-4f6c-a170-1fe123683899 ` + -Type AccessRequestId +``` + +- Convert the resource to JSON +```powershell +$ApprovalReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalReminderAndEscalationConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalReminderAndEscalationConfig.md new file mode 100644 index 000000000..79b9fc38f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalReminderAndEscalationConfig.md @@ -0,0 +1,41 @@ +--- +id: beta-approval-reminder-and-escalation-config +title: ApprovalReminderAndEscalationConfig +pagination_label: ApprovalReminderAndEscalationConfig +sidebar_label: ApprovalReminderAndEscalationConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalReminderAndEscalationConfig', 'BetaApprovalReminderAndEscalationConfig'] +slug: /tools/sdk/powershell/beta/models/approval-reminder-and-escalation-config +tags: ['SDK', 'Software Development Kit', 'ApprovalReminderAndEscalationConfig', 'BetaApprovalReminderAndEscalationConfig'] +--- + + +# ApprovalReminderAndEscalationConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DaysUntilEscalation** | Pointer to **Int32** | Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation. | [optional] +**DaysBetweenReminders** | Pointer to **Int32** | Number of days to wait between reminder notifications. | [optional] +**MaxReminders** | Pointer to **Int32** | Maximum number of reminder notification to send to the reviewer before approval escalation. | [optional] +**FallbackApproverRef** | Pointer to [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalReminderAndEscalationConfig = Initialize-PSSailpoint.BetaApprovalReminderAndEscalationConfig -DaysUntilEscalation 0 ` + -DaysBetweenReminders 0 ` + -MaxReminders 1 ` + -FallbackApproverRef null +``` + +- Convert the resource to JSON +```powershell +$ApprovalReminderAndEscalationConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalScheme.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalScheme.md new file mode 100644 index 000000000..2e782eeb0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalScheme.md @@ -0,0 +1,34 @@ +--- +id: beta-approval-scheme +title: ApprovalScheme +pagination_label: ApprovalScheme +sidebar_label: ApprovalScheme +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalScheme', 'BetaApprovalScheme'] +slug: /tools/sdk/powershell/beta/models/approval-scheme +tags: ['SDK', 'Software Development Kit', 'ApprovalScheme', 'BetaApprovalScheme'] +--- + + +# ApprovalScheme + +## Enum + + +* `APP_OWNER` (value: `"APP_OWNER"`) + +* `SOURCE_OWNER` (value: `"SOURCE_OWNER"`) + +* `MANAGER` (value: `"MANAGER"`) + +* `ROLE_OWNER` (value: `"ROLE_OWNER"`) + +* `ACCESS_PROFILE_OWNER` (value: `"ACCESS_PROFILE_OWNER"`) + +* `ENTITLEMENT_OWNER` (value: `"ENTITLEMENT_OWNER"`) + +* `GOVERNANCE_GROUP` (value: `"GOVERNANCE_GROUP"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalSchemeForRole.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalSchemeForRole.md new file mode 100644 index 000000000..87d77184a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalSchemeForRole.md @@ -0,0 +1,37 @@ +--- +id: beta-approval-scheme-for-role +title: ApprovalSchemeForRole +pagination_label: ApprovalSchemeForRole +sidebar_label: ApprovalSchemeForRole +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalSchemeForRole', 'BetaApprovalSchemeForRole'] +slug: /tools/sdk/powershell/beta/models/approval-scheme-for-role +tags: ['SDK', 'Software Development Kit', 'ApprovalSchemeForRole', 'BetaApprovalSchemeForRole'] +--- + + +# ApprovalSchemeForRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApproverType** | Pointer to **Enum** [ "OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **OWNER**: Owner of the associated Role **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] + +## Examples + +- Prepare the resource +```powershell +$ApprovalSchemeForRole = Initialize-PSSailpoint.BetaApprovalSchemeForRole -ApproverType GOVERNANCE_GROUP ` + -ApproverId 46c79819-a69f-49a2-becb-12c971ae66c6 +``` + +- Convert the resource to JSON +```powershell +$ApprovalSchemeForRole | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalStatus.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalStatus.md new file mode 100644 index 000000000..6412a403e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalStatus.md @@ -0,0 +1,30 @@ +--- +id: beta-approval-status +title: ApprovalStatus +pagination_label: ApprovalStatus +sidebar_label: ApprovalStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalStatus', 'BetaApprovalStatus'] +slug: /tools/sdk/powershell/beta/models/approval-status +tags: ['SDK', 'Software Development Kit', 'ApprovalStatus', 'BetaApprovalStatus'] +--- + + +# ApprovalStatus + +## Enum + + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `PENDING` (value: `"PENDING"`) + +* `NOT_READY` (value: `"NOT_READY"`) + +* `CANCELLED` (value: `"CANCELLED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalStatusDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalStatusDto.md new file mode 100644 index 000000000..002d80bc6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalStatusDto.md @@ -0,0 +1,53 @@ +--- +id: beta-approval-status-dto +title: ApprovalStatusDto +pagination_label: ApprovalStatusDto +sidebar_label: ApprovalStatusDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalStatusDto', 'BetaApprovalStatusDto'] +slug: /tools/sdk/powershell/beta/models/approval-status-dto +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDto', 'BetaApprovalStatusDto'] +--- + + +# ApprovalStatusDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalId** | Pointer to **String** | Unique identifier for the approval. | [optional] +**Forwarded** | Pointer to **Boolean** | True if the request for this item was forwarded from one owner to another. | [optional] [default to $false] +**OriginalOwner** | Pointer to [**ApprovalStatusDtoOriginalOwner**](approval-status-dto-original-owner) | | [optional] +**CurrentOwner** | Pointer to [**ApprovalStatusDtoCurrentOwner**](approval-status-dto-current-owner) | | [optional] +**Modified** | Pointer to **System.DateTime** | Time at which item was modified. | [optional] +**Status** | Pointer to [**ManualWorkItemState**](manual-work-item-state) | | [optional] +**Scheme** | Pointer to [**ApprovalScheme**](approval-scheme) | | [optional] +**ErrorMessages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | If the request failed, includes any error messages that were generated. | [optional] +**Comment** | Pointer to **String** | Comment, if any, provided by the approver. | [optional] +**RemoveDate** | Pointer to **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalStatusDto = Initialize-PSSailpoint.BetaApprovalStatusDto -ApprovalId 2c9180877b2b6ea4017b2c545f971429 ` + -Forwarded false ` + -OriginalOwner null ` + -CurrentOwner null ` + -Modified 2019-08-23T18:52:57.398Z ` + -Status null ` + -Scheme null ` + -ErrorMessages null ` + -Comment I approve this request ` + -RemoveDate 2020-07-11T00:00Z +``` + +- Convert the resource to JSON +```powershell +$ApprovalStatusDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalStatusDtoCurrentOwner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalStatusDtoCurrentOwner.md new file mode 100644 index 000000000..10466dbf1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalStatusDtoCurrentOwner.md @@ -0,0 +1,39 @@ +--- +id: beta-approval-status-dto-current-owner +title: ApprovalStatusDtoCurrentOwner +pagination_label: ApprovalStatusDtoCurrentOwner +sidebar_label: ApprovalStatusDtoCurrentOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalStatusDtoCurrentOwner', 'BetaApprovalStatusDtoCurrentOwner'] +slug: /tools/sdk/powershell/beta/models/approval-status-dto-current-owner +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoCurrentOwner', 'BetaApprovalStatusDtoCurrentOwner'] +--- + + +# ApprovalStatusDtoCurrentOwner + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$ApprovalStatusDtoCurrentOwner = Initialize-PSSailpoint.BetaApprovalStatusDtoCurrentOwner -Type IDENTITY ` + -Id 2c3780a46faadee4016fb4e018c20652 ` + -Name Allen Albertson +``` + +- Convert the resource to JSON +```powershell +$ApprovalStatusDtoCurrentOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalStatusDtoOriginalOwner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalStatusDtoOriginalOwner.md new file mode 100644 index 000000000..6245c4f8f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalStatusDtoOriginalOwner.md @@ -0,0 +1,39 @@ +--- +id: beta-approval-status-dto-original-owner +title: ApprovalStatusDtoOriginalOwner +pagination_label: ApprovalStatusDtoOriginalOwner +sidebar_label: ApprovalStatusDtoOriginalOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalStatusDtoOriginalOwner', 'BetaApprovalStatusDtoOriginalOwner'] +slug: /tools/sdk/powershell/beta/models/approval-status-dto-original-owner +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoOriginalOwner', 'BetaApprovalStatusDtoOriginalOwner'] +--- + + +# ApprovalStatusDtoOriginalOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP", "IDENTITY" ] | DTO type of original approval owner's identity. | [optional] +**Id** | Pointer to **String** | ID of original approval owner's identity. | [optional] +**Name** | Pointer to **String** | Display name of original approval owner. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalStatusDtoOriginalOwner = Initialize-PSSailpoint.BetaApprovalStatusDtoOriginalOwner -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$ApprovalStatusDtoOriginalOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalSummary.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalSummary.md new file mode 100644 index 000000000..61110c481 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ApprovalSummary.md @@ -0,0 +1,39 @@ +--- +id: beta-approval-summary +title: ApprovalSummary +pagination_label: ApprovalSummary +sidebar_label: ApprovalSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalSummary', 'BetaApprovalSummary'] +slug: /tools/sdk/powershell/beta/models/approval-summary +tags: ['SDK', 'Software Development Kit', 'ApprovalSummary', 'BetaApprovalSummary'] +--- + + +# ApprovalSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Pending** | Pointer to **Int32** | The number of pending access requests approvals. | [optional] +**Approved** | Pointer to **Int32** | The number of approved access requests approvals. | [optional] +**Rejected** | Pointer to **Int32** | The number of rejected access requests approvals. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalSummary = Initialize-PSSailpoint.BetaApprovalSummary -Pending null ` + -Approved null ` + -Rejected null +``` + +- Convert the resource to JSON +```powershell +$ApprovalSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Argument.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Argument.md new file mode 100644 index 000000000..197d3cb01 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Argument.md @@ -0,0 +1,39 @@ +--- +id: beta-argument +title: Argument +pagination_label: Argument +sidebar_label: Argument +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Argument', 'BetaArgument'] +slug: /tools/sdk/powershell/beta/models/argument +tags: ['SDK', 'Software Development Kit', 'Argument', 'BetaArgument'] +--- + + +# Argument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | the name of the argument | [required] +**Description** | Pointer to **String** | the description of the argument | [optional] +**Type** | Pointer to **String** | the programmatic type of the argument | [optional] + +## Examples + +- Prepare the resource +```powershell +$Argument = Initialize-PSSailpoint.BetaArgument -Name firstName ` + -Description the first name of the identity ` + -Type String +``` + +- Convert the resource to JSON +```powershell +$Argument | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ArrayInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ArrayInner.md new file mode 100644 index 000000000..ca347db45 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ArrayInner.md @@ -0,0 +1,34 @@ +--- +id: beta-array-inner +title: ArrayInner +pagination_label: ArrayInner +sidebar_label: ArrayInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ArrayInner', 'BetaArrayInner'] +slug: /tools/sdk/powershell/beta/models/array-inner +tags: ['SDK', 'Software Development Kit', 'ArrayInner', 'BetaArrayInner'] +--- + + +# ArrayInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$ArrayInner = Initialize-PSSailpoint.BetaArrayInner +``` + +- Convert the resource to JSON +```powershell +$ArrayInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ArrayInner1.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ArrayInner1.md new file mode 100644 index 000000000..c4bd08f86 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ArrayInner1.md @@ -0,0 +1,34 @@ +--- +id: beta-array-inner1 +title: ArrayInner1 +pagination_label: ArrayInner1 +sidebar_label: ArrayInner1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ArrayInner1', 'BetaArrayInner1'] +slug: /tools/sdk/powershell/beta/models/array-inner1 +tags: ['SDK', 'Software Development Kit', 'ArrayInner1', 'BetaArrayInner1'] +--- + + +# ArrayInner1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$ArrayInner1 = Initialize-PSSailpoint.BetaArrayInner1 +``` + +- Convert the resource to JSON +```powershell +$ArrayInner1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AssignmentContextDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AssignmentContextDto.md new file mode 100644 index 000000000..5395104b9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AssignmentContextDto.md @@ -0,0 +1,39 @@ +--- +id: beta-assignment-context-dto +title: AssignmentContextDto +pagination_label: AssignmentContextDto +sidebar_label: AssignmentContextDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AssignmentContextDto', 'BetaAssignmentContextDto'] +slug: /tools/sdk/powershell/beta/models/assignment-context-dto +tags: ['SDK', 'Software Development Kit', 'AssignmentContextDto', 'BetaAssignmentContextDto'] +--- + + +# AssignmentContextDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Requested** | Pointer to [**AccessRequestContext**](access-request-context) | | [optional] +**Matched** | Pointer to [**[]RoleMatchDto**](role-match-dto) | | [optional] +**ComputedDate** | Pointer to **String** | Date that the assignment will was evaluated | [optional] + +## Examples + +- Prepare the resource +```powershell +$AssignmentContextDto = Initialize-PSSailpoint.BetaAssignmentContextDto -Requested null ` + -Matched null ` + -ComputedDate Wed Feb 14 10:58:42 +``` + +- Convert the resource to JSON +```powershell +$AssignmentContextDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttrSyncSource.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttrSyncSource.md new file mode 100644 index 000000000..b8058b4f7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttrSyncSource.md @@ -0,0 +1,39 @@ +--- +id: beta-attr-sync-source +title: AttrSyncSource +pagination_label: AttrSyncSource +sidebar_label: AttrSyncSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttrSyncSource', 'BetaAttrSyncSource'] +slug: /tools/sdk/powershell/beta/models/attr-sync-source +tags: ['SDK', 'Software Development Kit', 'AttrSyncSource', 'BetaAttrSyncSource'] +--- + + +# AttrSyncSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "SOURCE" ] | DTO type of target source for attribute synchronization. | [optional] +**Id** | Pointer to **String** | ID of target source for attribute synchronization. | [optional] +**Name** | Pointer to **String** | Human-readable name of target source for attribute synchronization. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AttrSyncSource = Initialize-PSSailpoint.BetaAttrSyncSource -Type SOURCE ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name HR Active Directory +``` + +- Convert the resource to JSON +```powershell +$AttrSyncSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttrSyncSourceAttributeConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttrSyncSourceAttributeConfig.md new file mode 100644 index 000000000..e58b40c0e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttrSyncSourceAttributeConfig.md @@ -0,0 +1,41 @@ +--- +id: beta-attr-sync-source-attribute-config +title: AttrSyncSourceAttributeConfig +pagination_label: AttrSyncSourceAttributeConfig +sidebar_label: AttrSyncSourceAttributeConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttrSyncSourceAttributeConfig', 'BetaAttrSyncSourceAttributeConfig'] +slug: /tools/sdk/powershell/beta/models/attr-sync-source-attribute-config +tags: ['SDK', 'Software Development Kit', 'AttrSyncSourceAttributeConfig', 'BetaAttrSyncSourceAttributeConfig'] +--- + + +# AttrSyncSourceAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Name of the identity attribute | [required] +**DisplayName** | **String** | Display name of the identity attribute | [required] +**Enabled** | **Boolean** | Determines whether or not the attribute is enabled for synchronization | [required] +**Target** | **String** | Name of the source account attribute to which the identity attribute value will be synchronized if enabled | [required] + +## Examples + +- Prepare the resource +```powershell +$AttrSyncSourceAttributeConfig = Initialize-PSSailpoint.BetaAttrSyncSourceAttributeConfig -Name email ` + -DisplayName Email ` + -Enabled true ` + -Target mail +``` + +- Convert the resource to JSON +```powershell +$AttrSyncSourceAttributeConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttrSyncSourceConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttrSyncSourceConfig.md new file mode 100644 index 000000000..01830a0d8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttrSyncSourceConfig.md @@ -0,0 +1,37 @@ +--- +id: beta-attr-sync-source-config +title: AttrSyncSourceConfig +pagination_label: AttrSyncSourceConfig +sidebar_label: AttrSyncSourceConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttrSyncSourceConfig', 'BetaAttrSyncSourceConfig'] +slug: /tools/sdk/powershell/beta/models/attr-sync-source-config +tags: ['SDK', 'Software Development Kit', 'AttrSyncSourceConfig', 'BetaAttrSyncSourceConfig'] +--- + + +# AttrSyncSourceConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | [**AttrSyncSource**](attr-sync-source) | | [required] +**Attributes** | [**[]AttrSyncSourceAttributeConfig**](attr-sync-source-attribute-config) | Attribute synchronization configuration for specific identity attributes in the context of a source | [required] + +## Examples + +- Prepare the resource +```powershell +$AttrSyncSourceConfig = Initialize-PSSailpoint.BetaAttrSyncSourceConfig -Source null ` + -Attributes [{name=email, displayName=Email, enabled=true, target=mail}, {name=firstname, displayName=First Name, enabled=false, target=givenName}] +``` + +- Convert the resource to JSON +```powershell +$AttrSyncSourceConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttributeChange.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttributeChange.md new file mode 100644 index 000000000..093e799f4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttributeChange.md @@ -0,0 +1,39 @@ +--- +id: beta-attribute-change +title: AttributeChange +pagination_label: AttributeChange +sidebar_label: AttributeChange +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeChange', 'BetaAttributeChange'] +slug: /tools/sdk/powershell/beta/models/attribute-change +tags: ['SDK', 'Software Development Kit', 'AttributeChange', 'BetaAttributeChange'] +--- + + +# AttributeChange + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | the attribute name | [optional] +**PreviousValue** | Pointer to **String** | the old value of attribute | [optional] +**NewValue** | Pointer to **String** | the new value of attribute | [optional] + +## Examples + +- Prepare the resource +```powershell +$AttributeChange = Initialize-PSSailpoint.BetaAttributeChange -Name null ` + -PreviousValue null ` + -NewValue null +``` + +- Convert the resource to JSON +```powershell +$AttributeChange | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttributeDTO.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttributeDTO.md new file mode 100644 index 000000000..3c6325586 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttributeDTO.md @@ -0,0 +1,49 @@ +--- +id: beta-attribute-dto +title: AttributeDTO +pagination_label: AttributeDTO +sidebar_label: AttributeDTO +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDTO', 'BetaAttributeDTO'] +slug: /tools/sdk/powershell/beta/models/attribute-dto +tags: ['SDK', 'Software Development Kit', 'AttributeDTO', 'BetaAttributeDTO'] +--- + + +# AttributeDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **String** | Technical name of the Attribute. This is unique and cannot be changed after creation. | [optional] +**Name** | Pointer to **String** | The display name of the key. | [optional] +**Multiselect** | Pointer to **Boolean** | Indicates whether the attribute can have multiple values. | [optional] [default to $false] +**Status** | Pointer to **String** | The status of the Attribute. | [optional] +**Type** | Pointer to **String** | The type of the Attribute. This can be either ""custom"" or ""governance"". | [optional] +**ObjectTypes** | Pointer to **[]String** | An array of object types this attributes values can be applied to. Possible values are ""all"" or ""entitlement"". Value ""all"" means this attribute can be used with all object types that are supported. | [optional] +**Description** | Pointer to **String** | The description of the Attribute. | [optional] +**Values** | Pointer to [**[]AttributeValueDTO**](attribute-value-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AttributeDTO = Initialize-PSSailpoint.BetaAttributeDTO -Key iscPrivacy ` + -Name Privacy ` + -Multiselect false ` + -Status active ` + -Type governance ` + -ObjectTypes [entitlement] ` + -Description Specifies the level of privacy associated with an access item. ` + -Values null +``` + +- Convert the resource to JSON +```powershell +$AttributeDTO | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttributeDTOList.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttributeDTOList.md new file mode 100644 index 000000000..6eb00017d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttributeDTOList.md @@ -0,0 +1,35 @@ +--- +id: beta-attribute-dto-list +title: AttributeDTOList +pagination_label: AttributeDTOList +sidebar_label: AttributeDTOList +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDTOList', 'BetaAttributeDTOList'] +slug: /tools/sdk/powershell/beta/models/attribute-dto-list +tags: ['SDK', 'Software Development Kit', 'AttributeDTOList', 'BetaAttributeDTOList'] +--- + + +# AttributeDTOList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**[]AttributeDTO**](attribute-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AttributeDTOList = Initialize-PSSailpoint.BetaAttributeDTOList -Attributes [{key=iscPrivacy, name=Privacy, multiselect=false, status=active, type=governance, objectTypes=[all], description=Specifies the level of privacy associated with an access item., values=[{value=public, name=Public, status=active}]}] +``` + +- Convert the resource to JSON +```powershell +$AttributeDTOList | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttributeDefinition.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttributeDefinition.md new file mode 100644 index 000000000..0994d0b05 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttributeDefinition.md @@ -0,0 +1,47 @@ +--- +id: beta-attribute-definition +title: AttributeDefinition +pagination_label: AttributeDefinition +sidebar_label: AttributeDefinition +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDefinition', 'BetaAttributeDefinition'] +slug: /tools/sdk/powershell/beta/models/attribute-definition +tags: ['SDK', 'Software Development Kit', 'AttributeDefinition', 'BetaAttributeDefinition'] +--- + + +# AttributeDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the attribute. | [optional] +**Type** | Pointer to [**AttributeDefinitionType**](attribute-definition-type) | | [optional] +**Schema** | Pointer to [**AttributeDefinitionSchema**](attribute-definition-schema) | | [optional] +**Description** | Pointer to **String** | A human-readable description of the attribute. | [optional] +**IsMulti** | Pointer to **Boolean** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to $false] +**IsEntitlement** | Pointer to **Boolean** | Flag indicating whether or not the attribute is an entitlement. | [optional] [default to $false] +**IsGroup** | Pointer to **Boolean** | Flag indicating whether or not the attribute represents a group. This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$AttributeDefinition = Initialize-PSSailpoint.BetaAttributeDefinition -Name sAMAccountName ` + -Type null ` + -Schema null ` + -Description The sAMAccountName attribute ` + -IsMulti false ` + -IsEntitlement false ` + -IsGroup false +``` + +- Convert the resource to JSON +```powershell +$AttributeDefinition | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttributeDefinitionSchema.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttributeDefinitionSchema.md new file mode 100644 index 000000000..c261633f1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttributeDefinitionSchema.md @@ -0,0 +1,39 @@ +--- +id: beta-attribute-definition-schema +title: AttributeDefinitionSchema +pagination_label: AttributeDefinitionSchema +sidebar_label: AttributeDefinitionSchema +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDefinitionSchema', 'BetaAttributeDefinitionSchema'] +slug: /tools/sdk/powershell/beta/models/attribute-definition-schema +tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionSchema', 'BetaAttributeDefinitionSchema'] +--- + + +# AttributeDefinitionSchema + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "CONNECTOR_SCHEMA" ] | The type of object being referenced | [optional] +**Id** | Pointer to **String** | The object ID this reference applies to. | [optional] +**Name** | Pointer to **String** | The human-readable display name of the object. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AttributeDefinitionSchema = Initialize-PSSailpoint.BetaAttributeDefinitionSchema -Type CONNECTOR_SCHEMA ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name group +``` + +- Convert the resource to JSON +```powershell +$AttributeDefinitionSchema | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttributeDefinitionType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttributeDefinitionType.md new file mode 100644 index 000000000..da8de7660 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttributeDefinitionType.md @@ -0,0 +1,28 @@ +--- +id: beta-attribute-definition-type +title: AttributeDefinitionType +pagination_label: AttributeDefinitionType +sidebar_label: AttributeDefinitionType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDefinitionType', 'BetaAttributeDefinitionType'] +slug: /tools/sdk/powershell/beta/models/attribute-definition-type +tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionType', 'BetaAttributeDefinitionType'] +--- + + +# AttributeDefinitionType + +## Enum + + +* `STRING` (value: `"STRING"`) + +* `LONG` (value: `"LONG"`) + +* `INT` (value: `"INT"`) + +* `BOOLEAN` (value: `"BOOLEAN"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttributeValueDTO.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttributeValueDTO.md new file mode 100644 index 000000000..6001e1764 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttributeValueDTO.md @@ -0,0 +1,39 @@ +--- +id: beta-attribute-value-dto +title: AttributeValueDTO +pagination_label: AttributeValueDTO +sidebar_label: AttributeValueDTO +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeValueDTO', 'BetaAttributeValueDTO'] +slug: /tools/sdk/powershell/beta/models/attribute-value-dto +tags: ['SDK', 'Software Development Kit', 'AttributeValueDTO', 'BetaAttributeValueDTO'] +--- + + +# AttributeValueDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **String** | Technical name of the Attribute value. This is unique and cannot be changed after creation. | [optional] +**Name** | Pointer to **String** | The display name of the Attribute value. | [optional] +**Status** | Pointer to **String** | The status of the Attribute value. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AttributeValueDTO = Initialize-PSSailpoint.BetaAttributeValueDTO -Value public ` + -Name Public ` + -Status active +``` + +- Convert the resource to JSON +```powershell +$AttributeValueDTO | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttributesChanged.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttributesChanged.md new file mode 100644 index 000000000..4f28a7f9a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AttributesChanged.md @@ -0,0 +1,41 @@ +--- +id: beta-attributes-changed +title: AttributesChanged +pagination_label: AttributesChanged +sidebar_label: AttributesChanged +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttributesChanged', 'BetaAttributesChanged'] +slug: /tools/sdk/powershell/beta/models/attributes-changed +tags: ['SDK', 'Software Development Kit', 'AttributesChanged', 'BetaAttributesChanged'] +--- + + +# AttributesChanged + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Changes** | Pointer to [**[]AttributeChange**](attribute-change) | | [optional] +**EventType** | Pointer to **String** | the event type | [optional] +**IdentityId** | Pointer to **String** | the identity id | [optional] +**Dt** | Pointer to **String** | the date of event | [optional] + +## Examples + +- Prepare the resource +```powershell +$AttributesChanged = Initialize-PSSailpoint.BetaAttributesChanged -Changes null ` + -EventType null ` + -IdentityId null ` + -Dt null +``` + +- Convert the resource to JSON +```powershell +$AttributesChanged | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AuditDetails.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AuditDetails.md new file mode 100644 index 000000000..ecc61274d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AuditDetails.md @@ -0,0 +1,41 @@ +--- +id: beta-audit-details +title: AuditDetails +pagination_label: AuditDetails +sidebar_label: AuditDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AuditDetails', 'BetaAuditDetails'] +slug: /tools/sdk/powershell/beta/models/audit-details +tags: ['SDK', 'Software Development Kit', 'AuditDetails', 'BetaAuditDetails'] +--- + + +# AuditDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **System.DateTime** | Initial date and time when the record was created | [optional] +**CreatedBy** | Pointer to [**Identity1**](identity1) | | [optional] +**Modified** | Pointer to **System.DateTime** | Last modified date and time for the record | [optional] +**ModifiedBy** | Pointer to [**Identity1**](identity1) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AuditDetails = Initialize-PSSailpoint.BetaAuditDetails -Created 2022-07-21T11:13:12.345Z ` + -CreatedBy null ` + -Modified 2022-07-21T11:13:12.345Z ` + -ModifiedBy null +``` + +- Convert the resource to JSON +```powershell +$AuditDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AuthProfile.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AuthProfile.md new file mode 100644 index 000000000..80ef5c315 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AuthProfile.md @@ -0,0 +1,47 @@ +--- +id: beta-auth-profile +title: AuthProfile +pagination_label: AuthProfile +sidebar_label: AuthProfile +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AuthProfile', 'BetaAuthProfile'] +slug: /tools/sdk/powershell/beta/models/auth-profile +tags: ['SDK', 'Software Development Kit', 'AuthProfile', 'BetaAuthProfile'] +--- + + +# AuthProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Authentication Profile name. | [optional] +**OffNetwork** | Pointer to **Boolean** | Use it to block access from off network. | [optional] [default to $false] +**UntrustedGeography** | Pointer to **Boolean** | Use it to block access from untrusted geoographies. | [optional] [default to $false] +**ApplicationId** | Pointer to **String** | Application ID. | [optional] +**ApplicationName** | Pointer to **String** | Application name. | [optional] +**Type** | Pointer to **Enum** [ "BLOCK", "MFA", "NON_PTA", "PTA" ] | Type of the Authentication Profile. | [optional] +**StrongAuthLogin** | Pointer to **Boolean** | Use it to enable strong authentication. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$AuthProfile = Initialize-PSSailpoint.BetaAuthProfile -Name EndToEnd-Profile ` + -OffNetwork true ` + -UntrustedGeography true ` + -ApplicationId 2c91808458ae7a4f0158b1bbf8af0628 ` + -ApplicationName EndToEnd-Source ` + -Type PTA ` + -StrongAuthLogin true +``` + +- Convert the resource to JSON +```powershell +$AuthProfile | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AuthProfileSummary.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AuthProfileSummary.md new file mode 100644 index 000000000..364098357 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/AuthProfileSummary.md @@ -0,0 +1,37 @@ +--- +id: beta-auth-profile-summary +title: AuthProfileSummary +pagination_label: AuthProfileSummary +sidebar_label: AuthProfileSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AuthProfileSummary', 'BetaAuthProfileSummary'] +slug: /tools/sdk/powershell/beta/models/auth-profile-summary +tags: ['SDK', 'Software Development Kit', 'AuthProfileSummary', 'BetaAuthProfileSummary'] +--- + + +# AuthProfileSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Tenant** | Pointer to **String** | Tenant name. | [optional] +**Id** | Pointer to **String** | Identity ID. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AuthProfileSummary = Initialize-PSSailpoint.BetaAuthProfileSummary -Tenant test-tenant ` + -Id 2c91808458ae7a4f0158b1bbf8af0628 +``` + +- Convert the resource to JSON +```powershell +$AuthProfileSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Base64Decode.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Base64Decode.md new file mode 100644 index 000000000..d34663808 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Base64Decode.md @@ -0,0 +1,37 @@ +--- +id: beta-base64-decode +title: Base64Decode +pagination_label: Base64Decode +sidebar_label: Base64Decode +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Base64Decode', 'BetaBase64Decode'] +slug: /tools/sdk/powershell/beta/models/base64-decode +tags: ['SDK', 'Software Development Kit', 'Base64Decode', 'BetaBase64Decode'] +--- + + +# Base64Decode + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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] + +## Examples + +- Prepare the resource +```powershell +$Base64Decode = Initialize-PSSailpoint.BetaBase64Decode -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Base64Decode | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Base64Encode.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Base64Encode.md new file mode 100644 index 000000000..b4d7587af --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Base64Encode.md @@ -0,0 +1,37 @@ +--- +id: beta-base64-encode +title: Base64Encode +pagination_label: Base64Encode +sidebar_label: Base64Encode +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Base64Encode', 'BetaBase64Encode'] +slug: /tools/sdk/powershell/beta/models/base64-encode +tags: ['SDK', 'Software Development Kit', 'Base64Encode', 'BetaBase64Encode'] +--- + + +# Base64Encode + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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] + +## Examples + +- Prepare the resource +```powershell +$Base64Encode = Initialize-PSSailpoint.BetaBase64Encode -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Base64Encode | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BaseCommonDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BaseCommonDto.md new file mode 100644 index 000000000..06b8fd525 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BaseCommonDto.md @@ -0,0 +1,41 @@ +--- +id: beta-base-common-dto +title: BaseCommonDto +pagination_label: BaseCommonDto +sidebar_label: BaseCommonDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BaseCommonDto', 'BetaBaseCommonDto'] +slug: /tools/sdk/powershell/beta/models/base-common-dto +tags: ['SDK', 'Software Development Kit', 'BaseCommonDto', 'BetaBaseCommonDto'] +--- + + +# BaseCommonDto + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$BaseCommonDto = Initialize-PSSailpoint.BetaBaseCommonDto -Id id12345 ` + -Name aName ` + -Created 2023-01-03T21:16:22.432Z ` + -Modified 2023-01-03T21:16:22.432Z +``` + +- Convert the resource to JSON +```powershell +$BaseCommonDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BaseCommonDto1.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BaseCommonDto1.md new file mode 100644 index 000000000..59f3df9b2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BaseCommonDto1.md @@ -0,0 +1,41 @@ +--- +id: beta-base-common-dto1 +title: BaseCommonDto1 +pagination_label: BaseCommonDto1 +sidebar_label: BaseCommonDto1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BaseCommonDto1', 'BetaBaseCommonDto1'] +slug: /tools/sdk/powershell/beta/models/base-common-dto1 +tags: ['SDK', 'Software Development Kit', 'BaseCommonDto1', 'BetaBaseCommonDto1'] +--- + + +# BaseCommonDto1 + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$BaseCommonDto1 = Initialize-PSSailpoint.BetaBaseCommonDto1 -Id id12345 ` + -Name aName ` + -Created 2015-05-28T14:07:17Z ` + -Modified 2015-05-28T14:07:17Z +``` + +- Convert the resource to JSON +```powershell +$BaseCommonDto1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BaseReferenceDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BaseReferenceDto.md new file mode 100644 index 000000000..7a1b211c4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BaseReferenceDto.md @@ -0,0 +1,39 @@ +--- +id: beta-base-reference-dto +title: BaseReferenceDto +pagination_label: BaseReferenceDto +sidebar_label: BaseReferenceDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BaseReferenceDto', 'BetaBaseReferenceDto'] +slug: /tools/sdk/powershell/beta/models/base-reference-dto +tags: ['SDK', 'Software Development Kit', 'BaseReferenceDto', 'BetaBaseReferenceDto'] +--- + + +# BaseReferenceDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] + +## Examples + +- Prepare the resource +```powershell +$BaseReferenceDto = Initialize-PSSailpoint.BetaBaseReferenceDto -Type null ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$BaseReferenceDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BaseReferenceDto1.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BaseReferenceDto1.md new file mode 100644 index 000000000..2cfb51e47 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BaseReferenceDto1.md @@ -0,0 +1,37 @@ +--- +id: beta-base-reference-dto1 +title: BaseReferenceDto1 +pagination_label: BaseReferenceDto1 +sidebar_label: BaseReferenceDto1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BaseReferenceDto1', 'BetaBaseReferenceDto1'] +slug: /tools/sdk/powershell/beta/models/base-reference-dto1 +tags: ['SDK', 'Software Development Kit', 'BaseReferenceDto1', 'BetaBaseReferenceDto1'] +--- + + +# BaseReferenceDto1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | the application ID | [optional] +**Name** | Pointer to **String** | the application name | [optional] + +## Examples + +- Prepare the resource +```powershell +$BaseReferenceDto1 = Initialize-PSSailpoint.BetaBaseReferenceDto1 -Id ff8081814d977c21014da056804a0af3 ` + -Name Github +``` + +- Convert the resource to JSON +```powershell +$BaseReferenceDto1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BasicAuthConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BasicAuthConfig.md new file mode 100644 index 000000000..ae699fefc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BasicAuthConfig.md @@ -0,0 +1,37 @@ +--- +id: beta-basic-auth-config +title: BasicAuthConfig +pagination_label: BasicAuthConfig +sidebar_label: BasicAuthConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BasicAuthConfig', 'BetaBasicAuthConfig'] +slug: /tools/sdk/powershell/beta/models/basic-auth-config +tags: ['SDK', 'Software Development Kit', 'BasicAuthConfig', 'BetaBasicAuthConfig'] +--- + + +# BasicAuthConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserName** | Pointer to **String** | The username to authenticate. | [optional] +**Password** | Pointer to **String** | The password to authenticate. On response, this field is set to null as to not return secrets. | [optional] + +## Examples + +- Prepare the resource +```powershell +$BasicAuthConfig = Initialize-PSSailpoint.BetaBasicAuthConfig -UserName user@example.com ` + -Password null +``` + +- Convert the resource to JSON +```powershell +$BasicAuthConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BearerTokenAuthConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BearerTokenAuthConfig.md new file mode 100644 index 000000000..5be32ff99 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BearerTokenAuthConfig.md @@ -0,0 +1,35 @@ +--- +id: beta-bearer-token-auth-config +title: BearerTokenAuthConfig +pagination_label: BearerTokenAuthConfig +sidebar_label: BearerTokenAuthConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BearerTokenAuthConfig', 'BetaBearerTokenAuthConfig'] +slug: /tools/sdk/powershell/beta/models/bearer-token-auth-config +tags: ['SDK', 'Software Development Kit', 'BearerTokenAuthConfig', 'BetaBearerTokenAuthConfig'] +--- + + +# BearerTokenAuthConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BearerToken** | Pointer to **String** | Bearer token | [optional] + +## Examples + +- Prepare the resource +```powershell +$BearerTokenAuthConfig = Initialize-PSSailpoint.BetaBearerTokenAuthConfig -BearerToken null +``` + +- Convert the resource to JSON +```powershell +$BearerTokenAuthConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BeforeProvisioningRuleDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BeforeProvisioningRuleDto.md new file mode 100644 index 000000000..b26d6fe11 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BeforeProvisioningRuleDto.md @@ -0,0 +1,39 @@ +--- +id: beta-before-provisioning-rule-dto +title: BeforeProvisioningRuleDto +pagination_label: BeforeProvisioningRuleDto +sidebar_label: BeforeProvisioningRuleDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BeforeProvisioningRuleDto', 'BetaBeforeProvisioningRuleDto'] +slug: /tools/sdk/powershell/beta/models/before-provisioning-rule-dto +tags: ['SDK', 'Software Development Kit', 'BeforeProvisioningRuleDto', 'BetaBeforeProvisioningRuleDto'] +--- + + +# BeforeProvisioningRuleDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "RULE" ] | Before Provisioning Rule DTO type. | [optional] +**Id** | Pointer to **String** | Before Provisioning Rule ID. | [optional] +**Name** | Pointer to **String** | Rule display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$BeforeProvisioningRuleDto = Initialize-PSSailpoint.BetaBeforeProvisioningRuleDto -Type RULE ` + -Id 048eb3d55c5a4758bd07dccb87741c78 ` + -Name Before Provisioning Airtable Rule +``` + +- Convert the resource to JSON +```powershell +$BeforeProvisioningRuleDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BulkIdentitiesAccountsResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BulkIdentitiesAccountsResponse.md new file mode 100644 index 000000000..d86a2dd64 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BulkIdentitiesAccountsResponse.md @@ -0,0 +1,39 @@ +--- +id: beta-bulk-identities-accounts-response +title: BulkIdentitiesAccountsResponse +pagination_label: BulkIdentitiesAccountsResponse +sidebar_label: BulkIdentitiesAccountsResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BulkIdentitiesAccountsResponse', 'BetaBulkIdentitiesAccountsResponse'] +slug: /tools/sdk/powershell/beta/models/bulk-identities-accounts-response +tags: ['SDK', 'Software Development Kit', 'BulkIdentitiesAccountsResponse', 'BetaBulkIdentitiesAccountsResponse'] +--- + + +# BulkIdentitiesAccountsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Identifier of bulk request item. | [optional] +**StatusCode** | Pointer to **Int32** | Response status value. | [optional] +**Message** | Pointer to **String** | Status containing additional context information about failures. | [optional] + +## Examples + +- Prepare the resource +```powershell +$BulkIdentitiesAccountsResponse = Initialize-PSSailpoint.BetaBulkIdentitiesAccountsResponse -Id 2c9180858082150f0180893dbaf553fe ` + -StatusCode 404 ` + -Message Referenced identity "2c9180858082150f0180893dbaf553fe" was not found. +``` + +- Convert the resource to JSON +```powershell +$BulkIdentitiesAccountsResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BulkTaggedObject.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BulkTaggedObject.md new file mode 100644 index 000000000..1aa8de645 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BulkTaggedObject.md @@ -0,0 +1,39 @@ +--- +id: beta-bulk-tagged-object +title: BulkTaggedObject +pagination_label: BulkTaggedObject +sidebar_label: BulkTaggedObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BulkTaggedObject', 'BetaBulkTaggedObject'] +slug: /tools/sdk/powershell/beta/models/bulk-tagged-object +tags: ['SDK', 'Software Development Kit', 'BulkTaggedObject', 'BetaBulkTaggedObject'] +--- + + +# BulkTaggedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectRefs** | Pointer to [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] +**Tags** | Pointer to **[]String** | Label to be applied to object. | [optional] +**Operation** | Pointer to **Enum** [ "APPEND", "MERGE" ] | If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. | [optional] [default to "APPEND"] + +## Examples + +- Prepare the resource +```powershell +$BulkTaggedObject = Initialize-PSSailpoint.BetaBulkTaggedObject -ObjectRefs null ` + -Tags [BU_FINANCE, PCI] ` + -Operation MERGE +``` + +- Convert the resource to JSON +```powershell +$BulkTaggedObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BulkWorkgroupMembersRequestInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BulkWorkgroupMembersRequestInner.md new file mode 100644 index 000000000..5f54c3ddd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/BulkWorkgroupMembersRequestInner.md @@ -0,0 +1,39 @@ +--- +id: beta-bulk-workgroup-members-request-inner +title: BulkWorkgroupMembersRequestInner +pagination_label: BulkWorkgroupMembersRequestInner +sidebar_label: BulkWorkgroupMembersRequestInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BulkWorkgroupMembersRequestInner', 'BetaBulkWorkgroupMembersRequestInner'] +slug: /tools/sdk/powershell/beta/models/bulk-workgroup-members-request-inner +tags: ['SDK', 'Software Development Kit', 'BulkWorkgroupMembersRequestInner', 'BetaBulkWorkgroupMembersRequestInner'] +--- + + +# BulkWorkgroupMembersRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Identity's DTO type. | [optional] +**Id** | Pointer to **String** | Identity ID. | [optional] +**Name** | Pointer to **String** | Identity's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$BulkWorkgroupMembersRequestInner = Initialize-PSSailpoint.BetaBulkWorkgroupMembersRequestInner -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$BulkWorkgroupMembersRequestInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Campaign.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Campaign.md new file mode 100644 index 000000000..33d9a4b12 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Campaign.md @@ -0,0 +1,79 @@ +--- +id: beta-campaign +title: Campaign +pagination_label: Campaign +sidebar_label: Campaign +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Campaign', 'BetaCampaign'] +slug: /tools/sdk/powershell/beta/models/campaign +tags: ['SDK', 'Software Development Kit', 'Campaign', 'BetaCampaign'] +--- + + +# Campaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the campaign | [optional] [readonly] +**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Deadline** | Pointer to **System.DateTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required] +**EmailNotificationEnabled** | Pointer to **Boolean** | Enables email notification for this campaign | [optional] [default to $false] +**AutoRevokeAllowed** | Pointer to **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] +**RecommendationsEnabled** | Pointer to **Boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to $false] +**Status** | Pointer to **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **System.DateTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **Int32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | Modified time of the campaign | [optional] [readonly] +**VarFilter** | Pointer to [**FullcampaignAllOfFilter**](fullcampaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | Pointer to **Boolean** | Determines if comments on sunset date changes are required. | [optional] [default to $true] +**SourceOwnerCampaignInfo** | Pointer to [**FullcampaignAllOfSourceOwnerCampaignInfo**](fullcampaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | Pointer to [**FullcampaignAllOfSearchCampaignInfo**](fullcampaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | Pointer to [**FullcampaignAllOfRoleCompositionCampaignInfo**](fullcampaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | Pointer to [**FullcampaignAllOfMachineAccountCampaignInfo**](fullcampaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | Pointer to [**[]FullcampaignAllOfSourcesWithOrphanEntitlements**](fullcampaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \""orphan entitlements\"" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**MandatoryCommentRequirement** | Pointer to **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Campaign = Initialize-PSSailpoint.BetaCampaign -Id 2c9079b270a266a60170a2779fcb0007 ` + -Name Manager Campaign ` + -Description Everyone needs to be reviewed by their manager ` + -Deadline 2020-03-15T10:00:01.456Z ` + -Type MANAGER ` + -EmailNotificationEnabled false ` + -AutoRevokeAllowed false ` + -RecommendationsEnabled true ` + -Status ACTIVE ` + -CorrelatedStatus CORRELATED ` + -Created 2020-03-03T22:15:13.611Z ` + -TotalCertifications 100 ` + -CompletedCertifications 10 ` + -Alerts null ` + -Modified 2020-03-03T22:20:12.674Z ` + -VarFilter null ` + -SunsetCommentsRequired true ` + -SourceOwnerCampaignInfo null ` + -SearchCampaignInfo null ` + -RoleCompositionCampaignInfo null ` + -MachineAccountCampaignInfo null ` + -SourcesWithOrphanEntitlements null ` + -MandatoryCommentRequirement NO_DECISIONS +``` + +- Convert the resource to JSON +```powershell +$Campaign | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignActivated.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignActivated.md new file mode 100644 index 000000000..912aa931d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignActivated.md @@ -0,0 +1,35 @@ +--- +id: beta-campaign-activated +title: CampaignActivated +pagination_label: CampaignActivated +sidebar_label: CampaignActivated +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignActivated', 'BetaCampaignActivated'] +slug: /tools/sdk/powershell/beta/models/campaign-activated +tags: ['SDK', 'Software Development Kit', 'CampaignActivated', 'BetaCampaignActivated'] +--- + + +# CampaignActivated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Campaign** | [**CampaignActivatedCampaign**](campaign-activated-campaign) | | [required] + +## Examples + +- Prepare the resource +```powershell +$CampaignActivated = Initialize-PSSailpoint.BetaCampaignActivated -Campaign null +``` + +- Convert the resource to JSON +```powershell +$CampaignActivated | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignActivatedCampaign.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignActivatedCampaign.md new file mode 100644 index 000000000..ef3330bad --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignActivatedCampaign.md @@ -0,0 +1,51 @@ +--- +id: beta-campaign-activated-campaign +title: CampaignActivatedCampaign +pagination_label: CampaignActivatedCampaign +sidebar_label: CampaignActivatedCampaign +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignActivatedCampaign', 'BetaCampaignActivatedCampaign'] +slug: /tools/sdk/powershell/beta/models/campaign-activated-campaign +tags: ['SDK', 'Software Development Kit', 'CampaignActivatedCampaign', 'BetaCampaignActivatedCampaign'] +--- + + +# CampaignActivatedCampaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Unique ID for the campaign. | [required] +**Name** | **String** | The human friendly name of the campaign. | [required] +**Description** | **String** | Extended description of the campaign. | [required] +**Created** | **System.DateTime** | The date and time the campaign was created. | [required] +**Modified** | Pointer to **System.DateTime** | The date and time the campaign was last modified. | [optional] +**Deadline** | **System.DateTime** | The date and time the campaign is due. | [required] +**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION" ] | The type of campaign. | [required] +**CampaignOwner** | [**CampaignActivatedCampaignCampaignOwner**](campaign-activated-campaign-campaign-owner) | | [required] +**Status** | **Enum** [ "ACTIVE" ] | The current status of the campaign. | [required] + +## Examples + +- Prepare the resource +```powershell +$CampaignActivatedCampaign = Initialize-PSSailpoint.BetaCampaignActivatedCampaign -Id 2c91808576f886190176f88cac5a0010 ` + -Name Manager Access Campaign ` + -Description Audit access for all employees. ` + -Created 2021-02-16T03:04:45.815Z ` + -Modified 2021-02-16T03:06:45.815Z ` + -Deadline 2021-03-16T03:04:45.815Z ` + -Type MANAGER ` + -CampaignOwner null ` + -Status ACTIVE +``` + +- Convert the resource to JSON +```powershell +$CampaignActivatedCampaign | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignActivatedCampaignCampaignOwner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignActivatedCampaignCampaignOwner.md new file mode 100644 index 000000000..62da805ef --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignActivatedCampaignCampaignOwner.md @@ -0,0 +1,39 @@ +--- +id: beta-campaign-activated-campaign-campaign-owner +title: CampaignActivatedCampaignCampaignOwner +pagination_label: CampaignActivatedCampaignCampaignOwner +sidebar_label: CampaignActivatedCampaignCampaignOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignActivatedCampaignCampaignOwner', 'BetaCampaignActivatedCampaignCampaignOwner'] +slug: /tools/sdk/powershell/beta/models/campaign-activated-campaign-campaign-owner +tags: ['SDK', 'Software Development Kit', 'CampaignActivatedCampaignCampaignOwner', 'BetaCampaignActivatedCampaignCampaignOwner'] +--- + + +# CampaignActivatedCampaignCampaignOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the identity. | [required] +**DisplayName** | **String** | The human friendly name of the identity. | [required] +**Email** | **String** | The primary email address of the identity. | [required] + +## Examples + +- Prepare the resource +```powershell +$CampaignActivatedCampaignCampaignOwner = Initialize-PSSailpoint.BetaCampaignActivatedCampaignCampaignOwner -Id 37f080867702c1910177031320c40n27 ` + -DisplayName John Snow ` + -Email john.snow@example.com +``` + +- Convert the resource to JSON +```powershell +$CampaignActivatedCampaignCampaignOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignAlert.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignAlert.md new file mode 100644 index 000000000..052a7bb05 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignAlert.md @@ -0,0 +1,37 @@ +--- +id: beta-campaign-alert +title: CampaignAlert +pagination_label: CampaignAlert +sidebar_label: CampaignAlert +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAlert', 'BetaCampaignAlert'] +slug: /tools/sdk/powershell/beta/models/campaign-alert +tags: ['SDK', 'Software Development Kit', 'CampaignAlert', 'BetaCampaignAlert'] +--- + + +# CampaignAlert + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Level** | Pointer to **Enum** [ "ERROR", "WARN", "INFO" ] | Denotes the level of the message | [optional] +**Localizations** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignAlert = Initialize-PSSailpoint.BetaCampaignAlert -Level ERROR ` + -Localizations null +``` + +- Convert the resource to JSON +```powershell +$CampaignAlert | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignEnded.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignEnded.md new file mode 100644 index 000000000..43376f4d5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignEnded.md @@ -0,0 +1,35 @@ +--- +id: beta-campaign-ended +title: CampaignEnded +pagination_label: CampaignEnded +sidebar_label: CampaignEnded +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignEnded', 'BetaCampaignEnded'] +slug: /tools/sdk/powershell/beta/models/campaign-ended +tags: ['SDK', 'Software Development Kit', 'CampaignEnded', 'BetaCampaignEnded'] +--- + + +# CampaignEnded + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Campaign** | [**CampaignEndedCampaign**](campaign-ended-campaign) | | [required] + +## Examples + +- Prepare the resource +```powershell +$CampaignEnded = Initialize-PSSailpoint.BetaCampaignEnded -Campaign null +``` + +- Convert the resource to JSON +```powershell +$CampaignEnded | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignEndedCampaign.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignEndedCampaign.md new file mode 100644 index 000000000..cd1c3fd78 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignEndedCampaign.md @@ -0,0 +1,51 @@ +--- +id: beta-campaign-ended-campaign +title: CampaignEndedCampaign +pagination_label: CampaignEndedCampaign +sidebar_label: CampaignEndedCampaign +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignEndedCampaign', 'BetaCampaignEndedCampaign'] +slug: /tools/sdk/powershell/beta/models/campaign-ended-campaign +tags: ['SDK', 'Software Development Kit', 'CampaignEndedCampaign', 'BetaCampaignEndedCampaign'] +--- + + +# CampaignEndedCampaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Unique ID for the campaign. | [required] +**Name** | **String** | The human friendly name of the campaign. | [required] +**Description** | **String** | Extended description of the campaign. | [required] +**Created** | **System.DateTime** | The date and time the campaign was created. | [required] +**Modified** | Pointer to **System.DateTime** | The date and time the campaign was last modified. | [optional] +**Deadline** | **System.DateTime** | The date and time the campaign is due. | [required] +**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION" ] | The type of campaign. | [required] +**CampaignOwner** | [**CampaignActivatedCampaignCampaignOwner**](campaign-activated-campaign-campaign-owner) | | [required] +**Status** | **Enum** [ "COMPLETED" ] | The current status of the campaign. | [required] + +## Examples + +- Prepare the resource +```powershell +$CampaignEndedCampaign = Initialize-PSSailpoint.BetaCampaignEndedCampaign -Id 2c91808576f886190176f88cac5a0010 ` + -Name Manager Access Campaign ` + -Description Audit access for all employees. ` + -Created 2021-02-16T03:04:45.815Z ` + -Modified 2021-03-16T03:06:45.815Z ` + -Deadline 2021-03-16T03:04:45.815Z ` + -Type MANAGER ` + -CampaignOwner null ` + -Status COMPLETED +``` + +- Convert the resource to JSON +```powershell +$CampaignEndedCampaign | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignGenerated.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignGenerated.md new file mode 100644 index 000000000..7be6fe07b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignGenerated.md @@ -0,0 +1,35 @@ +--- +id: beta-campaign-generated +title: CampaignGenerated +pagination_label: CampaignGenerated +sidebar_label: CampaignGenerated +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignGenerated', 'BetaCampaignGenerated'] +slug: /tools/sdk/powershell/beta/models/campaign-generated +tags: ['SDK', 'Software Development Kit', 'CampaignGenerated', 'BetaCampaignGenerated'] +--- + + +# CampaignGenerated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Campaign** | [**CampaignGeneratedCampaign**](campaign-generated-campaign) | | [required] + +## Examples + +- Prepare the resource +```powershell +$CampaignGenerated = Initialize-PSSailpoint.BetaCampaignGenerated -Campaign null +``` + +- Convert the resource to JSON +```powershell +$CampaignGenerated | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignGeneratedCampaign.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignGeneratedCampaign.md new file mode 100644 index 000000000..bccf8e32d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignGeneratedCampaign.md @@ -0,0 +1,51 @@ +--- +id: beta-campaign-generated-campaign +title: CampaignGeneratedCampaign +pagination_label: CampaignGeneratedCampaign +sidebar_label: CampaignGeneratedCampaign +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignGeneratedCampaign', 'BetaCampaignGeneratedCampaign'] +slug: /tools/sdk/powershell/beta/models/campaign-generated-campaign +tags: ['SDK', 'Software Development Kit', 'CampaignGeneratedCampaign', 'BetaCampaignGeneratedCampaign'] +--- + + +# CampaignGeneratedCampaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the campaign. | [required] +**Name** | **String** | Human friendly name of the campaign. | [required] +**Description** | **String** | Extended description of the campaign. | [required] +**Created** | **System.DateTime** | The date and time the campaign was created. | [required] +**Modified** | Pointer to **String** | The date and time the campaign was last modified. | [optional] +**Deadline** | Pointer to **String** | The date and time when the campaign must be finished by. | [optional] +**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION" ] | The type of campaign that was generated. | [required] +**CampaignOwner** | [**CampaignGeneratedCampaignCampaignOwner**](campaign-generated-campaign-campaign-owner) | | [required] +**Status** | **Enum** [ "STAGED", "ACTIVATING", "ACTIVE" ] | The current status of the campaign. | [required] + +## Examples + +- Prepare the resource +```powershell +$CampaignGeneratedCampaign = Initialize-PSSailpoint.BetaCampaignGeneratedCampaign -Id 2c91808576f886190176f88cac5a0010 ` + -Name Manager Access Campaign ` + -Description Audit access for all employees. ` + -Created 2021-02-16T03:04:45.815Z ` + -Modified 2021-02-17T03:04:45.815Z ` + -Deadline 2021-02-18T03:04:45.815Z ` + -Type MANAGER ` + -CampaignOwner null ` + -Status STAGED +``` + +- Convert the resource to JSON +```powershell +$CampaignGeneratedCampaign | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignGeneratedCampaignCampaignOwner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignGeneratedCampaignCampaignOwner.md new file mode 100644 index 000000000..0de8edcf4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignGeneratedCampaignCampaignOwner.md @@ -0,0 +1,39 @@ +--- +id: beta-campaign-generated-campaign-campaign-owner +title: CampaignGeneratedCampaignCampaignOwner +pagination_label: CampaignGeneratedCampaignCampaignOwner +sidebar_label: CampaignGeneratedCampaignCampaignOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignGeneratedCampaignCampaignOwner', 'BetaCampaignGeneratedCampaignCampaignOwner'] +slug: /tools/sdk/powershell/beta/models/campaign-generated-campaign-campaign-owner +tags: ['SDK', 'Software Development Kit', 'CampaignGeneratedCampaignCampaignOwner', 'BetaCampaignGeneratedCampaignCampaignOwner'] +--- + + +# CampaignGeneratedCampaignCampaignOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the identity. | [required] +**DisplayName** | **String** | The display name of the identity. | [required] +**Email** | **String** | The primary email address of the identity. | [required] + +## Examples + +- Prepare the resource +```powershell +$CampaignGeneratedCampaignCampaignOwner = Initialize-PSSailpoint.BetaCampaignGeneratedCampaignCampaignOwner -Id 37f080867702c1910177031320c40n27 ` + -DisplayName John Snow ` + -Email john.snow@example.com +``` + +- Convert the resource to JSON +```powershell +$CampaignGeneratedCampaignCampaignOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignReference.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignReference.md new file mode 100644 index 000000000..2f509fc6a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignReference.md @@ -0,0 +1,47 @@ +--- +id: beta-campaign-reference +title: CampaignReference +pagination_label: CampaignReference +sidebar_label: CampaignReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignReference', 'BetaCampaignReference'] +slug: /tools/sdk/powershell/beta/models/campaign-reference +tags: ['SDK', 'Software Development Kit', 'CampaignReference', 'BetaCampaignReference'] +--- + + +# CampaignReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the campaign. | [required] +**Name** | **String** | The name of the campaign. | [required] +**Type** | **Enum** [ "CAMPAIGN" ] | The type of object that is being referenced. | [required] +**CampaignType** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH" ] | The type of the campaign. | [required] +**Description** | **String** | The description of the campaign set by the admin who created it. | [required] +**CorrelatedStatus** | **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [required] +**MandatoryCommentRequirement** | **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [required] + +## Examples + +- Prepare the resource +```powershell +$CampaignReference = Initialize-PSSailpoint.BetaCampaignReference -Id ef38f94347e94562b5bb8424a56397d8 ` + -Name Campaign Name ` + -Type CAMPAIGN ` + -CampaignType MANAGER ` + -Description A description of the campaign ` + -CorrelatedStatus CORRELATED ` + -MandatoryCommentRequirement NO_DECISIONS +``` + +- Convert the resource to JSON +```powershell +$CampaignReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignReport.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignReport.md new file mode 100644 index 000000000..1f82def89 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignReport.md @@ -0,0 +1,45 @@ +--- +id: beta-campaign-report +title: CampaignReport +pagination_label: CampaignReport +sidebar_label: CampaignReport +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignReport', 'BetaCampaignReport'] +slug: /tools/sdk/powershell/beta/models/campaign-report +tags: ['SDK', 'Software Development Kit', 'CampaignReport', 'BetaCampaignReport'] +--- + + +# CampaignReport + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "REPORT_RESULT" ] | SOD policy violation report result DTO type. | [optional] +**Id** | Pointer to **String** | SOD policy violation report result ID. | [optional] +**Name** | Pointer to **String** | Human-readable name of the SOD policy violation report result. | [optional] +**Status** | Pointer to **Enum** [ "SUCCESS", "WARNING", "ERROR", "TERMINATED", "TEMP_ERROR", "PENDING" ] | Status of a SOD policy violation report. | [optional] +**ReportType** | [**ReportType**](report-type) | | [required] +**LastRunAt** | Pointer to **System.DateTime** | The most recent date and time this report was run | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$CampaignReport = Initialize-PSSailpoint.BetaCampaignReport -Type REPORT_RESULT ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name SOD Policy 1 Violation ` + -Status PENDING ` + -ReportType null ` + -LastRunAt null +``` + +- Convert the resource to JSON +```powershell +$CampaignReport | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignReportsConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignReportsConfig.md new file mode 100644 index 000000000..52849a68c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignReportsConfig.md @@ -0,0 +1,35 @@ +--- +id: beta-campaign-reports-config +title: CampaignReportsConfig +pagination_label: CampaignReportsConfig +sidebar_label: CampaignReportsConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignReportsConfig', 'BetaCampaignReportsConfig'] +slug: /tools/sdk/powershell/beta/models/campaign-reports-config +tags: ['SDK', 'Software Development Kit', 'CampaignReportsConfig', 'BetaCampaignReportsConfig'] +--- + + +# CampaignReportsConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityAttributeColumns** | Pointer to **[]String** | list of identity attribute columns | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignReportsConfig = Initialize-PSSailpoint.BetaCampaignReportsConfig -IdentityAttributeColumns [firstname, lastname] +``` + +- Convert the resource to JSON +```powershell +$CampaignReportsConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignTemplate.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignTemplate.md new file mode 100644 index 000000000..01479f2d8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignTemplate.md @@ -0,0 +1,51 @@ +--- +id: beta-campaign-template +title: CampaignTemplate +pagination_label: CampaignTemplate +sidebar_label: CampaignTemplate +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignTemplate', 'BetaCampaignTemplate'] +slug: /tools/sdk/powershell/beta/models/campaign-template +tags: ['SDK', 'Software Development Kit', 'CampaignTemplate', 'BetaCampaignTemplate'] +--- + + +# CampaignTemplate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the campaign template | [optional] +**Name** | **String** | This template's name. Has no bearing on generated campaigns' names. | [required] +**Description** | **String** | This template's description. Has no bearing on generated campaigns' descriptions. | [required] +**Created** | **System.DateTime** | Creation date of Campaign Template | [required][readonly] +**Modified** | **System.DateTime** | Modification date of Campaign Template | [required][readonly] +**Scheduled** | Pointer to **Boolean** | Indicates if this campaign template has been scheduled. | [optional] [readonly] [default to $false] +**OwnerRef** | Pointer to [**CampaignTemplateOwnerRef**](campaign-template-owner-ref) | | [optional] +**DeadlineDuration** | Pointer to **String** | The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign's deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was ""P2W"" (two weeks), the resulting campaign's deadline would be 2020-01-15 (the current date plus 14 days). | [optional] +**Campaign** | [**Campaign**](campaign) | | [required] + +## Examples + +- Prepare the resource +```powershell +$CampaignTemplate = Initialize-PSSailpoint.BetaCampaignTemplate -Id 2c9079b270a266a60170a277bb960008 ` + -Name Manager Campaign Template ` + -Description Template for the annual manager campaign. ` + -Created 2020-03-05T22:44:00.364Z ` + -Modified 2020-03-05T22:52:09.969Z ` + -Scheduled false ` + -OwnerRef null ` + -DeadlineDuration P2W ` + -Campaign null +``` + +- Convert the resource to JSON +```powershell +$CampaignTemplate | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignTemplateOwnerRef.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignTemplateOwnerRef.md new file mode 100644 index 000000000..00d2230fa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CampaignTemplateOwnerRef.md @@ -0,0 +1,41 @@ +--- +id: beta-campaign-template-owner-ref +title: CampaignTemplateOwnerRef +pagination_label: CampaignTemplateOwnerRef +sidebar_label: CampaignTemplateOwnerRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignTemplateOwnerRef', 'BetaCampaignTemplateOwnerRef'] +slug: /tools/sdk/powershell/beta/models/campaign-template-owner-ref +tags: ['SDK', 'Software Development Kit', 'CampaignTemplateOwnerRef', 'BetaCampaignTemplateOwnerRef'] +--- + + +# CampaignTemplateOwnerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the owner | [optional] +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Type of the owner | [optional] +**Name** | Pointer to **String** | Name of the owner | [optional] +**Email** | Pointer to **String** | Email of the owner | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignTemplateOwnerRef = Initialize-PSSailpoint.BetaCampaignTemplateOwnerRef -Id 2c918086676d3e0601677611dbde220f ` + -Type IDENTITY ` + -Name Mister Manager ` + -Email mr.manager@example.com +``` + +- Convert the resource to JSON +```powershell +$CampaignTemplateOwnerRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CancelAccessRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CancelAccessRequest.md new file mode 100644 index 000000000..2ff7c81b2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CancelAccessRequest.md @@ -0,0 +1,37 @@ +--- +id: beta-cancel-access-request +title: CancelAccessRequest +pagination_label: CancelAccessRequest +sidebar_label: CancelAccessRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CancelAccessRequest', 'BetaCancelAccessRequest'] +slug: /tools/sdk/powershell/beta/models/cancel-access-request +tags: ['SDK', 'Software Development Kit', 'CancelAccessRequest', 'BetaCancelAccessRequest'] +--- + + +# CancelAccessRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountActivityId** | **String** | This refers to the identityRequestId. To successfully cancel an access request, you must provide the identityRequestId. | [required] +**Comment** | **String** | Reason for cancelling the pending access request. | [required] + +## Examples + +- Prepare the resource +```powershell +$CancelAccessRequest = Initialize-PSSailpoint.BetaCancelAccessRequest -AccountActivityId 2c9180835d2e5168015d32f890ca1581 ` + -Comment I requested this role by mistake. +``` + +- Convert the resource to JSON +```powershell +$CancelAccessRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CancelableAccountActivity.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CancelableAccountActivity.md new file mode 100644 index 000000000..fdbf96044 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CancelableAccountActivity.md @@ -0,0 +1,65 @@ +--- +id: beta-cancelable-account-activity +title: CancelableAccountActivity +pagination_label: CancelableAccountActivity +sidebar_label: CancelableAccountActivity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CancelableAccountActivity', 'BetaCancelableAccountActivity'] +slug: /tools/sdk/powershell/beta/models/cancelable-account-activity +tags: ['SDK', 'Software Development Kit', 'CancelableAccountActivity', 'BetaCancelableAccountActivity'] +--- + + +# CancelableAccountActivity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the account activity itself | [optional] +**Name** | Pointer to **String** | | [optional] +**Created** | Pointer to **System.DateTime** | | [optional] +**Modified** | Pointer to **System.DateTime** | | [optional] +**Completed** | Pointer to **System.DateTime** | | [optional] +**CompletionStatus** | Pointer to [**CompletionStatus**](completion-status) | | [optional] +**Type** | Pointer to **String** | | [optional] +**RequesterIdentitySummary** | Pointer to [**IdentitySummary**](identity-summary) | | [optional] +**TargetIdentitySummary** | Pointer to [**IdentitySummary**](identity-summary) | | [optional] +**Errors** | Pointer to **[]String** | | [optional] +**Warnings** | Pointer to **[]String** | | [optional] +**Items** | Pointer to [**[]AccountActivityItem**](account-activity-item) | | [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] +**Cancelable** | Pointer to **Boolean** | Whether the account activity can be canceled before completion | [optional] +**CancelComment** | Pointer to [**Comment**](comment) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CancelableAccountActivity = Initialize-PSSailpoint.BetaCancelableAccountActivity -Id 2c9180835d2e5168015d32f890ca1581 ` + -Name 2c9180835d2e5168015d32f890ca1581 ` + -Created 2017-07-11T18:45:37.098Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Completed 2018-10-19T13:49:37.385Z ` + -CompletionStatus null ` + -Type appRequest ` + -RequesterIdentitySummary null ` + -TargetIdentitySummary null ` + -Errors [sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds.] ` + -Warnings null ` + -Items null ` + -ExecutionStatus null ` + -ClientMetadata null ` + -Cancelable null ` + -CancelComment null +``` + +- Convert the resource to JSON +```powershell +$CancelableAccountActivity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CancelledRequestDetails.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CancelledRequestDetails.md new file mode 100644 index 000000000..6774b677e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CancelledRequestDetails.md @@ -0,0 +1,39 @@ +--- +id: beta-cancelled-request-details +title: CancelledRequestDetails +pagination_label: CancelledRequestDetails +sidebar_label: CancelledRequestDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CancelledRequestDetails', 'BetaCancelledRequestDetails'] +slug: /tools/sdk/powershell/beta/models/cancelled-request-details +tags: ['SDK', 'Software Development Kit', 'CancelledRequestDetails', 'BetaCancelledRequestDetails'] +--- + + +# CancelledRequestDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment made by the owner when cancelling the associated request. | [optional] +**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**Modified** | Pointer to **System.DateTime** | Date comment was added by the owner when cancelling the associated request. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CancelledRequestDetails = Initialize-PSSailpoint.BetaCancelledRequestDetails -Comment This request must be cancelled. ` + -Owner null ` + -Modified 2019-12-20T09:17:12.192Z +``` + +- Convert the resource to JSON +```powershell +$CancelledRequestDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CertificationDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CertificationDto.md new file mode 100644 index 000000000..f03542e16 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CertificationDto.md @@ -0,0 +1,59 @@ +--- +id: beta-certification-dto +title: CertificationDto +pagination_label: CertificationDto +sidebar_label: CertificationDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationDto', 'BetaCertificationDto'] +slug: /tools/sdk/powershell/beta/models/certification-dto +tags: ['SDK', 'Software Development Kit', 'CertificationDto', 'BetaCertificationDto'] +--- + + +# CertificationDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CampaignRef** | [**CampaignReference**](campaign-reference) | | [required] +**Phase** | [**CertificationPhase**](certification-phase) | | [required] +**Due** | **System.DateTime** | The due date of the certification. | [required] +**Signed** | **System.DateTime** | The date the reviewer signed off on the certification. | [required] +**Reviewer** | [**Reviewer**](reviewer) | | [required] +**Reassignment** | Pointer to [**Reassignment**](reassignment) | | [optional] +**HasErrors** | **Boolean** | Indicates it the certification has any errors. | [required] +**ErrorMessage** | Pointer to **String** | A message indicating what the error is. | [optional] +**Completed** | **Boolean** | Indicates if all certification decisions have been made. | [required] +**DecisionsMade** | **Int32** | The number of approve/revoke/acknowledge decisions that have been made by the reviewer. | [required] +**DecisionsTotal** | **Int32** | The total number of approve/revoke/acknowledge decisions for the certification. | [required] +**EntitiesCompleted** | **Int32** | The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. | [required] +**EntitiesTotal** | **Int32** | The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | [required] + +## Examples + +- Prepare the resource +```powershell +$CertificationDto = Initialize-PSSailpoint.BetaCertificationDto -CampaignRef null ` + -Phase null ` + -Due 2018-10-19T13:49:37.385Z ` + -Signed 2018-10-19T13:49:37.385Z ` + -Reviewer null ` + -Reassignment null ` + -HasErrors false ` + -ErrorMessage The certification has an error ` + -Completed false ` + -DecisionsMade 20 ` + -DecisionsTotal 40 ` + -EntitiesCompleted 5 ` + -EntitiesTotal 10 +``` + +- Convert the resource to JSON +```powershell +$CertificationDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CertificationPhase.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CertificationPhase.md new file mode 100644 index 000000000..229cf952e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CertificationPhase.md @@ -0,0 +1,26 @@ +--- +id: beta-certification-phase +title: CertificationPhase +pagination_label: CertificationPhase +sidebar_label: CertificationPhase +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationPhase', 'BetaCertificationPhase'] +slug: /tools/sdk/powershell/beta/models/certification-phase +tags: ['SDK', 'Software Development Kit', 'CertificationPhase', 'BetaCertificationPhase'] +--- + + +# CertificationPhase + +## Enum + + +* `STAGED` (value: `"STAGED"`) + +* `ACTIVE` (value: `"ACTIVE"`) + +* `SIGNED` (value: `"SIGNED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CertificationReference.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CertificationReference.md new file mode 100644 index 000000000..c642c7535 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CertificationReference.md @@ -0,0 +1,41 @@ +--- +id: beta-certification-reference +title: CertificationReference +pagination_label: CertificationReference +sidebar_label: CertificationReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationReference', 'BetaCertificationReference'] +slug: /tools/sdk/powershell/beta/models/certification-reference +tags: ['SDK', 'Software Development Kit', 'CertificationReference', 'BetaCertificationReference'] +--- + + +# CertificationReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "CERTIFICATION" ] | DTO type of certification for review. | [optional] +**Id** | Pointer to **String** | ID of certification for review. | [optional] +**Name** | Pointer to **String** | Display name of certification for review. | [optional] +**Reviewer** | Pointer to [**Reviewer**](reviewer) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CertificationReference = Initialize-PSSailpoint.BetaCertificationReference -Type IDENTITY ` + -Id 7589a83cec4b4f138ce56c1a5ef0756d ` + -Name Manager Access for Michael Michaels ` + -Reviewer null +``` + +- Convert the resource to JSON +```powershell +$CertificationReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CertificationReferenceDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CertificationReferenceDto.md new file mode 100644 index 000000000..9fbe20409 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CertificationReferenceDto.md @@ -0,0 +1,39 @@ +--- +id: beta-certification-reference-dto +title: CertificationReferenceDto +pagination_label: CertificationReferenceDto +sidebar_label: CertificationReferenceDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationReferenceDto', 'BetaCertificationReferenceDto'] +slug: /tools/sdk/powershell/beta/models/certification-reference-dto +tags: ['SDK', 'Software Development Kit', 'CertificationReferenceDto', 'BetaCertificationReferenceDto'] +--- + + +# CertificationReferenceDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "CERTIFICATION" ] | DTO type of certification for review. | [optional] +**Id** | Pointer to **String** | ID of certification for review. | [optional] +**Name** | Pointer to **String** | Display name of certification for review. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CertificationReferenceDto = Initialize-PSSailpoint.BetaCertificationReferenceDto -Type IDENTITY ` + -Id 7589a83cec4b4f138ce56c1a5ef0756d ` + -Name Manager Access for Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$CertificationReferenceDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CertificationSignedOff.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CertificationSignedOff.md new file mode 100644 index 000000000..081c8efe7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CertificationSignedOff.md @@ -0,0 +1,35 @@ +--- +id: beta-certification-signed-off +title: CertificationSignedOff +pagination_label: CertificationSignedOff +sidebar_label: CertificationSignedOff +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationSignedOff', 'BetaCertificationSignedOff'] +slug: /tools/sdk/powershell/beta/models/certification-signed-off +tags: ['SDK', 'Software Development Kit', 'CertificationSignedOff', 'BetaCertificationSignedOff'] +--- + + +# CertificationSignedOff + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Certification** | [**CertificationSignedOffCertification**](certification-signed-off-certification) | | [required] + +## Examples + +- Prepare the resource +```powershell +$CertificationSignedOff = Initialize-PSSailpoint.BetaCertificationSignedOff -Certification null +``` + +- Convert the resource to JSON +```powershell +$CertificationSignedOff | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CertificationSignedOffCertification.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CertificationSignedOffCertification.md new file mode 100644 index 000000000..4d6a2a87e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CertificationSignedOffCertification.md @@ -0,0 +1,67 @@ +--- +id: beta-certification-signed-off-certification +title: CertificationSignedOffCertification +pagination_label: CertificationSignedOffCertification +sidebar_label: CertificationSignedOffCertification +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationSignedOffCertification', 'BetaCertificationSignedOffCertification'] +slug: /tools/sdk/powershell/beta/models/certification-signed-off-certification +tags: ['SDK', 'Software Development Kit', 'CertificationSignedOffCertification', 'BetaCertificationSignedOffCertification'] +--- + + +# CertificationSignedOffCertification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Unique ID of the certification. | [required] +**Name** | **String** | The name of the certification. | [required] +**Created** | **System.DateTime** | The date and time the certification was created. | [required] +**Modified** | Pointer to **System.DateTime** | The date and time the certification was last modified. | [optional] +**CampaignRef** | [**CampaignReference**](campaign-reference) | | [required] +**Phase** | [**CertificationPhase**](certification-phase) | | [required] +**Due** | **System.DateTime** | The due date of the certification. | [required] +**Signed** | **System.DateTime** | The date the reviewer signed off on the certification. | [required] +**Reviewer** | [**Reviewer**](reviewer) | | [required] +**Reassignment** | Pointer to [**Reassignment**](reassignment) | | [optional] +**HasErrors** | **Boolean** | Indicates it the certification has any errors. | [required] +**ErrorMessage** | Pointer to **String** | A message indicating what the error is. | [optional] +**Completed** | **Boolean** | Indicates if all certification decisions have been made. | [required] +**DecisionsMade** | **Int32** | The number of approve/revoke/acknowledge decisions that have been made by the reviewer. | [required] +**DecisionsTotal** | **Int32** | The total number of approve/revoke/acknowledge decisions for the certification. | [required] +**EntitiesCompleted** | **Int32** | The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. | [required] +**EntitiesTotal** | **Int32** | The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | [required] + +## Examples + +- Prepare the resource +```powershell +$CertificationSignedOffCertification = Initialize-PSSailpoint.BetaCertificationSignedOffCertification -Id 2c91808576f886190176f88caf0d0067 ` + -Name Manager Access Review for Alice Baker ` + -Created 2020-02-16T03:04:45.815Z ` + -Modified 2020-02-16T03:06:45.815Z ` + -CampaignRef null ` + -Phase null ` + -Due 2018-10-19T13:49:37.385Z ` + -Signed 2018-10-19T13:49:37.385Z ` + -Reviewer null ` + -Reassignment null ` + -HasErrors false ` + -ErrorMessage The certification has an error ` + -Completed false ` + -DecisionsMade 20 ` + -DecisionsTotal 40 ` + -EntitiesCompleted 5 ` + -EntitiesTotal 10 +``` + +- Convert the resource to JSON +```powershell +$CertificationSignedOffCertification | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CertificationTask.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CertificationTask.md new file mode 100644 index 000000000..7eb6a7581 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CertificationTask.md @@ -0,0 +1,47 @@ +--- +id: beta-certification-task +title: CertificationTask +pagination_label: CertificationTask +sidebar_label: CertificationTask +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationTask', 'BetaCertificationTask'] +slug: /tools/sdk/powershell/beta/models/certification-task +tags: ['SDK', 'Software Development Kit', 'CertificationTask', 'BetaCertificationTask'] +--- + + +# CertificationTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of the certification task. | [optional] +**Type** | Pointer to **Enum** [ "REASSIGN", "ADMIN_REASSIGN", "COMPLETE_CERTIFICATION", "FINISH_CERTIFICATION", "COMPLETE_CAMPAIGN", "ACTIVATE_CAMPAIGN", "CAMPAIGN_CREATE", "CAMPAIGN_DELETE" ] | The type of the certification task. More values may be added in the future. | [optional] +**TargetType** | Pointer to **Enum** [ "CERTIFICATION", "CAMPAIGN" ] | The type of item that is being operated on by this task whose ID is stored in the targetId field. | [optional] +**TargetId** | Pointer to **String** | The ID of the item being operated on by this task. | [optional] +**Status** | Pointer to **Enum** [ "QUEUED", "IN_PROGRESS", "SUCCESS", "ERROR" ] | The status of the task. | [optional] +**Errors** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | | [optional] +**Created** | Pointer to **System.DateTime** | The date and time on which this task was created. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CertificationTask = Initialize-PSSailpoint.BetaCertificationTask -Id 2c918086719eec070171a7e3355a360a ` + -Type ADMIN_REASSIGN ` + -TargetType CAMPAIGN ` + -TargetId 2c918086719eec070171a7e3355a834c ` + -Status null ` + -Errors null ` + -Created 2020-09-24T18:10:47.693Z +``` + +- Convert the resource to JSON +```powershell +$CertificationTask | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CertifierResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CertifierResponse.md new file mode 100644 index 000000000..ade31370d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CertifierResponse.md @@ -0,0 +1,37 @@ +--- +id: beta-certifier-response +title: CertifierResponse +pagination_label: CertifierResponse +sidebar_label: CertifierResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertifierResponse', 'BetaCertifierResponse'] +slug: /tools/sdk/powershell/beta/models/certifier-response +tags: ['SDK', 'Software Development Kit', 'CertifierResponse', 'BetaCertifierResponse'] +--- + + +# CertifierResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | the id of the certifier | [optional] +**DisplayName** | Pointer to **String** | the name of the certifier | [optional] + +## Examples + +- Prepare the resource +```powershell +$CertifierResponse = Initialize-PSSailpoint.BetaCertifierResponse -Id 8a80828f643d484f01643e14202e206f ` + -DisplayName John Snow +``` + +- Convert the resource to JSON +```powershell +$CertifierResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Children.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Children.md new file mode 100644 index 000000000..631c1346e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Children.md @@ -0,0 +1,41 @@ +--- +id: beta-children +title: Children +pagination_label: Children +sidebar_label: Children +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Children', 'BetaChildren'] +slug: /tools/sdk/powershell/beta/models/children +tags: ['SDK', 'Software Development Kit', 'Children', 'BetaChildren'] +--- + + +# Children + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operator** | Pointer to **String** | | [optional] +**Attribute** | Pointer to **String** | | [optional] +**Value** | Pointer to [**Value**](value) | | [optional] +**Children** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Children = Initialize-PSSailpoint.BetaChildren -Operator EQUALS ` + -Attribute country ` + -Value null ` + -Children null +``` + +- Convert the resource to JSON +```powershell +$Children | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ClientLogConfiguration.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ClientLogConfiguration.md new file mode 100644 index 000000000..53346e11f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ClientLogConfiguration.md @@ -0,0 +1,43 @@ +--- +id: beta-client-log-configuration +title: ClientLogConfiguration +pagination_label: ClientLogConfiguration +sidebar_label: ClientLogConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ClientLogConfiguration', 'BetaClientLogConfiguration'] +slug: /tools/sdk/powershell/beta/models/client-log-configuration +tags: ['SDK', 'Software Development Kit', 'ClientLogConfiguration', 'BetaClientLogConfiguration'] +--- + + +# ClientLogConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClientId** | Pointer to **String** | Log configuration's client ID | [optional] +**DurationMinutes** | **Int32** | Duration in minutes for log configuration to remain in effect before resetting to defaults | [required] +**Expiration** | Pointer to **System.DateTime** | Expiration date-time of the log configuration request | [optional] +**RootLevel** | [**StandardLevel**](standard-level) | | [required] +**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] + +## Examples + +- Prepare the resource +```powershell +$ClientLogConfiguration = Initialize-PSSailpoint.BetaClientLogConfiguration -ClientId aClientId ` + -DurationMinutes 120 ` + -Expiration 2020-12-15T19:13:36.079Z ` + -RootLevel null ` + -LogLevels INFO +``` + +- Convert the resource to JSON +```powershell +$ClientLogConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ClientType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ClientType.md new file mode 100644 index 000000000..3c69fcb9b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ClientType.md @@ -0,0 +1,24 @@ +--- +id: beta-client-type +title: ClientType +pagination_label: ClientType +sidebar_label: ClientType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ClientType', 'BetaClientType'] +slug: /tools/sdk/powershell/beta/models/client-type +tags: ['SDK', 'Software Development Kit', 'ClientType', 'BetaClientType'] +--- + + +# ClientType + +## Enum + + +* `CONFIDENTIAL` (value: `"CONFIDENTIAL"`) + +* `PUBLIC` (value: `"PUBLIC"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CloseAccessRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CloseAccessRequest.md new file mode 100644 index 000000000..9a3f49e8a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CloseAccessRequest.md @@ -0,0 +1,41 @@ +--- +id: beta-close-access-request +title: CloseAccessRequest +pagination_label: CloseAccessRequest +sidebar_label: CloseAccessRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CloseAccessRequest', 'BetaCloseAccessRequest'] +slug: /tools/sdk/powershell/beta/models/close-access-request +tags: ['SDK', 'Software Development Kit', 'CloseAccessRequest', 'BetaCloseAccessRequest'] +--- + + +# CloseAccessRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestIds** | **[]String** | Access Request IDs for the requests to be closed. Accepts 1-500 Identity Request IDs per request. | [required] +**Message** | Pointer to **String** | Reason for closing the access request. Displayed under Warnings in IdentityNow. | [optional] [default to "The IdentityNow Administrator manually closed this request."] +**ExecutionStatus** | Pointer to **Enum** [ "Terminated", "Completed" ] | The request's provisioning status. Displayed as Stage in IdentityNow. | [optional] [default to "Terminated"] +**CompletionStatus** | Pointer to **Enum** [ "Success", "Incomplete", "Failure" ] | The request's overall status. Displayed as Status in IdentityNow. | [optional] [default to "Failure"] + +## Examples + +- Prepare the resource +```powershell +$CloseAccessRequest = Initialize-PSSailpoint.BetaCloseAccessRequest -AccessRequestIds [2c90ad2a70ace7d50170acf22ca90010] ` + -Message The IdentityNow Administrator manually closed this request. ` + -ExecutionStatus Terminated ` + -CompletionStatus Failure +``` + +- Convert the resource to JSON +```powershell +$CloseAccessRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Comment.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Comment.md new file mode 100644 index 000000000..ad6c5b8cd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Comment.md @@ -0,0 +1,41 @@ +--- +id: beta-comment +title: Comment +pagination_label: Comment +sidebar_label: Comment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Comment', 'BetaComment'] +slug: /tools/sdk/powershell/beta/models/comment +tags: ['SDK', 'Software Development Kit', 'Comment', 'BetaComment'] +--- + + +# Comment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommenterId** | Pointer to **String** | Id of the identity making the comment | [optional] +**CommenterName** | Pointer to **String** | Human-readable display name of the identity making the comment | [optional] +**Body** | Pointer to **String** | Content of the comment | [optional] +**Date** | Pointer to **System.DateTime** | Date and time comment was made | [optional] + +## Examples + +- Prepare the resource +```powershell +$Comment = Initialize-PSSailpoint.BetaComment -CommenterId 2c918084660f45d6016617daa9210584 ` + -CommenterName Adam Kennedy ` + -Body Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat. ` + -Date 2017-07-11T18:45:37.098Z +``` + +- Convert the resource to JSON +```powershell +$Comment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommentDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommentDto.md new file mode 100644 index 000000000..2fee3e200 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommentDto.md @@ -0,0 +1,39 @@ +--- +id: beta-comment-dto +title: CommentDto +pagination_label: CommentDto +sidebar_label: CommentDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CommentDto', 'BetaCommentDto'] +slug: /tools/sdk/powershell/beta/models/comment-dto +tags: ['SDK', 'Software Development Kit', 'CommentDto', 'BetaCommentDto'] +--- + + +# CommentDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment content. | [optional] +**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] +**Created** | Pointer to **System.DateTime** | Date and time comment was created. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CommentDto = Initialize-PSSailpoint.BetaCommentDto -Comment This is a comment. ` + -Author null ` + -Created 2017-07-11T18:45:37.098Z +``` + +- Convert the resource to JSON +```powershell +$CommentDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommentDto1.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommentDto1.md new file mode 100644 index 000000000..bf61032ea --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommentDto1.md @@ -0,0 +1,39 @@ +--- +id: beta-comment-dto1 +title: CommentDto1 +pagination_label: CommentDto1 +sidebar_label: CommentDto1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CommentDto1', 'BetaCommentDto1'] +slug: /tools/sdk/powershell/beta/models/comment-dto1 +tags: ['SDK', 'Software Development Kit', 'CommentDto1', 'BetaCommentDto1'] +--- + + +# CommentDto1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment content. | [optional] +**Created** | Pointer to **System.DateTime** | Date and time comment was created. | [optional] +**Author** | Pointer to [**CommentDto1Author**](comment-dto1-author) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CommentDto1 = Initialize-PSSailpoint.BetaCommentDto1 -Comment This is a comment. ` + -Created 2017-07-11T18:45:37.098Z ` + -Author null +``` + +- Convert the resource to JSON +```powershell +$CommentDto1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommentDto1Author.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommentDto1Author.md new file mode 100644 index 000000000..591fb0a24 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommentDto1Author.md @@ -0,0 +1,39 @@ +--- +id: beta-comment-dto1-author +title: CommentDto1Author +pagination_label: CommentDto1Author +sidebar_label: CommentDto1Author +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CommentDto1Author', 'BetaCommentDto1Author'] +slug: /tools/sdk/powershell/beta/models/comment-dto1-author +tags: ['SDK', 'Software Development Kit', 'CommentDto1Author', 'BetaCommentDto1Author'] +--- + + +# CommentDto1Author + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of object | [optional] +**Id** | Pointer to **String** | The unique ID of the object | [optional] +**Name** | Pointer to **String** | The display name of the object | [optional] + +## Examples + +- Prepare the resource +```powershell +$CommentDto1Author = Initialize-PSSailpoint.BetaCommentDto1Author -Type IDENTITY ` + -Id 2c9180847e25f377017e2ae8cae4650b ` + -Name john.doe +``` + +- Convert the resource to JSON +```powershell +$CommentDto1Author | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommentDtoAuthor.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommentDtoAuthor.md new file mode 100644 index 000000000..86ff7b2ce --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommentDtoAuthor.md @@ -0,0 +1,39 @@ +--- +id: beta-comment-dto-author +title: CommentDtoAuthor +pagination_label: CommentDtoAuthor +sidebar_label: CommentDtoAuthor +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CommentDtoAuthor', 'BetaCommentDtoAuthor'] +slug: /tools/sdk/powershell/beta/models/comment-dto-author +tags: ['SDK', 'Software Development Kit', 'CommentDtoAuthor', 'BetaCommentDtoAuthor'] +--- + + +# CommentDtoAuthor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | DTO type of the commenting identity. | [optional] +**Id** | Pointer to **String** | ID of the commenting identity. | [optional] +**Name** | Pointer to **String** | Display name of the commenting identity. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CommentDtoAuthor = Initialize-PSSailpoint.BetaCommentDtoAuthor -Type IDENTITY ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name Adam Kennedy +``` + +- Convert the resource to JSON +```powershell +$CommentDtoAuthor | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommonAccessIDStatus.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommonAccessIDStatus.md new file mode 100644 index 000000000..18d58a024 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommonAccessIDStatus.md @@ -0,0 +1,37 @@ +--- +id: beta-common-access-id-status +title: CommonAccessIDStatus +pagination_label: CommonAccessIDStatus +sidebar_label: CommonAccessIDStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CommonAccessIDStatus', 'BetaCommonAccessIDStatus'] +slug: /tools/sdk/powershell/beta/models/common-access-id-status +tags: ['SDK', 'Software Development Kit', 'CommonAccessIDStatus', 'BetaCommonAccessIDStatus'] +--- + + +# CommonAccessIDStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConfirmedIds** | Pointer to **[]String** | List of confirmed common access ids. | [optional] +**DeniedIds** | Pointer to **[]String** | List of denied common access ids. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CommonAccessIDStatus = Initialize-PSSailpoint.BetaCommonAccessIDStatus -ConfirmedIds null ` + -DeniedIds null +``` + +- Convert the resource to JSON +```powershell +$CommonAccessIDStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommonAccessItemAccess.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommonAccessItemAccess.md new file mode 100644 index 000000000..a20d643db --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommonAccessItemAccess.md @@ -0,0 +1,45 @@ +--- +id: beta-common-access-item-access +title: CommonAccessItemAccess +pagination_label: CommonAccessItemAccess +sidebar_label: CommonAccessItemAccess +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CommonAccessItemAccess', 'BetaCommonAccessItemAccess'] +slug: /tools/sdk/powershell/beta/models/common-access-item-access +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemAccess', 'BetaCommonAccessItemAccess'] +--- + + +# CommonAccessItemAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Common access ID | [optional] +**Type** | Pointer to [**CommonAccessType**](common-access-type) | | [optional] +**Name** | Pointer to **String** | Common access name | [optional] +**Description** | Pointer to **String** | Common access description | [optional] +**OwnerName** | Pointer to **String** | Common access owner name | [optional] +**OwnerId** | Pointer to **String** | Common access owner ID | [optional] + +## Examples + +- Prepare the resource +```powershell +$CommonAccessItemAccess = Initialize-PSSailpoint.BetaCommonAccessItemAccess -Id null ` + -Type null ` + -Name null ` + -Description null ` + -OwnerName null ` + -OwnerId null +``` + +- Convert the resource to JSON +```powershell +$CommonAccessItemAccess | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommonAccessItemRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommonAccessItemRequest.md new file mode 100644 index 000000000..5948f1c94 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommonAccessItemRequest.md @@ -0,0 +1,37 @@ +--- +id: beta-common-access-item-request +title: CommonAccessItemRequest +pagination_label: CommonAccessItemRequest +sidebar_label: CommonAccessItemRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CommonAccessItemRequest', 'BetaCommonAccessItemRequest'] +slug: /tools/sdk/powershell/beta/models/common-access-item-request +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemRequest', 'BetaCommonAccessItemRequest'] +--- + + +# CommonAccessItemRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Access** | Pointer to [**CommonAccessItemAccess**](common-access-item-access) | | [optional] +**Status** | Pointer to [**CommonAccessItemState**](common-access-item-state) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CommonAccessItemRequest = Initialize-PSSailpoint.BetaCommonAccessItemRequest -Access null ` + -Status null +``` + +- Convert the resource to JSON +```powershell +$CommonAccessItemRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommonAccessItemResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommonAccessItemResponse.md new file mode 100644 index 000000000..c535f1b8c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommonAccessItemResponse.md @@ -0,0 +1,47 @@ +--- +id: beta-common-access-item-response +title: CommonAccessItemResponse +pagination_label: CommonAccessItemResponse +sidebar_label: CommonAccessItemResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CommonAccessItemResponse', 'BetaCommonAccessItemResponse'] +slug: /tools/sdk/powershell/beta/models/common-access-item-response +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemResponse', 'BetaCommonAccessItemResponse'] +--- + + +# CommonAccessItemResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Common Access Item ID | [optional] +**Access** | Pointer to [**CommonAccessItemAccess**](common-access-item-access) | | [optional] +**Status** | Pointer to [**CommonAccessItemState**](common-access-item-state) | | [optional] +**LastUpdated** | Pointer to **String** | | [optional] +**ReviewedByUser** | Pointer to **Boolean** | | [optional] +**LastReviewed** | Pointer to **String** | | [optional] +**CreatedByUser** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CommonAccessItemResponse = Initialize-PSSailpoint.BetaCommonAccessItemResponse -Id null ` + -Access null ` + -Status null ` + -LastUpdated null ` + -ReviewedByUser null ` + -LastReviewed null ` + -CreatedByUser null +``` + +- Convert the resource to JSON +```powershell +$CommonAccessItemResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommonAccessItemState.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommonAccessItemState.md new file mode 100644 index 000000000..9b84555d9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommonAccessItemState.md @@ -0,0 +1,24 @@ +--- +id: beta-common-access-item-state +title: CommonAccessItemState +pagination_label: CommonAccessItemState +sidebar_label: CommonAccessItemState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CommonAccessItemState', 'BetaCommonAccessItemState'] +slug: /tools/sdk/powershell/beta/models/common-access-item-state +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemState', 'BetaCommonAccessItemState'] +--- + + +# CommonAccessItemState + +## Enum + + +* `CONFIRMED` (value: `"CONFIRMED"`) + +* `DENIED` (value: `"DENIED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommonAccessResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommonAccessResponse.md new file mode 100644 index 000000000..3e9f78ecc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommonAccessResponse.md @@ -0,0 +1,49 @@ +--- +id: beta-common-access-response +title: CommonAccessResponse +pagination_label: CommonAccessResponse +sidebar_label: CommonAccessResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CommonAccessResponse', 'BetaCommonAccessResponse'] +slug: /tools/sdk/powershell/beta/models/common-access-response +tags: ['SDK', 'Software Development Kit', 'CommonAccessResponse', 'BetaCommonAccessResponse'] +--- + + +# CommonAccessResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Unique ID of the common access item | [optional] +**Access** | Pointer to [**CommonAccessItemAccess**](common-access-item-access) | | [optional] +**Status** | Pointer to **String** | CONFIRMED or DENIED | [optional] +**CommonAccessType** | Pointer to **String** | | [optional] +**LastUpdated** | Pointer to **System.DateTime** | | [optional] [readonly] +**ReviewedByUser** | Pointer to **Boolean** | true if user has confirmed or denied status | [optional] +**LastReviewed** | Pointer to **System.DateTime** | | [optional] [readonly] +**CreatedByUser** | Pointer to **Boolean** | | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$CommonAccessResponse = Initialize-PSSailpoint.BetaCommonAccessResponse -Id 555ab47a-0d32-4813-906f-adf3567de6a4 ` + -Access null ` + -Status null ` + -CommonAccessType UNSET ` + -LastUpdated null ` + -ReviewedByUser null ` + -LastReviewed null ` + -CreatedByUser false +``` + +- Convert the resource to JSON +```powershell +$CommonAccessResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommonAccessType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommonAccessType.md new file mode 100644 index 000000000..26ae2521d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CommonAccessType.md @@ -0,0 +1,24 @@ +--- +id: beta-common-access-type +title: CommonAccessType +pagination_label: CommonAccessType +sidebar_label: CommonAccessType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CommonAccessType', 'BetaCommonAccessType'] +slug: /tools/sdk/powershell/beta/models/common-access-type +tags: ['SDK', 'Software Development Kit', 'CommonAccessType', 'BetaCommonAccessType'] +--- + + +# CommonAccessType + +## Enum + + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ROLE` (value: `"ROLE"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CompleteCampaignOptions.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CompleteCampaignOptions.md new file mode 100644 index 000000000..a6a06bdb7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CompleteCampaignOptions.md @@ -0,0 +1,35 @@ +--- +id: beta-complete-campaign-options +title: CompleteCampaignOptions +pagination_label: CompleteCampaignOptions +sidebar_label: CompleteCampaignOptions +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CompleteCampaignOptions', 'BetaCompleteCampaignOptions'] +slug: /tools/sdk/powershell/beta/models/complete-campaign-options +tags: ['SDK', 'Software Development Kit', 'CompleteCampaignOptions', 'BetaCompleteCampaignOptions'] +--- + + +# CompleteCampaignOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AutoCompleteAction** | Pointer to **Enum** [ "APPROVE", "REVOKE" ] | Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion. | [optional] [default to "APPROVE"] + +## Examples + +- Prepare the resource +```powershell +$CompleteCampaignOptions = Initialize-PSSailpoint.BetaCompleteCampaignOptions -AutoCompleteAction REVOKE +``` + +- Convert the resource to JSON +```powershell +$CompleteCampaignOptions | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CompleteInvocation.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CompleteInvocation.md new file mode 100644 index 000000000..b43308019 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CompleteInvocation.md @@ -0,0 +1,39 @@ +--- +id: beta-complete-invocation +title: CompleteInvocation +pagination_label: CompleteInvocation +sidebar_label: CompleteInvocation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CompleteInvocation', 'BetaCompleteInvocation'] +slug: /tools/sdk/powershell/beta/models/complete-invocation +tags: ['SDK', 'Software Development Kit', 'CompleteInvocation', 'BetaCompleteInvocation'] +--- + + +# CompleteInvocation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Secret** | **String** | Unique invocation secret that was generated when the invocation was created. Required to authenticate to the endpoint. | [required] +**VarError** | Pointer to **String** | The error message to indicate a failed invocation or error if any. | [optional] +**Output** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Trigger output to complete the invocation. Its schema is defined in the trigger definition. | [required] + +## Examples + +- Prepare the resource +```powershell +$CompleteInvocation = Initialize-PSSailpoint.BetaCompleteInvocation -Secret 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -VarError Access request is denied. ` + -Output {approved=false} +``` + +- Convert the resource to JSON +```powershell +$CompleteInvocation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CompleteInvocationInput.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CompleteInvocationInput.md new file mode 100644 index 000000000..4e2c94e90 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CompleteInvocationInput.md @@ -0,0 +1,37 @@ +--- +id: beta-complete-invocation-input +title: CompleteInvocationInput +pagination_label: CompleteInvocationInput +sidebar_label: CompleteInvocationInput +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CompleteInvocationInput', 'BetaCompleteInvocationInput'] +slug: /tools/sdk/powershell/beta/models/complete-invocation-input +tags: ['SDK', 'Software Development Kit', 'CompleteInvocationInput', 'BetaCompleteInvocationInput'] +--- + + +# CompleteInvocationInput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LocalizedError** | Pointer to [**LocalizedMessage**](localized-message) | | [optional] +**Output** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Trigger output that completed the invocation. Its schema is defined in the trigger definition. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CompleteInvocationInput = Initialize-PSSailpoint.BetaCompleteInvocationInput -LocalizedError null ` + -Output {approved=false} +``` + +- Convert the resource to JSON +```powershell +$CompleteInvocationInput | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CompletedApproval.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CompletedApproval.md new file mode 100644 index 000000000..f02a95ff9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CompletedApproval.md @@ -0,0 +1,79 @@ +--- +id: beta-completed-approval +title: CompletedApproval +pagination_label: CompletedApproval +sidebar_label: CompletedApproval +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CompletedApproval', 'BetaCompletedApproval'] +slug: /tools/sdk/powershell/beta/models/completed-approval +tags: ['SDK', 'Software Development Kit', 'CompletedApproval', 'BetaCompletedApproval'] +--- + + +# CompletedApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The approval id. | [optional] +**Name** | Pointer to **String** | The name of the approval. | [optional] +**Created** | Pointer to **System.DateTime** | When the approval was created. | [optional] +**Modified** | Pointer to **System.DateTime** | When the approval was modified last time. | [optional] +**RequestCreated** | Pointer to **System.DateTime** | When the access-request was created. | [optional] +**RequestType** | Pointer to [**AccessRequestType**](access-request-type) | | [optional] +**Requester** | Pointer to [**AccessItemRequesterDto**](access-item-requester-dto) | | [optional] +**RequestedFor** | Pointer to [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] +**ReviewedBy** | Pointer to [**CompletedApprovalReviewedBy**](completed-approval-reviewed-by) | | [optional] +**Owner** | Pointer to [**AccessItemOwnerDto**](access-item-owner-dto) | | [optional] +**RequestedObject** | Pointer to [**RequestableObjectReference**](requestable-object-reference) | | [optional] +**RequesterComment** | Pointer to [**CommentDto1**](comment-dto1) | | [optional] +**ReviewerComment** | Pointer to [**CommentDto**](comment-dto) | The approval's reviewer's comment. | [optional] +**PreviousReviewersComments** | Pointer to [**[]CommentDto1**](comment-dto1) | The history of the previous reviewers comments. | [optional] +**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] +**CommentRequiredWhenRejected** | Pointer to **Boolean** | When true the rejector has to provide comments when rejecting | [optional] [default to $false] +**State** | Pointer to [**CompletedApprovalState**](completed-approval-state) | | [optional] +**RemoveDate** | Pointer to **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +**RemoveDateUpdateRequested** | Pointer to **Boolean** | If true, then the request was to change the remove date or sunset date. | [optional] [default to $false] +**CurrentRemoveDate** | Pointer to **System.DateTime** | The remove date or sunset date that was assigned at the time of the request. | [optional] +**SodViolationContext** | Pointer to [**SodViolationContextCheckCompleted1**](sod-violation-context-check-completed1) | | [optional] +**PreApprovalTriggerResult** | Pointer to [**CompletedApprovalPreApprovalTriggerResult**](completed-approval-pre-approval-trigger-result) | | [optional] +**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs provided during the request. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CompletedApproval = Initialize-PSSailpoint.BetaCompletedApproval -Id 2c938083633d259901633d25c68c00fa ` + -Name Approval Name ` + -Created 2017-07-11T18:45:37.098Z ` + -Modified 2018-07-25T20:22:28.104Z ` + -RequestCreated 2017-07-11T18:45:35.098Z ` + -RequestType null ` + -Requester null ` + -RequestedFor null ` + -ReviewedBy null ` + -Owner null ` + -RequestedObject null ` + -RequesterComment null ` + -ReviewerComment null ` + -PreviousReviewersComments null ` + -ForwardHistory null ` + -CommentRequiredWhenRejected true ` + -State null ` + -RemoveDate 2020-07-11T00:00Z ` + -RemoveDateUpdateRequested true ` + -CurrentRemoveDate 2020-07-11T00:00Z ` + -SodViolationContext null ` + -PreApprovalTriggerResult null ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} +``` + +- Convert the resource to JSON +```powershell +$CompletedApproval | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CompletedApprovalPreApprovalTriggerResult.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CompletedApprovalPreApprovalTriggerResult.md new file mode 100644 index 000000000..6ea1cd118 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CompletedApprovalPreApprovalTriggerResult.md @@ -0,0 +1,41 @@ +--- +id: beta-completed-approval-pre-approval-trigger-result +title: CompletedApprovalPreApprovalTriggerResult +pagination_label: CompletedApprovalPreApprovalTriggerResult +sidebar_label: CompletedApprovalPreApprovalTriggerResult +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CompletedApprovalPreApprovalTriggerResult', 'BetaCompletedApprovalPreApprovalTriggerResult'] +slug: /tools/sdk/powershell/beta/models/completed-approval-pre-approval-trigger-result +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalPreApprovalTriggerResult', 'BetaCompletedApprovalPreApprovalTriggerResult'] +--- + + +# CompletedApprovalPreApprovalTriggerResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | The comment from the trigger | [optional] +**Decision** | Pointer to [**CompletedApprovalState**](completed-approval-state) | | [optional] +**Reviewer** | Pointer to **String** | The name of the approver | [optional] +**Date** | Pointer to **System.DateTime** | The date and time the trigger decided on the request | [optional] + +## Examples + +- Prepare the resource +```powershell +$CompletedApprovalPreApprovalTriggerResult = Initialize-PSSailpoint.BetaCompletedApprovalPreApprovalTriggerResult -Comment This request was autoapproved by our automated ETS subscriber ` + -Decision null ` + -Reviewer Automated AR Approval ` + -Date 2022-06-07T19:18:40.748Z +``` + +- Convert the resource to JSON +```powershell +$CompletedApprovalPreApprovalTriggerResult | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CompletedApprovalReviewedBy.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CompletedApprovalReviewedBy.md new file mode 100644 index 000000000..fd8e83927 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CompletedApprovalReviewedBy.md @@ -0,0 +1,39 @@ +--- +id: beta-completed-approval-reviewed-by +title: CompletedApprovalReviewedBy +pagination_label: CompletedApprovalReviewedBy +sidebar_label: CompletedApprovalReviewedBy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CompletedApprovalReviewedBy', 'BetaCompletedApprovalReviewedBy'] +slug: /tools/sdk/powershell/beta/models/completed-approval-reviewed-by +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalReviewedBy', 'BetaCompletedApprovalReviewedBy'] +--- + + +# CompletedApprovalReviewedBy + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$CompletedApprovalReviewedBy = Initialize-PSSailpoint.BetaCompletedApprovalReviewedBy -Type IDENTITY ` + -Id 2c3780a46faadee4016fb4e018c20652 ` + -Name Allen Albertson +``` + +- Convert the resource to JSON +```powershell +$CompletedApprovalReviewedBy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CompletedApprovalState.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CompletedApprovalState.md new file mode 100644 index 000000000..f0ae37a92 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CompletedApprovalState.md @@ -0,0 +1,24 @@ +--- +id: beta-completed-approval-state +title: CompletedApprovalState +pagination_label: CompletedApprovalState +sidebar_label: CompletedApprovalState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CompletedApprovalState', 'BetaCompletedApprovalState'] +slug: /tools/sdk/powershell/beta/models/completed-approval-state +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalState', 'BetaCompletedApprovalState'] +--- + + +# CompletedApprovalState + +## Enum + + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CompletionStatus.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CompletionStatus.md new file mode 100644 index 000000000..05c6bce11 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CompletionStatus.md @@ -0,0 +1,28 @@ +--- +id: beta-completion-status +title: CompletionStatus +pagination_label: CompletionStatus +sidebar_label: CompletionStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CompletionStatus', 'BetaCompletionStatus'] +slug: /tools/sdk/powershell/beta/models/completion-status +tags: ['SDK', 'Software Development Kit', 'CompletionStatus', 'BetaCompletionStatus'] +--- + + +# CompletionStatus + +## Enum + + +* `SUCCESS` (value: `"SUCCESS"`) + +* `FAILURE` (value: `"FAILURE"`) + +* `INCOMPLETE` (value: `"INCOMPLETE"`) + +* `PENDING` (value: `"PENDING"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Concatenation.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Concatenation.md new file mode 100644 index 000000000..cf3510817 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Concatenation.md @@ -0,0 +1,39 @@ +--- +id: beta-concatenation +title: Concatenation +pagination_label: Concatenation +sidebar_label: Concatenation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Concatenation', 'BetaConcatenation'] +slug: /tools/sdk/powershell/beta/models/concatenation +tags: ['SDK', 'Software Development Kit', 'Concatenation', 'BetaConcatenation'] +--- + + +# Concatenation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Values** | [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | An array of items to join together | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$Concatenation = Initialize-PSSailpoint.BetaConcatenation -Values [John, , Smith] ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Concatenation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConditionEffect.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConditionEffect.md new file mode 100644 index 000000000..5f804d2e6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConditionEffect.md @@ -0,0 +1,37 @@ +--- +id: beta-condition-effect +title: ConditionEffect +pagination_label: ConditionEffect +sidebar_label: ConditionEffect +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConditionEffect', 'BetaConditionEffect'] +slug: /tools/sdk/powershell/beta/models/condition-effect +tags: ['SDK', 'Software Development Kit', 'ConditionEffect', 'BetaConditionEffect'] +--- + + +# ConditionEffect + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EffectType** | Pointer to **Enum** [ "HIDE", "SHOW", "DISABLE", "ENABLE", "REQUIRE", "OPTIONAL", "SUBMIT_MESSAGE", "SUBMIT_NOTIFICATION", "SET_DEFAULT_VALUE" ] | Type of effect to perform when the conditions are evaluated for this logic block. HIDE ConditionEffectTypeHide Disables validations. SHOW ConditionEffectTypeShow Enables validations. DISABLE ConditionEffectTypeDisable Disables validations. ENABLE ConditionEffectTypeEnable Enables validations. REQUIRE ConditionEffectTypeRequire OPTIONAL ConditionEffectTypeOptional SUBMIT_MESSAGE ConditionEffectTypeSubmitMessage SUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification SET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue This value is ignored on purpose. | [optional] +**Config** | Pointer to [**ConditionEffectConfig**](condition-effect-config) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConditionEffect = Initialize-PSSailpoint.BetaConditionEffect -EffectType HIDE ` + -Config null +``` + +- Convert the resource to JSON +```powershell +$ConditionEffect | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConditionEffectConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConditionEffectConfig.md new file mode 100644 index 000000000..592774df0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConditionEffectConfig.md @@ -0,0 +1,37 @@ +--- +id: beta-condition-effect-config +title: ConditionEffectConfig +pagination_label: ConditionEffectConfig +sidebar_label: ConditionEffectConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConditionEffectConfig', 'BetaConditionEffectConfig'] +slug: /tools/sdk/powershell/beta/models/condition-effect-config +tags: ['SDK', 'Software Development Kit', 'ConditionEffectConfig', 'BetaConditionEffectConfig'] +--- + + +# ConditionEffectConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DefaultValueLabel** | Pointer to **String** | Effect type's label. | [optional] +**Element** | Pointer to **String** | Element's identifier. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConditionEffectConfig = Initialize-PSSailpoint.BetaConditionEffectConfig -DefaultValueLabel Access to Remove ` + -Element 8110662963316867 +``` + +- Convert the resource to JSON +```powershell +$ConditionEffectConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConditionRule.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConditionRule.md new file mode 100644 index 000000000..0a9e3a597 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConditionRule.md @@ -0,0 +1,43 @@ +--- +id: beta-condition-rule +title: ConditionRule +pagination_label: ConditionRule +sidebar_label: ConditionRule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConditionRule', 'BetaConditionRule'] +slug: /tools/sdk/powershell/beta/models/condition-rule +tags: ['SDK', 'Software Development Kit', 'ConditionRule', 'BetaConditionRule'] +--- + + +# ConditionRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceType** | Pointer to **Enum** [ "INPUT", "ELEMENT" ] | Defines the type of object being selected. It will be either a reference to a form input (by input name) or a form element (by technical key). INPUT ConditionRuleSourceTypeInput ELEMENT ConditionRuleSourceTypeElement | [optional] +**Source** | Pointer to **String** | Source - if the sourceType is ConditionRuleSourceTypeInput, the source type is the name of the form input to accept. However, if the sourceType is ConditionRuleSourceTypeElement, the source is the name of a technical key of an element to retrieve its value. | [optional] +**Operator** | Pointer to **Enum** [ "EQ", "NE", "CO", "NOT_CO", "IN", "NOT_IN", "EM", "NOT_EM", "SW", "NOT_SW", "EW", "NOT_EW" ] | ConditionRuleComparisonOperatorType value. EQ ConditionRuleComparisonOperatorTypeEquals This comparison operator compares the source and target for equality. NE ConditionRuleComparisonOperatorTypeNotEquals This comparison operator compares the source and target for inequality. CO ConditionRuleComparisonOperatorTypeContains This comparison operator searches the source to see whether it contains the value. NOT_CO ConditionRuleComparisonOperatorTypeNotContains IN ConditionRuleComparisonOperatorTypeIncludes This comparison operator searches the source if it equals any of the values. NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes EM ConditionRuleComparisonOperatorTypeEmpty NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty SW ConditionRuleComparisonOperatorTypeStartsWith Checks whether a string starts with another substring of the same string. This operator is case-sensitive. NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith EW ConditionRuleComparisonOperatorTypeEndsWith Checks whether a string ends with another substring of the same string. This operator is case-sensitive. NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith | [optional] +**ValueType** | Pointer to **Enum** [ "STRING", "STRING_LIST", "INPUT", "ELEMENT", "LIST", "BOOLEAN" ] | ConditionRuleValueType type. STRING ConditionRuleValueTypeString This value is a static string. STRING_LIST ConditionRuleValueTypeStringList This value is an array of string values. INPUT ConditionRuleValueTypeInput This value is a reference to a form input. ELEMENT ConditionRuleValueTypeElement This value is a reference to a form element (by technical key). LIST ConditionRuleValueTypeList BOOLEAN ConditionRuleValueTypeBoolean | [optional] +**Value** | Pointer to **String** | Based on the ValueType. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConditionRule = Initialize-PSSailpoint.BetaConditionRule -SourceType ELEMENT ` + -Source department ` + -Operator EQ ` + -ValueType STRING ` + -Value Engineering +``` + +- Convert the resource to JSON +```powershell +$ConditionRule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Conditional.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Conditional.md new file mode 100644 index 000000000..e61ad1f05 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Conditional.md @@ -0,0 +1,43 @@ +--- +id: beta-conditional +title: Conditional +pagination_label: Conditional +sidebar_label: Conditional +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Conditional', 'BetaConditional'] +slug: /tools/sdk/powershell/beta/models/conditional +tags: ['SDK', 'Software Development Kit', 'Conditional', 'BetaConditional'] +--- + + +# Conditional + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Expression** | **String** | A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. The `eq` operator is the only valid comparison | [required] +**PositiveCondition** | **String** | The output of the transform if the expression evalutes to true | [required] +**NegativeCondition** | **String** | The output of the transform if the expression evalutes to false | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$Conditional = Initialize-PSSailpoint.BetaConditional -Expression ValueA eq ValueB ` + -PositiveCondition true ` + -NegativeCondition false ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Conditional | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConfigObject.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConfigObject.md new file mode 100644 index 000000000..8e4663ac2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConfigObject.md @@ -0,0 +1,39 @@ +--- +id: beta-config-object +title: ConfigObject +pagination_label: ConfigObject +sidebar_label: ConfigObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigObject', 'BetaConfigObject'] +slug: /tools/sdk/powershell/beta/models/config-object +tags: ['SDK', 'Software Development Kit', 'ConfigObject', 'BetaConfigObject'] +--- + + +# ConfigObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | Pointer to **Int32** | Current version of configuration object. | [optional] +**Self** | Pointer to [**SelfImportExportDto**](self-import-export-dto) | | [optional] +**Object** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Object details. Format dependant on the object type. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConfigObject = Initialize-PSSailpoint.BetaConfigObject -Version 1 ` + -Self null ` + -Object null +``` + +- Convert the resource to JSON +```powershell +$ConfigObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConfigType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConfigType.md new file mode 100644 index 000000000..cb321d5f4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConfigType.md @@ -0,0 +1,43 @@ +--- +id: beta-config-type +title: ConfigType +pagination_label: ConfigType +sidebar_label: ConfigType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigType', 'BetaConfigType'] +slug: /tools/sdk/powershell/beta/models/config-type +tags: ['SDK', 'Software Development Kit', 'ConfigType', 'BetaConfigType'] +--- + + +# ConfigType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Priority** | Pointer to **Int32** | | [optional] +**InternalName** | Pointer to [**ConfigTypeEnumCamel**](config-type-enum-camel) | | [optional] +**InternalNameCamel** | Pointer to [**ConfigTypeEnum**](config-type-enum) | | [optional] +**DisplayName** | Pointer to **String** | Human readable display name of the type to be shown on UI | [optional] +**Description** | Pointer to **String** | Description of the type of work to be reassigned, displayed by the UI. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConfigType = Initialize-PSSailpoint.BetaConfigType -Priority 1 ` + -InternalName null ` + -InternalNameCamel null ` + -DisplayName Access Requests ` + -Description Reassign Access Request Work Items for an identity +``` + +- Convert the resource to JSON +```powershell +$ConfigType | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConfigTypeEnum.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConfigTypeEnum.md new file mode 100644 index 000000000..5d998e490 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConfigTypeEnum.md @@ -0,0 +1,26 @@ +--- +id: beta-config-type-enum +title: ConfigTypeEnum +pagination_label: ConfigTypeEnum +sidebar_label: ConfigTypeEnum +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigTypeEnum', 'BetaConfigTypeEnum'] +slug: /tools/sdk/powershell/beta/models/config-type-enum +tags: ['SDK', 'Software Development Kit', 'ConfigTypeEnum', 'BetaConfigTypeEnum'] +--- + + +# ConfigTypeEnum + +## Enum + + +* `ACCESS_REQUESTS` (value: `"ACCESS_REQUESTS"`) + +* `CERTIFICATIONS` (value: `"CERTIFICATIONS"`) + +* `MANUAL_TASKS` (value: `"MANUAL_TASKS"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConfigTypeEnumCamel.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConfigTypeEnumCamel.md new file mode 100644 index 000000000..b2a516846 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConfigTypeEnumCamel.md @@ -0,0 +1,26 @@ +--- +id: beta-config-type-enum-camel +title: ConfigTypeEnumCamel +pagination_label: ConfigTypeEnumCamel +sidebar_label: ConfigTypeEnumCamel +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigTypeEnumCamel', 'BetaConfigTypeEnumCamel'] +slug: /tools/sdk/powershell/beta/models/config-type-enum-camel +tags: ['SDK', 'Software Development Kit', 'ConfigTypeEnumCamel', 'BetaConfigTypeEnumCamel'] +--- + + +# ConfigTypeEnumCamel + +## Enum + + +* `accessRequests` (value: `"accessRequests"`) + +* `certifications` (value: `"certifications"`) + +* `manualTasks` (value: `"manualTasks"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConfigurationDetailsResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConfigurationDetailsResponse.md new file mode 100644 index 000000000..ec76f4a50 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConfigurationDetailsResponse.md @@ -0,0 +1,43 @@ +--- +id: beta-configuration-details-response +title: ConfigurationDetailsResponse +pagination_label: ConfigurationDetailsResponse +sidebar_label: ConfigurationDetailsResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigurationDetailsResponse', 'BetaConfigurationDetailsResponse'] +slug: /tools/sdk/powershell/beta/models/configuration-details-response +tags: ['SDK', 'Software Development Kit', 'ConfigurationDetailsResponse', 'BetaConfigurationDetailsResponse'] +--- + + +# ConfigurationDetailsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConfigType** | Pointer to [**ConfigTypeEnum**](config-type-enum) | | [optional] +**TargetIdentity** | Pointer to [**Identity1**](identity1) | | [optional] +**StartDate** | Pointer to **System.DateTime** | The date from which to start reassigning work items | [optional] +**EndDate** | Pointer to **System.DateTime** | The date from which to stop reassigning work items. If this is an empty string it indicates a permanent reassignment. | [optional] +**AuditDetails** | Pointer to [**AuditDetails**](audit-details) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConfigurationDetailsResponse = Initialize-PSSailpoint.BetaConfigurationDetailsResponse -ConfigType null ` + -TargetIdentity null ` + -StartDate 2022-07-21T11:13:12.345Z ` + -EndDate 0001-01-01T00:00Z ` + -AuditDetails null +``` + +- Convert the resource to JSON +```powershell +$ConfigurationDetailsResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConfigurationItemRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConfigurationItemRequest.md new file mode 100644 index 000000000..a52e05223 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConfigurationItemRequest.md @@ -0,0 +1,43 @@ +--- +id: beta-configuration-item-request +title: ConfigurationItemRequest +pagination_label: ConfigurationItemRequest +sidebar_label: ConfigurationItemRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigurationItemRequest', 'BetaConfigurationItemRequest'] +slug: /tools/sdk/powershell/beta/models/configuration-item-request +tags: ['SDK', 'Software Development Kit', 'ConfigurationItemRequest', 'BetaConfigurationItemRequest'] +--- + + +# ConfigurationItemRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReassignedFromId** | Pointer to **String** | The identity id to reassign an item from | [optional] +**ReassignedToId** | Pointer to **String** | The identity id to reassign an item to | [optional] +**ConfigType** | Pointer to [**ConfigTypeEnum**](config-type-enum) | | [optional] +**StartDate** | Pointer to **System.DateTime** | The date from which to start reassigning work items | [optional] +**EndDate** | Pointer to **System.DateTime** | The date from which to stop reassigning work items. If this is an null string it indicates a permanent reassignment. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConfigurationItemRequest = Initialize-PSSailpoint.BetaConfigurationItemRequest -ReassignedFromId 2c91808781a71ddb0181b9090b5c504e ` + -ReassignedToId 2c91808781a71ddb0181b9090b53504a ` + -ConfigType null ` + -StartDate 2022-07-21T11:13:12.345Z ` + -EndDate 2022-07-30T17:00Z +``` + +- Convert the resource to JSON +```powershell +$ConfigurationItemRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConfigurationItemResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConfigurationItemResponse.md new file mode 100644 index 000000000..83bfc430b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConfigurationItemResponse.md @@ -0,0 +1,37 @@ +--- +id: beta-configuration-item-response +title: ConfigurationItemResponse +pagination_label: ConfigurationItemResponse +sidebar_label: ConfigurationItemResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigurationItemResponse', 'BetaConfigurationItemResponse'] +slug: /tools/sdk/powershell/beta/models/configuration-item-response +tags: ['SDK', 'Software Development Kit', 'ConfigurationItemResponse', 'BetaConfigurationItemResponse'] +--- + + +# ConfigurationItemResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to [**Identity1**](identity1) | | [optional] +**ConfigDetails** | Pointer to [**[]ConfigurationDetailsResponse**](configuration-details-response) | Details of how work should be reassigned for an Identity | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConfigurationItemResponse = Initialize-PSSailpoint.BetaConfigurationItemResponse -Identity null ` + -ConfigDetails null +``` + +- Convert the resource to JSON +```powershell +$ConfigurationItemResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConfigurationResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConfigurationResponse.md new file mode 100644 index 000000000..9620823bd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConfigurationResponse.md @@ -0,0 +1,37 @@ +--- +id: beta-configuration-response +title: ConfigurationResponse +pagination_label: ConfigurationResponse +sidebar_label: ConfigurationResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigurationResponse', 'BetaConfigurationResponse'] +slug: /tools/sdk/powershell/beta/models/configuration-response +tags: ['SDK', 'Software Development Kit', 'ConfigurationResponse', 'BetaConfigurationResponse'] +--- + + +# ConfigurationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to [**Identity1**](identity1) | | [optional] +**ConfigDetails** | Pointer to [**[]ConfigurationDetailsResponse**](configuration-details-response) | Details of how work should be reassigned for an Identity | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConfigurationResponse = Initialize-PSSailpoint.BetaConfigurationResponse -Identity null ` + -ConfigDetails null +``` + +- Convert the resource to JSON +```powershell +$ConfigurationResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConflictingAccessCriteria.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConflictingAccessCriteria.md new file mode 100644 index 000000000..a29c8a7d5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConflictingAccessCriteria.md @@ -0,0 +1,37 @@ +--- +id: beta-conflicting-access-criteria +title: ConflictingAccessCriteria +pagination_label: ConflictingAccessCriteria +sidebar_label: ConflictingAccessCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConflictingAccessCriteria', 'BetaConflictingAccessCriteria'] +slug: /tools/sdk/powershell/beta/models/conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'ConflictingAccessCriteria', 'BetaConflictingAccessCriteria'] +--- + + +# ConflictingAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] +**RightCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConflictingAccessCriteria = Initialize-PSSailpoint.BetaConflictingAccessCriteria -LeftCriteria null ` + -RightCriteria null +``` + +- Convert the resource to JSON +```powershell +$ConflictingAccessCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectedObject.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectedObject.md new file mode 100644 index 000000000..69232a9f6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectedObject.md @@ -0,0 +1,41 @@ +--- +id: beta-connected-object +title: ConnectedObject +pagination_label: ConnectedObject +sidebar_label: ConnectedObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectedObject', 'BetaConnectedObject'] +slug: /tools/sdk/powershell/beta/models/connected-object +tags: ['SDK', 'Software Development Kit', 'ConnectedObject', 'BetaConnectedObject'] +--- + + +# ConnectedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**ConnectedObjectType**](connected-object-type) | | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable name of Connected object | [optional] +**Description** | Pointer to **String** | Description of the Connected object. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConnectedObject = Initialize-PSSailpoint.BetaConnectedObject -Type null ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name Employee-database-read-write ` + -Description Collection of entitlements to read/write the employee database. +``` + +- Convert the resource to JSON +```powershell +$ConnectedObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectedObjectType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectedObjectType.md new file mode 100644 index 000000000..88fd26da8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectedObjectType.md @@ -0,0 +1,28 @@ +--- +id: beta-connected-object-type +title: ConnectedObjectType +pagination_label: ConnectedObjectType +sidebar_label: ConnectedObjectType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectedObjectType', 'BetaConnectedObjectType'] +slug: /tools/sdk/powershell/beta/models/connected-object-type +tags: ['SDK', 'Software Development Kit', 'ConnectedObjectType', 'BetaConnectedObjectType'] +--- + + +# ConnectedObjectType + +## Enum + + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ROLE` (value: `"ROLE"`) + +* `SOD_POLICY` (value: `"SOD_POLICY"`) + +* `SOURCE` (value: `"SOURCE"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectorDetail.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectorDetail.md new file mode 100644 index 000000000..03e015746 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectorDetail.md @@ -0,0 +1,48 @@ +--- +id: beta-connector-detail +title: ConnectorDetail +pagination_label: ConnectorDetail +sidebar_label: ConnectorDetail +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorDetail', 'BetaConnectorDetail'] +slug: /tools/sdk/powershell/beta/models/connector-detail +tags: ['SDK', 'Software Development Kit', 'ConnectorDetail', 'BetaConnectorDetail'] +--- + + +# ConnectorDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The connector name | [optional] +**SourceConfigXml** | Pointer to **String** | XML representation of the source config data | [optional] +**SourceConfig** | Pointer to **String** | JSON representation of the source config data | [optional] +**DirectConnect** | Pointer to **Boolean** | true if the source is a direct connect source | [optional] +**FileUpload** | Pointer to **Boolean** | Connector config's file upload attribute, false if not there | [optional] +**UploadedFiles** | Pointer to **String** | List of uploaded file strings for the connector | [optional] +**ConnectorMetadata** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Object containing metadata pertinent to the UI to be used | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConnectorDetail = Initialize-PSSailpoint.BetaConnectorDetail -Name JDBC ` + -SourceConfigXml <Form connectorName='Active Directory - Direct' directConnect='true' name='Active Directory' status='released' type='SourceConfig' xmlns='http://www.sailpoint.com/xsd/sailpoint_form_1_0.xsd'> + <Field defaultValue='true' hidden='true' name='cloudAuthEnabled' type='boolean' value='true'> </Field> </Form> ` + -SourceConfig {Form={Field={_defaultValue=true, _hidden=true, _name=cloudAuthEnabled, _type=boolean, _value=true}, _xmlns=http://www.sailpoint.com/xsd/sailpoint_form_1_0.xsd, _connectorName=Active Directory - Direct, _directConnect=true, _name=Active Directory, _status=released, _type=SourceConfig, __text=\n\t}} ` + -DirectConnect true ` + -FileUpload false ` + -UploadedFiles [] ` + -ConnectorMetadata {supportedUI=EXTJS} +``` + +- Convert the resource to JSON +```powershell +$ConnectorDetail | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectorRuleCreateRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectorRuleCreateRequest.md new file mode 100644 index 000000000..6cb23a75a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectorRuleCreateRequest.md @@ -0,0 +1,45 @@ +--- +id: beta-connector-rule-create-request +title: ConnectorRuleCreateRequest +pagination_label: ConnectorRuleCreateRequest +sidebar_label: ConnectorRuleCreateRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorRuleCreateRequest', 'BetaConnectorRuleCreateRequest'] +slug: /tools/sdk/powershell/beta/models/connector-rule-create-request +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleCreateRequest', 'BetaConnectorRuleCreateRequest'] +--- + + +# ConnectorRuleCreateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | the name of the rule | [required] +**Description** | Pointer to **String** | a description of the rule's purpose | [optional] +**Type** | **Enum** [ "BuildMap", "ConnectorAfterCreate", "ConnectorAfterDelete", "ConnectorAfterModify", "ConnectorBeforeCreate", "ConnectorBeforeDelete", "ConnectorBeforeModify", "JDBCBuildMap", "JDBCOperationProvisioning", "JDBCProvision", "PeopleSoftHRMSBuildMap", "PeopleSoftHRMSOperationProvisioning", "PeopleSoftHRMSProvision", "RACFPermissionCustomization", "SAPBuildMap", "SapHrManagerRule", "SapHrOperationProvisioning", "SapHrProvision", "SuccessFactorsOperationProvisioning", "WebServiceAfterOperationRule", "WebServiceBeforeOperationRule" ] | the type of rule | [required] +**Signature** | Pointer to [**ConnectorRuleCreateRequestSignature**](connector-rule-create-request-signature) | | [optional] +**SourceCode** | [**SourceCode**](source-code) | | [required] +**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | a map of string to objects | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConnectorRuleCreateRequest = Initialize-PSSailpoint.BetaConnectorRuleCreateRequest -Name WebServiceBeforeOperationRule ` + -Description This rule does that ` + -Type BuildMap ` + -Signature null ` + -SourceCode null ` + -Attributes {} +``` + +- Convert the resource to JSON +```powershell +$ConnectorRuleCreateRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectorRuleCreateRequestSignature.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectorRuleCreateRequestSignature.md new file mode 100644 index 000000000..237f75baa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectorRuleCreateRequestSignature.md @@ -0,0 +1,37 @@ +--- +id: beta-connector-rule-create-request-signature +title: ConnectorRuleCreateRequestSignature +pagination_label: ConnectorRuleCreateRequestSignature +sidebar_label: ConnectorRuleCreateRequestSignature +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorRuleCreateRequestSignature', 'BetaConnectorRuleCreateRequestSignature'] +slug: /tools/sdk/powershell/beta/models/connector-rule-create-request-signature +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleCreateRequestSignature', 'BetaConnectorRuleCreateRequestSignature'] +--- + + +# ConnectorRuleCreateRequestSignature + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarInput** | [**[]Argument**](argument) | | [required] +**Output** | Pointer to [**Argument**](argument) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConnectorRuleCreateRequestSignature = Initialize-PSSailpoint.BetaConnectorRuleCreateRequestSignature -VarInput null ` + -Output null +``` + +- Convert the resource to JSON +```powershell +$ConnectorRuleCreateRequestSignature | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectorRuleResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectorRuleResponse.md new file mode 100644 index 000000000..275d001c8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectorRuleResponse.md @@ -0,0 +1,51 @@ +--- +id: beta-connector-rule-response +title: ConnectorRuleResponse +pagination_label: ConnectorRuleResponse +sidebar_label: ConnectorRuleResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorRuleResponse', 'BetaConnectorRuleResponse'] +slug: /tools/sdk/powershell/beta/models/connector-rule-response +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleResponse', 'BetaConnectorRuleResponse'] +--- + + +# ConnectorRuleResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | the name of the rule | [required] +**Description** | Pointer to **String** | a description of the rule's purpose | [optional] +**Type** | **Enum** [ "BuildMap", "ConnectorAfterCreate", "ConnectorAfterDelete", "ConnectorAfterModify", "ConnectorBeforeCreate", "ConnectorBeforeDelete", "ConnectorBeforeModify", "JDBCBuildMap", "JDBCOperationProvisioning", "JDBCProvision", "PeopleSoftHRMSBuildMap", "PeopleSoftHRMSOperationProvisioning", "PeopleSoftHRMSProvision", "RACFPermissionCustomization", "SAPBuildMap", "SapHrManagerRule", "SapHrOperationProvisioning", "SapHrProvision", "SuccessFactorsOperationProvisioning", "WebServiceAfterOperationRule", "WebServiceBeforeOperationRule" ] | the type of rule | [required] +**Signature** | Pointer to [**ConnectorRuleCreateRequestSignature**](connector-rule-create-request-signature) | | [optional] +**SourceCode** | [**SourceCode**](source-code) | | [required] +**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | a map of string to objects | [optional] +**Id** | **String** | the ID of the rule | [required] +**Created** | **String** | an ISO 8601 UTC timestamp when this rule was created | [required] +**Modified** | Pointer to **String** | an ISO 8601 UTC timestamp when this rule was last modified | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConnectorRuleResponse = Initialize-PSSailpoint.BetaConnectorRuleResponse -Name WebServiceBeforeOperationRule ` + -Description This rule does that ` + -Type BuildMap ` + -Signature null ` + -SourceCode null ` + -Attributes {} ` + -Id 8113d48c0b914f17b4c6072d4dcb9dfe ` + -Created 021-07-22T15:59:23Z ` + -Modified 021-07-22T15:59:23Z +``` + +- Convert the resource to JSON +```powershell +$ConnectorRuleResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectorRuleUpdateRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectorRuleUpdateRequest.md new file mode 100644 index 000000000..18ef2e032 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectorRuleUpdateRequest.md @@ -0,0 +1,47 @@ +--- +id: beta-connector-rule-update-request +title: ConnectorRuleUpdateRequest +pagination_label: ConnectorRuleUpdateRequest +sidebar_label: ConnectorRuleUpdateRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorRuleUpdateRequest', 'BetaConnectorRuleUpdateRequest'] +slug: /tools/sdk/powershell/beta/models/connector-rule-update-request +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleUpdateRequest', 'BetaConnectorRuleUpdateRequest'] +--- + + +# ConnectorRuleUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | the name of the rule | [required] +**Description** | Pointer to **String** | a description of the rule's purpose | [optional] +**Type** | **Enum** [ "BuildMap", "ConnectorAfterCreate", "ConnectorAfterDelete", "ConnectorAfterModify", "ConnectorBeforeCreate", "ConnectorBeforeDelete", "ConnectorBeforeModify", "JDBCBuildMap", "JDBCOperationProvisioning", "JDBCProvision", "PeopleSoftHRMSBuildMap", "PeopleSoftHRMSOperationProvisioning", "PeopleSoftHRMSProvision", "RACFPermissionCustomization", "SAPBuildMap", "SapHrManagerRule", "SapHrOperationProvisioning", "SapHrProvision", "SuccessFactorsOperationProvisioning", "WebServiceAfterOperationRule", "WebServiceBeforeOperationRule" ] | the type of rule | [required] +**Signature** | Pointer to [**ConnectorRuleCreateRequestSignature**](connector-rule-create-request-signature) | | [optional] +**SourceCode** | [**SourceCode**](source-code) | | [required] +**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | a map of string to objects | [optional] +**Id** | **String** | the ID of the rule to update | [required] + +## Examples + +- Prepare the resource +```powershell +$ConnectorRuleUpdateRequest = Initialize-PSSailpoint.BetaConnectorRuleUpdateRequest -Name WebServiceBeforeOperationRule ` + -Description This rule does that ` + -Type BuildMap ` + -Signature null ` + -SourceCode null ` + -Attributes {} ` + -Id 8113d48c0b914f17b4c6072d4dcb9dfe +``` + +- Convert the resource to JSON +```powershell +$ConnectorRuleUpdateRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectorRuleValidationResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectorRuleValidationResponse.md new file mode 100644 index 000000000..0c5da1f6c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectorRuleValidationResponse.md @@ -0,0 +1,37 @@ +--- +id: beta-connector-rule-validation-response +title: ConnectorRuleValidationResponse +pagination_label: ConnectorRuleValidationResponse +sidebar_label: ConnectorRuleValidationResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorRuleValidationResponse', 'BetaConnectorRuleValidationResponse'] +slug: /tools/sdk/powershell/beta/models/connector-rule-validation-response +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleValidationResponse', 'BetaConnectorRuleValidationResponse'] +--- + + +# ConnectorRuleValidationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | **Enum** [ "OK", "ERROR" ] | | [required] +**Details** | [**[]ConnectorRuleValidationResponseDetailsInner**](connector-rule-validation-response-details-inner) | | [required] + +## Examples + +- Prepare the resource +```powershell +$ConnectorRuleValidationResponse = Initialize-PSSailpoint.BetaConnectorRuleValidationResponse -State ERROR ` + -Details null +``` + +- Convert the resource to JSON +```powershell +$ConnectorRuleValidationResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectorRuleValidationResponseDetailsInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectorRuleValidationResponseDetailsInner.md new file mode 100644 index 000000000..7cce61def --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ConnectorRuleValidationResponseDetailsInner.md @@ -0,0 +1,39 @@ +--- +id: beta-connector-rule-validation-response-details-inner +title: ConnectorRuleValidationResponseDetailsInner +pagination_label: ConnectorRuleValidationResponseDetailsInner +sidebar_label: ConnectorRuleValidationResponseDetailsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorRuleValidationResponseDetailsInner', 'BetaConnectorRuleValidationResponseDetailsInner'] +slug: /tools/sdk/powershell/beta/models/connector-rule-validation-response-details-inner +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleValidationResponseDetailsInner', 'BetaConnectorRuleValidationResponseDetailsInner'] +--- + + +# ConnectorRuleValidationResponseDetailsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Line** | **Int32** | The line number where the issue occurred | [required] +**Column** | **Int32** | the column number where the issue occurred | [required] +**Messsage** | Pointer to **String** | a description of the issue in the code | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConnectorRuleValidationResponseDetailsInner = Initialize-PSSailpoint.BetaConnectorRuleValidationResponseDetailsInner -Line 2 ` + -Column 5 ` + -Messsage Remove reference to .decrypt( +``` + +- Convert the resource to JSON +```powershell +$ConnectorRuleValidationResponseDetailsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ContextAttributeDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ContextAttributeDto.md new file mode 100644 index 000000000..a9d90b374 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ContextAttributeDto.md @@ -0,0 +1,39 @@ +--- +id: beta-context-attribute-dto +title: ContextAttributeDto +pagination_label: ContextAttributeDto +sidebar_label: ContextAttributeDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ContextAttributeDto', 'BetaContextAttributeDto'] +slug: /tools/sdk/powershell/beta/models/context-attribute-dto +tags: ['SDK', 'Software Development Kit', 'ContextAttributeDto', 'BetaContextAttributeDto'] +--- + + +# ContextAttributeDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attribute** | Pointer to **String** | The name of the attribute | [optional] +**Value** | Pointer to [**ContextAttributeDtoValue**](context-attribute-dto-value) | | [optional] +**Derived** | Pointer to **Boolean** | True if the attribute was derived. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$ContextAttributeDto = Initialize-PSSailpoint.BetaContextAttributeDto -Attribute location ` + -Value null ` + -Derived false +``` + +- Convert the resource to JSON +```powershell +$ContextAttributeDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ContextAttributeDtoValue.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ContextAttributeDtoValue.md new file mode 100644 index 000000000..dcf0cef7b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ContextAttributeDtoValue.md @@ -0,0 +1,34 @@ +--- +id: beta-context-attribute-dto-value +title: ContextAttributeDtoValue +pagination_label: ContextAttributeDtoValue +sidebar_label: ContextAttributeDtoValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ContextAttributeDtoValue', 'BetaContextAttributeDtoValue'] +slug: /tools/sdk/powershell/beta/models/context-attribute-dto-value +tags: ['SDK', 'Software Development Kit', 'ContextAttributeDtoValue', 'BetaContextAttributeDtoValue'] +--- + + +# ContextAttributeDtoValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$ContextAttributeDtoValue = Initialize-PSSailpoint.BetaContextAttributeDtoValue +``` + +- Convert the resource to JSON +```powershell +$ContextAttributeDtoValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CorrelatedGovernanceEvent.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CorrelatedGovernanceEvent.md new file mode 100644 index 000000000..003b47cf7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CorrelatedGovernanceEvent.md @@ -0,0 +1,47 @@ +--- +id: beta-correlated-governance-event +title: CorrelatedGovernanceEvent +pagination_label: CorrelatedGovernanceEvent +sidebar_label: CorrelatedGovernanceEvent +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CorrelatedGovernanceEvent', 'BetaCorrelatedGovernanceEvent'] +slug: /tools/sdk/powershell/beta/models/correlated-governance-event +tags: ['SDK', 'Software Development Kit', 'CorrelatedGovernanceEvent', 'BetaCorrelatedGovernanceEvent'] +--- + + +# CorrelatedGovernanceEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the governance event, such as the certification name or access request ID. | [optional] +**Dt** | Pointer to **String** | The date that the certification or access request was completed. | [optional] +**Type** | Pointer to **Enum** [ "certification", "accessRequest" ] | The type of governance event. | [optional] +**GovernanceId** | Pointer to **String** | The ID of the instance that caused the event - either the certification ID or access request ID. | [optional] +**Owners** | Pointer to [**[]CertifierResponse**](certifier-response) | The owners of the governance event (the certifiers or approvers) | [optional] +**Reviewers** | Pointer to [**[]CertifierResponse**](certifier-response) | The owners of the governance event (the certifiers or approvers), this field should be preferred over owners | [optional] +**DecisionMaker** | Pointer to [**CertifierResponse**](certifier-response) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CorrelatedGovernanceEvent = Initialize-PSSailpoint.BetaCorrelatedGovernanceEvent -Name Manager Certification for Jon Snow ` + -Dt 2019-03-08T22:37:33.901Z ` + -Type certification ` + -GovernanceId 2c91808a77ff216301782327a50f09bf ` + -Owners [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` + -Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` + -DecisionMaker null +``` + +- Convert the resource to JSON +```powershell +$CorrelatedGovernanceEvent | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CorrelationConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CorrelationConfig.md new file mode 100644 index 000000000..0debaea20 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CorrelationConfig.md @@ -0,0 +1,39 @@ +--- +id: beta-correlation-config +title: CorrelationConfig +pagination_label: CorrelationConfig +sidebar_label: CorrelationConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CorrelationConfig', 'BetaCorrelationConfig'] +slug: /tools/sdk/powershell/beta/models/correlation-config +tags: ['SDK', 'Software Development Kit', 'CorrelationConfig', 'BetaCorrelationConfig'] +--- + + +# CorrelationConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of the correlation configuration. | [optional] +**Name** | Pointer to **String** | The name of the correlation configuration. | [optional] +**AttributeAssignments** | Pointer to [**[]CorrelationConfigAttributeAssignmentsInner**](correlation-config-attribute-assignments-inner) | The list of attribute assignments of the correlation configuration. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CorrelationConfig = Initialize-PSSailpoint.BetaCorrelationConfig -Id 2c9180835d191a86015d28455b4a2329 ` + -Name Source [source] Account Correlation ` + -AttributeAssignments null +``` + +- Convert the resource to JSON +```powershell +$CorrelationConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CorrelationConfigAttributeAssignmentsInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CorrelationConfigAttributeAssignmentsInner.md new file mode 100644 index 000000000..ebe3c7431 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CorrelationConfigAttributeAssignmentsInner.md @@ -0,0 +1,47 @@ +--- +id: beta-correlation-config-attribute-assignments-inner +title: CorrelationConfigAttributeAssignmentsInner +pagination_label: CorrelationConfigAttributeAssignmentsInner +sidebar_label: CorrelationConfigAttributeAssignmentsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CorrelationConfigAttributeAssignmentsInner', 'BetaCorrelationConfigAttributeAssignmentsInner'] +slug: /tools/sdk/powershell/beta/models/correlation-config-attribute-assignments-inner +tags: ['SDK', 'Software Development Kit', 'CorrelationConfigAttributeAssignmentsInner', 'BetaCorrelationConfigAttributeAssignmentsInner'] +--- + + +# CorrelationConfigAttributeAssignmentsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Property** | Pointer to **String** | The property of the attribute assignment. | [optional] +**Value** | Pointer to **String** | The value of the attribute assignment. | [optional] +**Operation** | Pointer to **Enum** [ "EQ" ] | The operation of the attribute assignment. | [optional] +**Complex** | Pointer to **Boolean** | Whether or not the it's a complex attribute assignment. | [optional] [default to $false] +**IgnoreCase** | Pointer to **Boolean** | Whether or not the attribute assignment should ignore case. | [optional] [default to $false] +**MatchMode** | Pointer to **Enum** [ "ANYWHERE", "START", "END" ] | The match mode of the attribute assignment. | [optional] +**FilterString** | Pointer to **String** | The filter string of the attribute assignment. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CorrelationConfigAttributeAssignmentsInner = Initialize-PSSailpoint.BetaCorrelationConfigAttributeAssignmentsInner -Property first_name ` + -Value firstName ` + -Operation EQ ` + -Complex false ` + -IgnoreCase false ` + -MatchMode ANYWHERE ` + -FilterString first_name == "John" +``` + +- Convert the resource to JSON +```powershell +$CorrelationConfigAttributeAssignmentsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreateDomainDkim405Response.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreateDomainDkim405Response.md new file mode 100644 index 000000000..1b32b095a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreateDomainDkim405Response.md @@ -0,0 +1,39 @@ +--- +id: beta-create-domain-dkim405-response +title: CreateDomainDkim405Response +pagination_label: CreateDomainDkim405Response +sidebar_label: CreateDomainDkim405Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateDomainDkim405Response', 'BetaCreateDomainDkim405Response'] +slug: /tools/sdk/powershell/beta/models/create-domain-dkim405-response +tags: ['SDK', 'Software Development Kit', 'CreateDomainDkim405Response', 'BetaCreateDomainDkim405Response'] +--- + + +# CreateDomainDkim405Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ErrorName** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A message describing the error | [optional] +**ErrorMessage** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Description of the error | [optional] +**TrackingId** | Pointer to **String** | Unique tracking id for the error. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateDomainDkim405Response = Initialize-PSSailpoint.BetaCreateDomainDkim405Response -ErrorName NotSupportedException ` + -ErrorMessage Cannot consume content type ` + -TrackingId e7eab60924f64aa284175b9fa3309599 +``` + +- Convert the resource to JSON +```powershell +$CreateDomainDkim405Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreateFormDefinitionFileRequestRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreateFormDefinitionFileRequestRequest.md new file mode 100644 index 000000000..9c5c4364b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreateFormDefinitionFileRequestRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-create-form-definition-file-request-request +title: CreateFormDefinitionFileRequestRequest +pagination_label: CreateFormDefinitionFileRequestRequest +sidebar_label: CreateFormDefinitionFileRequestRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateFormDefinitionFileRequestRequest', 'BetaCreateFormDefinitionFileRequestRequest'] +slug: /tools/sdk/powershell/beta/models/create-form-definition-file-request-request +tags: ['SDK', 'Software Development Kit', 'CreateFormDefinitionFileRequestRequest', 'BetaCreateFormDefinitionFileRequestRequest'] +--- + + +# CreateFormDefinitionFileRequestRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | **System.IO.FileInfo** | File specifying the multipart | [required] + +## Examples + +- Prepare the resource +```powershell +$CreateFormDefinitionFileRequestRequest = Initialize-PSSailpoint.BetaCreateFormDefinitionFileRequestRequest -File null +``` + +- Convert the resource to JSON +```powershell +$CreateFormDefinitionFileRequestRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreateFormDefinitionRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreateFormDefinitionRequest.md new file mode 100644 index 000000000..6c74b888f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreateFormDefinitionRequest.md @@ -0,0 +1,47 @@ +--- +id: beta-create-form-definition-request +title: CreateFormDefinitionRequest +pagination_label: CreateFormDefinitionRequest +sidebar_label: CreateFormDefinitionRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateFormDefinitionRequest', 'BetaCreateFormDefinitionRequest'] +slug: /tools/sdk/powershell/beta/models/create-form-definition-request +tags: ['SDK', 'Software Development Kit', 'CreateFormDefinitionRequest', 'BetaCreateFormDefinitionRequest'] +--- + + +# CreateFormDefinitionRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **String** | Description is the form definition description | [optional] +**FormConditions** | Pointer to [**[]FormCondition**](form-condition) | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [optional] +**FormElements** | Pointer to [**[]FormElement**](form-element) | FormElements is a list of nested form elements | [optional] +**FormInput** | Pointer to [**[]FormDefinitionInput**](form-definition-input) | FormInput is a list of form inputs that are required when creating a form-instance object | [optional] +**Name** | **String** | Name is the form definition name | [required] +**Owner** | [**FormOwner**](form-owner) | | [required] +**UsedBy** | Pointer to [**[]FormUsedBy**](form-used-by) | UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateFormDefinitionRequest = Initialize-PSSailpoint.BetaCreateFormDefinitionRequest -Description My form description ` + -FormConditions null ` + -FormElements null ` + -FormInput null ` + -Name My form ` + -Owner null ` + -UsedBy null +``` + +- Convert the resource to JSON +```powershell +$CreateFormDefinitionRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreateFormInstanceRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreateFormInstanceRequest.md new file mode 100644 index 000000000..d4c803404 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreateFormInstanceRequest.md @@ -0,0 +1,49 @@ +--- +id: beta-create-form-instance-request +title: CreateFormInstanceRequest +pagination_label: CreateFormInstanceRequest +sidebar_label: CreateFormInstanceRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateFormInstanceRequest', 'BetaCreateFormInstanceRequest'] +slug: /tools/sdk/powershell/beta/models/create-form-instance-request +tags: ['SDK', 'Software Development Kit', 'CreateFormInstanceRequest', 'BetaCreateFormInstanceRequest'] +--- + + +# CreateFormInstanceRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreatedBy** | [**FormInstanceCreatedBy**](form-instance-created-by) | | [required] +**Expire** | **String** | Expire is required | [required] +**FormDefinitionId** | **String** | FormDefinitionID is the id of the form definition that created this form | [required] +**FormInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | FormInput is an object of form input labels to value | [optional] +**Recipients** | [**[]FormInstanceRecipient**](form-instance-recipient) | Recipients is required | [required] +**StandAloneForm** | Pointer to **Boolean** | StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form | [optional] [default to $false] +**State** | Pointer to **Enum** [ "ASSIGNED", "IN_PROGRESS", "SUBMITTED", "COMPLETED", "CANCELLED" ] | State is required, if not present initial state is FormInstanceStateAssigned ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [optional] +**Ttl** | Pointer to **Int64** | TTL an epoch timestamp in seconds, it most be in seconds or dynamodb will ignore it SEE: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/time-to-live-ttl-before-you-start.html | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateFormInstanceRequest = Initialize-PSSailpoint.BetaCreateFormInstanceRequest -CreatedBy null ` + -Expire 2023-08-12T20:14:57.74486Z ` + -FormDefinitionId 00000000-0000-0000-0000-000000000000 ` + -FormInput {input1=Sales} ` + -Recipients null ` + -StandAloneForm false ` + -State ASSIGNED ` + -Ttl 1571827560 +``` + +- Convert the resource to JSON +```powershell +$CreateFormInstanceRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreateOAuthClientRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreateOAuthClientRequest.md new file mode 100644 index 000000000..8bd394a32 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreateOAuthClientRequest.md @@ -0,0 +1,63 @@ +--- +id: beta-create-o-auth-client-request +title: CreateOAuthClientRequest +pagination_label: CreateOAuthClientRequest +sidebar_label: CreateOAuthClientRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateOAuthClientRequest', 'BetaCreateOAuthClientRequest'] +slug: /tools/sdk/powershell/beta/models/create-o-auth-client-request +tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientRequest', 'BetaCreateOAuthClientRequest'] +--- + + +# CreateOAuthClientRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BusinessName** | Pointer to **String** | The name of the business the API Client should belong to | [optional] +**HomepageUrl** | Pointer to **String** | The homepage URL associated with the owner of the API Client | [optional] +**Name** | **String** | A human-readable name for the API Client | [required] +**Description** | **String** | A description of the API Client | [required] +**AccessTokenValiditySeconds** | **Int32** | The number of seconds an access token generated for this API Client is valid for | [required] +**RefreshTokenValiditySeconds** | Pointer to **Int32** | The number of seconds a refresh token generated for this API Client is valid for | [optional] +**RedirectUris** | Pointer to **[]String** | A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. | [optional] +**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | [required] +**AccessType** | [**AccessType**](access-type) | | [required] +**Type** | Pointer to [**ClientType**](client-type) | | [optional] +**Internal** | Pointer to **Boolean** | An indicator of whether the API Client can be used for requests internal within the product. | [optional] +**Enabled** | **Boolean** | An indicator of whether the API Client is enabled for use | [required] +**StrongAuthSupported** | Pointer to **Boolean** | An indicator of whether the API Client supports strong authentication | [optional] +**ClaimsSupported** | Pointer to **Boolean** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [optional] +**Scope** | Pointer to **[]String** | Scopes of the API Client. If no scope is specified, the client will be created with the default scope ""sp:scopes:all"". This means the API Client will have all the rights of the owner who created it. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateOAuthClientRequest = Initialize-PSSailpoint.BetaCreateOAuthClientRequest -BusinessName Acme-Solar ` + -HomepageUrl http://localhost:12345 ` + -Name Demo API Client ` + -Description An API client used for the authorization_code, refresh_token, and client_credentials flows ` + -AccessTokenValiditySeconds 750 ` + -RefreshTokenValiditySeconds 86400 ` + -RedirectUris [http://localhost:12345, http://localhost:67890] ` + -GrantTypes [AUTHORIZATION_CODE, CLIENT_CREDENTIALS, REFRESH_TOKEN] ` + -AccessType null ` + -Type null ` + -Internal false ` + -Enabled true ` + -StrongAuthSupported false ` + -ClaimsSupported false ` + -Scope [demo:api-client-scope:first, demo:api-client-scope:second] +``` + +- Convert the resource to JSON +```powershell +$CreateOAuthClientRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreateOAuthClientResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreateOAuthClientResponse.md new file mode 100644 index 000000000..05bad6943 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreateOAuthClientResponse.md @@ -0,0 +1,71 @@ +--- +id: beta-create-o-auth-client-response +title: CreateOAuthClientResponse +pagination_label: CreateOAuthClientResponse +sidebar_label: CreateOAuthClientResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateOAuthClientResponse', 'BetaCreateOAuthClientResponse'] +slug: /tools/sdk/powershell/beta/models/create-o-auth-client-response +tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientResponse', 'BetaCreateOAuthClientResponse'] +--- + + +# CreateOAuthClientResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | ID of the OAuth client | [required] +**Secret** | **String** | Secret of the OAuth client (This field is only returned on the intial create call.) | [required] +**BusinessName** | **String** | The name of the business the API Client should belong to | [required] +**HomepageUrl** | **String** | The homepage URL associated with the owner of the API Client | [required] +**Name** | **String** | A human-readable name for the API Client | [required] +**Description** | **String** | A description of the API Client | [required] +**AccessTokenValiditySeconds** | **Int32** | The number of seconds an access token generated for this API Client is valid for | [required] +**RefreshTokenValiditySeconds** | **Int32** | The number of seconds a refresh token generated for this API Client is valid for | [required] +**RedirectUris** | **[]String** | A list of the approved redirect URIs used with the authorization_code flow | [required] +**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | [required] +**AccessType** | [**AccessType**](access-type) | | [required] +**Type** | [**ClientType**](client-type) | | [required] +**Internal** | **Boolean** | An indicator of whether the API Client can be used for requests internal to IDN | [required] +**Enabled** | **Boolean** | An indicator of whether the API Client is enabled for use | [required] +**StrongAuthSupported** | **Boolean** | An indicator of whether the API Client supports strong authentication | [required] +**ClaimsSupported** | **Boolean** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [required] +**Created** | **System.DateTime** | The date and time, down to the millisecond, when the API Client was created | [required] +**Modified** | **System.DateTime** | The date and time, down to the millisecond, when the API Client was last updated | [required] +**Scope** | **[]String** | Scopes of the API Client. | [required] + +## Examples + +- Prepare the resource +```powershell +$CreateOAuthClientResponse = Initialize-PSSailpoint.BetaCreateOAuthClientResponse -Id 2c9180835d2e5168015d32f890ca1581 ` + -Secret 5c32dd9b21adb51c77794d46e71de117a1d0ddb36a7ff941fa28014ab7de2cf3 ` + -BusinessName Acme-Solar ` + -HomepageUrl http://localhost:12345 ` + -Name Demo API Client ` + -Description An API client used for the authorization_code, refresh_token, and client_credentials flows ` + -AccessTokenValiditySeconds 750 ` + -RefreshTokenValiditySeconds 86400 ` + -RedirectUris [http://localhost:12345] ` + -GrantTypes [AUTHORIZATION_CODE, CLIENT_CREDENTIALS, REFRESH_TOKEN] ` + -AccessType null ` + -Type null ` + -Internal false ` + -Enabled true ` + -StrongAuthSupported false ` + -ClaimsSupported false ` + -Created 2017-07-11T18:45:37.098Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Scope [demo:api-client-scope:first, demo:api-client-scope:second] +``` + +- Convert the resource to JSON +```powershell +$CreateOAuthClientResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreatePersonalAccessTokenRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreatePersonalAccessTokenRequest.md new file mode 100644 index 000000000..3888a7664 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreatePersonalAccessTokenRequest.md @@ -0,0 +1,39 @@ +--- +id: beta-create-personal-access-token-request +title: CreatePersonalAccessTokenRequest +pagination_label: CreatePersonalAccessTokenRequest +sidebar_label: CreatePersonalAccessTokenRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreatePersonalAccessTokenRequest', 'BetaCreatePersonalAccessTokenRequest'] +slug: /tools/sdk/powershell/beta/models/create-personal-access-token-request +tags: ['SDK', 'Software Development Kit', 'CreatePersonalAccessTokenRequest', 'BetaCreatePersonalAccessTokenRequest'] +--- + + +# CreatePersonalAccessTokenRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. | [required] +**Scope** | Pointer to **[]String** | Scopes of the personal access token. If no scope is specified, the token will be created with the default scope ""sp:scopes:all"". This means the personal access token will have all the rights of the owner who created it. | [optional] +**AccessTokenValiditySeconds** | Pointer to **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreatePersonalAccessTokenRequest = Initialize-PSSailpoint.BetaCreatePersonalAccessTokenRequest -Name NodeJS Integration ` + -Scope [demo:personal-access-token-scope:first, demo:personal-access-token-scope:second] ` + -AccessTokenValiditySeconds 36900 +``` + +- Convert the resource to JSON +```powershell +$CreatePersonalAccessTokenRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreatePersonalAccessTokenResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreatePersonalAccessTokenResponse.md new file mode 100644 index 000000000..54fddeb29 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreatePersonalAccessTokenResponse.md @@ -0,0 +1,47 @@ +--- +id: beta-create-personal-access-token-response +title: CreatePersonalAccessTokenResponse +pagination_label: CreatePersonalAccessTokenResponse +sidebar_label: CreatePersonalAccessTokenResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreatePersonalAccessTokenResponse', 'BetaCreatePersonalAccessTokenResponse'] +slug: /tools/sdk/powershell/beta/models/create-personal-access-token-response +tags: ['SDK', 'Software Development Kit', 'CreatePersonalAccessTokenResponse', 'BetaCreatePersonalAccessTokenResponse'] +--- + + +# CreatePersonalAccessTokenResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The ID of the personal access token (to be used as the username for Basic Auth). | [required] +**Secret** | **String** | The secret of the personal access token (to be used as the password for Basic Auth). | [required] +**Scope** | **[]String** | Scopes of the personal access token. | [required] +**Name** | **String** | The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. | [required] +**Owner** | [**PatOwner**](pat-owner) | | [required] +**Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required] +**AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [required] + +## Examples + +- Prepare the resource +```powershell +$CreatePersonalAccessTokenResponse = Initialize-PSSailpoint.BetaCreatePersonalAccessTokenResponse -Id 86f1dc6fe8f54414950454cbb11278fa ` + -Secret 1d1bef2b9f426383447f64f69349fc7cac176042578d205c256ba3f37c59adb9 ` + -Scope [demo:personal-access-token-scope:first, demo:personal-access-token-scope:second] ` + -Name NodeJS Integration ` + -Owner null ` + -Created 2017-07-11T18:45:37.098Z ` + -AccessTokenValiditySeconds 36900 +``` + +- Convert the resource to JSON +```powershell +$CreatePersonalAccessTokenResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreateWorkflowRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreateWorkflowRequest.md new file mode 100644 index 000000000..4ef16cb0e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CreateWorkflowRequest.md @@ -0,0 +1,45 @@ +--- +id: beta-create-workflow-request +title: CreateWorkflowRequest +pagination_label: CreateWorkflowRequest +sidebar_label: CreateWorkflowRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateWorkflowRequest', 'BetaCreateWorkflowRequest'] +slug: /tools/sdk/powershell/beta/models/create-workflow-request +tags: ['SDK', 'Software Development Kit', 'CreateWorkflowRequest', 'BetaCreateWorkflowRequest'] +--- + + +# CreateWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | The name of the workflow | [required] +**Owner** | [**WorkflowBodyOwner**](workflow-body-owner) | | [required] +**Description** | Pointer to **String** | Description of what the workflow accomplishes | [optional] +**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] +**Enabled** | Pointer to **Boolean** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to $false] +**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateWorkflowRequest = Initialize-PSSailpoint.BetaCreateWorkflowRequest -Name Send Email ` + -Owner null ` + -Description Send an email to the identity who's attributes changed. ` + -Definition null ` + -Enabled false ` + -Trigger null +``` + +- Convert the resource to JSON +```powershell +$CreateWorkflowRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CustomPasswordInstruction.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CustomPasswordInstruction.md new file mode 100644 index 000000000..89781a51c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/CustomPasswordInstruction.md @@ -0,0 +1,39 @@ +--- +id: beta-custom-password-instruction +title: CustomPasswordInstruction +pagination_label: CustomPasswordInstruction +sidebar_label: CustomPasswordInstruction +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CustomPasswordInstruction', 'BetaCustomPasswordInstruction'] +slug: /tools/sdk/powershell/beta/models/custom-password-instruction +tags: ['SDK', 'Software Development Kit', 'CustomPasswordInstruction', 'BetaCustomPasswordInstruction'] +--- + + +# CustomPasswordInstruction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PageId** | Pointer to **Enum** [ "change-password:enter-password", "change-password:finish", "flow-selection:select", "forget-username:user-email", "mfa:enter-code", "mfa:enter-kba", "mfa:select", "reset-password:enter-password", "reset-password:enter-username", "reset-password:finish", "unlock-account:enter-username", "unlock-account:finish" ] | The page ID that represents the page for forget user name, reset password and unlock account flow. | [optional] +**PageContent** | Pointer to **String** | The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. If the customization text includes a link, like `...` clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to ""_blank"" like this: `link`. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target. | [optional] +**Locale** | Pointer to **String** | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". | [optional] + +## Examples + +- Prepare the resource +```powershell +$CustomPasswordInstruction = Initialize-PSSailpoint.BetaCustomPasswordInstruction -PageId change-password:enter-password ` + -PageContent Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter. ` + -Locale en +``` + +- Convert the resource to JSON +```powershell +$CustomPasswordInstruction | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DateCompare.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DateCompare.md new file mode 100644 index 000000000..d0f1e6628 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DateCompare.md @@ -0,0 +1,47 @@ +--- +id: beta-date-compare +title: DateCompare +pagination_label: DateCompare +sidebar_label: DateCompare +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DateCompare', 'BetaDateCompare'] +slug: /tools/sdk/powershell/beta/models/date-compare +tags: ['SDK', 'Software Development Kit', 'DateCompare', 'BetaDateCompare'] +--- + + +# DateCompare + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FirstDate** | [**DateCompareFirstDate**](date-compare-first-date) | | [required] +**SecondDate** | [**DateCompareSecondDate**](date-compare-second-date) | | [required] +**Operator** | **Enum** [ "LT", "LTE", "GT", "GTE" ] | This is the comparison to perform. | Operation | Description | | --------- | ------- | | LT | Strictly less than: `firstDate < secondDate` | | LTE | Less than or equal to: `firstDate <= secondDate` | | GT | Strictly greater than: `firstDate > secondDate` | | GTE | Greater than or equal to: `firstDate >= secondDate` | | [required] +**PositiveCondition** | **String** | The output of the transform if the expression evalutes to true | [required] +**NegativeCondition** | **String** | The output of the transform if the expression evalutes to false | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$DateCompare = Initialize-PSSailpoint.BetaDateCompare -FirstDate null ` + -SecondDate null ` + -Operator LT ` + -PositiveCondition true ` + -NegativeCondition false ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$DateCompare | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DateCompareFirstDate.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DateCompareFirstDate.md new file mode 100644 index 000000000..9be452437 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DateCompareFirstDate.md @@ -0,0 +1,55 @@ +--- +id: beta-date-compare-first-date +title: DateCompareFirstDate +pagination_label: DateCompareFirstDate +sidebar_label: DateCompareFirstDate +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DateCompareFirstDate', 'BetaDateCompareFirstDate'] +slug: /tools/sdk/powershell/beta/models/date-compare-first-date +tags: ['SDK', 'Software Development Kit', 'DateCompareFirstDate', 'BetaDateCompareFirstDate'] +--- + + +# DateCompareFirstDate + +## Properties + +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] +**InputFormat** | Pointer to [**DateFormatInputFormat**](date-format-input-format) | | [optional] +**OutputFormat** | Pointer to [**DateFormatOutputFormat**](date-format-output-format) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$DateCompareFirstDate = Initialize-PSSailpoint.BetaDateCompareFirstDate -SourceName Workday ` + -AttributeName DEPARTMENT ` + -AccountSortAttribute created ` + -AccountSortDescending false ` + -AccountReturnFirstLink false ` + -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` + -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` + -InputFormat null ` + -OutputFormat null +``` + +- Convert the resource to JSON +```powershell +$DateCompareFirstDate | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DateCompareSecondDate.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DateCompareSecondDate.md new file mode 100644 index 000000000..6392c8af5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DateCompareSecondDate.md @@ -0,0 +1,55 @@ +--- +id: beta-date-compare-second-date +title: DateCompareSecondDate +pagination_label: DateCompareSecondDate +sidebar_label: DateCompareSecondDate +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DateCompareSecondDate', 'BetaDateCompareSecondDate'] +slug: /tools/sdk/powershell/beta/models/date-compare-second-date +tags: ['SDK', 'Software Development Kit', 'DateCompareSecondDate', 'BetaDateCompareSecondDate'] +--- + + +# DateCompareSecondDate + +## Properties + +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] +**InputFormat** | Pointer to [**DateFormatInputFormat**](date-format-input-format) | | [optional] +**OutputFormat** | Pointer to [**DateFormatOutputFormat**](date-format-output-format) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$DateCompareSecondDate = Initialize-PSSailpoint.BetaDateCompareSecondDate -SourceName Workday ` + -AttributeName DEPARTMENT ` + -AccountSortAttribute created ` + -AccountSortDescending false ` + -AccountReturnFirstLink false ` + -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` + -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` + -InputFormat null ` + -OutputFormat null +``` + +- Convert the resource to JSON +```powershell +$DateCompareSecondDate | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DateFormat.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DateFormat.md new file mode 100644 index 000000000..273f4c76e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DateFormat.md @@ -0,0 +1,41 @@ +--- +id: beta-date-format +title: DateFormat +pagination_label: DateFormat +sidebar_label: DateFormat +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DateFormat', 'BetaDateFormat'] +slug: /tools/sdk/powershell/beta/models/date-format +tags: ['SDK', 'Software Development Kit', 'DateFormat', 'BetaDateFormat'] +--- + + +# DateFormat + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InputFormat** | Pointer to [**DateFormatInputFormat**](date-format-input-format) | | [optional] +**OutputFormat** | Pointer to [**DateFormatOutputFormat**](date-format-output-format) | | [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] + +## Examples + +- Prepare the resource +```powershell +$DateFormat = Initialize-PSSailpoint.BetaDateFormat -InputFormat null ` + -OutputFormat null ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$DateFormat | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DateFormatInputFormat.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DateFormatInputFormat.md new file mode 100644 index 000000000..743286b0f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DateFormatInputFormat.md @@ -0,0 +1,34 @@ +--- +id: beta-date-format-input-format +title: DateFormatInputFormat +pagination_label: DateFormatInputFormat +sidebar_label: DateFormatInputFormat +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DateFormatInputFormat', 'BetaDateFormatInputFormat'] +slug: /tools/sdk/powershell/beta/models/date-format-input-format +tags: ['SDK', 'Software Development Kit', 'DateFormatInputFormat', 'BetaDateFormatInputFormat'] +--- + + +# DateFormatInputFormat + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$DateFormatInputFormat = Initialize-PSSailpoint.BetaDateFormatInputFormat +``` + +- Convert the resource to JSON +```powershell +$DateFormatInputFormat | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DateFormatOutputFormat.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DateFormatOutputFormat.md new file mode 100644 index 000000000..1a5371ef3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DateFormatOutputFormat.md @@ -0,0 +1,34 @@ +--- +id: beta-date-format-output-format +title: DateFormatOutputFormat +pagination_label: DateFormatOutputFormat +sidebar_label: DateFormatOutputFormat +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DateFormatOutputFormat', 'BetaDateFormatOutputFormat'] +slug: /tools/sdk/powershell/beta/models/date-format-output-format +tags: ['SDK', 'Software Development Kit', 'DateFormatOutputFormat', 'BetaDateFormatOutputFormat'] +--- + + +# DateFormatOutputFormat + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$DateFormatOutputFormat = Initialize-PSSailpoint.BetaDateFormatOutputFormat +``` + +- Convert the resource to JSON +```powershell +$DateFormatOutputFormat | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DateMath.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DateMath.md new file mode 100644 index 000000000..566b7360c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DateMath.md @@ -0,0 +1,41 @@ +--- +id: beta-date-math +title: DateMath +pagination_label: DateMath +sidebar_label: DateMath +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DateMath', 'BetaDateMath'] +slug: /tools/sdk/powershell/beta/models/date-math +tags: ['SDK', 'Software Development Kit', 'DateMath', 'BetaDateMath'] +--- + + +# DateMath + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Expression** | **String** | A string value of the date and time components to operation on, along with the math operations to execute. | [required] +**RoundUp** | Pointer to **Boolean** | A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. If not provided, the transform will default to `false` `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) | [optional] [default to $false] +**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] + +## Examples + +- Prepare the resource +```powershell +$DateMath = Initialize-PSSailpoint.BetaDateMath -Expression now+1w ` + -RoundUp false ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$DateMath | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DecomposeDiacriticalMarks.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DecomposeDiacriticalMarks.md new file mode 100644 index 000000000..d7fe5e791 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DecomposeDiacriticalMarks.md @@ -0,0 +1,37 @@ +--- +id: beta-decompose-diacritical-marks +title: DecomposeDiacriticalMarks +pagination_label: DecomposeDiacriticalMarks +sidebar_label: DecomposeDiacriticalMarks +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DecomposeDiacriticalMarks', 'BetaDecomposeDiacriticalMarks'] +slug: /tools/sdk/powershell/beta/models/decompose-diacritical-marks +tags: ['SDK', 'Software Development Kit', 'DecomposeDiacriticalMarks', 'BetaDecomposeDiacriticalMarks'] +--- + + +# DecomposeDiacriticalMarks + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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] + +## Examples + +- Prepare the resource +```powershell +$DecomposeDiacriticalMarks = Initialize-PSSailpoint.BetaDecomposeDiacriticalMarks -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$DecomposeDiacriticalMarks | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Delete202Response.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Delete202Response.md new file mode 100644 index 000000000..799c11075 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Delete202Response.md @@ -0,0 +1,39 @@ +--- +id: beta-delete202-response +title: Delete202Response +pagination_label: Delete202Response +sidebar_label: Delete202Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Delete202Response', 'BetaDelete202Response'] +slug: /tools/sdk/powershell/beta/models/delete202-response +tags: ['SDK', 'Software Development Kit', 'Delete202Response', 'BetaDelete202Response'] +--- + + +# Delete202Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "TASK_RESULT" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Task result ID. | [optional] +**Name** | Pointer to **String** | Task result's human-readable display name (this should be null/empty). | [optional] + +## Examples + +- Prepare the resource +```powershell +$Delete202Response = Initialize-PSSailpoint.BetaDelete202Response -Type TASK_RESULT ` + -Id 2c91808779ecf55b0179f720942f181a ` + -Name null +``` + +- Convert the resource to JSON +```powershell +$Delete202Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DeleteCampaignsRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DeleteCampaignsRequest.md new file mode 100644 index 000000000..5867eec65 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DeleteCampaignsRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-delete-campaigns-request +title: DeleteCampaignsRequest +pagination_label: DeleteCampaignsRequest +sidebar_label: DeleteCampaignsRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DeleteCampaignsRequest', 'BetaDeleteCampaignsRequest'] +slug: /tools/sdk/powershell/beta/models/delete-campaigns-request +tags: ['SDK', 'Software Development Kit', 'DeleteCampaignsRequest', 'BetaDeleteCampaignsRequest'] +--- + + +# DeleteCampaignsRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]String** | The ids of the campaigns to delete | [optional] + +## Examples + +- Prepare the resource +```powershell +$DeleteCampaignsRequest = Initialize-PSSailpoint.BetaDeleteCampaignsRequest -Ids [2c9180887335cee10173490db1776c26, 2c9180836a712436016a7125a90c0021] +``` + +- Convert the resource to JSON +```powershell +$DeleteCampaignsRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DeleteNonEmployeeRecordInBulkRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DeleteNonEmployeeRecordInBulkRequest.md new file mode 100644 index 000000000..8906c67cc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DeleteNonEmployeeRecordInBulkRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-delete-non-employee-record-in-bulk-request +title: DeleteNonEmployeeRecordInBulkRequest +pagination_label: DeleteNonEmployeeRecordInBulkRequest +sidebar_label: DeleteNonEmployeeRecordInBulkRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DeleteNonEmployeeRecordInBulkRequest', 'BetaDeleteNonEmployeeRecordInBulkRequest'] +slug: /tools/sdk/powershell/beta/models/delete-non-employee-record-in-bulk-request +tags: ['SDK', 'Software Development Kit', 'DeleteNonEmployeeRecordInBulkRequest', 'BetaDeleteNonEmployeeRecordInBulkRequest'] +--- + + +# DeleteNonEmployeeRecordInBulkRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | **[]String** | List of non-employee ids. | [required] + +## Examples + +- Prepare the resource +```powershell +$DeleteNonEmployeeRecordInBulkRequest = Initialize-PSSailpoint.BetaDeleteNonEmployeeRecordInBulkRequest -Ids null +``` + +- Convert the resource to JSON +```powershell +$DeleteNonEmployeeRecordInBulkRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DeleteVendorConnectorMapping200Response.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DeleteVendorConnectorMapping200Response.md new file mode 100644 index 000000000..dabd6446a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DeleteVendorConnectorMapping200Response.md @@ -0,0 +1,35 @@ +--- +id: beta-delete-vendor-connector-mapping200-response +title: DeleteVendorConnectorMapping200Response +pagination_label: DeleteVendorConnectorMapping200Response +sidebar_label: DeleteVendorConnectorMapping200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DeleteVendorConnectorMapping200Response', 'BetaDeleteVendorConnectorMapping200Response'] +slug: /tools/sdk/powershell/beta/models/delete-vendor-connector-mapping200-response +tags: ['SDK', 'Software Development Kit', 'DeleteVendorConnectorMapping200Response', 'BetaDeleteVendorConnectorMapping200Response'] +--- + + +# DeleteVendorConnectorMapping200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | Pointer to **Int32** | The number of vendor connector mappings successfully deleted. | [optional] + +## Examples + +- Prepare the resource +```powershell +$DeleteVendorConnectorMapping200Response = Initialize-PSSailpoint.BetaDeleteVendorConnectorMapping200Response -Count 1 +``` + +- Convert the resource to JSON +```powershell +$DeleteVendorConnectorMapping200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DimensionRef.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DimensionRef.md new file mode 100644 index 000000000..bdb873445 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DimensionRef.md @@ -0,0 +1,39 @@ +--- +id: beta-dimension-ref +title: DimensionRef +pagination_label: DimensionRef +sidebar_label: DimensionRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DimensionRef', 'BetaDimensionRef'] +slug: /tools/sdk/powershell/beta/models/dimension-ref +tags: ['SDK', 'Software Development Kit', 'DimensionRef', 'BetaDimensionRef'] +--- + + +# DimensionRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "DIMENSION" ] | The type of the object to which this reference applies | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] + +## Examples + +- Prepare the resource +```powershell +$DimensionRef = Initialize-PSSailpoint.BetaDimensionRef -Type DIMENSION ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name Role 2 +``` + +- Convert the resource to JSON +```powershell +$DimensionRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DkimAttributes.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DkimAttributes.md new file mode 100644 index 000000000..8e7fe45ab --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DkimAttributes.md @@ -0,0 +1,43 @@ +--- +id: beta-dkim-attributes +title: DkimAttributes +pagination_label: DkimAttributes +sidebar_label: DkimAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DkimAttributes', 'BetaDkimAttributes'] +slug: /tools/sdk/powershell/beta/models/dkim-attributes +tags: ['SDK', 'Software Development Kit', 'DkimAttributes', 'BetaDkimAttributes'] +--- + + +# DkimAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | UUID associated with domain to be verified | [optional] +**Address** | Pointer to **String** | The identity or domain address | [optional] +**DkimEnabled** | Pointer to **Boolean** | Whether or not DKIM has been enabled for this domain / identity | [optional] [default to $false] +**DkimTokens** | Pointer to **[]String** | The tokens to be added to a DNS for verification | [optional] +**DkimVerificationStatus** | Pointer to **String** | The current status if the domain /identity has been verified. Ie Success, Failed, Pending | [optional] + +## Examples + +- Prepare the resource +```powershell +$DkimAttributes = Initialize-PSSailpoint.BetaDkimAttributes -Id 123b45b0-aaaa-bbbb-a7db-123456a56abc ` + -Address BobSmith@sailpoint.com ` + -DkimEnabled true ` + -DkimTokens [uq1m3jjk25ckd3whl4n7y46c56r5l6aq, u7pm38jky9ckdawhlsn7y4dcj6f5lpgq, uhpm3jjkjjckdkwhlqn7yw6cjer5tpay] ` + -DkimVerificationStatus Success +``` + +- Convert the resource to JSON +```powershell +$DkimAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DomainAddress.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DomainAddress.md new file mode 100644 index 000000000..0a9b8fa98 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DomainAddress.md @@ -0,0 +1,35 @@ +--- +id: beta-domain-address +title: DomainAddress +pagination_label: DomainAddress +sidebar_label: DomainAddress +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DomainAddress', 'BetaDomainAddress'] +slug: /tools/sdk/powershell/beta/models/domain-address +tags: ['SDK', 'Software Development Kit', 'DomainAddress', 'BetaDomainAddress'] +--- + + +# DomainAddress + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Domain** | Pointer to **String** | A domain address | [optional] + +## Examples + +- Prepare the resource +```powershell +$DomainAddress = Initialize-PSSailpoint.BetaDomainAddress -Domain sailpoint.com +``` + +- Convert the resource to JSON +```powershell +$DomainAddress | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DomainStatusDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DomainStatusDto.md new file mode 100644 index 000000000..4a0e2e3b2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DomainStatusDto.md @@ -0,0 +1,43 @@ +--- +id: beta-domain-status-dto +title: DomainStatusDto +pagination_label: DomainStatusDto +sidebar_label: DomainStatusDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DomainStatusDto', 'BetaDomainStatusDto'] +slug: /tools/sdk/powershell/beta/models/domain-status-dto +tags: ['SDK', 'Software Development Kit', 'DomainStatusDto', 'BetaDomainStatusDto'] +--- + + +# DomainStatusDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | New UUID associated with domain to be verified | [optional] +**Domain** | Pointer to **String** | A domain address | [optional] +**DkimEnabled** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | DKIM is enabled for this domain | [optional] +**DkimTokens** | Pointer to **[]String** | DKIM tokens required for authentication | [optional] +**DkimVerificationStatus** | Pointer to **String** | Status of DKIM authentication | [optional] + +## Examples + +- Prepare the resource +```powershell +$DomainStatusDto = Initialize-PSSailpoint.BetaDomainStatusDto -Id 123b45b0-aaaa-bbbb-a7db-123456a56abc ` + -Domain sailpoint.com ` + -DkimEnabled true ` + -DkimTokens [token1, token2, token3] ` + -DkimVerificationStatus PENDING +``` + +- Convert the resource to JSON +```powershell +$DomainStatusDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DtoType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DtoType.md new file mode 100644 index 000000000..69684e226 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DtoType.md @@ -0,0 +1,78 @@ +--- +id: beta-dto-type +title: DtoType +pagination_label: DtoType +sidebar_label: DtoType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DtoType', 'BetaDtoType'] +slug: /tools/sdk/powershell/beta/models/dto-type +tags: ['SDK', 'Software Development Kit', 'DtoType', 'BetaDtoType'] +--- + + +# DtoType + +## Enum + + +* `ACCOUNT_CORRELATION_CONFIG` (value: `"ACCOUNT_CORRELATION_CONFIG"`) + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ACCESS_REQUEST_APPROVAL` (value: `"ACCESS_REQUEST_APPROVAL"`) + +* `ACCOUNT` (value: `"ACCOUNT"`) + +* `APPLICATION` (value: `"APPLICATION"`) + +* `CAMPAIGN` (value: `"CAMPAIGN"`) + +* `CAMPAIGN_FILTER` (value: `"CAMPAIGN_FILTER"`) + +* `CERTIFICATION` (value: `"CERTIFICATION"`) + +* `CLUSTER` (value: `"CLUSTER"`) + +* `CONNECTOR_SCHEMA` (value: `"CONNECTOR_SCHEMA"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + +* `GOVERNANCE_GROUP` (value: `"GOVERNANCE_GROUP"`) + +* `IDENTITY` (value: `"IDENTITY"`) + +* `IDENTITY_PROFILE` (value: `"IDENTITY_PROFILE"`) + +* `IDENTITY_REQUEST` (value: `"IDENTITY_REQUEST"`) + +* `MACHINE_IDENTITY` (value: `"MACHINE_IDENTITY"`) + +* `LIFECYCLE_STATE` (value: `"LIFECYCLE_STATE"`) + +* `PASSWORD_POLICY` (value: `"PASSWORD_POLICY"`) + +* `ROLE` (value: `"ROLE"`) + +* `RULE` (value: `"RULE"`) + +* `SOD_POLICY` (value: `"SOD_POLICY"`) + +* `SOURCE` (value: `"SOURCE"`) + +* `TAG` (value: `"TAG"`) + +* `TAG_CATEGORY` (value: `"TAG_CATEGORY"`) + +* `TASK_RESULT` (value: `"TASK_RESULT"`) + +* `REPORT_RESULT` (value: `"REPORT_RESULT"`) + +* `SOD_VIOLATION` (value: `"SOD_VIOLATION"`) + +* `ACCOUNT_ACTIVITY` (value: `"ACCOUNT_ACTIVITY"`) + +* `WORKGROUP` (value: `"WORKGROUP"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DuoVerificationRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DuoVerificationRequest.md new file mode 100644 index 000000000..8d43715db --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/DuoVerificationRequest.md @@ -0,0 +1,37 @@ +--- +id: beta-duo-verification-request +title: DuoVerificationRequest +pagination_label: DuoVerificationRequest +sidebar_label: DuoVerificationRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DuoVerificationRequest', 'BetaDuoVerificationRequest'] +slug: /tools/sdk/powershell/beta/models/duo-verification-request +tags: ['SDK', 'Software Development Kit', 'DuoVerificationRequest', 'BetaDuoVerificationRequest'] +--- + + +# DuoVerificationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserId** | **String** | User id for Verification request. | [required] +**SignedResponse** | **String** | User id for Verification request. | [required] + +## Examples + +- Prepare the resource +```powershell +$DuoVerificationRequest = Initialize-PSSailpoint.BetaDuoVerificationRequest -UserId 2c9180947f0ef465017f215cbcfd004b ` + -SignedResponse AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2 +``` + +- Convert the resource to JSON +```powershell +$DuoVerificationRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/E164phone.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/E164phone.md new file mode 100644 index 000000000..4b29ce5f8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/E164phone.md @@ -0,0 +1,39 @@ +--- +id: beta-e164phone +title: E164phone +pagination_label: E164phone +sidebar_label: E164phone +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'E164phone', 'BetaE164phone'] +slug: /tools/sdk/powershell/beta/models/e164phone +tags: ['SDK', 'Software Development Kit', 'E164phone', 'BetaE164phone'] +--- + + +# E164phone + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DefaultRegion** | Pointer to **String** | This is an optional attribute that can be used to define the region of the phone number to format into. If defaultRegion is not provided, it will take US as the default country. The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) | [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] + +## Examples + +- Prepare the resource +```powershell +$E164phone = Initialize-PSSailpoint.BetaE164phone -DefaultRegion US ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$E164phone | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EmailNotificationOption.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EmailNotificationOption.md new file mode 100644 index 000000000..15e678c30 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EmailNotificationOption.md @@ -0,0 +1,41 @@ +--- +id: beta-email-notification-option +title: EmailNotificationOption +pagination_label: EmailNotificationOption +sidebar_label: EmailNotificationOption +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EmailNotificationOption', 'BetaEmailNotificationOption'] +slug: /tools/sdk/powershell/beta/models/email-notification-option +tags: ['SDK', 'Software Development Kit', 'EmailNotificationOption', 'BetaEmailNotificationOption'] +--- + + +# EmailNotificationOption + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NotifyManagers** | Pointer to **Boolean** | If true, then the manager is notified of the lifecycle state change. | [optional] [default to $false] +**NotifyAllAdmins** | Pointer to **Boolean** | If true, then all the admins are notified of the lifecycle state change. | [optional] [default to $false] +**NotifySpecificUsers** | Pointer to **Boolean** | If true, then the users specified in ""emailAddressList"" below are notified of lifecycle state change. | [optional] [default to $false] +**EmailAddressList** | Pointer to **[]String** | List of user email addresses. If ""notifySpecificUsers"" option is true, then these users are notified of lifecycle state change. | [optional] + +## Examples + +- Prepare the resource +```powershell +$EmailNotificationOption = Initialize-PSSailpoint.BetaEmailNotificationOption -NotifyManagers true ` + -NotifyAllAdmins true ` + -NotifySpecificUsers true ` + -EmailAddressList [test@test.com, test2@test.com] +``` + +- Convert the resource to JSON +```powershell +$EmailNotificationOption | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EmailStatusDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EmailStatusDto.md new file mode 100644 index 000000000..e92f6f61d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EmailStatusDto.md @@ -0,0 +1,41 @@ +--- +id: beta-email-status-dto +title: EmailStatusDto +pagination_label: EmailStatusDto +sidebar_label: EmailStatusDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EmailStatusDto', 'BetaEmailStatusDto'] +slug: /tools/sdk/powershell/beta/models/email-status-dto +tags: ['SDK', 'Software Development Kit', 'EmailStatusDto', 'BetaEmailStatusDto'] +--- + + +# EmailStatusDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | | [optional] +**Email** | Pointer to **String** | | [optional] +**IsVerifiedByDomain** | Pointer to **Boolean** | | [optional] +**VerificationStatus** | Pointer to **Enum** [ "PENDING", "SUCCESS", "FAILED" ] | | [optional] + +## Examples + +- Prepare the resource +```powershell +$EmailStatusDto = Initialize-PSSailpoint.BetaEmailStatusDto -Id null ` + -Email sender@example.com ` + -IsVerifiedByDomain false ` + -VerificationStatus null +``` + +- Convert the resource to JSON +```powershell +$EmailStatusDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Entitlement.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Entitlement.md new file mode 100644 index 000000000..152a01e50 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Entitlement.md @@ -0,0 +1,69 @@ +--- +id: beta-entitlement +title: Entitlement +pagination_label: Entitlement +sidebar_label: Entitlement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Entitlement', 'BetaEntitlement'] +slug: /tools/sdk/powershell/beta/models/entitlement +tags: ['SDK', 'Software Development Kit', 'Entitlement', 'BetaEntitlement'] +--- + + +# Entitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The entitlement id | [optional] +**Name** | Pointer to **String** | The entitlement name | [optional] +**Created** | Pointer to **System.DateTime** | Time when the entitlement was created | [optional] +**Modified** | Pointer to **System.DateTime** | Time when the entitlement was last modified | [optional] +**Attribute** | Pointer to **String** | The entitlement attribute name | [optional] +**Value** | Pointer to **String** | The value of the entitlement | [optional] +**SourceSchemaObjectType** | Pointer to **String** | The object type of the entitlement from the source schema | [optional] +**Privileged** | Pointer to **Boolean** | True if the entitlement is privileged | [optional] [default to $false] +**CloudGoverned** | Pointer to **Boolean** | True if the entitlement is cloud governed | [optional] [default to $false] +**Description** | Pointer to **String** | The description of the entitlement | [optional] +**Requestable** | Pointer to **Boolean** | True if the entitlement is requestable | [optional] [default to $false] +**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map of free-form key-value pairs from the source system | [optional] +**Source** | Pointer to [**EntitlementSource**](entitlement-source) | | [optional] +**Owner** | Pointer to [**EntitlementOwner**](entitlement-owner) | | [optional] +**DirectPermissions** | Pointer to [**[]PermissionDto**](permission-dto) | | [optional] +**Segments** | Pointer to **[]String** | List of IDs of segments, if any, to which this Entitlement is assigned. | [optional] +**ManuallyUpdatedFields** | Pointer to [**EntitlementManuallyUpdatedFields**](entitlement-manually-updated-fields) | | [optional] +**AccessModelMetadata** | Pointer to [**EntitlementAccessModelMetadata**](entitlement-access-model-metadata) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Entitlement = Initialize-PSSailpoint.BetaEntitlement -Id 2c91808874ff91550175097daaec161c ` + -Name LauncherTest2 ` + -Created 2020-10-08T18:33:52.029Z ` + -Modified 2020-10-08T18:33:52.029Z ` + -Attribute memberOf ` + -Value CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` + -SourceSchemaObjectType group ` + -Privileged true ` + -CloudGoverned true ` + -Description CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` + -Requestable true ` + -Attributes {fieldName=fieldValue} ` + -Source null ` + -Owner null ` + -DirectPermissions null ` + -Segments [f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a] ` + -ManuallyUpdatedFields null ` + -AccessModelMetadata null +``` + +- Convert the resource to JSON +```powershell +$Entitlement | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementAccessModelMetadata.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementAccessModelMetadata.md new file mode 100644 index 000000000..a267d5a06 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementAccessModelMetadata.md @@ -0,0 +1,35 @@ +--- +id: beta-entitlement-access-model-metadata +title: EntitlementAccessModelMetadata +pagination_label: EntitlementAccessModelMetadata +sidebar_label: EntitlementAccessModelMetadata +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementAccessModelMetadata', 'BetaEntitlementAccessModelMetadata'] +slug: /tools/sdk/powershell/beta/models/entitlement-access-model-metadata +tags: ['SDK', 'Software Development Kit', 'EntitlementAccessModelMetadata', 'BetaEntitlementAccessModelMetadata'] +--- + + +# EntitlementAccessModelMetadata + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**[]AttributeDTO**](attribute-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$EntitlementAccessModelMetadata = Initialize-PSSailpoint.BetaEntitlementAccessModelMetadata -Attributes [{key=iscPrivacy, name=Privacy, multiselect=false, status=active, type=governance, objectTypes=[all], description=Specifies the level of privacy associated with an access item., values=[{value=public, name=Public, status=active}]}] +``` + +- Convert the resource to JSON +```powershell +$EntitlementAccessModelMetadata | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementAccessRequestConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementAccessRequestConfig.md new file mode 100644 index 000000000..467a4995c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementAccessRequestConfig.md @@ -0,0 +1,39 @@ +--- +id: beta-entitlement-access-request-config +title: EntitlementAccessRequestConfig +pagination_label: EntitlementAccessRequestConfig +sidebar_label: EntitlementAccessRequestConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementAccessRequestConfig', 'BetaEntitlementAccessRequestConfig'] +slug: /tools/sdk/powershell/beta/models/entitlement-access-request-config +tags: ['SDK', 'Software Development Kit', 'EntitlementAccessRequestConfig', 'BetaEntitlementAccessRequestConfig'] +--- + + +# EntitlementAccessRequestConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalSchemes** | Pointer to [**[]EntitlementApprovalScheme**](entitlement-approval-scheme) | Ordered list of approval steps for the access request. Empty when no approval is required. | [optional] +**RequestCommentRequired** | Pointer to **Boolean** | If the requester must provide a comment during access request. | [optional] [default to $false] +**DenialCommentRequired** | Pointer to **Boolean** | If the reviewer must provide a comment when denying the access request. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$EntitlementAccessRequestConfig = Initialize-PSSailpoint.BetaEntitlementAccessRequestConfig -ApprovalSchemes null ` + -RequestCommentRequired true ` + -DenialCommentRequired false +``` + +- Convert the resource to JSON +```powershell +$EntitlementAccessRequestConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementApprovalScheme.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementApprovalScheme.md new file mode 100644 index 000000000..25b662845 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementApprovalScheme.md @@ -0,0 +1,37 @@ +--- +id: beta-entitlement-approval-scheme +title: EntitlementApprovalScheme +pagination_label: EntitlementApprovalScheme +sidebar_label: EntitlementApprovalScheme +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementApprovalScheme', 'BetaEntitlementApprovalScheme'] +slug: /tools/sdk/powershell/beta/models/entitlement-approval-scheme +tags: ['SDK', 'Software Development Kit', 'EntitlementApprovalScheme', 'BetaEntitlementApprovalScheme'] +--- + + +# EntitlementApprovalScheme + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApproverType** | Pointer to **Enum** [ "ENTITLEMENT_OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **ENTITLEMENT_OWNER**: Owner of the associated Entitlement **SOURCE_OWNER**: Owner of the associated Source **MANAGER**: Manager of the Identity for whom the request is being made **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] + +## Examples + +- Prepare the resource +```powershell +$EntitlementApprovalScheme = Initialize-PSSailpoint.BetaEntitlementApprovalScheme -ApproverType GOVERNANCE_GROUP ` + -ApproverId e3eab852-8315-467f-9de7-70eda97f63c8 +``` + +- Convert the resource to JSON +```powershell +$EntitlementApprovalScheme | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementBulkUpdateRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementBulkUpdateRequest.md new file mode 100644 index 000000000..60033e199 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementBulkUpdateRequest.md @@ -0,0 +1,37 @@ +--- +id: beta-entitlement-bulk-update-request +title: EntitlementBulkUpdateRequest +pagination_label: EntitlementBulkUpdateRequest +sidebar_label: EntitlementBulkUpdateRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementBulkUpdateRequest', 'BetaEntitlementBulkUpdateRequest'] +slug: /tools/sdk/powershell/beta/models/entitlement-bulk-update-request +tags: ['SDK', 'Software Development Kit', 'EntitlementBulkUpdateRequest', 'BetaEntitlementBulkUpdateRequest'] +--- + + +# EntitlementBulkUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EntitlementIds** | **[]String** | List of entitlement ids to update | [required] +**JsonPatch** | [**[]JsonPatchOperation**](json-patch-operation) | | [required] + +## Examples + +- Prepare the resource +```powershell +$EntitlementBulkUpdateRequest = Initialize-PSSailpoint.BetaEntitlementBulkUpdateRequest -EntitlementIds [2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e, 2c91808a7624751a01762f19d692220f] ` + -JsonPatch [{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}] +``` + +- Convert the resource to JSON +```powershell +$EntitlementBulkUpdateRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementManuallyUpdatedFields.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementManuallyUpdatedFields.md new file mode 100644 index 000000000..6d2849653 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementManuallyUpdatedFields.md @@ -0,0 +1,37 @@ +--- +id: beta-entitlement-manually-updated-fields +title: EntitlementManuallyUpdatedFields +pagination_label: EntitlementManuallyUpdatedFields +sidebar_label: EntitlementManuallyUpdatedFields +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementManuallyUpdatedFields', 'BetaEntitlementManuallyUpdatedFields'] +slug: /tools/sdk/powershell/beta/models/entitlement-manually-updated-fields +tags: ['SDK', 'Software Development Kit', 'EntitlementManuallyUpdatedFields', 'BetaEntitlementManuallyUpdatedFields'] +--- + + +# EntitlementManuallyUpdatedFields + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DISPLAYNAME** | Pointer to **Boolean** | True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `name` property. | [optional] [default to $false] +**DESCRIPTION** | Pointer to **Boolean** | True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `description` property. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$EntitlementManuallyUpdatedFields = Initialize-PSSailpoint.BetaEntitlementManuallyUpdatedFields -DISPLAYNAME true ` + -DESCRIPTION true +``` + +- Convert the resource to JSON +```powershell +$EntitlementManuallyUpdatedFields | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementOwner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementOwner.md new file mode 100644 index 000000000..c4f51e66b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementOwner.md @@ -0,0 +1,39 @@ +--- +id: beta-entitlement-owner +title: EntitlementOwner +pagination_label: EntitlementOwner +sidebar_label: EntitlementOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementOwner', 'BetaEntitlementOwner'] +slug: /tools/sdk/powershell/beta/models/entitlement-owner +tags: ['SDK', 'Software Development Kit', 'EntitlementOwner', 'BetaEntitlementOwner'] +--- + + +# EntitlementOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The owner id for the entitlement | [optional] +**Name** | Pointer to **String** | The owner name for the entitlement | [optional] +**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of the owner. Initially only type IDENTITY is supported | [optional] + +## Examples + +- Prepare the resource +```powershell +$EntitlementOwner = Initialize-PSSailpoint.BetaEntitlementOwner -Id 2a2fdacca5e345f18bf7970cfbb8fec2 ` + -Name identity 1 ` + -Type IDENTITY +``` + +- Convert the resource to JSON +```powershell +$EntitlementOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementRef.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementRef.md new file mode 100644 index 000000000..c4c28a6b4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementRef.md @@ -0,0 +1,39 @@ +--- +id: beta-entitlement-ref +title: EntitlementRef +pagination_label: EntitlementRef +sidebar_label: EntitlementRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementRef', 'BetaEntitlementRef'] +slug: /tools/sdk/powershell/beta/models/entitlement-ref +tags: ['SDK', 'Software Development Kit', 'EntitlementRef', 'BetaEntitlementRef'] +--- + + +# EntitlementRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | Entitlement's DTO type. | [optional] +**Id** | Pointer to **String** | Entitlement's ID. | [optional] +**Name** | Pointer to **String** | Entitlement's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$EntitlementRef = Initialize-PSSailpoint.BetaEntitlementRef -Type ENTITLEMENT ` + -Id 2c91809773dee32014e13e122092014e ` + -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local +``` + +- Convert the resource to JSON +```powershell +$EntitlementRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementRequestConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementRequestConfig.md new file mode 100644 index 000000000..d6e36c7ce --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementRequestConfig.md @@ -0,0 +1,35 @@ +--- +id: beta-entitlement-request-config +title: EntitlementRequestConfig +pagination_label: EntitlementRequestConfig +sidebar_label: EntitlementRequestConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementRequestConfig', 'BetaEntitlementRequestConfig'] +slug: /tools/sdk/powershell/beta/models/entitlement-request-config +tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig', 'BetaEntitlementRequestConfig'] +--- + + +# EntitlementRequestConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestConfig** | Pointer to [**EntitlementAccessRequestConfig**](entitlement-access-request-config) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$EntitlementRequestConfig = Initialize-PSSailpoint.BetaEntitlementRequestConfig -AccessRequestConfig null +``` + +- Convert the resource to JSON +```powershell +$EntitlementRequestConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementRequestConfig1.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementRequestConfig1.md new file mode 100644 index 000000000..55ee279c0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementRequestConfig1.md @@ -0,0 +1,41 @@ +--- +id: beta-entitlement-request-config1 +title: EntitlementRequestConfig1 +pagination_label: EntitlementRequestConfig1 +sidebar_label: EntitlementRequestConfig1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementRequestConfig1', 'BetaEntitlementRequestConfig1'] +slug: /tools/sdk/powershell/beta/models/entitlement-request-config1 +tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig1', 'BetaEntitlementRequestConfig1'] +--- + + +# EntitlementRequestConfig1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AllowEntitlementRequest** | Pointer to **Boolean** | If this is true, entitlement requests are allowed. | [optional] [default to $false] +**RequestCommentsRequired** | Pointer to **Boolean** | If this is true, comments are required to submit entitlement requests. | [optional] [default to $false] +**DeniedCommentsRequired** | Pointer to **Boolean** | If this is true, comments are required to reject entitlement requests. | [optional] [default to $false] +**GrantRequestApprovalSchemes** | Pointer to **String** | Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are ""entitlementOwner"", ""sourceOwner"", ""manager"" and ""`workgroup:{id}`"". You can use multiple governance groups (workgroups). | [optional] [default to "sourceOwner"] + +## Examples + +- Prepare the resource +```powershell +$EntitlementRequestConfig1 = Initialize-PSSailpoint.BetaEntitlementRequestConfig1 -AllowEntitlementRequest true ` + -RequestCommentsRequired false ` + -DeniedCommentsRequired false ` + -GrantRequestApprovalSchemes entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584 +``` + +- Convert the resource to JSON +```powershell +$EntitlementRequestConfig1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementSource.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementSource.md new file mode 100644 index 000000000..08d599176 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementSource.md @@ -0,0 +1,39 @@ +--- +id: beta-entitlement-source +title: EntitlementSource +pagination_label: EntitlementSource +sidebar_label: EntitlementSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementSource', 'BetaEntitlementSource'] +slug: /tools/sdk/powershell/beta/models/entitlement-source +tags: ['SDK', 'Software Development Kit', 'EntitlementSource', 'BetaEntitlementSource'] +--- + + +# EntitlementSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The source ID | [optional] +**Type** | Pointer to **String** | The source type, will always be ""SOURCE"" | [optional] +**Name** | Pointer to **String** | The source name | [optional] + +## Examples + +- Prepare the resource +```powershell +$EntitlementSource = Initialize-PSSailpoint.BetaEntitlementSource -Id 2c9180827ca885d7017ca8ce28a000eb ` + -Type SOURCE ` + -Name ODS-AD-Source +``` + +- Convert the resource to JSON +```powershell +$EntitlementSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementSourceResetBaseReferenceDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementSourceResetBaseReferenceDto.md new file mode 100644 index 000000000..7d6c2bf20 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntitlementSourceResetBaseReferenceDto.md @@ -0,0 +1,39 @@ +--- +id: beta-entitlement-source-reset-base-reference-dto +title: EntitlementSourceResetBaseReferenceDto +pagination_label: EntitlementSourceResetBaseReferenceDto +sidebar_label: EntitlementSourceResetBaseReferenceDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementSourceResetBaseReferenceDto', 'BetaEntitlementSourceResetBaseReferenceDto'] +slug: /tools/sdk/powershell/beta/models/entitlement-source-reset-base-reference-dto +tags: ['SDK', 'Software Development Kit', 'EntitlementSourceResetBaseReferenceDto', 'BetaEntitlementSourceResetBaseReferenceDto'] +--- + + +# EntitlementSourceResetBaseReferenceDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **String** | The DTO type | [optional] +**Id** | Pointer to **String** | The task ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] + +## Examples + +- Prepare the resource +```powershell +$EntitlementSourceResetBaseReferenceDto = Initialize-PSSailpoint.BetaEntitlementSourceResetBaseReferenceDto -Type TASK_RESULT ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name Entitlement Source Reset +``` + +- Convert the resource to JSON +```powershell +$EntitlementSourceResetBaseReferenceDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntityCreatedByDTO.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntityCreatedByDTO.md new file mode 100644 index 000000000..308026fcd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EntityCreatedByDTO.md @@ -0,0 +1,37 @@ +--- +id: beta-entity-created-by-dto +title: EntityCreatedByDTO +pagination_label: EntityCreatedByDTO +sidebar_label: EntityCreatedByDTO +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntityCreatedByDTO', 'BetaEntityCreatedByDTO'] +slug: /tools/sdk/powershell/beta/models/entity-created-by-dto +tags: ['SDK', 'Software Development Kit', 'EntityCreatedByDTO', 'BetaEntityCreatedByDTO'] +--- + + +# EntityCreatedByDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the creator | [optional] +**DisplayName** | Pointer to **String** | The display name of the creator | [optional] + +## Examples + +- Prepare the resource +```powershell +$EntityCreatedByDTO = Initialize-PSSailpoint.BetaEntityCreatedByDTO -Id 2c918090761a5aac0176215c46a62d58 ` + -DisplayName Ashley.Pierce +``` + +- Convert the resource to JSON +```powershell +$EntityCreatedByDTO | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Error.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Error.md new file mode 100644 index 000000000..3ce71d2b8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Error.md @@ -0,0 +1,39 @@ +--- +id: beta-model-error +title: ModelError +pagination_label: ModelError +sidebar_label: ModelError +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ModelError', 'BetaModelError'] +slug: /tools/sdk/powershell/beta/models/model-error +tags: ['SDK', 'Software Development Kit', 'ModelError', 'BetaModelError'] +--- + + +# ModelError + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetailCode** | Pointer to **String** | DetailCode is the text of the status code returned | [optional] +**Messages** | Pointer to [**[]ErrorMessage**](error-message) | | [optional] +**TrackingId** | Pointer to **String** | TrackingID is the request tracking unique identifier | [optional] + +## Examples + +- Prepare the resource +```powershell +$ModelError = Initialize-PSSailpoint.BetaModelError -DetailCode Internal Server Error ` + -Messages null ` + -TrackingId 9cd03ef80e6a425eb6b11bdbb057cdb4 +``` + +- Convert the resource to JSON +```powershell +$ModelError | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ErrorMessage.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ErrorMessage.md new file mode 100644 index 000000000..675d415a0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ErrorMessage.md @@ -0,0 +1,39 @@ +--- +id: beta-error-message +title: ErrorMessage +pagination_label: ErrorMessage +sidebar_label: ErrorMessage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ErrorMessage', 'BetaErrorMessage'] +slug: /tools/sdk/powershell/beta/models/error-message +tags: ['SDK', 'Software Development Kit', 'ErrorMessage', 'BetaErrorMessage'] +--- + + +# ErrorMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Locale** | Pointer to **String** | Locale is the current Locale | [optional] +**LocaleOrigin** | Pointer to **String** | LocaleOrigin holds possible values of how the locale was selected | [optional] +**Text** | Pointer to **String** | Text is the actual text of the error message | [optional] + +## Examples + +- Prepare the resource +```powershell +$ErrorMessage = Initialize-PSSailpoint.BetaErrorMessage -Locale en-US ` + -LocaleOrigin DEFAULT ` + -Text This is an error +``` + +- Convert the resource to JSON +```powershell +$ErrorMessage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ErrorMessageDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ErrorMessageDto.md new file mode 100644 index 000000000..12f5ab28c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ErrorMessageDto.md @@ -0,0 +1,39 @@ +--- +id: beta-error-message-dto +title: ErrorMessageDto +pagination_label: ErrorMessageDto +sidebar_label: ErrorMessageDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ErrorMessageDto', 'BetaErrorMessageDto'] +slug: /tools/sdk/powershell/beta/models/error-message-dto +tags: ['SDK', 'Software Development Kit', 'ErrorMessageDto', 'BetaErrorMessageDto'] +--- + + +# ErrorMessageDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Locale** | Pointer to **String** | The locale for the message text, a BCP 47 language tag. | [optional] +**LocaleOrigin** | Pointer to [**LocaleOrigin**](locale-origin) | | [optional] +**Text** | Pointer to **String** | Actual text of the error message in the indicated locale. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ErrorMessageDto = Initialize-PSSailpoint.BetaErrorMessageDto -Locale en-US ` + -LocaleOrigin null ` + -Text The request was syntactically correct but its content is semantically invalid. +``` + +- Convert the resource to JSON +```powershell +$ErrorMessageDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ErrorResponseDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ErrorResponseDto.md new file mode 100644 index 000000000..a15d87f40 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ErrorResponseDto.md @@ -0,0 +1,41 @@ +--- +id: beta-error-response-dto +title: ErrorResponseDto +pagination_label: ErrorResponseDto +sidebar_label: ErrorResponseDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ErrorResponseDto', 'BetaErrorResponseDto'] +slug: /tools/sdk/powershell/beta/models/error-response-dto +tags: ['SDK', 'Software Development Kit', 'ErrorResponseDto', 'BetaErrorResponseDto'] +--- + + +# ErrorResponseDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetailCode** | Pointer to **String** | Fine-grained error code providing more detail of the error. | [optional] +**TrackingId** | Pointer to **String** | Unique tracking id for the error. | [optional] +**Messages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | Generic localized reason for error | [optional] +**Causes** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [optional] + +## Examples + +- Prepare the resource +```powershell +$ErrorResponseDto = Initialize-PSSailpoint.BetaErrorResponseDto -DetailCode 400.1 Bad Request Content ` + -TrackingId e7eab60924f64aa284175b9fa3309599 ` + -Messages null ` + -Causes null +``` + +- Convert the resource to JSON +```powershell +$ErrorResponseDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EvaluateResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EvaluateResponse.md new file mode 100644 index 000000000..7c5a37d74 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EvaluateResponse.md @@ -0,0 +1,37 @@ +--- +id: beta-evaluate-response +title: EvaluateResponse +pagination_label: EvaluateResponse +sidebar_label: EvaluateResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EvaluateResponse', 'BetaEvaluateResponse'] +slug: /tools/sdk/powershell/beta/models/evaluate-response +tags: ['SDK', 'Software Development Kit', 'EvaluateResponse', 'BetaEvaluateResponse'] +--- + + +# EvaluateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReassignToId** | Pointer to **String** | The Identity ID which should be the recipient of any work items sent to a specific identity & work type | [optional] +**LookupTrail** | Pointer to [**[]LookupStep**](lookup-step) | List of Reassignments found by looking up the next `TargetIdentity` in a ReassignmentConfiguration | [optional] + +## Examples + +- Prepare the resource +```powershell +$EvaluateResponse = Initialize-PSSailpoint.BetaEvaluateResponse -ReassignToId 869320b6b6f34a169b6178b1a865e66f ` + -LookupTrail null +``` + +- Convert the resource to JSON +```powershell +$EvaluateResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EventAttributes.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EventAttributes.md new file mode 100644 index 000000000..05ac13b63 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EventAttributes.md @@ -0,0 +1,39 @@ +--- +id: beta-event-attributes +title: EventAttributes +pagination_label: EventAttributes +sidebar_label: EventAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EventAttributes', 'BetaEventAttributes'] +slug: /tools/sdk/powershell/beta/models/event-attributes +tags: ['SDK', 'Software Development Kit', 'EventAttributes', 'BetaEventAttributes'] +--- + + +# EventAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the trigger | [required] +**VarFilter** | Pointer to **String** | JSON path expression that will limit which events the trigger will fire on | [optional] +**Description** | Pointer to **String** | Description of the event trigger | [optional] + +## Examples + +- Prepare the resource +```powershell +$EventAttributes = Initialize-PSSailpoint.BetaEventAttributes -Id idn:identity-attributes-changed ` + -VarFilter $.changes[?(@.attribute == 'manager')] ` + -Description null +``` + +- Convert the resource to JSON +```powershell +$EventAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EventBridgeConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EventBridgeConfig.md new file mode 100644 index 000000000..aba22f306 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/EventBridgeConfig.md @@ -0,0 +1,37 @@ +--- +id: beta-event-bridge-config +title: EventBridgeConfig +pagination_label: EventBridgeConfig +sidebar_label: EventBridgeConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EventBridgeConfig', 'BetaEventBridgeConfig'] +slug: /tools/sdk/powershell/beta/models/event-bridge-config +tags: ['SDK', 'Software Development Kit', 'EventBridgeConfig', 'BetaEventBridgeConfig'] +--- + + +# EventBridgeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AwsAccount** | **String** | AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource. | [required] +**AwsRegion** | **String** | AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values. | [required] + +## Examples + +- Prepare the resource +```powershell +$EventBridgeConfig = Initialize-PSSailpoint.BetaEventBridgeConfig -AwsAccount 123456789012 ` + -AwsRegion us-west-1 +``` + +- Convert the resource to JSON +```powershell +$EventBridgeConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExceptionAccessCriteria.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExceptionAccessCriteria.md new file mode 100644 index 000000000..39828b220 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExceptionAccessCriteria.md @@ -0,0 +1,37 @@ +--- +id: beta-exception-access-criteria +title: ExceptionAccessCriteria +pagination_label: ExceptionAccessCriteria +sidebar_label: ExceptionAccessCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExceptionAccessCriteria', 'BetaExceptionAccessCriteria'] +slug: /tools/sdk/powershell/beta/models/exception-access-criteria +tags: ['SDK', 'Software Development Kit', 'ExceptionAccessCriteria', 'BetaExceptionAccessCriteria'] +--- + + +# ExceptionAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**ExceptionCriteria**](exception-criteria) | | [optional] +**RightCriteria** | Pointer to [**ExceptionCriteria**](exception-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ExceptionAccessCriteria = Initialize-PSSailpoint.BetaExceptionAccessCriteria -LeftCriteria null ` + -RightCriteria null +``` + +- Convert the resource to JSON +```powershell +$ExceptionAccessCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExceptionCriteria.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExceptionCriteria.md new file mode 100644 index 000000000..232927e1e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExceptionCriteria.md @@ -0,0 +1,35 @@ +--- +id: beta-exception-criteria +title: ExceptionCriteria +pagination_label: ExceptionCriteria +sidebar_label: ExceptionCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExceptionCriteria', 'BetaExceptionCriteria'] +slug: /tools/sdk/powershell/beta/models/exception-criteria +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteria', 'BetaExceptionCriteria'] +--- + + +# ExceptionCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CriteriaList** | Pointer to [**[]ExceptionCriteriaCriteriaListInner**](exception-criteria-criteria-list-inner) | List of exception criteria. There is a min of 1 and max of 50 items in the list. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ExceptionCriteria = Initialize-PSSailpoint.BetaExceptionCriteria -CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, existing=true}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, existing=false}] +``` + +- Convert the resource to JSON +```powershell +$ExceptionCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExceptionCriteriaAccess.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExceptionCriteriaAccess.md new file mode 100644 index 000000000..0f2e3da03 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExceptionCriteriaAccess.md @@ -0,0 +1,41 @@ +--- +id: beta-exception-criteria-access +title: ExceptionCriteriaAccess +pagination_label: ExceptionCriteriaAccess +sidebar_label: ExceptionCriteriaAccess +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExceptionCriteriaAccess', 'BetaExceptionCriteriaAccess'] +slug: /tools/sdk/powershell/beta/models/exception-criteria-access +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteriaAccess', 'BetaExceptionCriteriaAccess'] +--- + + +# ExceptionCriteriaAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] +**Existing** | Pointer to **Boolean** | Whether the subject identity already had that access or not | [optional] + +## Examples + +- Prepare the resource +```powershell +$ExceptionCriteriaAccess = Initialize-PSSailpoint.BetaExceptionCriteriaAccess -Type null ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local ` + -Existing true +``` + +- Convert the resource to JSON +```powershell +$ExceptionCriteriaAccess | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExceptionCriteriaCriteriaListInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExceptionCriteriaCriteriaListInner.md new file mode 100644 index 000000000..367e324d3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExceptionCriteriaCriteriaListInner.md @@ -0,0 +1,41 @@ +--- +id: beta-exception-criteria-criteria-list-inner +title: ExceptionCriteriaCriteriaListInner +pagination_label: ExceptionCriteriaCriteriaListInner +sidebar_label: ExceptionCriteriaCriteriaListInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExceptionCriteriaCriteriaListInner', 'BetaExceptionCriteriaCriteriaListInner'] +slug: /tools/sdk/powershell/beta/models/exception-criteria-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteriaCriteriaListInner', 'BetaExceptionCriteriaCriteriaListInner'] +--- + + +# ExceptionCriteriaCriteriaListInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | The type of object that is referenced | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] +**Existing** | Pointer to **Boolean** | Whether the subject identity already had that access or not | [optional] + +## Examples + +- Prepare the resource +```powershell +$ExceptionCriteriaCriteriaListInner = Initialize-PSSailpoint.BetaExceptionCriteriaCriteriaListInner -Type ENTITLEMENT ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local ` + -Existing true +``` + +- Convert the resource to JSON +```powershell +$ExceptionCriteriaCriteriaListInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExecutionStatus.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExecutionStatus.md new file mode 100644 index 000000000..30be39655 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExecutionStatus.md @@ -0,0 +1,28 @@ +--- +id: beta-execution-status +title: ExecutionStatus +pagination_label: ExecutionStatus +sidebar_label: ExecutionStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExecutionStatus', 'BetaExecutionStatus'] +slug: /tools/sdk/powershell/beta/models/execution-status +tags: ['SDK', 'Software Development Kit', 'ExecutionStatus', 'BetaExecutionStatus'] +--- + + +# ExecutionStatus + +## Enum + + +* `EXECUTING` (value: `"EXECUTING"`) + +* `VERIFYING` (value: `"VERIFYING"`) + +* `TERMINATED` (value: `"TERMINATED"`) + +* `COMPLETED` (value: `"COMPLETED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExportFormDefinitionsByTenant200ResponseInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExportFormDefinitionsByTenant200ResponseInner.md new file mode 100644 index 000000000..56a0c7ffb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExportFormDefinitionsByTenant200ResponseInner.md @@ -0,0 +1,39 @@ +--- +id: beta-export-form-definitions-by-tenant200-response-inner +title: ExportFormDefinitionsByTenant200ResponseInner +pagination_label: ExportFormDefinitionsByTenant200ResponseInner +sidebar_label: ExportFormDefinitionsByTenant200ResponseInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExportFormDefinitionsByTenant200ResponseInner', 'BetaExportFormDefinitionsByTenant200ResponseInner'] +slug: /tools/sdk/powershell/beta/models/export-form-definitions-by-tenant200-response-inner +tags: ['SDK', 'Software Development Kit', 'ExportFormDefinitionsByTenant200ResponseInner', 'BetaExportFormDefinitionsByTenant200ResponseInner'] +--- + + +# ExportFormDefinitionsByTenant200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Object** | Pointer to [**FormDefinitionResponse**](form-definition-response) | | [optional] +**Self** | Pointer to [**FormDefinitionSelfImportExportDto**](form-definition-self-import-export-dto) | | [optional] +**Version** | Pointer to **Int32** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ExportFormDefinitionsByTenant200ResponseInner = Initialize-PSSailpoint.BetaExportFormDefinitionsByTenant200ResponseInner -Object null ` + -Self null ` + -Version null +``` + +- Convert the resource to JSON +```powershell +$ExportFormDefinitionsByTenant200ResponseInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExportOptions.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExportOptions.md new file mode 100644 index 000000000..97d2334fa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExportOptions.md @@ -0,0 +1,39 @@ +--- +id: beta-export-options +title: ExportOptions +pagination_label: ExportOptions +sidebar_label: ExportOptions +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExportOptions', 'BetaExportOptions'] +slug: /tools/sdk/powershell/beta/models/export-options +tags: ['SDK', 'Software Development Kit', 'ExportOptions', 'BetaExportOptions'] +--- + + +# ExportOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExcludeTypes** | Pointer to **[]String** | Object type names to be excluded from an sp-config export command. | [optional] +**IncludeTypes** | Pointer to **[]String** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional] +**ObjectOptions** | Pointer to [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional] + +## Examples + +- Prepare the resource +```powershell +$ExportOptions = Initialize-PSSailpoint.BetaExportOptions -ExcludeTypes null ` + -IncludeTypes null ` + -ObjectOptions {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}} +``` + +- Convert the resource to JSON +```powershell +$ExportOptions | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExportPayload.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExportPayload.md new file mode 100644 index 000000000..e2a6280d5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExportPayload.md @@ -0,0 +1,41 @@ +--- +id: beta-export-payload +title: ExportPayload +pagination_label: ExportPayload +sidebar_label: ExportPayload +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExportPayload', 'BetaExportPayload'] +slug: /tools/sdk/powershell/beta/models/export-payload +tags: ['SDK', 'Software Development Kit', 'ExportPayload', 'BetaExportPayload'] +--- + + +# ExportPayload + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **String** | Optional user defined description/name for export job. | [optional] +**ExcludeTypes** | Pointer to **[]String** | Object type names to be excluded from an sp-config export command. | [optional] +**IncludeTypes** | Pointer to **[]String** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional] +**ObjectOptions** | Pointer to [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional] + +## Examples + +- Prepare the resource +```powershell +$ExportPayload = Initialize-PSSailpoint.BetaExportPayload -Description Export Job 1 Test ` + -ExcludeTypes null ` + -IncludeTypes null ` + -ObjectOptions {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}} +``` + +- Convert the resource to JSON +```powershell +$ExportPayload | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Expression.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Expression.md new file mode 100644 index 000000000..15ee414a6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Expression.md @@ -0,0 +1,41 @@ +--- +id: beta-expression +title: Expression +pagination_label: Expression +sidebar_label: Expression +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Expression', 'BetaExpression'] +slug: /tools/sdk/powershell/beta/models/expression +tags: ['SDK', 'Software Development Kit', 'Expression', 'BetaExpression'] +--- + + +# Expression + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operator** | Pointer to **Enum** [ "AND", "EQUALS" ] | Operator for the expression | [optional] +**Attribute** | Pointer to **String** | Name for the attribute | [optional] +**Value** | Pointer to [**Value**](value) | | [optional] +**Children** | Pointer to [**[]Children**](children) | List of expressions | [optional] + +## Examples + +- Prepare the resource +```powershell +$Expression = Initialize-PSSailpoint.BetaExpression -Operator EQUALS ` + -Attribute location ` + -Value null ` + -Children [] +``` + +- Convert the resource to JSON +```powershell +$Expression | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExternalAttributes.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExternalAttributes.md new file mode 100644 index 000000000..cf119d0a1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ExternalAttributes.md @@ -0,0 +1,41 @@ +--- +id: beta-external-attributes +title: ExternalAttributes +pagination_label: ExternalAttributes +sidebar_label: ExternalAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExternalAttributes', 'BetaExternalAttributes'] +slug: /tools/sdk/powershell/beta/models/external-attributes +tags: ['SDK', 'Software Development Kit', 'ExternalAttributes', 'BetaExternalAttributes'] +--- + + +# ExternalAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | A unique name for the external trigger | [optional] +**Description** | Pointer to **String** | Additional context about the external trigger | [optional] +**ClientId** | Pointer to **String** | OAuth Client ID to authenticate with this trigger | [optional] +**Url** | Pointer to **String** | URL to invoke this workflow | [optional] + +## Examples + +- Prepare the resource +```powershell +$ExternalAttributes = Initialize-PSSailpoint.BetaExternalAttributes -Name search-and-notify ` + -Description Run a search and notify the results ` + -ClientId 87e239b2-b85b-4bde-b9a7-55bf304ddcdc ` + -Url https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d +``` + +- Convert the resource to JSON +```powershell +$ExternalAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FeatureValueDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FeatureValueDto.md new file mode 100644 index 000000000..45e12c684 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FeatureValueDto.md @@ -0,0 +1,39 @@ +--- +id: beta-feature-value-dto +title: FeatureValueDto +pagination_label: FeatureValueDto +sidebar_label: FeatureValueDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FeatureValueDto', 'BetaFeatureValueDto'] +slug: /tools/sdk/powershell/beta/models/feature-value-dto +tags: ['SDK', 'Software Development Kit', 'FeatureValueDto', 'BetaFeatureValueDto'] +--- + + +# FeatureValueDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Feature** | Pointer to **String** | The type of feature | [optional] +**Numerator** | Pointer to **Int32** | The number of identities that have access to the feature | [optional] +**Denominator** | Pointer to **Int32** | The number of identities with the corresponding feature | [optional] + +## Examples + +- Prepare the resource +```powershell +$FeatureValueDto = Initialize-PSSailpoint.BetaFeatureValueDto -Feature department ` + -Numerator 14 ` + -Denominator 14 +``` + +- Convert the resource to JSON +```powershell +$FeatureValueDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Field.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Field.md new file mode 100644 index 000000000..27d5099d2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Field.md @@ -0,0 +1,45 @@ +--- +id: beta-field +title: Field +pagination_label: Field +sidebar_label: Field +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Field', 'BetaField'] +slug: /tools/sdk/powershell/beta/models/field +tags: ['SDK', 'Software Development Kit', 'Field', 'BetaField'] +--- + + +# Field + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Name of the FormItem | [optional] +**DisplayName** | Pointer to **String** | Display name of the field | [optional] +**DisplayType** | Pointer to **String** | Type of the field to display | [optional] +**Required** | Pointer to **Boolean** | True if the field is required | [optional] +**AllowedValuesList** | Pointer to [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | List of allowed values for the field | [optional] +**Value** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Value of the field | [optional] + +## Examples + +- Prepare the resource +```powershell +$Field = Initialize-PSSailpoint.BetaField -Name Field1 ` + -DisplayName Field 1 ` + -DisplayType checkbox ` + -Required null ` + -AllowedValuesList [{Val1Display=null, Val1Value=null}, {Val2Display=null, Val2Value=null}] ` + -Value null +``` + +- Convert the resource to JSON +```powershell +$Field | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FieldDetails.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FieldDetails.md new file mode 100644 index 000000000..abe1925c7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FieldDetails.md @@ -0,0 +1,45 @@ +--- +id: beta-field-details +title: FieldDetails +pagination_label: FieldDetails +sidebar_label: FieldDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FieldDetails', 'BetaFieldDetails'] +slug: /tools/sdk/powershell/beta/models/field-details +tags: ['SDK', 'Software Development Kit', 'FieldDetails', 'BetaFieldDetails'] +--- + + +# FieldDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Name of the FormItem | [optional] +**DisplayName** | Pointer to **String** | Display name of the field | [optional] +**DisplayType** | Pointer to **String** | Type of the field to display | [optional] +**Required** | Pointer to **Boolean** | True if the field is required | [optional] +**AllowedValuesList** | Pointer to [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | List of allowed values for the field | [optional] +**Value** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Value of the field | [optional] + +## Examples + +- Prepare the resource +```powershell +$FieldDetails = Initialize-PSSailpoint.BetaFieldDetails -Name Field1 ` + -DisplayName Field 1 ` + -DisplayType checkbox ` + -Required null ` + -AllowedValuesList [{Val1Display=null, Val1Value=null}, {Val2Display=null, Val2Value=null}] ` + -Value null +``` + +- Convert the resource to JSON +```powershell +$FieldDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FieldDetailsDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FieldDetailsDto.md new file mode 100644 index 000000000..f6dd7e2fc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FieldDetailsDto.md @@ -0,0 +1,45 @@ +--- +id: beta-field-details-dto +title: FieldDetailsDto +pagination_label: FieldDetailsDto +sidebar_label: FieldDetailsDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FieldDetailsDto', 'BetaFieldDetailsDto'] +slug: /tools/sdk/powershell/beta/models/field-details-dto +tags: ['SDK', 'Software Development Kit', 'FieldDetailsDto', 'BetaFieldDetailsDto'] +--- + + +# FieldDetailsDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the attribute. | [optional] +**Transform** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The transform to apply to the field | [optional] +**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Attributes required for the transform | [optional] +**IsRequired** | Pointer to **Boolean** | Flag indicating whether or not the attribute is required. | [optional] [readonly] [default to $false] +**Type** | Pointer to **String** | The type of the attribute. | [optional] +**IsMultiValued** | Pointer to **Boolean** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$FieldDetailsDto = Initialize-PSSailpoint.BetaFieldDetailsDto -Name userName ` + -Transform {type=rule, attributes={name=Create Unique LDAP Attribute}} ` + -Attributes {template=${firstname}.${lastname}${uniqueCounter}, cloudMaxUniqueChecks=50, cloudMaxSize=20, cloudRequired=true} ` + -IsRequired false ` + -Type string ` + -IsMultiValued false +``` + +- Convert the resource to JSON +```powershell +$FieldDetailsDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FirstValid.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FirstValid.md new file mode 100644 index 000000000..9033b4d2c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FirstValid.md @@ -0,0 +1,39 @@ +--- +id: beta-first-valid +title: FirstValid +pagination_label: FirstValid +sidebar_label: FirstValid +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FirstValid', 'BetaFirstValid'] +slug: /tools/sdk/powershell/beta/models/first-valid +tags: ['SDK', 'Software Development Kit', 'FirstValid', 'BetaFirstValid'] +--- + + +# FirstValid + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Values** | [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | An array of attributes to evaluate for existence. | [required] +**IgnoreErrors** | Pointer to **Boolean** | a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. | [optional] [default to $false] +**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] + +## Examples + +- Prepare the resource +```powershell +$FirstValid = Initialize-PSSailpoint.BetaFirstValid -Values [{attributes={sourceName=Active Directory, attributeName=sAMAccountName}, type=accountAttribute}, {attributes={sourceName=Okta, attributeName=login}, type=accountAttribute}, {attributes={sourceName=HR Source, attributeName=employeeID}, type=accountAttribute}] ` + -IgnoreErrors false ` + -RequiresPeriodicRefresh false +``` + +- Convert the resource to JSON +```powershell +$FirstValid | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Form.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Form.md new file mode 100644 index 000000000..2a82fb642 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Form.md @@ -0,0 +1,45 @@ +--- +id: beta-form +title: Form +pagination_label: Form +sidebar_label: Form +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Form', 'BetaForm'] +slug: /tools/sdk/powershell/beta/models/form +tags: ['SDK', 'Software Development Kit', 'Form', 'BetaForm'] +--- + + +# Form + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the form | [optional] +**Name** | Pointer to **String** | Name of the form | [optional] +**Title** | Pointer to **String** | The form title | [optional] +**Subtitle** | Pointer to **String** | The form subtitle. | [optional] +**TargetUser** | Pointer to **String** | The name of the user that should be shown this form | [optional] +**Sections** | Pointer to [**[]SectionDetails**](section-details) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Form = Initialize-PSSailpoint.BetaForm -Id 2c9180835d2e5168015d32f890ca1581 ` + -Name AccountSelection Form ` + -Title Account Selection for John.Doe ` + -Subtitle Please select from the following ` + -TargetUser Jane.Doe ` + -Sections null +``` + +- Convert the resource to JSON +```powershell +$Form | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormCondition.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormCondition.md new file mode 100644 index 000000000..6edf312df --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormCondition.md @@ -0,0 +1,39 @@ +--- +id: beta-form-condition +title: FormCondition +pagination_label: FormCondition +sidebar_label: FormCondition +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormCondition', 'BetaFormCondition'] +slug: /tools/sdk/powershell/beta/models/form-condition +tags: ['SDK', 'Software Development Kit', 'FormCondition', 'BetaFormCondition'] +--- + + +# FormCondition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RuleOperator** | Pointer to **Enum** [ "AND", "OR" ] | ConditionRuleLogicalOperatorType value. AND ConditionRuleLogicalOperatorTypeAnd OR ConditionRuleLogicalOperatorTypeOr | [optional] +**Rules** | Pointer to [**[]ConditionRule**](condition-rule) | List of rules. | [optional] +**Effects** | Pointer to [**[]ConditionEffect**](condition-effect) | List of effects. | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormCondition = Initialize-PSSailpoint.BetaFormCondition -RuleOperator AND ` + -Rules null ` + -Effects null +``` + +- Convert the resource to JSON +```powershell +$FormCondition | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormDefinitionDynamicSchemaRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormDefinitionDynamicSchemaRequest.md new file mode 100644 index 000000000..ee70b0ada --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormDefinitionDynamicSchemaRequest.md @@ -0,0 +1,43 @@ +--- +id: beta-form-definition-dynamic-schema-request +title: FormDefinitionDynamicSchemaRequest +pagination_label: FormDefinitionDynamicSchemaRequest +sidebar_label: FormDefinitionDynamicSchemaRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormDefinitionDynamicSchemaRequest', 'BetaFormDefinitionDynamicSchemaRequest'] +slug: /tools/sdk/powershell/beta/models/form-definition-dynamic-schema-request +tags: ['SDK', 'Software Development Kit', 'FormDefinitionDynamicSchemaRequest', 'BetaFormDefinitionDynamicSchemaRequest'] +--- + + +# FormDefinitionDynamicSchemaRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**FormDefinitionDynamicSchemaRequestAttributes**](form-definition-dynamic-schema-request-attributes) | | [optional] +**Description** | Pointer to **String** | Description is the form definition dynamic schema description text | [optional] +**Id** | Pointer to **String** | ID is a unique identifier | [optional] +**Type** | Pointer to **String** | Type is the form definition dynamic schema type | [optional] +**VersionNumber** | Pointer to **Int64** | VersionNumber is the form definition dynamic schema version number | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormDefinitionDynamicSchemaRequest = Initialize-PSSailpoint.BetaFormDefinitionDynamicSchemaRequest -Attributes null ` + -Description A description ` + -Id 00000000-0000-0000-0000-000000000000 ` + -Type action ` + -VersionNumber 1 +``` + +- Convert the resource to JSON +```powershell +$FormDefinitionDynamicSchemaRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormDefinitionDynamicSchemaRequestAttributes.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormDefinitionDynamicSchemaRequestAttributes.md new file mode 100644 index 000000000..114f470d5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormDefinitionDynamicSchemaRequestAttributes.md @@ -0,0 +1,35 @@ +--- +id: beta-form-definition-dynamic-schema-request-attributes +title: FormDefinitionDynamicSchemaRequestAttributes +pagination_label: FormDefinitionDynamicSchemaRequestAttributes +sidebar_label: FormDefinitionDynamicSchemaRequestAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormDefinitionDynamicSchemaRequestAttributes', 'BetaFormDefinitionDynamicSchemaRequestAttributes'] +slug: /tools/sdk/powershell/beta/models/form-definition-dynamic-schema-request-attributes +tags: ['SDK', 'Software Development Kit', 'FormDefinitionDynamicSchemaRequestAttributes', 'BetaFormDefinitionDynamicSchemaRequestAttributes'] +--- + + +# FormDefinitionDynamicSchemaRequestAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FormDefinitionId** | Pointer to **String** | FormDefinitionID is a unique guid identifying this form definition | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormDefinitionDynamicSchemaRequestAttributes = Initialize-PSSailpoint.BetaFormDefinitionDynamicSchemaRequestAttributes -FormDefinitionId 00000000-0000-0000-0000-000000000000 +``` + +- Convert the resource to JSON +```powershell +$FormDefinitionDynamicSchemaRequestAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormDefinitionDynamicSchemaResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormDefinitionDynamicSchemaResponse.md new file mode 100644 index 000000000..6dc6fd8cf --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormDefinitionDynamicSchemaResponse.md @@ -0,0 +1,35 @@ +--- +id: beta-form-definition-dynamic-schema-response +title: FormDefinitionDynamicSchemaResponse +pagination_label: FormDefinitionDynamicSchemaResponse +sidebar_label: FormDefinitionDynamicSchemaResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormDefinitionDynamicSchemaResponse', 'BetaFormDefinitionDynamicSchemaResponse'] +slug: /tools/sdk/powershell/beta/models/form-definition-dynamic-schema-response +tags: ['SDK', 'Software Development Kit', 'FormDefinitionDynamicSchemaResponse', 'BetaFormDefinitionDynamicSchemaResponse'] +--- + + +# FormDefinitionDynamicSchemaResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OutputSchema** | Pointer to [**map[string]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | OutputSchema holds a JSON schema generated dynamically | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormDefinitionDynamicSchemaResponse = Initialize-PSSailpoint.BetaFormDefinitionDynamicSchemaResponse -OutputSchema {outputSchema={$schema=https://json-schema.org/draft/2020-12/schema, additionalProperties=false, properties={firstName={title=First Name, type=string}, fullName={title=Full Name, type=string}, lastName={title=Last Name, type=string}, startDate={format=date-time, title=Start Date, type=string}}, type=object}} +``` + +- Convert the resource to JSON +```powershell +$FormDefinitionDynamicSchemaResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormDefinitionFileUploadResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormDefinitionFileUploadResponse.md new file mode 100644 index 000000000..3bee20a4e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormDefinitionFileUploadResponse.md @@ -0,0 +1,39 @@ +--- +id: beta-form-definition-file-upload-response +title: FormDefinitionFileUploadResponse +pagination_label: FormDefinitionFileUploadResponse +sidebar_label: FormDefinitionFileUploadResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormDefinitionFileUploadResponse', 'BetaFormDefinitionFileUploadResponse'] +slug: /tools/sdk/powershell/beta/models/form-definition-file-upload-response +tags: ['SDK', 'Software Development Kit', 'FormDefinitionFileUploadResponse', 'BetaFormDefinitionFileUploadResponse'] +--- + + +# FormDefinitionFileUploadResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **String** | Created is the date the file was uploaded | [optional] +**FileId** | Pointer to **String** | fileId is a unique ULID that serves as an identifier for the form definition file | [optional] +**FormDefinitionId** | Pointer to **String** | FormDefinitionID is a unique guid identifying this form definition | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormDefinitionFileUploadResponse = Initialize-PSSailpoint.BetaFormDefinitionFileUploadResponse -Created 2023-07-12T20:14:57.74486Z ` + -FileId 01FHZXHK8PTP9FVK99Z66GXQTX.png ` + -FormDefinitionId 00000000-0000-0000-0000-000000000000 +``` + +- Convert the resource to JSON +```powershell +$FormDefinitionFileUploadResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormDefinitionInput.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormDefinitionInput.md new file mode 100644 index 000000000..7bcea9971 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormDefinitionInput.md @@ -0,0 +1,41 @@ +--- +id: beta-form-definition-input +title: FormDefinitionInput +pagination_label: FormDefinitionInput +sidebar_label: FormDefinitionInput +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormDefinitionInput', 'BetaFormDefinitionInput'] +slug: /tools/sdk/powershell/beta/models/form-definition-input +tags: ['SDK', 'Software Development Kit', 'FormDefinitionInput', 'BetaFormDefinitionInput'] +--- + + +# FormDefinitionInput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Unique identifier for the form input. | [optional] +**Type** | Pointer to **Enum** [ "STRING" ] | FormDefinitionInputType value. STRING FormDefinitionInputTypeString | [optional] +**Label** | Pointer to **String** | Name for the form input. | [optional] +**Description** | Pointer to **String** | Form input's description. | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormDefinitionInput = Initialize-PSSailpoint.BetaFormDefinitionInput -Id 00000000-0000-0000-0000-000000000000 ` + -Type STRING ` + -Label input1 ` + -Description A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic +``` + +- Convert the resource to JSON +```powershell +$FormDefinitionInput | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormDefinitionResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormDefinitionResponse.md new file mode 100644 index 000000000..745f4d6a6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormDefinitionResponse.md @@ -0,0 +1,53 @@ +--- +id: beta-form-definition-response +title: FormDefinitionResponse +pagination_label: FormDefinitionResponse +sidebar_label: FormDefinitionResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormDefinitionResponse', 'BetaFormDefinitionResponse'] +slug: /tools/sdk/powershell/beta/models/form-definition-response +tags: ['SDK', 'Software Development Kit', 'FormDefinitionResponse', 'BetaFormDefinitionResponse'] +--- + + +# FormDefinitionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Unique guid identifying the form definition. | [optional] +**Name** | Pointer to **String** | Name of the form definition. | [optional] +**Description** | Pointer to **String** | Form definition's description. | [optional] +**Owner** | Pointer to [**FormOwner**](form-owner) | | [optional] +**UsedBy** | Pointer to [**[]FormUsedBy**](form-used-by) | List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it. | [optional] +**FormInput** | Pointer to [**[]FormDefinitionInput**](form-definition-input) | List of form inputs required to create a form-instance object. | [optional] +**FormElements** | Pointer to [**[]FormElement**](form-element) | List of nested form elements. | [optional] +**FormConditions** | Pointer to [**[]FormCondition**](form-condition) | Conditional logic that can dynamically modify the form as the recipient is interacting with it. | [optional] +**Created** | Pointer to **System.DateTime** | Created is the date the form definition was created | [optional] +**Modified** | Pointer to **System.DateTime** | Modified is the last date the form definition was modified | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormDefinitionResponse = Initialize-PSSailpoint.BetaFormDefinitionResponse -Id 00000000-0000-0000-0000-000000000000 ` + -Name My form ` + -Description My form description ` + -Owner null ` + -UsedBy null ` + -FormInput null ` + -FormElements null ` + -FormConditions null ` + -Created 2023-07-12T20:14:57.744860Z ` + -Modified 2023-07-12T20:14:57.744860Z +``` + +- Convert the resource to JSON +```powershell +$FormDefinitionResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormDefinitionSelfImportExportDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormDefinitionSelfImportExportDto.md new file mode 100644 index 000000000..17567e147 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormDefinitionSelfImportExportDto.md @@ -0,0 +1,39 @@ +--- +id: beta-form-definition-self-import-export-dto +title: FormDefinitionSelfImportExportDto +pagination_label: FormDefinitionSelfImportExportDto +sidebar_label: FormDefinitionSelfImportExportDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormDefinitionSelfImportExportDto', 'BetaFormDefinitionSelfImportExportDto'] +slug: /tools/sdk/powershell/beta/models/form-definition-self-import-export-dto +tags: ['SDK', 'Software Development Kit', 'FormDefinitionSelfImportExportDto', 'BetaFormDefinitionSelfImportExportDto'] +--- + + +# FormDefinitionSelfImportExportDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "FORM_DEFINITION" ] | Imported/exported object's DTO type. | [optional] +**Id** | Pointer to **String** | Imported/exported object's ID. | [optional] +**Name** | Pointer to **String** | Imported/exported object's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormDefinitionSelfImportExportDto = Initialize-PSSailpoint.BetaFormDefinitionSelfImportExportDto -Type FORM_DEFINITION ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name Temporary User Level Permissions - Requester +``` + +- Convert the resource to JSON +```powershell +$FormDefinitionSelfImportExportDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormDetails.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormDetails.md new file mode 100644 index 000000000..2cbe0245f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormDetails.md @@ -0,0 +1,45 @@ +--- +id: beta-form-details +title: FormDetails +pagination_label: FormDetails +sidebar_label: FormDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormDetails', 'BetaFormDetails'] +slug: /tools/sdk/powershell/beta/models/form-details +tags: ['SDK', 'Software Development Kit', 'FormDetails', 'BetaFormDetails'] +--- + + +# FormDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the form | [optional] +**Name** | Pointer to **String** | Name of the form | [optional] +**Title** | Pointer to **String** | The form title | [optional] +**Subtitle** | Pointer to **String** | The form subtitle. | [optional] +**TargetUser** | Pointer to **String** | The name of the user that should be shown this form | [optional] +**Sections** | Pointer to [**[]SectionDetails**](section-details) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormDetails = Initialize-PSSailpoint.BetaFormDetails -Id 2c9180835d2e5168015d32f890ca1581 ` + -Name AccountSelection Form ` + -Title Account Selection for John.Doe ` + -Subtitle Please select from the following ` + -TargetUser Jane.Doe ` + -Sections null +``` + +- Convert the resource to JSON +```powershell +$FormDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormElement.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormElement.md new file mode 100644 index 000000000..477195b75 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormElement.md @@ -0,0 +1,43 @@ +--- +id: beta-form-element +title: FormElement +pagination_label: FormElement +sidebar_label: FormElement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormElement', 'BetaFormElement'] +slug: /tools/sdk/powershell/beta/models/form-element +tags: ['SDK', 'Software Development Kit', 'FormElement', 'BetaFormElement'] +--- + + +# FormElement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Form element identifier. | [optional] +**ElementType** | Pointer to **Enum** [ "TEXT", "TOGGLE", "TEXTAREA", "HIDDEN", "PHONE", "EMAIL", "SELECT", "DATE", "SECTION", "COLUMN_SET", "IMAGE", "DESCRIPTION" ] | FormElementType value. TEXT FormElementTypeText TOGGLE FormElementTypeToggle TEXTAREA FormElementTypeTextArea HIDDEN FormElementTypeHidden PHONE FormElementTypePhone EMAIL FormElementTypeEmail SELECT FormElementTypeSelect DATE FormElementTypeDate SECTION FormElementTypeSection COLUMN_SET FormElementTypeColumns IMAGE FormElementTypeImage DESCRIPTION FormElementTypeDescription | [optional] +**Config** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Config object. | [optional] +**Key** | Pointer to **String** | Technical key. | [optional] +**Validations** | Pointer to [**[]FormElementValidationsSet**](form-element-validations-set) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormElement = Initialize-PSSailpoint.BetaFormElement -Id 00000000-0000-0000-0000-000000000000 ` + -ElementType TEXT ` + -Config {label=Department} ` + -Key department ` + -Validations null +``` + +- Convert the resource to JSON +```powershell +$FormElement | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormElementDataSourceConfigOptions.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormElementDataSourceConfigOptions.md new file mode 100644 index 000000000..c0516d735 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormElementDataSourceConfigOptions.md @@ -0,0 +1,39 @@ +--- +id: beta-form-element-data-source-config-options +title: FormElementDataSourceConfigOptions +pagination_label: FormElementDataSourceConfigOptions +sidebar_label: FormElementDataSourceConfigOptions +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormElementDataSourceConfigOptions', 'BetaFormElementDataSourceConfigOptions'] +slug: /tools/sdk/powershell/beta/models/form-element-data-source-config-options +tags: ['SDK', 'Software Development Kit', 'FormElementDataSourceConfigOptions', 'BetaFormElementDataSourceConfigOptions'] +--- + + +# FormElementDataSourceConfigOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Label** | Pointer to **String** | Label is the main label to display to the user when selecting this option | [optional] +**SubLabel** | Pointer to **String** | SubLabel is the sub label to display below the label in diminutive styling to help describe or identify this option | [optional] +**Value** | Pointer to **String** | Value is the value to save as an entry when the user selects this option | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormElementDataSourceConfigOptions = Initialize-PSSailpoint.BetaFormElementDataSourceConfigOptions -Label regression-test-access-request-07c55dd6-3056-430a-86b5-fccc395bb6c5 ` + -SubLabel ` + -Value e96674448eba4ca1ba04eee999a8f3cd +``` + +- Convert the resource to JSON +```powershell +$FormElementDataSourceConfigOptions | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormElementDynamicDataSource.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormElementDynamicDataSource.md new file mode 100644 index 000000000..7f07024eb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormElementDynamicDataSource.md @@ -0,0 +1,37 @@ +--- +id: beta-form-element-dynamic-data-source +title: FormElementDynamicDataSource +pagination_label: FormElementDynamicDataSource +sidebar_label: FormElementDynamicDataSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormElementDynamicDataSource', 'BetaFormElementDynamicDataSource'] +slug: /tools/sdk/powershell/beta/models/form-element-dynamic-data-source +tags: ['SDK', 'Software Development Kit', 'FormElementDynamicDataSource', 'BetaFormElementDynamicDataSource'] +--- + + +# FormElementDynamicDataSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Config** | Pointer to [**FormElementDynamicDataSourceConfig**](form-element-dynamic-data-source-config) | | [optional] +**DataSourceType** | Pointer to **Enum** [ "STATIC", "INTERNAL", "SEARCH", "FORM_INPUT" ] | DataSourceType is a FormElementDataSourceType value STATIC FormElementDataSourceTypeStatic INTERNAL FormElementDataSourceTypeInternal SEARCH FormElementDataSourceTypeSearch FORM_INPUT FormElementDataSourceTypeFormInput | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormElementDynamicDataSource = Initialize-PSSailpoint.BetaFormElementDynamicDataSource -Config null ` + -DataSourceType STATIC +``` + +- Convert the resource to JSON +```powershell +$FormElementDynamicDataSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormElementDynamicDataSourceConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormElementDynamicDataSourceConfig.md new file mode 100644 index 000000000..88b01cfb3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormElementDynamicDataSourceConfig.md @@ -0,0 +1,41 @@ +--- +id: beta-form-element-dynamic-data-source-config +title: FormElementDynamicDataSourceConfig +pagination_label: FormElementDynamicDataSourceConfig +sidebar_label: FormElementDynamicDataSourceConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormElementDynamicDataSourceConfig', 'BetaFormElementDynamicDataSourceConfig'] +slug: /tools/sdk/powershell/beta/models/form-element-dynamic-data-source-config +tags: ['SDK', 'Software Development Kit', 'FormElementDynamicDataSourceConfig', 'BetaFormElementDynamicDataSourceConfig'] +--- + + +# FormElementDynamicDataSourceConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AggregationBucketField** | Pointer to **String** | AggregationBucketField is the aggregation bucket field name | [optional] +**Indices** | Pointer to **[]String** | Indices is a list of indices to use | [optional] +**ObjectType** | Pointer to **Enum** [ "IDENTITY", "ACCESS_PROFILE", "SOURCES", "ROLE", "ENTITLEMENT" ] | ObjectType is a PreDefinedSelectOption value IDENTITY PreDefinedSelectOptionIdentity ACCESS_PROFILE PreDefinedSelectOptionAccessProfile SOURCES PreDefinedSelectOptionSources ROLE PreDefinedSelectOptionRole ENTITLEMENT PreDefinedSelectOptionEntitlement | [optional] +**Query** | Pointer to **String** | Query is a text | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormElementDynamicDataSourceConfig = Initialize-PSSailpoint.BetaFormElementDynamicDataSourceConfig -AggregationBucketField attributes.cloudStatus.exact ` + -Indices [identities] ` + -ObjectType IDENTITY ` + -Query * +``` + +- Convert the resource to JSON +```powershell +$FormElementDynamicDataSourceConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormElementPreviewRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormElementPreviewRequest.md new file mode 100644 index 000000000..fa4fa98ce --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormElementPreviewRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-form-element-preview-request +title: FormElementPreviewRequest +pagination_label: FormElementPreviewRequest +sidebar_label: FormElementPreviewRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormElementPreviewRequest', 'BetaFormElementPreviewRequest'] +slug: /tools/sdk/powershell/beta/models/form-element-preview-request +tags: ['SDK', 'Software Development Kit', 'FormElementPreviewRequest', 'BetaFormElementPreviewRequest'] +--- + + +# FormElementPreviewRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DataSource** | Pointer to [**FormElementDynamicDataSource**](form-element-dynamic-data-source) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormElementPreviewRequest = Initialize-PSSailpoint.BetaFormElementPreviewRequest -DataSource null +``` + +- Convert the resource to JSON +```powershell +$FormElementPreviewRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormElementValidationsSet.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormElementValidationsSet.md new file mode 100644 index 000000000..9884d60c1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormElementValidationsSet.md @@ -0,0 +1,35 @@ +--- +id: beta-form-element-validations-set +title: FormElementValidationsSet +pagination_label: FormElementValidationsSet +sidebar_label: FormElementValidationsSet +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormElementValidationsSet', 'BetaFormElementValidationsSet'] +slug: /tools/sdk/powershell/beta/models/form-element-validations-set +tags: ['SDK', 'Software Development Kit', 'FormElementValidationsSet', 'BetaFormElementValidationsSet'] +--- + + +# FormElementValidationsSet + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ValidationType** | Pointer to **Enum** [ "REQUIRED", "MIN_LENGTH", "MAX_LENGTH", "REGEX", "DATE", "MAX_DATE", "MIN_DATE", "LESS_THAN_DATE", "PHONE", "EMAIL", "DATA_SOURCE", "TEXTAREA" ] | The type of data validation that you wish to enforce, e.g., a required field, a minimum length, etc. | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormElementValidationsSet = Initialize-PSSailpoint.BetaFormElementValidationsSet -ValidationType REQUIRED +``` + +- Convert the resource to JSON +```powershell +$FormElementValidationsSet | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormError.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormError.md new file mode 100644 index 000000000..416a74d51 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormError.md @@ -0,0 +1,39 @@ +--- +id: beta-form-error +title: FormError +pagination_label: FormError +sidebar_label: FormError +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormError', 'BetaFormError'] +slug: /tools/sdk/powershell/beta/models/form-error +tags: ['SDK', 'Software Development Kit', 'FormError', 'BetaFormError'] +--- + + +# FormError + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **String** | Key is the technical key | [optional] +**Messages** | Pointer to [**[]ErrorMessage**](error-message) | Messages is a list of web.ErrorMessage items | [optional] +**Value** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Value is the value associated with a Key | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormError = Initialize-PSSailpoint.BetaFormError -Key department ` + -Messages null ` + -Value Engineering +``` + +- Convert the resource to JSON +```powershell +$FormError | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormInstanceCreatedBy.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormInstanceCreatedBy.md new file mode 100644 index 000000000..d5c5883d4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormInstanceCreatedBy.md @@ -0,0 +1,37 @@ +--- +id: beta-form-instance-created-by +title: FormInstanceCreatedBy +pagination_label: FormInstanceCreatedBy +sidebar_label: FormInstanceCreatedBy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormInstanceCreatedBy', 'BetaFormInstanceCreatedBy'] +slug: /tools/sdk/powershell/beta/models/form-instance-created-by +tags: ['SDK', 'Software Development Kit', 'FormInstanceCreatedBy', 'BetaFormInstanceCreatedBy'] +--- + + +# FormInstanceCreatedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID is a unique identifier | [optional] +**Type** | Pointer to **Enum** [ "WORKFLOW_EXECUTION", "SOURCE" ] | Type is a form instance created by type enum value WORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution SOURCE FormInstanceCreatedByTypeSource | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormInstanceCreatedBy = Initialize-PSSailpoint.BetaFormInstanceCreatedBy -Id 00000000-0000-0000-0000-000000000000 ` + -Type WORKFLOW_EXECUTION +``` + +- Convert the resource to JSON +```powershell +$FormInstanceCreatedBy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormInstanceRecipient.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormInstanceRecipient.md new file mode 100644 index 000000000..8eb6e783b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormInstanceRecipient.md @@ -0,0 +1,37 @@ +--- +id: beta-form-instance-recipient +title: FormInstanceRecipient +pagination_label: FormInstanceRecipient +sidebar_label: FormInstanceRecipient +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormInstanceRecipient', 'BetaFormInstanceRecipient'] +slug: /tools/sdk/powershell/beta/models/form-instance-recipient +tags: ['SDK', 'Software Development Kit', 'FormInstanceRecipient', 'BetaFormInstanceRecipient'] +--- + + +# FormInstanceRecipient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID is a unique identifier | [optional] +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Type is a FormInstanceRecipientType value IDENTITY FormInstanceRecipientIdentity | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormInstanceRecipient = Initialize-PSSailpoint.BetaFormInstanceRecipient -Id 00000000-0000-0000-0000-000000000000 ` + -Type IDENTITY +``` + +- Convert the resource to JSON +```powershell +$FormInstanceRecipient | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormInstanceResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormInstanceResponse.md new file mode 100644 index 000000000..60362b928 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormInstanceResponse.md @@ -0,0 +1,63 @@ +--- +id: beta-form-instance-response +title: FormInstanceResponse +pagination_label: FormInstanceResponse +sidebar_label: FormInstanceResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormInstanceResponse', 'BetaFormInstanceResponse'] +slug: /tools/sdk/powershell/beta/models/form-instance-response +tags: ['SDK', 'Software Development Kit', 'FormInstanceResponse', 'BetaFormInstanceResponse'] +--- + + +# FormInstanceResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **System.DateTime** | Created is the date the form instance was assigned | [optional] +**CreatedBy** | Pointer to [**FormInstanceCreatedBy**](form-instance-created-by) | | [optional] +**Expire** | Pointer to **String** | Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record | [optional] +**FormConditions** | Pointer to [**[]FormCondition**](form-condition) | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [optional] +**FormData** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | FormData is the data provided by the form on submit. The data is in a key -> value map | [optional] +**FormDefinitionId** | Pointer to **String** | FormDefinitionID is the id of the form definition that created this form | [optional] +**FormElements** | Pointer to [**[]FormElement**](form-element) | FormElements is the configuration of the form, this would be a repeat of the fields from the form-config | [optional] +**FormErrors** | Pointer to [**[]FormError**](form-error) | FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors | [optional] +**FormInput** | Pointer to [**map[string]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | FormInput is an object of form input labels to value | [optional] +**Id** | Pointer to **String** | Unique guid identifying this form instance | [optional] +**Modified** | Pointer to **System.DateTime** | Modified is the last date the form instance was modified | [optional] +**Recipients** | Pointer to [**[]FormInstanceRecipient**](form-instance-recipient) | Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it | [optional] +**StandAloneForm** | Pointer to **Boolean** | StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form | [optional] [default to $false] +**StandAloneFormUrl** | Pointer to **String** | StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI | [optional] +**State** | Pointer to **Enum** [ "ASSIGNED", "IN_PROGRESS", "SUBMITTED", "COMPLETED", "CANCELLED" ] | State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormInstanceResponse = Initialize-PSSailpoint.BetaFormInstanceResponse -Created 2023-07-12T20:14:57.744860Z ` + -CreatedBy null ` + -Expire 2023-08-12T20:14:57.74486Z ` + -FormConditions null ` + -FormData {department=Engineering} ` + -FormDefinitionId 49841cb8-00a5-4fbd-9888-8bbb28d48331 ` + -FormElements null ` + -FormErrors null ` + -FormInput {input1=Sales} ` + -Id 06a2d961-07fa-44d1-8d0a-2f6470e30fd2 ` + -Modified 2023-07-12T20:14:57.744860Z ` + -Recipients null ` + -StandAloneForm false ` + -StandAloneFormUrl https://my-org.identitynow.com/ui/d/forms/00000000-0000-0000-0000-000000000000 ` + -State ASSIGNED +``` + +- Convert the resource to JSON +```powershell +$FormInstanceResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormItem.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormItem.md new file mode 100644 index 000000000..220c285eb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormItem.md @@ -0,0 +1,35 @@ +--- +id: beta-form-item +title: FormItem +pagination_label: FormItem +sidebar_label: FormItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormItem', 'BetaFormItem'] +slug: /tools/sdk/powershell/beta/models/form-item +tags: ['SDK', 'Software Development Kit', 'FormItem', 'BetaFormItem'] +--- + + +# FormItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Name of the FormItem | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormItem = Initialize-PSSailpoint.BetaFormItem -Name Field1 +``` + +- Convert the resource to JSON +```powershell +$FormItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormItemDetails.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormItemDetails.md new file mode 100644 index 000000000..39a28c054 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormItemDetails.md @@ -0,0 +1,35 @@ +--- +id: beta-form-item-details +title: FormItemDetails +pagination_label: FormItemDetails +sidebar_label: FormItemDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormItemDetails', 'BetaFormItemDetails'] +slug: /tools/sdk/powershell/beta/models/form-item-details +tags: ['SDK', 'Software Development Kit', 'FormItemDetails', 'BetaFormItemDetails'] +--- + + +# FormItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Name of the FormItem | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormItemDetails = Initialize-PSSailpoint.BetaFormItemDetails -Name Field1 +``` + +- Convert the resource to JSON +```powershell +$FormItemDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormOwner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormOwner.md new file mode 100644 index 000000000..3ffd97b4a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormOwner.md @@ -0,0 +1,39 @@ +--- +id: beta-form-owner +title: FormOwner +pagination_label: FormOwner +sidebar_label: FormOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormOwner', 'BetaFormOwner'] +slug: /tools/sdk/powershell/beta/models/form-owner +tags: ['SDK', 'Software Development Kit', 'FormOwner', 'BetaFormOwner'] +--- + + +# FormOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | FormOwnerType value. IDENTITY FormOwnerTypeIdentity | [optional] +**Id** | Pointer to **String** | Unique identifier of the form's owner. | [optional] +**Name** | Pointer to **String** | Name of the form's owner. | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormOwner = Initialize-PSSailpoint.BetaFormOwner -Type IDENTITY ` + -Id 2c9180867624cbd7017642d8c8c81f67 ` + -Name Grant Smith +``` + +- Convert the resource to JSON +```powershell +$FormOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormUsedBy.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormUsedBy.md new file mode 100644 index 000000000..00e655cac --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FormUsedBy.md @@ -0,0 +1,39 @@ +--- +id: beta-form-used-by +title: FormUsedBy +pagination_label: FormUsedBy +sidebar_label: FormUsedBy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormUsedBy', 'BetaFormUsedBy'] +slug: /tools/sdk/powershell/beta/models/form-used-by +tags: ['SDK', 'Software Development Kit', 'FormUsedBy', 'BetaFormUsedBy'] +--- + + +# FormUsedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "WORKFLOW", "SOURCE", "MySailPoint" ] | FormUsedByType value. WORKFLOW FormUsedByTypeWorkflow SOURCE FormUsedByTypeSource MySailPoint FormUsedByType | [optional] +**Id** | Pointer to **String** | Unique identifier of the system using the form. | [optional] +**Name** | Pointer to **String** | Name of the system using the form. | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormUsedBy = Initialize-PSSailpoint.BetaFormUsedBy -Type WORKFLOW ` + -Id 61940a92-5484-42bc-bc10-b9982b218cdf ` + -Name Access Request Form +``` + +- Convert the resource to JSON +```powershell +$FormUsedBy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ForwardApprovalDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ForwardApprovalDto.md new file mode 100644 index 000000000..f1bc0ab47 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ForwardApprovalDto.md @@ -0,0 +1,37 @@ +--- +id: beta-forward-approval-dto +title: ForwardApprovalDto +pagination_label: ForwardApprovalDto +sidebar_label: ForwardApprovalDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ForwardApprovalDto', 'BetaForwardApprovalDto'] +slug: /tools/sdk/powershell/beta/models/forward-approval-dto +tags: ['SDK', 'Software Development Kit', 'ForwardApprovalDto', 'BetaForwardApprovalDto'] +--- + + +# ForwardApprovalDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NewOwnerId** | **String** | The Id of the new owner | [required] +**Comment** | **String** | The comment provided by the forwarder | [required] + +## Examples + +- Prepare the resource +```powershell +$ForwardApprovalDto = Initialize-PSSailpoint.BetaForwardApprovalDto -NewOwnerId null ` + -Comment null +``` + +- Convert the resource to JSON +```powershell +$ForwardApprovalDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullDiscoveredApplications.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullDiscoveredApplications.md new file mode 100644 index 000000000..b81fe9ab3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullDiscoveredApplications.md @@ -0,0 +1,53 @@ +--- +id: beta-full-discovered-applications +title: FullDiscoveredApplications +pagination_label: FullDiscoveredApplications +sidebar_label: FullDiscoveredApplications +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FullDiscoveredApplications', 'BetaFullDiscoveredApplications'] +slug: /tools/sdk/powershell/beta/models/full-discovered-applications +tags: ['SDK', 'Software Development Kit', 'FullDiscoveredApplications', 'BetaFullDiscoveredApplications'] +--- + + +# FullDiscoveredApplications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Unique identifier for the discovered application. | [optional] +**Name** | Pointer to **String** | Name of the discovered application. | [optional] +**DiscoverySource** | Pointer to **String** | Source from which the application was discovered. | [optional] +**DiscoveredVendor** | Pointer to **String** | The vendor associated with the discovered application. | [optional] +**Description** | Pointer to **String** | A brief description of the discovered application. | [optional] +**RecommendedConnectors** | Pointer to **[]String** | List of recommended connectors for the application. | [optional] +**DiscoveredAt** | Pointer to **System.DateTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**CreatedAt** | Pointer to **System.DateTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**Status** | Pointer to **String** | The status of an application within the discovery source. By default this field is set to ""ACTIVE"" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to ""INACTIVE"". | [optional] +**AssociatedSources** | Pointer to **[]String** | List of associated sources related to this discovered application. | [optional] + +## Examples + +- Prepare the resource +```powershell +$FullDiscoveredApplications = Initialize-PSSailpoint.BetaFullDiscoveredApplications -Id null ` + -Name ExampleApp ` + -DiscoverySource csv ` + -DiscoveredVendor ExampleVendor ` + -Description An application for managing examples. ` + -RecommendedConnectors [ConnectorA, ConnectorB] ` + -DiscoveredAt 2023-01-01T12:00Z ` + -CreatedAt 2023-01-01T12:00Z ` + -Status ACTIVE ` + -AssociatedSources [e0cc5d7d-bf7f-4f81-b2af-8885b09d9923, a0303682-5e4a-44f7-bdc2-6ce6112549c1] +``` + +- Convert the resource to JSON +```powershell +$FullDiscoveredApplications | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Fullcampaign.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Fullcampaign.md new file mode 100644 index 000000000..2b2bbb4b1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Fullcampaign.md @@ -0,0 +1,79 @@ +--- +id: beta-fullcampaign +title: Fullcampaign +pagination_label: Fullcampaign +sidebar_label: Fullcampaign +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Fullcampaign', 'BetaFullcampaign'] +slug: /tools/sdk/powershell/beta/models/fullcampaign +tags: ['SDK', 'Software Development Kit', 'Fullcampaign', 'BetaFullcampaign'] +--- + + +# Fullcampaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the campaign | [optional] [readonly] +**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Deadline** | Pointer to **System.DateTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required] +**EmailNotificationEnabled** | Pointer to **Boolean** | Enables email notification for this campaign | [optional] [default to $false] +**AutoRevokeAllowed** | Pointer to **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] +**RecommendationsEnabled** | Pointer to **Boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to $false] +**Status** | Pointer to **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **System.DateTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **Int32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | Modified time of the campaign | [optional] [readonly] +**VarFilter** | Pointer to [**FullcampaignAllOfFilter**](fullcampaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | Pointer to **Boolean** | Determines if comments on sunset date changes are required. | [optional] [default to $true] +**SourceOwnerCampaignInfo** | Pointer to [**FullcampaignAllOfSourceOwnerCampaignInfo**](fullcampaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | Pointer to [**FullcampaignAllOfSearchCampaignInfo**](fullcampaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | Pointer to [**FullcampaignAllOfRoleCompositionCampaignInfo**](fullcampaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | Pointer to [**FullcampaignAllOfMachineAccountCampaignInfo**](fullcampaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | Pointer to [**[]FullcampaignAllOfSourcesWithOrphanEntitlements**](fullcampaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \""orphan entitlements\"" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**MandatoryCommentRequirement** | Pointer to **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Fullcampaign = Initialize-PSSailpoint.BetaFullcampaign -Id 2c9079b270a266a60170a2779fcb0007 ` + -Name Manager Campaign ` + -Description Everyone needs to be reviewed by their manager ` + -Deadline 2020-03-15T10:00:01.456Z ` + -Type MANAGER ` + -EmailNotificationEnabled false ` + -AutoRevokeAllowed false ` + -RecommendationsEnabled true ` + -Status ACTIVE ` + -CorrelatedStatus CORRELATED ` + -Created 2020-03-03T22:15:13.611Z ` + -TotalCertifications 100 ` + -CompletedCertifications 10 ` + -Alerts null ` + -Modified 2020-03-03T22:20:12.674Z ` + -VarFilter null ` + -SunsetCommentsRequired true ` + -SourceOwnerCampaignInfo null ` + -SearchCampaignInfo null ` + -RoleCompositionCampaignInfo null ` + -MachineAccountCampaignInfo null ` + -SourcesWithOrphanEntitlements null ` + -MandatoryCommentRequirement NO_DECISIONS +``` + +- Convert the resource to JSON +```powershell +$Fullcampaign | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullcampaignAllOfFilter.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullcampaignAllOfFilter.md new file mode 100644 index 000000000..79eb7af32 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullcampaignAllOfFilter.md @@ -0,0 +1,39 @@ +--- +id: beta-fullcampaign-all-of-filter +title: FullcampaignAllOfFilter +pagination_label: FullcampaignAllOfFilter +sidebar_label: FullcampaignAllOfFilter +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FullcampaignAllOfFilter', 'BetaFullcampaignAllOfFilter'] +slug: /tools/sdk/powershell/beta/models/fullcampaign-all-of-filter +tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfFilter', 'BetaFullcampaignAllOfFilter'] +--- + + +# FullcampaignAllOfFilter + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of whatever type of filter is being used. | [optional] +**Type** | Pointer to **Enum** [ "CAMPAIGN_FILTER", "RULE" ] | Type of the filter | [optional] +**Name** | Pointer to **String** | Name of the filter | [optional] + +## Examples + +- Prepare the resource +```powershell +$FullcampaignAllOfFilter = Initialize-PSSailpoint.BetaFullcampaignAllOfFilter -Id 0fbe863c063c4c88a35fd7f17e8a3df5 ` + -Type CAMPAIGN_FILTER ` + -Name Test Filter +``` + +- Convert the resource to JSON +```powershell +$FullcampaignAllOfFilter | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullcampaignAllOfMachineAccountCampaignInfo.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullcampaignAllOfMachineAccountCampaignInfo.md new file mode 100644 index 000000000..1f3697fd7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullcampaignAllOfMachineAccountCampaignInfo.md @@ -0,0 +1,37 @@ +--- +id: beta-fullcampaign-all-of-machine-account-campaign-info +title: FullcampaignAllOfMachineAccountCampaignInfo +pagination_label: FullcampaignAllOfMachineAccountCampaignInfo +sidebar_label: FullcampaignAllOfMachineAccountCampaignInfo +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FullcampaignAllOfMachineAccountCampaignInfo', 'BetaFullcampaignAllOfMachineAccountCampaignInfo'] +slug: /tools/sdk/powershell/beta/models/fullcampaign-all-of-machine-account-campaign-info +tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfMachineAccountCampaignInfo', 'BetaFullcampaignAllOfMachineAccountCampaignInfo'] +--- + + +# FullcampaignAllOfMachineAccountCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceIds** | Pointer to **[]String** | The list of sources to be included in the campaign. | [optional] +**ReviewerType** | Pointer to **Enum** [ "ACCOUNT_OWNER" ] | The reviewer's type. | [optional] + +## Examples + +- Prepare the resource +```powershell +$FullcampaignAllOfMachineAccountCampaignInfo = Initialize-PSSailpoint.BetaFullcampaignAllOfMachineAccountCampaignInfo -SourceIds [0fbe863c063c4c88a35fd7f17e8a3df5] ` + -ReviewerType ACCOUNT_OWNER +``` + +- Convert the resource to JSON +```powershell +$FullcampaignAllOfMachineAccountCampaignInfo | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullcampaignAllOfRoleCompositionCampaignInfo.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullcampaignAllOfRoleCompositionCampaignInfo.md new file mode 100644 index 000000000..6f557acac --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullcampaignAllOfRoleCompositionCampaignInfo.md @@ -0,0 +1,43 @@ +--- +id: beta-fullcampaign-all-of-role-composition-campaign-info +title: FullcampaignAllOfRoleCompositionCampaignInfo +pagination_label: FullcampaignAllOfRoleCompositionCampaignInfo +sidebar_label: FullcampaignAllOfRoleCompositionCampaignInfo +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FullcampaignAllOfRoleCompositionCampaignInfo', 'BetaFullcampaignAllOfRoleCompositionCampaignInfo'] +slug: /tools/sdk/powershell/beta/models/fullcampaign-all-of-role-composition-campaign-info +tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfRoleCompositionCampaignInfo', 'BetaFullcampaignAllOfRoleCompositionCampaignInfo'] +--- + + +# FullcampaignAllOfRoleCompositionCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Reviewer** | Pointer to [**FullcampaignAllOfSearchCampaignInfoReviewer**](fullcampaign-all-of-search-campaign-info-reviewer) | | [optional] +**RoleIds** | Pointer to **[]String** | Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. | [optional] +**RemediatorRef** | [**FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef**](fullcampaign-all-of-role-composition-campaign-info-remediator-ref) | | [required] +**Query** | Pointer to **String** | Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. | [optional] +**Description** | Pointer to **String** | Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available. | [optional] + +## Examples + +- Prepare the resource +```powershell +$FullcampaignAllOfRoleCompositionCampaignInfo = Initialize-PSSailpoint.BetaFullcampaignAllOfRoleCompositionCampaignInfo -Reviewer null ` + -RoleIds [2c90ad2a70ace7d50170acf22ca90010] ` + -RemediatorRef null ` + -Query Search Query ` + -Description Role Composition Description +``` + +- Convert the resource to JSON +```powershell +$FullcampaignAllOfRoleCompositionCampaignInfo | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md new file mode 100644 index 000000000..42ea6db25 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md @@ -0,0 +1,39 @@ +--- +id: beta-fullcampaign-all-of-role-composition-campaign-info-remediator-ref +title: FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef +pagination_label: FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef +sidebar_label: FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef', 'BetaFullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef'] +slug: /tools/sdk/powershell/beta/models/fullcampaign-all-of-role-composition-campaign-info-remediator-ref +tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef', 'BetaFullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef'] +--- + + +# FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | Legal Remediator Type | [required] +**Id** | **String** | The ID of the remediator. | [required] +**Name** | Pointer to **String** | The name of the remediator. | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef = Initialize-PSSailpoint.BetaFullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef -Type IDENTITY ` + -Id 2c90ad2a70ace7d50170acf22ca90010 ` + -Name Role Admin +``` + +- Convert the resource to JSON +```powershell +$FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullcampaignAllOfSearchCampaignInfo.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullcampaignAllOfSearchCampaignInfo.md new file mode 100644 index 000000000..8231cf16b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullcampaignAllOfSearchCampaignInfo.md @@ -0,0 +1,45 @@ +--- +id: beta-fullcampaign-all-of-search-campaign-info +title: FullcampaignAllOfSearchCampaignInfo +pagination_label: FullcampaignAllOfSearchCampaignInfo +sidebar_label: FullcampaignAllOfSearchCampaignInfo +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FullcampaignAllOfSearchCampaignInfo', 'BetaFullcampaignAllOfSearchCampaignInfo'] +slug: /tools/sdk/powershell/beta/models/fullcampaign-all-of-search-campaign-info +tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfSearchCampaignInfo', 'BetaFullcampaignAllOfSearchCampaignInfo'] +--- + + +# FullcampaignAllOfSearchCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY", "ACCESS" ] | The type of search campaign represented. | [required] +**Description** | Pointer to **String** | Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available. | [optional] +**Reviewer** | Pointer to [**FullcampaignAllOfSearchCampaignInfoReviewer**](fullcampaign-all-of-search-campaign-info-reviewer) | | [optional] +**Query** | Pointer to **String** | The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set. | [optional] +**IdentityIds** | Pointer to **[]String** | A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set. | [optional] +**AccessConstraints** | Pointer to [**[]AccessConstraint**](access-constraint) | Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. | [optional] + +## Examples + +- Prepare the resource +```powershell +$FullcampaignAllOfSearchCampaignInfo = Initialize-PSSailpoint.BetaFullcampaignAllOfSearchCampaignInfo -Type ACCESS ` + -Description Search Campaign description ` + -Reviewer null ` + -Query Search Campaign query description ` + -IdentityIds [0fbe863c063c4c88a35fd7f17e8a3df5] ` + -AccessConstraints null +``` + +- Convert the resource to JSON +```powershell +$FullcampaignAllOfSearchCampaignInfo | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullcampaignAllOfSearchCampaignInfoReviewer.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullcampaignAllOfSearchCampaignInfoReviewer.md new file mode 100644 index 000000000..68057b90e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullcampaignAllOfSearchCampaignInfoReviewer.md @@ -0,0 +1,39 @@ +--- +id: beta-fullcampaign-all-of-search-campaign-info-reviewer +title: FullcampaignAllOfSearchCampaignInfoReviewer +pagination_label: FullcampaignAllOfSearchCampaignInfoReviewer +sidebar_label: FullcampaignAllOfSearchCampaignInfoReviewer +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FullcampaignAllOfSearchCampaignInfoReviewer', 'BetaFullcampaignAllOfSearchCampaignInfoReviewer'] +slug: /tools/sdk/powershell/beta/models/fullcampaign-all-of-search-campaign-info-reviewer +tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfSearchCampaignInfoReviewer', 'BetaFullcampaignAllOfSearchCampaignInfoReviewer'] +--- + + +# FullcampaignAllOfSearchCampaignInfoReviewer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP", "IDENTITY" ] | The reviewer's DTO type. | [optional] +**Id** | Pointer to **String** | The reviewer's ID. | [optional] +**Name** | Pointer to **String** | The reviewer's name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$FullcampaignAllOfSearchCampaignInfoReviewer = Initialize-PSSailpoint.BetaFullcampaignAllOfSearchCampaignInfoReviewer -Type IDENTITY ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$FullcampaignAllOfSearchCampaignInfoReviewer | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullcampaignAllOfSourceOwnerCampaignInfo.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullcampaignAllOfSourceOwnerCampaignInfo.md new file mode 100644 index 000000000..6e279cad1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullcampaignAllOfSourceOwnerCampaignInfo.md @@ -0,0 +1,35 @@ +--- +id: beta-fullcampaign-all-of-source-owner-campaign-info +title: FullcampaignAllOfSourceOwnerCampaignInfo +pagination_label: FullcampaignAllOfSourceOwnerCampaignInfo +sidebar_label: FullcampaignAllOfSourceOwnerCampaignInfo +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FullcampaignAllOfSourceOwnerCampaignInfo', 'BetaFullcampaignAllOfSourceOwnerCampaignInfo'] +slug: /tools/sdk/powershell/beta/models/fullcampaign-all-of-source-owner-campaign-info +tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfSourceOwnerCampaignInfo', 'BetaFullcampaignAllOfSourceOwnerCampaignInfo'] +--- + + +# FullcampaignAllOfSourceOwnerCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceIds** | Pointer to **[]String** | The list of sources to be included in the campaign. | [optional] + +## Examples + +- Prepare the resource +```powershell +$FullcampaignAllOfSourceOwnerCampaignInfo = Initialize-PSSailpoint.BetaFullcampaignAllOfSourceOwnerCampaignInfo -SourceIds [0fbe863c063c4c88a35fd7f17e8a3df5] +``` + +- Convert the resource to JSON +```powershell +$FullcampaignAllOfSourceOwnerCampaignInfo | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullcampaignAllOfSourcesWithOrphanEntitlements.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullcampaignAllOfSourcesWithOrphanEntitlements.md new file mode 100644 index 000000000..ab7e1ccda --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/FullcampaignAllOfSourcesWithOrphanEntitlements.md @@ -0,0 +1,39 @@ +--- +id: beta-fullcampaign-all-of-sources-with-orphan-entitlements +title: FullcampaignAllOfSourcesWithOrphanEntitlements +pagination_label: FullcampaignAllOfSourcesWithOrphanEntitlements +sidebar_label: FullcampaignAllOfSourcesWithOrphanEntitlements +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FullcampaignAllOfSourcesWithOrphanEntitlements', 'BetaFullcampaignAllOfSourcesWithOrphanEntitlements'] +slug: /tools/sdk/powershell/beta/models/fullcampaign-all-of-sources-with-orphan-entitlements +tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfSourcesWithOrphanEntitlements', 'BetaFullcampaignAllOfSourcesWithOrphanEntitlements'] +--- + + +# FullcampaignAllOfSourcesWithOrphanEntitlements + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the source | [optional] +**Type** | Pointer to **Enum** [ "SOURCE" ] | Type | [optional] +**Name** | Pointer to **String** | Name of the source | [optional] + +## Examples + +- Prepare the resource +```powershell +$FullcampaignAllOfSourcesWithOrphanEntitlements = Initialize-PSSailpoint.BetaFullcampaignAllOfSourcesWithOrphanEntitlements -Id 2c90ad2a70ace7d50170acf22ca90010 ` + -Type SOURCE ` + -Name Source with orphan entitlements +``` + +- Convert the resource to JSON +```powershell +$FullcampaignAllOfSourcesWithOrphanEntitlements | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GenerateRandomString.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GenerateRandomString.md new file mode 100644 index 000000000..65c3eed5c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GenerateRandomString.md @@ -0,0 +1,45 @@ +--- +id: beta-generate-random-string +title: GenerateRandomString +pagination_label: GenerateRandomString +sidebar_label: GenerateRandomString +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GenerateRandomString', 'BetaGenerateRandomString'] +slug: /tools/sdk/powershell/beta/models/generate-random-string +tags: ['SDK', 'Software Development Kit', 'GenerateRandomString', 'BetaGenerateRandomString'] +--- + + +# GenerateRandomString + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | This must always be set to ""Cloud Services Deployment Utility"" | [required] +**Operation** | **String** | The operation to perform `generateRandomString` | [required] +**IncludeNumbers** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include numbers | [required] +**IncludeSpecialChars** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include special characters | [required] +**Length** | **String** | This specifies how long the randomly generated string needs to be >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$GenerateRandomString = Initialize-PSSailpoint.BetaGenerateRandomString -Name Cloud Services Deployment Utility ` + -Operation generateRandomString ` + -IncludeNumbers true ` + -IncludeSpecialChars true ` + -Length 10 ` + -RequiresPeriodicRefresh false +``` + +- Convert the resource to JSON +```powershell +$GenerateRandomString | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetActiveCampaigns200ResponseInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetActiveCampaigns200ResponseInner.md new file mode 100644 index 000000000..dac35d700 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetActiveCampaigns200ResponseInner.md @@ -0,0 +1,79 @@ +--- +id: beta-get-active-campaigns200-response-inner +title: GetActiveCampaigns200ResponseInner +pagination_label: GetActiveCampaigns200ResponseInner +sidebar_label: GetActiveCampaigns200ResponseInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetActiveCampaigns200ResponseInner', 'BetaGetActiveCampaigns200ResponseInner'] +slug: /tools/sdk/powershell/beta/models/get-active-campaigns200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetActiveCampaigns200ResponseInner', 'BetaGetActiveCampaigns200ResponseInner'] +--- + + +# GetActiveCampaigns200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the campaign | [optional] [readonly] +**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Deadline** | Pointer to **System.DateTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required] +**EmailNotificationEnabled** | Pointer to **Boolean** | Enables email notification for this campaign | [optional] [default to $false] +**AutoRevokeAllowed** | Pointer to **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] +**RecommendationsEnabled** | Pointer to **Boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to $false] +**Status** | Pointer to **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **System.DateTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **Int32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | Modified time of the campaign | [optional] [readonly] +**VarFilter** | Pointer to [**FullcampaignAllOfFilter**](fullcampaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | Pointer to **Boolean** | Determines if comments on sunset date changes are required. | [optional] [default to $true] +**SourceOwnerCampaignInfo** | Pointer to [**FullcampaignAllOfSourceOwnerCampaignInfo**](fullcampaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | Pointer to [**FullcampaignAllOfSearchCampaignInfo**](fullcampaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | Pointer to [**FullcampaignAllOfRoleCompositionCampaignInfo**](fullcampaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | Pointer to [**FullcampaignAllOfMachineAccountCampaignInfo**](fullcampaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | Pointer to [**[]FullcampaignAllOfSourcesWithOrphanEntitlements**](fullcampaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \""orphan entitlements\"" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**MandatoryCommentRequirement** | Pointer to **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] + +## Examples + +- Prepare the resource +```powershell +$GetActiveCampaigns200ResponseInner = Initialize-PSSailpoint.BetaGetActiveCampaigns200ResponseInner -Id 2c9079b270a266a60170a2779fcb0007 ` + -Name Manager Campaign ` + -Description Everyone needs to be reviewed by their manager ` + -Deadline 2020-03-15T10:00:01.456Z ` + -Type MANAGER ` + -EmailNotificationEnabled false ` + -AutoRevokeAllowed false ` + -RecommendationsEnabled true ` + -Status ACTIVE ` + -CorrelatedStatus CORRELATED ` + -Created 2020-03-03T22:15:13.611Z ` + -TotalCertifications 100 ` + -CompletedCertifications 10 ` + -Alerts null ` + -Modified 2020-03-03T22:20:12.674Z ` + -VarFilter null ` + -SunsetCommentsRequired true ` + -SourceOwnerCampaignInfo null ` + -SearchCampaignInfo null ` + -RoleCompositionCampaignInfo null ` + -MachineAccountCampaignInfo null ` + -SourcesWithOrphanEntitlements null ` + -MandatoryCommentRequirement NO_DECISIONS +``` + +- Convert the resource to JSON +```powershell +$GetActiveCampaigns200ResponseInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetDiscoveredApplications200ResponseInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetDiscoveredApplications200ResponseInner.md new file mode 100644 index 000000000..550f94b34 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetDiscoveredApplications200ResponseInner.md @@ -0,0 +1,53 @@ +--- +id: beta-get-discovered-applications200-response-inner +title: GetDiscoveredApplications200ResponseInner +pagination_label: GetDiscoveredApplications200ResponseInner +sidebar_label: GetDiscoveredApplications200ResponseInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetDiscoveredApplications200ResponseInner', 'BetaGetDiscoveredApplications200ResponseInner'] +slug: /tools/sdk/powershell/beta/models/get-discovered-applications200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetDiscoveredApplications200ResponseInner', 'BetaGetDiscoveredApplications200ResponseInner'] +--- + + +# GetDiscoveredApplications200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Unique identifier for the discovered application. | [optional] +**Name** | Pointer to **String** | Name of the discovered application. | [optional] +**DiscoverySource** | Pointer to **String** | Source from which the application was discovered. | [optional] +**DiscoveredVendor** | Pointer to **String** | The vendor associated with the discovered application. | [optional] +**Description** | Pointer to **String** | A brief description of the discovered application. | [optional] +**RecommendedConnectors** | Pointer to **[]String** | List of recommended connectors for the application. | [optional] +**DiscoveredAt** | Pointer to **System.DateTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**CreatedAt** | Pointer to **System.DateTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**Status** | Pointer to **String** | The status of an application within the discovery source. By default this field is set to ""ACTIVE"" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to ""INACTIVE"". | [optional] +**AssociatedSources** | Pointer to **[]String** | List of associated sources related to this discovered application. | [optional] + +## Examples + +- Prepare the resource +```powershell +$GetDiscoveredApplications200ResponseInner = Initialize-PSSailpoint.BetaGetDiscoveredApplications200ResponseInner -Id null ` + -Name ExampleApp ` + -DiscoverySource csv ` + -DiscoveredVendor ExampleVendor ` + -Description An application for managing examples. ` + -RecommendedConnectors [ConnectorA, ConnectorB] ` + -DiscoveredAt 2023-01-01T12:00Z ` + -CreatedAt 2023-01-01T12:00Z ` + -Status ACTIVE ` + -AssociatedSources [e0cc5d7d-bf7f-4f81-b2af-8885b09d9923, a0303682-5e4a-44f7-bdc2-6ce6112549c1] +``` + +- Convert the resource to JSON +```powershell +$GetDiscoveredApplications200ResponseInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetFormDefinitionByKey400Response.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetFormDefinitionByKey400Response.md new file mode 100644 index 000000000..0df0ecee3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetFormDefinitionByKey400Response.md @@ -0,0 +1,41 @@ +--- +id: beta-get-form-definition-by-key400-response +title: GetFormDefinitionByKey400Response +pagination_label: GetFormDefinitionByKey400Response +sidebar_label: GetFormDefinitionByKey400Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetFormDefinitionByKey400Response', 'BetaGetFormDefinitionByKey400Response'] +slug: /tools/sdk/powershell/beta/models/get-form-definition-by-key400-response +tags: ['SDK', 'Software Development Kit', 'GetFormDefinitionByKey400Response', 'BetaGetFormDefinitionByKey400Response'] +--- + + +# GetFormDefinitionByKey400Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetailCode** | Pointer to **String** | | [optional] +**Messages** | Pointer to [**[]ErrorMessage**](error-message) | | [optional] +**StatusCode** | Pointer to **Int64** | | [optional] +**TrackingId** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$GetFormDefinitionByKey400Response = Initialize-PSSailpoint.BetaGetFormDefinitionByKey400Response -DetailCode null ` + -Messages null ` + -StatusCode null ` + -TrackingId null +``` + +- Convert the resource to JSON +```powershell +$GetFormDefinitionByKey400Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetHistoricalIdentityEvents200ResponseInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetHistoricalIdentityEvents200ResponseInner.md new file mode 100644 index 000000000..cd4fce801 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetHistoricalIdentityEvents200ResponseInner.md @@ -0,0 +1,63 @@ +--- +id: beta-get-historical-identity-events200-response-inner +title: GetHistoricalIdentityEvents200ResponseInner +pagination_label: GetHistoricalIdentityEvents200ResponseInner +sidebar_label: GetHistoricalIdentityEvents200ResponseInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetHistoricalIdentityEvents200ResponseInner', 'BetaGetHistoricalIdentityEvents200ResponseInner'] +slug: /tools/sdk/powershell/beta/models/get-historical-identity-events200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetHistoricalIdentityEvents200ResponseInner', 'BetaGetHistoricalIdentityEvents200ResponseInner'] +--- + + +# GetHistoricalIdentityEvents200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessItem** | Pointer to [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional] +**IdentityId** | Pointer to **String** | the identity id | [optional] +**EventType** | Pointer to **String** | the event type | [optional] +**Dt** | Pointer to **String** | the date of event | [optional] +**GovernanceEvent** | Pointer to [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional] +**Changes** | Pointer to [**[]AttributeChange**](attribute-change) | | [optional] +**AccessRequest** | Pointer to [**AccessRequestResponse1**](access-request-response1) | | [optional] +**CertificationId** | Pointer to **String** | the id of the certification item | [optional] +**CertificationName** | Pointer to **String** | the certification item name | [optional] +**SignedDate** | Pointer to **String** | the date ceritification was signed | [optional] +**Certifiers** | Pointer to [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [optional] +**Reviewers** | Pointer to [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional] +**Signer** | Pointer to [**CertifierResponse**](certifier-response) | | [optional] +**Account** | Pointer to [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional] +**StatusChange** | Pointer to [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$GetHistoricalIdentityEvents200ResponseInner = Initialize-PSSailpoint.BetaGetHistoricalIdentityEvents200ResponseInner -AccessItem null ` + -IdentityId null ` + -EventType null ` + -Dt null ` + -GovernanceEvent null ` + -Changes null ` + -AccessRequest null ` + -CertificationId 2c91808a77ff216301782327a50f09bf ` + -CertificationName Cert name ` + -SignedDate 2019-03-08T22:37:33.901Z ` + -Certifiers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` + -Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` + -Signer null ` + -Account null ` + -StatusChange null +``` + +- Convert the resource to JSON +```powershell +$GetHistoricalIdentityEvents200ResponseInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetLaunchers200Response.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetLaunchers200Response.md new file mode 100644 index 000000000..8d9602c90 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetLaunchers200Response.md @@ -0,0 +1,37 @@ +--- +id: beta-get-launchers200-response +title: GetLaunchers200Response +pagination_label: GetLaunchers200Response +sidebar_label: GetLaunchers200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetLaunchers200Response', 'BetaGetLaunchers200Response'] +slug: /tools/sdk/powershell/beta/models/get-launchers200-response +tags: ['SDK', 'Software Development Kit', 'GetLaunchers200Response', 'BetaGetLaunchers200Response'] +--- + + +# GetLaunchers200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Next** | Pointer to **String** | Pagination marker | [optional] +**Items** | Pointer to [**[]Launcher**](launcher) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$GetLaunchers200Response = Initialize-PSSailpoint.BetaGetLaunchers200Response -Next null ` + -Items null +``` + +- Convert the resource to JSON +```powershell +$GetLaunchers200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetOAuthClientResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetOAuthClientResponse.md new file mode 100644 index 000000000..52745fd8c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetOAuthClientResponse.md @@ -0,0 +1,75 @@ +--- +id: beta-get-o-auth-client-response +title: GetOAuthClientResponse +pagination_label: GetOAuthClientResponse +sidebar_label: GetOAuthClientResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetOAuthClientResponse', 'BetaGetOAuthClientResponse'] +slug: /tools/sdk/powershell/beta/models/get-o-auth-client-response +tags: ['SDK', 'Software Development Kit', 'GetOAuthClientResponse', 'BetaGetOAuthClientResponse'] +--- + + +# GetOAuthClientResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | ID of the OAuth client | [required] +**BusinessName** | **String** | The name of the business the API Client should belong to | [required] +**HomepageUrl** | **String** | The homepage URL associated with the owner of the API Client | [required] +**Name** | **String** | A human-readable name for the API Client | [required] +**Description** | **String** | A description of the API Client | [required] +**AccessTokenValiditySeconds** | **Int32** | The number of seconds an access token generated for this API Client is valid for | [required] +**RefreshTokenValiditySeconds** | **Int32** | The number of seconds a refresh token generated for this API Client is valid for | [required] +**RedirectUris** | **[]String** | A list of the approved redirect URIs used with the authorization_code flow | [required] +**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | [required] +**AccessType** | [**AccessType**](access-type) | | [required] +**Type** | [**ClientType**](client-type) | | [required] +**Internal** | **Boolean** | An indicator of whether the API Client can be used for requests internal to IDN | [required] +**Enabled** | **Boolean** | An indicator of whether the API Client is enabled for use | [required] +**StrongAuthSupported** | **Boolean** | An indicator of whether the API Client supports strong authentication | [required] +**ClaimsSupported** | **Boolean** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [required] +**Created** | **System.DateTime** | The date and time, down to the millisecond, when the API Client was created | [required] +**Modified** | **System.DateTime** | The date and time, down to the millisecond, when the API Client was last updated | [required] +**Secret** | Pointer to **String** | | [optional] +**Metadata** | Pointer to **String** | | [optional] +**LastUsed** | Pointer to **System.DateTime** | The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed. | [optional] +**Scope** | **[]String** | Scopes of the API Client. | [required] + +## Examples + +- Prepare the resource +```powershell +$GetOAuthClientResponse = Initialize-PSSailpoint.BetaGetOAuthClientResponse -Id 2c9180835d2e5168015d32f890ca1581 ` + -BusinessName Acme-Solar ` + -HomepageUrl http://localhost:12345 ` + -Name Demo API Client ` + -Description An API client used for the authorization_code, refresh_token, and client_credentials flows ` + -AccessTokenValiditySeconds 750 ` + -RefreshTokenValiditySeconds 86400 ` + -RedirectUris [http://localhost:12345] ` + -GrantTypes [AUTHORIZATION_CODE, CLIENT_CREDENTIALS, REFRESH_TOKEN] ` + -AccessType null ` + -Type null ` + -Internal false ` + -Enabled true ` + -StrongAuthSupported false ` + -ClaimsSupported false ` + -Created 2017-07-11T18:45:37.098Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Secret null ` + -Metadata null ` + -LastUsed 2017-07-11T18:45:37.098Z ` + -Scope [demo:api-client-scope:first, demo:api-client-scope:second] +``` + +- Convert the resource to JSON +```powershell +$GetOAuthClientResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetPersonalAccessTokenResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetPersonalAccessTokenResponse.md new file mode 100644 index 000000000..4a7b03faa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetPersonalAccessTokenResponse.md @@ -0,0 +1,47 @@ +--- +id: beta-get-personal-access-token-response +title: GetPersonalAccessTokenResponse +pagination_label: GetPersonalAccessTokenResponse +sidebar_label: GetPersonalAccessTokenResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetPersonalAccessTokenResponse', 'BetaGetPersonalAccessTokenResponse'] +slug: /tools/sdk/powershell/beta/models/get-personal-access-token-response +tags: ['SDK', 'Software Development Kit', 'GetPersonalAccessTokenResponse', 'BetaGetPersonalAccessTokenResponse'] +--- + + +# GetPersonalAccessTokenResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The ID of the personal access token (to be used as the username for Basic Auth). | [required] +**Name** | **String** | The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. | [required] +**Scope** | **[]String** | Scopes of the personal access token. | [required] +**Owner** | [**PatOwner**](pat-owner) | | [required] +**Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required] +**LastUsed** | Pointer to **System.DateTime** | The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. | [optional] +**Managed** | Pointer to **Boolean** | If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$GetPersonalAccessTokenResponse = Initialize-PSSailpoint.BetaGetPersonalAccessTokenResponse -Id 86f1dc6fe8f54414950454cbb11278fa ` + -Name NodeJS Integration ` + -Scope [demo:personal-access-token-scope:first, demo:personal-access-token-scope:second] ` + -Owner null ` + -Created 2017-07-11T18:45:37.098Z ` + -LastUsed 2017-07-11T18:45:37.098Z ` + -Managed false +``` + +- Convert the resource to JSON +```powershell +$GetPersonalAccessTokenResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetReferenceIdentityAttribute.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetReferenceIdentityAttribute.md new file mode 100644 index 000000000..bba6b39e4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetReferenceIdentityAttribute.md @@ -0,0 +1,41 @@ +--- +id: beta-get-reference-identity-attribute +title: GetReferenceIdentityAttribute +pagination_label: GetReferenceIdentityAttribute +sidebar_label: GetReferenceIdentityAttribute +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetReferenceIdentityAttribute', 'BetaGetReferenceIdentityAttribute'] +slug: /tools/sdk/powershell/beta/models/get-reference-identity-attribute +tags: ['SDK', 'Software Development Kit', 'GetReferenceIdentityAttribute', 'BetaGetReferenceIdentityAttribute'] +--- + + +# GetReferenceIdentityAttribute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | This must always be set to ""Cloud Services Deployment Utility"" | [required] +**Operation** | **String** | The operation to perform `getReferenceIdentityAttribute` | [required] +**Uid** | **String** | This is the SailPoint User Name (uid) value of the identity whose attribute is desired As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$GetReferenceIdentityAttribute = Initialize-PSSailpoint.BetaGetReferenceIdentityAttribute -Name Cloud Services Deployment Utility ` + -Operation getReferenceIdentityAttribute ` + -Uid 2c91808570313110017040b06f344ec9 ` + -RequiresPeriodicRefresh false +``` + +- Convert the resource to JSON +```powershell +$GetReferenceIdentityAttribute | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetRoleAssignments200ResponseInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetRoleAssignments200ResponseInner.md new file mode 100644 index 000000000..75d7249df --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GetRoleAssignments200ResponseInner.md @@ -0,0 +1,51 @@ +--- +id: beta-get-role-assignments200-response-inner +title: GetRoleAssignments200ResponseInner +pagination_label: GetRoleAssignments200ResponseInner +sidebar_label: GetRoleAssignments200ResponseInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetRoleAssignments200ResponseInner', 'BetaGetRoleAssignments200ResponseInner'] +slug: /tools/sdk/powershell/beta/models/get-role-assignments200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetRoleAssignments200ResponseInner', 'BetaGetRoleAssignments200ResponseInner'] +--- + + +# GetRoleAssignments200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Assignment Id | [optional] +**Role** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] +**Comments** | Pointer to **String** | Comments added by the user when the assignment was made | [optional] +**AssignmentSource** | Pointer to **String** | Source describing how this assignment was made | [optional] +**Assigner** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] +**AssignedDimensions** | Pointer to [**[]BaseReferenceDto1**](base-reference-dto1) | Dimensions assigned related to this role | [optional] +**AssignmentContext** | Pointer to [**AssignmentContextDto**](assignment-context-dto) | | [optional] +**AccountTargets** | Pointer to [**[]RoleTargetDto**](role-target-dto) | | [optional] +**RemoveDate** | Pointer to **String** | Date that the assignment will be removed | [optional] + +## Examples + +- Prepare the resource +```powershell +$GetRoleAssignments200ResponseInner = Initialize-PSSailpoint.BetaGetRoleAssignments200ResponseInner -Id 1cbb0705b38c4226b1334eadd8874086 ` + -Role null ` + -Comments I'm a new Engineer and need this role to do my work ` + -AssignmentSource UI ` + -Assigner null ` + -AssignedDimensions [{id=1acc8ffe5fcf457090de28bee2af36ee, type=DIMENSION, name=Northeast region}] ` + -AssignmentContext null ` + -AccountTargets null ` + -RemoveDate Wed Feb 14 10:58:42 +``` + +- Convert the resource to JSON +```powershell +$GetRoleAssignments200ResponseInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GrantType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GrantType.md new file mode 100644 index 000000000..9185f41e9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/GrantType.md @@ -0,0 +1,26 @@ +--- +id: beta-grant-type +title: GrantType +pagination_label: GrantType +sidebar_label: GrantType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GrantType', 'BetaGrantType'] +slug: /tools/sdk/powershell/beta/models/grant-type +tags: ['SDK', 'Software Development Kit', 'GrantType', 'BetaGrantType'] +--- + + +# GrantType + +## Enum + + +* `CLIENT_CREDENTIALS` (value: `"CLIENT_CREDENTIALS"`) + +* `AUTHORIZATION_CODE` (value: `"AUTHORIZATION_CODE"`) + +* `REFRESH_TOKEN` (value: `"REFRESH_TOKEN"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/HttpAuthenticationType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/HttpAuthenticationType.md new file mode 100644 index 000000000..a82dcdb94 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/HttpAuthenticationType.md @@ -0,0 +1,26 @@ +--- +id: beta-http-authentication-type +title: HttpAuthenticationType +pagination_label: HttpAuthenticationType +sidebar_label: HttpAuthenticationType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'HttpAuthenticationType', 'BetaHttpAuthenticationType'] +slug: /tools/sdk/powershell/beta/models/http-authentication-type +tags: ['SDK', 'Software Development Kit', 'HttpAuthenticationType', 'BetaHttpAuthenticationType'] +--- + + +# HttpAuthenticationType + +## Enum + + +* `NO_AUTH` (value: `"NO_AUTH"`) + +* `BASIC_AUTH` (value: `"BASIC_AUTH"`) + +* `BEARER_TOKEN` (value: `"BEARER_TOKEN"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/HttpConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/HttpConfig.md new file mode 100644 index 000000000..108827db5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/HttpConfig.md @@ -0,0 +1,43 @@ +--- +id: beta-http-config +title: HttpConfig +pagination_label: HttpConfig +sidebar_label: HttpConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'HttpConfig', 'BetaHttpConfig'] +slug: /tools/sdk/powershell/beta/models/http-config +tags: ['SDK', 'Software Development Kit', 'HttpConfig', 'BetaHttpConfig'] +--- + + +# HttpConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Url** | **String** | URL of the external/custom integration. | [required] +**HttpDispatchMode** | [**HttpDispatchMode**](http-dispatch-mode) | | [required] +**HttpAuthenticationType** | Pointer to [**HttpAuthenticationType**](http-authentication-type) | | [optional] +**BasicAuthConfig** | Pointer to [**BasicAuthConfig**](basic-auth-config) | | [optional] +**BearerTokenAuthConfig** | Pointer to [**BearerTokenAuthConfig**](bearer-token-auth-config) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$HttpConfig = Initialize-PSSailpoint.BetaHttpConfig -Url https://www.example.com ` + -HttpDispatchMode null ` + -HttpAuthenticationType null ` + -BasicAuthConfig null ` + -BearerTokenAuthConfig null +``` + +- Convert the resource to JSON +```powershell +$HttpConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/HttpDispatchMode.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/HttpDispatchMode.md new file mode 100644 index 000000000..90c81d049 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/HttpDispatchMode.md @@ -0,0 +1,26 @@ +--- +id: beta-http-dispatch-mode +title: HttpDispatchMode +pagination_label: HttpDispatchMode +sidebar_label: HttpDispatchMode +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'HttpDispatchMode', 'BetaHttpDispatchMode'] +slug: /tools/sdk/powershell/beta/models/http-dispatch-mode +tags: ['SDK', 'Software Development Kit', 'HttpDispatchMode', 'BetaHttpDispatchMode'] +--- + + +# HttpDispatchMode + +## Enum + + +* `SYNC` (value: `"SYNC"`) + +* `ASYNC` (value: `"ASYNC"`) + +* `DYNAMIC` (value: `"DYNAMIC"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ISO3166.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ISO3166.md new file mode 100644 index 000000000..b539af8c4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ISO3166.md @@ -0,0 +1,39 @@ +--- +id: beta-iso3166 +title: ISO3166 +pagination_label: ISO3166 +sidebar_label: ISO3166 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ISO3166', 'BetaISO3166'] +slug: /tools/sdk/powershell/beta/models/iso3166 +tags: ['SDK', 'Software Development Kit', 'ISO3166', 'BetaISO3166'] +--- + + +# ISO3166 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Format** | Pointer to **String** | An optional value to denote which ISO 3166 format to return. Valid values are: `alpha2` - Two-character country code (e.g., ""US""); this is the default value if no format is supplied `alpha3` - Three-character country code (e.g., ""USA"") `numeric` - The numeric country code (e.g., ""840"") | [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] + +## Examples + +- Prepare the resource +```powershell +$ISO3166 = Initialize-PSSailpoint.BetaISO3166 -Format alpha2 ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$ISO3166 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentitiesAccountsBulkRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentitiesAccountsBulkRequest.md new file mode 100644 index 000000000..307c076f9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentitiesAccountsBulkRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-identities-accounts-bulk-request +title: IdentitiesAccountsBulkRequest +pagination_label: IdentitiesAccountsBulkRequest +sidebar_label: IdentitiesAccountsBulkRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentitiesAccountsBulkRequest', 'BetaIdentitiesAccountsBulkRequest'] +slug: /tools/sdk/powershell/beta/models/identities-accounts-bulk-request +tags: ['SDK', 'Software Development Kit', 'IdentitiesAccountsBulkRequest', 'BetaIdentitiesAccountsBulkRequest'] +--- + + +# IdentitiesAccountsBulkRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityIds** | Pointer to **[]String** | The ids of the identities for which enable/disable accounts. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentitiesAccountsBulkRequest = Initialize-PSSailpoint.BetaIdentitiesAccountsBulkRequest -IdentityIds [2c91808384203c2d018437e631158308, 2c9180858082150f0180893dbaf553fe] +``` + +- Convert the resource to JSON +```powershell +$IdentitiesAccountsBulkRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Identity.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Identity.md new file mode 100644 index 000000000..50c92436b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Identity.md @@ -0,0 +1,59 @@ +--- +id: beta-identity +title: Identity +pagination_label: Identity +sidebar_label: Identity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Identity', 'BetaIdentity'] +slug: /tools/sdk/powershell/beta/models/identity +tags: ['SDK', 'Software Development Kit', 'Identity', 'BetaIdentity'] +--- + + +# Identity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | System-generated unique ID of the identity | [optional] [readonly] +**Name** | **String** | The identity's name is equivalent to its Display Name attribute. | [required] +**Created** | Pointer to **System.DateTime** | Creation date of the identity | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | Last modification date of the identity | [optional] [readonly] +**Alias** | Pointer to **String** | The identity's alternate unique identifier is equivalent to its Account Name on the authoritative source account schema. | [optional] +**EmailAddress** | Pointer to **String** | The email address of the identity | [optional] +**ProcessingState** | Pointer to **Enum** [ "ERROR", "OK" ] | The processing state of the identity | [optional] +**IdentityStatus** | Pointer to **Enum** [ "UNREGISTERED", "REGISTERED", "PENDING", "WARNING", "DISABLED", "ACTIVE", "DEACTIVATED", "TERMINATED", "ERROR", "LOCKED" ] | The identity's status in the system | [optional] +**ManagerRef** | Pointer to [**IdentityManagerRef**](identity-manager-ref) | | [optional] +**IsManager** | Pointer to **Boolean** | Whether this identity is a manager of another identity | [optional] [default to $false] +**LastRefresh** | Pointer to **System.DateTime** | The last time the identity was refreshed by the system | [optional] +**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A map with the identity attributes for the identity | [optional] +**LifecycleState** | Pointer to [**IdentityLifecycleState**](identity-lifecycle-state) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Identity = Initialize-PSSailpoint.BetaIdentity -Id 01f04e428c484542a241dc89c303b178 ` + -Name Walter White ` + -Created 2023-01-03T21:16:22.432Z ` + -Modified 2023-01-03T21:16:22.432Z ` + -Alias walter.white ` + -EmailAddress walter.white@example.com ` + -ProcessingState ERROR ` + -IdentityStatus LOCKED ` + -ManagerRef null ` + -IsManager true ` + -LastRefresh 2020-11-22T15:42:31.123Z ` + -Attributes {uid=86754, firstname=Walter, cloudStatus=UNREGISTERED, displayName=Walter White, identificationNumber=86754, lastSyncDate=1470348809380, email=walter.white@example.com, lastname=White} ` + -LifecycleState null +``` + +- Convert the resource to JSON +```powershell +$Identity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Identity1.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Identity1.md new file mode 100644 index 000000000..86a4a8c06 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Identity1.md @@ -0,0 +1,37 @@ +--- +id: beta-identity1 +title: Identity1 +pagination_label: Identity1 +sidebar_label: Identity1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Identity1', 'BetaIdentity1'] +slug: /tools/sdk/powershell/beta/models/identity1 +tags: ['SDK', 'Software Development Kit', 'Identity1', 'BetaIdentity1'] +--- + + +# Identity1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of the object | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object | [optional] + +## Examples + +- Prepare the resource +```powershell +$Identity1 = Initialize-PSSailpoint.BetaIdentity1 -Id 2c91808380aa05580180aaaaf1940410 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$Identity1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAssociationDetails.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAssociationDetails.md new file mode 100644 index 000000000..c1a6bb224 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAssociationDetails.md @@ -0,0 +1,37 @@ +--- +id: beta-identity-association-details +title: IdentityAssociationDetails +pagination_label: IdentityAssociationDetails +sidebar_label: IdentityAssociationDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAssociationDetails', 'BetaIdentityAssociationDetails'] +slug: /tools/sdk/powershell/beta/models/identity-association-details +tags: ['SDK', 'Software Development Kit', 'IdentityAssociationDetails', 'BetaIdentityAssociationDetails'] +--- + + +# IdentityAssociationDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to **String** | any additional context information of the http call result | [optional] +**AssociationDetails** | Pointer to [**[]IdentityAssociationDetailsAssociationDetailsInner**](identity-association-details-association-details-inner) | list of all the resource associations for the identity | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAssociationDetails = Initialize-PSSailpoint.BetaIdentityAssociationDetails -Message Identity cannot be deleted as it is owner of following resources ` + -AssociationDetails null +``` + +- Convert the resource to JSON +```powershell +$IdentityAssociationDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAssociationDetailsAssociationDetailsInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAssociationDetailsAssociationDetailsInner.md new file mode 100644 index 000000000..9a6618ce3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAssociationDetailsAssociationDetailsInner.md @@ -0,0 +1,37 @@ +--- +id: beta-identity-association-details-association-details-inner +title: IdentityAssociationDetailsAssociationDetailsInner +pagination_label: IdentityAssociationDetailsAssociationDetailsInner +sidebar_label: IdentityAssociationDetailsAssociationDetailsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAssociationDetailsAssociationDetailsInner', 'BetaIdentityAssociationDetailsAssociationDetailsInner'] +slug: /tools/sdk/powershell/beta/models/identity-association-details-association-details-inner +tags: ['SDK', 'Software Development Kit', 'IdentityAssociationDetailsAssociationDetailsInner', 'BetaIdentityAssociationDetailsAssociationDetailsInner'] +--- + + +# IdentityAssociationDetailsAssociationDetailsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AssociationType** | Pointer to **String** | association type with the identity | [optional] +**Entities** | Pointer to [**[]IdentityEntities**](identity-entities) | the specific resource this identity has ownership on | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAssociationDetailsAssociationDetailsInner = Initialize-PSSailpoint.BetaIdentityAssociationDetailsAssociationDetailsInner -AssociationType CAMPAIGN_OWNER ` + -Entities {id=b660a232f05b4e04812ca974b3011e0f, name=Gaston.800ddf9640a, type=CAMPAIGN_CAMPAIGNER} +``` + +- Convert the resource to JSON +```powershell +$IdentityAssociationDetailsAssociationDetailsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttribute.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttribute.md new file mode 100644 index 000000000..2a9041ad3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttribute.md @@ -0,0 +1,49 @@ +--- +id: beta-identity-attribute +title: IdentityAttribute +pagination_label: IdentityAttribute +sidebar_label: IdentityAttribute +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttribute', 'BetaIdentityAttribute'] +slug: /tools/sdk/powershell/beta/models/identity-attribute +tags: ['SDK', 'Software Development Kit', 'IdentityAttribute', 'BetaIdentityAttribute'] +--- + + +# IdentityAttribute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Identity attribute's technical name. | [required] +**DisplayName** | Pointer to **String** | Identity attribute's business-friendly name. | [optional] +**Standard** | Pointer to **Boolean** | Indicates whether the attribute is 'standard' or 'default'. | [optional] [default to $false] +**Type** | Pointer to **String** | Identity attribute's type. | [optional] +**Multi** | Pointer to **Boolean** | Indicates whether the identity attribute is multi-valued. | [optional] [default to $false] +**Searchable** | Pointer to **Boolean** | Indicates whether the identity attribute is searchable. | [optional] [default to $false] +**System** | Pointer to **Boolean** | Indicates whether the identity attribute is 'system', meaning that it doesn't have a source and isn't configurable. | [optional] [default to $false] +**Sources** | Pointer to [**[]Source1**](source1) | Identity attribute's list of sources - this specifies how the rule's value is derived. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAttribute = Initialize-PSSailpoint.BetaIdentityAttribute -Name costCenter ` + -DisplayName Cost Center ` + -Standard false ` + -Type string ` + -Multi false ` + -Searchable false ` + -System false ` + -Sources null +``` + +- Convert the resource to JSON +```powershell +$IdentityAttribute | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttribute1.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttribute1.md new file mode 100644 index 000000000..a591fdf06 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttribute1.md @@ -0,0 +1,39 @@ +--- +id: beta-identity-attribute1 +title: IdentityAttribute1 +pagination_label: IdentityAttribute1 +sidebar_label: IdentityAttribute1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttribute1', 'BetaIdentityAttribute1'] +slug: /tools/sdk/powershell/beta/models/identity-attribute1 +tags: ['SDK', 'Software Development Kit', 'IdentityAttribute1', 'BetaIdentityAttribute1'] +--- + + +# IdentityAttribute1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | The system (camel-cased) name of the identity attribute to bring in | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$IdentityAttribute1 = Initialize-PSSailpoint.BetaIdentityAttribute1 -Name email ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$IdentityAttribute1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributeConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributeConfig.md new file mode 100644 index 000000000..de36669da --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributeConfig.md @@ -0,0 +1,37 @@ +--- +id: beta-identity-attribute-config +title: IdentityAttributeConfig +pagination_label: IdentityAttributeConfig +sidebar_label: IdentityAttributeConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributeConfig', 'BetaIdentityAttributeConfig'] +slug: /tools/sdk/powershell/beta/models/identity-attribute-config +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig', 'BetaIdentityAttributeConfig'] +--- + + +# IdentityAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **Boolean** | If the profile or mapping is enabled | [optional] [default to $true] +**AttributeTransforms** | Pointer to [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributeConfig = Initialize-PSSailpoint.BetaIdentityAttributeConfig -Enabled true ` + -AttributeTransforms null +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributeConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributeConfig1.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributeConfig1.md new file mode 100644 index 000000000..666d569ab --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributeConfig1.md @@ -0,0 +1,37 @@ +--- +id: beta-identity-attribute-config1 +title: IdentityAttributeConfig1 +pagination_label: IdentityAttributeConfig1 +sidebar_label: IdentityAttributeConfig1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributeConfig1', 'BetaIdentityAttributeConfig1'] +slug: /tools/sdk/powershell/beta/models/identity-attribute-config1 +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig1', 'BetaIdentityAttributeConfig1'] +--- + + +# IdentityAttributeConfig1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **Boolean** | The backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false] +**AttributeTransforms** | Pointer to [**[]IdentityAttributeTransform1**](identity-attribute-transform1) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributeConfig1 = Initialize-PSSailpoint.BetaIdentityAttributeConfig1 -Enabled true ` + -AttributeTransforms null +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributeConfig1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributeNames.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributeNames.md new file mode 100644 index 000000000..89bf31304 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributeNames.md @@ -0,0 +1,35 @@ +--- +id: beta-identity-attribute-names +title: IdentityAttributeNames +pagination_label: IdentityAttributeNames +sidebar_label: IdentityAttributeNames +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributeNames', 'BetaIdentityAttributeNames'] +slug: /tools/sdk/powershell/beta/models/identity-attribute-names +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeNames', 'BetaIdentityAttributeNames'] +--- + + +# IdentityAttributeNames + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]String** | List of identity attributes' technical names. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributeNames = Initialize-PSSailpoint.BetaIdentityAttributeNames -Ids [name, displayName] +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributeNames | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributePreview.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributePreview.md new file mode 100644 index 000000000..f71be0a67 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributePreview.md @@ -0,0 +1,41 @@ +--- +id: beta-identity-attribute-preview +title: IdentityAttributePreview +pagination_label: IdentityAttributePreview +sidebar_label: IdentityAttributePreview +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributePreview', 'BetaIdentityAttributePreview'] +slug: /tools/sdk/powershell/beta/models/identity-attribute-preview +tags: ['SDK', 'Software Development Kit', 'IdentityAttributePreview', 'BetaIdentityAttributePreview'] +--- + + +# IdentityAttributePreview + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Name of the attribute that is being previewed. | [optional] +**Value** | Pointer to **String** | Value that was derived during the preview. | [optional] +**PreviousValue** | Pointer to **String** | The value of the attribute before the preview. | [optional] +**ErrorMessages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributePreview = Initialize-PSSailpoint.BetaIdentityAttributePreview -Name email ` + -Value email@mail.com ` + -PreviousValue oldEmail@mail.com ` + -ErrorMessages null +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributePreview | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributeTransform.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributeTransform.md new file mode 100644 index 000000000..46ae28741 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributeTransform.md @@ -0,0 +1,37 @@ +--- +id: beta-identity-attribute-transform +title: IdentityAttributeTransform +pagination_label: IdentityAttributeTransform +sidebar_label: IdentityAttributeTransform +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributeTransform', 'BetaIdentityAttributeTransform'] +slug: /tools/sdk/powershell/beta/models/identity-attribute-transform +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'BetaIdentityAttributeTransform'] +--- + + +# IdentityAttributeTransform + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityAttributeName** | Pointer to **String** | Name of the identity attribute | [optional] +**TransformDefinition** | Pointer to [**TransformDefinition**](transform-definition) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributeTransform = Initialize-PSSailpoint.BetaIdentityAttributeTransform -IdentityAttributeName email ` + -TransformDefinition null +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributeTransform | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributeTransform1.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributeTransform1.md new file mode 100644 index 000000000..167fd322d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributeTransform1.md @@ -0,0 +1,37 @@ +--- +id: beta-identity-attribute-transform1 +title: IdentityAttributeTransform1 +pagination_label: IdentityAttributeTransform1 +sidebar_label: IdentityAttributeTransform1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributeTransform1', 'BetaIdentityAttributeTransform1'] +slug: /tools/sdk/powershell/beta/models/identity-attribute-transform1 +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform1', 'BetaIdentityAttributeTransform1'] +--- + + +# IdentityAttributeTransform1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityAttributeName** | Pointer to **String** | Name of the identity attribute. | [optional] +**TransformDefinition** | Pointer to [**TransformDefinition1**](transform-definition1) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributeTransform1 = Initialize-PSSailpoint.BetaIdentityAttributeTransform1 -IdentityAttributeName email ` + -TransformDefinition null +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributeTransform1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributesChanged.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributesChanged.md new file mode 100644 index 000000000..6586a40d3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributesChanged.md @@ -0,0 +1,37 @@ +--- +id: beta-identity-attributes-changed +title: IdentityAttributesChanged +pagination_label: IdentityAttributesChanged +sidebar_label: IdentityAttributesChanged +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributesChanged', 'BetaIdentityAttributesChanged'] +slug: /tools/sdk/powershell/beta/models/identity-attributes-changed +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChanged', 'BetaIdentityAttributesChanged'] +--- + + +# IdentityAttributesChanged + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**IdentityAttributesChangedIdentity**](identity-attributes-changed-identity) | | [required] +**Changes** | [**[]IdentityAttributesChangedChangesInner**](identity-attributes-changed-changes-inner) | A list of one or more identity attributes that changed on the identity. | [required] + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributesChanged = Initialize-PSSailpoint.BetaIdentityAttributesChanged -Identity null ` + -Changes null +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributesChanged | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributesChangedChangesInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributesChangedChangesInner.md new file mode 100644 index 000000000..e6d91f50c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributesChangedChangesInner.md @@ -0,0 +1,39 @@ +--- +id: beta-identity-attributes-changed-changes-inner +title: IdentityAttributesChangedChangesInner +pagination_label: IdentityAttributesChangedChangesInner +sidebar_label: IdentityAttributesChangedChangesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributesChangedChangesInner', 'BetaIdentityAttributesChangedChangesInner'] +slug: /tools/sdk/powershell/beta/models/identity-attributes-changed-changes-inner +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInner', 'BetaIdentityAttributesChangedChangesInner'] +--- + + +# IdentityAttributesChangedChangesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attribute** | **String** | The name of the identity attribute that changed. | [required] +**OldValue** | Pointer to [**IdentityAttributesChangedChangesInnerOldValue**](identity-attributes-changed-changes-inner-old-value) | | [optional] +**NewValue** | Pointer to [**IdentityAttributesChangedChangesInnerNewValue**](identity-attributes-changed-changes-inner-new-value) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributesChangedChangesInner = Initialize-PSSailpoint.BetaIdentityAttributesChangedChangesInner -Attribute department ` + -OldValue null ` + -NewValue null +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributesChangedChangesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributesChangedChangesInnerNewValue.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributesChangedChangesInnerNewValue.md new file mode 100644 index 000000000..83fee173b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributesChangedChangesInnerNewValue.md @@ -0,0 +1,34 @@ +--- +id: beta-identity-attributes-changed-changes-inner-new-value +title: IdentityAttributesChangedChangesInnerNewValue +pagination_label: IdentityAttributesChangedChangesInnerNewValue +sidebar_label: IdentityAttributesChangedChangesInnerNewValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributesChangedChangesInnerNewValue', 'BetaIdentityAttributesChangedChangesInnerNewValue'] +slug: /tools/sdk/powershell/beta/models/identity-attributes-changed-changes-inner-new-value +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInnerNewValue', 'BetaIdentityAttributesChangedChangesInnerNewValue'] +--- + + +# IdentityAttributesChangedChangesInnerNewValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributesChangedChangesInnerNewValue = Initialize-PSSailpoint.BetaIdentityAttributesChangedChangesInnerNewValue +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributesChangedChangesInnerNewValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributesChangedChangesInnerOldValue.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributesChangedChangesInnerOldValue.md new file mode 100644 index 000000000..6d10e756b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributesChangedChangesInnerOldValue.md @@ -0,0 +1,34 @@ +--- +id: beta-identity-attributes-changed-changes-inner-old-value +title: IdentityAttributesChangedChangesInnerOldValue +pagination_label: IdentityAttributesChangedChangesInnerOldValue +sidebar_label: IdentityAttributesChangedChangesInnerOldValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributesChangedChangesInnerOldValue', 'BetaIdentityAttributesChangedChangesInnerOldValue'] +slug: /tools/sdk/powershell/beta/models/identity-attributes-changed-changes-inner-old-value +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInnerOldValue', 'BetaIdentityAttributesChangedChangesInnerOldValue'] +--- + + +# IdentityAttributesChangedChangesInnerOldValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributesChangedChangesInnerOldValue = Initialize-PSSailpoint.BetaIdentityAttributesChangedChangesInnerOldValue +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributesChangedChangesInnerOldValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributesChangedChangesInnerOldValueOneOfValue.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributesChangedChangesInnerOldValueOneOfValue.md new file mode 100644 index 000000000..6800c5e08 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributesChangedChangesInnerOldValueOneOfValue.md @@ -0,0 +1,34 @@ +--- +id: beta-identity-attributes-changed-changes-inner-old-value-one-of-value +title: IdentityAttributesChangedChangesInnerOldValueOneOfValue +pagination_label: IdentityAttributesChangedChangesInnerOldValueOneOfValue +sidebar_label: IdentityAttributesChangedChangesInnerOldValueOneOfValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributesChangedChangesInnerOldValueOneOfValue', 'BetaIdentityAttributesChangedChangesInnerOldValueOneOfValue'] +slug: /tools/sdk/powershell/beta/models/identity-attributes-changed-changes-inner-old-value-one-of-value +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInnerOldValueOneOfValue', 'BetaIdentityAttributesChangedChangesInnerOldValueOneOfValue'] +--- + + +# IdentityAttributesChangedChangesInnerOldValueOneOfValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributesChangedChangesInnerOldValueOneOfValue = Initialize-PSSailpoint.BetaIdentityAttributesChangedChangesInnerOldValueOneOfValue +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributesChangedChangesInnerOldValueOneOfValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributesChangedIdentity.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributesChangedIdentity.md new file mode 100644 index 000000000..2b95123f9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityAttributesChangedIdentity.md @@ -0,0 +1,39 @@ +--- +id: beta-identity-attributes-changed-identity +title: IdentityAttributesChangedIdentity +pagination_label: IdentityAttributesChangedIdentity +sidebar_label: IdentityAttributesChangedIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributesChangedIdentity', 'BetaIdentityAttributesChangedIdentity'] +slug: /tools/sdk/powershell/beta/models/identity-attributes-changed-identity +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedIdentity', 'BetaIdentityAttributesChangedIdentity'] +--- + + +# IdentityAttributesChangedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | DTO type of identity whose attributes changed. | [required] +**Id** | **String** | ID of identity whose attributes changed. | [required] +**Name** | **String** | Display name of identity whose attributes changed. | [required] + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributesChangedIdentity = Initialize-PSSailpoint.BetaIdentityAttributesChangedIdentity -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributesChangedIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityCertificationTask.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityCertificationTask.md new file mode 100644 index 000000000..69c8f2043 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityCertificationTask.md @@ -0,0 +1,43 @@ +--- +id: beta-identity-certification-task +title: IdentityCertificationTask +pagination_label: IdentityCertificationTask +sidebar_label: IdentityCertificationTask +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityCertificationTask', 'BetaIdentityCertificationTask'] +slug: /tools/sdk/powershell/beta/models/identity-certification-task +tags: ['SDK', 'Software Development Kit', 'IdentityCertificationTask', 'BetaIdentityCertificationTask'] +--- + + +# IdentityCertificationTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The task id | [optional] +**CertificationId** | Pointer to **String** | The certification id | [optional] +**Type** | Pointer to **Enum** [ "REASSIGN" ] | | [optional] +**Status** | Pointer to **Enum** [ "QUEUED", "IN_PROGRESS", "SUCCESS", "ERROR" ] | | [optional] +**Errors** | Pointer to **[]String** | Any errors executing the task (Optional). | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityCertificationTask = Initialize-PSSailpoint.BetaIdentityCertificationTask -Id abcd-ef12-3456 ` + -CertificationId ef38f94347e94562b5bb8424a56397d8 ` + -Type null ` + -Status null ` + -Errors [] +``` + +- Convert the resource to JSON +```powershell +$IdentityCertificationTask | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityCertified.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityCertified.md new file mode 100644 index 000000000..7940231e0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityCertified.md @@ -0,0 +1,49 @@ +--- +id: beta-identity-certified +title: IdentityCertified +pagination_label: IdentityCertified +sidebar_label: IdentityCertified +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityCertified', 'BetaIdentityCertified'] +slug: /tools/sdk/powershell/beta/models/identity-certified +tags: ['SDK', 'Software Development Kit', 'IdentityCertified', 'BetaIdentityCertified'] +--- + + +# IdentityCertified + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CertificationId** | Pointer to **String** | the id of the certification item | [optional] +**CertificationName** | Pointer to **String** | the certification item name | [optional] +**SignedDate** | Pointer to **String** | the date ceritification was signed | [optional] +**Certifiers** | Pointer to [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [optional] +**Reviewers** | Pointer to [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional] +**Signer** | Pointer to [**CertifierResponse**](certifier-response) | | [optional] +**EventType** | Pointer to **String** | the event type | [optional] +**Dt** | Pointer to **String** | the date of event | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityCertified = Initialize-PSSailpoint.BetaIdentityCertified -CertificationId 2c91808a77ff216301782327a50f09bf ` + -CertificationName Cert name ` + -SignedDate 2019-03-08T22:37:33.901Z ` + -Certifiers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` + -Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` + -Signer null ` + -EventType IdentityCertified ` + -Dt 2019-03-08T22:37:33.901Z +``` + +- Convert the resource to JSON +```powershell +$IdentityCertified | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityCompareResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityCompareResponse.md new file mode 100644 index 000000000..490e81de8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityCompareResponse.md @@ -0,0 +1,35 @@ +--- +id: beta-identity-compare-response +title: IdentityCompareResponse +pagination_label: IdentityCompareResponse +sidebar_label: IdentityCompareResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityCompareResponse', 'BetaIdentityCompareResponse'] +slug: /tools/sdk/powershell/beta/models/identity-compare-response +tags: ['SDK', 'Software Development Kit', 'IdentityCompareResponse', 'BetaIdentityCompareResponse'] +--- + + +# IdentityCompareResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessItemDiff** | Pointer to [**map[string]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityCompareResponse = Initialize-PSSailpoint.BetaIdentityCompareResponse -AccessItemDiff null +``` + +- Convert the resource to JSON +```powershell +$IdentityCompareResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityCreated.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityCreated.md new file mode 100644 index 000000000..aebd13619 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityCreated.md @@ -0,0 +1,37 @@ +--- +id: beta-identity-created +title: IdentityCreated +pagination_label: IdentityCreated +sidebar_label: IdentityCreated +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityCreated', 'BetaIdentityCreated'] +slug: /tools/sdk/powershell/beta/models/identity-created +tags: ['SDK', 'Software Development Kit', 'IdentityCreated', 'BetaIdentityCreated'] +--- + + +# IdentityCreated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**IdentityCreatedIdentity**](identity-created-identity) | | [required] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes assigned to the identity. Attributes are determined by the identity profile. | [required] + +## Examples + +- Prepare the resource +```powershell +$IdentityCreated = Initialize-PSSailpoint.BetaIdentityCreated -Identity null ` + -Attributes {firstname=John} +``` + +- Convert the resource to JSON +```powershell +$IdentityCreated | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityCreatedIdentity.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityCreatedIdentity.md new file mode 100644 index 000000000..0cd7d0c9d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityCreatedIdentity.md @@ -0,0 +1,39 @@ +--- +id: beta-identity-created-identity +title: IdentityCreatedIdentity +pagination_label: IdentityCreatedIdentity +sidebar_label: IdentityCreatedIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityCreatedIdentity', 'BetaIdentityCreatedIdentity'] +slug: /tools/sdk/powershell/beta/models/identity-created-identity +tags: ['SDK', 'Software Development Kit', 'IdentityCreatedIdentity', 'BetaIdentityCreatedIdentity'] +--- + + +# IdentityCreatedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | Created identity's DTO type. | [required] +**Id** | **String** | Created identity ID. | [required] +**Name** | **String** | Created identity's display name. | [required] + +## Examples + +- Prepare the resource +```powershell +$IdentityCreatedIdentity = Initialize-PSSailpoint.BetaIdentityCreatedIdentity -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$IdentityCreatedIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityDeleted.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityDeleted.md new file mode 100644 index 000000000..80b6a6f46 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityDeleted.md @@ -0,0 +1,37 @@ +--- +id: beta-identity-deleted +title: IdentityDeleted +pagination_label: IdentityDeleted +sidebar_label: IdentityDeleted +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityDeleted', 'BetaIdentityDeleted'] +slug: /tools/sdk/powershell/beta/models/identity-deleted +tags: ['SDK', 'Software Development Kit', 'IdentityDeleted', 'BetaIdentityDeleted'] +--- + + +# IdentityDeleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**IdentityDeletedIdentity**](identity-deleted-identity) | | [required] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes assigned to the identity. Attributes are determined by the identity profile. | [required] + +## Examples + +- Prepare the resource +```powershell +$IdentityDeleted = Initialize-PSSailpoint.BetaIdentityDeleted -Identity null ` + -Attributes {firstname=John} +``` + +- Convert the resource to JSON +```powershell +$IdentityDeleted | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityDeletedIdentity.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityDeletedIdentity.md new file mode 100644 index 000000000..a3624f52c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityDeletedIdentity.md @@ -0,0 +1,39 @@ +--- +id: beta-identity-deleted-identity +title: IdentityDeletedIdentity +pagination_label: IdentityDeletedIdentity +sidebar_label: IdentityDeletedIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityDeletedIdentity', 'BetaIdentityDeletedIdentity'] +slug: /tools/sdk/powershell/beta/models/identity-deleted-identity +tags: ['SDK', 'Software Development Kit', 'IdentityDeletedIdentity', 'BetaIdentityDeletedIdentity'] +--- + + +# IdentityDeletedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | Deleted identity's DTO type. | [required] +**Id** | **String** | Deleted identity ID. | [required] +**Name** | **String** | Deleted identity's display name. | [required] + +## Examples + +- Prepare the resource +```powershell +$IdentityDeletedIdentity = Initialize-PSSailpoint.BetaIdentityDeletedIdentity -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$IdentityDeletedIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityEntities.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityEntities.md new file mode 100644 index 000000000..eeb1b22ff --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityEntities.md @@ -0,0 +1,35 @@ +--- +id: beta-identity-entities +title: IdentityEntities +pagination_label: IdentityEntities +sidebar_label: IdentityEntities +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityEntities', 'BetaIdentityEntities'] +slug: /tools/sdk/powershell/beta/models/identity-entities +tags: ['SDK', 'Software Development Kit', 'IdentityEntities', 'BetaIdentityEntities'] +--- + + +# IdentityEntities + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityEntity** | Pointer to [**IdentityEntitiesIdentityEntity**](identity-entities-identity-entity) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityEntities = Initialize-PSSailpoint.BetaIdentityEntities -IdentityEntity null +``` + +- Convert the resource to JSON +```powershell +$IdentityEntities | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityEntitiesIdentityEntity.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityEntitiesIdentityEntity.md new file mode 100644 index 000000000..9d95403f3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityEntitiesIdentityEntity.md @@ -0,0 +1,39 @@ +--- +id: beta-identity-entities-identity-entity +title: IdentityEntitiesIdentityEntity +pagination_label: IdentityEntitiesIdentityEntity +sidebar_label: IdentityEntitiesIdentityEntity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityEntitiesIdentityEntity', 'BetaIdentityEntitiesIdentityEntity'] +slug: /tools/sdk/powershell/beta/models/identity-entities-identity-entity +tags: ['SDK', 'Software Development Kit', 'IdentityEntitiesIdentityEntity', 'BetaIdentityEntitiesIdentityEntity'] +--- + + +# IdentityEntitiesIdentityEntity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | id of the resource to which the identity is associated | [optional] +**Name** | Pointer to **String** | name of the resource to which the identity is associated | [optional] +**Type** | Pointer to **String** | type of the resource to which the identity is associated | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityEntitiesIdentityEntity = Initialize-PSSailpoint.BetaIdentityEntitiesIdentityEntity -Id 031034e97f094a4096c1be53f75f6b91 ` + -Name Gaston.800ddf9640a ` + -Type CAMPAIGN_CAMPAIGNER +``` + +- Convert the resource to JSON +```powershell +$IdentityEntitiesIdentityEntity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityExceptionReportReference.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityExceptionReportReference.md new file mode 100644 index 000000000..ef6b6edf4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityExceptionReportReference.md @@ -0,0 +1,37 @@ +--- +id: beta-identity-exception-report-reference +title: IdentityExceptionReportReference +pagination_label: IdentityExceptionReportReference +sidebar_label: IdentityExceptionReportReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityExceptionReportReference', 'BetaIdentityExceptionReportReference'] +slug: /tools/sdk/powershell/beta/models/identity-exception-report-reference +tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'BetaIdentityExceptionReportReference'] +--- + + +# IdentityExceptionReportReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TaskResultId** | Pointer to **String** | The id of the task result | [optional] +**ReportName** | Pointer to **String** | The name of the report | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityExceptionReportReference = Initialize-PSSailpoint.BetaIdentityExceptionReportReference -TaskResultId null ` + -ReportName My annual report +``` + +- Convert the resource to JSON +```powershell +$IdentityExceptionReportReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityExceptionReportReference1.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityExceptionReportReference1.md new file mode 100644 index 000000000..a8124f914 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityExceptionReportReference1.md @@ -0,0 +1,37 @@ +--- +id: beta-identity-exception-report-reference1 +title: IdentityExceptionReportReference1 +pagination_label: IdentityExceptionReportReference1 +sidebar_label: IdentityExceptionReportReference1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityExceptionReportReference1', 'BetaIdentityExceptionReportReference1'] +slug: /tools/sdk/powershell/beta/models/identity-exception-report-reference1 +tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference1', 'BetaIdentityExceptionReportReference1'] +--- + + +# IdentityExceptionReportReference1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TaskResultId** | Pointer to **String** | The id of the task result. | [optional] +**ReportName** | Pointer to **String** | The name of the report. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityExceptionReportReference1 = Initialize-PSSailpoint.BetaIdentityExceptionReportReference1 -TaskResultId 2b838de9-db9b-abcf-e646-d4f274ad4238 ` + -ReportName My annual report +``` + +- Convert the resource to JSON +```powershell +$IdentityExceptionReportReference1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityHistoryResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityHistoryResponse.md new file mode 100644 index 000000000..fb95118cd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityHistoryResponse.md @@ -0,0 +1,45 @@ +--- +id: beta-identity-history-response +title: IdentityHistoryResponse +pagination_label: IdentityHistoryResponse +sidebar_label: IdentityHistoryResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityHistoryResponse', 'BetaIdentityHistoryResponse'] +slug: /tools/sdk/powershell/beta/models/identity-history-response +tags: ['SDK', 'Software Development Kit', 'IdentityHistoryResponse', 'BetaIdentityHistoryResponse'] +--- + + +# IdentityHistoryResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | the identity ID | [optional] +**DisplayName** | Pointer to **String** | the display name of the identity | [optional] +**Snapshot** | Pointer to **String** | the date when the identity record was created | [optional] +**DeletedDate** | Pointer to **String** | the date when the identity was deleted | [optional] +**AccessItemCount** | Pointer to **map[string]Int32** | A map containing the count of each access item | [optional] +**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map containing the identity attributes | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityHistoryResponse = Initialize-PSSailpoint.BetaIdentityHistoryResponse -Id bc693f07e7b645539626c25954c58554 ` + -DisplayName Adam Zampa ` + -Snapshot 2007-03-01T13:00:00.000Z ` + -DeletedDate 2007-03-01T13:00:00.000Z ` + -AccessItemCount {app=0, role=2, entitlement=4, accessProfile=3, account=1} ` + -Attributes {jobTitle=HR Manager, location=NYC, firstname=Adam, lastname=Zampa, department=HR} +``` + +- Convert the resource to JSON +```powershell +$IdentityHistoryResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityLifecycleState.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityLifecycleState.md new file mode 100644 index 000000000..8efb5f605 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityLifecycleState.md @@ -0,0 +1,37 @@ +--- +id: beta-identity-lifecycle-state +title: IdentityLifecycleState +pagination_label: IdentityLifecycleState +sidebar_label: IdentityLifecycleState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityLifecycleState', 'BetaIdentityLifecycleState'] +slug: /tools/sdk/powershell/beta/models/identity-lifecycle-state +tags: ['SDK', 'Software Development Kit', 'IdentityLifecycleState', 'BetaIdentityLifecycleState'] +--- + + +# IdentityLifecycleState + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**StateName** | **String** | The name of the lifecycle state | [required] +**ManuallyUpdated** | **Boolean** | Whether the lifecycle state has been manually or automatically set | [required] + +## Examples + +- Prepare the resource +```powershell +$IdentityLifecycleState = Initialize-PSSailpoint.BetaIdentityLifecycleState -StateName active ` + -ManuallyUpdated true +``` + +- Convert the resource to JSON +```powershell +$IdentityLifecycleState | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityListItem.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityListItem.md new file mode 100644 index 000000000..f22e39b87 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityListItem.md @@ -0,0 +1,45 @@ +--- +id: beta-identity-list-item +title: IdentityListItem +pagination_label: IdentityListItem +sidebar_label: IdentityListItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityListItem', 'BetaIdentityListItem'] +slug: /tools/sdk/powershell/beta/models/identity-list-item +tags: ['SDK', 'Software Development Kit', 'IdentityListItem', 'BetaIdentityListItem'] +--- + + +# IdentityListItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | the identity ID | [optional] +**DisplayName** | Pointer to **String** | the display name of the identity | [optional] +**FirstName** | Pointer to **String** | the first name of the identity | [optional] +**LastName** | Pointer to **String** | the last name of the identity | [optional] +**Active** | Pointer to **Boolean** | indicates if an identity is active or not | [optional] [default to $true] +**DeletedDate** | Pointer to **String** | the date when the identity was deleted | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityListItem = Initialize-PSSailpoint.BetaIdentityListItem -Id bc693f07e7b645539626c25954c58554 ` + -DisplayName Adam Zampa ` + -FirstName Adam ` + -LastName Zampa ` + -Active true ` + -DeletedDate 2007-03-01T13:00:00.000Z +``` + +- Convert the resource to JSON +```powershell +$IdentityListItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityManagerRef.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityManagerRef.md new file mode 100644 index 000000000..c2f35988a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityManagerRef.md @@ -0,0 +1,39 @@ +--- +id: beta-identity-manager-ref +title: IdentityManagerRef +pagination_label: IdentityManagerRef +sidebar_label: IdentityManagerRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityManagerRef', 'BetaIdentityManagerRef'] +slug: /tools/sdk/powershell/beta/models/identity-manager-ref +tags: ['SDK', 'Software Development Kit', 'IdentityManagerRef', 'BetaIdentityManagerRef'] +--- + + +# IdentityManagerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | DTO type of identity's manager | [optional] +**Id** | Pointer to **String** | ID of identity's manager | [optional] +**Name** | Pointer to **String** | Human-readable display name of identity's manager | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityManagerRef = Initialize-PSSailpoint.BetaIdentityManagerRef -Type IDENTITY ` + -Id 2c4180a46faadee4016fb4e018c20626 ` + -Name Robert Robinson +``` + +- Convert the resource to JSON +```powershell +$IdentityManagerRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityOwnershipAssociationDetails.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityOwnershipAssociationDetails.md new file mode 100644 index 000000000..6ffae2503 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityOwnershipAssociationDetails.md @@ -0,0 +1,35 @@ +--- +id: beta-identity-ownership-association-details +title: IdentityOwnershipAssociationDetails +pagination_label: IdentityOwnershipAssociationDetails +sidebar_label: IdentityOwnershipAssociationDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityOwnershipAssociationDetails', 'BetaIdentityOwnershipAssociationDetails'] +slug: /tools/sdk/powershell/beta/models/identity-ownership-association-details +tags: ['SDK', 'Software Development Kit', 'IdentityOwnershipAssociationDetails', 'BetaIdentityOwnershipAssociationDetails'] +--- + + +# IdentityOwnershipAssociationDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AssociationDetails** | Pointer to [**[]IdentityOwnershipAssociationDetailsAssociationDetailsInner**](identity-ownership-association-details-association-details-inner) | list of all the resource associations for the identity | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityOwnershipAssociationDetails = Initialize-PSSailpoint.BetaIdentityOwnershipAssociationDetails -AssociationDetails null +``` + +- Convert the resource to JSON +```powershell +$IdentityOwnershipAssociationDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md new file mode 100644 index 000000000..355aeb1e9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md @@ -0,0 +1,37 @@ +--- +id: beta-identity-ownership-association-details-association-details-inner +title: IdentityOwnershipAssociationDetailsAssociationDetailsInner +pagination_label: IdentityOwnershipAssociationDetailsAssociationDetailsInner +sidebar_label: IdentityOwnershipAssociationDetailsAssociationDetailsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityOwnershipAssociationDetailsAssociationDetailsInner', 'BetaIdentityOwnershipAssociationDetailsAssociationDetailsInner'] +slug: /tools/sdk/powershell/beta/models/identity-ownership-association-details-association-details-inner +tags: ['SDK', 'Software Development Kit', 'IdentityOwnershipAssociationDetailsAssociationDetailsInner', 'BetaIdentityOwnershipAssociationDetailsAssociationDetailsInner'] +--- + + +# IdentityOwnershipAssociationDetailsAssociationDetailsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AssociationType** | Pointer to **String** | association type with the identity | [optional] +**Entities** | Pointer to [**[]IdentityEntities**](identity-entities) | the specific resource this identity has ownership on | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityOwnershipAssociationDetailsAssociationDetailsInner = Initialize-PSSailpoint.BetaIdentityOwnershipAssociationDetailsAssociationDetailsInner -AssociationType ROLE_OWNER ` + -Entities {id=b660a232f05b4e04812ca974b3011e0f, name=Gaston.800ddf9640a, type=ROLE} +``` + +- Convert the resource to JSON +```powershell +$IdentityOwnershipAssociationDetailsAssociationDetailsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityPreviewRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityPreviewRequest.md new file mode 100644 index 000000000..33fe21637 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityPreviewRequest.md @@ -0,0 +1,37 @@ +--- +id: beta-identity-preview-request +title: IdentityPreviewRequest +pagination_label: IdentityPreviewRequest +sidebar_label: IdentityPreviewRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityPreviewRequest', 'BetaIdentityPreviewRequest'] +slug: /tools/sdk/powershell/beta/models/identity-preview-request +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewRequest', 'BetaIdentityPreviewRequest'] +--- + + +# IdentityPreviewRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **String** | | [optional] +**IdentityAttributeConfig** | Pointer to [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityPreviewRequest = Initialize-PSSailpoint.BetaIdentityPreviewRequest -IdentityId null ` + -IdentityAttributeConfig null +``` + +- Convert the resource to JSON +```powershell +$IdentityPreviewRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityPreviewResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityPreviewResponse.md new file mode 100644 index 000000000..e042a13c7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityPreviewResponse.md @@ -0,0 +1,37 @@ +--- +id: beta-identity-preview-response +title: IdentityPreviewResponse +pagination_label: IdentityPreviewResponse +sidebar_label: IdentityPreviewResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityPreviewResponse', 'BetaIdentityPreviewResponse'] +slug: /tools/sdk/powershell/beta/models/identity-preview-response +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewResponse', 'BetaIdentityPreviewResponse'] +--- + + +# IdentityPreviewResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to [**IdentityPreviewResponseIdentity**](identity-preview-response-identity) | | [optional] +**PreviewAttributes** | Pointer to [**[]IdentityAttributePreview**](identity-attribute-preview) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityPreviewResponse = Initialize-PSSailpoint.BetaIdentityPreviewResponse -Identity null ` + -PreviewAttributes null +``` + +- Convert the resource to JSON +```powershell +$IdentityPreviewResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityPreviewResponseIdentity.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityPreviewResponseIdentity.md new file mode 100644 index 000000000..918836c0e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityPreviewResponseIdentity.md @@ -0,0 +1,39 @@ +--- +id: beta-identity-preview-response-identity +title: IdentityPreviewResponseIdentity +pagination_label: IdentityPreviewResponseIdentity +sidebar_label: IdentityPreviewResponseIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityPreviewResponseIdentity', 'BetaIdentityPreviewResponseIdentity'] +slug: /tools/sdk/powershell/beta/models/identity-preview-response-identity +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewResponseIdentity', 'BetaIdentityPreviewResponseIdentity'] +--- + + +# IdentityPreviewResponseIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | DTO type of identity's manager. | [optional] +**Id** | Pointer to **String** | ID of identity's manager. | [optional] +**Name** | Pointer to **String** | Human-readable display name of identity's manager. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityPreviewResponseIdentity = Initialize-PSSailpoint.BetaIdentityPreviewResponseIdentity -Type IDENTITY ` + -Id 2c4180a46faadee4016fb4e018c20626 ` + -Name Robert Robinson +``` + +- Convert the resource to JSON +```powershell +$IdentityPreviewResponseIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityProfile.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityProfile.md new file mode 100644 index 000000000..19c4d4184 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityProfile.md @@ -0,0 +1,59 @@ +--- +id: beta-identity-profile +title: IdentityProfile +pagination_label: IdentityProfile +sidebar_label: IdentityProfile +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfile', 'BetaIdentityProfile'] +slug: /tools/sdk/powershell/beta/models/identity-profile +tags: ['SDK', 'Software Development Kit', 'IdentityProfile', 'BetaIdentityProfile'] +--- + + +# IdentityProfile + +## Properties + +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] +**Description** | Pointer to **String** | The description of the Identity Profile. | [optional] +**Owner** | Pointer to [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] +**Priority** | Pointer to **Int64** | The priority for an Identity Profile. | [optional] +**AuthoritativeSource** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | [required] +**IdentityRefreshRequired** | Pointer to **Boolean** | True if a identity refresh is needed. Typically triggered when a change on the source has been made | [optional] [default to $false] +**IdentityCount** | Pointer to **Int32** | The number of identities that belong to the Identity Profile. | [optional] +**IdentityAttributeConfig** | Pointer to [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] +**IdentityExceptionReportReference** | Pointer to [**IdentityExceptionReportReference**](identity-exception-report-reference) | | [optional] +**HasTimeBasedAttr** | Pointer to **Boolean** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to $true] + +## Examples + +- Prepare the resource +```powershell +$IdentityProfile = Initialize-PSSailpoint.BetaIdentityProfile -Id id12345 ` + -Name aName ` + -Created 2023-01-03T21:16:22.432Z ` + -Modified 2023-01-03T21:16:22.432Z ` + -Description My custom flat file profile ` + -Owner null ` + -Priority 10 ` + -AuthoritativeSource null ` + -IdentityRefreshRequired true ` + -IdentityCount 8 ` + -IdentityAttributeConfig null ` + -IdentityExceptionReportReference null ` + -HasTimeBasedAttr true +``` + +- Convert the resource to JSON +```powershell +$IdentityProfile | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityProfile1.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityProfile1.md new file mode 100644 index 000000000..97f2e295a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityProfile1.md @@ -0,0 +1,59 @@ +--- +id: beta-identity-profile1 +title: IdentityProfile1 +pagination_label: IdentityProfile1 +sidebar_label: IdentityProfile1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfile1', 'BetaIdentityProfile1'] +slug: /tools/sdk/powershell/beta/models/identity-profile1 +tags: ['SDK', 'Software Development Kit', 'IdentityProfile1', 'BetaIdentityProfile1'] +--- + + +# IdentityProfile1 + +## Properties + +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] +**Description** | Pointer to **String** | The description of the Identity Profile. | [optional] +**Owner** | Pointer to [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] +**Priority** | Pointer to **Int64** | The priority for an Identity Profile. | [optional] +**AuthoritativeSource** | [**IdentityProfile1AllOfAuthoritativeSource**](identity-profile1-all-of-authoritative-source) | | [required] +**IdentityRefreshRequired** | Pointer to **Boolean** | True if a identity refresh is needed. Typically triggered when a change on the source has been made. | [optional] [default to $false] +**IdentityCount** | Pointer to **Int32** | The number of identities that belong to the Identity Profile. | [optional] +**IdentityAttributeConfig** | Pointer to [**IdentityAttributeConfig1**](identity-attribute-config1) | | [optional] +**IdentityExceptionReportReference** | Pointer to [**IdentityExceptionReportReference1**](identity-exception-report-reference1) | | [optional] +**HasTimeBasedAttr** | Pointer to **Boolean** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$IdentityProfile1 = Initialize-PSSailpoint.BetaIdentityProfile1 -Id id12345 ` + -Name aName ` + -Created 2015-05-28T14:07:17Z ` + -Modified 2015-05-28T14:07:17Z ` + -Description My custom flat file profile ` + -Owner null ` + -Priority 10 ` + -AuthoritativeSource null ` + -IdentityRefreshRequired true ` + -IdentityCount 8 ` + -IdentityAttributeConfig null ` + -IdentityExceptionReportReference null ` + -HasTimeBasedAttr true +``` + +- Convert the resource to JSON +```powershell +$IdentityProfile1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityProfile1AllOfAuthoritativeSource.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityProfile1AllOfAuthoritativeSource.md new file mode 100644 index 000000000..b54c8964d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityProfile1AllOfAuthoritativeSource.md @@ -0,0 +1,39 @@ +--- +id: beta-identity-profile1-all-of-authoritative-source +title: IdentityProfile1AllOfAuthoritativeSource +pagination_label: IdentityProfile1AllOfAuthoritativeSource +sidebar_label: IdentityProfile1AllOfAuthoritativeSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfile1AllOfAuthoritativeSource', 'BetaIdentityProfile1AllOfAuthoritativeSource'] +slug: /tools/sdk/powershell/beta/models/identity-profile1-all-of-authoritative-source +tags: ['SDK', 'Software Development Kit', 'IdentityProfile1AllOfAuthoritativeSource', 'BetaIdentityProfile1AllOfAuthoritativeSource'] +--- + + +# IdentityProfile1AllOfAuthoritativeSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "SOURCE" ] | Type of the object to which this reference applies | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityProfile1AllOfAuthoritativeSource = Initialize-PSSailpoint.BetaIdentityProfile1AllOfAuthoritativeSource -Type SOURCE ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name HR Active Directory +``` + +- Convert the resource to JSON +```powershell +$IdentityProfile1AllOfAuthoritativeSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityProfileAllOfAuthoritativeSource.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityProfileAllOfAuthoritativeSource.md new file mode 100644 index 000000000..17743cee6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityProfileAllOfAuthoritativeSource.md @@ -0,0 +1,39 @@ +--- +id: beta-identity-profile-all-of-authoritative-source +title: IdentityProfileAllOfAuthoritativeSource +pagination_label: IdentityProfileAllOfAuthoritativeSource +sidebar_label: IdentityProfileAllOfAuthoritativeSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfileAllOfAuthoritativeSource', 'BetaIdentityProfileAllOfAuthoritativeSource'] +slug: /tools/sdk/powershell/beta/models/identity-profile-all-of-authoritative-source +tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSource', 'BetaIdentityProfileAllOfAuthoritativeSource'] +--- + + +# IdentityProfileAllOfAuthoritativeSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "SOURCE" ] | Type of the object to which this reference applies | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityProfileAllOfAuthoritativeSource = Initialize-PSSailpoint.BetaIdentityProfileAllOfAuthoritativeSource -Type SOURCE ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name HR Active Directory +``` + +- Convert the resource to JSON +```powershell +$IdentityProfileAllOfAuthoritativeSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityProfileAllOfOwner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityProfileAllOfOwner.md new file mode 100644 index 000000000..a4854fe36 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityProfileAllOfOwner.md @@ -0,0 +1,39 @@ +--- +id: beta-identity-profile-all-of-owner +title: IdentityProfileAllOfOwner +pagination_label: IdentityProfileAllOfOwner +sidebar_label: IdentityProfileAllOfOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfileAllOfOwner', 'BetaIdentityProfileAllOfOwner'] +slug: /tools/sdk/powershell/beta/models/identity-profile-all-of-owner +tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'BetaIdentityProfileAllOfOwner'] +--- + + +# IdentityProfileAllOfOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Type of the object to which this reference applies | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityProfileAllOfOwner = Initialize-PSSailpoint.BetaIdentityProfileAllOfOwner -Type IDENTITY ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$IdentityProfileAllOfOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityProfileExportedObject.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityProfileExportedObject.md new file mode 100644 index 000000000..744971959 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityProfileExportedObject.md @@ -0,0 +1,39 @@ +--- +id: beta-identity-profile-exported-object +title: IdentityProfileExportedObject +pagination_label: IdentityProfileExportedObject +sidebar_label: IdentityProfileExportedObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfileExportedObject', 'BetaIdentityProfileExportedObject'] +slug: /tools/sdk/powershell/beta/models/identity-profile-exported-object +tags: ['SDK', 'Software Development Kit', 'IdentityProfileExportedObject', 'BetaIdentityProfileExportedObject'] +--- + + +# IdentityProfileExportedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | Pointer to **Int32** | Version or object from the target service. | [optional] +**Self** | Pointer to [**SelfImportExportDto**](self-import-export-dto) | | [optional] +**Object** | Pointer to [**IdentityProfile1**](identity-profile1) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityProfileExportedObject = Initialize-PSSailpoint.BetaIdentityProfileExportedObject -Version 1 ` + -Self null ` + -Object null +``` + +- Convert the resource to JSON +```powershell +$IdentityProfileExportedObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityReference.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityReference.md new file mode 100644 index 000000000..93ff35069 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityReference.md @@ -0,0 +1,39 @@ +--- +id: beta-identity-reference +title: IdentityReference +pagination_label: IdentityReference +sidebar_label: IdentityReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityReference', 'BetaIdentityReference'] +slug: /tools/sdk/powershell/beta/models/identity-reference +tags: ['SDK', 'Software Development Kit', 'IdentityReference', 'BetaIdentityReference'] +--- + + +# IdentityReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **String** | Identity id | [optional] +**Name** | Pointer to **String** | Human-readable display name of identity. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityReference = Initialize-PSSailpoint.BetaIdentityReference -Type null ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Thomas Edison +``` + +- Convert the resource to JSON +```powershell +$IdentityReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityReferenceWithId.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityReferenceWithId.md new file mode 100644 index 000000000..87f00080c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityReferenceWithId.md @@ -0,0 +1,37 @@ +--- +id: beta-identity-reference-with-id +title: IdentityReferenceWithId +pagination_label: IdentityReferenceWithId +sidebar_label: IdentityReferenceWithId +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityReferenceWithId', 'BetaIdentityReferenceWithId'] +slug: /tools/sdk/powershell/beta/models/identity-reference-with-id +tags: ['SDK', 'Software Development Kit', 'IdentityReferenceWithId', 'BetaIdentityReferenceWithId'] +--- + + +# IdentityReferenceWithId + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **String** | Identity id | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityReferenceWithId = Initialize-PSSailpoint.BetaIdentityReferenceWithId -Type null ` + -Id 5168015d32f890ca15812c9180835d2e +``` + +- Convert the resource to JSON +```powershell +$IdentityReferenceWithId | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityReferenceWithNameAndEmail.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityReferenceWithNameAndEmail.md new file mode 100644 index 000000000..0aa72be9c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityReferenceWithNameAndEmail.md @@ -0,0 +1,41 @@ +--- +id: beta-identity-reference-with-name-and-email +title: IdentityReferenceWithNameAndEmail +pagination_label: IdentityReferenceWithNameAndEmail +sidebar_label: IdentityReferenceWithNameAndEmail +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityReferenceWithNameAndEmail', 'BetaIdentityReferenceWithNameAndEmail'] +slug: /tools/sdk/powershell/beta/models/identity-reference-with-name-and-email +tags: ['SDK', 'Software Development Kit', 'IdentityReferenceWithNameAndEmail', 'BetaIdentityReferenceWithNameAndEmail'] +--- + + +# IdentityReferenceWithNameAndEmail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **String** | The type can only be IDENTITY. This is read-only. | [optional] +**Id** | Pointer to **String** | Identity ID. | [optional] +**Name** | Pointer to **String** | Identity's human-readable display name. This is read-only. | [optional] +**Email** | Pointer to **String** | Identity's email address. This is read-only. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityReferenceWithNameAndEmail = Initialize-PSSailpoint.BetaIdentityReferenceWithNameAndEmail -Type IDENTITY ` + -Id 5168015d32f890ca15812c9180835d2e ` + -Name Alison Ferguso ` + -Email alison.ferguso@identitysoon.com +``` + +- Convert the resource to JSON +```powershell +$IdentityReferenceWithNameAndEmail | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentitySnapshotSummaryResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentitySnapshotSummaryResponse.md new file mode 100644 index 000000000..692ffca37 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentitySnapshotSummaryResponse.md @@ -0,0 +1,35 @@ +--- +id: beta-identity-snapshot-summary-response +title: IdentitySnapshotSummaryResponse +pagination_label: IdentitySnapshotSummaryResponse +sidebar_label: IdentitySnapshotSummaryResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentitySnapshotSummaryResponse', 'BetaIdentitySnapshotSummaryResponse'] +slug: /tools/sdk/powershell/beta/models/identity-snapshot-summary-response +tags: ['SDK', 'Software Development Kit', 'IdentitySnapshotSummaryResponse', 'BetaIdentitySnapshotSummaryResponse'] +--- + + +# IdentitySnapshotSummaryResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Snapshot** | Pointer to **String** | the date when the identity record was created | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentitySnapshotSummaryResponse = Initialize-PSSailpoint.BetaIdentitySnapshotSummaryResponse -Snapshot 2007-03-01T13:00:00.000Z +``` + +- Convert the resource to JSON +```powershell +$IdentitySnapshotSummaryResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentitySummary.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentitySummary.md new file mode 100644 index 000000000..83b1d780e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentitySummary.md @@ -0,0 +1,41 @@ +--- +id: beta-identity-summary +title: IdentitySummary +pagination_label: IdentitySummary +sidebar_label: IdentitySummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentitySummary', 'BetaIdentitySummary'] +slug: /tools/sdk/powershell/beta/models/identity-summary +tags: ['SDK', 'Software Development Kit', 'IdentitySummary', 'BetaIdentitySummary'] +--- + + +# IdentitySummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of this identity summary | [optional] +**Name** | Pointer to **String** | Human-readable display name of identity | [optional] +**IdentityId** | Pointer to **String** | ID of the identity that this summary represents | [optional] +**Completed** | Pointer to **Boolean** | Indicates if all access items for this summary have been decided on | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$IdentitySummary = Initialize-PSSailpoint.BetaIdentitySummary -Id ff80818155fe8c080155fe8d925b0316 ` + -Name SailPoint Services ` + -IdentityId c15b9f5cca5a4e9599eaa0e64fa921bd ` + -Completed true +``` + +- Convert the resource to JSON +```powershell +$IdentitySummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentitySyncJob.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentitySyncJob.md new file mode 100644 index 000000000..864311b93 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentitySyncJob.md @@ -0,0 +1,39 @@ +--- +id: beta-identity-sync-job +title: IdentitySyncJob +pagination_label: IdentitySyncJob +sidebar_label: IdentitySyncJob +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentitySyncJob', 'BetaIdentitySyncJob'] +slug: /tools/sdk/powershell/beta/models/identity-sync-job +tags: ['SDK', 'Software Development Kit', 'IdentitySyncJob', 'BetaIdentitySyncJob'] +--- + + +# IdentitySyncJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Job ID. | [required] +**Status** | **Enum** [ "QUEUED", "IN_PROGRESS", "SUCCESS", "ERROR" ] | The job status. | [required] +**Payload** | [**IdentitySyncPayload**](identity-sync-payload) | | [required] + +## Examples + +- Prepare the resource +```powershell +$IdentitySyncJob = Initialize-PSSailpoint.BetaIdentitySyncJob -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -Status IN_PROGRESS ` + -Payload null +``` + +- Convert the resource to JSON +```powershell +$IdentitySyncJob | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentitySyncPayload.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentitySyncPayload.md new file mode 100644 index 000000000..3ee7b5303 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentitySyncPayload.md @@ -0,0 +1,37 @@ +--- +id: beta-identity-sync-payload +title: IdentitySyncPayload +pagination_label: IdentitySyncPayload +sidebar_label: IdentitySyncPayload +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentitySyncPayload', 'BetaIdentitySyncPayload'] +slug: /tools/sdk/powershell/beta/models/identity-sync-payload +tags: ['SDK', 'Software Development Kit', 'IdentitySyncPayload', 'BetaIdentitySyncPayload'] +--- + + +# IdentitySyncPayload + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **String** | Payload type. | [required] +**DataJson** | **String** | Payload type. | [required] + +## Examples + +- Prepare the resource +```powershell +$IdentitySyncPayload = Initialize-PSSailpoint.BetaIdentitySyncPayload -Type SYNCHRONIZE_IDENTITY_ATTRIBUTES ` + -DataJson {"identityId":"2c918083746f642c01746f990884012a"} +``` + +- Convert the resource to JSON +```powershell +$IdentitySyncPayload | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityWithNewAccess.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityWithNewAccess.md new file mode 100644 index 000000000..6c0e1bca7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityWithNewAccess.md @@ -0,0 +1,37 @@ +--- +id: beta-identity-with-new-access +title: IdentityWithNewAccess +pagination_label: IdentityWithNewAccess +sidebar_label: IdentityWithNewAccess +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityWithNewAccess', 'BetaIdentityWithNewAccess'] +slug: /tools/sdk/powershell/beta/models/identity-with-new-access +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess', 'BetaIdentityWithNewAccess'] +--- + + +# IdentityWithNewAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **String** | Identity id to be checked. | [required] +**AccessRefs** | [**[]IdentityWithNewAccessAccessRefsInner**](identity-with-new-access-access-refs-inner) | The list of entitlements to consider for possible violations in a preventive check. | [required] + +## Examples + +- Prepare the resource +```powershell +$IdentityWithNewAccess = Initialize-PSSailpoint.BetaIdentityWithNewAccess -IdentityId 2c91808568c529c60168cca6f90c1313 ` + -AccessRefs [{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}] +``` + +- Convert the resource to JSON +```powershell +$IdentityWithNewAccess | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityWithNewAccessAccessRefsInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityWithNewAccessAccessRefsInner.md new file mode 100644 index 000000000..6c2d8b323 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IdentityWithNewAccessAccessRefsInner.md @@ -0,0 +1,39 @@ +--- +id: beta-identity-with-new-access-access-refs-inner +title: IdentityWithNewAccessAccessRefsInner +pagination_label: IdentityWithNewAccessAccessRefsInner +sidebar_label: IdentityWithNewAccessAccessRefsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityWithNewAccessAccessRefsInner', 'BetaIdentityWithNewAccessAccessRefsInner'] +slug: /tools/sdk/powershell/beta/models/identity-with-new-access-access-refs-inner +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccessAccessRefsInner', 'BetaIdentityWithNewAccessAccessRefsInner'] +--- + + +# IdentityWithNewAccessAccessRefsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | Entitlement's DTO type. | [optional] +**Id** | Pointer to **String** | Entitlement's ID. | [optional] +**Name** | Pointer to **String** | Entitlement's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityWithNewAccessAccessRefsInner = Initialize-PSSailpoint.BetaIdentityWithNewAccessAccessRefsInner -Type ENTITLEMENT ` + -Id 2c91809773dee32014e13e122092014e ` + -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local +``` + +- Convert the resource to JSON +```powershell +$IdentityWithNewAccessAccessRefsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportAccountsRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportAccountsRequest.md new file mode 100644 index 000000000..8b2ca470d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportAccountsRequest.md @@ -0,0 +1,37 @@ +--- +id: beta-import-accounts-request +title: ImportAccountsRequest +pagination_label: ImportAccountsRequest +sidebar_label: ImportAccountsRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ImportAccountsRequest', 'BetaImportAccountsRequest'] +slug: /tools/sdk/powershell/beta/models/import-accounts-request +tags: ['SDK', 'Software Development Kit', 'ImportAccountsRequest', 'BetaImportAccountsRequest'] +--- + + +# ImportAccountsRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | Pointer to **System.IO.FileInfo** | The CSV file containing the source accounts to aggregate. | [optional] +**DisableOptimization** | Pointer to **Enum** [ "true", "false" ] | Use this flag to reprocess every account whether or not the data has changed. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImportAccountsRequest = Initialize-PSSailpoint.BetaImportAccountsRequest -File null ` + -DisableOptimization true +``` + +- Convert the resource to JSON +```powershell +$ImportAccountsRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportAccountsRequest1.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportAccountsRequest1.md new file mode 100644 index 000000000..0df4f2d5a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportAccountsRequest1.md @@ -0,0 +1,35 @@ +--- +id: beta-import-accounts-request1 +title: ImportAccountsRequest1 +pagination_label: ImportAccountsRequest1 +sidebar_label: ImportAccountsRequest1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ImportAccountsRequest1', 'BetaImportAccountsRequest1'] +slug: /tools/sdk/powershell/beta/models/import-accounts-request1 +tags: ['SDK', 'Software Development Kit', 'ImportAccountsRequest1', 'BetaImportAccountsRequest1'] +--- + + +# ImportAccountsRequest1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisableOptimization** | Pointer to **Enum** [ "true", "false" ] | Use this flag to reprocess every account whether or not the data has changed. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImportAccountsRequest1 = Initialize-PSSailpoint.BetaImportAccountsRequest1 -DisableOptimization true +``` + +- Convert the resource to JSON +```powershell +$ImportAccountsRequest1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportEntitlementsBySourceRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportEntitlementsBySourceRequest.md new file mode 100644 index 000000000..e744827dd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportEntitlementsBySourceRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-import-entitlements-by-source-request +title: ImportEntitlementsBySourceRequest +pagination_label: ImportEntitlementsBySourceRequest +sidebar_label: ImportEntitlementsBySourceRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ImportEntitlementsBySourceRequest', 'BetaImportEntitlementsBySourceRequest'] +slug: /tools/sdk/powershell/beta/models/import-entitlements-by-source-request +tags: ['SDK', 'Software Development Kit', 'ImportEntitlementsBySourceRequest', 'BetaImportEntitlementsBySourceRequest'] +--- + + +# ImportEntitlementsBySourceRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CsvFile** | Pointer to **System.IO.FileInfo** | The CSV file containing the source entitlements to aggregate. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImportEntitlementsBySourceRequest = Initialize-PSSailpoint.BetaImportEntitlementsBySourceRequest -CsvFile null +``` + +- Convert the resource to JSON +```powershell +$ImportEntitlementsBySourceRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportEntitlementsRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportEntitlementsRequest.md new file mode 100644 index 000000000..18f071bfc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportEntitlementsRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-import-entitlements-request +title: ImportEntitlementsRequest +pagination_label: ImportEntitlementsRequest +sidebar_label: ImportEntitlementsRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ImportEntitlementsRequest', 'BetaImportEntitlementsRequest'] +slug: /tools/sdk/powershell/beta/models/import-entitlements-request +tags: ['SDK', 'Software Development Kit', 'ImportEntitlementsRequest', 'BetaImportEntitlementsRequest'] +--- + + +# ImportEntitlementsRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | Pointer to **System.IO.FileInfo** | The CSV file containing the source entitlements to aggregate. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImportEntitlementsRequest = Initialize-PSSailpoint.BetaImportEntitlementsRequest -File null +``` + +- Convert the resource to JSON +```powershell +$ImportEntitlementsRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportFormDefinitions202Response.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportFormDefinitions202Response.md new file mode 100644 index 000000000..1cb7a8288 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportFormDefinitions202Response.md @@ -0,0 +1,41 @@ +--- +id: beta-import-form-definitions202-response +title: ImportFormDefinitions202Response +pagination_label: ImportFormDefinitions202Response +sidebar_label: ImportFormDefinitions202Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ImportFormDefinitions202Response', 'BetaImportFormDefinitions202Response'] +slug: /tools/sdk/powershell/beta/models/import-form-definitions202-response +tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitions202Response', 'BetaImportFormDefinitions202Response'] +--- + + +# ImportFormDefinitions202Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Errors** | Pointer to [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional] +**ImportedObjects** | Pointer to [**[]ExportFormDefinitionsByTenant200ResponseInner**](export-form-definitions-by-tenant200-response-inner) | | [optional] +**Infos** | Pointer to [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional] +**Warnings** | Pointer to [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImportFormDefinitions202Response = Initialize-PSSailpoint.BetaImportFormDefinitions202Response -Errors null ` + -ImportedObjects null ` + -Infos null ` + -Warnings null +``` + +- Convert the resource to JSON +```powershell +$ImportFormDefinitions202Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportFormDefinitions202ResponseErrorsInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportFormDefinitions202ResponseErrorsInner.md new file mode 100644 index 000000000..62f44f4e6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportFormDefinitions202ResponseErrorsInner.md @@ -0,0 +1,39 @@ +--- +id: beta-import-form-definitions202-response-errors-inner +title: ImportFormDefinitions202ResponseErrorsInner +pagination_label: ImportFormDefinitions202ResponseErrorsInner +sidebar_label: ImportFormDefinitions202ResponseErrorsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ImportFormDefinitions202ResponseErrorsInner', 'BetaImportFormDefinitions202ResponseErrorsInner'] +slug: /tools/sdk/powershell/beta/models/import-form-definitions202-response-errors-inner +tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitions202ResponseErrorsInner', 'BetaImportFormDefinitions202ResponseErrorsInner'] +--- + + +# ImportFormDefinitions202ResponseErrorsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Detail** | Pointer to [**map[string]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | | [optional] +**Key** | Pointer to **String** | | [optional] +**Text** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImportFormDefinitions202ResponseErrorsInner = Initialize-PSSailpoint.BetaImportFormDefinitions202ResponseErrorsInner -Detail null ` + -Key null ` + -Text null +``` + +- Convert the resource to JSON +```powershell +$ImportFormDefinitions202ResponseErrorsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportFormDefinitionsRequestInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportFormDefinitionsRequestInner.md new file mode 100644 index 000000000..f37437b35 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportFormDefinitionsRequestInner.md @@ -0,0 +1,39 @@ +--- +id: beta-import-form-definitions-request-inner +title: ImportFormDefinitionsRequestInner +pagination_label: ImportFormDefinitionsRequestInner +sidebar_label: ImportFormDefinitionsRequestInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ImportFormDefinitionsRequestInner', 'BetaImportFormDefinitionsRequestInner'] +slug: /tools/sdk/powershell/beta/models/import-form-definitions-request-inner +tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitionsRequestInner', 'BetaImportFormDefinitionsRequestInner'] +--- + + +# ImportFormDefinitionsRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Object** | Pointer to [**FormDefinitionResponse**](form-definition-response) | | [optional] +**Self** | Pointer to **String** | | [optional] +**Version** | Pointer to **Int32** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImportFormDefinitionsRequestInner = Initialize-PSSailpoint.BetaImportFormDefinitionsRequestInner -Object null ` + -Self null ` + -Version null +``` + +- Convert the resource to JSON +```powershell +$ImportFormDefinitionsRequestInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportNonEmployeeRecordsInBulkRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportNonEmployeeRecordsInBulkRequest.md new file mode 100644 index 000000000..8b235ee36 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportNonEmployeeRecordsInBulkRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-import-non-employee-records-in-bulk-request +title: ImportNonEmployeeRecordsInBulkRequest +pagination_label: ImportNonEmployeeRecordsInBulkRequest +sidebar_label: ImportNonEmployeeRecordsInBulkRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ImportNonEmployeeRecordsInBulkRequest', 'BetaImportNonEmployeeRecordsInBulkRequest'] +slug: /tools/sdk/powershell/beta/models/import-non-employee-records-in-bulk-request +tags: ['SDK', 'Software Development Kit', 'ImportNonEmployeeRecordsInBulkRequest', 'BetaImportNonEmployeeRecordsInBulkRequest'] +--- + + +# ImportNonEmployeeRecordsInBulkRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarData** | **System.IO.FileInfo** | | [required] + +## Examples + +- Prepare the resource +```powershell +$ImportNonEmployeeRecordsInBulkRequest = Initialize-PSSailpoint.BetaImportNonEmployeeRecordsInBulkRequest -VarData null +``` + +- Convert the resource to JSON +```powershell +$ImportNonEmployeeRecordsInBulkRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportObject.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportObject.md new file mode 100644 index 000000000..11175f177 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportObject.md @@ -0,0 +1,39 @@ +--- +id: beta-import-object +title: ImportObject +pagination_label: ImportObject +sidebar_label: ImportObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ImportObject', 'BetaImportObject'] +slug: /tools/sdk/powershell/beta/models/import-object +tags: ['SDK', 'Software Development Kit', 'ImportObject', 'BetaImportObject'] +--- + + +# ImportObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "RULE", "SOURCE", "TRANSFORM", "TRIGGER_SUBSCRIPTION" ] | DTO type of object created or updated by import. | [optional] +**Id** | Pointer to **String** | ID of object created or updated by import. | [optional] +**Name** | Pointer to **String** | Display name of object created or updated by import. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImportObject = Initialize-PSSailpoint.BetaImportObject -Type SOURCE ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name HR Active Directory +``` + +- Convert the resource to JSON +```powershell +$ImportObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportOptions.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportOptions.md new file mode 100644 index 000000000..21606d0be --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportOptions.md @@ -0,0 +1,43 @@ +--- +id: beta-import-options +title: ImportOptions +pagination_label: ImportOptions +sidebar_label: ImportOptions +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ImportOptions', 'BetaImportOptions'] +slug: /tools/sdk/powershell/beta/models/import-options +tags: ['SDK', 'Software Development Kit', 'ImportOptions', 'BetaImportOptions'] +--- + + +# ImportOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExcludeTypes** | Pointer to **[]String** | Object type names to be excluded from an sp-config export command. | [optional] +**IncludeTypes** | Pointer to **[]String** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional] +**ObjectOptions** | Pointer to [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional] +**DefaultReferences** | Pointer to **[]String** | List of object types that can be used to resolve references on import. | [optional] +**ExcludeBackup** | Pointer to **Boolean** | By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. If excludeBackup is true, the backup will not be performed. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$ImportOptions = Initialize-PSSailpoint.BetaImportOptions -ExcludeTypes null ` + -IncludeTypes null ` + -ObjectOptions {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}} ` + -DefaultReferences null ` + -ExcludeBackup false +``` + +- Convert the resource to JSON +```powershell +$ImportOptions | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportSpConfigRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportSpConfigRequest.md new file mode 100644 index 000000000..8db39c90c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ImportSpConfigRequest.md @@ -0,0 +1,37 @@ +--- +id: beta-import-sp-config-request +title: ImportSpConfigRequest +pagination_label: ImportSpConfigRequest +sidebar_label: ImportSpConfigRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ImportSpConfigRequest', 'BetaImportSpConfigRequest'] +slug: /tools/sdk/powershell/beta/models/import-sp-config-request +tags: ['SDK', 'Software Development Kit', 'ImportSpConfigRequest', 'BetaImportSpConfigRequest'] +--- + + +# ImportSpConfigRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarData** | **System.IO.FileInfo** | JSON file containing the objects to be imported. | [required] +**Options** | Pointer to [**ImportOptions**](import-options) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImportSpConfigRequest = Initialize-PSSailpoint.BetaImportSpConfigRequest -VarData null ` + -Options null +``` + +- Convert the resource to JSON +```powershell +$ImportSpConfigRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IndexOf.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IndexOf.md new file mode 100644 index 000000000..fe7f83ed8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/IndexOf.md @@ -0,0 +1,39 @@ +--- +id: beta-index-of +title: IndexOf +pagination_label: IndexOf +sidebar_label: IndexOf +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IndexOf', 'BetaIndexOf'] +slug: /tools/sdk/powershell/beta/models/index-of +tags: ['SDK', 'Software Development Kit', 'IndexOf', 'BetaIndexOf'] +--- + + +# IndexOf + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Substring** | **String** | A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring. | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$IndexOf = Initialize-PSSailpoint.BetaIndexOf -Substring admin_ ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$IndexOf | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/InviteIdentitiesRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/InviteIdentitiesRequest.md new file mode 100644 index 000000000..dee037110 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/InviteIdentitiesRequest.md @@ -0,0 +1,37 @@ +--- +id: beta-invite-identities-request +title: InviteIdentitiesRequest +pagination_label: InviteIdentitiesRequest +sidebar_label: InviteIdentitiesRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'InviteIdentitiesRequest', 'BetaInviteIdentitiesRequest'] +slug: /tools/sdk/powershell/beta/models/invite-identities-request +tags: ['SDK', 'Software Development Kit', 'InviteIdentitiesRequest', 'BetaInviteIdentitiesRequest'] +--- + + +# InviteIdentitiesRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]String** | The list of Identities IDs to invite - required when 'uninvited' is false | [optional] +**Uninvited** | Pointer to **Boolean** | indicator (optional) to invite all unregistered identities in the system within a limit 1000. This parameter makes sense only when 'ids' is empty. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$InviteIdentitiesRequest = Initialize-PSSailpoint.BetaInviteIdentitiesRequest -Ids [2b568c65bc3c4c57a43bd97e3a8e55, 2c9180867769897d01776ed5f125512f] ` + -Uninvited false +``` + +- Convert the resource to JSON +```powershell +$InviteIdentitiesRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Invocation.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Invocation.md new file mode 100644 index 000000000..5cf172781 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Invocation.md @@ -0,0 +1,41 @@ +--- +id: beta-invocation +title: Invocation +pagination_label: Invocation +sidebar_label: Invocation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Invocation', 'BetaInvocation'] +slug: /tools/sdk/powershell/beta/models/invocation +tags: ['SDK', 'Software Development Kit', 'Invocation', 'BetaInvocation'] +--- + + +# Invocation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Invocation ID | [optional] +**TriggerId** | Pointer to **String** | Trigger ID | [optional] +**Secret** | Pointer to **String** | Unique invocation secret. | [optional] +**ContentJson** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | JSON map of invocation metadata. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Invocation = Initialize-PSSailpoint.BetaInvocation -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -TriggerId idn:access-requested ` + -Secret 0f979022-08be-44f2-b6f9-7393ec73ed9b ` + -ContentJson {workflowId=1234} +``` + +- Convert the resource to JSON +```powershell +$Invocation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/InvocationStatus.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/InvocationStatus.md new file mode 100644 index 000000000..4751121ea --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/InvocationStatus.md @@ -0,0 +1,51 @@ +--- +id: beta-invocation-status +title: InvocationStatus +pagination_label: InvocationStatus +sidebar_label: InvocationStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'InvocationStatus', 'BetaInvocationStatus'] +slug: /tools/sdk/powershell/beta/models/invocation-status +tags: ['SDK', 'Software Development Kit', 'InvocationStatus', 'BetaInvocationStatus'] +--- + + +# InvocationStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Invocation ID | [required] +**TriggerId** | **String** | Trigger ID | [required] +**SubscriptionName** | **String** | Subscription name | [required] +**SubscriptionId** | **String** | Subscription ID | [required] +**Type** | [**InvocationStatusType**](invocation-status-type) | | [required] +**Created** | **System.DateTime** | Invocation created timestamp. ISO-8601 in UTC. | [required] +**Completed** | Pointer to **System.DateTime** | Invocation completed timestamp; empty fields imply invocation is in-flight or not completed. ISO-8601 in UTC. | [optional] +**StartInvocationInput** | [**StartInvocationInput**](start-invocation-input) | | [required] +**CompleteInvocationInput** | Pointer to [**CompleteInvocationInput**](complete-invocation-input) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$InvocationStatus = Initialize-PSSailpoint.BetaInvocationStatus -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -TriggerId idn:access-request-post-approval ` + -SubscriptionName Access request subscription ` + -SubscriptionId 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -Type null ` + -Created 2020-03-27T20:40:10.738Z ` + -Completed 2020-03-27T20:42:14.738Z ` + -StartInvocationInput null ` + -CompleteInvocationInput null +``` + +- Convert the resource to JSON +```powershell +$InvocationStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/InvocationStatusType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/InvocationStatusType.md new file mode 100644 index 000000000..7b3ef7c80 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/InvocationStatusType.md @@ -0,0 +1,24 @@ +--- +id: beta-invocation-status-type +title: InvocationStatusType +pagination_label: InvocationStatusType +sidebar_label: InvocationStatusType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'InvocationStatusType', 'BetaInvocationStatusType'] +slug: /tools/sdk/powershell/beta/models/invocation-status-type +tags: ['SDK', 'Software Development Kit', 'InvocationStatusType', 'BetaInvocationStatusType'] +--- + + +# InvocationStatusType + +## Enum + + +* `TEST` (value: `"TEST"`) + +* `REAL_TIME` (value: `"REAL_TIME"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/JsonPatch.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/JsonPatch.md new file mode 100644 index 000000000..37cbe0f29 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/JsonPatch.md @@ -0,0 +1,35 @@ +--- +id: beta-json-patch +title: JsonPatch +pagination_label: JsonPatch +sidebar_label: JsonPatch +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'JsonPatch', 'BetaJsonPatch'] +slug: /tools/sdk/powershell/beta/models/json-patch +tags: ['SDK', 'Software Development Kit', 'JsonPatch', 'BetaJsonPatch'] +--- + + +# JsonPatch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operations** | Pointer to [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] + +## Examples + +- Prepare the resource +```powershell +$JsonPatch = Initialize-PSSailpoint.BetaJsonPatch -Operations null +``` + +- Convert the resource to JSON +```powershell +$JsonPatch | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/JsonPatchOperation.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/JsonPatchOperation.md new file mode 100644 index 000000000..c9d653233 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/JsonPatchOperation.md @@ -0,0 +1,39 @@ +--- +id: beta-json-patch-operation +title: JsonPatchOperation +pagination_label: JsonPatchOperation +sidebar_label: JsonPatchOperation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'JsonPatchOperation', 'BetaJsonPatchOperation'] +slug: /tools/sdk/powershell/beta/models/json-patch-operation +tags: ['SDK', 'Software Development Kit', 'JsonPatchOperation', 'BetaJsonPatchOperation'] +--- + + +# JsonPatchOperation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | **Enum** [ "add", "remove", "replace", "move", "copy", "test" ] | The operation to be performed | [required] +**Path** | **String** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required] +**Value** | Pointer to [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$JsonPatchOperation = Initialize-PSSailpoint.BetaJsonPatchOperation -Op replace ` + -Path /description ` + -Value null +``` + +- Convert the resource to JSON +```powershell +$JsonPatchOperation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/JsonPatchOperations.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/JsonPatchOperations.md new file mode 100644 index 000000000..d81fbf671 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/JsonPatchOperations.md @@ -0,0 +1,39 @@ +--- +id: beta-json-patch-operations +title: JsonPatchOperations +pagination_label: JsonPatchOperations +sidebar_label: JsonPatchOperations +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'JsonPatchOperations', 'BetaJsonPatchOperations'] +slug: /tools/sdk/powershell/beta/models/json-patch-operations +tags: ['SDK', 'Software Development Kit', 'JsonPatchOperations', 'BetaJsonPatchOperations'] +--- + + +# JsonPatchOperations + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | **Enum** [ "add", "remove", "replace" ] | The operation to be performed | [required] +**Path** | **String** | A string representing the target path to an element to be affected by the operation | [required] +**Value** | Pointer to [**JsonPatchOperationsValue**](json-patch-operations-value) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$JsonPatchOperations = Initialize-PSSailpoint.BetaJsonPatchOperations -Op replace ` + -Path /dismissed ` + -Value null +``` + +- Convert the resource to JSON +```powershell +$JsonPatchOperations | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/JsonPatchOperationsValue.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/JsonPatchOperationsValue.md new file mode 100644 index 000000000..a45d13581 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/JsonPatchOperationsValue.md @@ -0,0 +1,34 @@ +--- +id: beta-json-patch-operations-value +title: JsonPatchOperationsValue +pagination_label: JsonPatchOperationsValue +sidebar_label: JsonPatchOperationsValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'JsonPatchOperationsValue', 'BetaJsonPatchOperationsValue'] +slug: /tools/sdk/powershell/beta/models/json-patch-operations-value +tags: ['SDK', 'Software Development Kit', 'JsonPatchOperationsValue', 'BetaJsonPatchOperationsValue'] +--- + + +# JsonPatchOperationsValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$JsonPatchOperationsValue = Initialize-PSSailpoint.BetaJsonPatchOperationsValue +``` + +- Convert the resource to JSON +```powershell +$JsonPatchOperationsValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/KbaAnswerRequestItem.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/KbaAnswerRequestItem.md new file mode 100644 index 000000000..78afb4fd8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/KbaAnswerRequestItem.md @@ -0,0 +1,37 @@ +--- +id: beta-kba-answer-request-item +title: KbaAnswerRequestItem +pagination_label: KbaAnswerRequestItem +sidebar_label: KbaAnswerRequestItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'KbaAnswerRequestItem', 'BetaKbaAnswerRequestItem'] +slug: /tools/sdk/powershell/beta/models/kba-answer-request-item +tags: ['SDK', 'Software Development Kit', 'KbaAnswerRequestItem', 'BetaKbaAnswerRequestItem'] +--- + + +# KbaAnswerRequestItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Question Id | [required] +**Answer** | **String** | An answer for the KBA question | [required] + +## Examples + +- Prepare the resource +```powershell +$KbaAnswerRequestItem = Initialize-PSSailpoint.BetaKbaAnswerRequestItem -Id c54fee53-2d63-4fc5-9259-3e93b9994135 ` + -Answer Your answer +``` + +- Convert the resource to JSON +```powershell +$KbaAnswerRequestItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/KbaAnswerResponseItem.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/KbaAnswerResponseItem.md new file mode 100644 index 000000000..6e2e248d9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/KbaAnswerResponseItem.md @@ -0,0 +1,39 @@ +--- +id: beta-kba-answer-response-item +title: KbaAnswerResponseItem +pagination_label: KbaAnswerResponseItem +sidebar_label: KbaAnswerResponseItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'KbaAnswerResponseItem', 'BetaKbaAnswerResponseItem'] +slug: /tools/sdk/powershell/beta/models/kba-answer-response-item +tags: ['SDK', 'Software Development Kit', 'KbaAnswerResponseItem', 'BetaKbaAnswerResponseItem'] +--- + + +# KbaAnswerResponseItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Question Id | [required] +**Question** | **String** | Question description | [required] +**HasAnswer** | **Boolean** | Denotes whether the KBA question has an answer configured for the current user | [required] + +## Examples + +- Prepare the resource +```powershell +$KbaAnswerResponseItem = Initialize-PSSailpoint.BetaKbaAnswerResponseItem -Id c54fee53-2d63-4fc5-9259-3e93b9994135 ` + -Question [{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}] ` + -HasAnswer true +``` + +- Convert the resource to JSON +```powershell +$KbaAnswerResponseItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/KbaAuthResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/KbaAuthResponse.md new file mode 100644 index 000000000..47eaad0d9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/KbaAuthResponse.md @@ -0,0 +1,37 @@ +--- +id: beta-kba-auth-response +title: KbaAuthResponse +pagination_label: KbaAuthResponse +sidebar_label: KbaAuthResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'KbaAuthResponse', 'BetaKbaAuthResponse'] +slug: /tools/sdk/powershell/beta/models/kba-auth-response +tags: ['SDK', 'Software Development Kit', 'KbaAuthResponse', 'BetaKbaAuthResponse'] +--- + + +# KbaAuthResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**KbaAuthResponseItems** | Pointer to [**[]KbaAuthResponseItem**](kba-auth-response-item) | | [optional] +**Status** | Pointer to **Enum** [ "PENDING", "SUCCESS", "FAILED", "LOCKOUT", "NOT_ENOUGH_DATA" ] | MFA Authentication status | [optional] + +## Examples + +- Prepare the resource +```powershell +$KbaAuthResponse = Initialize-PSSailpoint.BetaKbaAuthResponse -KbaAuthResponseItems [{questionId=089899f13a8f4da7824996191587bab9, isVerified=false}] ` + -Status PENDING +``` + +- Convert the resource to JSON +```powershell +$KbaAuthResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/KbaAuthResponseItem.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/KbaAuthResponseItem.md new file mode 100644 index 000000000..9bff0ced0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/KbaAuthResponseItem.md @@ -0,0 +1,37 @@ +--- +id: beta-kba-auth-response-item +title: KbaAuthResponseItem +pagination_label: KbaAuthResponseItem +sidebar_label: KbaAuthResponseItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'KbaAuthResponseItem', 'BetaKbaAuthResponseItem'] +slug: /tools/sdk/powershell/beta/models/kba-auth-response-item +tags: ['SDK', 'Software Development Kit', 'KbaAuthResponseItem', 'BetaKbaAuthResponseItem'] +--- + + +# KbaAuthResponseItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**QuestionId** | Pointer to **String** | The KBA question id | [optional] +**IsVerified** | Pointer to **Boolean** | Return true if verified | [optional] + +## Examples + +- Prepare the resource +```powershell +$KbaAuthResponseItem = Initialize-PSSailpoint.BetaKbaAuthResponseItem -QuestionId 089899f13a8f4da7824996191587bab9 ` + -IsVerified true +``` + +- Convert the resource to JSON +```powershell +$KbaAuthResponseItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/KbaQuestion.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/KbaQuestion.md new file mode 100644 index 000000000..38e750745 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/KbaQuestion.md @@ -0,0 +1,41 @@ +--- +id: beta-kba-question +title: KbaQuestion +pagination_label: KbaQuestion +sidebar_label: KbaQuestion +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'KbaQuestion', 'BetaKbaQuestion'] +slug: /tools/sdk/powershell/beta/models/kba-question +tags: ['SDK', 'Software Development Kit', 'KbaQuestion', 'BetaKbaQuestion'] +--- + + +# KbaQuestion + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | KBA Question Id | [required] +**Text** | **String** | KBA Question description | [required] +**HasAnswer** | **Boolean** | Denotes whether the KBA question has an answer configured for any user in the tenant | [required] +**NumAnswers** | **Int32** | Denotes the number of KBA configurations for this question | [required] + +## Examples + +- Prepare the resource +```powershell +$KbaQuestion = Initialize-PSSailpoint.BetaKbaQuestion -Id 143cfd3b-c23f-426b-ae5f-d3db06fa5919 ` + -Text [{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}] ` + -HasAnswer true ` + -NumAnswers 5 +``` + +- Convert the resource to JSON +```powershell +$KbaQuestion | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LatestOutlierSummary.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LatestOutlierSummary.md new file mode 100644 index 000000000..46964953b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LatestOutlierSummary.md @@ -0,0 +1,43 @@ +--- +id: beta-latest-outlier-summary +title: LatestOutlierSummary +pagination_label: LatestOutlierSummary +sidebar_label: LatestOutlierSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LatestOutlierSummary', 'BetaLatestOutlierSummary'] +slug: /tools/sdk/powershell/beta/models/latest-outlier-summary +tags: ['SDK', 'Software Development Kit', 'LatestOutlierSummary', 'BetaLatestOutlierSummary'] +--- + + +# LatestOutlierSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "LOW_SIMILARITY", "STRUCTURAL" ] | The type of outlier summary | [optional] +**SnapshotDate** | Pointer to **System.DateTime** | The date the bulk outlier detection ran/snapshot was created | [optional] +**TotalOutliers** | Pointer to **Int32** | Total number of outliers for the customer making the request | [optional] +**TotalIdentities** | Pointer to **Int32** | Total number of identities for the customer making the request | [optional] +**TotalIgnored** | Pointer to **Int32** | Total number of ignored outliers | [optional] + +## Examples + +- Prepare the resource +```powershell +$LatestOutlierSummary = Initialize-PSSailpoint.BetaLatestOutlierSummary -Type LOW_SIMILARITY ` + -SnapshotDate 2021-05-01T18:40:35.772Z ` + -TotalOutliers 50 ` + -TotalIdentities 5000 ` + -TotalIgnored 10 +``` + +- Convert the resource to JSON +```powershell +$LatestOutlierSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Launcher.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Launcher.md new file mode 100644 index 000000000..ec2ace330 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Launcher.md @@ -0,0 +1,53 @@ +--- +id: beta-launcher +title: Launcher +pagination_label: Launcher +sidebar_label: Launcher +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Launcher', 'BetaLauncher'] +slug: /tools/sdk/powershell/beta/models/launcher +tags: ['SDK', 'Software Development Kit', 'Launcher', 'BetaLauncher'] +--- + + +# Launcher + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | ID of the Launcher | [required] +**Created** | **System.DateTime** | Date the Launcher was created | [required] +**Modified** | **System.DateTime** | Date the Launcher was last modified | [required] +**Owner** | [**LauncherOwner**](launcher-owner) | | [required] +**Name** | **String** | Name of the Launcher, limited to 255 characters | [required] +**Description** | **String** | Description of the Launcher, limited to 2000 characters | [required] +**Type** | **Enum** [ "INTERACTIVE_PROCESS" ] | Launcher type | [required] +**Disabled** | **Boolean** | State of the Launcher | [required] +**Reference** | Pointer to [**LauncherReference**](launcher-reference) | | [optional] +**Config** | **String** | JSON configuration associated with this Launcher, restricted to a max size of 4KB | [required] + +## Examples + +- Prepare the resource +```powershell +$Launcher = Initialize-PSSailpoint.BetaLauncher -Id 1b630bed-0941-4792-a712-57a5868ca34d ` + -Created 2024-04-16T20:07:30.601016489Z ` + -Modified 2024-04-17T18:02:07.320143194Z ` + -Owner null ` + -Name Group Create ` + -Description Create a new Active Directory Group ` + -Type INTERACTIVE_PROCESS ` + -Disabled false ` + -Reference null ` + -Config {"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"} +``` + +- Convert the resource to JSON +```powershell +$Launcher | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LauncherOwner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LauncherOwner.md new file mode 100644 index 000000000..146e77ab6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LauncherOwner.md @@ -0,0 +1,37 @@ +--- +id: beta-launcher-owner +title: LauncherOwner +pagination_label: LauncherOwner +sidebar_label: LauncherOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LauncherOwner', 'BetaLauncherOwner'] +slug: /tools/sdk/powershell/beta/models/launcher-owner +tags: ['SDK', 'Software Development Kit', 'LauncherOwner', 'BetaLauncherOwner'] +--- + + +# LauncherOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **String** | Owner type | [required] +**Id** | **String** | Owner ID | [required] + +## Examples + +- Prepare the resource +```powershell +$LauncherOwner = Initialize-PSSailpoint.BetaLauncherOwner -Type IDENTITY ` + -Id 123180847373330f0173c7e1756b6890 +``` + +- Convert the resource to JSON +```powershell +$LauncherOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LauncherReference.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LauncherReference.md new file mode 100644 index 000000000..6534d644c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LauncherReference.md @@ -0,0 +1,37 @@ +--- +id: beta-launcher-reference +title: LauncherReference +pagination_label: LauncherReference +sidebar_label: LauncherReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LauncherReference', 'BetaLauncherReference'] +slug: /tools/sdk/powershell/beta/models/launcher-reference +tags: ['SDK', 'Software Development Kit', 'LauncherReference', 'BetaLauncherReference'] +--- + + +# LauncherReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "WORKFLOW" ] | Type of Launcher reference | [optional] +**Id** | Pointer to **String** | ID of Launcher reference | [optional] + +## Examples + +- Prepare the resource +```powershell +$LauncherReference = Initialize-PSSailpoint.BetaLauncherReference -Type WORKFLOW ` + -Id 2fd6ff94-2081-4d29-acbc-83a0a2f744a5 +``` + +- Convert the resource to JSON +```powershell +$LauncherReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LauncherRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LauncherRequest.md new file mode 100644 index 000000000..ceecd9790 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LauncherRequest.md @@ -0,0 +1,45 @@ +--- +id: beta-launcher-request +title: LauncherRequest +pagination_label: LauncherRequest +sidebar_label: LauncherRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LauncherRequest', 'BetaLauncherRequest'] +slug: /tools/sdk/powershell/beta/models/launcher-request +tags: ['SDK', 'Software Development Kit', 'LauncherRequest', 'BetaLauncherRequest'] +--- + + +# LauncherRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Name of the Launcher, limited to 255 characters | [required] +**Description** | **String** | Description of the Launcher, limited to 2000 characters | [required] +**Type** | **Enum** [ "INTERACTIVE_PROCESS" ] | Launcher type | [required] +**Disabled** | **Boolean** | State of the Launcher | [required] +**Reference** | Pointer to [**LauncherRequestReference**](launcher-request-reference) | | [optional] +**Config** | **String** | JSON configuration associated with this Launcher, restricted to a max size of 4KB | [required] + +## Examples + +- Prepare the resource +```powershell +$LauncherRequest = Initialize-PSSailpoint.BetaLauncherRequest -Name Group Create ` + -Description Create a new Active Directory Group ` + -Type INTERACTIVE_PROCESS ` + -Disabled false ` + -Reference null ` + -Config {"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"} +``` + +- Convert the resource to JSON +```powershell +$LauncherRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LauncherRequestReference.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LauncherRequestReference.md new file mode 100644 index 000000000..612d554e7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LauncherRequestReference.md @@ -0,0 +1,37 @@ +--- +id: beta-launcher-request-reference +title: LauncherRequestReference +pagination_label: LauncherRequestReference +sidebar_label: LauncherRequestReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LauncherRequestReference', 'BetaLauncherRequestReference'] +slug: /tools/sdk/powershell/beta/models/launcher-request-reference +tags: ['SDK', 'Software Development Kit', 'LauncherRequestReference', 'BetaLauncherRequestReference'] +--- + + +# LauncherRequestReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "WORKFLOW" ] | Type of Launcher reference | [required] +**Id** | **String** | ID of Launcher reference | [required] + +## Examples + +- Prepare the resource +```powershell +$LauncherRequestReference = Initialize-PSSailpoint.BetaLauncherRequestReference -Type WORKFLOW ` + -Id 2fd6ff94-2081-4d29-acbc-83a0a2f744a5 +``` + +- Convert the resource to JSON +```powershell +$LauncherRequestReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LeftPad.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LeftPad.md new file mode 100644 index 000000000..49840ba31 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LeftPad.md @@ -0,0 +1,41 @@ +--- +id: beta-left-pad +title: LeftPad +pagination_label: LeftPad +sidebar_label: LeftPad +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LeftPad', 'BetaLeftPad'] +slug: /tools/sdk/powershell/beta/models/left-pad +tags: ['SDK', 'Software Development Kit', 'LeftPad', 'BetaLeftPad'] +--- + + +# LeftPad + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Length** | **String** | An integer value for the desired length of the final output string | [required] +**Padding** | Pointer to **String** | A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space ("" "") character for padding | [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] + +## Examples + +- Prepare the resource +```powershell +$LeftPad = Initialize-PSSailpoint.BetaLeftPad -Length 4 ` + -Padding 0 ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$LeftPad | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/License.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/License.md new file mode 100644 index 000000000..272b20d78 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/License.md @@ -0,0 +1,37 @@ +--- +id: beta-license +title: License +pagination_label: License +sidebar_label: License +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'License', 'BetaLicense'] +slug: /tools/sdk/powershell/beta/models/license +tags: ['SDK', 'Software Development Kit', 'License', 'BetaLicense'] +--- + + +# License + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LicenseId** | Pointer to **String** | Name of the license | [optional] +**LegacyFeatureName** | Pointer to **String** | Legacy name of the license | [optional] + +## Examples + +- Prepare the resource +```powershell +$License = Initialize-PSSailpoint.BetaLicense -LicenseId idn:access-request ` + -LegacyFeatureName ACCESS_REQUEST +``` + +- Convert the resource to JSON +```powershell +$License | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LifecycleState.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LifecycleState.md new file mode 100644 index 000000000..02ed61dc5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LifecycleState.md @@ -0,0 +1,55 @@ +--- +id: beta-lifecycle-state +title: LifecycleState +pagination_label: LifecycleState +sidebar_label: LifecycleState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LifecycleState', 'BetaLifecycleState'] +slug: /tools/sdk/powershell/beta/models/lifecycle-state +tags: ['SDK', 'Software Development Kit', 'LifecycleState', 'BetaLifecycleState'] +--- + + +# LifecycleState + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Lifecycle state ID. | [optional] [readonly] +**Name** | Pointer to **String** | Lifecycle state name. | [optional] [readonly] +**TechnicalName** | Pointer to **String** | Lifecycle state technical name. This is for internal use. | [optional] [readonly] +**Description** | Pointer to **String** | Lifecycle state description. | [optional] +**Created** | Pointer to **System.DateTime** | Lifecycle state created date. | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | Lifecycle state modified date. | [optional] [readonly] +**Enabled** | Pointer to **Boolean** | Indicates whether the lifecycle state is enabled or disabled. | [optional] [default to $false] +**IdentityCount** | Pointer to **Int32** | Number of identities that have the lifecycle state. | [optional] [readonly] +**EmailNotificationOption** | Pointer to [**EmailNotificationOption**](email-notification-option) | | [optional] +**AccountActions** | Pointer to [**[]AccountAction**](account-action) | | [optional] +**AccessProfileIds** | Pointer to **[]String** | List of access-profile IDs that are associated with the lifecycle state. | [optional] + +## Examples + +- Prepare the resource +```powershell +$LifecycleState = Initialize-PSSailpoint.BetaLifecycleState -Id 2c9180835d2e5168015d32f890ca1581 ` + -Name Lifecycle Name ` + -TechnicalName lifecycleTechnicalName ` + -Description LifecycleDescription ` + -Created 2015-05-28T14:07:17Z ` + -Modified 2015-05-28T14:07:17Z ` + -Enabled true ` + -IdentityCount 12 ` + -EmailNotificationOption null ` + -AccountActions null ` + -AccessProfileIds [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500] +``` + +- Convert the resource to JSON +```powershell +$LifecycleState | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LifecycleStateDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LifecycleStateDto.md new file mode 100644 index 000000000..c35bf0dc3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LifecycleStateDto.md @@ -0,0 +1,37 @@ +--- +id: beta-lifecycle-state-dto +title: LifecycleStateDto +pagination_label: LifecycleStateDto +sidebar_label: LifecycleStateDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LifecycleStateDto', 'BetaLifecycleStateDto'] +slug: /tools/sdk/powershell/beta/models/lifecycle-state-dto +tags: ['SDK', 'Software Development Kit', 'LifecycleStateDto', 'BetaLifecycleStateDto'] +--- + + +# LifecycleStateDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**StateName** | **String** | The name of the lifecycle state | [required] +**ManuallyUpdated** | **Boolean** | Whether the lifecycle state has been manually or automatically set | [required] + +## Examples + +- Prepare the resource +```powershell +$LifecycleStateDto = Initialize-PSSailpoint.BetaLifecycleStateDto -StateName active ` + -ManuallyUpdated true +``` + +- Convert the resource to JSON +```powershell +$LifecycleStateDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ListAccessModelMetadataAttribute401Response.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ListAccessModelMetadataAttribute401Response.md new file mode 100644 index 000000000..a4ce4c149 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ListAccessModelMetadataAttribute401Response.md @@ -0,0 +1,35 @@ +--- +id: beta-list-access-model-metadata-attribute401-response +title: ListAccessModelMetadataAttribute401Response +pagination_label: ListAccessModelMetadataAttribute401Response +sidebar_label: ListAccessModelMetadataAttribute401Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ListAccessModelMetadataAttribute401Response', 'BetaListAccessModelMetadataAttribute401Response'] +slug: /tools/sdk/powershell/beta/models/list-access-model-metadata-attribute401-response +tags: ['SDK', 'Software Development Kit', 'ListAccessModelMetadataAttribute401Response', 'BetaListAccessModelMetadataAttribute401Response'] +--- + + +# ListAccessModelMetadataAttribute401Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarError** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A message describing the error | [optional] + +## Examples + +- Prepare the resource +```powershell +$ListAccessModelMetadataAttribute401Response = Initialize-PSSailpoint.BetaListAccessModelMetadataAttribute401Response -VarError JWT validation failed: JWT is expired +``` + +- Convert the resource to JSON +```powershell +$ListAccessModelMetadataAttribute401Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ListAccessModelMetadataAttribute429Response.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ListAccessModelMetadataAttribute429Response.md new file mode 100644 index 000000000..83703b320 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ListAccessModelMetadataAttribute429Response.md @@ -0,0 +1,35 @@ +--- +id: beta-list-access-model-metadata-attribute429-response +title: ListAccessModelMetadataAttribute429Response +pagination_label: ListAccessModelMetadataAttribute429Response +sidebar_label: ListAccessModelMetadataAttribute429Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ListAccessModelMetadataAttribute429Response', 'BetaListAccessModelMetadataAttribute429Response'] +slug: /tools/sdk/powershell/beta/models/list-access-model-metadata-attribute429-response +tags: ['SDK', 'Software Development Kit', 'ListAccessModelMetadataAttribute429Response', 'BetaListAccessModelMetadataAttribute429Response'] +--- + + +# ListAccessModelMetadataAttribute429Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A message describing the error | [optional] + +## Examples + +- Prepare the resource +```powershell +$ListAccessModelMetadataAttribute429Response = Initialize-PSSailpoint.BetaListAccessModelMetadataAttribute429Response -Message Rate Limit Exceeded +``` + +- Convert the resource to JSON +```powershell +$ListAccessModelMetadataAttribute429Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ListCompleteWorkflowLibrary200ResponseInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ListCompleteWorkflowLibrary200ResponseInner.md new file mode 100644 index 000000000..d06648c21 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ListCompleteWorkflowLibrary200ResponseInner.md @@ -0,0 +1,59 @@ +--- +id: beta-list-complete-workflow-library200-response-inner +title: ListCompleteWorkflowLibrary200ResponseInner +pagination_label: ListCompleteWorkflowLibrary200ResponseInner +sidebar_label: ListCompleteWorkflowLibrary200ResponseInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ListCompleteWorkflowLibrary200ResponseInner', 'BetaListCompleteWorkflowLibrary200ResponseInner'] +slug: /tools/sdk/powershell/beta/models/list-complete-workflow-library200-response-inner +tags: ['SDK', 'Software Development Kit', 'ListCompleteWorkflowLibrary200ResponseInner', 'BetaListCompleteWorkflowLibrary200ResponseInner'] +--- + + +# ListCompleteWorkflowLibrary200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Operator ID. | [optional] +**Name** | Pointer to **String** | Operator friendly name | [optional] +**Type** | Pointer to **String** | Operator type | [optional] +**Description** | Pointer to **String** | Description of the operator | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the operator accepts | [optional] +**ExampleOutput** | Pointer to [**WorkflowLibraryActionExampleOutput**](workflow-library-action-example-output) | | [optional] +**Deprecated** | Pointer to **Boolean** | | [optional] +**DeprecatedBy** | Pointer to **System.DateTime** | | [optional] +**VersionNumber** | Pointer to **Int32** | Version number | [optional] +**IsSimulationEnabled** | Pointer to **Boolean** | | [optional] +**IsDynamicSchema** | Pointer to **Boolean** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**OutputSchema** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Example output schema | [optional] +**InputExample** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Example trigger payload if applicable | [optional] + +## Examples + +- Prepare the resource +```powershell +$ListCompleteWorkflowLibrary200ResponseInner = Initialize-PSSailpoint.BetaListCompleteWorkflowLibrary200ResponseInner -Id sp:compare-boolean ` + -Name Compare Boolean Values ` + -Type OPERATOR ` + -Description Compare two boolean values and decide what happens based on the result. ` + -FormFields [{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] ` + -ExampleOutput null ` + -Deprecated null ` + -DeprecatedBy null ` + -VersionNumber null ` + -IsSimulationEnabled null ` + -IsDynamicSchema false ` + -OutputSchema null ` + -InputExample {changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} +``` + +- Convert the resource to JSON +```powershell +$ListCompleteWorkflowLibrary200ResponseInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ListFormDefinitionsByTenantResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ListFormDefinitionsByTenantResponse.md new file mode 100644 index 000000000..b1747d70f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ListFormDefinitionsByTenantResponse.md @@ -0,0 +1,37 @@ +--- +id: beta-list-form-definitions-by-tenant-response +title: ListFormDefinitionsByTenantResponse +pagination_label: ListFormDefinitionsByTenantResponse +sidebar_label: ListFormDefinitionsByTenantResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ListFormDefinitionsByTenantResponse', 'BetaListFormDefinitionsByTenantResponse'] +slug: /tools/sdk/powershell/beta/models/list-form-definitions-by-tenant-response +tags: ['SDK', 'Software Development Kit', 'ListFormDefinitionsByTenantResponse', 'BetaListFormDefinitionsByTenantResponse'] +--- + + +# ListFormDefinitionsByTenantResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | Pointer to **Int64** | Count number of results. | [optional] +**Results** | Pointer to [**[]FormDefinitionResponse**](form-definition-response) | List of FormDefinitionResponse items. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ListFormDefinitionsByTenantResponse = Initialize-PSSailpoint.BetaListFormDefinitionsByTenantResponse -Count 1 ` + -Results null +``` + +- Convert the resource to JSON +```powershell +$ListFormDefinitionsByTenantResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ListFormElementDataByElementIDResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ListFormElementDataByElementIDResponse.md new file mode 100644 index 000000000..0ec2f7707 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ListFormElementDataByElementIDResponse.md @@ -0,0 +1,35 @@ +--- +id: beta-list-form-element-data-by-element-id-response +title: ListFormElementDataByElementIDResponse +pagination_label: ListFormElementDataByElementIDResponse +sidebar_label: ListFormElementDataByElementIDResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ListFormElementDataByElementIDResponse', 'BetaListFormElementDataByElementIDResponse'] +slug: /tools/sdk/powershell/beta/models/list-form-element-data-by-element-id-response +tags: ['SDK', 'Software Development Kit', 'ListFormElementDataByElementIDResponse', 'BetaListFormElementDataByElementIDResponse'] +--- + + +# ListFormElementDataByElementIDResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Results** | Pointer to [**[]FormElementDataSourceConfigOptions**](form-element-data-source-config-options) | Results holds a list of FormElementDataSourceConfigOptions items | [optional] + +## Examples + +- Prepare the resource +```powershell +$ListFormElementDataByElementIDResponse = Initialize-PSSailpoint.BetaListFormElementDataByElementIDResponse -Results {"results":[{"label":"Alfred 255e71dfc6e","subLabel":"Alfred.255e71dfc6e@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16676"},{"label":"Alize eba9d4cd27da","subLabel":"Alize.eba9d4cd27da@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f1667c"},{"label":"Antonina 01f69c3ea","subLabel":"Antonina.01f69c3ea@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f9667e"},{"label":"Ardella 21e78ce155","subLabel":"Ardella.21e78ce155@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e6667a"},{"label":"Arnaldo d8582b6e17","subLabel":"Arnaldo.d8582b6e17@testmail.identitysoon.com","value":"2c918084821847c5018227ced3426686"},{"label":"Aurelia admin24828","subLabel":"Aurelia.admin24828@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16674"},{"label":"Barbara 72ca418fdd","subLabel":"Barbara.72ca418fdd@testmail.identitysoon.com","value":"2c918084821847c5018227ced2fb6680"},{"label":"Barbara ee1a2436ee","subLabel":"Barbara.ee1a2436ee@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e56678"},{"label":"Baylee 652d72432f3","subLabel":"Baylee.652d72432f3@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aee"},{"label":"Brock e76b56ae4d49","subLabel":"Brock.e76b56ae4d49@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aef"}]} +``` + +- Convert the resource to JSON +```powershell +$ListFormElementDataByElementIDResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ListIdentityAccessItems200ResponseInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ListIdentityAccessItems200ResponseInner.md new file mode 100644 index 000000000..a19111f87 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ListIdentityAccessItems200ResponseInner.md @@ -0,0 +1,71 @@ +--- +id: beta-list-identity-access-items200-response-inner +title: ListIdentityAccessItems200ResponseInner +pagination_label: ListIdentityAccessItems200ResponseInner +sidebar_label: ListIdentityAccessItems200ResponseInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ListIdentityAccessItems200ResponseInner', 'BetaListIdentityAccessItems200ResponseInner'] +slug: /tools/sdk/powershell/beta/models/list-identity-access-items200-response-inner +tags: ['SDK', 'Software Development Kit', 'ListIdentityAccessItems200ResponseInner', 'BetaListIdentityAccessItems200ResponseInner'] +--- + + +# ListIdentityAccessItems200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **String** | the access item type. role in this case | [optional] +**Id** | Pointer to **String** | the access item id | [optional] +**Name** | Pointer to **String** | the access profile name | [optional] +**SourceName** | Pointer to **String** | the associated source name if it exists | [optional] +**SourceId** | Pointer to **String** | the id of the source | [optional] +**Description** | Pointer to **String** | the description for the role | [optional] +**DisplayName** | Pointer to **String** | the role display name | [optional] +**EntitlementCount** | Pointer to **String** | the number of entitlements the account will create | [optional] +**AppDisplayName** | Pointer to **String** | the name of | [optional] +**RemoveDate** | Pointer to **String** | the date the role is no longer assigned to the specified identity | [optional] +**Standalone** | **Boolean** | indicates whether the entitlement is standalone | [required] +**Revocable** | **Boolean** | indicates whether the role is revocable | [required] +**NativeIdentity** | Pointer to **String** | the native identifier used to uniquely identify an acccount | [optional] +**AppRoleId** | Pointer to **String** | the app role id | [optional] +**Attribute** | Pointer to **String** | the entitlement attribute | [optional] +**Value** | Pointer to **String** | the associated value | [optional] +**EntitlementType** | Pointer to **String** | the type of entitlement | [optional] +**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required] +**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required] + +## Examples + +- Prepare the resource +```powershell +$ListIdentityAccessItems200ResponseInner = Initialize-PSSailpoint.BetaListIdentityAccessItems200ResponseInner -AccessType role ` + -Id 2c918087763e69d901763e72e97f006f ` + -Name sample ` + -SourceName Source Name ` + -SourceId 2793o32dwd ` + -Description Role - Workday/Citizenship access ` + -DisplayName sample ` + -EntitlementCount 12 ` + -AppDisplayName AppName ` + -RemoveDate 2024-07-01T06:00:00.00Z ` + -Standalone true ` + -Revocable true ` + -NativeIdentity dr.arden.ogahn.d ` + -AppRoleId 2c918087763e69d901763e72e97f006f ` + -Attribute groups ` + -Value Upward mobility access ` + -EntitlementType entitlement ` + -Privileged false ` + -CloudGoverned true +``` + +- Convert the resource to JSON +```powershell +$ListIdentityAccessItems200ResponseInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ListPredefinedSelectOptionsResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ListPredefinedSelectOptionsResponse.md new file mode 100644 index 000000000..d4ce0298d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ListPredefinedSelectOptionsResponse.md @@ -0,0 +1,35 @@ +--- +id: beta-list-predefined-select-options-response +title: ListPredefinedSelectOptionsResponse +pagination_label: ListPredefinedSelectOptionsResponse +sidebar_label: ListPredefinedSelectOptionsResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ListPredefinedSelectOptionsResponse', 'BetaListPredefinedSelectOptionsResponse'] +slug: /tools/sdk/powershell/beta/models/list-predefined-select-options-response +tags: ['SDK', 'Software Development Kit', 'ListPredefinedSelectOptionsResponse', 'BetaListPredefinedSelectOptionsResponse'] +--- + + +# ListPredefinedSelectOptionsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Results** | Pointer to **[]String** | Results holds a list of PreDefinedSelectOption items | [optional] + +## Examples + +- Prepare the resource +```powershell +$ListPredefinedSelectOptionsResponse = Initialize-PSSailpoint.BetaListPredefinedSelectOptionsResponse -Results null +``` + +- Convert the resource to JSON +```powershell +$ListPredefinedSelectOptionsResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ListWorkgroupMembers200ResponseInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ListWorkgroupMembers200ResponseInner.md new file mode 100644 index 000000000..e3161c6fb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ListWorkgroupMembers200ResponseInner.md @@ -0,0 +1,41 @@ +--- +id: beta-list-workgroup-members200-response-inner +title: ListWorkgroupMembers200ResponseInner +pagination_label: ListWorkgroupMembers200ResponseInner +sidebar_label: ListWorkgroupMembers200ResponseInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ListWorkgroupMembers200ResponseInner', 'BetaListWorkgroupMembers200ResponseInner'] +slug: /tools/sdk/powershell/beta/models/list-workgroup-members200-response-inner +tags: ['SDK', 'Software Development Kit', 'ListWorkgroupMembers200ResponseInner', 'BetaListWorkgroupMembers200ResponseInner'] +--- + + +# ListWorkgroupMembers200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Workgroup member identity DTO type. | [optional] +**Id** | Pointer to **String** | Workgroup member identity ID. | [optional] +**Name** | Pointer to **String** | Workgroup member identity display name. | [optional] +**Email** | Pointer to **String** | Workgroup member identity email. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ListWorkgroupMembers200ResponseInner = Initialize-PSSailpoint.BetaListWorkgroupMembers200ResponseInner -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels ` + -Email michael.michaels@sailpoint.com +``` + +- Convert the resource to JSON +```powershell +$ListWorkgroupMembers200ResponseInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadAccountsTask.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadAccountsTask.md new file mode 100644 index 000000000..358818940 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadAccountsTask.md @@ -0,0 +1,37 @@ +--- +id: beta-load-accounts-task +title: LoadAccountsTask +pagination_label: LoadAccountsTask +sidebar_label: LoadAccountsTask +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LoadAccountsTask', 'BetaLoadAccountsTask'] +slug: /tools/sdk/powershell/beta/models/load-accounts-task +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTask', 'BetaLoadAccountsTask'] +--- + + +# LoadAccountsTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Success** | Pointer to **Boolean** | The status of the result | [optional] [default to $true] +**Task** | Pointer to [**LoadAccountsTaskTask**](load-accounts-task-task) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$LoadAccountsTask = Initialize-PSSailpoint.BetaLoadAccountsTask -Success true ` + -Task null +``` + +- Convert the resource to JSON +```powershell +$LoadAccountsTask | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadAccountsTaskTask.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadAccountsTaskTask.md new file mode 100644 index 000000000..8cdd51292 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadAccountsTaskTask.md @@ -0,0 +1,61 @@ +--- +id: beta-load-accounts-task-task +title: LoadAccountsTaskTask +pagination_label: LoadAccountsTaskTask +sidebar_label: LoadAccountsTaskTask +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LoadAccountsTaskTask', 'BetaLoadAccountsTaskTask'] +slug: /tools/sdk/powershell/beta/models/load-accounts-task-task +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTask', 'BetaLoadAccountsTaskTask'] +--- + + +# LoadAccountsTaskTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | System-generated unique ID of the task this taskStatus represents | [optional] +**Type** | Pointer to **String** | Type of task this task represents | [optional] +**Name** | Pointer to **String** | The name of the aggregation process | [optional] +**Description** | Pointer to **String** | The description of the task | [optional] +**Launcher** | Pointer to **String** | The user who initiated the task | [optional] +**Created** | Pointer to **System.DateTime** | The Task creation date | [optional] +**Launched** | Pointer to **System.DateTime** | The task start date | [optional] +**Completed** | Pointer to **System.DateTime** | The task completion date | [optional] +**CompletionStatus** | Pointer to **Enum** [ "SUCCESS", "WARNING", "ERROR", "TERMINATED", "TEMP_ERROR" ] | Task completion status. | [optional] +**ParentName** | Pointer to **String** | Name of the parent task if exists. | [optional] +**Messages** | Pointer to [**[]LoadAccountsTaskTaskMessagesInner**](load-accounts-task-task-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional] +**Progress** | Pointer to **String** | Current task state. | [optional] +**Attributes** | Pointer to [**LoadAccountsTaskTaskAttributes**](load-accounts-task-task-attributes) | | [optional] +**Returns** | Pointer to [**[]LoadAccountsTaskTaskReturnsInner**](load-accounts-task-task-returns-inner) | Return values from the task | [optional] + +## Examples + +- Prepare the resource +```powershell +$LoadAccountsTaskTask = Initialize-PSSailpoint.BetaLoadAccountsTaskTask -Id ef38f94347e94562b5bb8424a56397d8 ` + -Type QUARTZ ` + -Name Cloud Account Aggregation ` + -Description Aggregate from the specified application ` + -Launcher John Doe ` + -Created null ` + -Launched null ` + -Completed null ` + -CompletionStatus Success ` + -ParentName Audit Report ` + -Messages [] ` + -Progress Initializing... ` + -Attributes null ` + -Returns null +``` + +- Convert the resource to JSON +```powershell +$LoadAccountsTaskTask | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadAccountsTaskTaskAttributes.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadAccountsTaskTaskAttributes.md new file mode 100644 index 000000000..c0c4d9283 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadAccountsTaskTaskAttributes.md @@ -0,0 +1,37 @@ +--- +id: beta-load-accounts-task-task-attributes +title: LoadAccountsTaskTaskAttributes +pagination_label: LoadAccountsTaskTaskAttributes +sidebar_label: LoadAccountsTaskTaskAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LoadAccountsTaskTaskAttributes', 'BetaLoadAccountsTaskTaskAttributes'] +slug: /tools/sdk/powershell/beta/models/load-accounts-task-task-attributes +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTaskAttributes', 'BetaLoadAccountsTaskTaskAttributes'] +--- + + +# LoadAccountsTaskTaskAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AppId** | Pointer to **String** | The id of the source | [optional] +**OptimizedAggregation** | Pointer to **String** | The indicator if the aggregation process was enabled/disabled for the aggregation job | [optional] + +## Examples + +- Prepare the resource +```powershell +$LoadAccountsTaskTaskAttributes = Initialize-PSSailpoint.BetaLoadAccountsTaskTaskAttributes -AppId c31386cb18bb403cbb6df4c86294ff82 ` + -OptimizedAggregation enabled +``` + +- Convert the resource to JSON +```powershell +$LoadAccountsTaskTaskAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadAccountsTaskTaskMessagesInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadAccountsTaskTaskMessagesInner.md new file mode 100644 index 000000000..b601900fb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadAccountsTaskTaskMessagesInner.md @@ -0,0 +1,43 @@ +--- +id: beta-load-accounts-task-task-messages-inner +title: LoadAccountsTaskTaskMessagesInner +pagination_label: LoadAccountsTaskTaskMessagesInner +sidebar_label: LoadAccountsTaskTaskMessagesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LoadAccountsTaskTaskMessagesInner', 'BetaLoadAccountsTaskTaskMessagesInner'] +slug: /tools/sdk/powershell/beta/models/load-accounts-task-task-messages-inner +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTaskMessagesInner', 'BetaLoadAccountsTaskTaskMessagesInner'] +--- + + +# LoadAccountsTaskTaskMessagesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "INFO", "WARN", "ERROR" ] | Type of the message. | [optional] +**VarError** | Pointer to **Boolean** | Flag whether message is an error. | [optional] [default to $false] +**Warning** | Pointer to **Boolean** | Flag whether message is a warning. | [optional] [default to $false] +**Key** | Pointer to **String** | Message string identifier. | [optional] +**LocalizedText** | Pointer to **String** | Message context with the locale based language. | [optional] + +## Examples + +- Prepare the resource +```powershell +$LoadAccountsTaskTaskMessagesInner = Initialize-PSSailpoint.BetaLoadAccountsTaskTaskMessagesInner -Type WARN ` + -VarError false ` + -Warning true ` + -Key This aggregation failed because the currently running aggregation must complete before the next one can start. ` + -LocalizedText This aggregation failed because the currently running aggregation must complete before the next one can start. +``` + +- Convert the resource to JSON +```powershell +$LoadAccountsTaskTaskMessagesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadAccountsTaskTaskReturnsInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadAccountsTaskTaskReturnsInner.md new file mode 100644 index 000000000..9b3b349b9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadAccountsTaskTaskReturnsInner.md @@ -0,0 +1,37 @@ +--- +id: beta-load-accounts-task-task-returns-inner +title: LoadAccountsTaskTaskReturnsInner +pagination_label: LoadAccountsTaskTaskReturnsInner +sidebar_label: LoadAccountsTaskTaskReturnsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LoadAccountsTaskTaskReturnsInner', 'BetaLoadAccountsTaskTaskReturnsInner'] +slug: /tools/sdk/powershell/beta/models/load-accounts-task-task-returns-inner +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTaskReturnsInner', 'BetaLoadAccountsTaskTaskReturnsInner'] +--- + + +# LoadAccountsTaskTaskReturnsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayLabel** | Pointer to **String** | The display label of the return value | [optional] +**AttributeName** | Pointer to **String** | The attribute name of the return value | [optional] + +## Examples + +- Prepare the resource +```powershell +$LoadAccountsTaskTaskReturnsInner = Initialize-PSSailpoint.BetaLoadAccountsTaskTaskReturnsInner -DisplayLabel TASK_OUT_ACCOUNT_AGGREGATION_APPLICATIONS ` + -AttributeName applications +``` + +- Convert the resource to JSON +```powershell +$LoadAccountsTaskTaskReturnsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadEntitlementTask.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadEntitlementTask.md new file mode 100644 index 000000000..f919d8eed --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadEntitlementTask.md @@ -0,0 +1,47 @@ +--- +id: beta-load-entitlement-task +title: LoadEntitlementTask +pagination_label: LoadEntitlementTask +sidebar_label: LoadEntitlementTask +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LoadEntitlementTask', 'BetaLoadEntitlementTask'] +slug: /tools/sdk/powershell/beta/models/load-entitlement-task +tags: ['SDK', 'Software Development Kit', 'LoadEntitlementTask', 'BetaLoadEntitlementTask'] +--- + + +# LoadEntitlementTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | System-generated unique ID of the task this taskStatus represents | [optional] +**Type** | Pointer to **String** | Type of task this task represents | [optional] +**UniqueName** | Pointer to **String** | The name of the task | [optional] +**Description** | Pointer to **String** | The description of the task | [optional] +**Launcher** | Pointer to **String** | The user who initiated the task | [optional] +**Created** | Pointer to **System.DateTime** | The creation date of the task | [optional] +**Returns** | Pointer to [**[]LoadEntitlementTaskReturnsInner**](load-entitlement-task-returns-inner) | Return values from the task | [optional] + +## Examples + +- Prepare the resource +```powershell +$LoadEntitlementTask = Initialize-PSSailpoint.BetaLoadEntitlementTask -Id ef38f94347e94562b5bb8424a56397d8 ` + -Type QUARTZ ` + -UniqueName Cloud Group Aggregation ` + -Description Aggregate from the specified application ` + -Launcher John Doe ` + -Created 2020-07-11T21:23:15Z ` + -Returns [{displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_APPLICATIONS, attributeName=applications}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_TOTAL, attributeName=total}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_CREATED, attributeName=groupsCreated}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_UPDATED, attributeName=groupsUpdated}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_DELETED, attributeName=groupsDeleted}] +``` + +- Convert the resource to JSON +```powershell +$LoadEntitlementTask | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadEntitlementTaskReturnsInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadEntitlementTaskReturnsInner.md new file mode 100644 index 000000000..1658c39fa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadEntitlementTaskReturnsInner.md @@ -0,0 +1,37 @@ +--- +id: beta-load-entitlement-task-returns-inner +title: LoadEntitlementTaskReturnsInner +pagination_label: LoadEntitlementTaskReturnsInner +sidebar_label: LoadEntitlementTaskReturnsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LoadEntitlementTaskReturnsInner', 'BetaLoadEntitlementTaskReturnsInner'] +slug: /tools/sdk/powershell/beta/models/load-entitlement-task-returns-inner +tags: ['SDK', 'Software Development Kit', 'LoadEntitlementTaskReturnsInner', 'BetaLoadEntitlementTaskReturnsInner'] +--- + + +# LoadEntitlementTaskReturnsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayLabel** | Pointer to **String** | The display label for the return value | [optional] +**AttributeName** | Pointer to **String** | The attribute name for the return value | [optional] + +## Examples + +- Prepare the resource +```powershell +$LoadEntitlementTaskReturnsInner = Initialize-PSSailpoint.BetaLoadEntitlementTaskReturnsInner -DisplayLabel TASK_OUT_ACCOUNT_GROUP_AGGREGATION_APPLICATIONS ` + -AttributeName applications +``` + +- Convert the resource to JSON +```powershell +$LoadEntitlementTaskReturnsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadUncorrelatedAccountsTask.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadUncorrelatedAccountsTask.md new file mode 100644 index 000000000..1fab49ff7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadUncorrelatedAccountsTask.md @@ -0,0 +1,37 @@ +--- +id: beta-load-uncorrelated-accounts-task +title: LoadUncorrelatedAccountsTask +pagination_label: LoadUncorrelatedAccountsTask +sidebar_label: LoadUncorrelatedAccountsTask +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LoadUncorrelatedAccountsTask', 'BetaLoadUncorrelatedAccountsTask'] +slug: /tools/sdk/powershell/beta/models/load-uncorrelated-accounts-task +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTask', 'BetaLoadUncorrelatedAccountsTask'] +--- + + +# LoadUncorrelatedAccountsTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Success** | Pointer to **Boolean** | The status of the result | [optional] [default to $true] +**Task** | Pointer to [**LoadUncorrelatedAccountsTaskTask**](load-uncorrelated-accounts-task-task) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$LoadUncorrelatedAccountsTask = Initialize-PSSailpoint.BetaLoadUncorrelatedAccountsTask -Success true ` + -Task null +``` + +- Convert the resource to JSON +```powershell +$LoadUncorrelatedAccountsTask | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadUncorrelatedAccountsTaskTask.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadUncorrelatedAccountsTaskTask.md new file mode 100644 index 000000000..6d2c61de6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadUncorrelatedAccountsTaskTask.md @@ -0,0 +1,61 @@ +--- +id: beta-load-uncorrelated-accounts-task-task +title: LoadUncorrelatedAccountsTaskTask +pagination_label: LoadUncorrelatedAccountsTaskTask +sidebar_label: LoadUncorrelatedAccountsTaskTask +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LoadUncorrelatedAccountsTaskTask', 'BetaLoadUncorrelatedAccountsTaskTask'] +slug: /tools/sdk/powershell/beta/models/load-uncorrelated-accounts-task-task +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTaskTask', 'BetaLoadUncorrelatedAccountsTaskTask'] +--- + + +# LoadUncorrelatedAccountsTaskTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | System-generated unique ID of the task this taskStatus represents | [optional] +**Type** | Pointer to **String** | Type of task this task represents | [optional] +**Name** | Pointer to **String** | The name of uncorrelated accounts process | [optional] +**Description** | Pointer to **String** | The description of the task | [optional] +**Launcher** | Pointer to **String** | The user who initiated the task | [optional] +**Created** | Pointer to **System.DateTime** | The Task creation date | [optional] +**Launched** | Pointer to **System.DateTime** | The task start date | [optional] +**Completed** | Pointer to **System.DateTime** | The task completion date | [optional] +**CompletionStatus** | Pointer to **Enum** [ "SUCCESS", "WARNING", "ERROR", "TERMINATED", "TEMP_ERROR" ] | Task completion status. | [optional] +**ParentName** | Pointer to **String** | Name of the parent task if exists. | [optional] +**Messages** | Pointer to [**[]LoadUncorrelatedAccountsTaskTaskMessagesInner**](load-uncorrelated-accounts-task-task-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional] +**Progress** | Pointer to **String** | Current task state. | [optional] +**Attributes** | Pointer to [**LoadUncorrelatedAccountsTaskTaskAttributes**](load-uncorrelated-accounts-task-task-attributes) | | [optional] +**Returns** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Return values from the task | [optional] + +## Examples + +- Prepare the resource +```powershell +$LoadUncorrelatedAccountsTaskTask = Initialize-PSSailpoint.BetaLoadUncorrelatedAccountsTaskTask -Id 90b83a6bb737489494794f84cd3a51e6 ` + -Type QUARTZ ` + -Name Cloud Process Uncorrelated Accounts ` + -Description Processes uncorrelated accounts for the specified application. ` + -Launcher John Doe ` + -Created null ` + -Launched null ` + -Completed null ` + -CompletionStatus Success ` + -ParentName Audit Report ` + -Messages [] ` + -Progress Initializing... ` + -Attributes null ` + -Returns [{displayLabel=TASK_OUT_ACCOUNT_CORRELATION_APPLICATIONS, attributeName=applications}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_TOTAL, attributeName=total}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_IGNORED, attributeName=correlationFailures}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_FAILURES, attributeName=ignored}, {displayLabel=TASK_OUT_UNCHANGED_ACCOUNTS, attributeName=optimized}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION__CREATED, attributeName=created}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_UPDATED, attributeName=updated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_DELETED, attributeName=deleted}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGER_CHANGES, attributeName=managerChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_BUSINESS_ROLE_CHANGES, attributeName=detectedRoleChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_EXCEPTION_CHANGES, attributeName=exceptionChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICIES, attributeName=policies}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICY_VIOLATIONS, attributeName=policyViolations}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICY_NOTIFICATIONS, attributeName=policyNotifications}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCORES_CHANGED, attributeName=scoresChanged}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SNAPSHOTS_CREATED, attributeName=snapshotsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_CREATED, attributeName=scopesCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_CORRELATED, attributeName=scopesCorrelated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_SELECTED, attributeName=scopesSelected}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_DORMANT, attributeName=scopesDormant}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_UNSCOPED_IDENTITIES, attributeName=unscopedIdentities}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_CERTIFICATIONS_CREATED, attributeName=certificationsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_CERTIFICATIONS_DELETED, attributeName=certificationsDeleted}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_APPLICATIONS_GENERATED, attributeName=applicationsGenerated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGED_ATTRIBUTES_PROMOTED, attributeName=managedAttributesCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGED_ATTRIBUTES_PROMOTED_BY_APP, attributeName=managedAttributesCreatedByApplication}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_IDENTITYENTITLEMENTS_CREATED, attributeName=identityEntitlementsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_GROUPS_CREATED, attributeName=groupsCreated}] +``` + +- Convert the resource to JSON +```powershell +$LoadUncorrelatedAccountsTaskTask | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadUncorrelatedAccountsTaskTaskAttributes.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadUncorrelatedAccountsTaskTaskAttributes.md new file mode 100644 index 000000000..818e13b5e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadUncorrelatedAccountsTaskTaskAttributes.md @@ -0,0 +1,37 @@ +--- +id: beta-load-uncorrelated-accounts-task-task-attributes +title: LoadUncorrelatedAccountsTaskTaskAttributes +pagination_label: LoadUncorrelatedAccountsTaskTaskAttributes +sidebar_label: LoadUncorrelatedAccountsTaskTaskAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LoadUncorrelatedAccountsTaskTaskAttributes', 'BetaLoadUncorrelatedAccountsTaskTaskAttributes'] +slug: /tools/sdk/powershell/beta/models/load-uncorrelated-accounts-task-task-attributes +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTaskTaskAttributes', 'BetaLoadUncorrelatedAccountsTaskTaskAttributes'] +--- + + +# LoadUncorrelatedAccountsTaskTaskAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**QpocJobId** | Pointer to **String** | The id of qpoc job | [optional] +**TaskStartDelay** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | the task start delay value | [optional] + +## Examples + +- Prepare the resource +```powershell +$LoadUncorrelatedAccountsTaskTaskAttributes = Initialize-PSSailpoint.BetaLoadUncorrelatedAccountsTaskTaskAttributes -QpocJobId 5d303d46-fc51-48cd-9c6d-4e211e3ab63c ` + -TaskStartDelay +``` + +- Convert the resource to JSON +```powershell +$LoadUncorrelatedAccountsTaskTaskAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadUncorrelatedAccountsTaskTaskMessagesInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadUncorrelatedAccountsTaskTaskMessagesInner.md new file mode 100644 index 000000000..2762335c7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LoadUncorrelatedAccountsTaskTaskMessagesInner.md @@ -0,0 +1,43 @@ +--- +id: beta-load-uncorrelated-accounts-task-task-messages-inner +title: LoadUncorrelatedAccountsTaskTaskMessagesInner +pagination_label: LoadUncorrelatedAccountsTaskTaskMessagesInner +sidebar_label: LoadUncorrelatedAccountsTaskTaskMessagesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LoadUncorrelatedAccountsTaskTaskMessagesInner', 'BetaLoadUncorrelatedAccountsTaskTaskMessagesInner'] +slug: /tools/sdk/powershell/beta/models/load-uncorrelated-accounts-task-task-messages-inner +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTaskTaskMessagesInner', 'BetaLoadUncorrelatedAccountsTaskTaskMessagesInner'] +--- + + +# LoadUncorrelatedAccountsTaskTaskMessagesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "INFO", "WARN", "ERROR" ] | Type of the message. | [optional] +**VarError** | Pointer to **Boolean** | Flag whether message is an error. | [optional] [default to $false] +**Warning** | Pointer to **Boolean** | Flag whether message is a warning. | [optional] [default to $false] +**Key** | Pointer to **String** | Message string identifier. | [optional] +**LocalizedText** | Pointer to **String** | Message context with the locale based language. | [optional] + +## Examples + +- Prepare the resource +```powershell +$LoadUncorrelatedAccountsTaskTaskMessagesInner = Initialize-PSSailpoint.BetaLoadUncorrelatedAccountsTaskTaskMessagesInner -Type WARN ` + -VarError false ` + -Warning true ` + -Key This correlation failed because the currently running correlation must complete before the next one can start. ` + -LocalizedText This correlation failed because the currently running correlation must complete before the next one can start. +``` + +- Convert the resource to JSON +```powershell +$LoadUncorrelatedAccountsTaskTaskMessagesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LocaleOrigin.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LocaleOrigin.md new file mode 100644 index 000000000..c3baff2fa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LocaleOrigin.md @@ -0,0 +1,24 @@ +--- +id: beta-locale-origin +title: LocaleOrigin +pagination_label: LocaleOrigin +sidebar_label: LocaleOrigin +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LocaleOrigin', 'BetaLocaleOrigin'] +slug: /tools/sdk/powershell/beta/models/locale-origin +tags: ['SDK', 'Software Development Kit', 'LocaleOrigin', 'BetaLocaleOrigin'] +--- + + +# LocaleOrigin + +## Enum + + +* `DEFAULT` (value: `"DEFAULT"`) + +* `REQUEST` (value: `"REQUEST"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LocalizedMessage.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LocalizedMessage.md new file mode 100644 index 000000000..801f4c90e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LocalizedMessage.md @@ -0,0 +1,37 @@ +--- +id: beta-localized-message +title: LocalizedMessage +pagination_label: LocalizedMessage +sidebar_label: LocalizedMessage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LocalizedMessage', 'BetaLocalizedMessage'] +slug: /tools/sdk/powershell/beta/models/localized-message +tags: ['SDK', 'Software Development Kit', 'LocalizedMessage', 'BetaLocalizedMessage'] +--- + + +# LocalizedMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Locale** | **String** | Message locale | [required] +**Message** | **String** | Message text | [required] + +## Examples + +- Prepare the resource +```powershell +$LocalizedMessage = Initialize-PSSailpoint.BetaLocalizedMessage -Locale An error has occurred! ` + -Message Error has occurred! +``` + +- Convert the resource to JSON +```powershell +$LocalizedMessage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Lookup.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Lookup.md new file mode 100644 index 000000000..637f99de6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Lookup.md @@ -0,0 +1,39 @@ +--- +id: beta-lookup +title: Lookup +pagination_label: Lookup +sidebar_label: Lookup +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Lookup', 'BetaLookup'] +slug: /tools/sdk/powershell/beta/models/lookup +tags: ['SDK', 'Software Development Kit', 'Lookup', 'BetaLookup'] +--- + + +# Lookup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Table** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return ""Unknown Region"" for the attribute that is mapped to this transform. | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$Lookup = Initialize-PSSailpoint.BetaLookup -Table {USA=Americas, FRA=EMEA, AUS=APAC, default=Unknown Region} ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Lookup | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LookupStep.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LookupStep.md new file mode 100644 index 000000000..cc1e7a679 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/LookupStep.md @@ -0,0 +1,39 @@ +--- +id: beta-lookup-step +title: LookupStep +pagination_label: LookupStep +sidebar_label: LookupStep +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LookupStep', 'BetaLookupStep'] +slug: /tools/sdk/powershell/beta/models/lookup-step +tags: ['SDK', 'Software Development Kit', 'LookupStep', 'BetaLookupStep'] +--- + + +# LookupStep + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReassignedToId** | Pointer to **String** | The ID of the Identity who work is reassigned to | [optional] +**ReassignedFromId** | Pointer to **String** | The ID of the Identity who work is reassigned from | [optional] +**ReassignmentType** | Pointer to [**ReassignmentTypeEnum**](reassignment-type-enum) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$LookupStep = Initialize-PSSailpoint.BetaLookupStep -ReassignedToId 869320b6b6f34a169b6178b1a865e66f ` + -ReassignedFromId 51948a8f306a4e7a9a6f8f5d032fa59e ` + -ReassignmentType null +``` + +- Convert the resource to JSON +```powershell +$LookupStep | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Lower.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Lower.md new file mode 100644 index 000000000..7523f610a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Lower.md @@ -0,0 +1,37 @@ +--- +id: beta-lower +title: Lower +pagination_label: Lower +sidebar_label: Lower +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Lower', 'BetaLower'] +slug: /tools/sdk/powershell/beta/models/lower +tags: ['SDK', 'Software Development Kit', 'Lower', 'BetaLower'] +--- + + +# Lower + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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] + +## Examples + +- Prepare the resource +```powershell +$Lower = Initialize-PSSailpoint.BetaLower -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Lower | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MailFromAttributes.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MailFromAttributes.md new file mode 100644 index 000000000..5eb5a5f74 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MailFromAttributes.md @@ -0,0 +1,43 @@ +--- +id: beta-mail-from-attributes +title: MailFromAttributes +pagination_label: MailFromAttributes +sidebar_label: MailFromAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MailFromAttributes', 'BetaMailFromAttributes'] +slug: /tools/sdk/powershell/beta/models/mail-from-attributes +tags: ['SDK', 'Software Development Kit', 'MailFromAttributes', 'BetaMailFromAttributes'] +--- + + +# MailFromAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to **String** | The email identity | [optional] +**MailFromDomain** | Pointer to **String** | The name of a domain that an email identity uses as a custom MAIL FROM domain | [optional] +**MxRecord** | Pointer to **String** | MX record that is required in customer's DNS to allow the domain to receive bounce and complaint notifications that email providers send you | [optional] +**TxtRecord** | Pointer to **String** | TXT record that is required in customer's DNS in order to prove that Amazon SES is authorized to send email from your domain | [optional] +**MailFromDomainStatus** | Pointer to **Enum** [ "PENDING", "SUCCESS", "FAILED" ] | The current status of the MAIL FROM verification | [optional] + +## Examples + +- Prepare the resource +```powershell +$MailFromAttributes = Initialize-PSSailpoint.BetaMailFromAttributes -Identity bob.smith@sailpoint.com ` + -MailFromDomain foo.sailpoint.com ` + -MxRecord 10 feedback-smtp.us-east-1.amazonses.com ` + -TxtRecord v=spf1 include:amazonses.com ~all ` + -MailFromDomainStatus PENDING +``` + +- Convert the resource to JSON +```powershell +$MailFromAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MailFromAttributesDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MailFromAttributesDto.md new file mode 100644 index 000000000..e2927c704 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MailFromAttributesDto.md @@ -0,0 +1,37 @@ +--- +id: beta-mail-from-attributes-dto +title: MailFromAttributesDto +pagination_label: MailFromAttributesDto +sidebar_label: MailFromAttributesDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MailFromAttributesDto', 'BetaMailFromAttributesDto'] +slug: /tools/sdk/powershell/beta/models/mail-from-attributes-dto +tags: ['SDK', 'Software Development Kit', 'MailFromAttributesDto', 'BetaMailFromAttributesDto'] +--- + + +# MailFromAttributesDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to **String** | The identity or domain address | [optional] +**MailFromDomain** | Pointer to **String** | The new MAIL FROM domain of the identity. Must be a subdomain of the identity. | [optional] + +## Examples + +- Prepare the resource +```powershell +$MailFromAttributesDto = Initialize-PSSailpoint.BetaMailFromAttributesDto -Identity BobSmith@sailpoint.com ` + -MailFromDomain example.sailpoint.com +``` + +- Convert the resource to JSON +```powershell +$MailFromAttributesDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClient.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClient.md new file mode 100644 index 000000000..a74d72c60 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClient.md @@ -0,0 +1,67 @@ +--- +id: beta-managed-client +title: ManagedClient +pagination_label: ManagedClient +sidebar_label: ManagedClient +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClient', 'BetaManagedClient'] +slug: /tools/sdk/powershell/beta/models/managed-client +tags: ['SDK', 'Software Development Kit', 'ManagedClient', 'BetaManagedClient'] +--- + + +# ManagedClient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ManagedClient ID | [optional] [readonly] +**AlertKey** | Pointer to **String** | ManagedClient alert key | [optional] [readonly] +**ApiGatewayBaseUrl** | Pointer to **String** | ManagedClient gateway base url | [optional] [readonly] +**CcId** | Pointer to **Int64** | Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) | [optional] +**ClientId** | **String** | The client ID used in API management | [required] +**ClusterId** | **String** | Cluster ID that the ManagedClient is linked to | [required] +**Cookbook** | Pointer to **String** | VA cookbook | [optional] [readonly] +**Description** | **String** | ManagedClient description | [required] +**IpAddress** | Pointer to **String** | The public IP address of the ManagedClient | [optional] [readonly] +**LastSeen** | Pointer to **System.DateTime** | When the ManagedClient was last seen by the server | [optional] [readonly] +**Name** | Pointer to **String** | ManagedClient name | [optional] +**SinceLastSeen** | Pointer to **String** | Milliseconds since the ManagedClient has polled the server | [optional] [readonly] +**Status** | Pointer to [**ManagedClientStatusEnum**](managed-client-status-enum) | Status of the ManagedClient | [optional] [readonly] +**Type** | **String** | Type of the ManagedClient (VA, CCG) | [required] +**VaDownloadUrl** | Pointer to **String** | ManagedClient VA download URL | [optional] [readonly] +**VaVersion** | Pointer to **String** | Version that the ManagedClient's VA is running | [optional] [readonly] +**Secret** | Pointer to **String** | Client's apiKey | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagedClient = Initialize-PSSailpoint.BetaManagedClient -Id aClientId ` + -AlertKey anAlertKey ` + -ApiGatewayBaseUrl https://denali-xxx.api.cloud.sailpoint.com ` + -CcId 2248 ` + -ClientId aClientApiId ` + -ClusterId aClusterId ` + -Cookbook va-cookbook-info ` + -Description A short description of the ManagedClient ` + -IpAddress 123.456.78.90 ` + -LastSeen 2020-01-01T00:00Z ` + -Name aName ` + -SinceLastSeen 15000 ` + -Status null ` + -Type VA ` + -VaDownloadUrl aUrl ` + -VaVersion va-megapod-useast1-610-1621372012 ` + -Secret ef878e15eaa8c8d3e2fa52f41125e2a0eeadadc6a14f931a33ad3e1b62d56381 +``` + +- Convert the resource to JSON +```powershell +$ManagedClient | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClientStatus.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClientStatus.md new file mode 100644 index 000000000..489d3b529 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClientStatus.md @@ -0,0 +1,41 @@ +--- +id: beta-managed-client-status +title: ManagedClientStatus +pagination_label: ManagedClientStatus +sidebar_label: ManagedClientStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClientStatus', 'BetaManagedClientStatus'] +slug: /tools/sdk/powershell/beta/models/managed-client-status +tags: ['SDK', 'Software Development Kit', 'ManagedClientStatus', 'BetaManagedClientStatus'] +--- + + +# ManagedClientStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Body** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | ManagedClientStatus body information | [required] +**Status** | [**ManagedClientStatusEnum**](managed-client-status-enum) | | [required] +**Type** | [**ManagedClientType**](managed-client-type) | | [required] +**Timestamp** | **System.DateTime** | timestamp on the Client Status update | [required] + +## Examples + +- Prepare the resource +```powershell +$ManagedClientStatus = Initialize-PSSailpoint.BetaManagedClientStatus -Body {alertKey=, id=5678, clusterId=1234, ccg_etag=ccg_etag123xyz456, ccg_pin=NONE, cookbook_etag=20210420125956-20210511144538, hostname=megapod-useast1-secret-hostname.sailpoint.com, internal_ip=127.0.0.1, lastSeen=1620843964604, sinceSeen=14708, sinceSeenMillis=14708, localDev=false, stacktrace=, state=null, status=NORMAL, uuid=null, product=idn, va_version=null, platform_version=2, os_version=2345.3.1, os_type=flatcar, hypervisor=unknown} ` + -Status null ` + -Type null ` + -Timestamp 2020-01-01T00:00Z +``` + +- Convert the resource to JSON +```powershell +$ManagedClientStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClientStatusAggResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClientStatusAggResponse.md new file mode 100644 index 000000000..80810ec7c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClientStatusAggResponse.md @@ -0,0 +1,41 @@ +--- +id: beta-managed-client-status-agg-response +title: ManagedClientStatusAggResponse +pagination_label: ManagedClientStatusAggResponse +sidebar_label: ManagedClientStatusAggResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClientStatusAggResponse', 'BetaManagedClientStatusAggResponse'] +slug: /tools/sdk/powershell/beta/models/managed-client-status-agg-response +tags: ['SDK', 'Software Development Kit', 'ManagedClientStatusAggResponse', 'BetaManagedClientStatusAggResponse'] +--- + + +# ManagedClientStatusAggResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Body** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | ManagedClientStatus body information | [required] +**Status** | [**ManagedClientStatusEnum**](managed-client-status-enum) | | [required] +**Type** | [**ManagedClientType**](managed-client-type) | | [required] +**Timestamp** | **System.DateTime** | timestamp on the Client Status update | [required] + +## Examples + +- Prepare the resource +```powershell +$ManagedClientStatusAggResponse = Initialize-PSSailpoint.BetaManagedClientStatusAggResponse -Body {body={id=1528, clientId=1528, clusterId=1533, orgType=test, vaDownloadUrl=https://sptcbu-va-images.s3.amazonaws.com/va-latest.zip, clusterJobCount=1, configuration={clusterType=sqsCluster, clusterExternalId=2c91808876dd79120176f758af765c58, debug=false, failureThreshold=0, gmtOffset=-6, scheduleUpgrade=false, va_version=va-megapod-useast1-595-1627543540, jobType=VA_UPGRADE, cookbook=va-megapod-useast1-595-1627543540}, connectorServices=[{id=540696, name=EndToEnd-ADSource, connector_host=host.example.com, connector_port=389, connector_(boolean)useSSL=false, connectorFileUploadHistory=null}, {id=540698, name=EndToEnd-AzureADSource, connector_host=null, connector_port=null, connector_(boolean)useSSL=null, connectorFileUploadHistory=null}, {id=540710, name=EndToEnd-OpenLDAP, connector_host=10.0.2.64, connector_port=389, connector_(boolean)useSSL=false, connectorFileUploadHistory=null}, {id=540713, name=Dynamic-ADSource, connector_host=host.example.com, connector_port=389, connector_(boolean)useSSL=false, connectorFileUploadHistory=null}, {id=540716, name=EndToEnd-JdbcADSource, connector_host=10.0.5.187, connector_port=389, connector_(boolean)useSSL=false, connectorFileUploadHistory=null}, {id=540717, name=EndToEnd-JdbcSource, connector_host=null, connector_port=null, connector_(boolean)useSSL=null, connectorFileUploadHistory=[{serviceId=540717, date=2021-02-05T22:58:15Z, file=temp7081703651350031905mysql-connector-java-8.0.11.jar}]}], jobs=[{uuid=872b622f-5ab5-4836-9172-e3bb77f05b2c, cookbook=872b622f-5ab5-4836-9172-e3bb77f05b2c, state=FINISHED, type=VA_UPGRADE, targetId=1528, managedProcessConfiguration={charon={version=345, path=sailpoint/charon, description=null, dependencies=null}, ccg={version=415_583_79.0.0, path=sailpoint/ccg, description=null, dependencies=null}, toolbox={version=6, path=sailpoint/toolbox, description=null, dependencies=null}, fluent={version=50, path=fluent/va, description=null, dependencies=null}, va_agent={version=89, path=sailpoint/va_agent, description=null, dependencies=null}}}], queue={name=megapod-useast1-denali-lwt-cluster-1533, region=us-east-1}, maintenance={window=true, windowStartTime=2021-07-29T00:00:00Z, windowClusterTime=2021-07-29T01:35:24Z, windowFinishTime=2021-07-29T04:00:00Z}}} ` + -Status null ` + -Type null ` + -Timestamp 2020-01-01T00:00Z +``` + +- Convert the resource to JSON +```powershell +$ManagedClientStatusAggResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClientStatusEnum.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClientStatusEnum.md new file mode 100644 index 000000000..f4df092f4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClientStatusEnum.md @@ -0,0 +1,34 @@ +--- +id: beta-managed-client-status-enum +title: ManagedClientStatusEnum +pagination_label: ManagedClientStatusEnum +sidebar_label: ManagedClientStatusEnum +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClientStatusEnum', 'BetaManagedClientStatusEnum'] +slug: /tools/sdk/powershell/beta/models/managed-client-status-enum +tags: ['SDK', 'Software Development Kit', 'ManagedClientStatusEnum', 'BetaManagedClientStatusEnum'] +--- + + +# ManagedClientStatusEnum + +## Enum + + +* `NORMAL` (value: `"NORMAL"`) + +* `UNDEFINED` (value: `"UNDEFINED"`) + +* `NOT_CONFIGURED` (value: `"NOT_CONFIGURED"`) + +* `CONFIGURING` (value: `"CONFIGURING"`) + +* `WARNING` (value: `"WARNING"`) + +* `ERROR` (value: `"ERROR"`) + +* `FAILED` (value: `"FAILED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClientType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClientType.md new file mode 100644 index 000000000..5372ce7d7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClientType.md @@ -0,0 +1,28 @@ +--- +id: beta-managed-client-type +title: ManagedClientType +pagination_label: ManagedClientType +sidebar_label: ManagedClientType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClientType', 'BetaManagedClientType'] +slug: /tools/sdk/powershell/beta/models/managed-client-type +tags: ['SDK', 'Software Development Kit', 'ManagedClientType', 'BetaManagedClientType'] +--- + + +# ManagedClientType + +## Enum + + +* `CCG` (value: `"CCG"`) + +* `VA` (value: `"VA"`) + +* `INTERNAL` (value: `"INTERNAL"`) + +* `IIQ_HARVESTER` (value: `"IIQ_HARVESTER"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedCluster.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedCluster.md new file mode 100644 index 000000000..bd260438e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedCluster.md @@ -0,0 +1,83 @@ +--- +id: beta-managed-cluster +title: ManagedCluster +pagination_label: ManagedCluster +sidebar_label: ManagedCluster +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedCluster', 'BetaManagedCluster'] +slug: /tools/sdk/powershell/beta/models/managed-cluster +tags: ['SDK', 'Software Development Kit', 'ManagedCluster', 'BetaManagedCluster'] +--- + + +# ManagedCluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | ManagedCluster ID | [required] +**Name** | Pointer to **String** | ManagedCluster name | [optional] +**Pod** | Pointer to **String** | ManagedCluster pod | [optional] +**Org** | Pointer to **String** | ManagedCluster org | [optional] +**Type** | Pointer to [**ManagedClusterTypes**](managed-cluster-types) | | [optional] +**Configuration** | Pointer to **map[string]String** | ManagedProcess configuration map | [optional] +**KeyPair** | Pointer to [**ManagedClusterKeyPair**](managed-cluster-key-pair) | | [optional] +**Attributes** | Pointer to [**ManagedClusterAttributes**](managed-cluster-attributes) | | [optional] +**Description** | Pointer to **String** | ManagedCluster description | [optional] +**Redis** | Pointer to [**ManagedClusterRedis**](managed-cluster-redis) | | [optional] +**ClientType** | [**ManagedClientType**](managed-client-type) | | [required] +**CcgVersion** | **String** | CCG version used by the ManagedCluster | [required] +**PinnedConfig** | Pointer to **Boolean** | boolean flag indiacting whether or not the cluster configuration is pinned | [optional] [default to $false] +**LogConfiguration** | Pointer to [**ClientLogConfiguration**](client-log-configuration) | | [optional] +**Operational** | Pointer to **Boolean** | Whether or not the cluster is operational or not | [optional] [default to $false] +**Status** | Pointer to **String** | Cluster status | [optional] +**PublicKeyCertificate** | Pointer to **String** | Public key certificate | [optional] +**PublicKeyThumbprint** | Pointer to **String** | Public key thumbprint | [optional] +**PublicKey** | Pointer to **String** | Public key | [optional] +**AlertKey** | Pointer to **String** | Key describing any immediate cluster alerts | [optional] +**ClientIds** | Pointer to **[]String** | List of clients in a cluster | [optional] +**ServiceCount** | Pointer to **Int32** | Number of services bound to a cluster | [optional] [default to 0] +**CcId** | Pointer to **String** | CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished | [optional] [default to "0"] +**CreatedAt** | Pointer to **System.DateTime** | The date/time this cluster was created | [optional] +**UpdatedAt** | Pointer to **System.DateTime** | The date/time this cluster was last updated | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagedCluster = Initialize-PSSailpoint.BetaManagedCluster -Id aClusterId ` + -Name Managed Cluster Name ` + -Pod megapod-useast1 ` + -Org denali ` + -Type null ` + -Configuration {clusterExternalId=externalId, ccgVersion=77.0.0} ` + -KeyPair null ` + -Attributes null ` + -Description A short description of the managed cluster. ` + -Redis null ` + -ClientType null ` + -CcgVersion v01 ` + -PinnedConfig false ` + -LogConfiguration null ` + -Operational false ` + -Status NORMAL ` + -PublicKeyCertificate -----BEGIN CERTIFICATE-----TCCAb2gAwIBAgIBADANBgkqhkiG9w0BAQsFADAuMQ0wCwYDVQQD-----END CERTIFICATE----- ` + -PublicKeyThumbprint obc6pLiulGbtZ ` + -PublicKey -----BEGIN PUBLIC KEY-----jANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3WgnsxP52MDgBTfHR+5n4-----END PUBLIC KEY----- ` + -AlertKey LIMITED_RESOURCES ` + -ClientIds [1244, 1245] ` + -ServiceCount 6 ` + -CcId 1533 ` + -CreatedAt 2023-08-04T20:48:01.865Z ` + -UpdatedAt 2023-08-04T20:48:01.865Z +``` + +- Convert the resource to JSON +```powershell +$ManagedCluster | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClusterAttributes.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClusterAttributes.md new file mode 100644 index 000000000..c18c3ad3f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClusterAttributes.md @@ -0,0 +1,37 @@ +--- +id: beta-managed-cluster-attributes +title: ManagedClusterAttributes +pagination_label: ManagedClusterAttributes +sidebar_label: ManagedClusterAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterAttributes', 'BetaManagedClusterAttributes'] +slug: /tools/sdk/powershell/beta/models/managed-cluster-attributes +tags: ['SDK', 'Software Development Kit', 'ManagedClusterAttributes', 'BetaManagedClusterAttributes'] +--- + + +# ManagedClusterAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Queue** | Pointer to [**ManagedClusterQueue**](managed-cluster-queue) | | [optional] +**Keystore** | Pointer to **String** | ManagedCluster keystore for spConnectCluster type | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagedClusterAttributes = Initialize-PSSailpoint.BetaManagedClusterAttributes -Queue null ` + -Keystore /u3+7QAAAAIAAAABAAAAAQAvL3Byb3h5LWNsdXN0ZXIvMmM5MTgwODc3Yjg3MW +``` + +- Convert the resource to JSON +```powershell +$ManagedClusterAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClusterKeyPair.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClusterKeyPair.md new file mode 100644 index 000000000..f6d209a22 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClusterKeyPair.md @@ -0,0 +1,39 @@ +--- +id: beta-managed-cluster-key-pair +title: ManagedClusterKeyPair +pagination_label: ManagedClusterKeyPair +sidebar_label: ManagedClusterKeyPair +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterKeyPair', 'BetaManagedClusterKeyPair'] +slug: /tools/sdk/powershell/beta/models/managed-cluster-key-pair +tags: ['SDK', 'Software Development Kit', 'ManagedClusterKeyPair', 'BetaManagedClusterKeyPair'] +--- + + +# ManagedClusterKeyPair + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PublicKey** | Pointer to **String** | ManagedCluster publicKey | [optional] +**PublicKeyThumbprint** | Pointer to **String** | ManagedCluster publicKeyThumbprint | [optional] +**PublicKeyCertificate** | Pointer to **String** | ManagedCluster publicKeyCertificate | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagedClusterKeyPair = Initialize-PSSailpoint.BetaManagedClusterKeyPair -PublicKey -----BEGIN PUBLIC KEY-----******-----END PUBLIC KEY----- ` + -PublicKeyThumbprint 6CMlaJIV44-xJxcB3CJBjDUUn54 ` + -PublicKeyCertificate -----BEGIN CERTIFICATE-----****-----END CERTIFICATE----- +``` + +- Convert the resource to JSON +```powershell +$ManagedClusterKeyPair | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClusterQueue.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClusterQueue.md new file mode 100644 index 000000000..096fb8926 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClusterQueue.md @@ -0,0 +1,37 @@ +--- +id: beta-managed-cluster-queue +title: ManagedClusterQueue +pagination_label: ManagedClusterQueue +sidebar_label: ManagedClusterQueue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterQueue', 'BetaManagedClusterQueue'] +slug: /tools/sdk/powershell/beta/models/managed-cluster-queue +tags: ['SDK', 'Software Development Kit', 'ManagedClusterQueue', 'BetaManagedClusterQueue'] +--- + + +# ManagedClusterQueue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | ManagedCluster queue name | [optional] +**Region** | Pointer to **String** | ManagedCluster queue aws region | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagedClusterQueue = Initialize-PSSailpoint.BetaManagedClusterQueue -Name megapod-useast1-denali-lwt-cluster-1533 ` + -Region us-east-1 +``` + +- Convert the resource to JSON +```powershell +$ManagedClusterQueue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClusterRedis.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClusterRedis.md new file mode 100644 index 000000000..b43d4d5aa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClusterRedis.md @@ -0,0 +1,37 @@ +--- +id: beta-managed-cluster-redis +title: ManagedClusterRedis +pagination_label: ManagedClusterRedis +sidebar_label: ManagedClusterRedis +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterRedis', 'BetaManagedClusterRedis'] +slug: /tools/sdk/powershell/beta/models/managed-cluster-redis +tags: ['SDK', 'Software Development Kit', 'ManagedClusterRedis', 'BetaManagedClusterRedis'] +--- + + +# ManagedClusterRedis + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RedisHost** | Pointer to **String** | ManagedCluster redisHost | [optional] +**RedisPort** | Pointer to **Int32** | ManagedCluster redisPort | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagedClusterRedis = Initialize-PSSailpoint.BetaManagedClusterRedis -RedisHost megapod-useast1-shared-redis.cloud.sailpoint.com ` + -RedisPort 6379 +``` + +- Convert the resource to JSON +```powershell +$ManagedClusterRedis | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClusterTypes.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClusterTypes.md new file mode 100644 index 000000000..be6775f00 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagedClusterTypes.md @@ -0,0 +1,24 @@ +--- +id: beta-managed-cluster-types +title: ManagedClusterTypes +pagination_label: ManagedClusterTypes +sidebar_label: ManagedClusterTypes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterTypes', 'BetaManagedClusterTypes'] +slug: /tools/sdk/powershell/beta/models/managed-cluster-types +tags: ['SDK', 'Software Development Kit', 'ManagedClusterTypes', 'BetaManagedClusterTypes'] +--- + + +# ManagedClusterTypes + +## Enum + + +* `idn` (value: `"idn"`) + +* `iai` (value: `"iai"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagerCorrelationMapping.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagerCorrelationMapping.md new file mode 100644 index 000000000..becaa0c45 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManagerCorrelationMapping.md @@ -0,0 +1,37 @@ +--- +id: beta-manager-correlation-mapping +title: ManagerCorrelationMapping +pagination_label: ManagerCorrelationMapping +sidebar_label: ManagerCorrelationMapping +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagerCorrelationMapping', 'BetaManagerCorrelationMapping'] +slug: /tools/sdk/powershell/beta/models/manager-correlation-mapping +tags: ['SDK', 'Software Development Kit', 'ManagerCorrelationMapping', 'BetaManagerCorrelationMapping'] +--- + + +# ManagerCorrelationMapping + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountAttributeName** | Pointer to **String** | Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. | [optional] +**IdentityAttributeName** | Pointer to **String** | Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagerCorrelationMapping = Initialize-PSSailpoint.BetaManagerCorrelationMapping -AccountAttributeName manager ` + -IdentityAttributeName manager +``` + +- Convert the resource to JSON +```powershell +$ManagerCorrelationMapping | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManualDiscoverApplications.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManualDiscoverApplications.md new file mode 100644 index 000000000..79aaf2333 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManualDiscoverApplications.md @@ -0,0 +1,37 @@ +--- +id: beta-manual-discover-applications +title: ManualDiscoverApplications +pagination_label: ManualDiscoverApplications +sidebar_label: ManualDiscoverApplications +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManualDiscoverApplications', 'BetaManualDiscoverApplications'] +slug: /tools/sdk/powershell/beta/models/manual-discover-applications +tags: ['SDK', 'Software Development Kit', 'ManualDiscoverApplications', 'BetaManualDiscoverApplications'] +--- + + +# ManualDiscoverApplications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | **System.IO.FileInfo** | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. | [required] + +## Examples + +- Prepare the resource +```powershell +$ManualDiscoverApplications = Initialize-PSSailpoint.BetaManualDiscoverApplications -File application_name,description +"Sample App","This is a sample description for Sample App." +"Another App","Description for Another App." +``` + +- Convert the resource to JSON +```powershell +$ManualDiscoverApplications | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManualDiscoverApplicationsTemplate.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManualDiscoverApplicationsTemplate.md new file mode 100644 index 000000000..bc612bcd2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManualDiscoverApplicationsTemplate.md @@ -0,0 +1,37 @@ +--- +id: beta-manual-discover-applications-template +title: ManualDiscoverApplicationsTemplate +pagination_label: ManualDiscoverApplicationsTemplate +sidebar_label: ManualDiscoverApplicationsTemplate +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManualDiscoverApplicationsTemplate', 'BetaManualDiscoverApplicationsTemplate'] +slug: /tools/sdk/powershell/beta/models/manual-discover-applications-template +tags: ['SDK', 'Software Development Kit', 'ManualDiscoverApplicationsTemplate', 'BetaManualDiscoverApplicationsTemplate'] +--- + + +# ManualDiscoverApplicationsTemplate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationName** | Pointer to **String** | Name of the example application. | [optional] +**Description** | Pointer to **String** | Description of the example application. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManualDiscoverApplicationsTemplate = Initialize-PSSailpoint.BetaManualDiscoverApplicationsTemplate -ApplicationName Example Application ` + -Description Example Description +``` + +- Convert the resource to JSON +```powershell +$ManualDiscoverApplicationsTemplate | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManualWorkItemDetails.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManualWorkItemDetails.md new file mode 100644 index 000000000..54a5eabc2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManualWorkItemDetails.md @@ -0,0 +1,45 @@ +--- +id: beta-manual-work-item-details +title: ManualWorkItemDetails +pagination_label: ManualWorkItemDetails +sidebar_label: ManualWorkItemDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManualWorkItemDetails', 'BetaManualWorkItemDetails'] +slug: /tools/sdk/powershell/beta/models/manual-work-item-details +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetails', 'BetaManualWorkItemDetails'] +--- + + +# ManualWorkItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Forwarded** | Pointer to **Boolean** | True if the request for this item was forwarded from one owner to another. | [optional] [default to $false] +**OriginalOwner** | Pointer to [**ManualWorkItemDetailsOriginalOwner**](manual-work-item-details-original-owner) | | [optional] +**CurrentOwner** | Pointer to [**ManualWorkItemDetailsCurrentOwner**](manual-work-item-details-current-owner) | | [optional] +**Modified** | Pointer to **System.DateTime** | Time at which item was modified. | [optional] +**Status** | Pointer to [**ManualWorkItemState**](manual-work-item-state) | | [optional] +**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManualWorkItemDetails = Initialize-PSSailpoint.BetaManualWorkItemDetails -Forwarded true ` + -OriginalOwner null ` + -CurrentOwner null ` + -Modified 2019-08-23T18:52:57.398Z ` + -Status null ` + -ForwardHistory null +``` + +- Convert the resource to JSON +```powershell +$ManualWorkItemDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManualWorkItemDetailsCurrentOwner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManualWorkItemDetailsCurrentOwner.md new file mode 100644 index 000000000..035f09a53 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManualWorkItemDetailsCurrentOwner.md @@ -0,0 +1,39 @@ +--- +id: beta-manual-work-item-details-current-owner +title: ManualWorkItemDetailsCurrentOwner +pagination_label: ManualWorkItemDetailsCurrentOwner +sidebar_label: ManualWorkItemDetailsCurrentOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManualWorkItemDetailsCurrentOwner', 'BetaManualWorkItemDetailsCurrentOwner'] +slug: /tools/sdk/powershell/beta/models/manual-work-item-details-current-owner +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetailsCurrentOwner', 'BetaManualWorkItemDetailsCurrentOwner'] +--- + + +# ManualWorkItemDetailsCurrentOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP", "IDENTITY" ] | DTO type of current work item owner's identity. | [optional] +**Id** | Pointer to **String** | ID of current work item owner's identity. | [optional] +**Name** | Pointer to **String** | Display name of current work item owner. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManualWorkItemDetailsCurrentOwner = Initialize-PSSailpoint.BetaManualWorkItemDetailsCurrentOwner -Type IDENTITY ` + -Id 2c3780a46faadee4016fb4e018c20652 ` + -Name Allen Albertson +``` + +- Convert the resource to JSON +```powershell +$ManualWorkItemDetailsCurrentOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManualWorkItemDetailsOriginalOwner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManualWorkItemDetailsOriginalOwner.md new file mode 100644 index 000000000..0c377cd1f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManualWorkItemDetailsOriginalOwner.md @@ -0,0 +1,39 @@ +--- +id: beta-manual-work-item-details-original-owner +title: ManualWorkItemDetailsOriginalOwner +pagination_label: ManualWorkItemDetailsOriginalOwner +sidebar_label: ManualWorkItemDetailsOriginalOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManualWorkItemDetailsOriginalOwner', 'BetaManualWorkItemDetailsOriginalOwner'] +slug: /tools/sdk/powershell/beta/models/manual-work-item-details-original-owner +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetailsOriginalOwner', 'BetaManualWorkItemDetailsOriginalOwner'] +--- + + +# ManualWorkItemDetailsOriginalOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP", "IDENTITY" ] | DTO type of original work item owner's identity. | [optional] +**Id** | Pointer to **String** | ID of original work item owner's identity. | [optional] +**Name** | Pointer to **String** | Display name of original work item owner. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManualWorkItemDetailsOriginalOwner = Initialize-PSSailpoint.BetaManualWorkItemDetailsOriginalOwner -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$ManualWorkItemDetailsOriginalOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManualWorkItemState.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManualWorkItemState.md new file mode 100644 index 000000000..5c2b0e943 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManualWorkItemState.md @@ -0,0 +1,32 @@ +--- +id: beta-manual-work-item-state +title: ManualWorkItemState +pagination_label: ManualWorkItemState +sidebar_label: ManualWorkItemState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManualWorkItemState', 'BetaManualWorkItemState'] +slug: /tools/sdk/powershell/beta/models/manual-work-item-state +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemState', 'BetaManualWorkItemState'] +--- + + +# ManualWorkItemState + +## Enum + + +* `PENDING` (value: `"PENDING"`) + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `EXPIRED` (value: `"EXPIRED"`) + +* `CANCELLED` (value: `"CANCELLED"`) + +* `ARCHIVED` (value: `"ARCHIVED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManuallyUpdatedFieldsDTO.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManuallyUpdatedFieldsDTO.md new file mode 100644 index 000000000..6bdbeba45 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ManuallyUpdatedFieldsDTO.md @@ -0,0 +1,37 @@ +--- +id: beta-manually-updated-fields-dto +title: ManuallyUpdatedFieldsDTO +pagination_label: ManuallyUpdatedFieldsDTO +sidebar_label: ManuallyUpdatedFieldsDTO +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManuallyUpdatedFieldsDTO', 'BetaManuallyUpdatedFieldsDTO'] +slug: /tools/sdk/powershell/beta/models/manually-updated-fields-dto +tags: ['SDK', 'Software Development Kit', 'ManuallyUpdatedFieldsDTO', 'BetaManuallyUpdatedFieldsDTO'] +--- + + +# ManuallyUpdatedFieldsDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DISPLAYNAME** | Pointer to **Boolean** | True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `name` property. | [optional] [default to $false] +**DESCRIPTION** | Pointer to **Boolean** | True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `description` property. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$ManuallyUpdatedFieldsDTO = Initialize-PSSailpoint.BetaManuallyUpdatedFieldsDTO -DISPLAYNAME true ` + -DESCRIPTION true +``` + +- Convert the resource to JSON +```powershell +$ManuallyUpdatedFieldsDTO | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MatchTerm.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MatchTerm.md new file mode 100644 index 000000000..1e81b90dc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MatchTerm.md @@ -0,0 +1,45 @@ +--- +id: beta-match-term +title: MatchTerm +pagination_label: MatchTerm +sidebar_label: MatchTerm +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MatchTerm', 'BetaMatchTerm'] +slug: /tools/sdk/powershell/beta/models/match-term +tags: ['SDK', 'Software Development Kit', 'MatchTerm', 'BetaMatchTerm'] +--- + + +# MatchTerm + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The attribute name | [optional] +**Value** | Pointer to **String** | The attribute value | [optional] +**Op** | Pointer to **String** | The operator between name and value | [optional] +**Container** | Pointer to **Boolean** | If it is a container or a real match term | [optional] [default to $false] +**And** | Pointer to **Boolean** | If it is AND logical operator for the children match terms | [optional] [default to $false] +**Children** | Pointer to [**[]System.Collections.Hashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The children under this match term | [optional] + +## Examples + +- Prepare the resource +```powershell +$MatchTerm = Initialize-PSSailpoint.BetaMatchTerm -Name mail ` + -Value 1234 Albany Dr ` + -Op eq ` + -Container true ` + -And false ` + -Children [{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}] +``` + +- Convert the resource to JSON +```powershell +$MatchTerm | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Medium.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Medium.md new file mode 100644 index 000000000..b6b728613 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Medium.md @@ -0,0 +1,30 @@ +--- +id: beta-medium +title: Medium +pagination_label: Medium +sidebar_label: Medium +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Medium', 'BetaMedium'] +slug: /tools/sdk/powershell/beta/models/medium +tags: ['SDK', 'Software Development Kit', 'Medium', 'BetaMedium'] +--- + + +# Medium + +## Enum + + +* `EMAIL` (value: `"EMAIL"`) + +* `SMS` (value: `"SMS"`) + +* `PHONE` (value: `"PHONE"`) + +* `SLACK` (value: `"SLACK"`) + +* `TEAMS` (value: `"TEAMS"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MessageCatalogDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MessageCatalogDto.md new file mode 100644 index 000000000..f5d6da303 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MessageCatalogDto.md @@ -0,0 +1,37 @@ +--- +id: beta-message-catalog-dto +title: MessageCatalogDto +pagination_label: MessageCatalogDto +sidebar_label: MessageCatalogDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MessageCatalogDto', 'BetaMessageCatalogDto'] +slug: /tools/sdk/powershell/beta/models/message-catalog-dto +tags: ['SDK', 'Software Development Kit', 'MessageCatalogDto', 'BetaMessageCatalogDto'] +--- + + +# MessageCatalogDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Locale** | Pointer to **String** | The language in which the messages are returned | [optional] +**Messages** | Pointer to [**[]ResourceBundleMessage**](resource-bundle-message) | The list of message with their keys and formats | [optional] + +## Examples + +- Prepare the resource +```powershell +$MessageCatalogDto = Initialize-PSSailpoint.BetaMessageCatalogDto -Locale en_US ` + -Messages null +``` + +- Convert the resource to JSON +```powershell +$MessageCatalogDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MetricResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MetricResponse.md new file mode 100644 index 000000000..4c8a01681 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MetricResponse.md @@ -0,0 +1,37 @@ +--- +id: beta-metric-response +title: MetricResponse +pagination_label: MetricResponse +sidebar_label: MetricResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MetricResponse', 'BetaMetricResponse'] +slug: /tools/sdk/powershell/beta/models/metric-response +tags: ['SDK', 'Software Development Kit', 'MetricResponse', 'BetaMetricResponse'] +--- + + +# MetricResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | the name of metric | [optional] +**Value** | Pointer to **Decimal** | the value associated to the metric | [optional] + +## Examples + +- Prepare the resource +```powershell +$MetricResponse = Initialize-PSSailpoint.BetaMetricResponse -Name null ` + -Value null +``` + +- Convert the resource to JSON +```powershell +$MetricResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MfaConfigTestResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MfaConfigTestResponse.md new file mode 100644 index 000000000..7b4a5189b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MfaConfigTestResponse.md @@ -0,0 +1,37 @@ +--- +id: beta-mfa-config-test-response +title: MfaConfigTestResponse +pagination_label: MfaConfigTestResponse +sidebar_label: MfaConfigTestResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MfaConfigTestResponse', 'BetaMfaConfigTestResponse'] +slug: /tools/sdk/powershell/beta/models/mfa-config-test-response +tags: ['SDK', 'Software Development Kit', 'MfaConfigTestResponse', 'BetaMfaConfigTestResponse'] +--- + + +# MfaConfigTestResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **Enum** [ "SUCCESS", "FAILED" ] | The configuration test result. | [optional] [readonly] +**VarError** | Pointer to **String** | The error message to indicate the failure of configuration test. | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$MfaConfigTestResponse = Initialize-PSSailpoint.BetaMfaConfigTestResponse -State SUCCESS ` + -VarError MFA Method is disabled. +``` + +- Convert the resource to JSON +```powershell +$MfaConfigTestResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MfaDuoConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MfaDuoConfig.md new file mode 100644 index 000000000..a4ff72ac9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MfaDuoConfig.md @@ -0,0 +1,45 @@ +--- +id: beta-mfa-duo-config +title: MfaDuoConfig +pagination_label: MfaDuoConfig +sidebar_label: MfaDuoConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MfaDuoConfig', 'BetaMfaDuoConfig'] +slug: /tools/sdk/powershell/beta/models/mfa-duo-config +tags: ['SDK', 'Software Development Kit', 'MfaDuoConfig', 'BetaMfaDuoConfig'] +--- + + +# MfaDuoConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MfaMethod** | Pointer to **String** | Mfa method name | [optional] +**Enabled** | Pointer to **Boolean** | If MFA method is enabled. | [optional] [default to $false] +**VarHost** | Pointer to **String** | The server host name or IP address of the MFA provider. | [optional] +**AccessKey** | Pointer to **String** | The secret key for authenticating requests to the MFA provider. | [optional] +**IdentityAttribute** | Pointer to **String** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [optional] +**ConfigProperties** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map with additional config properties for the given MFA method - duo-web. | [optional] + +## Examples + +- Prepare the resource +```powershell +$MfaDuoConfig = Initialize-PSSailpoint.BetaMfaDuoConfig -MfaMethod duo-web ` + -Enabled true ` + -VarHost example.com ` + -AccessKey qw123Y3QlA5UqocYpdU3rEkzrK2D497y ` + -IdentityAttribute email ` + -ConfigProperties {skey=qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x, ikey=Q123WE45R6TY7890ZXCV} +``` + +- Convert the resource to JSON +```powershell +$MfaDuoConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MfaOktaConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MfaOktaConfig.md new file mode 100644 index 000000000..073d0c441 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MfaOktaConfig.md @@ -0,0 +1,43 @@ +--- +id: beta-mfa-okta-config +title: MfaOktaConfig +pagination_label: MfaOktaConfig +sidebar_label: MfaOktaConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MfaOktaConfig', 'BetaMfaOktaConfig'] +slug: /tools/sdk/powershell/beta/models/mfa-okta-config +tags: ['SDK', 'Software Development Kit', 'MfaOktaConfig', 'BetaMfaOktaConfig'] +--- + + +# MfaOktaConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MfaMethod** | Pointer to **String** | Mfa method name | [optional] +**Enabled** | Pointer to **Boolean** | If MFA method is enabled. | [optional] [default to $false] +**VarHost** | Pointer to **String** | The server host name or IP address of the MFA provider. | [optional] +**AccessKey** | Pointer to **String** | The secret key for authenticating requests to the MFA provider. | [optional] +**IdentityAttribute** | Pointer to **String** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [optional] + +## Examples + +- Prepare the resource +```powershell +$MfaOktaConfig = Initialize-PSSailpoint.BetaMfaOktaConfig -MfaMethod okta-verify ` + -Enabled true ` + -VarHost example.com ` + -AccessKey qw123Y3QlA5UqocYpdU3rEkzrK2D497y ` + -IdentityAttribute email +``` + +- Convert the resource to JSON +```powershell +$MfaOktaConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationTemplateType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationTemplateType.md new file mode 100644 index 000000000..830f757b7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationTemplateType.md @@ -0,0 +1,39 @@ +--- +id: beta-multi-host-integration-template-type +title: MultiHostIntegrationTemplateType +pagination_label: MultiHostIntegrationTemplateType +sidebar_label: MultiHostIntegrationTemplateType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationTemplateType', 'BetaMultiHostIntegrationTemplateType'] +slug: /tools/sdk/powershell/beta/models/multi-host-integration-template-type +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationTemplateType', 'BetaMultiHostIntegrationTemplateType'] +--- + + +# MultiHostIntegrationTemplateType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | This is the name of the type. | [optional] +**Type** | **String** | This is the type value for the type. | [required] +**ScriptName** | **String** | This is the scriptName attribute value for the type. | [required] + +## Examples + +- Prepare the resource +```powershell +$MultiHostIntegrationTemplateType = Initialize-PSSailpoint.BetaMultiHostIntegrationTemplateType -Name aName ` + -Type aType ` + -ScriptName aScriptName +``` + +- Convert the resource to JSON +```powershell +$MultiHostIntegrationTemplateType | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrations.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrations.md new file mode 100644 index 000000000..4aca3215a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrations.md @@ -0,0 +1,83 @@ +--- +id: beta-multi-host-integrations +title: MultiHostIntegrations +pagination_label: MultiHostIntegrations +sidebar_label: MultiHostIntegrations +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrations', 'BetaMultiHostIntegrations'] +slug: /tools/sdk/powershell/beta/models/multi-host-integrations +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrations', 'BetaMultiHostIntegrations'] +--- + + +# MultiHostIntegrations + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Multi-Host Integration ID. | [required][readonly] +**Name** | **String** | Multi-Host Integration's human-readable name. | [required] +**Description** | **String** | Multi-Host Integration's human-readable description. | [required] +**Owner** | [**MultiHostIntegrationsOwner**](multi-host-integrations-owner) | | [required] +**Cluster** | Pointer to [**MultiHostIntegrationsCluster**](multi-host-integrations-cluster) | | [optional] +**Type** | Pointer to **String** | Specifies the type of system being managed e.g. Workday, Multi-Host - Microsoft SQL Server, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional] +**Connector** | **String** | Connector script name. | [required] +**LastSourceUploadSuccessCount** | Pointer to **Int32** | Last successfully uploaded source count of given Multi-Host Integration. | [optional] +**MaxSourcesPerAggGroup** | Pointer to **Int32** | Maximum sources that can contain in a aggregation group of Multi-Host Integration. | [optional] +**ConnectorClass** | Pointer to **String** | Fully qualified name of the Java class that implements the connector interface. | [optional] +**ConnectorAttributes** | Pointer to [**MultiHostIntegrationsConnectorAttributes**](multi-host-integrations-connector-attributes) | | [optional] +**DeleteThreshold** | Pointer to **Int32** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional] +**Authoritative** | Pointer to **Boolean** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to $false] +**ManagementWorkgroup** | Pointer to [**MultiHostIntegrationsManagementWorkgroup**](multi-host-integrations-management-workgroup) | | [optional] +**Healthy** | Pointer to **Boolean** | When this is true, it indicates that the source is healthy. | [optional] [default to $false] +**Status** | Pointer to **Enum** [ "SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT", "SOURCE_STATE_ERROR_CLUSTER", "SOURCE_STATE_ERROR_SOURCE", "SOURCE_STATE_ERROR_VA", "SOURCE_STATE_FAILURE_CLUSTER", "SOURCE_STATE_FAILURE_SOURCE", "SOURCE_STATE_HEALTHY", "SOURCE_STATE_UNCHECKED_CLUSTER", "SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES", "SOURCE_STATE_UNCHECKED_SOURCE", "SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS" ] | Status identifier that gives specific information about why a source is or isn't healthy. | [optional] +**Since** | Pointer to **System.DateTime** | Timestamp that shows when a source health check was last performed. | [optional] +**ConnectorId** | Pointer to **String** | Connector ID | [optional] +**ConnectorName** | Pointer to **String** | Name of the connector that was chosen during source creation. | [optional] +**ConnectionType** | Pointer to **Enum** [ "direct", "file" ] | Type of connection (direct or file). | [optional] +**ConnectorImplementationId** | Pointer to **String** | Connector implementation ID. | [optional] +**Created** | Pointer to **System.DateTime** | Date-time when the source was created | [optional] +**Modified** | Pointer to **System.DateTime** | Date-time when the source was last modified. | [optional] +**CredentialProviderEnabled** | Pointer to **Boolean** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to $false] +**Category** | Pointer to **String** | Source category (e.g. null, CredentialProvider). | [optional] + +## Examples + +- Prepare the resource +```powershell +$MultiHostIntegrations = Initialize-PSSailpoint.BetaMultiHostIntegrations -Id 2c91808568c529c60168cca6f90c1324 ` + -Name My Multi-Host Integration ` + -Description This is a Multi-Host Integration. ` + -Owner null ` + -Cluster null ` + -Type Multi-Host - Microsoft SQL Server ` + -Connector multihost-microsoft-sql-server ` + -LastSourceUploadSuccessCount 50 ` + -MaxSourcesPerAggGroup 10 ` + -ConnectorClass sailpoint.connector.OpenConnectorAdapter ` + -ConnectorAttributes null ` + -DeleteThreshold 10 ` + -Authoritative false ` + -ManagementWorkgroup null ` + -Healthy true ` + -Status SOURCE_STATE_HEALTHY ` + -Since null ` + -ConnectorId multihost-microsoft-sql-server ` + -ConnectorName Multi-Host Microsoft SQL Server ` + -ConnectionType direct ` + -ConnectorImplementationId multihost-microsoft-sql-server ` + -Created 2022-02-08T14:50:03.827Z ` + -Modified 2024-01-23T18:08:50.897Z ` + -CredentialProviderEnabled false ` + -Category CredentialProvider +``` + +- Convert the resource to JSON +```powershell +$MultiHostIntegrations | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsAggScheduleUpdate.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsAggScheduleUpdate.md new file mode 100644 index 000000000..ad55e79ec --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsAggScheduleUpdate.md @@ -0,0 +1,49 @@ +--- +id: beta-multi-host-integrations-agg-schedule-update +title: MultiHostIntegrationsAggScheduleUpdate +pagination_label: MultiHostIntegrationsAggScheduleUpdate +sidebar_label: MultiHostIntegrationsAggScheduleUpdate +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsAggScheduleUpdate', 'BetaMultiHostIntegrationsAggScheduleUpdate'] +slug: /tools/sdk/powershell/beta/models/multi-host-integrations-agg-schedule-update +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsAggScheduleUpdate', 'BetaMultiHostIntegrationsAggScheduleUpdate'] +--- + + +# MultiHostIntegrationsAggScheduleUpdate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MultihostId** | **String** | Multi-Host Integration ID. The ID must be unique | [required] +**AggregationGrpId** | **String** | Multi-Host Integration aggregation group ID | [required] +**AggregationGrpName** | **String** | Multi-Host Integration name | [required] +**AggregationCronSchedule** | **String** | Cron expression to schedule aggregation | [required] +**EnableSchedule** | **Boolean** | Boolean value for Multi-Host Integration aggregation schedule. This specifies if scheduled aggregation is enabled or disabled. | [required][default to $false] +**SourceIdList** | **[]String** | Source IDs of the Multi-Host Integration | [required] +**Created** | Pointer to **System.DateTime** | Created date of Multi-Host Integration aggregation schedule | [optional] +**Modified** | Pointer to **System.DateTime** | Modified date of Multi-Host Integration aggregation schedule | [optional] + +## Examples + +- Prepare the resource +```powershell +$MultiHostIntegrationsAggScheduleUpdate = Initialize-PSSailpoint.BetaMultiHostIntegrationsAggScheduleUpdate -MultihostId 004091cb79b04636b88662afa50a4456 ` + -AggregationGrpId 004091cb79b04636b88662afa50a4448 ` + -AggregationGrpName Multi-Host Integration aggregation group name ` + -AggregationCronSchedule 0 0 0 * * ? ` + -EnableSchedule false ` + -SourceIdList [004091cb79b04636b88662afa50a4440, 00af6d0d562a49b591c47be908740542] ` + -Created 2024-01-23T18:08:50.897Z ` + -Modified 2024-01-23T18:08:50.897Z +``` + +- Convert the resource to JSON +```powershell +$MultiHostIntegrationsAggScheduleUpdate | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsCluster.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsCluster.md new file mode 100644 index 000000000..aa0100d3a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsCluster.md @@ -0,0 +1,39 @@ +--- +id: beta-multi-host-integrations-cluster +title: MultiHostIntegrationsCluster +pagination_label: MultiHostIntegrationsCluster +sidebar_label: MultiHostIntegrationsCluster +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsCluster', 'BetaMultiHostIntegrationsCluster'] +slug: /tools/sdk/powershell/beta/models/multi-host-integrations-cluster +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsCluster', 'BetaMultiHostIntegrationsCluster'] +--- + + +# MultiHostIntegrationsCluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "CLUSTER" ] | Type of object being referenced. | [required] +**Id** | **String** | Cluster ID. | [required] +**Name** | **String** | Cluster's human-readable display name. | [required] + +## Examples + +- Prepare the resource +```powershell +$MultiHostIntegrationsCluster = Initialize-PSSailpoint.BetaMultiHostIntegrationsCluster -Type CLUSTER ` + -Id 2c9180866166b5b0016167c32ef31a66 ` + -Name Corporate Cluster +``` + +- Convert the resource to JSON +```powershell +$MultiHostIntegrationsCluster | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsConnectorAttributes.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsConnectorAttributes.md new file mode 100644 index 000000000..c96e75d6e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsConnectorAttributes.md @@ -0,0 +1,47 @@ +--- +id: beta-multi-host-integrations-connector-attributes +title: MultiHostIntegrationsConnectorAttributes +pagination_label: MultiHostIntegrationsConnectorAttributes +sidebar_label: MultiHostIntegrationsConnectorAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsConnectorAttributes', 'BetaMultiHostIntegrationsConnectorAttributes'] +slug: /tools/sdk/powershell/beta/models/multi-host-integrations-connector-attributes +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributes', 'BetaMultiHostIntegrationsConnectorAttributes'] +--- + + +# MultiHostIntegrationsConnectorAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxAllowedSources** | Pointer to **Int32** | Maximum sources allowed count of a Multi-Host Integration | [optional] +**LastSourceUploadCount** | Pointer to **Int32** | Last upload sources count of a Multi-Host Integration | [optional] +**ConnectorFileUploadHistory** | Pointer to [**MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory**](multi-host-integrations-connector-attributes-connector-file-upload-history) | | [optional] +**MultihostStatus** | Pointer to **Enum** [ "ready", "processing", "fileUploadInProgress", "sourceCreationInProgress", "aggregationGroupingInProgress", "aggregationScheduleInProgress", "deleteInProgress", "deleteFailed" ] | Multi-Host integration status. | [optional] +**ShowAccountSchema** | Pointer to **Boolean** | Show account schema | [optional] [default to $true] +**ShowEntitlementSchema** | Pointer to **Boolean** | Show entitlement schema | [optional] [default to $true] +**MultiHostAttributes** | Pointer to [**MultiHostIntegrationsConnectorAttributesMultiHostAttributes**](multi-host-integrations-connector-attributes-multi-host-attributes) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$MultiHostIntegrationsConnectorAttributes = Initialize-PSSailpoint.BetaMultiHostIntegrationsConnectorAttributes -MaxAllowedSources 250 ` + -LastSourceUploadCount 40 ` + -ConnectorFileUploadHistory null ` + -MultihostStatus ready ` + -ShowAccountSchema true ` + -ShowEntitlementSchema true ` + -MultiHostAttributes null +``` + +- Convert the resource to JSON +```powershell +$MultiHostIntegrationsConnectorAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory.md new file mode 100644 index 000000000..a63276817 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory.md @@ -0,0 +1,35 @@ +--- +id: beta-multi-host-integrations-connector-attributes-connector-file-upload-history +title: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory +pagination_label: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory +sidebar_label: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory', 'BetaMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory'] +slug: /tools/sdk/powershell/beta/models/multi-host-integrations-connector-attributes-connector-file-upload-history +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory', 'BetaMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory'] +--- + + +# MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConnectorFileNameUploadedDate** | Pointer to **String** | File name of the connector JAR | [optional] + +## Examples + +- Prepare the resource +```powershell +$MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory = Initialize-PSSailpoint.BetaMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory -ConnectorFileNameUploadedDate 2024-08-29T10:20:38.896479Z +``` + +- Convert the resource to JSON +```powershell +$MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsConnectorAttributesMultiHostAttributes.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsConnectorAttributesMultiHostAttributes.md new file mode 100644 index 000000000..d3ef94b36 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsConnectorAttributesMultiHostAttributes.md @@ -0,0 +1,41 @@ +--- +id: beta-multi-host-integrations-connector-attributes-multi-host-attributes +title: MultiHostIntegrationsConnectorAttributesMultiHostAttributes +pagination_label: MultiHostIntegrationsConnectorAttributesMultiHostAttributes +sidebar_label: MultiHostIntegrationsConnectorAttributesMultiHostAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsConnectorAttributesMultiHostAttributes', 'BetaMultiHostIntegrationsConnectorAttributesMultiHostAttributes'] +slug: /tools/sdk/powershell/beta/models/multi-host-integrations-connector-attributes-multi-host-attributes +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributesMultiHostAttributes', 'BetaMultiHostIntegrationsConnectorAttributesMultiHostAttributes'] +--- + + +# MultiHostIntegrationsConnectorAttributesMultiHostAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Password** | Pointer to **String** | Password. | [optional] +**ConnectorFiles** | Pointer to **String** | Connector file. | [optional] +**AuthType** | Pointer to **String** | Authentication type. | [optional] +**User** | Pointer to **String** | Username. | [optional] + +## Examples + +- Prepare the resource +```powershell +$MultiHostIntegrationsConnectorAttributesMultiHostAttributes = Initialize-PSSailpoint.BetaMultiHostIntegrationsConnectorAttributesMultiHostAttributes -Password Password ` + -ConnectorFiles mssql-jdbc-8.4.1.jre8.jar ` + -AuthType SQLAuthentication ` + -User My Username +``` + +- Convert the resource to JSON +```powershell +$MultiHostIntegrationsConnectorAttributesMultiHostAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsCreate.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsCreate.md new file mode 100644 index 000000000..a3e2b6541 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsCreate.md @@ -0,0 +1,51 @@ +--- +id: beta-multi-host-integrations-create +title: MultiHostIntegrationsCreate +pagination_label: MultiHostIntegrationsCreate +sidebar_label: MultiHostIntegrationsCreate +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsCreate', 'BetaMultiHostIntegrationsCreate'] +slug: /tools/sdk/powershell/beta/models/multi-host-integrations-create +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsCreate', 'BetaMultiHostIntegrationsCreate'] +--- + + +# MultiHostIntegrationsCreate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Multi-Host Integration's human-readable name. | [required] +**Description** | **String** | Multi-Host Integration's human-readable description. | [required] +**Owner** | [**MultiHostIntegrationsOwner**](multi-host-integrations-owner) | | [required] +**Cluster** | Pointer to [**MultiHostIntegrationsCluster**](multi-host-integrations-cluster) | | [optional] +**Connector** | **String** | Connector script name. | [required] +**ConnectorAttributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Multi-Host Integration specific configuration. User can add any number of additional attributes. e.g. maxSourcesPerAggGroup, maxAllowedSources etc. | [optional] +**ManagementWorkgroup** | Pointer to [**MultiHostIntegrationsManagementWorkgroup**](multi-host-integrations-management-workgroup) | | [optional] +**Created** | Pointer to **System.DateTime** | Date-time when the source was created | [optional] +**Modified** | Pointer to **System.DateTime** | Date-time when the source was last modified. | [optional] + +## Examples + +- Prepare the resource +```powershell +$MultiHostIntegrationsCreate = Initialize-PSSailpoint.BetaMultiHostIntegrationsCreate -Name My Multi-Host Integration ` + -Description This is the Multi-Host Integration. ` + -Owner null ` + -Cluster null ` + -Connector multihost-microsoft-sql-server ` + -ConnectorAttributes {maxSourcesPerAggGroup=10, maxAllowedSources=300} ` + -ManagementWorkgroup null ` + -Created 2022-02-08T14:50:03.827Z ` + -Modified 2024-01-23T18:08:50.897Z +``` + +- Convert the resource to JSON +```powershell +$MultiHostIntegrationsCreate | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsCreateSources.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsCreateSources.md new file mode 100644 index 000000000..7939df952 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsCreateSources.md @@ -0,0 +1,39 @@ +--- +id: beta-multi-host-integrations-create-sources +title: MultiHostIntegrationsCreateSources +pagination_label: MultiHostIntegrationsCreateSources +sidebar_label: MultiHostIntegrationsCreateSources +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsCreateSources', 'BetaMultiHostIntegrationsCreateSources'] +slug: /tools/sdk/powershell/beta/models/multi-host-integrations-create-sources +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsCreateSources', 'BetaMultiHostIntegrationsCreateSources'] +--- + + +# MultiHostIntegrationsCreateSources + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Source's human-readable name. | [required] +**Description** | Pointer to **String** | Source's human-readable description. | [optional] +**ConnectorAttributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Connector specific configuration. This configuration will differ from type to type. | [optional] + +## Examples + +- Prepare the resource +```powershell +$MultiHostIntegrationsCreateSources = Initialize-PSSailpoint.BetaMultiHostIntegrationsCreateSources -Name My Source ` + -Description This is the corporate directory. ` + -ConnectorAttributes {authType=SQLAuthentication, url=jdbc:sqlserver://178.18.41.118:1433, user=username, driverClass=com.microsoft.sqlserver.jdbc.SQLServerDriver, maxSourcesPerAggGroup=10, maxAllowedSources=300} +``` + +- Convert the resource to JSON +```powershell +$MultiHostIntegrationsCreateSources | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsManagementWorkgroup.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsManagementWorkgroup.md new file mode 100644 index 000000000..73d52875d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsManagementWorkgroup.md @@ -0,0 +1,39 @@ +--- +id: beta-multi-host-integrations-management-workgroup +title: MultiHostIntegrationsManagementWorkgroup +pagination_label: MultiHostIntegrationsManagementWorkgroup +sidebar_label: MultiHostIntegrationsManagementWorkgroup +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsManagementWorkgroup', 'BetaMultiHostIntegrationsManagementWorkgroup'] +slug: /tools/sdk/powershell/beta/models/multi-host-integrations-management-workgroup +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsManagementWorkgroup', 'BetaMultiHostIntegrationsManagementWorkgroup'] +--- + + +# MultiHostIntegrationsManagementWorkgroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Management workgroup ID. | [optional] +**Name** | Pointer to **String** | Management workgroup's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$MultiHostIntegrationsManagementWorkgroup = Initialize-PSSailpoint.BetaMultiHostIntegrationsManagementWorkgroup -Type GOVERNANCE_GROUP ` + -Id 2c91808568c529c60168cca6f90c2222 ` + -Name My Management Workgroup +``` + +- Convert the resource to JSON +```powershell +$MultiHostIntegrationsManagementWorkgroup | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsOwner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsOwner.md new file mode 100644 index 000000000..8e586cea3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostIntegrationsOwner.md @@ -0,0 +1,39 @@ +--- +id: beta-multi-host-integrations-owner +title: MultiHostIntegrationsOwner +pagination_label: MultiHostIntegrationsOwner +sidebar_label: MultiHostIntegrationsOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsOwner', 'BetaMultiHostIntegrationsOwner'] +slug: /tools/sdk/powershell/beta/models/multi-host-integrations-owner +tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsOwner', 'BetaMultiHostIntegrationsOwner'] +--- + + +# MultiHostIntegrationsOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Owner identity's ID. | [optional] +**Name** | Pointer to **String** | Owner identity's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$MultiHostIntegrationsOwner = Initialize-PSSailpoint.BetaMultiHostIntegrationsOwner -Type IDENTITY ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name MyName +``` + +- Convert the resource to JSON +```powershell +$MultiHostIntegrationsOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostSources.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostSources.md new file mode 100644 index 000000000..9304b2ef6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostSources.md @@ -0,0 +1,95 @@ +--- +id: beta-multi-host-sources +title: MultiHostSources +pagination_label: MultiHostSources +sidebar_label: MultiHostSources +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostSources', 'BetaMultiHostSources'] +slug: /tools/sdk/powershell/beta/models/multi-host-sources +tags: ['SDK', 'Software Development Kit', 'MultiHostSources', 'BetaMultiHostSources'] +--- + + +# MultiHostSources + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Source ID. | [required][readonly] +**Name** | **String** | Source's human-readable name. | [required] +**Description** | Pointer to **String** | Source's human-readable description. | [optional] +**Owner** | [**MultiHostIntegrationsOwner**](multi-host-integrations-owner) | | [required] +**Cluster** | Pointer to [**MultiHostIntegrationsCluster**](multi-host-integrations-cluster) | | [optional] +**AccountCorrelationConfig** | Pointer to [**MultiHostSourcesAccountCorrelationConfig**](multi-host-sources-account-correlation-config) | | [optional] +**AccountCorrelationRule** | Pointer to [**MultiHostSourcesAccountCorrelationRule**](multi-host-sources-account-correlation-rule) | | [optional] +**ManagerCorrelationMapping** | Pointer to [**ManagerCorrelationMapping**](manager-correlation-mapping) | | [optional] +**ManagerCorrelationRule** | Pointer to [**MultiHostSourcesManagerCorrelationRule**](multi-host-sources-manager-correlation-rule) | | [optional] +**BeforeProvisioningRule** | Pointer to [**MultiHostSourcesBeforeProvisioningRule**](multi-host-sources-before-provisioning-rule) | | [optional] +**Schemas** | Pointer to [**[]MultiHostSourcesSchemasInner**](multi-host-sources-schemas-inner) | List of references to schema objects. | [optional] +**PasswordPolicies** | Pointer to [**[]MultiHostSourcesPasswordPoliciesInner**](multi-host-sources-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional] +**Features** | Pointer to **[]String** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**Type** | Pointer to **String** | Specifies the type of system being managed e.g. Multi-Host - Microsoft SQL Server, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional] +**Connector** | **String** | Connector script name. | [required] +**ConnectorClass** | Pointer to **String** | Fully qualified name of the Java class that implements the connector interface. | [optional] +**ConnectorAttributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Connector specific configuration. This configuration will differ from type to type. | [optional] +**DeleteThreshold** | Pointer to **Int32** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional] +**Authoritative** | Pointer to **Boolean** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to $false] +**ManagementWorkgroup** | Pointer to [**MultiHostIntegrationsManagementWorkgroup**](multi-host-integrations-management-workgroup) | | [optional] +**Healthy** | Pointer to **Boolean** | When this is true, it indicates that the source is healthy. | [optional] [default to $false] +**Status** | Pointer to **Enum** [ "SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT", "SOURCE_STATE_ERROR_CLUSTER", "SOURCE_STATE_ERROR_SOURCE", "SOURCE_STATE_ERROR_VA", "SOURCE_STATE_FAILURE_CLUSTER", "SOURCE_STATE_FAILURE_SOURCE", "SOURCE_STATE_HEALTHY", "SOURCE_STATE_UNCHECKED_CLUSTER", "SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES", "SOURCE_STATE_UNCHECKED_SOURCE", "SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS" ] | Status identifier that gives specific information about why a source is or isn't healthy. | [optional] +**Since** | Pointer to **System.DateTime** | Timestamp that shows when a source health check was last performed. | [optional] +**ConnectorId** | Pointer to **String** | Connector ID | [optional] +**ConnectorName** | **String** | Name of the connector that was chosen during source creation. | [required] +**ConnectionType** | Pointer to **String** | Type of connection (direct or file). | [optional] +**ConnectorImplementationId** | Pointer to **String** | Connector implementation ID. | [optional] +**Created** | Pointer to **System.DateTime** | Date-time when the source was created | [optional] +**Modified** | Pointer to **System.DateTime** | Date-time when the source was last modified. | [optional] +**CredentialProviderEnabled** | Pointer to **Boolean** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to $false] +**Category** | Pointer to **String** | Source category (e.g. null, CredentialProvider). | [optional] + +## Examples + +- Prepare the resource +```powershell +$MultiHostSources = Initialize-PSSailpoint.BetaMultiHostSources -Id 2c91808568c529c60168cca6f90c1324 ` + -Name My Source ` + -Description This is the Source. ` + -Owner null ` + -Cluster null ` + -AccountCorrelationConfig null ` + -AccountCorrelationRule null ` + -ManagerCorrelationMapping null ` + -ManagerCorrelationRule null ` + -BeforeProvisioningRule null ` + -Schemas [{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}] ` + -PasswordPolicies [{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}] ` + -Features [PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS] ` + -Type Multi-Host - Microsoft SQL Server ` + -Connector multihost-microsoft-sql-server ` + -ConnectorClass sailpoint.connector.OpenConnectorAdapter ` + -ConnectorAttributes {healthCheckTimeout=30, authSearchAttributes=[cn, uid, mail]} ` + -DeleteThreshold 10 ` + -Authoritative false ` + -ManagementWorkgroup null ` + -Healthy true ` + -Status SOURCE_STATE_HEALTHY ` + -Since null ` + -ConnectorId multihost-microsoft-sql-server ` + -ConnectorName Multi-Host Microsoft SQL Server ` + -ConnectionType file ` + -ConnectorImplementationId multihost-microsoft-sql-server ` + -Created 2022-02-08T14:50:03.827Z ` + -Modified 2024-01-23T18:08:50.897Z ` + -CredentialProviderEnabled false ` + -Category CredentialProvider +``` + +- Convert the resource to JSON +```powershell +$MultiHostSources | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostSourcesAccountCorrelationConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostSourcesAccountCorrelationConfig.md new file mode 100644 index 000000000..5dbee47f5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostSourcesAccountCorrelationConfig.md @@ -0,0 +1,39 @@ +--- +id: beta-multi-host-sources-account-correlation-config +title: MultiHostSourcesAccountCorrelationConfig +pagination_label: MultiHostSourcesAccountCorrelationConfig +sidebar_label: MultiHostSourcesAccountCorrelationConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostSourcesAccountCorrelationConfig', 'BetaMultiHostSourcesAccountCorrelationConfig'] +slug: /tools/sdk/powershell/beta/models/multi-host-sources-account-correlation-config +tags: ['SDK', 'Software Development Kit', 'MultiHostSourcesAccountCorrelationConfig', 'BetaMultiHostSourcesAccountCorrelationConfig'] +--- + + +# MultiHostSourcesAccountCorrelationConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ACCOUNT_CORRELATION_CONFIG" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Account correlation config ID. | [optional] +**Name** | Pointer to **String** | Account correlation config's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$MultiHostSourcesAccountCorrelationConfig = Initialize-PSSailpoint.BetaMultiHostSourcesAccountCorrelationConfig -Type ACCOUNT_CORRELATION_CONFIG ` + -Id 2c9180855d191c59015d28583727245a ` + -Name Directory [source-62867] Account Correlation +``` + +- Convert the resource to JSON +```powershell +$MultiHostSourcesAccountCorrelationConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostSourcesAccountCorrelationRule.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostSourcesAccountCorrelationRule.md new file mode 100644 index 000000000..2196b305c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostSourcesAccountCorrelationRule.md @@ -0,0 +1,39 @@ +--- +id: beta-multi-host-sources-account-correlation-rule +title: MultiHostSourcesAccountCorrelationRule +pagination_label: MultiHostSourcesAccountCorrelationRule +sidebar_label: MultiHostSourcesAccountCorrelationRule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostSourcesAccountCorrelationRule', 'BetaMultiHostSourcesAccountCorrelationRule'] +slug: /tools/sdk/powershell/beta/models/multi-host-sources-account-correlation-rule +tags: ['SDK', 'Software Development Kit', 'MultiHostSourcesAccountCorrelationRule', 'BetaMultiHostSourcesAccountCorrelationRule'] +--- + + +# MultiHostSourcesAccountCorrelationRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "RULE" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Rule ID. | [optional] +**Name** | Pointer to **String** | Rule's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$MultiHostSourcesAccountCorrelationRule = Initialize-PSSailpoint.BetaMultiHostSourcesAccountCorrelationRule -Type RULE ` + -Id 2c918085708c274401708c2a8a760001 ` + -Name Example Rule +``` + +- Convert the resource to JSON +```powershell +$MultiHostSourcesAccountCorrelationRule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostSourcesBeforeProvisioningRule.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostSourcesBeforeProvisioningRule.md new file mode 100644 index 000000000..7b21e704b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostSourcesBeforeProvisioningRule.md @@ -0,0 +1,39 @@ +--- +id: beta-multi-host-sources-before-provisioning-rule +title: MultiHostSourcesBeforeProvisioningRule +pagination_label: MultiHostSourcesBeforeProvisioningRule +sidebar_label: MultiHostSourcesBeforeProvisioningRule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostSourcesBeforeProvisioningRule', 'BetaMultiHostSourcesBeforeProvisioningRule'] +slug: /tools/sdk/powershell/beta/models/multi-host-sources-before-provisioning-rule +tags: ['SDK', 'Software Development Kit', 'MultiHostSourcesBeforeProvisioningRule', 'BetaMultiHostSourcesBeforeProvisioningRule'] +--- + + +# MultiHostSourcesBeforeProvisioningRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "RULE" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Rule ID. | [optional] +**Name** | Pointer to **String** | Rule's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$MultiHostSourcesBeforeProvisioningRule = Initialize-PSSailpoint.BetaMultiHostSourcesBeforeProvisioningRule -Type RULE ` + -Id 2c918085708c274401708c2a8a760001 ` + -Name Example Rule +``` + +- Convert the resource to JSON +```powershell +$MultiHostSourcesBeforeProvisioningRule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostSourcesManagerCorrelationRule.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostSourcesManagerCorrelationRule.md new file mode 100644 index 000000000..3987f810c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostSourcesManagerCorrelationRule.md @@ -0,0 +1,39 @@ +--- +id: beta-multi-host-sources-manager-correlation-rule +title: MultiHostSourcesManagerCorrelationRule +pagination_label: MultiHostSourcesManagerCorrelationRule +sidebar_label: MultiHostSourcesManagerCorrelationRule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostSourcesManagerCorrelationRule', 'BetaMultiHostSourcesManagerCorrelationRule'] +slug: /tools/sdk/powershell/beta/models/multi-host-sources-manager-correlation-rule +tags: ['SDK', 'Software Development Kit', 'MultiHostSourcesManagerCorrelationRule', 'BetaMultiHostSourcesManagerCorrelationRule'] +--- + + +# MultiHostSourcesManagerCorrelationRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "RULE" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Rule ID. | [optional] +**Name** | Pointer to **String** | Rule's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$MultiHostSourcesManagerCorrelationRule = Initialize-PSSailpoint.BetaMultiHostSourcesManagerCorrelationRule -Type RULE ` + -Id 2c918085708c274401708c2a8a760001 ` + -Name Example Rule +``` + +- Convert the resource to JSON +```powershell +$MultiHostSourcesManagerCorrelationRule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostSourcesPasswordPoliciesInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostSourcesPasswordPoliciesInner.md new file mode 100644 index 000000000..8e83b8ebd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostSourcesPasswordPoliciesInner.md @@ -0,0 +1,39 @@ +--- +id: beta-multi-host-sources-password-policies-inner +title: MultiHostSourcesPasswordPoliciesInner +pagination_label: MultiHostSourcesPasswordPoliciesInner +sidebar_label: MultiHostSourcesPasswordPoliciesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostSourcesPasswordPoliciesInner', 'BetaMultiHostSourcesPasswordPoliciesInner'] +slug: /tools/sdk/powershell/beta/models/multi-host-sources-password-policies-inner +tags: ['SDK', 'Software Development Kit', 'MultiHostSourcesPasswordPoliciesInner', 'BetaMultiHostSourcesPasswordPoliciesInner'] +--- + + +# MultiHostSourcesPasswordPoliciesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "PASSWORD_POLICY" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Policy ID. | [optional] +**Name** | Pointer to **String** | Policy's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$MultiHostSourcesPasswordPoliciesInner = Initialize-PSSailpoint.BetaMultiHostSourcesPasswordPoliciesInner -Type PASSWORD_POLICY ` + -Id 2c91808568c529c60168cca6f90c1777 ` + -Name My Password Policy +``` + +- Convert the resource to JSON +```powershell +$MultiHostSourcesPasswordPoliciesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostSourcesSchemasInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostSourcesSchemasInner.md new file mode 100644 index 000000000..896164cd3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiHostSourcesSchemasInner.md @@ -0,0 +1,39 @@ +--- +id: beta-multi-host-sources-schemas-inner +title: MultiHostSourcesSchemasInner +pagination_label: MultiHostSourcesSchemasInner +sidebar_label: MultiHostSourcesSchemasInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostSourcesSchemasInner', 'BetaMultiHostSourcesSchemasInner'] +slug: /tools/sdk/powershell/beta/models/multi-host-sources-schemas-inner +tags: ['SDK', 'Software Development Kit', 'MultiHostSourcesSchemasInner', 'BetaMultiHostSourcesSchemasInner'] +--- + + +# MultiHostSourcesSchemasInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "CONNECTOR_SCHEMA" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Schema ID. | [optional] +**Name** | Pointer to **String** | Schema's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$MultiHostSourcesSchemasInner = Initialize-PSSailpoint.BetaMultiHostSourcesSchemasInner -Type CONNECTOR_SCHEMA ` + -Id 2c91808568c529c60168cca6f90c1777 ` + -Name MySchema +``` + +- Convert the resource to JSON +```powershell +$MultiHostSourcesSchemasInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiPolicyRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiPolicyRequest.md new file mode 100644 index 000000000..fcd87f9fd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/MultiPolicyRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-multi-policy-request +title: MultiPolicyRequest +pagination_label: MultiPolicyRequest +sidebar_label: MultiPolicyRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MultiPolicyRequest', 'BetaMultiPolicyRequest'] +slug: /tools/sdk/powershell/beta/models/multi-policy-request +tags: ['SDK', 'Software Development Kit', 'MultiPolicyRequest', 'BetaMultiPolicyRequest'] +--- + + +# MultiPolicyRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FilteredPolicyList** | Pointer to **[]String** | Multi-policy report will be run for this list of ids | [optional] + +## Examples + +- Prepare the resource +```powershell +$MultiPolicyRequest = Initialize-PSSailpoint.BetaMultiPolicyRequest -FilteredPolicyList null +``` + +- Convert the resource to JSON +```powershell +$MultiPolicyRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NameNormalizer.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NameNormalizer.md new file mode 100644 index 000000000..679a04b20 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NameNormalizer.md @@ -0,0 +1,37 @@ +--- +id: beta-name-normalizer +title: NameNormalizer +pagination_label: NameNormalizer +sidebar_label: NameNormalizer +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NameNormalizer', 'BetaNameNormalizer'] +slug: /tools/sdk/powershell/beta/models/name-normalizer +tags: ['SDK', 'Software Development Kit', 'NameNormalizer', 'BetaNameNormalizer'] +--- + + +# NameNormalizer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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] + +## Examples + +- Prepare the resource +```powershell +$NameNormalizer = Initialize-PSSailpoint.BetaNameNormalizer -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$NameNormalizer | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NamedConstructs.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NamedConstructs.md new file mode 100644 index 000000000..3d729e270 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NamedConstructs.md @@ -0,0 +1,30 @@ +--- +id: beta-named-constructs +title: NamedConstructs +pagination_label: NamedConstructs +sidebar_label: NamedConstructs +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NamedConstructs', 'BetaNamedConstructs'] +slug: /tools/sdk/powershell/beta/models/named-constructs +tags: ['SDK', 'Software Development Kit', 'NamedConstructs', 'BetaNamedConstructs'] +--- + + +# NamedConstructs + +## Enum + + +* `ISO8601` (value: `"ISO8601"`) + +* `LDAP` (value: `"LDAP"`) + +* `PEOPLE_SOFT` (value: `"PEOPLE_SOFT"`) + +* `EPOCH_TIME_JAVA` (value: `"EPOCH_TIME_JAVA"`) + +* `EPOCH_TIME_WIN32` (value: `"EPOCH_TIME_WIN32"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NativeChangeDetectionConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NativeChangeDetectionConfig.md new file mode 100644 index 000000000..a0df2c517 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NativeChangeDetectionConfig.md @@ -0,0 +1,45 @@ +--- +id: beta-native-change-detection-config +title: NativeChangeDetectionConfig +pagination_label: NativeChangeDetectionConfig +sidebar_label: NativeChangeDetectionConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NativeChangeDetectionConfig', 'BetaNativeChangeDetectionConfig'] +slug: /tools/sdk/powershell/beta/models/native-change-detection-config +tags: ['SDK', 'Software Development Kit', 'NativeChangeDetectionConfig', 'BetaNativeChangeDetectionConfig'] +--- + + +# NativeChangeDetectionConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **Boolean** | A flag indicating if Native Change Detection is enabled for a source. | [optional] [default to $false] +**Operations** | Pointer to **[]String** | Operation types for which Native Change Detection is enabled for a source. | [optional] +**AllEntitlements** | Pointer to **Boolean** | A flag indicating that all entitlements participate in Native Change Detection. | [optional] [default to $false] +**AllNonEntitlementAttributes** | Pointer to **Boolean** | A flag indicating that all non-entitlement account attributes participate in Native Change Detection. | [optional] [default to $false] +**SelectedEntitlements** | Pointer to **[]String** | If allEntitlements flag is off this field lists entitlements that participate in Native Change Detection. | [optional] +**SelectedNonEntitlementAttributes** | Pointer to **[]String** | If allNonEntitlementAttributes flag is off this field lists non-entitlement account attributes that participate in Native Change Detection. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NativeChangeDetectionConfig = Initialize-PSSailpoint.BetaNativeChangeDetectionConfig -Enabled true ` + -Operations [ACCOUNT_UPDATED, ACCOUNT_DELETED] ` + -AllEntitlements false ` + -AllNonEntitlementAttributes false ` + -SelectedEntitlements [memberOf, memberOfSharedMailbox] ` + -SelectedNonEntitlementAttributes [lastName, phoneNumber, objectType, servicePrincipalName] +``` + +- Convert the resource to JSON +```powershell +$NativeChangeDetectionConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeApprovalDecision.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeApprovalDecision.md new file mode 100644 index 000000000..a11ef8c6c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeApprovalDecision.md @@ -0,0 +1,35 @@ +--- +id: beta-non-employee-approval-decision +title: NonEmployeeApprovalDecision +pagination_label: NonEmployeeApprovalDecision +sidebar_label: NonEmployeeApprovalDecision +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalDecision', 'BetaNonEmployeeApprovalDecision'] +slug: /tools/sdk/powershell/beta/models/non-employee-approval-decision +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalDecision', 'BetaNonEmployeeApprovalDecision'] +--- + + +# NonEmployeeApprovalDecision + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment on the approval item. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeApprovalDecision = Initialize-PSSailpoint.BetaNonEmployeeApprovalDecision -Comment null +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeApprovalDecision | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeApprovalItem.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeApprovalItem.md new file mode 100644 index 000000000..42bdcb3c7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeApprovalItem.md @@ -0,0 +1,51 @@ +--- +id: beta-non-employee-approval-item +title: NonEmployeeApprovalItem +pagination_label: NonEmployeeApprovalItem +sidebar_label: NonEmployeeApprovalItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalItem', 'BetaNonEmployeeApprovalItem'] +slug: /tools/sdk/powershell/beta/models/non-employee-approval-item +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItem', 'BetaNonEmployeeApprovalItem'] +--- + + +# NonEmployeeApprovalItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee approval item id | [optional] +**Approver** | Pointer to [**IdentityReferenceWithId**](identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **String** | Requested identity account name | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**ApprovalOrder** | Pointer to **Double** | Approval order | [optional] +**Comment** | Pointer to **String** | comment of approver | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] +**NonEmployeeRequest** | Pointer to [**NonEmployeeRequestLite**](non-employee-request-lite) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeApprovalItem = Initialize-PSSailpoint.BetaNonEmployeeApprovalItem -Id 2c1e388b-1e55-4b0a-ab5c-897f1204159c ` + -Approver null ` + -AccountName test.account ` + -ApprovalStatus null ` + -ApprovalOrder 1 ` + -Comment true ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z ` + -NonEmployeeRequest null +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeApprovalItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeApprovalItemBase.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeApprovalItemBase.md new file mode 100644 index 000000000..0bbae477d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeApprovalItemBase.md @@ -0,0 +1,49 @@ +--- +id: beta-non-employee-approval-item-base +title: NonEmployeeApprovalItemBase +pagination_label: NonEmployeeApprovalItemBase +sidebar_label: NonEmployeeApprovalItemBase +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalItemBase', 'BetaNonEmployeeApprovalItemBase'] +slug: /tools/sdk/powershell/beta/models/non-employee-approval-item-base +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItemBase', 'BetaNonEmployeeApprovalItemBase'] +--- + + +# NonEmployeeApprovalItemBase + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee approval item id | [optional] +**Approver** | Pointer to [**IdentityReferenceWithId**](identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **String** | Requested identity account name | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**ApprovalOrder** | Pointer to **Double** | Approval order | [optional] +**Comment** | Pointer to **String** | comment of approver | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeApprovalItemBase = Initialize-PSSailpoint.BetaNonEmployeeApprovalItemBase -Id 2c1e388b-1e55-4b0a-ab5c-897f1204159c ` + -Approver null ` + -AccountName test.account ` + -ApprovalStatus null ` + -ApprovalOrder 1 ` + -Comment true ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeApprovalItemBase | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeApprovalItemDetail.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeApprovalItemDetail.md new file mode 100644 index 000000000..6cbe5916d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeApprovalItemDetail.md @@ -0,0 +1,51 @@ +--- +id: beta-non-employee-approval-item-detail +title: NonEmployeeApprovalItemDetail +pagination_label: NonEmployeeApprovalItemDetail +sidebar_label: NonEmployeeApprovalItemDetail +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalItemDetail', 'BetaNonEmployeeApprovalItemDetail'] +slug: /tools/sdk/powershell/beta/models/non-employee-approval-item-detail +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItemDetail', 'BetaNonEmployeeApprovalItemDetail'] +--- + + +# NonEmployeeApprovalItemDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee approval item id | [optional] +**Approver** | Pointer to [**IdentityReferenceWithId**](identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **String** | Requested identity account name | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**ApprovalOrder** | Pointer to **Double** | Approval order | [optional] +**Comment** | Pointer to **String** | comment of approver | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] +**NonEmployeeRequest** | Pointer to [**NonEmployeeRequestWithoutApprovalItem**](non-employee-request-without-approval-item) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeApprovalItemDetail = Initialize-PSSailpoint.BetaNonEmployeeApprovalItemDetail -Id 2c1e388b-1e55-4b0a-ab5c-897f1204159c ` + -Approver null ` + -AccountName test.account ` + -ApprovalStatus null ` + -ApprovalOrder 1 ` + -Comment true ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z ` + -NonEmployeeRequest null +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeApprovalItemDetail | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeApprovalSummary.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeApprovalSummary.md new file mode 100644 index 000000000..040653940 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeApprovalSummary.md @@ -0,0 +1,39 @@ +--- +id: beta-non-employee-approval-summary +title: NonEmployeeApprovalSummary +pagination_label: NonEmployeeApprovalSummary +sidebar_label: NonEmployeeApprovalSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalSummary', 'BetaNonEmployeeApprovalSummary'] +slug: /tools/sdk/powershell/beta/models/non-employee-approval-summary +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalSummary', 'BetaNonEmployeeApprovalSummary'] +--- + + +# NonEmployeeApprovalSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Approved** | Pointer to **Decimal** | The number of approved non-employee approval requests. | [optional] +**Pending** | Pointer to **Decimal** | The number of pending non-employee approval requests. | [optional] +**Rejected** | Pointer to **Decimal** | The number of rejected non-employee approval requests. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeApprovalSummary = Initialize-PSSailpoint.BetaNonEmployeeApprovalSummary -Approved null ` + -Pending null ` + -Rejected null +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeApprovalSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeBulkUploadJob.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeBulkUploadJob.md new file mode 100644 index 000000000..3c0d47a8c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeBulkUploadJob.md @@ -0,0 +1,43 @@ +--- +id: beta-non-employee-bulk-upload-job +title: NonEmployeeBulkUploadJob +pagination_label: NonEmployeeBulkUploadJob +sidebar_label: NonEmployeeBulkUploadJob +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeBulkUploadJob', 'BetaNonEmployeeBulkUploadJob'] +slug: /tools/sdk/powershell/beta/models/non-employee-bulk-upload-job +tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadJob', 'BetaNonEmployeeBulkUploadJob'] +--- + + +# NonEmployeeBulkUploadJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The bulk upload job's ID. (UUID) | [optional] +**SourceId** | Pointer to **String** | The ID of the source to bulk-upload non-employees to. (UUID) | [optional] +**Created** | Pointer to **System.DateTime** | The date-time the job was submitted. | [optional] +**Modified** | Pointer to **System.DateTime** | The date-time that the job was last updated. | [optional] +**Status** | Pointer to **Enum** [ "PENDING", "IN_PROGRESS", "COMPLETED", "ERROR" ] | Returns the following values indicating the progress or result of the bulk upload job. ""PENDING"" means the job is queued and waiting to be processed. ""IN_PROGRESS"" means the job is currently being processed. ""COMPLETED"" means the job has been completed without any errors. ""ERROR"" means the job failed to process with errors. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeBulkUploadJob = Initialize-PSSailpoint.BetaNonEmployeeBulkUploadJob -Id 2c91808568c529c60168cca6f90cffff ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -Created 2019-08-23T18:52:59.162Z ` + -Modified 2019-08-23T18:52:59.162Z ` + -Status PENDING +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeBulkUploadJob | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeBulkUploadStatus.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeBulkUploadStatus.md new file mode 100644 index 000000000..73cc4dba1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeBulkUploadStatus.md @@ -0,0 +1,35 @@ +--- +id: beta-non-employee-bulk-upload-status +title: NonEmployeeBulkUploadStatus +pagination_label: NonEmployeeBulkUploadStatus +sidebar_label: NonEmployeeBulkUploadStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeBulkUploadStatus', 'BetaNonEmployeeBulkUploadStatus'] +slug: /tools/sdk/powershell/beta/models/non-employee-bulk-upload-status +tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadStatus', 'BetaNonEmployeeBulkUploadStatus'] +--- + + +# NonEmployeeBulkUploadStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **Enum** [ "PENDING", "IN_PROGRESS", "COMPLETED", "ERROR" ] | Returns the following values indicating the progress or result of the bulk upload job. ""PENDING"" means the job is queued and waiting to be processed. ""IN_PROGRESS"" means the job is currently being processed. ""COMPLETED"" means the job has been completed without any errors. ""ERROR"" means the job failed to process with errors. null means job has been submitted to the source. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeBulkUploadStatus = Initialize-PSSailpoint.BetaNonEmployeeBulkUploadStatus -Status PENDING +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeBulkUploadStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeIdnUserRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeIdnUserRequest.md new file mode 100644 index 000000000..3c52754a9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeIdnUserRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-non-employee-idn-user-request +title: NonEmployeeIdnUserRequest +pagination_label: NonEmployeeIdnUserRequest +sidebar_label: NonEmployeeIdnUserRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeIdnUserRequest', 'BetaNonEmployeeIdnUserRequest'] +slug: /tools/sdk/powershell/beta/models/non-employee-idn-user-request +tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdnUserRequest', 'BetaNonEmployeeIdnUserRequest'] +--- + + +# NonEmployeeIdnUserRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Identity id. | [required] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeIdnUserRequest = Initialize-PSSailpoint.BetaNonEmployeeIdnUserRequest -Id 2c91808570313110017040b06f344ec9 +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeIdnUserRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeRecord.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeRecord.md new file mode 100644 index 000000000..3a094911c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeRecord.md @@ -0,0 +1,59 @@ +--- +id: beta-non-employee-record +title: NonEmployeeRecord +pagination_label: NonEmployeeRecord +sidebar_label: NonEmployeeRecord +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRecord', 'BetaNonEmployeeRecord'] +slug: /tools/sdk/powershell/beta/models/non-employee-record +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRecord', 'BetaNonEmployeeRecord'] +--- + + +# NonEmployeeRecord + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee record id. | [optional] +**AccountName** | Pointer to **String** | Requested identity account name. | [optional] +**FirstName** | Pointer to **String** | Non-Employee's first name. | [optional] +**LastName** | Pointer to **String** | Non-Employee's last name. | [optional] +**Email** | Pointer to **String** | Non-Employee's email. | [optional] +**Phone** | Pointer to **String** | Non-Employee's phone. | [optional] +**Manager** | Pointer to **String** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**SourceId** | Pointer to **String** | Non-Employee's source id. | [optional] +**VarData** | Pointer to **map[string]String** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**StartDate** | Pointer to **System.DateTime** | Non-Employee employment start date. | [optional] +**EndDate** | Pointer to **System.DateTime** | Non-Employee employment end date. | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeRecord = Initialize-PSSailpoint.BetaNonEmployeeRecord -Id ac10e21c-931c-1ef2-8193-1c51e7ff0003 ` + -AccountName william.smith ` + -FirstName William ` + -LastName Smith ` + -Email william.smith@example.com ` + -Phone 5125555555 ` + -Manager jane.doe ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -VarData {description=Auditing} ` + -StartDate 2019-08-23T18:52:59.162Z ` + -EndDate 2020-08-23T18:52:59.162Z ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeRecord | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeRejectApprovalDecision.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeRejectApprovalDecision.md new file mode 100644 index 000000000..c824ad408 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeRejectApprovalDecision.md @@ -0,0 +1,35 @@ +--- +id: beta-non-employee-reject-approval-decision +title: NonEmployeeRejectApprovalDecision +pagination_label: NonEmployeeRejectApprovalDecision +sidebar_label: NonEmployeeRejectApprovalDecision +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRejectApprovalDecision', 'BetaNonEmployeeRejectApprovalDecision'] +slug: /tools/sdk/powershell/beta/models/non-employee-reject-approval-decision +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRejectApprovalDecision', 'BetaNonEmployeeRejectApprovalDecision'] +--- + + +# NonEmployeeRejectApprovalDecision + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | **String** | Comment on the approval item. | [required] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeRejectApprovalDecision = Initialize-PSSailpoint.BetaNonEmployeeRejectApprovalDecision -Comment null +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeRejectApprovalDecision | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeRequest.md new file mode 100644 index 000000000..f1c184a60 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeRequest.md @@ -0,0 +1,73 @@ +--- +id: beta-non-employee-request +title: NonEmployeeRequest +pagination_label: NonEmployeeRequest +sidebar_label: NonEmployeeRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequest', 'BetaNonEmployeeRequest'] +slug: /tools/sdk/powershell/beta/models/non-employee-request +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequest', 'BetaNonEmployeeRequest'] +--- + + +# NonEmployeeRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] +**AccountName** | Pointer to **String** | Requested identity account name. | [optional] +**FirstName** | Pointer to **String** | Non-Employee's first name. | [optional] +**LastName** | Pointer to **String** | Non-Employee's last name. | [optional] +**Email** | Pointer to **String** | Non-Employee's email. | [optional] +**Phone** | Pointer to **String** | Non-Employee's phone. | [optional] +**Manager** | Pointer to **String** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**NonEmployeeSource** | Pointer to [**NonEmployeeSourceLite**](non-employee-source-lite) | | [optional] +**VarData** | Pointer to **map[string]String** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**ApprovalItems** | Pointer to [**[]NonEmployeeApprovalItemBase**](non-employee-approval-item-base) | List of approval item for the request | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**Comment** | Pointer to **String** | Comment of requester | [optional] +**CompletionDate** | Pointer to **System.DateTime** | When the request was completely approved. | [optional] +**StartDate** | Pointer to **System.DateTime** | Non-Employee employment start date. | [optional] +**EndDate** | Pointer to **System.DateTime** | Non-Employee employment end date. | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeRequest = Initialize-PSSailpoint.BetaNonEmployeeRequest -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -Name Retail ` + -Description Source description ` + -AccountName william.smith ` + -FirstName William ` + -LastName Smith ` + -Email william.smith@example.com ` + -Phone 5125555555 ` + -Manager jane.doe ` + -NonEmployeeSource null ` + -VarData {description=Auditing} ` + -ApprovalItems null ` + -ApprovalStatus null ` + -Comment approved ` + -CompletionDate 2020-03-24T11:11:41.139-05:00 ` + -StartDate 2020-03-24T00:00-05:00 ` + -EndDate 2021-03-25T00:00-05:00 ` + -Modified 2020-03-24T11:11:41.139-05:00 ` + -Created 2020-03-24T11:11:41.139-05:00 +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeRequestBody.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeRequestBody.md new file mode 100644 index 000000000..1077e3f0f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeRequestBody.md @@ -0,0 +1,53 @@ +--- +id: beta-non-employee-request-body +title: NonEmployeeRequestBody +pagination_label: NonEmployeeRequestBody +sidebar_label: NonEmployeeRequestBody +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequestBody', 'BetaNonEmployeeRequestBody'] +slug: /tools/sdk/powershell/beta/models/non-employee-request-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestBody', 'BetaNonEmployeeRequestBody'] +--- + + +# NonEmployeeRequestBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountName** | **String** | Requested identity account name. | [required] +**FirstName** | **String** | Non-Employee's first name. | [required] +**LastName** | **String** | Non-Employee's last name. | [required] +**Email** | **String** | Non-Employee's email. | [required] +**Phone** | **String** | Non-Employee's phone. | [required] +**Manager** | **String** | The account ID of a valid identity to serve as this non-employee's manager. | [required] +**SourceId** | **String** | Non-Employee's source id. | [required] +**VarData** | Pointer to **map[string]String** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**StartDate** | **System.DateTime** | Non-Employee employment start date. | [required] +**EndDate** | **System.DateTime** | Non-Employee employment end date. | [required] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeRequestBody = Initialize-PSSailpoint.BetaNonEmployeeRequestBody -AccountName william.smith ` + -FirstName William ` + -LastName Smith ` + -Email william.smith@example.com ` + -Phone 5125555555 ` + -Manager jane.doe ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -VarData {description=Auditing} ` + -StartDate 2020-03-24T00:00-05:00 ` + -EndDate 2021-03-25T00:00-05:00 +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeRequestBody | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeRequestLite.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeRequestLite.md new file mode 100644 index 000000000..2ec369465 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeRequestLite.md @@ -0,0 +1,37 @@ +--- +id: beta-non-employee-request-lite +title: NonEmployeeRequestLite +pagination_label: NonEmployeeRequestLite +sidebar_label: NonEmployeeRequestLite +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequestLite', 'BetaNonEmployeeRequestLite'] +slug: /tools/sdk/powershell/beta/models/non-employee-request-lite +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestLite', 'BetaNonEmployeeRequestLite'] +--- + + +# NonEmployeeRequestLite + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee request id. | [optional] +**Requester** | Pointer to [**IdentityReferenceWithId**](identity-reference-with-id) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeRequestLite = Initialize-PSSailpoint.BetaNonEmployeeRequestLite -Id ac10e21c-931c-1ef2-8193-1c51e7ff0003 ` + -Requester null +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeRequestLite | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeRequestSummary.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeRequestSummary.md new file mode 100644 index 000000000..cd13c0a6d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeRequestSummary.md @@ -0,0 +1,41 @@ +--- +id: beta-non-employee-request-summary +title: NonEmployeeRequestSummary +pagination_label: NonEmployeeRequestSummary +sidebar_label: NonEmployeeRequestSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequestSummary', 'BetaNonEmployeeRequestSummary'] +slug: /tools/sdk/powershell/beta/models/non-employee-request-summary +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestSummary', 'BetaNonEmployeeRequestSummary'] +--- + + +# NonEmployeeRequestSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Approved** | Pointer to **Decimal** | The number of approved non-employee requests on all sources that *requested-for* user manages. | [optional] +**Rejected** | Pointer to **Decimal** | The number of rejected non-employee requests on all sources that *requested-for* user manages. | [optional] +**Pending** | Pointer to **Decimal** | The number of pending non-employee requests on all sources that *requested-for* user manages. | [optional] +**NonEmployeeCount** | Pointer to **Decimal** | The number of non-employee records on all sources that *requested-for* user manages. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeRequestSummary = Initialize-PSSailpoint.BetaNonEmployeeRequestSummary -Approved null ` + -Rejected null ` + -Pending null ` + -NonEmployeeCount null +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeRequestSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeRequestWithoutApprovalItem.md new file mode 100644 index 000000000..c05f103bb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -0,0 +1,67 @@ +--- +id: beta-non-employee-request-without-approval-item +title: NonEmployeeRequestWithoutApprovalItem +pagination_label: NonEmployeeRequestWithoutApprovalItem +sidebar_label: NonEmployeeRequestWithoutApprovalItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequestWithoutApprovalItem', 'BetaNonEmployeeRequestWithoutApprovalItem'] +slug: /tools/sdk/powershell/beta/models/non-employee-request-without-approval-item +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestWithoutApprovalItem', 'BetaNonEmployeeRequestWithoutApprovalItem'] +--- + + +# NonEmployeeRequestWithoutApprovalItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee request id. | [optional] +**Requester** | Pointer to [**IdentityReferenceWithId**](identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **String** | Requested identity account name. | [optional] +**FirstName** | Pointer to **String** | Non-Employee's first name. | [optional] +**LastName** | Pointer to **String** | Non-Employee's last name. | [optional] +**Email** | Pointer to **String** | Non-Employee's email. | [optional] +**Phone** | Pointer to **String** | Non-Employee's phone. | [optional] +**Manager** | Pointer to **String** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**NonEmployeeSource** | Pointer to [**NonEmployeeSourceLiteWithSchemaAttributes**](non-employee-source-lite-with-schema-attributes) | | [optional] +**VarData** | Pointer to **map[string]String** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**Comment** | Pointer to **String** | Comment of requester | [optional] +**CompletionDate** | Pointer to **System.DateTime** | When the request was completely approved. | [optional] +**StartDate** | Pointer to **System.DateTime** | Non-Employee employment start date. | [optional] +**EndDate** | Pointer to **System.DateTime** | Non-Employee employment end date. | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.BetaNonEmployeeRequestWithoutApprovalItem -Id ac10e21c-931c-1ef2-8193-1c51e7ff0003 ` + -Requester null ` + -AccountName william.smith ` + -FirstName William ` + -LastName Smith ` + -Email william.smith@example.com ` + -Phone 5125555555 ` + -Manager jane.doe ` + -NonEmployeeSource null ` + -VarData {description=Auditing} ` + -ApprovalStatus null ` + -Comment approved ` + -CompletionDate 2020-03-24T11:11:41.139-05:00 ` + -StartDate Mon Mar 23 20:00:00 EDT 2020 ` + -EndDate Wed Mar 24 20:00:00 EDT 2021 ` + -Modified 2020-03-24T11:11:41.139-05:00 ` + -Created 2020-03-24T11:11:41.139-05:00 +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeRequestWithoutApprovalItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSchemaAttribute.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSchemaAttribute.md new file mode 100644 index 000000000..03ab8470d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSchemaAttribute.md @@ -0,0 +1,53 @@ +--- +id: beta-non-employee-schema-attribute +title: NonEmployeeSchemaAttribute +pagination_label: NonEmployeeSchemaAttribute +sidebar_label: NonEmployeeSchemaAttribute +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSchemaAttribute', 'BetaNonEmployeeSchemaAttribute'] +slug: /tools/sdk/powershell/beta/models/non-employee-schema-attribute +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttribute', 'BetaNonEmployeeSchemaAttribute'] +--- + + +# NonEmployeeSchemaAttribute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Schema Attribute Id | [optional] +**System** | Pointer to **Boolean** | True if this schema attribute is mandatory on all non-employees sources. | [optional] [default to $false] +**Modified** | Pointer to **System.DateTime** | When the schema attribute was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the schema attribute was created. | [optional] +**Type** | [**NonEmployeeSchemaAttributeType**](non-employee-schema-attribute-type) | | [required] +**Label** | **String** | Label displayed on the UI for this schema attribute. | [required] +**TechnicalName** | **String** | The technical name of the attribute. Must be unique per source. | [required] +**HelpText** | Pointer to **String** | help text displayed by UI. | [optional] +**Placeholder** | Pointer to **String** | Hint text that fills UI box. | [optional] +**Required** | Pointer to **Boolean** | If true, the schema attribute is required for all non-employees in the source | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeSchemaAttribute = Initialize-PSSailpoint.BetaNonEmployeeSchemaAttribute -Id ac110005-7156-1150-8171-5b292e3e0084 ` + -System true ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z ` + -Type null ` + -Label Account Name ` + -TechnicalName account.name ` + -HelpText The unique identifier for the account ` + -Placeholder Enter a unique user name for this account. ` + -Required true +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeSchemaAttribute | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSchemaAttributeBody.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSchemaAttributeBody.md new file mode 100644 index 000000000..da6c5aa67 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSchemaAttributeBody.md @@ -0,0 +1,45 @@ +--- +id: beta-non-employee-schema-attribute-body +title: NonEmployeeSchemaAttributeBody +pagination_label: NonEmployeeSchemaAttributeBody +sidebar_label: NonEmployeeSchemaAttributeBody +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSchemaAttributeBody', 'BetaNonEmployeeSchemaAttributeBody'] +slug: /tools/sdk/powershell/beta/models/non-employee-schema-attribute-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeBody', 'BetaNonEmployeeSchemaAttributeBody'] +--- + + +# NonEmployeeSchemaAttributeBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **String** | Type of the attribute. Only type 'TEXT' is supported for custom attributes. | [required] +**Label** | **String** | Label displayed on the UI for this schema attribute. | [required] +**TechnicalName** | **String** | The technical name of the attribute. Must be unique per source. | [required] +**HelpText** | Pointer to **String** | help text displayed by UI. | [optional] +**Placeholder** | Pointer to **String** | Hint text that fills UI box. | [optional] +**Required** | Pointer to **Boolean** | If true, the schema attribute is required for all non-employees in the source | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeSchemaAttributeBody = Initialize-PSSailpoint.BetaNonEmployeeSchemaAttributeBody -Type TEXT ` + -Label Account Name ` + -TechnicalName account.name ` + -HelpText The unique identifier for the account ` + -Placeholder Enter a unique user name for this account. ` + -Required true +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeSchemaAttributeBody | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSchemaAttributeType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSchemaAttributeType.md new file mode 100644 index 000000000..abc06a525 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSchemaAttributeType.md @@ -0,0 +1,26 @@ +--- +id: beta-non-employee-schema-attribute-type +title: NonEmployeeSchemaAttributeType +pagination_label: NonEmployeeSchemaAttributeType +sidebar_label: NonEmployeeSchemaAttributeType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSchemaAttributeType', 'BetaNonEmployeeSchemaAttributeType'] +slug: /tools/sdk/powershell/beta/models/non-employee-schema-attribute-type +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeType', 'BetaNonEmployeeSchemaAttributeType'] +--- + + +# NonEmployeeSchemaAttributeType + +## Enum + + +* `TEXT` (value: `"TEXT"`) + +* `DATE` (value: `"DATE"`) + +* `IDENTITY` (value: `"IDENTITY"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSource.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSource.md new file mode 100644 index 000000000..b4f7b1cb8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSource.md @@ -0,0 +1,51 @@ +--- +id: beta-non-employee-source +title: NonEmployeeSource +pagination_label: NonEmployeeSource +sidebar_label: NonEmployeeSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSource', 'BetaNonEmployeeSource'] +slug: /tools/sdk/powershell/beta/models/non-employee-source +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSource', 'BetaNonEmployeeSource'] +--- + + +# NonEmployeeSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] +**Approvers** | Pointer to [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of approvers | [optional] +**AccountManagers** | Pointer to [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of account managers | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] +**NonEmployeeCount** | Pointer to **Int32** | The number of non-employee records on all sources that *requested-for* user manages. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeSource = Initialize-PSSailpoint.BetaNonEmployeeSource -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -Name Retail ` + -Description Source description ` + -Approvers null ` + -AccountManagers null ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z ` + -NonEmployeeCount 2 +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSourceLite.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSourceLite.md new file mode 100644 index 000000000..5466bf3f3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSourceLite.md @@ -0,0 +1,41 @@ +--- +id: beta-non-employee-source-lite +title: NonEmployeeSourceLite +pagination_label: NonEmployeeSourceLite +sidebar_label: NonEmployeeSourceLite +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceLite', 'BetaNonEmployeeSourceLite'] +slug: /tools/sdk/powershell/beta/models/non-employee-source-lite +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceLite', 'BetaNonEmployeeSourceLite'] +--- + + +# NonEmployeeSourceLite + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeSourceLite = Initialize-PSSailpoint.BetaNonEmployeeSourceLite -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -Name Retail ` + -Description Source description +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeSourceLite | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSourceLiteWithSchemaAttributes.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSourceLiteWithSchemaAttributes.md new file mode 100644 index 000000000..656573326 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSourceLiteWithSchemaAttributes.md @@ -0,0 +1,43 @@ +--- +id: beta-non-employee-source-lite-with-schema-attributes +title: NonEmployeeSourceLiteWithSchemaAttributes +pagination_label: NonEmployeeSourceLiteWithSchemaAttributes +sidebar_label: NonEmployeeSourceLiteWithSchemaAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceLiteWithSchemaAttributes', 'BetaNonEmployeeSourceLiteWithSchemaAttributes'] +slug: /tools/sdk/powershell/beta/models/non-employee-source-lite-with-schema-attributes +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceLiteWithSchemaAttributes', 'BetaNonEmployeeSourceLiteWithSchemaAttributes'] +--- + + +# NonEmployeeSourceLiteWithSchemaAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] +**SchemaAttributes** | Pointer to [**[]NonEmployeeSchemaAttribute**](non-employee-schema-attribute) | List of schema attributes associated with this non-employee source. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeSourceLiteWithSchemaAttributes = Initialize-PSSailpoint.BetaNonEmployeeSourceLiteWithSchemaAttributes -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -Name Retail ` + -Description Source description ` + -SchemaAttributes null +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeSourceLiteWithSchemaAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSourceRequestBody.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSourceRequestBody.md new file mode 100644 index 000000000..19941050e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSourceRequestBody.md @@ -0,0 +1,45 @@ +--- +id: beta-non-employee-source-request-body +title: NonEmployeeSourceRequestBody +pagination_label: NonEmployeeSourceRequestBody +sidebar_label: NonEmployeeSourceRequestBody +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceRequestBody', 'BetaNonEmployeeSourceRequestBody'] +slug: /tools/sdk/powershell/beta/models/non-employee-source-request-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceRequestBody', 'BetaNonEmployeeSourceRequestBody'] +--- + + +# NonEmployeeSourceRequestBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Name of non-employee source. | [required] +**Description** | **String** | Description of non-employee source. | [required] +**Owner** | [**NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | | [required] +**ManagementWorkgroup** | Pointer to **String** | The ID for the management workgroup that contains source sub-admins | [optional] +**Approvers** | Pointer to [**[]NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | List of approvers. | [optional] +**AccountManagers** | Pointer to [**[]NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | List of account managers. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeSourceRequestBody = Initialize-PSSailpoint.BetaNonEmployeeSourceRequestBody -Name Retail ` + -Description Source description ` + -Owner null ` + -ManagementWorkgroup 123299 ` + -Approvers null ` + -AccountManagers null +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeSourceRequestBody | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSourceWithCloudExternalId.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSourceWithCloudExternalId.md new file mode 100644 index 000000000..0d13f8dde --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSourceWithCloudExternalId.md @@ -0,0 +1,53 @@ +--- +id: beta-non-employee-source-with-cloud-external-id +title: NonEmployeeSourceWithCloudExternalId +pagination_label: NonEmployeeSourceWithCloudExternalId +sidebar_label: NonEmployeeSourceWithCloudExternalId +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceWithCloudExternalId', 'BetaNonEmployeeSourceWithCloudExternalId'] +slug: /tools/sdk/powershell/beta/models/non-employee-source-with-cloud-external-id +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceWithCloudExternalId', 'BetaNonEmployeeSourceWithCloudExternalId'] +--- + + +# NonEmployeeSourceWithCloudExternalId + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] +**Approvers** | Pointer to [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of approvers | [optional] +**AccountManagers** | Pointer to [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of account managers | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] +**NonEmployeeCount** | Pointer to **Int32** | The number of non-employee records on all sources that *requested-for* user manages. | [optional] +**CloudExternalId** | Pointer to **String** | Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeSourceWithCloudExternalId = Initialize-PSSailpoint.BetaNonEmployeeSourceWithCloudExternalId -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -Name Retail ` + -Description Source description ` + -Approvers null ` + -AccountManagers null ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z ` + -NonEmployeeCount 2 ` + -CloudExternalId 99999 +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeSourceWithCloudExternalId | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSourceWithNECount.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSourceWithNECount.md new file mode 100644 index 000000000..2c4c0f8c1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NonEmployeeSourceWithNECount.md @@ -0,0 +1,51 @@ +--- +id: beta-non-employee-source-with-ne-count +title: NonEmployeeSourceWithNECount +pagination_label: NonEmployeeSourceWithNECount +sidebar_label: NonEmployeeSourceWithNECount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceWithNECount', 'BetaNonEmployeeSourceWithNECount'] +slug: /tools/sdk/powershell/beta/models/non-employee-source-with-ne-count +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceWithNECount', 'BetaNonEmployeeSourceWithNECount'] +--- + + +# NonEmployeeSourceWithNECount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] +**Approvers** | Pointer to [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of approvers | [optional] +**AccountManagers** | Pointer to [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of account managers | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] +**NonEmployeeCount** | Pointer to **Int32** | Number of non-employee records associated with this source. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeSourceWithNECount = Initialize-PSSailpoint.BetaNonEmployeeSourceWithNECount -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -Name Retail ` + -Description Source description ` + -Approvers null ` + -AccountManagers null ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z ` + -NonEmployeeCount 2 +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeSourceWithNECount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NotificationTemplateContext.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NotificationTemplateContext.md new file mode 100644 index 000000000..acc9a26be --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/NotificationTemplateContext.md @@ -0,0 +1,39 @@ +--- +id: beta-notification-template-context +title: NotificationTemplateContext +pagination_label: NotificationTemplateContext +sidebar_label: NotificationTemplateContext +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NotificationTemplateContext', 'BetaNotificationTemplateContext'] +slug: /tools/sdk/powershell/beta/models/notification-template-context +tags: ['SDK', 'Software Development Kit', 'NotificationTemplateContext', 'BetaNotificationTemplateContext'] +--- + + +# NotificationTemplateContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A JSON object that stores the context. | [optional] +**Created** | Pointer to **System.DateTime** | When the global context was created | [optional] +**Modified** | Pointer to **System.DateTime** | When the global context was last modified | [optional] + +## Examples + +- Prepare the resource +```powershell +$NotificationTemplateContext = Initialize-PSSailpoint.BetaNotificationTemplateContext -Attributes {productUrl=https://test-org.identitysoon.com, brandingConfigs={default={narrowLogoURL=null, productName=SailPoint, standardLogoURL=null, navigationColor=011E64, actionButtonColor=20B2DE, emailFromAddress=null, activeLinkColor=20B2DE, loginInformationalMessage=null}}} ` + -Created 2020-04-15T16:16:47.525Z ` + -Modified 2020-04-15T16:16:47.525Z +``` + +- Convert the resource to JSON +```powershell +$NotificationTemplateContext | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ObjectExportImportOptions.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ObjectExportImportOptions.md new file mode 100644 index 000000000..1a9c601a3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ObjectExportImportOptions.md @@ -0,0 +1,37 @@ +--- +id: beta-object-export-import-options +title: ObjectExportImportOptions +pagination_label: ObjectExportImportOptions +sidebar_label: ObjectExportImportOptions +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectExportImportOptions', 'BetaObjectExportImportOptions'] +slug: /tools/sdk/powershell/beta/models/object-export-import-options +tags: ['SDK', 'Software Development Kit', 'ObjectExportImportOptions', 'BetaObjectExportImportOptions'] +--- + + +# ObjectExportImportOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IncludedIds** | Pointer to **[]String** | Object ids to be included in an import or export. | [optional] +**IncludedNames** | Pointer to **[]String** | Object names to be included in an import or export. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ObjectExportImportOptions = Initialize-PSSailpoint.BetaObjectExportImportOptions -IncludedIds null ` + -IncludedNames null +``` + +- Convert the resource to JSON +```powershell +$ObjectExportImportOptions | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ObjectImportResult.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ObjectImportResult.md new file mode 100644 index 000000000..cb2948ef0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ObjectImportResult.md @@ -0,0 +1,41 @@ +--- +id: beta-object-import-result +title: ObjectImportResult +pagination_label: ObjectImportResult +sidebar_label: ObjectImportResult +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectImportResult', 'BetaObjectImportResult'] +slug: /tools/sdk/powershell/beta/models/object-import-result +tags: ['SDK', 'Software Development Kit', 'ObjectImportResult', 'BetaObjectImportResult'] +--- + + +# ObjectImportResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Infos** | [**[]SpConfigMessage**](sp-config-message) | Informational messages returned from the target service on import. | [required] +**Warnings** | [**[]SpConfigMessage**](sp-config-message) | Warning messages returned from the target service on import. | [required] +**Errors** | [**[]SpConfigMessage**](sp-config-message) | Error messages returned from the target service on import. | [required] +**ImportedObjects** | [**[]ImportObject**](import-object) | References to objects that were created or updated by the import. | [required] + +## Examples + +- Prepare the resource +```powershell +$ObjectImportResult = Initialize-PSSailpoint.BetaObjectImportResult -Infos null ` + -Warnings null ` + -Errors null ` + -ImportedObjects null +``` + +- Convert the resource to JSON +```powershell +$ObjectImportResult | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OktaVerificationRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OktaVerificationRequest.md new file mode 100644 index 000000000..9a903b3ee --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OktaVerificationRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-okta-verification-request +title: OktaVerificationRequest +pagination_label: OktaVerificationRequest +sidebar_label: OktaVerificationRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OktaVerificationRequest', 'BetaOktaVerificationRequest'] +slug: /tools/sdk/powershell/beta/models/okta-verification-request +tags: ['SDK', 'Software Development Kit', 'OktaVerificationRequest', 'BetaOktaVerificationRequest'] +--- + + +# OktaVerificationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserId** | **String** | User identifier for Verification request. The value of the user's attribute. | [required] + +## Examples + +- Prepare the resource +```powershell +$OktaVerificationRequest = Initialize-PSSailpoint.BetaOktaVerificationRequest -UserId example@mail.com +``` + +- Convert the resource to JSON +```powershell +$OktaVerificationRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OrgConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OrgConfig.md new file mode 100644 index 000000000..c925daacb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OrgConfig.md @@ -0,0 +1,53 @@ +--- +id: beta-org-config +title: OrgConfig +pagination_label: OrgConfig +sidebar_label: OrgConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OrgConfig', 'BetaOrgConfig'] +slug: /tools/sdk/powershell/beta/models/org-config +tags: ['SDK', 'Software Development Kit', 'OrgConfig', 'BetaOrgConfig'] +--- + + +# OrgConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OrgName** | Pointer to **String** | The name of the org. | [optional] +**TimeZone** | Pointer to **String** | The selected time zone which is to be used for the org. This directly affects when scheduled tasks are executed. Valid options can be found at /beta/org-config/valid-time-zones | [optional] +**LcsChangeHonorsSourceEnableFeature** | Pointer to **Boolean** | Flag to determine whether the LCS_CHANGE_HONORS_SOURCE_ENABLE_FEATURE flag is enabled for the current org. | [optional] +**ArmCustomerId** | Pointer to **String** | ARM Customer ID | [optional] +**ArmSapSystemIdMappings** | Pointer to **String** | A list of IDN::sourceId to ARM::systemId mappings. | [optional] +**ArmAuth** | Pointer to **String** | ARM authentication string | [optional] +**ArmDb** | Pointer to **String** | ARM database name | [optional] +**ArmSsoUrl** | Pointer to **String** | ARM SSO URL | [optional] +**IaiEnableCertificationRecommendations** | Pointer to **Boolean** | Flag to determine whether IAI Certification Recommendations are enabled for the current org | [optional] +**SodReportConfigs** | Pointer to [**[]ReportConfigDTO**](report-config-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$OrgConfig = Initialize-PSSailpoint.BetaOrgConfig -OrgName acme-solar ` + -TimeZone America/Toronto ` + -LcsChangeHonorsSourceEnableFeature false ` + -ArmCustomerId DE38E75A-5FF6-4A65-5DC7-08D64426B09E ` + -ArmSapSystemIdMappings [{sourceId=2c91808c791a94e501792388b0d62659, systemId=1556}, {sourceId=2_2c91808c791a94e501792388b0d62659, systemId=2_1556}, {sourceId=3_2c91808c791a94e501792388b0d62659, systemId=3_1556}] ` + -ArmAuth epiYNTRYA2S7swisDWk1Zv4VMNgvqEjiBh5_ufuCWsma2m-5XADijqBg0ijXLby5nS6lxZNXabhGnAPGeDGc4V3jQKrhwV-UHypRLs8ZLgOjiQNus9NimS0uPdKomRW6TFWqXyfnYd-znNgbbVuwUy9GyD9ebDVJSntPastxSx7UcyGuWBqfNZYpuxKRWe_7TVY60qL55jUqyz8N4XUbbdcxdbZ0uik6ut-Bv90MKTbZexBW_PR4qcgIkaEs4kIenLyBxnGziYo7AO0tJ8bGHO8FJRkibCpAQIt7PISLo7Gg_Xf9j10dKq2YDgy4pPTvz3fE2ZHYnXCXvXFSA-vVag== ` + -ArmDb EU ` + -ArmSsoUrl https://your-arm-sso-url ` + -IaiEnableCertificationRecommendations true ` + -SodReportConfigs null +``` + +- Convert the resource to JSON +```powershell +$OrgConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Outlier.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Outlier.md new file mode 100644 index 000000000..76b705e30 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Outlier.md @@ -0,0 +1,55 @@ +--- +id: beta-outlier +title: Outlier +pagination_label: Outlier +sidebar_label: Outlier +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Outlier', 'BetaOutlier'] +slug: /tools/sdk/powershell/beta/models/outlier +tags: ['SDK', 'Software Development Kit', 'Outlier', 'BetaOutlier'] +--- + + +# Outlier + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The identity's unique identifier for the outlier record | [optional] +**IdentityId** | Pointer to **String** | The ID of the identity that is detected as an outlier | [optional] +**Type** | Pointer to **Enum** [ "LOW_SIMILARITY", "STRUCTURAL" ] | The type of outlier summary | [optional] +**FirstDetectionDate** | Pointer to **System.DateTime** | The first date the outlier was detected | [optional] +**LatestDetectionDate** | Pointer to **System.DateTime** | The most recent date the outlier was detected | [optional] +**Ignored** | Pointer to **Boolean** | Flag whether or not the outlier has been ignored | [optional] +**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Object containing mapped identity attributes | [optional] +**Score** | Pointer to **Double** | The outlier score determined by the detection engine ranging from 0..1 | [optional] +**UnignoreType** | Pointer to **Enum** [ "MANUAL", "AUTOMATIC" ] | Enum value of if the outlier manually or automatically un-ignored. Will be NULL if outlier is not ignored | [optional] +**UnignoreDate** | Pointer to **System.DateTime** | shows date when last time has been unignored outlier | [optional] +**IgnoreDate** | Pointer to **System.DateTime** | shows date when last time has been ignored outlier | [optional] + +## Examples + +- Prepare the resource +```powershell +$Outlier = Initialize-PSSailpoint.BetaOutlier -Id 5be33d3e-c54d-4ed7-af73-2380543e8283 ` + -IdentityId 5be33d3e-c54d-4ed7-af73-2380543e8283 ` + -Type LOW_SIMILARITY ` + -FirstDetectionDate 2021-05-01T18:40:35.772Z ` + -LatestDetectionDate 2021-05-03T18:40:35.772Z ` + -Ignored false ` + -Attributes {displayName=John Smith, jobTitle=Software Engineer, department=Engineering} ` + -Score 0.92 ` + -UnignoreType MANUAL ` + -UnignoreDate 2021-06-01T18:40:35.772Z ` + -IgnoreDate 2021-06-01T18:40:35.772Z +``` + +- Convert the resource to JSON +```powershell +$Outlier | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OutlierContributingFeature.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OutlierContributingFeature.md new file mode 100644 index 000000000..1f5509217 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OutlierContributingFeature.md @@ -0,0 +1,49 @@ +--- +id: beta-outlier-contributing-feature +title: OutlierContributingFeature +pagination_label: OutlierContributingFeature +sidebar_label: OutlierContributingFeature +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OutlierContributingFeature', 'BetaOutlierContributingFeature'] +slug: /tools/sdk/powershell/beta/models/outlier-contributing-feature +tags: ['SDK', 'Software Development Kit', 'OutlierContributingFeature', 'BetaOutlierContributingFeature'] +--- + + +# OutlierContributingFeature + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Contributing feature id | [optional] +**Name** | Pointer to **String** | The name of the feature | [optional] +**ValueType** | Pointer to **Enum** [ "INTEGER", "FLOAT" ] | The data type of the value field | [optional] +**Value** | Pointer to [**OutlierContributingFeatureValue**](outlier-contributing-feature-value) | | [optional] +**Importance** | Pointer to **Double** | The importance of the feature. This can also be a negative value | [optional] +**DisplayName** | Pointer to **String** | The (translated if header is passed) displayName for the feature | [optional] +**Description** | Pointer to **String** | The (translated if header is passed) description for the feature | [optional] +**TranslationMessages** | Pointer to [**OutlierFeatureTranslation**](outlier-feature-translation) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$OutlierContributingFeature = Initialize-PSSailpoint.BetaOutlierContributingFeature -Id 66e38828-5017-47af-92ff-9844871352c5 ` + -Name entitlement_count ` + -ValueType INTEGER ` + -Value null ` + -Importance -0.15 ` + -DisplayName Number of entitlements ` + -Description The total number of entitlements belonging to an identity ` + -TranslationMessages null +``` + +- Convert the resource to JSON +```powershell +$OutlierContributingFeature | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OutlierContributingFeatureValue.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OutlierContributingFeatureValue.md new file mode 100644 index 000000000..a7d28628f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OutlierContributingFeatureValue.md @@ -0,0 +1,34 @@ +--- +id: beta-outlier-contributing-feature-value +title: OutlierContributingFeatureValue +pagination_label: OutlierContributingFeatureValue +sidebar_label: OutlierContributingFeatureValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OutlierContributingFeatureValue', 'BetaOutlierContributingFeatureValue'] +slug: /tools/sdk/powershell/beta/models/outlier-contributing-feature-value +tags: ['SDK', 'Software Development Kit', 'OutlierContributingFeatureValue', 'BetaOutlierContributingFeatureValue'] +--- + + +# OutlierContributingFeatureValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$OutlierContributingFeatureValue = Initialize-PSSailpoint.BetaOutlierContributingFeatureValue +``` + +- Convert the resource to JSON +```powershell +$OutlierContributingFeatureValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OutlierFeatureSummary.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OutlierFeatureSummary.md new file mode 100644 index 000000000..4f476aec6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OutlierFeatureSummary.md @@ -0,0 +1,49 @@ +--- +id: beta-outlier-feature-summary +title: OutlierFeatureSummary +pagination_label: OutlierFeatureSummary +sidebar_label: OutlierFeatureSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OutlierFeatureSummary', 'BetaOutlierFeatureSummary'] +slug: /tools/sdk/powershell/beta/models/outlier-feature-summary +tags: ['SDK', 'Software Development Kit', 'OutlierFeatureSummary', 'BetaOutlierFeatureSummary'] +--- + + +# OutlierFeatureSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ContributingFeatureName** | Pointer to **String** | Contributing feature name | [optional] +**IdentityOutlierDisplayName** | Pointer to **String** | Identity display name | [optional] +**OutlierFeatureDisplayValues** | Pointer to [**[]OutlierFeatureSummaryOutlierFeatureDisplayValuesInner**](outlier-feature-summary-outlier-feature-display-values-inner) | | [optional] +**FeatureDefinition** | Pointer to **String** | Definition of the feature | [optional] +**FeatureExplanation** | Pointer to **String** | Detailed explanation of the feature | [optional] +**PeerDisplayName** | Pointer to **String** | outlier's peer identity display name | [optional] +**PeerIdentityId** | Pointer to **String** | outlier's peer identity id | [optional] +**AccessItemReference** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Access Item reference | [optional] + +## Examples + +- Prepare the resource +```powershell +$OutlierFeatureSummary = Initialize-PSSailpoint.BetaOutlierFeatureSummary -ContributingFeatureName Rare Access ` + -IdentityOutlierDisplayName John Smith ` + -OutlierFeatureDisplayValues null ` + -FeatureDefinition Identity total number of entitlements ` + -FeatureExplanation An identity that has too much rare access has a higher change of becoming a security threat due to the unique access they possess ` + -PeerDisplayName Mary Jane ` + -PeerIdentityId 9f9d5d53ad0e48fba7352f6da9f1b8gbg ` + -AccessItemReference {displayName=All Rare Entitlements, searchPlaceholder=Search by name or description} +``` + +- Convert the resource to JSON +```powershell +$OutlierFeatureSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OutlierFeatureSummaryOutlierFeatureDisplayValuesInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OutlierFeatureSummaryOutlierFeatureDisplayValuesInner.md new file mode 100644 index 000000000..26d9941e7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OutlierFeatureSummaryOutlierFeatureDisplayValuesInner.md @@ -0,0 +1,39 @@ +--- +id: beta-outlier-feature-summary-outlier-feature-display-values-inner +title: OutlierFeatureSummaryOutlierFeatureDisplayValuesInner +pagination_label: OutlierFeatureSummaryOutlierFeatureDisplayValuesInner +sidebar_label: OutlierFeatureSummaryOutlierFeatureDisplayValuesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OutlierFeatureSummaryOutlierFeatureDisplayValuesInner', 'BetaOutlierFeatureSummaryOutlierFeatureDisplayValuesInner'] +slug: /tools/sdk/powershell/beta/models/outlier-feature-summary-outlier-feature-display-values-inner +tags: ['SDK', 'Software Development Kit', 'OutlierFeatureSummaryOutlierFeatureDisplayValuesInner', 'BetaOutlierFeatureSummaryOutlierFeatureDisplayValuesInner'] +--- + + +# OutlierFeatureSummaryOutlierFeatureDisplayValuesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayName** | Pointer to **String** | display name | [optional] +**Value** | Pointer to **String** | value | [optional] +**ValueType** | Pointer to **Enum** [ "INTEGER", "FLOAT" ] | The data type of the value field | [optional] + +## Examples + +- Prepare the resource +```powershell +$OutlierFeatureSummaryOutlierFeatureDisplayValuesInner = Initialize-PSSailpoint.BetaOutlierFeatureSummaryOutlierFeatureDisplayValuesInner -DisplayName Aliza Chris ` + -Value 55 ` + -ValueType INTEGER +``` + +- Convert the resource to JSON +```powershell +$OutlierFeatureSummaryOutlierFeatureDisplayValuesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OutlierFeatureTranslation.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OutlierFeatureTranslation.md new file mode 100644 index 000000000..aa14d6267 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OutlierFeatureTranslation.md @@ -0,0 +1,37 @@ +--- +id: beta-outlier-feature-translation +title: OutlierFeatureTranslation +pagination_label: OutlierFeatureTranslation +sidebar_label: OutlierFeatureTranslation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OutlierFeatureTranslation', 'BetaOutlierFeatureTranslation'] +slug: /tools/sdk/powershell/beta/models/outlier-feature-translation +tags: ['SDK', 'Software Development Kit', 'OutlierFeatureTranslation', 'BetaOutlierFeatureTranslation'] +--- + + +# OutlierFeatureTranslation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayName** | Pointer to [**TranslationMessage**](translation-message) | | [optional] +**Description** | Pointer to [**TranslationMessage**](translation-message) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$OutlierFeatureTranslation = Initialize-PSSailpoint.BetaOutlierFeatureTranslation -DisplayName null ` + -Description null +``` + +- Convert the resource to JSON +```powershell +$OutlierFeatureTranslation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OutlierSummary.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OutlierSummary.md new file mode 100644 index 000000000..fb5a7980f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OutlierSummary.md @@ -0,0 +1,43 @@ +--- +id: beta-outlier-summary +title: OutlierSummary +pagination_label: OutlierSummary +sidebar_label: OutlierSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OutlierSummary', 'BetaOutlierSummary'] +slug: /tools/sdk/powershell/beta/models/outlier-summary +tags: ['SDK', 'Software Development Kit', 'OutlierSummary', 'BetaOutlierSummary'] +--- + + +# OutlierSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "LOW_SIMILARITY", "STRUCTURAL" ] | The type of outlier summary | [optional] +**SnapshotDate** | Pointer to **System.DateTime** | The date the bulk outlier detection ran/snapshot was created | [optional] +**TotalOutliers** | Pointer to **Int32** | Total number of outliers for the customer making the request | [optional] +**TotalIdentities** | Pointer to **Int32** | Total number of identities for the customer making the request | [optional] +**TotalIgnored** | Pointer to **Int32** | | [optional] [default to 0] + +## Examples + +- Prepare the resource +```powershell +$OutlierSummary = Initialize-PSSailpoint.BetaOutlierSummary -Type LOW_SIMILARITY ` + -SnapshotDate 2021-05-01T18:40:35.772Z ` + -TotalOutliers 50 ` + -TotalIdentities 5000 ` + -TotalIgnored 0 +``` + +- Convert the resource to JSON +```powershell +$OutlierSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OutliersContributingFeatureAccessItems.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OutliersContributingFeatureAccessItems.md new file mode 100644 index 000000000..e5f4251a3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OutliersContributingFeatureAccessItems.md @@ -0,0 +1,45 @@ +--- +id: beta-outliers-contributing-feature-access-items +title: OutliersContributingFeatureAccessItems +pagination_label: OutliersContributingFeatureAccessItems +sidebar_label: OutliersContributingFeatureAccessItems +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OutliersContributingFeatureAccessItems', 'BetaOutliersContributingFeatureAccessItems'] +slug: /tools/sdk/powershell/beta/models/outliers-contributing-feature-access-items +tags: ['SDK', 'Software Development Kit', 'OutliersContributingFeatureAccessItems', 'BetaOutliersContributingFeatureAccessItems'] +--- + + +# OutliersContributingFeatureAccessItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of the access item | [optional] +**DisplayName** | Pointer to **String** | the display name of the access item | [optional] +**Description** | Pointer to **String** | Description of the access item. | [optional] +**AccessType** | Pointer to **Enum** [ "ENTITLEMENT", "ACCESS_PROFILE", "ROLE" ] | The type of the access item. | [optional] +**SourceName** | Pointer to **String** | the associated source name if it exists | [optional] +**ExtremelyRare** | Pointer to **Boolean** | rarest access | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$OutliersContributingFeatureAccessItems = Initialize-PSSailpoint.BetaOutliersContributingFeatureAccessItems -Id 2c938083633d259901633d2623ec0375 ` + -DisplayName Applied Research Access ` + -Description Access to research information, lab results, and schematics ` + -AccessType ENTITLEMENT ` + -SourceName appName ` + -ExtremelyRare true +``` + +- Convert the resource to JSON +```powershell +$OutliersContributingFeatureAccessItems | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OwnerDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OwnerDto.md new file mode 100644 index 000000000..398471202 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OwnerDto.md @@ -0,0 +1,39 @@ +--- +id: beta-owner-dto +title: OwnerDto +pagination_label: OwnerDto +sidebar_label: OwnerDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OwnerDto', 'BetaOwnerDto'] +slug: /tools/sdk/powershell/beta/models/owner-dto +tags: ['SDK', 'Software Development Kit', 'OwnerDto', 'BetaOwnerDto'] +--- + + +# OwnerDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Owner's DTO type. | [optional] +**Id** | Pointer to **String** | Owner's identity ID. | [optional] +**Name** | Pointer to **String** | Owner's name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$OwnerDto = Initialize-PSSailpoint.BetaOwnerDto -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Support +``` + +- Convert the resource to JSON +```powershell +$OwnerDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OwnerReference.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OwnerReference.md new file mode 100644 index 000000000..8f7d23ad3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OwnerReference.md @@ -0,0 +1,39 @@ +--- +id: beta-owner-reference +title: OwnerReference +pagination_label: OwnerReference +sidebar_label: OwnerReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OwnerReference', 'BetaOwnerReference'] +slug: /tools/sdk/powershell/beta/models/owner-reference +tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'BetaOwnerReference'] +--- + + +# OwnerReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] +**Id** | Pointer to **String** | Identity id | [optional] +**Name** | Pointer to **String** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] + +## Examples + +- Prepare the resource +```powershell +$OwnerReference = Initialize-PSSailpoint.BetaOwnerReference -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name support +``` + +- Convert the resource to JSON +```powershell +$OwnerReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OwnerReferenceDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OwnerReferenceDto.md new file mode 100644 index 000000000..db63eae1f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OwnerReferenceDto.md @@ -0,0 +1,39 @@ +--- +id: beta-owner-reference-dto +title: OwnerReferenceDto +pagination_label: OwnerReferenceDto +sidebar_label: OwnerReferenceDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OwnerReferenceDto', 'BetaOwnerReferenceDto'] +slug: /tools/sdk/powershell/beta/models/owner-reference-dto +tags: ['SDK', 'Software Development Kit', 'OwnerReferenceDto', 'BetaOwnerReferenceDto'] +--- + + +# OwnerReferenceDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The owner id for the entitlement | [optional] +**Name** | Pointer to **String** | The owner name for the entitlement | [optional] +**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of the owner. Initially only type IDENTITY is supported | [optional] + +## Examples + +- Prepare the resource +```powershell +$OwnerReferenceDto = Initialize-PSSailpoint.BetaOwnerReferenceDto -Id 2a2fdacca5e345f18bf7970cfbb8fec2 ` + -Name identity 1 ` + -Type IDENTITY +``` + +- Convert the resource to JSON +```powershell +$OwnerReferenceDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OwnerReferenceSegments.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OwnerReferenceSegments.md new file mode 100644 index 000000000..4326820d8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/OwnerReferenceSegments.md @@ -0,0 +1,39 @@ +--- +id: beta-owner-reference-segments +title: OwnerReferenceSegments +pagination_label: OwnerReferenceSegments +sidebar_label: OwnerReferenceSegments +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OwnerReferenceSegments', 'BetaOwnerReferenceSegments'] +slug: /tools/sdk/powershell/beta/models/owner-reference-segments +tags: ['SDK', 'Software Development Kit', 'OwnerReferenceSegments', 'BetaOwnerReferenceSegments'] +--- + + +# OwnerReferenceSegments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] +**Id** | Pointer to **String** | Identity id | [optional] +**Name** | Pointer to **String** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] + +## Examples + +- Prepare the resource +```powershell +$OwnerReferenceSegments = Initialize-PSSailpoint.BetaOwnerReferenceSegments -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name support +``` + +- Convert the resource to JSON +```powershell +$OwnerReferenceSegments | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordChangeRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordChangeRequest.md new file mode 100644 index 000000000..b028bbd06 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordChangeRequest.md @@ -0,0 +1,43 @@ +--- +id: beta-password-change-request +title: PasswordChangeRequest +pagination_label: PasswordChangeRequest +sidebar_label: PasswordChangeRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordChangeRequest', 'BetaPasswordChangeRequest'] +slug: /tools/sdk/powershell/beta/models/password-change-request +tags: ['SDK', 'Software Development Kit', 'PasswordChangeRequest', 'BetaPasswordChangeRequest'] +--- + + +# PasswordChangeRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **String** | The identity ID that requested the password change | [optional] +**EncryptedPassword** | Pointer to **String** | The RSA encrypted password | [optional] +**PublicKeyId** | Pointer to **String** | The encryption key ID | [optional] +**AccountId** | Pointer to **String** | Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [optional] +**SourceId** | Pointer to **String** | The ID of the source for which identity is requesting the password change | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordChangeRequest = Initialize-PSSailpoint.BetaPasswordChangeRequest -IdentityId 8a807d4c73c545510173c545f0a002ff ` + -EncryptedPassword XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A== ` + -PublicKeyId YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2 ` + -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` + -SourceId 8a807d4c73c545510173c545d4b60246 +``` + +- Convert the resource to JSON +```powershell +$PasswordChangeRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordChangeResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordChangeResponse.md new file mode 100644 index 000000000..8f58289f1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordChangeResponse.md @@ -0,0 +1,37 @@ +--- +id: beta-password-change-response +title: PasswordChangeResponse +pagination_label: PasswordChangeResponse +sidebar_label: PasswordChangeResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordChangeResponse', 'BetaPasswordChangeResponse'] +slug: /tools/sdk/powershell/beta/models/password-change-response +tags: ['SDK', 'Software Development Kit', 'PasswordChangeResponse', 'BetaPasswordChangeResponse'] +--- + + +# PasswordChangeResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | Pointer to **String** | The password change request ID | [optional] +**State** | Pointer to **Enum** [ "IN_PROGRESS", "FINISHED", "FAILED" ] | Password change state | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordChangeResponse = Initialize-PSSailpoint.BetaPasswordChangeResponse -RequestId 089899f13a8f4da7824996191587bab9 ` + -State null +``` + +- Convert the resource to JSON +```powershell +$PasswordChangeResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordDigitToken.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordDigitToken.md new file mode 100644 index 000000000..7bd1d8de0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordDigitToken.md @@ -0,0 +1,37 @@ +--- +id: beta-password-digit-token +title: PasswordDigitToken +pagination_label: PasswordDigitToken +sidebar_label: PasswordDigitToken +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordDigitToken', 'BetaPasswordDigitToken'] +slug: /tools/sdk/powershell/beta/models/password-digit-token +tags: ['SDK', 'Software Development Kit', 'PasswordDigitToken', 'BetaPasswordDigitToken'] +--- + + +# PasswordDigitToken + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DigitToken** | Pointer to **String** | The digit token for password management | [optional] +**RequestId** | Pointer to **String** | The reference ID of the digit token generation request | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordDigitToken = Initialize-PSSailpoint.BetaPasswordDigitToken -DigitToken 09087713 ` + -RequestId e1267ecd-fcd9-4c73-9c55-12555efad136 +``` + +- Convert the resource to JSON +```powershell +$PasswordDigitToken | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordDigitTokenReset.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordDigitTokenReset.md new file mode 100644 index 000000000..9a36b724a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordDigitTokenReset.md @@ -0,0 +1,39 @@ +--- +id: beta-password-digit-token-reset +title: PasswordDigitTokenReset +pagination_label: PasswordDigitTokenReset +sidebar_label: PasswordDigitTokenReset +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordDigitTokenReset', 'BetaPasswordDigitTokenReset'] +slug: /tools/sdk/powershell/beta/models/password-digit-token-reset +tags: ['SDK', 'Software Development Kit', 'PasswordDigitTokenReset', 'BetaPasswordDigitTokenReset'] +--- + + +# PasswordDigitTokenReset + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserId** | **String** | The uid of the user requested for digit token | [required] +**Length** | Pointer to **Int32** | The length of digit token. It should be from 6 to 18, inclusive. The default value is 6. | [optional] +**DurationMinutes** | Pointer to **Int32** | The time to live for the digit token in minutes. The default value is 5 minutes. | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordDigitTokenReset = Initialize-PSSailpoint.BetaPasswordDigitTokenReset -UserId Abby.Smith ` + -Length 8 ` + -DurationMinutes 5 +``` + +- Convert the resource to JSON +```powershell +$PasswordDigitTokenReset | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordInfo.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordInfo.md new file mode 100644 index 000000000..4fda55938 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordInfo.md @@ -0,0 +1,45 @@ +--- +id: beta-password-info +title: PasswordInfo +pagination_label: PasswordInfo +sidebar_label: PasswordInfo +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordInfo', 'BetaPasswordInfo'] +slug: /tools/sdk/powershell/beta/models/password-info +tags: ['SDK', 'Software Development Kit', 'PasswordInfo', 'BetaPasswordInfo'] +--- + + +# PasswordInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **String** | | [optional] +**SourceId** | Pointer to **String** | | [optional] +**PublicKeyId** | Pointer to **String** | | [optional] +**PublicKey** | Pointer to **String** | User's public key with Base64 encoding | [optional] +**Accounts** | Pointer to [**[]PasswordInfoAccount**](password-info-account) | Account info related to queried identity and source | [optional] +**Policies** | Pointer to **[]String** | Password constraints | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordInfo = Initialize-PSSailpoint.BetaPasswordInfo -IdentityId 2c918085744fec4301746f9a5bce4605 ` + -SourceId 2c918083746f642c01746f990884012a ` + -PublicKeyId N2M1OTJiMGEtMDJlZS00ZWU3LTkyYTEtNjA5YmI5NWE3ZWVh ` + -PublicKey MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuGFkWi2J75TztpbaPKd36bJnIB3J8gZ6UcoS9oSDYsqBzPpTsfZXYaEf4Y4BKGgJIXmE/lwhwuj7mU1itdZ2qTSNFtnXA8Fn75c3UUkk+h+wdZbkuSmqlsJo3R1OnJkwkJggcAy9Jvk9jlcrNLWorpQ1w9raUvxtvfgkSdq153KxotenQ1HciSyZ0nA/Kw0UaucLnho8xdRowZs11afXGXA9IT9H6D8T6zUdtSxm0nAyH+mluma5LdTfaM50W3l/L8q56Vrqmx2pZIiwdx/0+g3Y++jV70zom0ZBkC1MmSoLMrQYG5OICNjr72f78B2PaGXfarQHqARLjKpMVt9YIQIDAQAB ` + -Accounts null ` + -Policies [passwordRepeatedChar is 3, passwordMinAlpha is 1, passwordMinLength is 5, passwordMinNumeric is 1] +``` + +- Convert the resource to JSON +```powershell +$PasswordInfo | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordInfoAccount.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordInfoAccount.md new file mode 100644 index 000000000..a422a7210 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordInfoAccount.md @@ -0,0 +1,37 @@ +--- +id: beta-password-info-account +title: PasswordInfoAccount +pagination_label: PasswordInfoAccount +sidebar_label: PasswordInfoAccount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordInfoAccount', 'BetaPasswordInfoAccount'] +slug: /tools/sdk/powershell/beta/models/password-info-account +tags: ['SDK', 'Software Development Kit', 'PasswordInfoAccount', 'BetaPasswordInfoAccount'] +--- + + +# PasswordInfoAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | Pointer to **String** | Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [optional] +**AccountName** | Pointer to **String** | Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008 | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordInfoAccount = Initialize-PSSailpoint.BetaPasswordInfoAccount -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` + -AccountName Abby.Smith +``` + +- Convert the resource to JSON +```powershell +$PasswordInfoAccount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordInfoQueryDTO.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordInfoQueryDTO.md new file mode 100644 index 000000000..4a1b4b1a8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordInfoQueryDTO.md @@ -0,0 +1,37 @@ +--- +id: beta-password-info-query-dto +title: PasswordInfoQueryDTO +pagination_label: PasswordInfoQueryDTO +sidebar_label: PasswordInfoQueryDTO +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordInfoQueryDTO', 'BetaPasswordInfoQueryDTO'] +slug: /tools/sdk/powershell/beta/models/password-info-query-dto +tags: ['SDK', 'Software Development Kit', 'PasswordInfoQueryDTO', 'BetaPasswordInfoQueryDTO'] +--- + + +# PasswordInfoQueryDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserName** | Pointer to **String** | The login name of the user | [optional] +**SourceName** | Pointer to **String** | The display name of the source | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordInfoQueryDTO = Initialize-PSSailpoint.BetaPasswordInfoQueryDTO -UserName Abby.Smith ` + -SourceName My-AD +``` + +- Convert the resource to JSON +```powershell +$PasswordInfoQueryDTO | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordOrgConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordOrgConfig.md new file mode 100644 index 000000000..ae0a2749e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordOrgConfig.md @@ -0,0 +1,41 @@ +--- +id: beta-password-org-config +title: PasswordOrgConfig +pagination_label: PasswordOrgConfig +sidebar_label: PasswordOrgConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordOrgConfig', 'BetaPasswordOrgConfig'] +slug: /tools/sdk/powershell/beta/models/password-org-config +tags: ['SDK', 'Software Development Kit', 'PasswordOrgConfig', 'BetaPasswordOrgConfig'] +--- + + +# PasswordOrgConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CustomInstructionsEnabled** | Pointer to **Boolean** | Indicator whether custom password instructions feature is enabled. The default value is false. | [optional] [default to $false] +**DigitTokenEnabled** | Pointer to **Boolean** | Indicator whether ""digit token"" feature is enabled. The default value is false. | [optional] [default to $false] +**DigitTokenDurationMinutes** | Pointer to **Int32** | The duration of ""digit token"" in minutes. The default value is 5. | [optional] [default to 5] +**DigitTokenLength** | Pointer to **Int32** | The length of ""digit token"". The default value is 6. | [optional] [default to 6] + +## Examples + +- Prepare the resource +```powershell +$PasswordOrgConfig = Initialize-PSSailpoint.BetaPasswordOrgConfig -CustomInstructionsEnabled true ` + -DigitTokenEnabled true ` + -DigitTokenDurationMinutes 10 ` + -DigitTokenLength 9 +``` + +- Convert the resource to JSON +```powershell +$PasswordOrgConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordPolicyV3Dto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordPolicyV3Dto.md new file mode 100644 index 000000000..c9fd05f50 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordPolicyV3Dto.md @@ -0,0 +1,95 @@ +--- +id: beta-password-policy-v3-dto +title: PasswordPolicyV3Dto +pagination_label: PasswordPolicyV3Dto +sidebar_label: PasswordPolicyV3Dto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordPolicyV3Dto', 'BetaPasswordPolicyV3Dto'] +slug: /tools/sdk/powershell/beta/models/password-policy-v3-dto +tags: ['SDK', 'Software Development Kit', 'PasswordPolicyV3Dto', 'BetaPasswordPolicyV3Dto'] +--- + + +# PasswordPolicyV3Dto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The password policy Id. | [optional] +**Description** | Pointer to **String** | Description for current password policy. | [optional] +**Name** | Pointer to **String** | The name of the password policy. | [optional] +**DateCreated** | Pointer to **System.DateTime** | Date the Password Policy was created. | [optional] +**LastUpdated** | Pointer to **System.DateTime** | Date the Password Policy was updated. | [optional] +**FirstExpirationReminder** | Pointer to **Int64** | The number of days before expiration remaninder. | [optional] +**AccountIdMinWordLength** | Pointer to **Int64** | The minimun length of account Id. By default is equals to -1. | [optional] +**AccountNameMinWordLength** | Pointer to **Int64** | The minimun length of account name. By default is equals to -1. | [optional] +**MinAlpha** | Pointer to **Int64** | Maximum alpha. By default is equals to 0. | [optional] +**MinCharacterTypes** | Pointer to **Int64** | MinCharacterTypes. By default is equals to -1. | [optional] +**MaxLength** | Pointer to **Int64** | Maximum length of the password. | [optional] +**MinLength** | Pointer to **Int64** | Minimum length of the password. By default is equals to 0. | [optional] +**MaxRepeatedChars** | Pointer to **Int64** | Maximum repetition of the same character in the password. By default is equals to -1. | [optional] +**MinLower** | Pointer to **Int64** | Minimum amount of lower case character in the password. By default is equals to 0. | [optional] +**MinNumeric** | Pointer to **Int64** | Minimum amount of numeric characters in the password. By default is equals to 0. | [optional] +**MinSpecial** | Pointer to **Int64** | Minimum amount of special symbols in the password. By default is equals to 0. | [optional] +**MinUpper** | Pointer to **Int64** | Minimum amount of upper case symbols in the password. By default is equals to 0. | [optional] +**PasswordExpiration** | Pointer to **Int64** | Number of days before current password expires. By default is equals to 90. | [optional] +**DefaultPolicy** | Pointer to **Boolean** | Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default. | [optional] [default to $false] +**EnablePasswdExpiration** | Pointer to **Boolean** | Defines whether this policy is enabled to expire or not. This field is false by default. | [optional] [default to $false] +**RequireStrongAuthn** | Pointer to **Boolean** | Defines whether this policy require strong Auth or not. This field is false by default. | [optional] [default to $false] +**RequireStrongAuthOffNetwork** | Pointer to **Boolean** | Defines whether this policy require strong Auth of network or not. This field is false by default. | [optional] [default to $false] +**RequireStrongAuthUntrustedGeographies** | Pointer to **Boolean** | Defines whether this policy require strong Auth for untrusted geographies. This field is false by default. | [optional] [default to $false] +**UseAccountAttributes** | Pointer to **Boolean** | Defines whether this policy uses account attributes or not. This field is false by default. | [optional] [default to $false] +**UseDictionary** | Pointer to **Boolean** | Defines whether this policy uses dictionary or not. This field is false by default. | [optional] [default to $false] +**UseIdentityAttributes** | Pointer to **Boolean** | Defines whether this policy uses identity attributes or not. This field is false by default. | [optional] [default to $false] +**ValidateAgainstAccountId** | Pointer to **Boolean** | Defines whether this policy validate against account id or not. This field is false by default. | [optional] [default to $false] +**ValidateAgainstAccountName** | Pointer to **Boolean** | Defines whether this policy validate against account name or not. This field is false by default. | [optional] [default to $false] +**Created** | Pointer to **String** | | [optional] +**Modified** | Pointer to **String** | | [optional] +**SourceIds** | Pointer to **[]String** | List of sources IDs managed by this password policy. | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordPolicyV3Dto = Initialize-PSSailpoint.BetaPasswordPolicyV3Dto -Id 2c91808e7d976f3b017d9f5ceae440c8 ` + -Description Information about the Password Policy ` + -Name PasswordPolicy Example ` + -DateCreated null ` + -LastUpdated null ` + -FirstExpirationReminder 45 ` + -AccountIdMinWordLength 4 ` + -AccountNameMinWordLength 6 ` + -MinAlpha 5 ` + -MinCharacterTypes 5 ` + -MaxLength 25 ` + -MinLength 8 ` + -MaxRepeatedChars 3 ` + -MinLower 8 ` + -MinNumeric 8 ` + -MinSpecial 8 ` + -MinUpper 8 ` + -PasswordExpiration 8 ` + -DefaultPolicy true ` + -EnablePasswdExpiration true ` + -RequireStrongAuthn true ` + -RequireStrongAuthOffNetwork true ` + -RequireStrongAuthUntrustedGeographies true ` + -UseAccountAttributes false ` + -UseDictionary false ` + -UseIdentityAttributes false ` + -ValidateAgainstAccountId false ` + -ValidateAgainstAccountName true ` + -Created null ` + -Modified null ` + -SourceIds [2c91808382ffee0b01830de154f14034, 2f98808382ffee0b01830de154f12134] +``` + +- Convert the resource to JSON +```powershell +$PasswordPolicyV3Dto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordStatus.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordStatus.md new file mode 100644 index 000000000..57c7f90af --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordStatus.md @@ -0,0 +1,41 @@ +--- +id: beta-password-status +title: PasswordStatus +pagination_label: PasswordStatus +sidebar_label: PasswordStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordStatus', 'BetaPasswordStatus'] +slug: /tools/sdk/powershell/beta/models/password-status +tags: ['SDK', 'Software Development Kit', 'PasswordStatus', 'BetaPasswordStatus'] +--- + + +# PasswordStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | Pointer to **String** | The password change request ID | [optional] +**State** | Pointer to **Enum** [ "IN_PROGRESS", "FINISHED", "FAILED" ] | Password change state | [optional] +**Errors** | Pointer to **[]String** | The errors during the password change request | [optional] +**SourceIds** | Pointer to **[]String** | List of source IDs in the password change request | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordStatus = Initialize-PSSailpoint.BetaPasswordStatus -RequestId 089899f13a8f4da7824996191587bab9 ` + -State null ` + -Errors null ` + -SourceIds null +``` + +- Convert the resource to JSON +```powershell +$PasswordStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordSyncGroup.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordSyncGroup.md new file mode 100644 index 000000000..2c8440149 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PasswordSyncGroup.md @@ -0,0 +1,45 @@ +--- +id: beta-password-sync-group +title: PasswordSyncGroup +pagination_label: PasswordSyncGroup +sidebar_label: PasswordSyncGroup +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordSyncGroup', 'BetaPasswordSyncGroup'] +slug: /tools/sdk/powershell/beta/models/password-sync-group +tags: ['SDK', 'Software Development Kit', 'PasswordSyncGroup', 'BetaPasswordSyncGroup'] +--- + + +# PasswordSyncGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the sync group | [optional] +**Name** | Pointer to **String** | Name of the sync group | [optional] +**PasswordPolicyId** | Pointer to **String** | ID of the password policy | [optional] +**SourceIds** | Pointer to **[]String** | List of password managed sources IDs | [optional] +**Created** | Pointer to **System.DateTime** | The date and time this sync group was created | [optional] +**Modified** | Pointer to **System.DateTime** | The date and time this sync group was last modified | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordSyncGroup = Initialize-PSSailpoint.BetaPasswordSyncGroup -Id 6881f631-3bd5-4213-9c75-8e05cc3e35dd ` + -Name Password Sync Group 1 ` + -PasswordPolicyId 2c91808d744ba0ce01746f93b6204501 ` + -SourceIds [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500] ` + -Created 2023-03-16T04:00Z ` + -Modified 2023-03-16T04:00Z +``` + +- Convert the resource to JSON +```powershell +$PasswordSyncGroup | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PatOwner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PatOwner.md new file mode 100644 index 000000000..3f72ac208 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PatOwner.md @@ -0,0 +1,39 @@ +--- +id: beta-pat-owner +title: PatOwner +pagination_label: PatOwner +sidebar_label: PatOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PatOwner', 'BetaPatOwner'] +slug: /tools/sdk/powershell/beta/models/pat-owner +tags: ['SDK', 'Software Development Kit', 'PatOwner', 'BetaPatOwner'] +--- + + +# PatOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Personal access token owner's DTO type. | [optional] +**Id** | Pointer to **String** | Personal access token owner's identity ID. | [optional] +**Name** | Pointer to **String** | Personal access token owner's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$PatOwner = Initialize-PSSailpoint.BetaPatOwner -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Support +``` + +- Convert the resource to JSON +```powershell +$PatOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PatchPotentialRoleRequestInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PatchPotentialRoleRequestInner.md new file mode 100644 index 000000000..dfeda9e66 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PatchPotentialRoleRequestInner.md @@ -0,0 +1,39 @@ +--- +id: beta-patch-potential-role-request-inner +title: PatchPotentialRoleRequestInner +pagination_label: PatchPotentialRoleRequestInner +sidebar_label: PatchPotentialRoleRequestInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PatchPotentialRoleRequestInner', 'BetaPatchPotentialRoleRequestInner'] +slug: /tools/sdk/powershell/beta/models/patch-potential-role-request-inner +tags: ['SDK', 'Software Development Kit', 'PatchPotentialRoleRequestInner', 'BetaPatchPotentialRoleRequestInner'] +--- + + +# PatchPotentialRoleRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | Pointer to **Enum** [ "remove", "replace" ] | The operation to be performed | [optional] +**Path** | **String** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required] +**Value** | Pointer to [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PatchPotentialRoleRequestInner = Initialize-PSSailpoint.BetaPatchPotentialRoleRequestInner -Op replace ` + -Path /description ` + -Value null +``` + +- Convert the resource to JSON +```powershell +$PatchPotentialRoleRequestInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PatchServiceDeskIntegrationRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PatchServiceDeskIntegrationRequest.md new file mode 100644 index 000000000..48e4ae19b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PatchServiceDeskIntegrationRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-patch-service-desk-integration-request +title: PatchServiceDeskIntegrationRequest +pagination_label: PatchServiceDeskIntegrationRequest +sidebar_label: PatchServiceDeskIntegrationRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PatchServiceDeskIntegrationRequest', 'BetaPatchServiceDeskIntegrationRequest'] +slug: /tools/sdk/powershell/beta/models/patch-service-desk-integration-request +tags: ['SDK', 'Software Development Kit', 'PatchServiceDeskIntegrationRequest', 'BetaPatchServiceDeskIntegrationRequest'] +--- + + +# PatchServiceDeskIntegrationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operations** | Pointer to [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] + +## Examples + +- Prepare the resource +```powershell +$PatchServiceDeskIntegrationRequest = Initialize-PSSailpoint.BetaPatchServiceDeskIntegrationRequest -Operations null +``` + +- Convert the resource to JSON +```powershell +$PatchServiceDeskIntegrationRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PeerGroupMember.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PeerGroupMember.md new file mode 100644 index 000000000..742e5e451 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PeerGroupMember.md @@ -0,0 +1,41 @@ +--- +id: beta-peer-group-member +title: PeerGroupMember +pagination_label: PeerGroupMember +sidebar_label: PeerGroupMember +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PeerGroupMember', 'BetaPeerGroupMember'] +slug: /tools/sdk/powershell/beta/models/peer-group-member +tags: ['SDK', 'Software Development Kit', 'PeerGroupMember', 'BetaPeerGroupMember'] +--- + + +# PeerGroupMember + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | A unique identifier for the peer group member. | [optional] +**Type** | Pointer to **String** | The type of the peer group member. | [optional] +**PeerGroupId** | Pointer to **String** | The ID of the peer group. | [optional] +**Attributes** | Pointer to [**map[string]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Arbitrary key-value pairs, belonging to the peer group member. | [optional] + +## Examples + +- Prepare the resource +```powershell +$PeerGroupMember = Initialize-PSSailpoint.BetaPeerGroupMember -Id null ` + -Type null ` + -PeerGroupId null ` + -Attributes null +``` + +- Convert the resource to JSON +```powershell +$PeerGroupMember | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PendingApproval.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PendingApproval.md new file mode 100644 index 000000000..f0d0fafbd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PendingApproval.md @@ -0,0 +1,71 @@ +--- +id: beta-pending-approval +title: PendingApproval +pagination_label: PendingApproval +sidebar_label: PendingApproval +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PendingApproval', 'BetaPendingApproval'] +slug: /tools/sdk/powershell/beta/models/pending-approval +tags: ['SDK', 'Software Development Kit', 'PendingApproval', 'BetaPendingApproval'] +--- + + +# PendingApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The approval id. | [optional] +**Name** | Pointer to **String** | The name of the approval. | [optional] +**Created** | Pointer to **System.DateTime** | When the approval was created. | [optional] +**Modified** | Pointer to **System.DateTime** | When the approval was modified last time. | [optional] +**RequestCreated** | Pointer to **System.DateTime** | When the access-request was created. | [optional] +**RequestType** | Pointer to [**AccessRequestType**](access-request-type) | | [optional] +**Requester** | Pointer to [**AccessItemRequesterDto**](access-item-requester-dto) | | [optional] +**RequestedFor** | Pointer to [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [optional] +**Owner** | Pointer to [**AccessItemOwnerDto**](access-item-owner-dto) | | [optional] +**RequestedObject** | Pointer to [**RequestableObjectReference**](requestable-object-reference) | | [optional] +**RequesterComment** | Pointer to [**CommentDto1**](comment-dto1) | | [optional] +**PreviousReviewersComments** | Pointer to [**[]CommentDto1**](comment-dto1) | The history of the previous reviewers comments. | [optional] +**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] +**CommentRequiredWhenRejected** | Pointer to **Boolean** | When true the rejector has to provide comments when rejecting | [optional] [default to $false] +**ActionInProcess** | Pointer to [**PendingApprovalAction**](pending-approval-action) | | [optional] +**RemoveDate** | Pointer to **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +**RemoveDateUpdateRequested** | Pointer to **Boolean** | If true, then the request is to change the remove date or sunset date. | [optional] [default to $false] +**CurrentRemoveDate** | Pointer to **System.DateTime** | The remove date or sunset date that was assigned at the time of the request. | [optional] +**SodViolationContext** | Pointer to [**SodViolationContextCheckCompleted1**](sod-violation-context-check-completed1) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PendingApproval = Initialize-PSSailpoint.BetaPendingApproval -Id 2c9180835d2e5168015d32f890ca1581 ` + -Name Pending approval name ` + -Created 2017-07-11T18:45:37.098Z ` + -Modified 2018-07-25T20:22:28.104Z ` + -RequestCreated 2017-07-11T18:45:35.098Z ` + -RequestType null ` + -Requester null ` + -RequestedFor null ` + -Owner null ` + -RequestedObject null ` + -RequesterComment null ` + -PreviousReviewersComments null ` + -ForwardHistory null ` + -CommentRequiredWhenRejected true ` + -ActionInProcess null ` + -RemoveDate 2020-07-11T00:00Z ` + -RemoveDateUpdateRequested true ` + -CurrentRemoveDate 2020-07-11T00:00Z ` + -SodViolationContext null +``` + +- Convert the resource to JSON +```powershell +$PendingApproval | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PendingApprovalAction.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PendingApprovalAction.md new file mode 100644 index 000000000..c189b69d3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PendingApprovalAction.md @@ -0,0 +1,26 @@ +--- +id: beta-pending-approval-action +title: PendingApprovalAction +pagination_label: PendingApprovalAction +sidebar_label: PendingApprovalAction +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PendingApprovalAction', 'BetaPendingApprovalAction'] +slug: /tools/sdk/powershell/beta/models/pending-approval-action +tags: ['SDK', 'Software Development Kit', 'PendingApprovalAction', 'BetaPendingApprovalAction'] +--- + + +# PendingApprovalAction + +## Enum + + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `FORWARDED` (value: `"FORWARDED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PermissionDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PermissionDto.md new file mode 100644 index 000000000..8db8b0296 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PermissionDto.md @@ -0,0 +1,37 @@ +--- +id: beta-permission-dto +title: PermissionDto +pagination_label: PermissionDto +sidebar_label: PermissionDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PermissionDto', 'BetaPermissionDto'] +slug: /tools/sdk/powershell/beta/models/permission-dto +tags: ['SDK', 'Software Development Kit', 'PermissionDto', 'BetaPermissionDto'] +--- + + +# PermissionDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Rights** | Pointer to **[]String** | All the rights (e.g. actions) that this permission allows on the target | [optional] [readonly] +**Target** | Pointer to **String** | The target the permission would grants rights on. | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$PermissionDto = Initialize-PSSailpoint.BetaPermissionDto -Rights null ` + -Target SYS.GV_$TRANSACTION +``` + +- Convert the resource to JSON +```powershell +$PermissionDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PostExternalExecuteWorkflow200Response.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PostExternalExecuteWorkflow200Response.md new file mode 100644 index 000000000..eb54214f9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PostExternalExecuteWorkflow200Response.md @@ -0,0 +1,37 @@ +--- +id: beta-post-external-execute-workflow200-response +title: PostExternalExecuteWorkflow200Response +pagination_label: PostExternalExecuteWorkflow200Response +sidebar_label: PostExternalExecuteWorkflow200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PostExternalExecuteWorkflow200Response', 'BetaPostExternalExecuteWorkflow200Response'] +slug: /tools/sdk/powershell/beta/models/post-external-execute-workflow200-response +tags: ['SDK', 'Software Development Kit', 'PostExternalExecuteWorkflow200Response', 'BetaPostExternalExecuteWorkflow200Response'] +--- + + +# PostExternalExecuteWorkflow200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**WorkflowExecutionId** | Pointer to **String** | The workflow execution id | [optional] +**Message** | Pointer to **String** | An error message if any errors occurred | [optional] + +## Examples + +- Prepare the resource +```powershell +$PostExternalExecuteWorkflow200Response = Initialize-PSSailpoint.BetaPostExternalExecuteWorkflow200Response -WorkflowExecutionId 0e11cefa-96e7-4b67-90d0-065bc1da5753 ` + -Message Workflow was not executed externally. Check enabled flag on workflow definition +``` + +- Convert the resource to JSON +```powershell +$PostExternalExecuteWorkflow200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PostExternalExecuteWorkflowRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PostExternalExecuteWorkflowRequest.md new file mode 100644 index 000000000..7a83afe31 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PostExternalExecuteWorkflowRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-post-external-execute-workflow-request +title: PostExternalExecuteWorkflowRequest +pagination_label: PostExternalExecuteWorkflowRequest +sidebar_label: PostExternalExecuteWorkflowRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PostExternalExecuteWorkflowRequest', 'BetaPostExternalExecuteWorkflowRequest'] +slug: /tools/sdk/powershell/beta/models/post-external-execute-workflow-request +tags: ['SDK', 'Software Development Kit', 'PostExternalExecuteWorkflowRequest', 'BetaPostExternalExecuteWorkflowRequest'] +--- + + +# PostExternalExecuteWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarInput** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The input for the workflow | [optional] + +## Examples + +- Prepare the resource +```powershell +$PostExternalExecuteWorkflowRequest = Initialize-PSSailpoint.BetaPostExternalExecuteWorkflowRequest -VarInput {customAttribute1=value1, customAttribute2=value2} +``` + +- Convert the resource to JSON +```powershell +$PostExternalExecuteWorkflowRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PreApprovalTriggerDetails.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PreApprovalTriggerDetails.md new file mode 100644 index 000000000..7868b53d9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PreApprovalTriggerDetails.md @@ -0,0 +1,39 @@ +--- +id: beta-pre-approval-trigger-details +title: PreApprovalTriggerDetails +pagination_label: PreApprovalTriggerDetails +sidebar_label: PreApprovalTriggerDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PreApprovalTriggerDetails', 'BetaPreApprovalTriggerDetails'] +slug: /tools/sdk/powershell/beta/models/pre-approval-trigger-details +tags: ['SDK', 'Software Development Kit', 'PreApprovalTriggerDetails', 'BetaPreApprovalTriggerDetails'] +--- + + +# PreApprovalTriggerDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment left for the pre-approval decision | [optional] +**Reviewer** | Pointer to **String** | The reviewer of the pre-approval decision | [optional] +**Decision** | Pointer to **Enum** [ "APPROVED", "REJECTED" ] | The decision of the pre-approval trigger | [optional] + +## Examples + +- Prepare the resource +```powershell +$PreApprovalTriggerDetails = Initialize-PSSailpoint.BetaPreApprovalTriggerDetails -Comment Access is Approved ` + -Reviewer John Doe ` + -Decision APPROVED +``` + +- Convert the resource to JSON +```powershell +$PreApprovalTriggerDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PreferencesDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PreferencesDto.md new file mode 100644 index 000000000..4d52ca83d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PreferencesDto.md @@ -0,0 +1,39 @@ +--- +id: beta-preferences-dto +title: PreferencesDto +pagination_label: PreferencesDto +sidebar_label: PreferencesDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PreferencesDto', 'BetaPreferencesDto'] +slug: /tools/sdk/powershell/beta/models/preferences-dto +tags: ['SDK', 'Software Development Kit', 'PreferencesDto', 'BetaPreferencesDto'] +--- + + +# PreferencesDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **String** | The template notification key. | [optional] +**Mediums** | Pointer to [**[]Medium**](medium) | List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future. | [optional] +**Modified** | Pointer to **System.DateTime** | Modified date of preference | [optional] + +## Examples + +- Prepare the resource +```powershell +$PreferencesDto = Initialize-PSSailpoint.BetaPreferencesDto -Key cloud_manual_work_item_summary ` + -Mediums [EMAIL] ` + -Modified 2020-05-15T14:37:06.909Z +``` + +- Convert the resource to JSON +```powershell +$PreferencesDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PreviewDataSourceResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PreviewDataSourceResponse.md new file mode 100644 index 000000000..9b6fefb06 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PreviewDataSourceResponse.md @@ -0,0 +1,35 @@ +--- +id: beta-preview-data-source-response +title: PreviewDataSourceResponse +pagination_label: PreviewDataSourceResponse +sidebar_label: PreviewDataSourceResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PreviewDataSourceResponse', 'BetaPreviewDataSourceResponse'] +slug: /tools/sdk/powershell/beta/models/preview-data-source-response +tags: ['SDK', 'Software Development Kit', 'PreviewDataSourceResponse', 'BetaPreviewDataSourceResponse'] +--- + + +# PreviewDataSourceResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Results** | Pointer to [**[]FormElementDataSourceConfigOptions**](form-element-data-source-config-options) | Results holds a list of FormElementDataSourceConfigOptions items | [optional] + +## Examples + +- Prepare the resource +```powershell +$PreviewDataSourceResponse = Initialize-PSSailpoint.BetaPreviewDataSourceResponse -Results {"results":[{"label":"Alfred 255e71dfc6e","subLabel":"Alfred.255e71dfc6e@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16676"},{"label":"Alize eba9d4cd27da","subLabel":"Alize.eba9d4cd27da@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f1667c"},{"label":"Antonina 01f69c3ea","subLabel":"Antonina.01f69c3ea@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f9667e"},{"label":"Ardella 21e78ce155","subLabel":"Ardella.21e78ce155@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e6667a"},{"label":"Arnaldo d8582b6e17","subLabel":"Arnaldo.d8582b6e17@testmail.identitysoon.com","value":"2c918084821847c5018227ced3426686"},{"label":"Aurelia admin24828","subLabel":"Aurelia.admin24828@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16674"},{"label":"Barbara 72ca418fdd","subLabel":"Barbara.72ca418fdd@testmail.identitysoon.com","value":"2c918084821847c5018227ced2fb6680"},{"label":"Barbara ee1a2436ee","subLabel":"Barbara.ee1a2436ee@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e56678"},{"label":"Baylee 652d72432f3","subLabel":"Baylee.652d72432f3@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aee"},{"label":"Brock e76b56ae4d49","subLabel":"Brock.e76b56ae4d49@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aef"}]} +``` + +- Convert the resource to JSON +```powershell +$PreviewDataSourceResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProcessIdentitiesRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProcessIdentitiesRequest.md new file mode 100644 index 000000000..7d0ad32a8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProcessIdentitiesRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-process-identities-request +title: ProcessIdentitiesRequest +pagination_label: ProcessIdentitiesRequest +sidebar_label: ProcessIdentitiesRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProcessIdentitiesRequest', 'BetaProcessIdentitiesRequest'] +slug: /tools/sdk/powershell/beta/models/process-identities-request +tags: ['SDK', 'Software Development Kit', 'ProcessIdentitiesRequest', 'BetaProcessIdentitiesRequest'] +--- + + +# ProcessIdentitiesRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityIds** | Pointer to **[]String** | List of up to 250 identity IDs to process. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProcessIdentitiesRequest = Initialize-PSSailpoint.BetaProcessIdentitiesRequest -IdentityIds null +``` + +- Convert the resource to JSON +```powershell +$ProcessIdentitiesRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Product.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Product.md new file mode 100644 index 000000000..60dd22857 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Product.md @@ -0,0 +1,65 @@ +--- +id: beta-product +title: Product +pagination_label: Product +sidebar_label: Product +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Product', 'BetaProduct'] +slug: /tools/sdk/powershell/beta/models/product +tags: ['SDK', 'Software Development Kit', 'Product', 'BetaProduct'] +--- + + +# Product + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ProductName** | Pointer to **String** | Name of the Product | [optional] +**Url** | Pointer to **String** | URL of the Product | [optional] +**ProductTenantId** | Pointer to **String** | An identifier for a specific product-tenant combination | [optional] +**ProductRegion** | Pointer to **String** | Product region | [optional] +**ProductRight** | Pointer to **String** | Right needed for the Product | [optional] +**ApiUrl** | Pointer to **String** | API URL of the Product | [optional] +**Licenses** | Pointer to [**[]License**](license) | | [optional] +**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Additional attributes for a product | [optional] +**Zone** | Pointer to **String** | Zone | [optional] +**Status** | Pointer to **String** | Status of the product | [optional] +**StatusDateTime** | Pointer to **System.DateTime** | Status datetime | [optional] +**Reason** | Pointer to **String** | If there's a tenant provisioning failure then reason will have the description of error | [optional] +**Notes** | Pointer to **String** | Product could have additional notes added during tenant provisioning. | [optional] +**DateCreated** | Pointer to **System.DateTime** | Date when the product was created | [optional] +**LastUpdated** | Pointer to **System.DateTime** | Date when the product was last updated | [optional] +**OrgType** | Pointer to **Enum** [ "development", "staging", "production", "test", "partner", "training", "demonstration", "sandbox" ] | Type of org | [optional] + +## Examples + +- Prepare the resource +```powershell +$Product = Initialize-PSSailpoint.BetaProduct -ProductName idn ` + -Url https://tenant-name.identitynow.com ` + -ProductTenantId tenant#product ` + -ProductRegion us-east-1 ` + -ProductRight idn:ui:view ` + -ApiUrl https://tenant-name.api.identitynow.com ` + -Licenses null ` + -Attributes {domain=https://tenant-name.identitynow.com, maxRegisteredUsers=250} ` + -Zone Deployment zone for the Product ` + -Status active ` + -StatusDateTime 2020-05-19T13:49:37.385Z ` + -Reason Reason ` + -Notes Example notes ` + -DateCreated 2020-05-19T13:49:37.385Z ` + -LastUpdated 2020-05-19T13:49:37.385Z ` + -OrgType test +``` + +- Convert the resource to JSON +```powershell +$Product | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCompleted.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCompleted.md new file mode 100644 index 000000000..43e2ebb9f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCompleted.md @@ -0,0 +1,49 @@ +--- +id: beta-provisioning-completed +title: ProvisioningCompleted +pagination_label: ProvisioningCompleted +sidebar_label: ProvisioningCompleted +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCompleted', 'BetaProvisioningCompleted'] +slug: /tools/sdk/powershell/beta/models/provisioning-completed +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompleted', 'BetaProvisioningCompleted'] +--- + + +# ProvisioningCompleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TrackingNumber** | **String** | The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. | [required] +**Sources** | **String** | One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. | [required] +**Action** | Pointer to **String** | Origin of where the provisioning request came from. | [optional] +**Errors** | Pointer to **[]String** | A list of any accumulated error messages that occurred during provisioning. | [optional] +**Warnings** | Pointer to **[]String** | A list of any accumulated warning messages that occurred during provisioning. | [optional] +**Recipient** | [**ProvisioningCompletedRecipient**](provisioning-completed-recipient) | | [required] +**Requester** | Pointer to [**ProvisioningCompletedRequester**](provisioning-completed-requester) | | [optional] +**AccountRequests** | [**[]ProvisioningCompletedAccountRequestsInner**](provisioning-completed-account-requests-inner) | A list of provisioning instructions to perform on an account-by-account basis. | [required] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningCompleted = Initialize-PSSailpoint.BetaProvisioningCompleted -TrackingNumber 4b4d982dddff4267ab12f0f1e72b5a6d ` + -Sources Corp AD, Corp LDAP, Corp Salesforce ` + -Action IdentityRefresh ` + -Errors null ` + -Warnings null ` + -Recipient null ` + -Requester null ` + -AccountRequests null +``` + +- Convert the resource to JSON +```powershell +$ProvisioningCompleted | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCompletedAccountRequestsInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCompletedAccountRequestsInner.md new file mode 100644 index 000000000..0e10aaf2d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCompletedAccountRequestsInner.md @@ -0,0 +1,47 @@ +--- +id: beta-provisioning-completed-account-requests-inner +title: ProvisioningCompletedAccountRequestsInner +pagination_label: ProvisioningCompletedAccountRequestsInner +sidebar_label: ProvisioningCompletedAccountRequestsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCompletedAccountRequestsInner', 'BetaProvisioningCompletedAccountRequestsInner'] +slug: /tools/sdk/powershell/beta/models/provisioning-completed-account-requests-inner +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsInner', 'BetaProvisioningCompletedAccountRequestsInner'] +--- + + +# ProvisioningCompletedAccountRequestsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | [**ProvisioningCompletedAccountRequestsInnerSource**](provisioning-completed-account-requests-inner-source) | | [required] +**AccountId** | Pointer to **String** | The unique idenfier of the account being provisioned. | [optional] +**AccountOperation** | **String** | The provisioning operation; typically Create, Modify, Enable, Disable, Unlock, or Delete. | [required] +**ProvisioningResult** | **Enum** [ "SUCCESS", "PENDING", "FAILED" ] | The overall result of the provisioning transaction; this could be success, pending, failed, etc. | [required] +**ProvisioningTarget** | **String** | The name of the provisioning channel selected; this could be the same as the source, or could be a Service Desk Integration Module (SDIM). | [required] +**TicketId** | Pointer to **String** | A reference to a tracking number, if this is sent to a Service Desk Integration Module (SDIM). | [optional] +**AttributeRequests** | Pointer to [**[]ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner**](provisioning-completed-account-requests-inner-attribute-requests-inner) | A list of attributes as part of the provisioning transaction. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningCompletedAccountRequestsInner = Initialize-PSSailpoint.BetaProvisioningCompletedAccountRequestsInner -Source null ` + -AccountId CN=Chewy.Bacca,ou=hardcorefigter,ou=wookies,dc=starwars,dc=com ` + -AccountOperation Modify ` + -ProvisioningResult SUCCESS ` + -ProvisioningTarget Corp AD ` + -TicketId 72619262 ` + -AttributeRequests null +``` + +- Convert the resource to JSON +```powershell +$ProvisioningCompletedAccountRequestsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md new file mode 100644 index 000000000..45d175d59 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md @@ -0,0 +1,39 @@ +--- +id: beta-provisioning-completed-account-requests-inner-attribute-requests-inner +title: ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner +pagination_label: ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner +sidebar_label: ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner', 'BetaProvisioningCompletedAccountRequestsInnerAttributeRequestsInner'] +slug: /tools/sdk/powershell/beta/models/provisioning-completed-account-requests-inner-attribute-requests-inner +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner', 'BetaProvisioningCompletedAccountRequestsInnerAttributeRequestsInner'] +--- + + +# ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AttributeName** | **String** | The name of the attribute being provisioned. | [required] +**AttributeValue** | Pointer to **String** | The value of the attribute being provisioned. | [optional] +**Operation** | **Enum** [ "Add", "Set", "Remove" ] | The operation to handle the attribute. | [required] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner = Initialize-PSSailpoint.BetaProvisioningCompletedAccountRequestsInnerAttributeRequestsInner -AttributeName memberOf ` + -AttributeValue CN=jedi,DC=starwars,DC=com ` + -Operation Add +``` + +- Convert the resource to JSON +```powershell +$ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCompletedAccountRequestsInnerSource.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCompletedAccountRequestsInnerSource.md new file mode 100644 index 000000000..c377676fb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCompletedAccountRequestsInnerSource.md @@ -0,0 +1,39 @@ +--- +id: beta-provisioning-completed-account-requests-inner-source +title: ProvisioningCompletedAccountRequestsInnerSource +pagination_label: ProvisioningCompletedAccountRequestsInnerSource +sidebar_label: ProvisioningCompletedAccountRequestsInnerSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCompletedAccountRequestsInnerSource', 'BetaProvisioningCompletedAccountRequestsInnerSource'] +slug: /tools/sdk/powershell/beta/models/provisioning-completed-account-requests-inner-source +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsInnerSource', 'BetaProvisioningCompletedAccountRequestsInnerSource'] +--- + + +# ProvisioningCompletedAccountRequestsInnerSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | ID of the object to which this reference applies | [required] +**Type** | **Enum** [ "SOURCE" ] | The type of object that is referenced | [required] +**Name** | **String** | Human-readable display name of the object to which this reference applies | [required] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningCompletedAccountRequestsInnerSource = Initialize-PSSailpoint.BetaProvisioningCompletedAccountRequestsInnerSource -Id 4e4d982dddff4267ab12f0f1e72b5a6d ` + -Type SOURCE ` + -Name Corporate Active Directory +``` + +- Convert the resource to JSON +```powershell +$ProvisioningCompletedAccountRequestsInnerSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCompletedRecipient.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCompletedRecipient.md new file mode 100644 index 000000000..094956834 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCompletedRecipient.md @@ -0,0 +1,39 @@ +--- +id: beta-provisioning-completed-recipient +title: ProvisioningCompletedRecipient +pagination_label: ProvisioningCompletedRecipient +sidebar_label: ProvisioningCompletedRecipient +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCompletedRecipient', 'BetaProvisioningCompletedRecipient'] +slug: /tools/sdk/powershell/beta/models/provisioning-completed-recipient +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedRecipient', 'BetaProvisioningCompletedRecipient'] +--- + + +# ProvisioningCompletedRecipient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | Provisioning recipient DTO type. | [required] +**Id** | **String** | Provisioning recipient's identity ID. | [required] +**Name** | **String** | Provisioning recipient's display name. | [required] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningCompletedRecipient = Initialize-PSSailpoint.BetaProvisioningCompletedRecipient -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$ProvisioningCompletedRecipient | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCompletedRequester.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCompletedRequester.md new file mode 100644 index 000000000..9ea6abf44 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCompletedRequester.md @@ -0,0 +1,39 @@ +--- +id: beta-provisioning-completed-requester +title: ProvisioningCompletedRequester +pagination_label: ProvisioningCompletedRequester +sidebar_label: ProvisioningCompletedRequester +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCompletedRequester', 'BetaProvisioningCompletedRequester'] +slug: /tools/sdk/powershell/beta/models/provisioning-completed-requester +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedRequester', 'BetaProvisioningCompletedRequester'] +--- + + +# ProvisioningCompletedRequester + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | Provisioning requester's DTO type. | [required] +**Id** | **String** | Provisioning requester's identity ID. | [required] +**Name** | **String** | Provisioning owner's human-readable display name. | [required] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningCompletedRequester = Initialize-PSSailpoint.BetaProvisioningCompletedRequester -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20648 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$ProvisioningCompletedRequester | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningConfig.md new file mode 100644 index 000000000..4daf7407e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningConfig.md @@ -0,0 +1,43 @@ +--- +id: beta-provisioning-config +title: ProvisioningConfig +pagination_label: ProvisioningConfig +sidebar_label: ProvisioningConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningConfig', 'BetaProvisioningConfig'] +slug: /tools/sdk/powershell/beta/models/provisioning-config +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfig', 'BetaProvisioningConfig'] +--- + + +# ProvisioningConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UniversalManager** | Pointer to **Boolean** | Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. | [optional] [readonly] [default to $false] +**ManagedResourceRefs** | Pointer to [**[]ProvisioningConfigManagedResourceRefsInner**](provisioning-config-managed-resource-refs-inner) | References to sources for the Service Desk integration template. May only be specified if universalManager is false. | [optional] +**PlanInitializerScript** | Pointer to [**ProvisioningConfigPlanInitializerScript**](provisioning-config-plan-initializer-script) | | [optional] +**NoProvisioningRequests** | Pointer to **Boolean** | Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. | [optional] [default to $false] +**ProvisioningRequestExpiration** | Pointer to **Int32** | When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningConfig = Initialize-PSSailpoint.BetaProvisioningConfig -UniversalManager true ` + -ManagedResourceRefs [{type=SOURCE, id=2c9180855d191c59015d291ceb051111, name=My Source 1}, {type=SOURCE, id=2c9180855d191c59015d291ceb052222, name=My Source 2}] ` + -PlanInitializerScript null ` + -NoProvisioningRequests true ` + -ProvisioningRequestExpiration 7 +``` + +- Convert the resource to JSON +```powershell +$ProvisioningConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningConfigManagedResourceRefsInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningConfigManagedResourceRefsInner.md new file mode 100644 index 000000000..0b87e7d8d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningConfigManagedResourceRefsInner.md @@ -0,0 +1,39 @@ +--- +id: beta-provisioning-config-managed-resource-refs-inner +title: ProvisioningConfigManagedResourceRefsInner +pagination_label: ProvisioningConfigManagedResourceRefsInner +sidebar_label: ProvisioningConfigManagedResourceRefsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningConfigManagedResourceRefsInner', 'BetaProvisioningConfigManagedResourceRefsInner'] +slug: /tools/sdk/powershell/beta/models/provisioning-config-managed-resource-refs-inner +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfigManagedResourceRefsInner', 'BetaProvisioningConfigManagedResourceRefsInner'] +--- + + +# ProvisioningConfigManagedResourceRefsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "SOURCE" ] | The type of object being referenced | [optional] +**Id** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | ID of the source | [optional] +**Name** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Human-readable display name of the source | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningConfigManagedResourceRefsInner = Initialize-PSSailpoint.BetaProvisioningConfigManagedResourceRefsInner -Type SOURCE ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name My Source +``` + +- Convert the resource to JSON +```powershell +$ProvisioningConfigManagedResourceRefsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningConfigPlanInitializerScript.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningConfigPlanInitializerScript.md new file mode 100644 index 000000000..1a620d582 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningConfigPlanInitializerScript.md @@ -0,0 +1,36 @@ +--- +id: beta-provisioning-config-plan-initializer-script +title: ProvisioningConfigPlanInitializerScript +pagination_label: ProvisioningConfigPlanInitializerScript +sidebar_label: ProvisioningConfigPlanInitializerScript +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningConfigPlanInitializerScript', 'BetaProvisioningConfigPlanInitializerScript'] +slug: /tools/sdk/powershell/beta/models/provisioning-config-plan-initializer-script +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfigPlanInitializerScript', 'BetaProvisioningConfigPlanInitializerScript'] +--- + + +# ProvisioningConfigPlanInitializerScript + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | Pointer to **String** | This is a Rule that allows provisioning instruction changes. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningConfigPlanInitializerScript = Initialize-PSSailpoint.BetaProvisioningConfigPlanInitializerScript -Source <?xml version='1.0' encoding='UTF-8'?>\r\n<!DOCTYPE Rule PUBLIC \"sailpoint.dtd\" \"sailpoint.dtd\">\r\n<Rule name=\"Example Rule\" type=\"BeforeProvisioning\">\r\n <Description>Before Provisioning Rule which changes disables and enables to a modify.</Description>\r\n <Source><![CDATA[\r\nimport sailpoint.object.*;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest.Operation;\r\nimport sailpoint.object.ProvisioningPlan.AttributeRequest;\r\nimport sailpoint.object.ProvisioningPlan;\r\nimport sailpoint.object.ProvisioningPlan.Operation;\r\n\r\nfor ( AccountRequest accountRequest : plan.getAccountRequests() ) {\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Disable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Enable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n}\r\n\r\n ]]></Source> + +``` + +- Convert the resource to JSON +```powershell +$ProvisioningConfigPlanInitializerScript | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCriteriaLevel1.md new file mode 100644 index 000000000..1c993de93 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCriteriaLevel1.md @@ -0,0 +1,41 @@ +--- +id: beta-provisioning-criteria-level1 +title: ProvisioningCriteriaLevel1 +pagination_label: ProvisioningCriteriaLevel1 +sidebar_label: ProvisioningCriteriaLevel1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCriteriaLevel1', 'BetaProvisioningCriteriaLevel1'] +slug: /tools/sdk/powershell/beta/models/provisioning-criteria-level1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'BetaProvisioningCriteriaLevel1'] +--- + + +# ProvisioningCriteriaLevel1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**Attribute** | Pointer to **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] +**Value** | Pointer to **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] +**Children** | Pointer to [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningCriteriaLevel1 = Initialize-PSSailpoint.BetaProvisioningCriteriaLevel1 -Operation null ` + -Attribute email ` + -Value carlee.cert1c9f9b6fd@mailinator.com ` + -Children null +``` + +- Convert the resource to JSON +```powershell +$ProvisioningCriteriaLevel1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCriteriaLevel2.md new file mode 100644 index 000000000..3ca959cde --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCriteriaLevel2.md @@ -0,0 +1,41 @@ +--- +id: beta-provisioning-criteria-level2 +title: ProvisioningCriteriaLevel2 +pagination_label: ProvisioningCriteriaLevel2 +sidebar_label: ProvisioningCriteriaLevel2 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCriteriaLevel2', 'BetaProvisioningCriteriaLevel2'] +slug: /tools/sdk/powershell/beta/models/provisioning-criteria-level2 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'BetaProvisioningCriteriaLevel2'] +--- + + +# ProvisioningCriteriaLevel2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**Attribute** | Pointer to **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] +**Value** | Pointer to **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] +**Children** | Pointer to [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningCriteriaLevel2 = Initialize-PSSailpoint.BetaProvisioningCriteriaLevel2 -Operation null ` + -Attribute email ` + -Value carlee.cert1c9f9b6fd@mailinator.com ` + -Children null +``` + +- Convert the resource to JSON +```powershell +$ProvisioningCriteriaLevel2 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCriteriaLevel3.md new file mode 100644 index 000000000..8f6f69f6b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCriteriaLevel3.md @@ -0,0 +1,41 @@ +--- +id: beta-provisioning-criteria-level3 +title: ProvisioningCriteriaLevel3 +pagination_label: ProvisioningCriteriaLevel3 +sidebar_label: ProvisioningCriteriaLevel3 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCriteriaLevel3', 'BetaProvisioningCriteriaLevel3'] +slug: /tools/sdk/powershell/beta/models/provisioning-criteria-level3 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'BetaProvisioningCriteriaLevel3'] +--- + + +# ProvisioningCriteriaLevel3 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**Attribute** | Pointer to **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] +**Value** | Pointer to **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] +**Children** | Pointer to **String** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningCriteriaLevel3 = Initialize-PSSailpoint.BetaProvisioningCriteriaLevel3 -Operation null ` + -Attribute email ` + -Value carlee.cert1c9f9b6fd@mailinator.com ` + -Children null +``` + +- Convert the resource to JSON +```powershell +$ProvisioningCriteriaLevel3 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCriteriaOperation.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCriteriaOperation.md new file mode 100644 index 000000000..052860589 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningCriteriaOperation.md @@ -0,0 +1,32 @@ +--- +id: beta-provisioning-criteria-operation +title: ProvisioningCriteriaOperation +pagination_label: ProvisioningCriteriaOperation +sidebar_label: ProvisioningCriteriaOperation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCriteriaOperation', 'BetaProvisioningCriteriaOperation'] +slug: /tools/sdk/powershell/beta/models/provisioning-criteria-operation +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaOperation', 'BetaProvisioningCriteriaOperation'] +--- + + +# ProvisioningCriteriaOperation + +## Enum + + +* `EQUALS` (value: `"EQUALS"`) + +* `NOT_EQUALS` (value: `"NOT_EQUALS"`) + +* `CONTAINS` (value: `"CONTAINS"`) + +* `HAS` (value: `"HAS"`) + +* `AND` (value: `"AND"`) + +* `OR` (value: `"OR"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningDetails.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningDetails.md new file mode 100644 index 000000000..067d9d4d1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningDetails.md @@ -0,0 +1,35 @@ +--- +id: beta-provisioning-details +title: ProvisioningDetails +pagination_label: ProvisioningDetails +sidebar_label: ProvisioningDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningDetails', 'BetaProvisioningDetails'] +slug: /tools/sdk/powershell/beta/models/provisioning-details +tags: ['SDK', 'Software Development Kit', 'ProvisioningDetails', 'BetaProvisioningDetails'] +--- + + +# ProvisioningDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OrderedSubPhaseReferences** | Pointer to **String** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain ""manualWorkItemDetails"" which indicate that there is further information in that object for this phase. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningDetails = Initialize-PSSailpoint.BetaProvisioningDetails -OrderedSubPhaseReferences manualWorkItemDetails +``` + +- Convert the resource to JSON +```powershell +$ProvisioningDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningPolicyDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningPolicyDto.md new file mode 100644 index 000000000..4b8a01528 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningPolicyDto.md @@ -0,0 +1,41 @@ +--- +id: beta-provisioning-policy-dto +title: ProvisioningPolicyDto +pagination_label: ProvisioningPolicyDto +sidebar_label: ProvisioningPolicyDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningPolicyDto', 'BetaProvisioningPolicyDto'] +slug: /tools/sdk/powershell/beta/models/provisioning-policy-dto +tags: ['SDK', 'Software Development Kit', 'ProvisioningPolicyDto', 'BetaProvisioningPolicyDto'] +--- + + +# ProvisioningPolicyDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | the provisioning policy name | [required] +**Description** | Pointer to **String** | the description of the provisioning policy | [optional] +**UsageType** | Pointer to [**UsageType**](usage-type) | | [optional] +**Fields** | Pointer to [**[]FieldDetailsDto**](field-details-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningPolicyDto = Initialize-PSSailpoint.BetaProvisioningPolicyDto -Name example provisioning policy for inactive identities ` + -Description this provisioning policy creates access based on an identity going inactive ` + -UsageType null ` + -Fields null +``` + +- Convert the resource to JSON +```powershell +$ProvisioningPolicyDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningState.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningState.md new file mode 100644 index 000000000..d54d1b3a9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ProvisioningState.md @@ -0,0 +1,32 @@ +--- +id: beta-provisioning-state +title: ProvisioningState +pagination_label: ProvisioningState +sidebar_label: ProvisioningState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningState', 'BetaProvisioningState'] +slug: /tools/sdk/powershell/beta/models/provisioning-state +tags: ['SDK', 'Software Development Kit', 'ProvisioningState', 'BetaProvisioningState'] +--- + + +# ProvisioningState + +## Enum + + +* `PENDING` (value: `"PENDING"`) + +* `FINISHED` (value: `"FINISHED"`) + +* `UNVERIFIABLE` (value: `"UNVERIFIABLE"`) + +* `COMMITED` (value: `"COMMITED"`) + +* `FAILED` (value: `"FAILED"`) + +* `RETRY` (value: `"RETRY"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PublicIdentityAttributeConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PublicIdentityAttributeConfig.md new file mode 100644 index 000000000..8718137eb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PublicIdentityAttributeConfig.md @@ -0,0 +1,37 @@ +--- +id: beta-public-identity-attribute-config +title: PublicIdentityAttributeConfig +pagination_label: PublicIdentityAttributeConfig +sidebar_label: PublicIdentityAttributeConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PublicIdentityAttributeConfig', 'BetaPublicIdentityAttributeConfig'] +slug: /tools/sdk/powershell/beta/models/public-identity-attribute-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentityAttributeConfig', 'BetaPublicIdentityAttributeConfig'] +--- + + +# PublicIdentityAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **String** | the key of the attribute | [optional] +**Name** | Pointer to **String** | the display name of the attribute | [optional] + +## Examples + +- Prepare the resource +```powershell +$PublicIdentityAttributeConfig = Initialize-PSSailpoint.BetaPublicIdentityAttributeConfig -Key country ` + -Name Country +``` + +- Convert the resource to JSON +```powershell +$PublicIdentityAttributeConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PublicIdentityConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PublicIdentityConfig.md new file mode 100644 index 000000000..ac8126853 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PublicIdentityConfig.md @@ -0,0 +1,39 @@ +--- +id: beta-public-identity-config +title: PublicIdentityConfig +pagination_label: PublicIdentityConfig +sidebar_label: PublicIdentityConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PublicIdentityConfig', 'BetaPublicIdentityConfig'] +slug: /tools/sdk/powershell/beta/models/public-identity-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentityConfig', 'BetaPublicIdentityConfig'] +--- + + +# PublicIdentityConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**[]PublicIdentityAttributeConfig**](public-identity-attribute-config) | | [optional] +**ModifiedBy** | Pointer to [**IdentityReference**](identity-reference) | | [optional] +**Modified** | Pointer to **System.DateTime** | the date/time of the modification | [optional] + +## Examples + +- Prepare the resource +```powershell +$PublicIdentityConfig = Initialize-PSSailpoint.BetaPublicIdentityConfig -Attributes null ` + -ModifiedBy null ` + -Modified 2018-06-25T20:22:28.104Z +``` + +- Convert the resource to JSON +```powershell +$PublicIdentityConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PutPasswordDictionaryRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PutPasswordDictionaryRequest.md new file mode 100644 index 000000000..2d957eb38 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/PutPasswordDictionaryRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-put-password-dictionary-request +title: PutPasswordDictionaryRequest +pagination_label: PutPasswordDictionaryRequest +sidebar_label: PutPasswordDictionaryRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PutPasswordDictionaryRequest', 'BetaPutPasswordDictionaryRequest'] +slug: /tools/sdk/powershell/beta/models/put-password-dictionary-request +tags: ['SDK', 'Software Development Kit', 'PutPasswordDictionaryRequest', 'BetaPutPasswordDictionaryRequest'] +--- + + +# PutPasswordDictionaryRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | Pointer to **System.IO.FileInfo** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PutPasswordDictionaryRequest = Initialize-PSSailpoint.BetaPutPasswordDictionaryRequest -File null +``` + +- Convert the resource to JSON +```powershell +$PutPasswordDictionaryRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/QueuedCheckConfigDetails.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/QueuedCheckConfigDetails.md new file mode 100644 index 000000000..b4b2a5f74 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/QueuedCheckConfigDetails.md @@ -0,0 +1,37 @@ +--- +id: beta-queued-check-config-details +title: QueuedCheckConfigDetails +pagination_label: QueuedCheckConfigDetails +sidebar_label: QueuedCheckConfigDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'QueuedCheckConfigDetails', 'BetaQueuedCheckConfigDetails'] +slug: /tools/sdk/powershell/beta/models/queued-check-config-details +tags: ['SDK', 'Software Development Kit', 'QueuedCheckConfigDetails', 'BetaQueuedCheckConfigDetails'] +--- + + +# QueuedCheckConfigDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ProvisioningStatusCheckIntervalMinutes** | **String** | Interval in minutes between status checks | [required] +**ProvisioningMaxStatusCheckDays** | **String** | Maximum number of days to check | [required] + +## Examples + +- Prepare the resource +```powershell +$QueuedCheckConfigDetails = Initialize-PSSailpoint.BetaQueuedCheckConfigDetails -ProvisioningStatusCheckIntervalMinutes 30 ` + -ProvisioningMaxStatusCheckDays 2 +``` + +- Convert the resource to JSON +```powershell +$QueuedCheckConfigDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RandomAlphaNumeric.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RandomAlphaNumeric.md new file mode 100644 index 000000000..77b604e2d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RandomAlphaNumeric.md @@ -0,0 +1,39 @@ +--- +id: beta-random-alpha-numeric +title: RandomAlphaNumeric +pagination_label: RandomAlphaNumeric +sidebar_label: RandomAlphaNumeric +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RandomAlphaNumeric', 'BetaRandomAlphaNumeric'] +slug: /tools/sdk/powershell/beta/models/random-alpha-numeric +tags: ['SDK', 'Software Development Kit', 'RandomAlphaNumeric', 'BetaRandomAlphaNumeric'] +--- + + +# RandomAlphaNumeric + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Length** | Pointer to **String** | This is an integer value specifying the size/number of characters the random string must contain * This value must be a positive number and cannot be blank * If no length is provided, the transform will default to a value of `32` * Due to identity attribute data constraints, the maximum allowable value is `450` characters | [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] + +## Examples + +- Prepare the resource +```powershell +$RandomAlphaNumeric = Initialize-PSSailpoint.BetaRandomAlphaNumeric -Length 10 ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$RandomAlphaNumeric | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RandomNumeric.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RandomNumeric.md new file mode 100644 index 000000000..c11700889 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RandomNumeric.md @@ -0,0 +1,39 @@ +--- +id: beta-random-numeric +title: RandomNumeric +pagination_label: RandomNumeric +sidebar_label: RandomNumeric +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RandomNumeric', 'BetaRandomNumeric'] +slug: /tools/sdk/powershell/beta/models/random-numeric +tags: ['SDK', 'Software Development Kit', 'RandomNumeric', 'BetaRandomNumeric'] +--- + + +# RandomNumeric + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Length** | Pointer to **String** | This is an integer value specifying the size/number of characters the random string must contain * This value must be a positive number and cannot be blank * If no length is provided, the transform will default to a value of `32` * Due to identity attribute data constraints, the maximum allowable value is `450` characters | [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] + +## Examples + +- Prepare the resource +```powershell +$RandomNumeric = Initialize-PSSailpoint.BetaRandomNumeric -Length 10 ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$RandomNumeric | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ReassignReference.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ReassignReference.md new file mode 100644 index 000000000..12250d089 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ReassignReference.md @@ -0,0 +1,37 @@ +--- +id: beta-reassign-reference +title: ReassignReference +pagination_label: ReassignReference +sidebar_label: ReassignReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReassignReference', 'BetaReassignReference'] +slug: /tools/sdk/powershell/beta/models/reassign-reference +tags: ['SDK', 'Software Development Kit', 'ReassignReference', 'BetaReassignReference'] +--- + + +# ReassignReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The ID of item or identity being reassigned. | [required] +**Type** | **Enum** [ "TARGET_SUMMARY", "ITEM", "IDENTITY_SUMMARY" ] | The type of item or identity being reassigned. | [required] + +## Examples + +- Prepare the resource +```powershell +$ReassignReference = Initialize-PSSailpoint.BetaReassignReference -Id ef38f94347e94562b5bb8424a56397d8 ` + -Type ITEM +``` + +- Convert the resource to JSON +```powershell +$ReassignReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Reassignment.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Reassignment.md new file mode 100644 index 000000000..d42147956 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Reassignment.md @@ -0,0 +1,37 @@ +--- +id: beta-reassignment +title: Reassignment +pagination_label: Reassignment +sidebar_label: Reassignment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Reassignment', 'BetaReassignment'] +slug: /tools/sdk/powershell/beta/models/reassignment +tags: ['SDK', 'Software Development Kit', 'Reassignment', 'BetaReassignment'] +--- + + +# Reassignment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarFrom** | Pointer to [**CertificationReference**](certification-reference) | | [optional] +**Comment** | Pointer to **String** | Comments from the previous reviewer. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Reassignment = Initialize-PSSailpoint.BetaReassignment -VarFrom null ` + -Comment Please review +``` + +- Convert the resource to JSON +```powershell +$Reassignment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ReassignmentType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ReassignmentType.md new file mode 100644 index 000000000..c38dadaca --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ReassignmentType.md @@ -0,0 +1,28 @@ +--- +id: beta-reassignment-type +title: ReassignmentType +pagination_label: ReassignmentType +sidebar_label: ReassignmentType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReassignmentType', 'BetaReassignmentType'] +slug: /tools/sdk/powershell/beta/models/reassignment-type +tags: ['SDK', 'Software Development Kit', 'ReassignmentType', 'BetaReassignmentType'] +--- + + +# ReassignmentType + +## Enum + + +* `MANUAL_REASSIGNMENT` (value: `"MANUAL_REASSIGNMENT"`) + +* `AUTOMATIC_REASSIGNMENT` (value: `"AUTOMATIC_REASSIGNMENT"`) + +* `AUTO_ESCALATION` (value: `"AUTO_ESCALATION"`) + +* `SELF_REVIEW_DELEGATION` (value: `"SELF_REVIEW_DELEGATION"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ReassignmentTypeEnum.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ReassignmentTypeEnum.md new file mode 100644 index 000000000..40de1e4b0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ReassignmentTypeEnum.md @@ -0,0 +1,28 @@ +--- +id: beta-reassignment-type-enum +title: ReassignmentTypeEnum +pagination_label: ReassignmentTypeEnum +sidebar_label: ReassignmentTypeEnum +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReassignmentTypeEnum', 'BetaReassignmentTypeEnum'] +slug: /tools/sdk/powershell/beta/models/reassignment-type-enum +tags: ['SDK', 'Software Development Kit', 'ReassignmentTypeEnum', 'BetaReassignmentTypeEnum'] +--- + + +# ReassignmentTypeEnum + +## Enum + + +* `MANUAL_REASSIGNMENT` (value: `"MANUAL_REASSIGNMENT,"`) + +* `AUTOMATIC_REASSIGNMENT` (value: `"AUTOMATIC_REASSIGNMENT,"`) + +* `AUTO_ESCALATION` (value: `"AUTO_ESCALATION,"`) + +* `SELF_REVIEW_DELEGATION` (value: `"SELF_REVIEW_DELEGATION"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Recommendation.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Recommendation.md new file mode 100644 index 000000000..ad2143999 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Recommendation.md @@ -0,0 +1,37 @@ +--- +id: beta-recommendation +title: Recommendation +pagination_label: Recommendation +sidebar_label: Recommendation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Recommendation', 'BetaRecommendation'] +slug: /tools/sdk/powershell/beta/models/recommendation +tags: ['SDK', 'Software Development Kit', 'Recommendation', 'BetaRecommendation'] +--- + + +# Recommendation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "HUMAN", "MACHINE" ] | Recommended type of account. | [required] +**Method** | **Enum** [ "DISCOVERY", "SOURCE", "CRITERIA" ] | Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. | [required] + +## Examples + +- Prepare the resource +```powershell +$Recommendation = Initialize-PSSailpoint.BetaRecommendation -Type MACHINE ` + -Method DISCOVERY +``` + +- Convert the resource to JSON +```powershell +$Recommendation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RecommendationConfigDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RecommendationConfigDto.md new file mode 100644 index 000000000..488bf7611 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RecommendationConfigDto.md @@ -0,0 +1,41 @@ +--- +id: beta-recommendation-config-dto +title: RecommendationConfigDto +pagination_label: RecommendationConfigDto +sidebar_label: RecommendationConfigDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RecommendationConfigDto', 'BetaRecommendationConfigDto'] +slug: /tools/sdk/powershell/beta/models/recommendation-config-dto +tags: ['SDK', 'Software Development Kit', 'RecommendationConfigDto', 'BetaRecommendationConfigDto'] +--- + + +# RecommendationConfigDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RecommenderFeatures** | Pointer to **[]String** | List of identity attributes to use for calculating certification recommendations | [optional] +**PeerGroupPercentageThreshold** | Pointer to **Double** | The percent value that the recommendation calculation must surpass to produce a YES recommendation | [optional] +**RunAutoSelectOnce** | Pointer to **Boolean** | If true, rulesRecommenderConfig will be refreshed with new programatically selected attribute and threshold values on the next pipeline run | [optional] [default to $false] +**OnlyTuneThreshold** | Pointer to **Boolean** | If true, rulesRecommenderConfig will be refreshed with new programatically selected threshold values on the next pipeline run | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$RecommendationConfigDto = Initialize-PSSailpoint.BetaRecommendationConfigDto -RecommenderFeatures [jobTitle, location, peer_group, department, active] ` + -PeerGroupPercentageThreshold 0.5 ` + -RunAutoSelectOnce false ` + -OnlyTuneThreshold false +``` + +- Convert the resource to JSON +```powershell +$RecommendationConfigDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RecommendationRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RecommendationRequest.md new file mode 100644 index 000000000..b44b95789 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RecommendationRequest.md @@ -0,0 +1,37 @@ +--- +id: beta-recommendation-request +title: RecommendationRequest +pagination_label: RecommendationRequest +sidebar_label: RecommendationRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RecommendationRequest', 'BetaRecommendationRequest'] +slug: /tools/sdk/powershell/beta/models/recommendation-request +tags: ['SDK', 'Software Development Kit', 'RecommendationRequest', 'BetaRecommendationRequest'] +--- + + +# RecommendationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **String** | The identity ID | [optional] +**Item** | Pointer to [**AccessItemRef**](access-item-ref) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RecommendationRequest = Initialize-PSSailpoint.BetaRecommendationRequest -IdentityId 2c938083633d259901633d25c68c00fa ` + -Item null +``` + +- Convert the resource to JSON +```powershell +$RecommendationRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RecommendationRequestDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RecommendationRequestDto.md new file mode 100644 index 000000000..8f3b9d822 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RecommendationRequestDto.md @@ -0,0 +1,43 @@ +--- +id: beta-recommendation-request-dto +title: RecommendationRequestDto +pagination_label: RecommendationRequestDto +sidebar_label: RecommendationRequestDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RecommendationRequestDto', 'BetaRecommendationRequestDto'] +slug: /tools/sdk/powershell/beta/models/recommendation-request-dto +tags: ['SDK', 'Software Development Kit', 'RecommendationRequestDto', 'BetaRecommendationRequestDto'] +--- + + +# RecommendationRequestDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Requests** | Pointer to [**[]RecommendationRequest**](recommendation-request) | | [optional] +**ExcludeInterpretations** | Pointer to **Boolean** | Exclude interpretations in the response if ""true"". Return interpretations in the response if this attribute is not specified. | [optional] [default to $false] +**IncludeTranslationMessages** | Pointer to **Boolean** | When set to true, the calling system uses the translated messages for the specified language | [optional] [default to $false] +**IncludeDebugInformation** | Pointer to **Boolean** | Returns the recommender calculations if set to true | [optional] [default to $false] +**PrescribeMode** | Pointer to **Boolean** | When set to true, uses prescribedRulesRecommenderConfig to get identity attributes and peer group threshold instead of standard config. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$RecommendationRequestDto = Initialize-PSSailpoint.BetaRecommendationRequestDto -Requests null ` + -ExcludeInterpretations false ` + -IncludeTranslationMessages false ` + -IncludeDebugInformation true ` + -PrescribeMode false +``` + +- Convert the resource to JSON +```powershell +$RecommendationRequestDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RecommendationResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RecommendationResponse.md new file mode 100644 index 000000000..ccbb12302 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RecommendationResponse.md @@ -0,0 +1,43 @@ +--- +id: beta-recommendation-response +title: RecommendationResponse +pagination_label: RecommendationResponse +sidebar_label: RecommendationResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RecommendationResponse', 'BetaRecommendationResponse'] +slug: /tools/sdk/powershell/beta/models/recommendation-response +tags: ['SDK', 'Software Development Kit', 'RecommendationResponse', 'BetaRecommendationResponse'] +--- + + +# RecommendationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Request** | Pointer to [**RecommendationRequest**](recommendation-request) | | [optional] +**Recommendation** | Pointer to **Enum** [ "true", "false", "MAYBE", "NOT_FOUND" ] | The recommendation - YES if the access is recommended, NO if not recommended, MAYBE if there is not enough information to make a recommendation, NOT_FOUND if the identity is not found in the system | [optional] +**Interpretations** | Pointer to **[]String** | The list of interpretations explaining the recommendation. The array is empty if includeInterpretations is false or not present in the request. e.g. - [ ""Not approved in the last 6 months."" ]. Interpretations will be translated using the client's locale as found in the Accept-Language header. If a translation for the client's locale cannot be found, the US English translation will be returned. | [optional] +**TranslationMessages** | Pointer to [**[]TranslationMessage**](translation-message) | The list of translation messages, if they have been requested. | [optional] +**RecommenderCalculations** | Pointer to [**RecommenderCalculations**](recommender-calculations) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RecommendationResponse = Initialize-PSSailpoint.BetaRecommendationResponse -Request null ` + -Recommendation true ` + -Interpretations [75% of identities with the same department have this access. This information had a high impact on the overall score., 67% of identities with the same peer group have this access. This information had a low impact on the overall score., 42% of identities with the same location have this access. This information had a low impact on the overall score.] ` + -TranslationMessages [{key=recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values=[75, department]}] ` + -RecommenderCalculations null +``` + +- Convert the resource to JSON +```powershell +$RecommendationResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RecommendationResponseDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RecommendationResponseDto.md new file mode 100644 index 000000000..c6ce7ddd2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RecommendationResponseDto.md @@ -0,0 +1,35 @@ +--- +id: beta-recommendation-response-dto +title: RecommendationResponseDto +pagination_label: RecommendationResponseDto +sidebar_label: RecommendationResponseDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RecommendationResponseDto', 'BetaRecommendationResponseDto'] +slug: /tools/sdk/powershell/beta/models/recommendation-response-dto +tags: ['SDK', 'Software Development Kit', 'RecommendationResponseDto', 'BetaRecommendationResponseDto'] +--- + + +# RecommendationResponseDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Response** | Pointer to [**[]RecommendationResponse**](recommendation-response) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RecommendationResponseDto = Initialize-PSSailpoint.BetaRecommendationResponseDto -Response null +``` + +- Convert the resource to JSON +```powershell +$RecommendationResponseDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RecommenderCalculations.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RecommenderCalculations.md new file mode 100644 index 000000000..ec182f4d5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RecommenderCalculations.md @@ -0,0 +1,49 @@ +--- +id: beta-recommender-calculations +title: RecommenderCalculations +pagination_label: RecommenderCalculations +sidebar_label: RecommenderCalculations +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RecommenderCalculations', 'BetaRecommenderCalculations'] +slug: /tools/sdk/powershell/beta/models/recommender-calculations +tags: ['SDK', 'Software Development Kit', 'RecommenderCalculations', 'BetaRecommenderCalculations'] +--- + + +# RecommenderCalculations + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **String** | The ID of the identity | [optional] +**EntitlementId** | Pointer to **String** | The entitlement ID | [optional] +**Recommendation** | Pointer to **String** | The actual recommendation | [optional] +**OverallWeightedScore** | Pointer to **Decimal** | The overall weighted score | [optional] +**FeatureWeightedScores** | Pointer to **map[string]Decimal** | The weighted score of each individual feature | [optional] +**Threshold** | Pointer to **Decimal** | The configured value against which the overallWeightedScore is compared | [optional] +**IdentityAttributes** | Pointer to [**map[string]RecommenderCalculationsIdentityAttributesValue**](recommender-calculations-identity-attributes-value) | The values for your configured features | [optional] +**FeatureValues** | Pointer to [**FeatureValueDto**](feature-value-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RecommenderCalculations = Initialize-PSSailpoint.BetaRecommenderCalculations -IdentityId 2c91808457d8f3ab0157e3e62cb4213c ` + -EntitlementId 2c91809050db617d0150e0bf3215385e ` + -Recommendation YES ` + -OverallWeightedScore null ` + -FeatureWeightedScores null ` + -Threshold null ` + -IdentityAttributes null ` + -FeatureValues null +``` + +- Convert the resource to JSON +```powershell +$RecommenderCalculations | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RecommenderCalculationsIdentityAttributesValue.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RecommenderCalculationsIdentityAttributesValue.md new file mode 100644 index 000000000..5f0a5866d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RecommenderCalculationsIdentityAttributesValue.md @@ -0,0 +1,35 @@ +--- +id: beta-recommender-calculations-identity-attributes-value +title: RecommenderCalculationsIdentityAttributesValue +pagination_label: RecommenderCalculationsIdentityAttributesValue +sidebar_label: RecommenderCalculationsIdentityAttributesValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RecommenderCalculationsIdentityAttributesValue', 'BetaRecommenderCalculationsIdentityAttributesValue'] +slug: /tools/sdk/powershell/beta/models/recommender-calculations-identity-attributes-value +tags: ['SDK', 'Software Development Kit', 'RecommenderCalculationsIdentityAttributesValue', 'BetaRecommenderCalculationsIdentityAttributesValue'] +--- + + +# RecommenderCalculationsIdentityAttributesValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RecommenderCalculationsIdentityAttributesValue = Initialize-PSSailpoint.BetaRecommenderCalculationsIdentityAttributesValue -Value null +``` + +- Convert the resource to JSON +```powershell +$RecommenderCalculationsIdentityAttributesValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Reference.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Reference.md new file mode 100644 index 000000000..d9a978121 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Reference.md @@ -0,0 +1,39 @@ +--- +id: beta-reference +title: Reference +pagination_label: Reference +sidebar_label: Reference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Reference', 'BetaReference'] +slug: /tools/sdk/powershell/beta/models/reference +tags: ['SDK', 'Software Development Kit', 'Reference', 'BetaReference'] +--- + + +# Reference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | This ID specifies the name of the pre-existing transform which you want to use within your current transform | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$Reference = Initialize-PSSailpoint.BetaReference -Id Existing Transform ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Reference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RemediationItemDetails.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RemediationItemDetails.md new file mode 100644 index 000000000..b9ef9d854 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RemediationItemDetails.md @@ -0,0 +1,51 @@ +--- +id: beta-remediation-item-details +title: RemediationItemDetails +pagination_label: RemediationItemDetails +sidebar_label: RemediationItemDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RemediationItemDetails', 'BetaRemediationItemDetails'] +slug: /tools/sdk/powershell/beta/models/remediation-item-details +tags: ['SDK', 'Software Development Kit', 'RemediationItemDetails', 'BetaRemediationItemDetails'] +--- + + +# RemediationItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of the certification | [optional] +**TargetId** | Pointer to **String** | The ID of the certification target | [optional] +**TargetName** | Pointer to **String** | The name of the certification target | [optional] +**TargetDisplayName** | Pointer to **String** | The display name of the certification target | [optional] +**ApplicationName** | Pointer to **String** | The name of the application/source | [optional] +**AttributeName** | Pointer to **String** | The name of the attribute being certified | [optional] +**AttributeOperation** | Pointer to **String** | The operation of the certification on the attribute | [optional] +**AttributeValue** | Pointer to **String** | The value of the attribute being certified | [optional] +**NativeIdentity** | Pointer to **String** | The native identity of the target | [optional] + +## Examples + +- Prepare the resource +```powershell +$RemediationItemDetails = Initialize-PSSailpoint.BetaRemediationItemDetails -Id 2c9180835d2e5168015d32f890ca1581 ` + -TargetId 2c9180835d2e5168015d32f890ca1581 ` + -TargetName john.smith ` + -TargetDisplayName emailAddress ` + -ApplicationName Active Directory ` + -AttributeName phoneNumber ` + -AttributeOperation update ` + -AttributeValue 512-555-1212 ` + -NativeIdentity jason.smith2 +``` + +- Convert the resource to JSON +```powershell +$RemediationItemDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RemediationItems.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RemediationItems.md new file mode 100644 index 000000000..b93e7e678 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RemediationItems.md @@ -0,0 +1,51 @@ +--- +id: beta-remediation-items +title: RemediationItems +pagination_label: RemediationItems +sidebar_label: RemediationItems +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RemediationItems', 'BetaRemediationItems'] +slug: /tools/sdk/powershell/beta/models/remediation-items +tags: ['SDK', 'Software Development Kit', 'RemediationItems', 'BetaRemediationItems'] +--- + + +# RemediationItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of the certification | [optional] +**TargetId** | Pointer to **String** | The ID of the certification target | [optional] +**TargetName** | Pointer to **String** | The name of the certification target | [optional] +**TargetDisplayName** | Pointer to **String** | The display name of the certification target | [optional] +**ApplicationName** | Pointer to **String** | The name of the application/source | [optional] +**AttributeName** | Pointer to **String** | The name of the attribute being certified | [optional] +**AttributeOperation** | Pointer to **String** | The operation of the certification on the attribute | [optional] +**AttributeValue** | Pointer to **String** | The value of the attribute being certified | [optional] +**NativeIdentity** | Pointer to **String** | The native identity of the target | [optional] + +## Examples + +- Prepare the resource +```powershell +$RemediationItems = Initialize-PSSailpoint.BetaRemediationItems -Id 2c9180835d2e5168015d32f890ca1581 ` + -TargetId 2c9180835d2e5168015d32f890ca1581 ` + -TargetName john.smith ` + -TargetDisplayName emailAddress ` + -ApplicationName Active Directory ` + -AttributeName phoneNumber ` + -AttributeOperation update ` + -AttributeValue 512-555-1212 ` + -NativeIdentity jason.smith2 +``` + +- Convert the resource to JSON +```powershell +$RemediationItems | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Replace.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Replace.md new file mode 100644 index 000000000..c909fc4ba --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Replace.md @@ -0,0 +1,41 @@ +--- +id: beta-replace +title: Replace +pagination_label: Replace +sidebar_label: Replace +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Replace', 'BetaReplace'] +slug: /tools/sdk/powershell/beta/models/replace +tags: ['SDK', 'Software Development Kit', 'Replace', 'BetaReplace'] +--- + + +# Replace + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Regex** | **String** | This can be a string or a regex pattern in which you want to replace. | [required] +**Replacement** | **String** | This is the replacement string that should be substituded wherever the string or pattern is found. | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$Replace = Initialize-PSSailpoint.BetaReplace -Regex [^a-zA-Z] ` + -Replacement ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Replace | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ReplaceAll.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ReplaceAll.md new file mode 100644 index 000000000..1d2083428 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ReplaceAll.md @@ -0,0 +1,39 @@ +--- +id: beta-replace-all +title: ReplaceAll +pagination_label: ReplaceAll +sidebar_label: ReplaceAll +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReplaceAll', 'BetaReplaceAll'] +slug: /tools/sdk/powershell/beta/models/replace-all +tags: ['SDK', 'Software Development Kit', 'ReplaceAll', 'BetaReplaceAll'] +--- + + +# ReplaceAll + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Table** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value. | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$ReplaceAll = Initialize-PSSailpoint.BetaReplaceAll -Table {-= , "=', ñ=n} ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$ReplaceAll | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ReportConfigDTO.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ReportConfigDTO.md new file mode 100644 index 000000000..0c61aaf32 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ReportConfigDTO.md @@ -0,0 +1,41 @@ +--- +id: beta-report-config-dto +title: ReportConfigDTO +pagination_label: ReportConfigDTO +sidebar_label: ReportConfigDTO +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReportConfigDTO', 'BetaReportConfigDTO'] +slug: /tools/sdk/powershell/beta/models/report-config-dto +tags: ['SDK', 'Software Development Kit', 'ReportConfigDTO', 'BetaReportConfigDTO'] +--- + + +# ReportConfigDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ColumnName** | Pointer to **String** | Name of column in report | [optional] +**Required** | Pointer to **Boolean** | If true, column is required in all reports, and this entry is immutable. A 400 error will result from any attempt to modify the column's definition. | [optional] [default to $false] +**Included** | Pointer to **Boolean** | If true, column is included in the report. A 400 error will be thrown if an attempt is made to set included=false if required==true. | [optional] [default to $false] +**Order** | Pointer to **Int32** | Relative sort order for the column. Columns will be displayed left-to-right in nondecreasing order. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReportConfigDTO = Initialize-PSSailpoint.BetaReportConfigDTO -ColumnName SOD Business Name ` + -Required true ` + -Included false ` + -Order 2 +``` + +- Convert the resource to JSON +```powershell +$ReportConfigDTO | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ReportResultReference.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ReportResultReference.md new file mode 100644 index 000000000..fc1b50bc5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ReportResultReference.md @@ -0,0 +1,41 @@ +--- +id: beta-report-result-reference +title: ReportResultReference +pagination_label: ReportResultReference +sidebar_label: ReportResultReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReportResultReference', 'BetaReportResultReference'] +slug: /tools/sdk/powershell/beta/models/report-result-reference +tags: ['SDK', 'Software Development Kit', 'ReportResultReference', 'BetaReportResultReference'] +--- + + +# ReportResultReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "REPORT_RESULT" ] | SOD policy violation report result DTO type. | [optional] +**Id** | Pointer to **String** | SOD policy violation report result ID. | [optional] +**Name** | Pointer to **String** | Human-readable name of the SOD policy violation report result. | [optional] +**Status** | Pointer to **Enum** [ "SUCCESS", "WARNING", "ERROR", "TERMINATED", "TEMP_ERROR", "PENDING" ] | Status of a SOD policy violation report. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReportResultReference = Initialize-PSSailpoint.BetaReportResultReference -Type REPORT_RESULT ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name SOD Policy 1 Violation ` + -Status PENDING +``` + +- Convert the resource to JSON +```powershell +$ReportResultReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ReportType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ReportType.md new file mode 100644 index 000000000..543a2f849 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ReportType.md @@ -0,0 +1,28 @@ +--- +id: beta-report-type +title: ReportType +pagination_label: ReportType +sidebar_label: ReportType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReportType', 'BetaReportType'] +slug: /tools/sdk/powershell/beta/models/report-type +tags: ['SDK', 'Software Development Kit', 'ReportType', 'BetaReportType'] +--- + + +# ReportType + +## Enum + + +* `CAMPAIGN_COMPOSITION_REPORT` (value: `"CAMPAIGN_COMPOSITION_REPORT"`) + +* `CAMPAIGN_REMEDIATION_STATUS_REPORT` (value: `"CAMPAIGN_REMEDIATION_STATUS_REPORT"`) + +* `CAMPAIGN_STATUS_REPORT` (value: `"CAMPAIGN_STATUS_REPORT"`) + +* `CERTIFICATION_SIGNOFF_REPORT` (value: `"CERTIFICATION_SIGNOFF_REPORT"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestOnBehalfOfConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestOnBehalfOfConfig.md new file mode 100644 index 000000000..4092da62e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestOnBehalfOfConfig.md @@ -0,0 +1,37 @@ +--- +id: beta-request-on-behalf-of-config +title: RequestOnBehalfOfConfig +pagination_label: RequestOnBehalfOfConfig +sidebar_label: RequestOnBehalfOfConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestOnBehalfOfConfig', 'BetaRequestOnBehalfOfConfig'] +slug: /tools/sdk/powershell/beta/models/request-on-behalf-of-config +tags: ['SDK', 'Software Development Kit', 'RequestOnBehalfOfConfig', 'BetaRequestOnBehalfOfConfig'] +--- + + +# RequestOnBehalfOfConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AllowRequestOnBehalfOfAnyoneByAnyone** | Pointer to **Boolean** | If this is true, anyone can request access for anyone. | [optional] [default to $false] +**AllowRequestOnBehalfOfEmployeeByManager** | Pointer to **Boolean** | If this is true, a manager can request access for his or her direct reports. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$RequestOnBehalfOfConfig = Initialize-PSSailpoint.BetaRequestOnBehalfOfConfig -AllowRequestOnBehalfOfAnyoneByAnyone true ` + -AllowRequestOnBehalfOfEmployeeByManager true +``` + +- Convert the resource to JSON +```powershell +$RequestOnBehalfOfConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Requestability.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Requestability.md new file mode 100644 index 000000000..2c8927de3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Requestability.md @@ -0,0 +1,39 @@ +--- +id: beta-requestability +title: Requestability +pagination_label: Requestability +sidebar_label: Requestability +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Requestability', 'BetaRequestability'] +slug: /tools/sdk/powershell/beta/models/requestability +tags: ['SDK', 'Software Development Kit', 'Requestability', 'BetaRequestability'] +--- + + +# Requestability + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommentsRequired** | Pointer to **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] +**DenialCommentsRequired** | Pointer to **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] +**ApprovalSchemes** | Pointer to [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] + +## Examples + +- Prepare the resource +```powershell +$Requestability = Initialize-PSSailpoint.BetaRequestability -CommentsRequired true ` + -DenialCommentsRequired true ` + -ApprovalSchemes null +``` + +- Convert the resource to JSON +```powershell +$Requestability | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestabilityForRole.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestabilityForRole.md new file mode 100644 index 000000000..35b9296b2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestabilityForRole.md @@ -0,0 +1,39 @@ +--- +id: beta-requestability-for-role +title: RequestabilityForRole +pagination_label: RequestabilityForRole +sidebar_label: RequestabilityForRole +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestabilityForRole', 'BetaRequestabilityForRole'] +slug: /tools/sdk/powershell/beta/models/requestability-for-role +tags: ['SDK', 'Software Development Kit', 'RequestabilityForRole', 'BetaRequestabilityForRole'] +--- + + +# RequestabilityForRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommentsRequired** | Pointer to **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] +**DenialCommentsRequired** | Pointer to **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] +**ApprovalSchemes** | Pointer to [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestabilityForRole = Initialize-PSSailpoint.BetaRequestabilityForRole -CommentsRequired true ` + -DenialCommentsRequired true ` + -ApprovalSchemes null +``` + +- Convert the resource to JSON +```powershell +$RequestabilityForRole | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestableObject.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestableObject.md new file mode 100644 index 000000000..62cee72b6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestableObject.md @@ -0,0 +1,53 @@ +--- +id: beta-requestable-object +title: RequestableObject +pagination_label: RequestableObject +sidebar_label: RequestableObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestableObject', 'BetaRequestableObject'] +slug: /tools/sdk/powershell/beta/models/requestable-object +tags: ['SDK', 'Software Development Kit', 'RequestableObject', 'BetaRequestableObject'] +--- + + +# RequestableObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the requestable object itself | [optional] +**Name** | Pointer to **String** | Human-readable display name of the requestable object | [optional] +**Created** | Pointer to **System.DateTime** | The time when the requestable object was created | [optional] +**Modified** | Pointer to **System.DateTime** | The time when the requestable object was last modified | [optional] +**Description** | Pointer to **String** | Description of the requestable object. | [optional] +**Type** | Pointer to [**RequestableObjectType**](requestable-object-type) | | [optional] +**RequestStatus** | Pointer to [**RequestableObjectRequestStatus**](requestable-object-request-status) | | [optional] +**IdentityRequestId** | Pointer to **String** | If *requestStatus* is *PENDING*, indicates the id of the associated account activity. | [optional] +**OwnerRef** | Pointer to [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**RequestCommentsRequired** | Pointer to **Boolean** | Whether the requester must provide comments when requesting the object. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestableObject = Initialize-PSSailpoint.BetaRequestableObject -Id 2c9180835d2e5168015d32f890ca1581 ` + -Name Applied Research Access ` + -Created 2017-07-11T18:45:37.098Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Description Access to research information, lab results, and schematics. ` + -Type null ` + -RequestStatus null ` + -IdentityRequestId null ` + -OwnerRef null ` + -RequestCommentsRequired false +``` + +- Convert the resource to JSON +```powershell +$RequestableObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestableObjectReference.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestableObjectReference.md new file mode 100644 index 000000000..ac6b3a286 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestableObjectReference.md @@ -0,0 +1,41 @@ +--- +id: beta-requestable-object-reference +title: RequestableObjectReference +pagination_label: RequestableObjectReference +sidebar_label: RequestableObjectReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestableObjectReference', 'BetaRequestableObjectReference'] +slug: /tools/sdk/powershell/beta/models/requestable-object-reference +tags: ['SDK', 'Software Development Kit', 'RequestableObjectReference', 'BetaRequestableObjectReference'] +--- + + +# RequestableObjectReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the object. | [optional] +**Name** | Pointer to **String** | Name of the object. | [optional] +**Description** | Pointer to **String** | Description of the object. | [optional] +**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | Type of the object. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestableObjectReference = Initialize-PSSailpoint.BetaRequestableObjectReference -Id 2c938083633d259901633d25c68c00fa ` + -Name Object Name ` + -Description Object Description ` + -Type ROLE +``` + +- Convert the resource to JSON +```powershell +$RequestableObjectReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestableObjectRequestStatus.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestableObjectRequestStatus.md new file mode 100644 index 000000000..1d75fb372 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestableObjectRequestStatus.md @@ -0,0 +1,26 @@ +--- +id: beta-requestable-object-request-status +title: RequestableObjectRequestStatus +pagination_label: RequestableObjectRequestStatus +sidebar_label: RequestableObjectRequestStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestableObjectRequestStatus', 'BetaRequestableObjectRequestStatus'] +slug: /tools/sdk/powershell/beta/models/requestable-object-request-status +tags: ['SDK', 'Software Development Kit', 'RequestableObjectRequestStatus', 'BetaRequestableObjectRequestStatus'] +--- + + +# RequestableObjectRequestStatus + +## Enum + + +* `AVAILABLE` (value: `"AVAILABLE"`) + +* `PENDING` (value: `"PENDING"`) + +* `ASSIGNED` (value: `"ASSIGNED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestableObjectType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestableObjectType.md new file mode 100644 index 000000000..605099a88 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestableObjectType.md @@ -0,0 +1,26 @@ +--- +id: beta-requestable-object-type +title: RequestableObjectType +pagination_label: RequestableObjectType +sidebar_label: RequestableObjectType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestableObjectType', 'BetaRequestableObjectType'] +slug: /tools/sdk/powershell/beta/models/requestable-object-type +tags: ['SDK', 'Software Development Kit', 'RequestableObjectType', 'BetaRequestableObjectType'] +--- + + +# RequestableObjectType + +## Enum + + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ROLE` (value: `"ROLE"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemDetails.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemDetails.md new file mode 100644 index 000000000..3a9327308 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemDetails.md @@ -0,0 +1,37 @@ +--- +id: beta-requested-item-details +title: RequestedItemDetails +pagination_label: RequestedItemDetails +sidebar_label: RequestedItemDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemDetails', 'BetaRequestedItemDetails'] +slug: /tools/sdk/powershell/beta/models/requested-item-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemDetails', 'BetaRequestedItemDetails'] +--- + + +# RequestedItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "ENTITLEMENT", "ROLE" ] | The type of access item requested. | [optional] +**Id** | Pointer to **String** | The id of the access item requested. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemDetails = Initialize-PSSailpoint.BetaRequestedItemDetails -Type ENTITLEMENT ` + -Id 779c6fd7171540bba1184e5946112c28 +``` + +- Convert the resource to JSON +```powershell +$RequestedItemDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemStatus.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemStatus.md new file mode 100644 index 000000000..c36589880 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemStatus.md @@ -0,0 +1,81 @@ +--- +id: beta-requested-item-status +title: RequestedItemStatus +pagination_label: RequestedItemStatus +sidebar_label: RequestedItemStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatus', 'BetaRequestedItemStatus'] +slug: /tools/sdk/powershell/beta/models/requested-item-status +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatus', 'BetaRequestedItemStatus'] +--- + + +# RequestedItemStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Human-readable display name of the item being requested. | [optional] +**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | Type of requested object. | [optional] +**CancelledRequestDetails** | Pointer to [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional] +**ErrorMessages** | Pointer to [**[]ErrorMessageDto[]**](error-message-dto) | List of list of localized error messages, if any, encountered during the approval/provisioning process. | [optional] +**State** | Pointer to [**RequestedItemStatusRequestState**](requested-item-status-request-state) | | [optional] +**ApprovalDetails** | Pointer to [**[]ApprovalStatusDto**](approval-status-dto) | Approval details for each item. | [optional] +**ApprovalIds** | Pointer to **[]String** | List of approval IDs associated with the request. | [optional] +**ManualWorkItemDetails** | Pointer to [**[]ManualWorkItemDetails**](manual-work-item-details) | Manual work items created for provisioning the item. | [optional] +**AccountActivityItemId** | Pointer to **String** | Id of associated account activity item. | [optional] +**RequestType** | Pointer to [**AccessRequestType**](access-request-type) | | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] +**Requester** | Pointer to [**AccessItemRequester**](access-item-requester) | | [optional] +**RequestedFor** | Pointer to [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] +**RequesterComment** | Pointer to [**RequestedItemStatusRequesterComment**](requested-item-status-requester-comment) | | [optional] +**SodViolationContext** | Pointer to [**RequestedItemStatusSodViolationContext**](requested-item-status-sod-violation-context) | | [optional] +**ProvisioningDetails** | Pointer to [**RequestedItemStatusProvisioningDetails**](requested-item-status-provisioning-details) | | [optional] +**PreApprovalTriggerDetails** | Pointer to [**RequestedItemStatusPreApprovalTriggerDetails**](requested-item-status-pre-approval-trigger-details) | | [optional] +**AccessRequestPhases** | Pointer to [**[]AccessRequestPhases**](access-request-phases) | A list of Phases that the Access Request has gone through in order, to help determine the status of the request. | [optional] +**Description** | Pointer to **String** | Description associated to the requested object. | [optional] +**RemoveDate** | Pointer to **System.DateTime** | When the role access is scheduled for removal. | [optional] +**Cancelable** | Pointer to **Boolean** | True if the request can be canceled. | [optional] [default to $false] +**AccessRequestId** | Pointer to **String** | This is the account activity id. | [optional] +**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemStatus = Initialize-PSSailpoint.BetaRequestedItemStatus -Name AccessProfile1 ` + -Type ACCESS_PROFILE ` + -CancelledRequestDetails null ` + -ErrorMessages null ` + -State null ` + -ApprovalDetails null ` + -ApprovalIds [85f0cf482dd44327b593624c07906c21, fa57e1bfa36f41ee85e33ee59fcbeac5] ` + -ManualWorkItemDetails null ` + -AccountActivityItemId 2c9180926cbfbddd016cbfc7c3b10010 ` + -RequestType null ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z ` + -Requester null ` + -RequestedFor null ` + -RequesterComment null ` + -SodViolationContext null ` + -ProvisioningDetails null ` + -PreApprovalTriggerDetails null ` + -AccessRequestPhases null ` + -Description This is the Engineering role that engineers are granted. ` + -RemoveDate 2019-10-23T00:00Z ` + -Cancelable true ` + -AccessRequestId 2b838de9-db9b-abcf-e646-d4f274ad4238 ` + -ClientMetadata {key1=value1, key2=value2} +``` + +- Convert the resource to JSON +```powershell +$RequestedItemStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemStatusCancelledRequestDetails.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemStatusCancelledRequestDetails.md new file mode 100644 index 000000000..356bf831a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemStatusCancelledRequestDetails.md @@ -0,0 +1,39 @@ +--- +id: beta-requested-item-status-cancelled-request-details +title: RequestedItemStatusCancelledRequestDetails +pagination_label: RequestedItemStatusCancelledRequestDetails +sidebar_label: RequestedItemStatusCancelledRequestDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusCancelledRequestDetails', 'BetaRequestedItemStatusCancelledRequestDetails'] +slug: /tools/sdk/powershell/beta/models/requested-item-status-cancelled-request-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusCancelledRequestDetails', 'BetaRequestedItemStatusCancelledRequestDetails'] +--- + + +# RequestedItemStatusCancelledRequestDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment made by the owner when cancelling the associated request. | [optional] +**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**Modified** | Pointer to **System.DateTime** | Date comment was added by the owner when cancelling the associated request. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemStatusCancelledRequestDetails = Initialize-PSSailpoint.BetaRequestedItemStatusCancelledRequestDetails -Comment This request must be cancelled. ` + -Owner null ` + -Modified 2019-12-20T09:17:12.192Z +``` + +- Convert the resource to JSON +```powershell +$RequestedItemStatusCancelledRequestDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemStatusPreApprovalTriggerDetails.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemStatusPreApprovalTriggerDetails.md new file mode 100644 index 000000000..313b82dcd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemStatusPreApprovalTriggerDetails.md @@ -0,0 +1,39 @@ +--- +id: beta-requested-item-status-pre-approval-trigger-details +title: RequestedItemStatusPreApprovalTriggerDetails +pagination_label: RequestedItemStatusPreApprovalTriggerDetails +sidebar_label: RequestedItemStatusPreApprovalTriggerDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusPreApprovalTriggerDetails', 'BetaRequestedItemStatusPreApprovalTriggerDetails'] +slug: /tools/sdk/powershell/beta/models/requested-item-status-pre-approval-trigger-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusPreApprovalTriggerDetails', 'BetaRequestedItemStatusPreApprovalTriggerDetails'] +--- + + +# RequestedItemStatusPreApprovalTriggerDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment left for the pre-approval decision | [optional] +**Reviewer** | Pointer to **String** | The reviewer of the pre-approval decision | [optional] +**Decision** | Pointer to **Enum** [ "APPROVED", "REJECTED" ] | The decision of the pre-approval trigger | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemStatusPreApprovalTriggerDetails = Initialize-PSSailpoint.BetaRequestedItemStatusPreApprovalTriggerDetails -Comment Access is Approved ` + -Reviewer John Doe ` + -Decision APPROVED +``` + +- Convert the resource to JSON +```powershell +$RequestedItemStatusPreApprovalTriggerDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemStatusProvisioningDetails.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemStatusProvisioningDetails.md new file mode 100644 index 000000000..cf3391f90 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemStatusProvisioningDetails.md @@ -0,0 +1,35 @@ +--- +id: beta-requested-item-status-provisioning-details +title: RequestedItemStatusProvisioningDetails +pagination_label: RequestedItemStatusProvisioningDetails +sidebar_label: RequestedItemStatusProvisioningDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusProvisioningDetails', 'BetaRequestedItemStatusProvisioningDetails'] +slug: /tools/sdk/powershell/beta/models/requested-item-status-provisioning-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusProvisioningDetails', 'BetaRequestedItemStatusProvisioningDetails'] +--- + + +# RequestedItemStatusProvisioningDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OrderedSubPhaseReferences** | Pointer to **String** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain ""manualWorkItemDetails"" which indicate that there is further information in that object for this phase. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemStatusProvisioningDetails = Initialize-PSSailpoint.BetaRequestedItemStatusProvisioningDetails -OrderedSubPhaseReferences manualWorkItemDetails +``` + +- Convert the resource to JSON +```powershell +$RequestedItemStatusProvisioningDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemStatusRequestState.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemStatusRequestState.md new file mode 100644 index 000000000..9f4d7063f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemStatusRequestState.md @@ -0,0 +1,38 @@ +--- +id: beta-requested-item-status-request-state +title: RequestedItemStatusRequestState +pagination_label: RequestedItemStatusRequestState +sidebar_label: RequestedItemStatusRequestState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusRequestState', 'BetaRequestedItemStatusRequestState'] +slug: /tools/sdk/powershell/beta/models/requested-item-status-request-state +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequestState', 'BetaRequestedItemStatusRequestState'] +--- + + +# RequestedItemStatusRequestState + +## Enum + + +* `EXECUTING` (value: `"EXECUTING"`) + +* `REQUEST_COMPLETED` (value: `"REQUEST_COMPLETED"`) + +* `CANCELLED` (value: `"CANCELLED"`) + +* `TERMINATED` (value: `"TERMINATED"`) + +* `PROVISIONING_VERIFICATION_PENDING` (value: `"PROVISIONING_VERIFICATION_PENDING"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `PROVISIONING_FAILED` (value: `"PROVISIONING_FAILED"`) + +* `NOT_ALL_ITEMS_PROVISIONED` (value: `"NOT_ALL_ITEMS_PROVISIONED"`) + +* `ERROR` (value: `"ERROR"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemStatusRequestedFor.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemStatusRequestedFor.md new file mode 100644 index 000000000..bb2f68fc9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemStatusRequestedFor.md @@ -0,0 +1,39 @@ +--- +id: beta-requested-item-status-requested-for +title: RequestedItemStatusRequestedFor +pagination_label: RequestedItemStatusRequestedFor +sidebar_label: RequestedItemStatusRequestedFor +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusRequestedFor', 'BetaRequestedItemStatusRequestedFor'] +slug: /tools/sdk/powershell/beta/models/requested-item-status-requested-for +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequestedFor', 'BetaRequestedItemStatusRequestedFor'] +--- + + +# RequestedItemStatusRequestedFor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Type of the object to which this reference applies | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemStatusRequestedFor = Initialize-PSSailpoint.BetaRequestedItemStatusRequestedFor -Type IDENTITY ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$RequestedItemStatusRequestedFor | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemStatusRequesterComment.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemStatusRequesterComment.md new file mode 100644 index 000000000..7a6be94af --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemStatusRequesterComment.md @@ -0,0 +1,39 @@ +--- +id: beta-requested-item-status-requester-comment +title: RequestedItemStatusRequesterComment +pagination_label: RequestedItemStatusRequesterComment +sidebar_label: RequestedItemStatusRequesterComment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusRequesterComment', 'BetaRequestedItemStatusRequesterComment'] +slug: /tools/sdk/powershell/beta/models/requested-item-status-requester-comment +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequesterComment', 'BetaRequestedItemStatusRequesterComment'] +--- + + +# RequestedItemStatusRequesterComment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment content. | [optional] +**Created** | Pointer to **System.DateTime** | Date and time comment was created. | [optional] +**Author** | Pointer to [**CommentDto1Author**](comment-dto1-author) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemStatusRequesterComment = Initialize-PSSailpoint.BetaRequestedItemStatusRequesterComment -Comment This is a comment. ` + -Created 2017-07-11T18:45:37.098Z ` + -Author null +``` + +- Convert the resource to JSON +```powershell +$RequestedItemStatusRequesterComment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemStatusSodViolationContext.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemStatusSodViolationContext.md new file mode 100644 index 000000000..00ed8cfe6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RequestedItemStatusSodViolationContext.md @@ -0,0 +1,39 @@ +--- +id: beta-requested-item-status-sod-violation-context +title: RequestedItemStatusSodViolationContext +pagination_label: RequestedItemStatusSodViolationContext +sidebar_label: RequestedItemStatusSodViolationContext +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusSodViolationContext', 'BetaRequestedItemStatusSodViolationContext'] +slug: /tools/sdk/powershell/beta/models/requested-item-status-sod-violation-context +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusSodViolationContext', 'BetaRequestedItemStatusSodViolationContext'] +--- + + +# RequestedItemStatusSodViolationContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **Enum** [ "SUCCESS", "ERROR" ] | The status of SOD violation check | [optional] +**Uuid** | Pointer to **String** | The id of the Violation check event | [optional] +**ViolationCheckResult** | Pointer to [**SodViolationCheckResult**](sod-violation-check-result) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemStatusSodViolationContext = Initialize-PSSailpoint.BetaRequestedItemStatusSodViolationContext -State SUCCESS ` + -Uuid f73d16e9-a038-46c5-b217-1246e15fdbdd ` + -ViolationCheckResult null +``` + +- Convert the resource to JSON +```powershell +$RequestedItemStatusSodViolationContext | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ResourceBundleMessage.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ResourceBundleMessage.md new file mode 100644 index 000000000..e81dd05b7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ResourceBundleMessage.md @@ -0,0 +1,37 @@ +--- +id: beta-resource-bundle-message +title: ResourceBundleMessage +pagination_label: ResourceBundleMessage +sidebar_label: ResourceBundleMessage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ResourceBundleMessage', 'BetaResourceBundleMessage'] +slug: /tools/sdk/powershell/beta/models/resource-bundle-message +tags: ['SDK', 'Software Development Kit', 'ResourceBundleMessage', 'BetaResourceBundleMessage'] +--- + + +# ResourceBundleMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **String** | The key of the message | [optional] +**Format** | Pointer to **String** | The format of the message | [optional] + +## Examples + +- Prepare the resource +```powershell +$ResourceBundleMessage = Initialize-PSSailpoint.BetaResourceBundleMessage -Key recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_LOW ` + -Format {0,,\"i18n hint: percentage\"}% of identities with the same {1,,\"i18n hint: name of category feature\"} have this access. This information had a low impact on the overall score. +``` + +- Convert the resource to JSON +```powershell +$ResourceBundleMessage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ResourceObject.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ResourceObject.md new file mode 100644 index 000000000..4299960a4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ResourceObject.md @@ -0,0 +1,59 @@ +--- +id: beta-resource-object +title: ResourceObject +pagination_label: ResourceObject +sidebar_label: ResourceObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ResourceObject', 'BetaResourceObject'] +slug: /tools/sdk/powershell/beta/models/resource-object +tags: ['SDK', 'Software Development Kit', 'ResourceObject', 'BetaResourceObject'] +--- + + +# ResourceObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Instance** | Pointer to **String** | Identifier of the specific instance where this object resides. | [optional] [readonly] +**Identity** | Pointer to **String** | Native identity of the object in the Source. | [optional] [readonly] +**Uuid** | Pointer to **String** | Universal unique identifier of the object in the Source. | [optional] [readonly] +**PreviousIdentity** | Pointer to **String** | Native identity that the object has previously. | [optional] [readonly] +**Name** | Pointer to **String** | Display name for this object. | [optional] [readonly] +**ObjectType** | Pointer to **String** | Type of object. | [optional] [readonly] +**Incomplete** | Pointer to **Boolean** | A flag indicating that this is an incomplete object. Used in special cases where the connector has to return account information in several phases and the objects might not have a complete set of all account attributes. The attributes in this object will replace the corresponding attributes in the Link, but no other Link attributes will be changed. | [optional] [readonly] +**Incremental** | Pointer to **Boolean** | A flag indicating that this is an incremental change object. This is similar to incomplete but it also means that the values of any multi-valued attributes in this object should be merged with the existing values in the Link rather than replacing the existing Link value. | [optional] [readonly] +**Delete** | Pointer to **Boolean** | A flag indicating that this object has been deleted. This is set only when doing delta aggregation and the connector supports detection of native deletes. | [optional] [readonly] +**Remove** | Pointer to **Boolean** | A flag set indicating that the values in the attributes represent things to remove rather than things to add. Setting this implies incremental. The values which are always for multi-valued attributes are removed from the current values. | [optional] [readonly] +**Missing** | Pointer to **[]String** | A list of attribute names that are not included in this object. This is only used with SMConnector and will only contain ""groups"". | [optional] [readonly] +**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Attributes of this ResourceObject. | [optional] [readonly] +**FinalUpdate** | Pointer to **Boolean** | In Aggregation, for sparse object the count for total accounts scanned identities updated is not incremented. | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$ResourceObject = Initialize-PSSailpoint.BetaResourceObject -Instance null ` + -Identity CN=Aaron Carr,OU=test1,DC=test2,DC=test ` + -Uuid {abf7bd9b-68b4-4d21-9b70-870c58ebf844} ` + -PreviousIdentity null ` + -Name Aaron Carr ` + -ObjectType account ` + -Incomplete false ` + -Incremental false ` + -Delete false ` + -Remove false ` + -Missing [missFieldOne, missFieldTwo] ` + -Attributes {telephoneNumber=12-(345)678-9012, mail=example@test.com, displayName=Aaron Carr} ` + -FinalUpdate false +``` + +- Convert the resource to JSON +```powershell +$ResourceObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ResourceObjectsRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ResourceObjectsRequest.md new file mode 100644 index 000000000..b33ecd40d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ResourceObjectsRequest.md @@ -0,0 +1,37 @@ +--- +id: beta-resource-objects-request +title: ResourceObjectsRequest +pagination_label: ResourceObjectsRequest +sidebar_label: ResourceObjectsRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ResourceObjectsRequest', 'BetaResourceObjectsRequest'] +slug: /tools/sdk/powershell/beta/models/resource-objects-request +tags: ['SDK', 'Software Development Kit', 'ResourceObjectsRequest', 'BetaResourceObjectsRequest'] +--- + + +# ResourceObjectsRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectType** | Pointer to **String** | The type of resource objects to iterate over. | [optional] [default to "account"] +**MaxCount** | Pointer to **Int32** | The maximum number of resource objects to iterate over and return. | [optional] [default to 25] + +## Examples + +- Prepare the resource +```powershell +$ResourceObjectsRequest = Initialize-PSSailpoint.BetaResourceObjectsRequest -ObjectType group ` + -MaxCount 100 +``` + +- Convert the resource to JSON +```powershell +$ResourceObjectsRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ResourceObjectsResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ResourceObjectsResponse.md new file mode 100644 index 000000000..f7ded4b19 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ResourceObjectsResponse.md @@ -0,0 +1,43 @@ +--- +id: beta-resource-objects-response +title: ResourceObjectsResponse +pagination_label: ResourceObjectsResponse +sidebar_label: ResourceObjectsResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ResourceObjectsResponse', 'BetaResourceObjectsResponse'] +slug: /tools/sdk/powershell/beta/models/resource-objects-response +tags: ['SDK', 'Software Development Kit', 'ResourceObjectsResponse', 'BetaResourceObjectsResponse'] +--- + + +# ResourceObjectsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the source | [optional] [readonly] +**Name** | Pointer to **String** | Name of the source | [optional] [readonly] +**ObjectCount** | Pointer to **Int32** | The number of objects that were fetched by the connector. | [optional] [readonly] +**ElapsedMillis** | Pointer to **Int32** | The number of milliseconds spent on the entire request. | [optional] [readonly] +**ResourceObjects** | Pointer to [**[]ResourceObject**](resource-object) | Fetched objects from the source connector. | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$ResourceObjectsResponse = Initialize-PSSailpoint.BetaResourceObjectsResponse -Id 2c91808568c529c60168cca6f90c1313 ` + -Name ODS-AD-Test [source-999999] ` + -ObjectCount 25 ` + -ElapsedMillis 1055 ` + -ResourceObjects null +``` + +- Convert the resource to JSON +```powershell +$ResourceObjectsResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ReviewReassign.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ReviewReassign.md new file mode 100644 index 000000000..aa0b9181d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ReviewReassign.md @@ -0,0 +1,39 @@ +--- +id: beta-review-reassign +title: ReviewReassign +pagination_label: ReviewReassign +sidebar_label: ReviewReassign +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewReassign', 'BetaReviewReassign'] +slug: /tools/sdk/powershell/beta/models/review-reassign +tags: ['SDK', 'Software Development Kit', 'ReviewReassign', 'BetaReviewReassign'] +--- + + +# ReviewReassign + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$ReviewReassign = Initialize-PSSailpoint.BetaReviewReassign -Reassign null ` + -ReassignTo ef38f94347e94562b5bb8424a56397d8 ` + -Reason reassigned for some reason +``` + +- Convert the resource to JSON +```powershell +$ReviewReassign | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Reviewer.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Reviewer.md new file mode 100644 index 000000000..8ad022b96 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Reviewer.md @@ -0,0 +1,41 @@ +--- +id: beta-reviewer +title: Reviewer +pagination_label: Reviewer +sidebar_label: Reviewer +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Reviewer', 'BetaReviewer'] +slug: /tools/sdk/powershell/beta/models/reviewer +tags: ['SDK', 'Software Development Kit', 'Reviewer', 'BetaReviewer'] +--- + + +# Reviewer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY", "GOVERNANCE_GROUP" ] | The reviewer's DTO type. | [required] +**Id** | **String** | The reviewer's ID. | [required] +**Name** | **String** | The reviewer's display name. | [required] +**Email** | Pointer to **String** | The reviewing identity's email. Only applicable to `IDENTITY`. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Reviewer = Initialize-PSSailpoint.BetaReviewer -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels ` + -Email reviewer@test.com +``` + +- Convert the resource to JSON +```powershell +$Reviewer | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Revocability.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Revocability.md new file mode 100644 index 000000000..c187446a6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Revocability.md @@ -0,0 +1,35 @@ +--- +id: beta-revocability +title: Revocability +pagination_label: Revocability +sidebar_label: Revocability +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Revocability', 'BetaRevocability'] +slug: /tools/sdk/powershell/beta/models/revocability +tags: ['SDK', 'Software Development Kit', 'Revocability', 'BetaRevocability'] +--- + + +# Revocability + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalSchemes** | Pointer to [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] + +## Examples + +- Prepare the resource +```powershell +$Revocability = Initialize-PSSailpoint.BetaRevocability -ApprovalSchemes null +``` + +- Convert the resource to JSON +```powershell +$Revocability | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RevocabilityForRole.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RevocabilityForRole.md new file mode 100644 index 000000000..fcd58c817 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RevocabilityForRole.md @@ -0,0 +1,39 @@ +--- +id: beta-revocability-for-role +title: RevocabilityForRole +pagination_label: RevocabilityForRole +sidebar_label: RevocabilityForRole +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RevocabilityForRole', 'BetaRevocabilityForRole'] +slug: /tools/sdk/powershell/beta/models/revocability-for-role +tags: ['SDK', 'Software Development Kit', 'RevocabilityForRole', 'BetaRevocabilityForRole'] +--- + + +# RevocabilityForRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommentsRequired** | Pointer to **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] +**DenialCommentsRequired** | Pointer to **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] +**ApprovalSchemes** | Pointer to [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the revocation request | [optional] + +## Examples + +- Prepare the resource +```powershell +$RevocabilityForRole = Initialize-PSSailpoint.BetaRevocabilityForRole -CommentsRequired false ` + -DenialCommentsRequired false ` + -ApprovalSchemes null +``` + +- Convert the resource to JSON +```powershell +$RevocabilityForRole | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RightPad.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RightPad.md new file mode 100644 index 000000000..d02d84395 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RightPad.md @@ -0,0 +1,41 @@ +--- +id: beta-right-pad +title: RightPad +pagination_label: RightPad +sidebar_label: RightPad +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RightPad', 'BetaRightPad'] +slug: /tools/sdk/powershell/beta/models/right-pad +tags: ['SDK', 'Software Development Kit', 'RightPad', 'BetaRightPad'] +--- + + +# RightPad + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Length** | **String** | An integer value for the desired length of the final output string | [required] +**Padding** | Pointer to **String** | A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space ("" "") character for padding | [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] + +## Examples + +- Prepare the resource +```powershell +$RightPad = Initialize-PSSailpoint.BetaRightPad -Length 4 ` + -Padding 0 ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$RightPad | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Role.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Role.md new file mode 100644 index 000000000..239f0a265 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Role.md @@ -0,0 +1,69 @@ +--- +id: beta-role +title: Role +pagination_label: Role +sidebar_label: Role +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Role', 'BetaRole'] +slug: /tools/sdk/powershell/beta/models/role +tags: ['SDK', 'Software Development Kit', 'Role', 'BetaRole'] +--- + + +# Role + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result. | [optional] +**Name** | **String** | The human-readable display name of the Role | [required] +**Created** | Pointer to **System.DateTime** | Date the Role was created | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | Date the Role was last modified. | [optional] [readonly] +**Description** | Pointer to **String** | A human-readable description of the Role | [optional] +**Owner** | [**OwnerReference**](owner-reference) | | [required] +**AccessProfiles** | Pointer to [**[]AccessProfileRef**](access-profile-ref) | | [optional] +**Entitlements** | Pointer to [**[]EntitlementRef**](entitlement-ref) | | [optional] +**Membership** | Pointer to [**RoleMembershipSelector**](role-membership-selector) | | [optional] +**LegacyMembershipInfo** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. | [optional] +**Enabled** | Pointer to **Boolean** | Whether the Role is enabled or not. | [optional] [default to $false] +**Requestable** | Pointer to **Boolean** | Whether the Role can be the target of access requests. | [optional] [default to $false] +**AccessRequestConfig** | Pointer to [**RequestabilityForRole**](requestability-for-role) | | [optional] +**RevocationRequestConfig** | Pointer to [**RevocabilityForRole**](revocability-for-role) | | [optional] +**Segments** | Pointer to **[]String** | List of IDs of segments, if any, to which this Role is assigned. | [optional] +**Dimensional** | Pointer to **Boolean** | Whether the Role is dimensional. | [optional] [default to $false] +**DimensionRefs** | Pointer to [**[]DimensionRef**](dimension-ref) | List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional. | [optional] +**AccessModelMetadata** | Pointer to [**AttributeDTOList**](attribute-dto-list) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Role = Initialize-PSSailpoint.BetaRole -Id 2c918086749d78830174a1a40e121518 ` + -Name Role 2567 ` + -Created 2021-03-01T22:32:58.104Z ` + -Modified 2021-03-02T20:22:28.104Z ` + -Description Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor. ` + -Owner null ` + -AccessProfiles null ` + -Entitlements null ` + -Membership null ` + -LegacyMembershipInfo {type=IDENTITY_LIST} ` + -Enabled true ` + -Requestable true ` + -AccessRequestConfig null ` + -RevocationRequestConfig null ` + -Segments [f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a] ` + -Dimensional null ` + -DimensionRefs null ` + -AccessModelMetadata null +``` + +- Convert the resource to JSON +```powershell +$Role | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleAssignmentDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleAssignmentDto.md new file mode 100644 index 000000000..7ff8595c3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleAssignmentDto.md @@ -0,0 +1,51 @@ +--- +id: beta-role-assignment-dto +title: RoleAssignmentDto +pagination_label: RoleAssignmentDto +sidebar_label: RoleAssignmentDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleAssignmentDto', 'BetaRoleAssignmentDto'] +slug: /tools/sdk/powershell/beta/models/role-assignment-dto +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentDto', 'BetaRoleAssignmentDto'] +--- + + +# RoleAssignmentDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Assignment Id | [optional] +**Role** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] +**Comments** | Pointer to **String** | Comments added by the user when the assignment was made | [optional] +**AssignmentSource** | Pointer to **String** | Source describing how this assignment was made | [optional] +**Assigner** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] +**AssignedDimensions** | Pointer to [**[]BaseReferenceDto1**](base-reference-dto1) | Dimensions assigned related to this role | [optional] +**AssignmentContext** | Pointer to [**AssignmentContextDto**](assignment-context-dto) | | [optional] +**AccountTargets** | Pointer to [**[]RoleTargetDto**](role-target-dto) | | [optional] +**RemoveDate** | Pointer to **String** | Date that the assignment will be removed | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleAssignmentDto = Initialize-PSSailpoint.BetaRoleAssignmentDto -Id 1cbb0705b38c4226b1334eadd8874086 ` + -Role null ` + -Comments I'm a new Engineer and need this role to do my work ` + -AssignmentSource UI ` + -Assigner null ` + -AssignedDimensions [{id=1acc8ffe5fcf457090de28bee2af36ee, type=DIMENSION, name=Northeast region}] ` + -AssignmentContext null ` + -AccountTargets null ` + -RemoveDate Wed Feb 14 10:58:42 +``` + +- Convert the resource to JSON +```powershell +$RoleAssignmentDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleAssignmentRef.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleAssignmentRef.md new file mode 100644 index 000000000..97fdf279e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleAssignmentRef.md @@ -0,0 +1,37 @@ +--- +id: beta-role-assignment-ref +title: RoleAssignmentRef +pagination_label: RoleAssignmentRef +sidebar_label: RoleAssignmentRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleAssignmentRef', 'BetaRoleAssignmentRef'] +slug: /tools/sdk/powershell/beta/models/role-assignment-ref +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentRef', 'BetaRoleAssignmentRef'] +--- + + +# RoleAssignmentRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Assignment Id | [optional] +**Role** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleAssignmentRef = Initialize-PSSailpoint.BetaRoleAssignmentRef -Id 1cbb0705b38c4226b1334eadd8874086 ` + -Role null +``` + +- Convert the resource to JSON +```powershell +$RoleAssignmentRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleAssignmentSourceType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleAssignmentSourceType.md new file mode 100644 index 000000000..8b29e40f9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleAssignmentSourceType.md @@ -0,0 +1,24 @@ +--- +id: beta-role-assignment-source-type +title: RoleAssignmentSourceType +pagination_label: RoleAssignmentSourceType +sidebar_label: RoleAssignmentSourceType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleAssignmentSourceType', 'BetaRoleAssignmentSourceType'] +slug: /tools/sdk/powershell/beta/models/role-assignment-source-type +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentSourceType', 'BetaRoleAssignmentSourceType'] +--- + + +# RoleAssignmentSourceType + +## Enum + + +* `ACCESS_REQUEST` (value: `"ACCESS_REQUEST"`) + +* `ROLE_MEMBERSHIP` (value: `"ROLE_MEMBERSHIP"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleBulkDeleteRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleBulkDeleteRequest.md new file mode 100644 index 000000000..1acea1e82 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleBulkDeleteRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-role-bulk-delete-request +title: RoleBulkDeleteRequest +pagination_label: RoleBulkDeleteRequest +sidebar_label: RoleBulkDeleteRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleBulkDeleteRequest', 'BetaRoleBulkDeleteRequest'] +slug: /tools/sdk/powershell/beta/models/role-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'RoleBulkDeleteRequest', 'BetaRoleBulkDeleteRequest'] +--- + + +# RoleBulkDeleteRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RoleIds** | **[]String** | List of IDs of Roles to be deleted. | [required] + +## Examples + +- Prepare the resource +```powershell +$RoleBulkDeleteRequest = Initialize-PSSailpoint.BetaRoleBulkDeleteRequest -RoleIds [2c9180847812e0b1017817051919ecca, 2c9180887812e0b201781e129f151816] +``` + +- Convert the resource to JSON +```powershell +$RoleBulkDeleteRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleCriteriaKey.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleCriteriaKey.md new file mode 100644 index 000000000..fb948ad9d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleCriteriaKey.md @@ -0,0 +1,39 @@ +--- +id: beta-role-criteria-key +title: RoleCriteriaKey +pagination_label: RoleCriteriaKey +sidebar_label: RoleCriteriaKey +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaKey', 'BetaRoleCriteriaKey'] +slug: /tools/sdk/powershell/beta/models/role-criteria-key +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKey', 'BetaRoleCriteriaKey'] +--- + + +# RoleCriteriaKey + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**RoleCriteriaKeyType**](role-criteria-key-type) | | [required] +**Property** | **String** | The name of the attribute or entitlement to which the associated criteria applies. | [required] +**SourceId** | Pointer to **String** | ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleCriteriaKey = Initialize-PSSailpoint.BetaRoleCriteriaKey -Type null ` + -Property attribute.email ` + -SourceId 2c9180867427f3a301745aec18211519 +``` + +- Convert the resource to JSON +```powershell +$RoleCriteriaKey | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleCriteriaKeyType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleCriteriaKeyType.md new file mode 100644 index 000000000..363a6eb48 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleCriteriaKeyType.md @@ -0,0 +1,26 @@ +--- +id: beta-role-criteria-key-type +title: RoleCriteriaKeyType +pagination_label: RoleCriteriaKeyType +sidebar_label: RoleCriteriaKeyType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaKeyType', 'BetaRoleCriteriaKeyType'] +slug: /tools/sdk/powershell/beta/models/role-criteria-key-type +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKeyType', 'BetaRoleCriteriaKeyType'] +--- + + +# RoleCriteriaKeyType + +## Enum + + +* `IDENTITY` (value: `"IDENTITY"`) + +* `ACCOUNT` (value: `"ACCOUNT"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleCriteriaLevel1.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleCriteriaLevel1.md new file mode 100644 index 000000000..f05d7bc67 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleCriteriaLevel1.md @@ -0,0 +1,41 @@ +--- +id: beta-role-criteria-level1 +title: RoleCriteriaLevel1 +pagination_label: RoleCriteriaLevel1 +sidebar_label: RoleCriteriaLevel1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaLevel1', 'BetaRoleCriteriaLevel1'] +slug: /tools/sdk/powershell/beta/models/role-criteria-level1 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel1', 'BetaRoleCriteriaLevel1'] +--- + + +# RoleCriteriaLevel1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**Key** | Pointer to [**RoleCriteriaKey**](role-criteria-key) | | [optional] +**StringValue** | Pointer to **String** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] +**Children** | Pointer to [**[]RoleCriteriaLevel2**](role-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleCriteriaLevel1 = Initialize-PSSailpoint.BetaRoleCriteriaLevel1 -Operation null ` + -Key null ` + -StringValue carlee.cert1c9f9b6fd@mailinator.com ` + -Children null +``` + +- Convert the resource to JSON +```powershell +$RoleCriteriaLevel1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleCriteriaLevel2.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleCriteriaLevel2.md new file mode 100644 index 000000000..02cb6a815 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleCriteriaLevel2.md @@ -0,0 +1,41 @@ +--- +id: beta-role-criteria-level2 +title: RoleCriteriaLevel2 +pagination_label: RoleCriteriaLevel2 +sidebar_label: RoleCriteriaLevel2 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaLevel2', 'BetaRoleCriteriaLevel2'] +slug: /tools/sdk/powershell/beta/models/role-criteria-level2 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel2', 'BetaRoleCriteriaLevel2'] +--- + + +# RoleCriteriaLevel2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**Key** | Pointer to [**RoleCriteriaKey**](role-criteria-key) | | [optional] +**StringValue** | Pointer to **String** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] +**Children** | Pointer to [**[]RoleCriteriaLevel3**](role-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleCriteriaLevel2 = Initialize-PSSailpoint.BetaRoleCriteriaLevel2 -Operation null ` + -Key null ` + -StringValue carlee.cert1c9f9b6fd@mailinator.com ` + -Children null +``` + +- Convert the resource to JSON +```powershell +$RoleCriteriaLevel2 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleCriteriaLevel3.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleCriteriaLevel3.md new file mode 100644 index 000000000..30287a18f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleCriteriaLevel3.md @@ -0,0 +1,39 @@ +--- +id: beta-role-criteria-level3 +title: RoleCriteriaLevel3 +pagination_label: RoleCriteriaLevel3 +sidebar_label: RoleCriteriaLevel3 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaLevel3', 'BetaRoleCriteriaLevel3'] +slug: /tools/sdk/powershell/beta/models/role-criteria-level3 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel3', 'BetaRoleCriteriaLevel3'] +--- + + +# RoleCriteriaLevel3 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**Key** | Pointer to [**RoleCriteriaKey**](role-criteria-key) | | [optional] +**StringValue** | Pointer to **String** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleCriteriaLevel3 = Initialize-PSSailpoint.BetaRoleCriteriaLevel3 -Operation null ` + -Key null ` + -StringValue carlee.cert1c9f9b6fd@mailinator.com +``` + +- Convert the resource to JSON +```powershell +$RoleCriteriaLevel3 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleCriteriaOperation.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleCriteriaOperation.md new file mode 100644 index 000000000..33c26f4a8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleCriteriaOperation.md @@ -0,0 +1,34 @@ +--- +id: beta-role-criteria-operation +title: RoleCriteriaOperation +pagination_label: RoleCriteriaOperation +sidebar_label: RoleCriteriaOperation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaOperation', 'BetaRoleCriteriaOperation'] +slug: /tools/sdk/powershell/beta/models/role-criteria-operation +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaOperation', 'BetaRoleCriteriaOperation'] +--- + + +# RoleCriteriaOperation + +## Enum + + +* `EQUALS` (value: `"EQUALS"`) + +* `NOT_EQUALS` (value: `"NOT_EQUALS"`) + +* `CONTAINS` (value: `"CONTAINS"`) + +* `STARTS_WITH` (value: `"STARTS_WITH"`) + +* `ENDS_WITH` (value: `"ENDS_WITH"`) + +* `AND` (value: `"AND"`) + +* `OR` (value: `"OR"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleIdentity.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleIdentity.md new file mode 100644 index 000000000..7b02c9147 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleIdentity.md @@ -0,0 +1,43 @@ +--- +id: beta-role-identity +title: RoleIdentity +pagination_label: RoleIdentity +sidebar_label: RoleIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleIdentity', 'BetaRoleIdentity'] +slug: /tools/sdk/powershell/beta/models/role-identity +tags: ['SDK', 'Software Development Kit', 'RoleIdentity', 'BetaRoleIdentity'] +--- + + +# RoleIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of the Identity | [optional] +**AliasName** | Pointer to **String** | The alias / username of the Identity | [optional] +**Name** | Pointer to **String** | The human-readable display name of the Identity | [optional] +**Email** | Pointer to **String** | Email address of the Identity | [optional] +**RoleAssignmentSource** | Pointer to [**RoleAssignmentSourceType**](role-assignment-source-type) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleIdentity = Initialize-PSSailpoint.BetaRoleIdentity -Id 2c9180a46faadee4016fb4e018c20639 ` + -AliasName t.edison ` + -Name Thomas Edison ` + -Email t.edison@identitynow.com ` + -RoleAssignmentSource null +``` + +- Convert the resource to JSON +```powershell +$RoleIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleInsight.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleInsight.md new file mode 100644 index 000000000..5e2edb69a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleInsight.md @@ -0,0 +1,45 @@ +--- +id: beta-role-insight +title: RoleInsight +pagination_label: RoleInsight +sidebar_label: RoleInsight +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsight', 'BetaRoleInsight'] +slug: /tools/sdk/powershell/beta/models/role-insight +tags: ['SDK', 'Software Development Kit', 'RoleInsight', 'BetaRoleInsight'] +--- + + +# RoleInsight + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Insight id | [optional] +**NumberOfUpdates** | Pointer to **Int32** | Total number of updates for this role | [optional] +**CreatedDate** | Pointer to **System.DateTime** | The date-time insights were last created for this role. | [optional] +**ModifiedDate** | Pointer to **System.DateTime** | The date-time insights were last modified for this role. | [optional] +**Role** | Pointer to [**RoleInsightsRole**](role-insights-role) | | [optional] +**Insight** | Pointer to [**RoleInsightsInsight**](role-insights-insight) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleInsight = Initialize-PSSailpoint.BetaRoleInsight -Id 1467e61e-f284-439c-ba2d-c6cc11cf0941 ` + -NumberOfUpdates 5 ` + -CreatedDate null ` + -ModifiedDate 2020-05-19T13:49:37.385Z ` + -Role null ` + -Insight null +``` + +- Convert the resource to JSON +```powershell +$RoleInsight | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleInsightsEntitlement.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleInsightsEntitlement.md new file mode 100644 index 000000000..4cbf72865 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleInsightsEntitlement.md @@ -0,0 +1,45 @@ +--- +id: beta-role-insights-entitlement +title: RoleInsightsEntitlement +pagination_label: RoleInsightsEntitlement +sidebar_label: RoleInsightsEntitlement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsightsEntitlement', 'BetaRoleInsightsEntitlement'] +slug: /tools/sdk/powershell/beta/models/role-insights-entitlement +tags: ['SDK', 'Software Development Kit', 'RoleInsightsEntitlement', 'BetaRoleInsightsEntitlement'] +--- + + +# RoleInsightsEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Name of the entitlement | [optional] +**Id** | Pointer to **String** | Id of the entitlement | [optional] +**Description** | Pointer to **String** | Description for the entitlement | [optional] +**Source** | Pointer to **String** | Source or the application for the entitlement | [optional] +**Attribute** | Pointer to **String** | Attribute for the entitlement | [optional] +**Value** | Pointer to **String** | Attribute value for the entitlement | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleInsightsEntitlement = Initialize-PSSailpoint.BetaRoleInsightsEntitlement -Name null ` + -Id null ` + -Description null ` + -Source null ` + -Attribute null ` + -Value null +``` + +- Convert the resource to JSON +```powershell +$RoleInsightsEntitlement | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleInsightsEntitlementChanges.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleInsightsEntitlementChanges.md new file mode 100644 index 000000000..56413d401 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleInsightsEntitlementChanges.md @@ -0,0 +1,47 @@ +--- +id: beta-role-insights-entitlement-changes +title: RoleInsightsEntitlementChanges +pagination_label: RoleInsightsEntitlementChanges +sidebar_label: RoleInsightsEntitlementChanges +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsightsEntitlementChanges', 'BetaRoleInsightsEntitlementChanges'] +slug: /tools/sdk/powershell/beta/models/role-insights-entitlement-changes +tags: ['SDK', 'Software Development Kit', 'RoleInsightsEntitlementChanges', 'BetaRoleInsightsEntitlementChanges'] +--- + + +# RoleInsightsEntitlementChanges + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Name of the entitlement | [optional] +**Id** | Pointer to **String** | Id of the entitlement | [optional] +**Description** | Pointer to **String** | Description for the entitlement | [optional] +**Attribute** | Pointer to **String** | Attribute for the entitlement | [optional] +**Value** | Pointer to **String** | Attribute value for the entitlement | [optional] +**Source** | Pointer to **String** | Source or the application for the entitlement | [optional] +**Insight** | Pointer to [**RoleInsightsInsight**](role-insights-insight) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleInsightsEntitlementChanges = Initialize-PSSailpoint.BetaRoleInsightsEntitlementChanges -Name null ` + -Id null ` + -Description null ` + -Attribute null ` + -Value null ` + -Source null ` + -Insight null +``` + +- Convert the resource to JSON +```powershell +$RoleInsightsEntitlementChanges | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleInsightsIdentities.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleInsightsIdentities.md new file mode 100644 index 000000000..5a468c903 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleInsightsIdentities.md @@ -0,0 +1,39 @@ +--- +id: beta-role-insights-identities +title: RoleInsightsIdentities +pagination_label: RoleInsightsIdentities +sidebar_label: RoleInsightsIdentities +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsightsIdentities', 'BetaRoleInsightsIdentities'] +slug: /tools/sdk/powershell/beta/models/role-insights-identities +tags: ['SDK', 'Software Development Kit', 'RoleInsightsIdentities', 'BetaRoleInsightsIdentities'] +--- + + +# RoleInsightsIdentities + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id for identity | [optional] +**Name** | Pointer to **String** | Name for identity | [optional] +**Attributes** | Pointer to **map[string]String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleInsightsIdentities = Initialize-PSSailpoint.BetaRoleInsightsIdentities -Id null ` + -Name null ` + -Attributes null +``` + +- Convert the resource to JSON +```powershell +$RoleInsightsIdentities | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleInsightsInsight.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleInsightsInsight.md new file mode 100644 index 000000000..465b2c406 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleInsightsInsight.md @@ -0,0 +1,43 @@ +--- +id: beta-role-insights-insight +title: RoleInsightsInsight +pagination_label: RoleInsightsInsight +sidebar_label: RoleInsightsInsight +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsightsInsight', 'BetaRoleInsightsInsight'] +slug: /tools/sdk/powershell/beta/models/role-insights-insight +tags: ['SDK', 'Software Development Kit', 'RoleInsightsInsight', 'BetaRoleInsightsInsight'] +--- + + +# RoleInsightsInsight + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **String** | The number of identities in this role with the entitlement. | [optional] +**IdentitiesWithAccess** | Pointer to **Int32** | The number of identities in this role with the entitlement. | [optional] +**IdentitiesImpacted** | Pointer to **Int32** | The number of identities in this role that do not have the specified entitlement. | [optional] +**TotalNumberOfIdentities** | Pointer to **Int32** | The total number of identities. | [optional] +**ImpactedIdentityNames** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleInsightsInsight = Initialize-PSSailpoint.BetaRoleInsightsInsight -Type ADD ` + -IdentitiesWithAccess 850 ` + -IdentitiesImpacted 150 ` + -TotalNumberOfIdentities 1000 ` + -ImpactedIdentityNames null +``` + +- Convert the resource to JSON +```powershell +$RoleInsightsInsight | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleInsightsResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleInsightsResponse.md new file mode 100644 index 000000000..bc249ed7b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleInsightsResponse.md @@ -0,0 +1,45 @@ +--- +id: beta-role-insights-response +title: RoleInsightsResponse +pagination_label: RoleInsightsResponse +sidebar_label: RoleInsightsResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsightsResponse', 'BetaRoleInsightsResponse'] +slug: /tools/sdk/powershell/beta/models/role-insights-response +tags: ['SDK', 'Software Development Kit', 'RoleInsightsResponse', 'BetaRoleInsightsResponse'] +--- + + +# RoleInsightsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Request Id for a role insight generation request | [optional] +**CreatedDate** | Pointer to **System.DateTime** | The date-time role insights request was created. | [optional] +**LastGenerated** | Pointer to **System.DateTime** | The date-time role insights request was completed. | [optional] +**NumberOfUpdates** | Pointer to **Int32** | Total number of updates for this request. Starts with 0 and will have correct number when request is COMPLETED. | [optional] +**RoleIds** | Pointer to **[]String** | The role IDs that are in this request. | [optional] +**Status** | Pointer to **Enum** [ "CREATED", "IN PROGRESS", "COMPLETED", "FAILED" ] | Request status | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleInsightsResponse = Initialize-PSSailpoint.BetaRoleInsightsResponse -Id 8c190e67-87aa-4ed9-a90b-d9d5344523fb ` + -CreatedDate 2020-09-16T18:49:32.150Z ` + -LastGenerated 2020-09-16T18:50:12.150Z ` + -NumberOfUpdates 0 ` + -RoleIds null ` + -Status null +``` + +- Convert the resource to JSON +```powershell +$RoleInsightsResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleInsightsRole.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleInsightsRole.md new file mode 100644 index 000000000..3b0763211 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleInsightsRole.md @@ -0,0 +1,43 @@ +--- +id: beta-role-insights-role +title: RoleInsightsRole +pagination_label: RoleInsightsRole +sidebar_label: RoleInsightsRole +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsightsRole', 'BetaRoleInsightsRole'] +slug: /tools/sdk/powershell/beta/models/role-insights-role +tags: ['SDK', 'Software Development Kit', 'RoleInsightsRole', 'BetaRoleInsightsRole'] +--- + + +# RoleInsightsRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Role name | [optional] +**Id** | Pointer to **String** | Role id | [optional] +**Description** | Pointer to **String** | Role description | [optional] +**OwnerName** | Pointer to **String** | Role owner name | [optional] +**OwnerId** | Pointer to **String** | Role owner id | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleInsightsRole = Initialize-PSSailpoint.BetaRoleInsightsRole -Name Software Engineer ` + -Id 1467e61e-f284-439c-ba2d-c6cc11cf0941 ` + -Description Person who develops software ` + -OwnerName Bob ` + -OwnerId 1467e61e-f284-439c-ba2d-c6cc11cf0941 +``` + +- Convert the resource to JSON +```powershell +$RoleInsightsRole | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleInsightsSummary.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleInsightsSummary.md new file mode 100644 index 000000000..e4cb5bc50 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleInsightsSummary.md @@ -0,0 +1,45 @@ +--- +id: beta-role-insights-summary +title: RoleInsightsSummary +pagination_label: RoleInsightsSummary +sidebar_label: RoleInsightsSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsightsSummary', 'BetaRoleInsightsSummary'] +slug: /tools/sdk/powershell/beta/models/role-insights-summary +tags: ['SDK', 'Software Development Kit', 'RoleInsightsSummary', 'BetaRoleInsightsSummary'] +--- + + +# RoleInsightsSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NumberOfUpdates** | Pointer to **Int32** | Total number of roles with updates | [optional] +**LastGenerated** | Pointer to **System.DateTime** | The date-time role insights were last found. | [optional] +**EntitlementsIncludedInRoles** | Pointer to **Int32** | The number of entitlements included in roles (vs free radicals). | [optional] +**TotalNumberOfEntitlements** | Pointer to **Int32** | The total number of entitlements. | [optional] +**IdentitiesWithAccessViaRoles** | Pointer to **Int32** | The number of identities in roles vs. identities with just entitlements and not in roles. | [optional] +**TotalNumberOfIdentities** | Pointer to **Int32** | The total number of identities. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleInsightsSummary = Initialize-PSSailpoint.BetaRoleInsightsSummary -NumberOfUpdates null ` + -LastGenerated 2020-05-19T13:49:37.385Z ` + -EntitlementsIncludedInRoles 45 ` + -TotalNumberOfEntitlements 250 ` + -IdentitiesWithAccessViaRoles 550 ` + -TotalNumberOfIdentities 980 +``` + +- Convert the resource to JSON +```powershell +$RoleInsightsSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMatchDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMatchDto.md new file mode 100644 index 000000000..b7c82b1c1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMatchDto.md @@ -0,0 +1,37 @@ +--- +id: beta-role-match-dto +title: RoleMatchDto +pagination_label: RoleMatchDto +sidebar_label: RoleMatchDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMatchDto', 'BetaRoleMatchDto'] +slug: /tools/sdk/powershell/beta/models/role-match-dto +tags: ['SDK', 'Software Development Kit', 'RoleMatchDto', 'BetaRoleMatchDto'] +--- + + +# RoleMatchDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RoleRef** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] +**MatchedAttributes** | Pointer to [**[]ContextAttributeDto**](context-attribute-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMatchDto = Initialize-PSSailpoint.BetaRoleMatchDto -RoleRef null ` + -MatchedAttributes null +``` + +- Convert the resource to JSON +```powershell +$RoleMatchDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMembershipIdentity.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMembershipIdentity.md new file mode 100644 index 000000000..61b7a332c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMembershipIdentity.md @@ -0,0 +1,41 @@ +--- +id: beta-role-membership-identity +title: RoleMembershipIdentity +pagination_label: RoleMembershipIdentity +sidebar_label: RoleMembershipIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMembershipIdentity', 'BetaRoleMembershipIdentity'] +slug: /tools/sdk/powershell/beta/models/role-membership-identity +tags: ['SDK', 'Software Development Kit', 'RoleMembershipIdentity', 'BetaRoleMembershipIdentity'] +--- + + +# RoleMembershipIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **String** | Identity id | [optional] +**Name** | Pointer to **String** | Human-readable display name of the Identity. | [optional] +**AliasName** | Pointer to **String** | User name of the Identity | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMembershipIdentity = Initialize-PSSailpoint.BetaRoleMembershipIdentity -Type null ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Thomas Edison ` + -AliasName t.edison +``` + +- Convert the resource to JSON +```powershell +$RoleMembershipIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMembershipSelector.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMembershipSelector.md new file mode 100644 index 000000000..d9bc315ba --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMembershipSelector.md @@ -0,0 +1,39 @@ +--- +id: beta-role-membership-selector +title: RoleMembershipSelector +pagination_label: RoleMembershipSelector +sidebar_label: RoleMembershipSelector +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMembershipSelector', 'BetaRoleMembershipSelector'] +slug: /tools/sdk/powershell/beta/models/role-membership-selector +tags: ['SDK', 'Software Development Kit', 'RoleMembershipSelector', 'BetaRoleMembershipSelector'] +--- + + +# RoleMembershipSelector + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**RoleMembershipSelectorType**](role-membership-selector-type) | | [optional] +**Criteria** | Pointer to [**RoleCriteriaLevel1**](role-criteria-level1) | | [optional] +**Identities** | Pointer to [**[]RoleMembershipIdentity**](role-membership-identity) | Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMembershipSelector = Initialize-PSSailpoint.BetaRoleMembershipSelector -Type null ` + -Criteria null ` + -Identities null +``` + +- Convert the resource to JSON +```powershell +$RoleMembershipSelector | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMembershipSelectorType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMembershipSelectorType.md new file mode 100644 index 000000000..78a2271fe --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMembershipSelectorType.md @@ -0,0 +1,24 @@ +--- +id: beta-role-membership-selector-type +title: RoleMembershipSelectorType +pagination_label: RoleMembershipSelectorType +sidebar_label: RoleMembershipSelectorType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMembershipSelectorType', 'BetaRoleMembershipSelectorType'] +slug: /tools/sdk/powershell/beta/models/role-membership-selector-type +tags: ['SDK', 'Software Development Kit', 'RoleMembershipSelectorType', 'BetaRoleMembershipSelectorType'] +--- + + +# RoleMembershipSelectorType + +## Enum + + +* `STANDARD` (value: `"STANDARD"`) + +* `IDENTITY_LIST` (value: `"IDENTITY_LIST"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningEntitlement.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningEntitlement.md new file mode 100644 index 000000000..1330908b9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningEntitlement.md @@ -0,0 +1,51 @@ +--- +id: beta-role-mining-entitlement +title: RoleMiningEntitlement +pagination_label: RoleMiningEntitlement +sidebar_label: RoleMiningEntitlement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningEntitlement', 'BetaRoleMiningEntitlement'] +slug: /tools/sdk/powershell/beta/models/role-mining-entitlement +tags: ['SDK', 'Software Development Kit', 'RoleMiningEntitlement', 'BetaRoleMiningEntitlement'] +--- + + +# RoleMiningEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EntitlementRef** | Pointer to [**RoleMiningEntitlementRef**](role-mining-entitlement-ref) | | [optional] +**Name** | Pointer to **String** | Name of the entitlement | [optional] +**ApplicationName** | Pointer to **String** | Application name of the entitlement | [optional] +**IdentityCount** | Pointer to **Int32** | The number of identities with this entitlement in a role. | [optional] +**Popularity** | Pointer to **Double** | The % popularity of this entitlement in a role. | [optional] +**PopularityInOrg** | Pointer to **Double** | The % popularity of this entitlement in the org. | [optional] +**SourceId** | Pointer to **String** | The ID of the source/application. | [optional] +**ActivitySourceState** | Pointer to **String** | The status of activity data for the source. Value is complete or notComplete. | [optional] +**SourceUsagePercent** | Pointer to **Double** | The percentage of identities in the potential role that have usage of the source/application of this entitlement. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningEntitlement = Initialize-PSSailpoint.BetaRoleMiningEntitlement -EntitlementRef null ` + -Name Add/modify/delete users ` + -ApplicationName AppName ` + -IdentityCount 45 ` + -Popularity 65.2 ` + -PopularityInOrg 35.8 ` + -SourceId 2c9180877620c1460176267f336a106f ` + -ActivitySourceState complete ` + -SourceUsagePercent 65.6 +``` + +- Convert the resource to JSON +```powershell +$RoleMiningEntitlement | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningEntitlementRef.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningEntitlementRef.md new file mode 100644 index 000000000..a8ae895c7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningEntitlementRef.md @@ -0,0 +1,41 @@ +--- +id: beta-role-mining-entitlement-ref +title: RoleMiningEntitlementRef +pagination_label: RoleMiningEntitlementRef +sidebar_label: RoleMiningEntitlementRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningEntitlementRef', 'BetaRoleMiningEntitlementRef'] +slug: /tools/sdk/powershell/beta/models/role-mining-entitlement-ref +tags: ['SDK', 'Software Development Kit', 'RoleMiningEntitlementRef', 'BetaRoleMiningEntitlementRef'] +--- + + +# RoleMiningEntitlementRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the entitlement | [optional] +**Name** | Pointer to **String** | Name of the entitlement | [optional] +**Description** | Pointer to **String** | Description forthe entitlement | [optional] +**Attribute** | Pointer to **String** | The entitlement attribute | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningEntitlementRef = Initialize-PSSailpoint.BetaRoleMiningEntitlementRef -Id 2c91808a7e95e6e0017e96e2086206c8 ` + -Name App.entitlement.1 ` + -Description Entitlement 1 ` + -Attribute groups +``` + +- Convert the resource to JSON +```powershell +$RoleMiningEntitlementRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningIdentity.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningIdentity.md new file mode 100644 index 000000000..27edbbd41 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningIdentity.md @@ -0,0 +1,39 @@ +--- +id: beta-role-mining-identity +title: RoleMiningIdentity +pagination_label: RoleMiningIdentity +sidebar_label: RoleMiningIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningIdentity', 'BetaRoleMiningIdentity'] +slug: /tools/sdk/powershell/beta/models/role-mining-identity +tags: ['SDK', 'Software Development Kit', 'RoleMiningIdentity', 'BetaRoleMiningIdentity'] +--- + + +# RoleMiningIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the identity | [optional] +**Name** | Pointer to **String** | Name of the identity | [optional] +**Attributes** | Pointer to **map[string]String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningIdentity = Initialize-PSSailpoint.BetaRoleMiningIdentity -Id null ` + -Name null ` + -Attributes null +``` + +- Convert the resource to JSON +```powershell +$RoleMiningIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningIdentityDistribution.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningIdentityDistribution.md new file mode 100644 index 000000000..895b8eb18 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningIdentityDistribution.md @@ -0,0 +1,37 @@ +--- +id: beta-role-mining-identity-distribution +title: RoleMiningIdentityDistribution +pagination_label: RoleMiningIdentityDistribution +sidebar_label: RoleMiningIdentityDistribution +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningIdentityDistribution', 'BetaRoleMiningIdentityDistribution'] +slug: /tools/sdk/powershell/beta/models/role-mining-identity-distribution +tags: ['SDK', 'Software Development Kit', 'RoleMiningIdentityDistribution', 'BetaRoleMiningIdentityDistribution'] +--- + + +# RoleMiningIdentityDistribution + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AttributeName** | Pointer to **String** | Id of the potential role | [optional] +**Distribution** | Pointer to **[]System.Collections.Hashtable** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningIdentityDistribution = Initialize-PSSailpoint.BetaRoleMiningIdentityDistribution -AttributeName department ` + -Distribution [{attributeValue=NM Tier 3, count=6}] +``` + +- Convert the resource to JSON +```powershell +$RoleMiningIdentityDistribution | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRole.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRole.md new file mode 100644 index 000000000..5f42f888a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRole.md @@ -0,0 +1,71 @@ +--- +id: beta-role-mining-potential-role +title: RoleMiningPotentialRole +pagination_label: RoleMiningPotentialRole +sidebar_label: RoleMiningPotentialRole +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRole', 'BetaRoleMiningPotentialRole'] +slug: /tools/sdk/powershell/beta/models/role-mining-potential-role +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRole', 'BetaRoleMiningPotentialRole'] +--- + + +# RoleMiningPotentialRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreatedBy** | Pointer to [**RoleMiningSessionResponseCreatedBy**](role-mining-session-response-created-by) | | [optional] +**Density** | Pointer to **Int32** | The density of a potential role. | [optional] +**Description** | Pointer to **String** | The description of a potential role. | [optional] +**EntitlementCount** | Pointer to **Int32** | The number of entitlements in a potential role. | [optional] +**ExcludedEntitlements** | Pointer to **[]String** | The list of entitlement ids to be excluded. | [optional] +**Freshness** | Pointer to **Int32** | The freshness of a potential role. | [optional] +**IdentityCount** | Pointer to **Int32** | The number of identities in a potential role. | [optional] +**IdentityDistribution** | Pointer to [**[]RoleMiningIdentityDistribution**](role-mining-identity-distribution) | Identity attribute distribution. | [optional] +**IdentityIds** | Pointer to **[]String** | The list of ids in a potential role. | [optional] +**Name** | Pointer to **String** | Name of the potential role. | [optional] +**ProvisionState** | Pointer to [**RoleMiningPotentialRoleProvisionState**](role-mining-potential-role-provision-state) | | [optional] +**Quality** | Pointer to **Int32** | The quality of a potential role. | [optional] +**RoleId** | Pointer to **String** | The roleId of a potential role. | [optional] +**Saved** | Pointer to **Boolean** | The potential role's saved status. | [optional] +**Session** | Pointer to [**RoleMiningSessionParametersDto**](role-mining-session-parameters-dto) | | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**Id** | Pointer to **String** | Id of the potential role | [optional] +**CreatedDate** | Pointer to **System.DateTime** | The date-time when this potential role was created. | [optional] +**ModifiedDate** | Pointer to **System.DateTime** | The date-time when this potential role was modified. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningPotentialRole = Initialize-PSSailpoint.BetaRoleMiningPotentialRole -CreatedBy null ` + -Density 75 ` + -Description Potential Role for Accounting dept ` + -EntitlementCount 25 ` + -ExcludedEntitlements [07a0b4e2, 13b4e2a0] ` + -Freshness 75 ` + -IdentityCount 25 ` + -IdentityDistribution null ` + -IdentityIds [07a0b4e2, 13b4e2a0] ` + -Name Saved Potential Role - 07/10 ` + -ProvisionState null ` + -Quality 100 ` + -RoleId 07a0b4e2-7a76-44fa-bd0b-c64654b66519 ` + -Saved true ` + -Session null ` + -Type null ` + -Id e0cc5d7d-bf7f-4f81-b2af-8885b09d9923 ` + -CreatedDate null ` + -ModifiedDate null +``` + +- Convert the resource to JSON +```powershell +$RoleMiningPotentialRole | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleApplication.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleApplication.md new file mode 100644 index 000000000..392aa4ff0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleApplication.md @@ -0,0 +1,37 @@ +--- +id: beta-role-mining-potential-role-application +title: RoleMiningPotentialRoleApplication +pagination_label: RoleMiningPotentialRoleApplication +sidebar_label: RoleMiningPotentialRoleApplication +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleApplication', 'BetaRoleMiningPotentialRoleApplication'] +slug: /tools/sdk/powershell/beta/models/role-mining-potential-role-application +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleApplication', 'BetaRoleMiningPotentialRoleApplication'] +--- + + +# RoleMiningPotentialRoleApplication + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the application | [optional] +**Name** | Pointer to **String** | Name of the application | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningPotentialRoleApplication = Initialize-PSSailpoint.BetaRoleMiningPotentialRoleApplication -Id {id=2c9180877212632a017228d5a796292b} ` + -Name {name=Slack} +``` + +- Convert the resource to JSON +```powershell +$RoleMiningPotentialRoleApplication | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleEditEntitlements.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleEditEntitlements.md new file mode 100644 index 000000000..3b66d91ec --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleEditEntitlements.md @@ -0,0 +1,37 @@ +--- +id: beta-role-mining-potential-role-edit-entitlements +title: RoleMiningPotentialRoleEditEntitlements +pagination_label: RoleMiningPotentialRoleEditEntitlements +sidebar_label: RoleMiningPotentialRoleEditEntitlements +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleEditEntitlements', 'BetaRoleMiningPotentialRoleEditEntitlements'] +slug: /tools/sdk/powershell/beta/models/role-mining-potential-role-edit-entitlements +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleEditEntitlements', 'BetaRoleMiningPotentialRoleEditEntitlements'] +--- + + +# RoleMiningPotentialRoleEditEntitlements + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]String** | The list of entitlement ids to be edited | [optional] +**Exclude** | Pointer to **Boolean** | If true, add ids to be exclusion list. If false, remove ids from the exclusion list. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningPotentialRoleEditEntitlements = Initialize-PSSailpoint.BetaRoleMiningPotentialRoleEditEntitlements -Ids null ` + -Exclude null +``` + +- Convert the resource to JSON +```powershell +$RoleMiningPotentialRoleEditEntitlements | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleEntitlements.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleEntitlements.md new file mode 100644 index 000000000..1111c909e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleEntitlements.md @@ -0,0 +1,37 @@ +--- +id: beta-role-mining-potential-role-entitlements +title: RoleMiningPotentialRoleEntitlements +pagination_label: RoleMiningPotentialRoleEntitlements +sidebar_label: RoleMiningPotentialRoleEntitlements +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleEntitlements', 'BetaRoleMiningPotentialRoleEntitlements'] +slug: /tools/sdk/powershell/beta/models/role-mining-potential-role-entitlements +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleEntitlements', 'BetaRoleMiningPotentialRoleEntitlements'] +--- + + +# RoleMiningPotentialRoleEntitlements + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the entitlement | [optional] +**Name** | Pointer to **String** | Name of the entitlement | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningPotentialRoleEntitlements = Initialize-PSSailpoint.BetaRoleMiningPotentialRoleEntitlements -Id {id=2c9180877212632a017228d5a796292c} ` + -Name {name=LauncherTest2} +``` + +- Convert the resource to JSON +```powershell +$RoleMiningPotentialRoleEntitlements | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleExportRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleExportRequest.md new file mode 100644 index 000000000..dac189b88 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleExportRequest.md @@ -0,0 +1,37 @@ +--- +id: beta-role-mining-potential-role-export-request +title: RoleMiningPotentialRoleExportRequest +pagination_label: RoleMiningPotentialRoleExportRequest +sidebar_label: RoleMiningPotentialRoleExportRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleExportRequest', 'BetaRoleMiningPotentialRoleExportRequest'] +slug: /tools/sdk/powershell/beta/models/role-mining-potential-role-export-request +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleExportRequest', 'BetaRoleMiningPotentialRoleExportRequest'] +--- + + +# RoleMiningPotentialRoleExportRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MinEntitlementPopularity** | Pointer to **Int32** | The minimum popularity among identities in the role which an entitlement must have to be included in the report | [optional] +**IncludeCommonAccess** | Pointer to **Boolean** | If false, do not include entitlements that are highly popular among the entire orginization | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningPotentialRoleExportRequest = Initialize-PSSailpoint.BetaRoleMiningPotentialRoleExportRequest -MinEntitlementPopularity 0 ` + -IncludeCommonAccess true +``` + +- Convert the resource to JSON +```powershell +$RoleMiningPotentialRoleExportRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleExportResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleExportResponse.md new file mode 100644 index 000000000..880d06977 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleExportResponse.md @@ -0,0 +1,41 @@ +--- +id: beta-role-mining-potential-role-export-response +title: RoleMiningPotentialRoleExportResponse +pagination_label: RoleMiningPotentialRoleExportResponse +sidebar_label: RoleMiningPotentialRoleExportResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleExportResponse', 'BetaRoleMiningPotentialRoleExportResponse'] +slug: /tools/sdk/powershell/beta/models/role-mining-potential-role-export-response +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleExportResponse', 'BetaRoleMiningPotentialRoleExportResponse'] +--- + + +# RoleMiningPotentialRoleExportResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MinEntitlementPopularity** | Pointer to **Int32** | The minimum popularity among identities in the role which an entitlement must have to be included in the report | [optional] +**IncludeCommonAccess** | Pointer to **Boolean** | If false, do not include entitlements that are highly popular among the entire orginization | [optional] +**ExportId** | Pointer to **String** | ID used to reference this export | [optional] +**Status** | Pointer to [**RoleMiningPotentialRoleExportState**](role-mining-potential-role-export-state) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningPotentialRoleExportResponse = Initialize-PSSailpoint.BetaRoleMiningPotentialRoleExportResponse -MinEntitlementPopularity 0 ` + -IncludeCommonAccess true ` + -ExportId 0c6cdb76-1227-4aaf-af21-192dbdfbfa04 ` + -Status null +``` + +- Convert the resource to JSON +```powershell +$RoleMiningPotentialRoleExportResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleExportState.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleExportState.md new file mode 100644 index 000000000..db4e7abea --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleExportState.md @@ -0,0 +1,28 @@ +--- +id: beta-role-mining-potential-role-export-state +title: RoleMiningPotentialRoleExportState +pagination_label: RoleMiningPotentialRoleExportState +sidebar_label: RoleMiningPotentialRoleExportState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleExportState', 'BetaRoleMiningPotentialRoleExportState'] +slug: /tools/sdk/powershell/beta/models/role-mining-potential-role-export-state +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleExportState', 'BetaRoleMiningPotentialRoleExportState'] +--- + + +# RoleMiningPotentialRoleExportState + +## Enum + + +* `QUEUED` (value: `"QUEUED"`) + +* `IN_PROGRESS` (value: `"IN_PROGRESS"`) + +* `SUCCESS` (value: `"SUCCESS"`) + +* `ERROR` (value: `"ERROR"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleProvisionRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleProvisionRequest.md new file mode 100644 index 000000000..e88c4a4e9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleProvisionRequest.md @@ -0,0 +1,43 @@ +--- +id: beta-role-mining-potential-role-provision-request +title: RoleMiningPotentialRoleProvisionRequest +pagination_label: RoleMiningPotentialRoleProvisionRequest +sidebar_label: RoleMiningPotentialRoleProvisionRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleProvisionRequest', 'BetaRoleMiningPotentialRoleProvisionRequest'] +slug: /tools/sdk/powershell/beta/models/role-mining-potential-role-provision-request +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleProvisionRequest', 'BetaRoleMiningPotentialRoleProvisionRequest'] +--- + + +# RoleMiningPotentialRoleProvisionRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RoleName** | Pointer to **String** | Name of the new role being created | [optional] +**RoleDescription** | Pointer to **String** | Short description of the new role being created | [optional] +**OwnerId** | Pointer to **String** | ID of the identity that will own this role | [optional] +**IncludeIdentities** | Pointer to **Boolean** | When true, create access requests for the identities associated with the potential role | [optional] [default to $false] +**DirectlyAssignedEntitlements** | Pointer to **Boolean** | When true, assign entitlements directly to the role; otherwise, create access profiles containing the entitlements | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningPotentialRoleProvisionRequest = Initialize-PSSailpoint.BetaRoleMiningPotentialRoleProvisionRequest -RoleName Finance - Accounting ` + -RoleDescription General access for accounting department ` + -OwnerId 2b568c65bc3c4c57a43bd97e3a8e41 ` + -IncludeIdentities true ` + -DirectlyAssignedEntitlements false +``` + +- Convert the resource to JSON +```powershell +$RoleMiningPotentialRoleProvisionRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleProvisionState.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleProvisionState.md new file mode 100644 index 000000000..e3398485a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleProvisionState.md @@ -0,0 +1,28 @@ +--- +id: beta-role-mining-potential-role-provision-state +title: RoleMiningPotentialRoleProvisionState +pagination_label: RoleMiningPotentialRoleProvisionState +sidebar_label: RoleMiningPotentialRoleProvisionState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleProvisionState', 'BetaRoleMiningPotentialRoleProvisionState'] +slug: /tools/sdk/powershell/beta/models/role-mining-potential-role-provision-state +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleProvisionState', 'BetaRoleMiningPotentialRoleProvisionState'] +--- + + +# RoleMiningPotentialRoleProvisionState + +## Enum + + +* `POTENTIAL` (value: `"POTENTIAL"`) + +* `PENDING` (value: `"PENDING"`) + +* `COMPLETE` (value: `"COMPLETE"`) + +* `FAILED` (value: `"FAILED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleRef.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleRef.md new file mode 100644 index 000000000..b23ce0f42 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleRef.md @@ -0,0 +1,37 @@ +--- +id: beta-role-mining-potential-role-ref +title: RoleMiningPotentialRoleRef +pagination_label: RoleMiningPotentialRoleRef +sidebar_label: RoleMiningPotentialRoleRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleRef', 'BetaRoleMiningPotentialRoleRef'] +slug: /tools/sdk/powershell/beta/models/role-mining-potential-role-ref +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleRef', 'BetaRoleMiningPotentialRoleRef'] +--- + + +# RoleMiningPotentialRoleRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the potential role | [optional] +**Name** | Pointer to **String** | Name of the potential role | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningPotentialRoleRef = Initialize-PSSailpoint.BetaRoleMiningPotentialRoleRef -Id e0cc5d7d-bf7f-4f81-b2af-8885b09d9923 ` + -Name Potential Role - e0cc5d +``` + +- Convert the resource to JSON +```powershell +$RoleMiningPotentialRoleRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleSourceUsage.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleSourceUsage.md new file mode 100644 index 000000000..a8f25eb67 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleSourceUsage.md @@ -0,0 +1,41 @@ +--- +id: beta-role-mining-potential-role-source-usage +title: RoleMiningPotentialRoleSourceUsage +pagination_label: RoleMiningPotentialRoleSourceUsage +sidebar_label: RoleMiningPotentialRoleSourceUsage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleSourceUsage', 'BetaRoleMiningPotentialRoleSourceUsage'] +slug: /tools/sdk/powershell/beta/models/role-mining-potential-role-source-usage +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSourceUsage', 'BetaRoleMiningPotentialRoleSourceUsage'] +--- + + +# RoleMiningPotentialRoleSourceUsage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The identity ID | [optional] +**DisplayName** | Pointer to **String** | Display name for the identity | [optional] +**Email** | Pointer to **String** | Email address for the identity | [optional] +**UsageCount** | Pointer to **Int32** | The number of days there has been usage of the source by the identity. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningPotentialRoleSourceUsage = Initialize-PSSailpoint.BetaRoleMiningPotentialRoleSourceUsage -Id 2c918089762475180176267f894b54dc ` + -DisplayName Kirk Koepp ` + -Email kirk.koepp@testmail.identitynow.com ` + -UsageCount 25 +``` + +- Convert the resource to JSON +```powershell +$RoleMiningPotentialRoleSourceUsage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleSummary.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleSummary.md new file mode 100644 index 000000000..5d612a4cd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleSummary.md @@ -0,0 +1,67 @@ +--- +id: beta-role-mining-potential-role-summary +title: RoleMiningPotentialRoleSummary +pagination_label: RoleMiningPotentialRoleSummary +sidebar_label: RoleMiningPotentialRoleSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleSummary', 'BetaRoleMiningPotentialRoleSummary'] +slug: /tools/sdk/powershell/beta/models/role-mining-potential-role-summary +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSummary', 'BetaRoleMiningPotentialRoleSummary'] +--- + + +# RoleMiningPotentialRoleSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the potential role | [optional] +**Name** | Pointer to **String** | Name of the potential role | [optional] +**PotentialRoleRef** | Pointer to [**RoleMiningPotentialRoleRef**](role-mining-potential-role-ref) | | [optional] +**IdentityCount** | Pointer to **Int32** | The number of identities in a potential role. | [optional] +**EntitlementCount** | Pointer to **Int32** | The number of entitlements in a potential role. | [optional] +**IdentityGroupStatus** | Pointer to **String** | The status for this identity group which can be ""REQUESTED"" or ""OBTAINED"" | [optional] +**ProvisionState** | Pointer to [**RoleMiningPotentialRoleProvisionState**](role-mining-potential-role-provision-state) | | [optional] +**RoleId** | Pointer to **String** | ID of the provisioned role in IIQ or IDN. Null if this potential role has not been provisioned. | [optional] +**Density** | Pointer to **Int32** | The density metric (0-100) of this potential role. Higher density values indicate higher similarity amongst the identities. | [optional] +**Freshness** | Pointer to **Int32** | The freshness metric (0-100) of this potential role. Higher freshness values indicate this potential role is more distinctive compared to existing roles. | [optional] +**Quality** | Pointer to **Int32** | The quality metric (0-100) of this potential role. Higher quality values indicate this potential role has high density and freshness. | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**CreatedBy** | Pointer to [**RoleMiningPotentialRoleSummaryCreatedBy**](role-mining-potential-role-summary-created-by) | | [optional] +**CreatedDate** | Pointer to **System.DateTime** | The date-time when this potential role was created. | [optional] +**Saved** | Pointer to **Boolean** | The potential role's saved status | [optional] [default to $false] +**Description** | Pointer to **String** | Description of the potential role | [optional] +**Session** | Pointer to [**RoleMiningSessionParametersDto**](role-mining-session-parameters-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningPotentialRoleSummary = Initialize-PSSailpoint.BetaRoleMiningPotentialRoleSummary -Id e0cc5d7d-bf7f-4f81-b2af-8885b09d9923 ` + -Name Potential Role - e0cc5d ` + -PotentialRoleRef null ` + -IdentityCount 25 ` + -EntitlementCount 15 ` + -IdentityGroupStatus OBTAINED ` + -ProvisionState null ` + -RoleId 2a4be6fbcf3c4e66b95a0c15ffd591 ` + -Density 90 ` + -Freshness 70 ` + -Quality 80 ` + -Type null ` + -CreatedBy null ` + -CreatedDate null ` + -Saved true ` + -Description null ` + -Session null +``` + +- Convert the resource to JSON +```powershell +$RoleMiningPotentialRoleSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleSummaryCreatedBy.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleSummaryCreatedBy.md new file mode 100644 index 000000000..3201461e0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningPotentialRoleSummaryCreatedBy.md @@ -0,0 +1,37 @@ +--- +id: beta-role-mining-potential-role-summary-created-by +title: RoleMiningPotentialRoleSummaryCreatedBy +pagination_label: RoleMiningPotentialRoleSummaryCreatedBy +sidebar_label: RoleMiningPotentialRoleSummaryCreatedBy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleSummaryCreatedBy', 'BetaRoleMiningPotentialRoleSummaryCreatedBy'] +slug: /tools/sdk/powershell/beta/models/role-mining-potential-role-summary-created-by +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSummaryCreatedBy', 'BetaRoleMiningPotentialRoleSummaryCreatedBy'] +--- + + +# RoleMiningPotentialRoleSummaryCreatedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the creator | [optional] +**DisplayName** | Pointer to **String** | The display name of the creator | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningPotentialRoleSummaryCreatedBy = Initialize-PSSailpoint.BetaRoleMiningPotentialRoleSummaryCreatedBy -Id 2c918090761a5aac0176215c46a62d58 ` + -DisplayName Ashley.Pierce +``` + +- Convert the resource to JSON +```powershell +$RoleMiningPotentialRoleSummaryCreatedBy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningRoleType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningRoleType.md new file mode 100644 index 000000000..8192dd606 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningRoleType.md @@ -0,0 +1,24 @@ +--- +id: beta-role-mining-role-type +title: RoleMiningRoleType +pagination_label: RoleMiningRoleType +sidebar_label: RoleMiningRoleType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningRoleType', 'BetaRoleMiningRoleType'] +slug: /tools/sdk/powershell/beta/models/role-mining-role-type +tags: ['SDK', 'Software Development Kit', 'RoleMiningRoleType', 'BetaRoleMiningRoleType'] +--- + + +# RoleMiningRoleType + +## Enum + + +* `SPECIALIZED` (value: `"SPECIALIZED"`) + +* `COMMON` (value: `"COMMON"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionDraftRoleDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionDraftRoleDto.md new file mode 100644 index 000000000..c0cd0632e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionDraftRoleDto.md @@ -0,0 +1,53 @@ +--- +id: beta-role-mining-session-draft-role-dto +title: RoleMiningSessionDraftRoleDto +pagination_label: RoleMiningSessionDraftRoleDto +sidebar_label: RoleMiningSessionDraftRoleDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionDraftRoleDto', 'BetaRoleMiningSessionDraftRoleDto'] +slug: /tools/sdk/powershell/beta/models/role-mining-session-draft-role-dto +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionDraftRoleDto', 'BetaRoleMiningSessionDraftRoleDto'] +--- + + +# RoleMiningSessionDraftRoleDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Name of the draft role | [optional] +**Description** | Pointer to **String** | Draft role description | [optional] +**IdentityIds** | Pointer to **[]String** | The list of identities for this role mining session. | [optional] +**EntitlementIds** | Pointer to **[]String** | The list of entitlement ids for this role mining session. | [optional] +**ExcludedEntitlements** | Pointer to **[]String** | The list of excluded entitlement ids. | [optional] +**Modified** | Pointer to **System.DateTime** | Last modified date | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**Id** | Pointer to **String** | Id of the potential draft role | [optional] +**CreatedDate** | Pointer to **System.DateTime** | The date-time when this potential draft role was created. | [optional] +**ModifiedDate** | Pointer to **System.DateTime** | The date-time when this potential draft role was modified. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningSessionDraftRoleDto = Initialize-PSSailpoint.BetaRoleMiningSessionDraftRoleDto -Name Saved RM Session - 07/10 ` + -Description Person who develops software ` + -IdentityIds [2c918090761a5aac0176215c46a62d58, 2c918090761a5aac01722015c46a62d42] ` + -EntitlementIds [2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e] ` + -ExcludedEntitlements [07a0b4e2, 13b4e2a0] ` + -Modified 2020-09-16T18:49:32.150Z ` + -Type null ` + -Id e0cc5d7d-bf7f-4f81-b2af-8885b09d9923 ` + -CreatedDate null ` + -ModifiedDate null +``` + +- Convert the resource to JSON +```powershell +$RoleMiningSessionDraftRoleDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionDto.md new file mode 100644 index 000000000..04da52653 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionDto.md @@ -0,0 +1,55 @@ +--- +id: beta-role-mining-session-dto +title: RoleMiningSessionDto +pagination_label: RoleMiningSessionDto +sidebar_label: RoleMiningSessionDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionDto', 'BetaRoleMiningSessionDto'] +slug: /tools/sdk/powershell/beta/models/role-mining-session-dto +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionDto', 'BetaRoleMiningSessionDto'] +--- + + +# RoleMiningSessionDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Scope** | Pointer to [**RoleMiningSessionScope**](role-mining-session-scope) | | [optional] +**PruneThreshold** | Pointer to **Int32** | The prune threshold to be used or null to calculate prescribedPruneThreshold | [optional] +**PrescribedPruneThreshold** | Pointer to **Int32** | The calculated prescribedPruneThreshold | [optional] +**MinNumIdentitiesInPotentialRole** | Pointer to **Int32** | Minimum number of identities in a potential role | [optional] +**PotentialRoleCount** | Pointer to **Int32** | Number of potential roles | [optional] +**PotentialRolesReadyCount** | Pointer to **Int32** | Number of potential roles ready | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**EmailRecipientId** | Pointer to **String** | The id of the user who will receive an email about the role mining session | [optional] +**IdentityCount** | Pointer to **Int32** | Number of identities in the population which meet the search criteria or identity list provided | [optional] +**Saved** | Pointer to **Boolean** | The session's saved status | [optional] [default to $false] +**Name** | Pointer to **String** | The session's saved name | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningSessionDto = Initialize-PSSailpoint.BetaRoleMiningSessionDto -Scope null ` + -PruneThreshold 50 ` + -PrescribedPruneThreshold 10 ` + -MinNumIdentitiesInPotentialRole 20 ` + -PotentialRoleCount 0 ` + -PotentialRolesReadyCount 0 ` + -Type null ` + -EmailRecipientId 2c918090761a5aac0176215c46a62d58 ` + -IdentityCount 0 ` + -Saved true ` + -Name Saved RM Session - 07/10 +``` + +- Convert the resource to JSON +```powershell +$RoleMiningSessionDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionParametersDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionParametersDto.md new file mode 100644 index 000000000..1bd886591 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionParametersDto.md @@ -0,0 +1,51 @@ +--- +id: beta-role-mining-session-parameters-dto +title: RoleMiningSessionParametersDto +pagination_label: RoleMiningSessionParametersDto +sidebar_label: RoleMiningSessionParametersDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionParametersDto', 'BetaRoleMiningSessionParametersDto'] +slug: /tools/sdk/powershell/beta/models/role-mining-session-parameters-dto +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionParametersDto', 'BetaRoleMiningSessionParametersDto'] +--- + + +# RoleMiningSessionParametersDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of the role mining session | [optional] +**Name** | Pointer to **String** | The session's saved name | [optional] +**MinNumIdentitiesInPotentialRole** | Pointer to **Int32** | Minimum number of identities in a potential role | [optional] +**PruneThreshold** | Pointer to **Int32** | The prune threshold to be used or null to calculate prescribedPruneThreshold | [optional] +**Saved** | Pointer to **Boolean** | The session's saved status | [optional] [default to $true] +**Scope** | Pointer to [**RoleMiningSessionScope**](role-mining-session-scope) | | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**State** | Pointer to [**RoleMiningSessionState**](role-mining-session-state) | | [optional] +**ScopingMethod** | Pointer to [**RoleMiningSessionScopingMethod**](role-mining-session-scoping-method) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningSessionParametersDto = Initialize-PSSailpoint.BetaRoleMiningSessionParametersDto -Id 9f36f5e5-1e81-4eca-b087-548959d91c71 ` + -Name Saved RM Session - 07/10 ` + -MinNumIdentitiesInPotentialRole 20 ` + -PruneThreshold 5 ` + -Saved true ` + -Scope null ` + -Type null ` + -State null ` + -ScopingMethod null +``` + +- Convert the resource to JSON +```powershell +$RoleMiningSessionParametersDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionResponse.md new file mode 100644 index 000000000..c9cfe32f3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionResponse.md @@ -0,0 +1,69 @@ +--- +id: beta-role-mining-session-response +title: RoleMiningSessionResponse +pagination_label: RoleMiningSessionResponse +sidebar_label: RoleMiningSessionResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionResponse', 'BetaRoleMiningSessionResponse'] +slug: /tools/sdk/powershell/beta/models/role-mining-session-response +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionResponse', 'BetaRoleMiningSessionResponse'] +--- + + +# RoleMiningSessionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Scope** | Pointer to [**RoleMiningSessionScope**](role-mining-session-scope) | | [optional] +**MinNumIdentitiesInPotentialRole** | Pointer to **Int32** | Minimum number of identities in a potential role | [optional] +**ScopingMethod** | Pointer to **String** | The scoping method of the role mining session | [optional] +**PrescribedPruneThreshold** | Pointer to **Int32** | The computed (or prescribed) prune threshold for this session | [optional] +**PruneThreshold** | Pointer to **Int32** | The prune threshold to be used for this role mining session | [optional] +**PotentialRoleCount** | Pointer to **Int32** | The number of potential roles | [optional] +**PotentialRolesReadyCount** | Pointer to **Int32** | The number of potential roles which have completed processing | [optional] +**Status** | Pointer to [**RoleMiningSessionStatus**](role-mining-session-status) | | [optional] +**EmailRecipientId** | Pointer to **String** | The id of the user who will receive an email about the role mining session | [optional] +**CreatedBy** | Pointer to [**RoleMiningSessionResponseCreatedBy**](role-mining-session-response-created-by) | | [optional] +**IdentityCount** | Pointer to **Int32** | The number of identities | [optional] +**Saved** | Pointer to **Boolean** | The session's saved status | [optional] [default to $false] +**Name** | Pointer to **String** | The session's saved name | [optional] +**DataFilePath** | Pointer to **String** | The data file path of the role mining session | [optional] +**Id** | Pointer to **String** | Session Id for this role mining session | [optional] +**CreatedDate** | Pointer to **System.DateTime** | The date-time when this role mining session was created. | [optional] +**ModifiedDate** | Pointer to **System.DateTime** | The date-time when this role mining session was completed. | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningSessionResponse = Initialize-PSSailpoint.BetaRoleMiningSessionResponse -Scope null ` + -MinNumIdentitiesInPotentialRole 20 ` + -ScopingMethod AUTO_RM ` + -PrescribedPruneThreshold 83 ` + -PruneThreshold 70 ` + -PotentialRoleCount 8 ` + -PotentialRolesReadyCount 4 ` + -Status null ` + -EmailRecipientId null ` + -CreatedBy null ` + -IdentityCount 39 ` + -Saved true ` + -Name Saved RM Session - 07/10 ` + -DataFilePath null ` + -Id 8c190e67-87aa-4ed9-a90b-d9d5344523fb ` + -CreatedDate null ` + -ModifiedDate null ` + -Type null +``` + +- Convert the resource to JSON +```powershell +$RoleMiningSessionResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionResponseCreatedBy.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionResponseCreatedBy.md new file mode 100644 index 000000000..dc65c538a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionResponseCreatedBy.md @@ -0,0 +1,37 @@ +--- +id: beta-role-mining-session-response-created-by +title: RoleMiningSessionResponseCreatedBy +pagination_label: RoleMiningSessionResponseCreatedBy +sidebar_label: RoleMiningSessionResponseCreatedBy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionResponseCreatedBy', 'BetaRoleMiningSessionResponseCreatedBy'] +slug: /tools/sdk/powershell/beta/models/role-mining-session-response-created-by +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionResponseCreatedBy', 'BetaRoleMiningSessionResponseCreatedBy'] +--- + + +# RoleMiningSessionResponseCreatedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the creator | [optional] +**DisplayName** | Pointer to **String** | The display name of the creator | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningSessionResponseCreatedBy = Initialize-PSSailpoint.BetaRoleMiningSessionResponseCreatedBy -Id 2c918090761a5aac0176215c46a62d58 ` + -DisplayName Ashley.Pierce +``` + +- Convert the resource to JSON +```powershell +$RoleMiningSessionResponseCreatedBy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionScope.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionScope.md new file mode 100644 index 000000000..c86bb472e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionScope.md @@ -0,0 +1,39 @@ +--- +id: beta-role-mining-session-scope +title: RoleMiningSessionScope +pagination_label: RoleMiningSessionScope +sidebar_label: RoleMiningSessionScope +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionScope', 'BetaRoleMiningSessionScope'] +slug: /tools/sdk/powershell/beta/models/role-mining-session-scope +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionScope', 'BetaRoleMiningSessionScope'] +--- + + +# RoleMiningSessionScope + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityIds** | Pointer to **[]String** | The list of identities for this role mining session. | [optional] +**Criteria** | Pointer to **String** | The ""search"" criteria that produces the list of identities for this role mining session. | [optional] +**AttributeFilterCriteria** | Pointer to [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The filter criteria for this role mining session. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningSessionScope = Initialize-PSSailpoint.BetaRoleMiningSessionScope -IdentityIds [2c918090761a5aac0176215c46a62d58, 2c918090761a5aac01722015c46a62d42] ` + -Criteria source.name:DataScienceDataset ` + -AttributeFilterCriteria {displayName={untranslated=Location: Miami}, ariaLabel={untranslated=Location: Miami}, data={displayName={translateKey=IDN.IDENTITY_ATTRIBUTES.LOCATION}, name=location, operator=EQUALS, values=[Miami]}} +``` + +- Convert the resource to JSON +```powershell +$RoleMiningSessionScope | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionScopingMethod.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionScopingMethod.md new file mode 100644 index 000000000..9f523be11 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionScopingMethod.md @@ -0,0 +1,24 @@ +--- +id: beta-role-mining-session-scoping-method +title: RoleMiningSessionScopingMethod +pagination_label: RoleMiningSessionScopingMethod +sidebar_label: RoleMiningSessionScopingMethod +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionScopingMethod', 'BetaRoleMiningSessionScopingMethod'] +slug: /tools/sdk/powershell/beta/models/role-mining-session-scoping-method +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionScopingMethod', 'BetaRoleMiningSessionScopingMethod'] +--- + + +# RoleMiningSessionScopingMethod + +## Enum + + +* `MANUAL` (value: `"MANUAL"`) + +* `AUTO_RM` (value: `"AUTO_RM"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionState.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionState.md new file mode 100644 index 000000000..1bccceb83 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionState.md @@ -0,0 +1,32 @@ +--- +id: beta-role-mining-session-state +title: RoleMiningSessionState +pagination_label: RoleMiningSessionState +sidebar_label: RoleMiningSessionState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionState', 'BetaRoleMiningSessionState'] +slug: /tools/sdk/powershell/beta/models/role-mining-session-state +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionState', 'BetaRoleMiningSessionState'] +--- + + +# RoleMiningSessionState + +## Enum + + +* `CREATED` (value: `"CREATED"`) + +* `UPDATED` (value: `"UPDATED"`) + +* `IDENTITIES_OBTAINED` (value: `"IDENTITIES_OBTAINED"`) + +* `PRUNE_THRESHOLD_OBTAINED` (value: `"PRUNE_THRESHOLD_OBTAINED"`) + +* `POTENTIAL_ROLES_PROCESSING` (value: `"POTENTIAL_ROLES_PROCESSING"`) + +* `POTENTIAL_ROLES_CREATED` (value: `"POTENTIAL_ROLES_CREATED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionStatus.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionStatus.md new file mode 100644 index 000000000..c9ced98a7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleMiningSessionStatus.md @@ -0,0 +1,35 @@ +--- +id: beta-role-mining-session-status +title: RoleMiningSessionStatus +pagination_label: RoleMiningSessionStatus +sidebar_label: RoleMiningSessionStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionStatus', 'BetaRoleMiningSessionStatus'] +slug: /tools/sdk/powershell/beta/models/role-mining-session-status +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionStatus', 'BetaRoleMiningSessionStatus'] +--- + + +# RoleMiningSessionStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to [**RoleMiningSessionState**](role-mining-session-state) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningSessionStatus = Initialize-PSSailpoint.BetaRoleMiningSessionStatus -State null +``` + +- Convert the resource to JSON +```powershell +$RoleMiningSessionStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleTargetDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleTargetDto.md new file mode 100644 index 000000000..619d75aae --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/RoleTargetDto.md @@ -0,0 +1,39 @@ +--- +id: beta-role-target-dto +title: RoleTargetDto +pagination_label: RoleTargetDto +sidebar_label: RoleTargetDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleTargetDto', 'BetaRoleTargetDto'] +slug: /tools/sdk/powershell/beta/models/role-target-dto +tags: ['SDK', 'Software Development Kit', 'RoleTargetDto', 'BetaRoleTargetDto'] +--- + + +# RoleTargetDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] +**AccountInfo** | Pointer to [**AccountInfoDto**](account-info-dto) | | [optional] +**RoleName** | Pointer to **String** | Specific role name for this target if using multiple accounts | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleTargetDto = Initialize-PSSailpoint.BetaRoleTargetDto -Source null ` + -AccountInfo null ` + -RoleName Marketing +``` + +- Convert the resource to JSON +```powershell +$RoleTargetDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Rule.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Rule.md new file mode 100644 index 000000000..6e3e8838c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Rule.md @@ -0,0 +1,47 @@ +--- +id: beta-rule +title: Rule +pagination_label: Rule +sidebar_label: Rule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Rule', 'BetaRule'] +slug: /tools/sdk/powershell/beta/models/rule +tags: ['SDK', 'Software Development Kit', 'Rule', 'BetaRule'] +--- + + +# Rule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | This must always be set to ""Cloud Services Deployment Utility"" | [required] +**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] +**Operation** | **String** | The operation to perform `getReferenceIdentityAttribute` | [required] +**IncludeNumbers** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include numbers | [required] +**IncludeSpecialChars** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include special characters | [required] +**Length** | **String** | This specifies how long the randomly generated string needs to be >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters | [required] +**Uid** | **String** | This is the SailPoint User Name (uid) value of the identity whose attribute is desired As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. | [required] + +## Examples + +- Prepare the resource +```powershell +$Rule = Initialize-PSSailpoint.BetaRule -Name Cloud Services Deployment Utility ` + -RequiresPeriodicRefresh false ` + -Operation getReferenceIdentityAttribute ` + -IncludeNumbers true ` + -IncludeSpecialChars true ` + -Length 10 ` + -Uid 2c91808570313110017040b06f344ec9 +``` + +- Convert the resource to JSON +```powershell +$Rule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SavedSearchComplete.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SavedSearchComplete.md new file mode 100644 index 000000000..146248541 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SavedSearchComplete.md @@ -0,0 +1,47 @@ +--- +id: beta-saved-search-complete +title: SavedSearchComplete +pagination_label: SavedSearchComplete +sidebar_label: SavedSearchComplete +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearchComplete', 'BetaSavedSearchComplete'] +slug: /tools/sdk/powershell/beta/models/saved-search-complete +tags: ['SDK', 'Software Development Kit', 'SavedSearchComplete', 'BetaSavedSearchComplete'] +--- + + +# SavedSearchComplete + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FileName** | **String** | A name for the report file. | [required] +**OwnerEmail** | **String** | The email address of the identity that owns the saved search. | [required] +**OwnerName** | **String** | The name of the identity that owns the saved search. | [required] +**Query** | **String** | The search query that was used to generate the report. | [required] +**SearchName** | **String** | The name of the saved search. | [required] +**SearchResults** | [**SavedSearchCompleteSearchResults**](saved-search-complete-search-results) | | [required] +**SignedS3Url** | **String** | The Amazon S3 URL to download the report from. | [required] + +## Examples + +- Prepare the resource +```powershell +$SavedSearchComplete = Initialize-PSSailpoint.BetaSavedSearchComplete -FileName Modified.zip ` + -OwnerEmail test@sailpoint.com ` + -OwnerName Cloud Support ` + -Query modified:[now-7y/d TO now] ` + -SearchName Modified Activity ` + -SearchResults null ` + -SignedS3Url https://sptcbu-org-data-useast1.s3.amazonaws.com/arsenal-john/reports/Events%20Export.2020-05-06%2018%2759%20GMT.3e580592-86e4-4953-8aea-49e6ef20a086.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200506T185919Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=AKIAV5E54XOGTS4Q4L7A%2F20200506%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2e732bb97a12a1fd8a215613e3c31fcdae8ba1fb6a25916843ab5b51d2ddefbc +``` + +- Convert the resource to JSON +```powershell +$SavedSearchComplete | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SavedSearchCompleteSearchResults.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SavedSearchCompleteSearchResults.md new file mode 100644 index 000000000..57470b169 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SavedSearchCompleteSearchResults.md @@ -0,0 +1,39 @@ +--- +id: beta-saved-search-complete-search-results +title: SavedSearchCompleteSearchResults +pagination_label: SavedSearchCompleteSearchResults +sidebar_label: SavedSearchCompleteSearchResults +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearchCompleteSearchResults', 'BetaSavedSearchCompleteSearchResults'] +slug: /tools/sdk/powershell/beta/models/saved-search-complete-search-results +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResults', 'BetaSavedSearchCompleteSearchResults'] +--- + + +# SavedSearchCompleteSearchResults + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Account** | Pointer to [**SavedSearchCompleteSearchResultsAccount**](saved-search-complete-search-results-account) | | [optional] +**Entitlement** | Pointer to [**SavedSearchCompleteSearchResultsEntitlement**](saved-search-complete-search-results-entitlement) | | [optional] +**Identity** | Pointer to [**SavedSearchCompleteSearchResultsIdentity**](saved-search-complete-search-results-identity) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SavedSearchCompleteSearchResults = Initialize-PSSailpoint.BetaSavedSearchCompleteSearchResults -Account null ` + -Entitlement null ` + -Identity null +``` + +- Convert the resource to JSON +```powershell +$SavedSearchCompleteSearchResults | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SavedSearchCompleteSearchResultsAccount.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SavedSearchCompleteSearchResultsAccount.md new file mode 100644 index 000000000..9254216ec --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SavedSearchCompleteSearchResultsAccount.md @@ -0,0 +1,39 @@ +--- +id: beta-saved-search-complete-search-results-account +title: SavedSearchCompleteSearchResultsAccount +pagination_label: SavedSearchCompleteSearchResultsAccount +sidebar_label: SavedSearchCompleteSearchResultsAccount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearchCompleteSearchResultsAccount', 'BetaSavedSearchCompleteSearchResultsAccount'] +slug: /tools/sdk/powershell/beta/models/saved-search-complete-search-results-account +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsAccount', 'BetaSavedSearchCompleteSearchResultsAccount'] +--- + + +# SavedSearchCompleteSearchResultsAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | **String** | The number of rows in the table. | [required] +**Noun** | **String** | The type of object represented in the table. | [required] +**Preview** | **[]String[]** | A sample of the data in the table. | [required] + +## Examples + +- Prepare the resource +```powershell +$SavedSearchCompleteSearchResultsAccount = Initialize-PSSailpoint.BetaSavedSearchCompleteSearchResultsAccount -Count 3 ` + -Noun accounts ` + -Preview null +``` + +- Convert the resource to JSON +```powershell +$SavedSearchCompleteSearchResultsAccount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SavedSearchCompleteSearchResultsEntitlement.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SavedSearchCompleteSearchResultsEntitlement.md new file mode 100644 index 000000000..0339c7979 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SavedSearchCompleteSearchResultsEntitlement.md @@ -0,0 +1,39 @@ +--- +id: beta-saved-search-complete-search-results-entitlement +title: SavedSearchCompleteSearchResultsEntitlement +pagination_label: SavedSearchCompleteSearchResultsEntitlement +sidebar_label: SavedSearchCompleteSearchResultsEntitlement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearchCompleteSearchResultsEntitlement', 'BetaSavedSearchCompleteSearchResultsEntitlement'] +slug: /tools/sdk/powershell/beta/models/saved-search-complete-search-results-entitlement +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsEntitlement', 'BetaSavedSearchCompleteSearchResultsEntitlement'] +--- + + +# SavedSearchCompleteSearchResultsEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | **String** | The number of rows in the table. | [required] +**Noun** | **String** | The type of object represented in the table. | [required] +**Preview** | **[]String[]** | A sample of the data in the table. | [required] + +## Examples + +- Prepare the resource +```powershell +$SavedSearchCompleteSearchResultsEntitlement = Initialize-PSSailpoint.BetaSavedSearchCompleteSearchResultsEntitlement -Count 2 ` + -Noun entitlements ` + -Preview null +``` + +- Convert the resource to JSON +```powershell +$SavedSearchCompleteSearchResultsEntitlement | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SavedSearchCompleteSearchResultsIdentity.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SavedSearchCompleteSearchResultsIdentity.md new file mode 100644 index 000000000..402be3771 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SavedSearchCompleteSearchResultsIdentity.md @@ -0,0 +1,39 @@ +--- +id: beta-saved-search-complete-search-results-identity +title: SavedSearchCompleteSearchResultsIdentity +pagination_label: SavedSearchCompleteSearchResultsIdentity +sidebar_label: SavedSearchCompleteSearchResultsIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearchCompleteSearchResultsIdentity', 'BetaSavedSearchCompleteSearchResultsIdentity'] +slug: /tools/sdk/powershell/beta/models/saved-search-complete-search-results-identity +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsIdentity', 'BetaSavedSearchCompleteSearchResultsIdentity'] +--- + + +# SavedSearchCompleteSearchResultsIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | **String** | The number of rows in the table. | [required] +**Noun** | **String** | The type of object represented in the table. | [required] +**Preview** | **[]String[]** | A sample of the data in the table. | [required] + +## Examples + +- Prepare the resource +```powershell +$SavedSearchCompleteSearchResultsIdentity = Initialize-PSSailpoint.BetaSavedSearchCompleteSearchResultsIdentity -Count 2 ` + -Noun identities ` + -Preview null +``` + +- Convert the resource to JSON +```powershell +$SavedSearchCompleteSearchResultsIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Schedule.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Schedule.md new file mode 100644 index 000000000..ee18bd4f9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Schedule.md @@ -0,0 +1,45 @@ +--- +id: beta-schedule +title: Schedule +pagination_label: Schedule +sidebar_label: Schedule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule', 'BetaSchedule'] +slug: /tools/sdk/powershell/beta/models/schedule +tags: ['SDK', 'Software Development Kit', 'Schedule', 'BetaSchedule'] +--- + + +# Schedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "WEEKLY", "MONTHLY", "ANNUALLY", "CALENDAR" ] | Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type can be configured. For example, a DAILY schedule can have 'hours' set, but not 'days'; a WEEKLY schedule can have both 'hours' and 'days' set. | [required] +**Months** | Pointer to [**ScheduleMonths**](schedule-months) | | [optional] +**Days** | Pointer to [**ScheduleDays**](schedule-days) | | [optional] +**Hours** | [**ScheduleHours**](schedule-hours) | | [required] +**Expiration** | Pointer to **System.DateTime** | Specifies the time after which this schedule will no longer occur. | [optional] +**TimeZoneId** | Pointer to **String** | The time zone to use when running the schedule. For instance, if the schedule is scheduled to run at 1AM, and this field is set to ""CST"", the schedule will run at 1AM CST. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Schedule = Initialize-PSSailpoint.BetaSchedule -Type WEEKLY ` + -Months null ` + -Days null ` + -Hours null ` + -Expiration null ` + -TimeZoneId CST +``` + +- Convert the resource to JSON +```powershell +$Schedule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Schedule1.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Schedule1.md new file mode 100644 index 000000000..5ee13ddf5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Schedule1.md @@ -0,0 +1,45 @@ +--- +id: beta-schedule1 +title: Schedule1 +pagination_label: Schedule1 +sidebar_label: Schedule1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule1', 'BetaSchedule1'] +slug: /tools/sdk/powershell/beta/models/schedule1 +tags: ['SDK', 'Software Development Kit', 'Schedule1', 'BetaSchedule1'] +--- + + +# Schedule1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**ScheduleType**](schedule-type) | | [required] +**Months** | Pointer to [**Schedule1Months**](schedule1-months) | | [optional] +**Days** | Pointer to [**Schedule1Days**](schedule1-days) | | [optional] +**Hours** | [**Schedule1Hours**](schedule1-hours) | | [required] +**Expiration** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] +**TimeZoneId** | Pointer to **String** | The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org's default timezone is used. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Schedule1 = Initialize-PSSailpoint.BetaSchedule1 -Type null ` + -Months null ` + -Days null ` + -Hours null ` + -Expiration 2018-06-25T20:22:28.104Z ` + -TimeZoneId America/Chicago +``` + +- Convert the resource to JSON +```powershell +$Schedule1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Schedule1Days.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Schedule1Days.md new file mode 100644 index 000000000..159cd2eef --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Schedule1Days.md @@ -0,0 +1,37 @@ +--- +id: beta-schedule1-days +title: Schedule1Days +pagination_label: Schedule1Days +sidebar_label: Schedule1Days +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule1Days', 'BetaSchedule1Days'] +slug: /tools/sdk/powershell/beta/models/schedule1-days +tags: ['SDK', 'Software Development Kit', 'Schedule1Days', 'BetaSchedule1Days'] +--- + + +# Schedule1Days + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationId** | Pointer to **String** | The application id | [optional] +**AccountMatchConfig** | Pointer to [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Schedule1Days = Initialize-PSSailpoint.BetaSchedule1Days -ApplicationId 2c91808874ff91550175097daaec161c" ` + -AccountMatchConfig null +``` + +- Convert the resource to JSON +```powershell +$Schedule1Days | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Schedule1Hours.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Schedule1Hours.md new file mode 100644 index 000000000..34de3cafc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Schedule1Hours.md @@ -0,0 +1,37 @@ +--- +id: beta-schedule1-hours +title: Schedule1Hours +pagination_label: Schedule1Hours +sidebar_label: Schedule1Hours +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule1Hours', 'BetaSchedule1Hours'] +slug: /tools/sdk/powershell/beta/models/schedule1-hours +tags: ['SDK', 'Software Development Kit', 'Schedule1Hours', 'BetaSchedule1Hours'] +--- + + +# Schedule1Hours + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationId** | Pointer to **String** | The application id | [optional] +**AccountMatchConfig** | Pointer to [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Schedule1Hours = Initialize-PSSailpoint.BetaSchedule1Hours -ApplicationId 2c91808874ff91550175097daaec161c" ` + -AccountMatchConfig null +``` + +- Convert the resource to JSON +```powershell +$Schedule1Hours | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Schedule1Months.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Schedule1Months.md new file mode 100644 index 000000000..370ea0f08 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Schedule1Months.md @@ -0,0 +1,37 @@ +--- +id: beta-schedule1-months +title: Schedule1Months +pagination_label: Schedule1Months +sidebar_label: Schedule1Months +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule1Months', 'BetaSchedule1Months'] +slug: /tools/sdk/powershell/beta/models/schedule1-months +tags: ['SDK', 'Software Development Kit', 'Schedule1Months', 'BetaSchedule1Months'] +--- + + +# Schedule1Months + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationId** | Pointer to **String** | The application id | [optional] +**AccountMatchConfig** | Pointer to [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Schedule1Months = Initialize-PSSailpoint.BetaSchedule1Months -ApplicationId 2c91808874ff91550175097daaec161c" ` + -AccountMatchConfig null +``` + +- Convert the resource to JSON +```powershell +$Schedule1Months | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ScheduleDays.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ScheduleDays.md new file mode 100644 index 000000000..274b79c52 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ScheduleDays.md @@ -0,0 +1,39 @@ +--- +id: beta-schedule-days +title: ScheduleDays +pagination_label: ScheduleDays +sidebar_label: ScheduleDays +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduleDays', 'BetaScheduleDays'] +slug: /tools/sdk/powershell/beta/models/schedule-days +tags: ['SDK', 'Software Development Kit', 'ScheduleDays', 'BetaScheduleDays'] +--- + + +# ScheduleDays + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "LIST", "RANGE" ] | Enum type to specify days value | [required] +**Values** | **[]String** | Values of the days based on the enum type mentioned above | [required] +**Interval** | Pointer to **Int64** | Interval between the cert generations | [optional] + +## Examples + +- Prepare the resource +```powershell +$ScheduleDays = Initialize-PSSailpoint.BetaScheduleDays -Type LIST ` + -Values [1] ` + -Interval 2 +``` + +- Convert the resource to JSON +```powershell +$ScheduleDays | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ScheduleHours.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ScheduleHours.md new file mode 100644 index 000000000..a2cafda34 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ScheduleHours.md @@ -0,0 +1,39 @@ +--- +id: beta-schedule-hours +title: ScheduleHours +pagination_label: ScheduleHours +sidebar_label: ScheduleHours +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduleHours', 'BetaScheduleHours'] +slug: /tools/sdk/powershell/beta/models/schedule-hours +tags: ['SDK', 'Software Development Kit', 'ScheduleHours', 'BetaScheduleHours'] +--- + + +# ScheduleHours + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "LIST", "RANGE" ] | Enum type to specify hours value | [required] +**Values** | **[]String** | Values of the days based on the enum type mentioned above | [required] +**Interval** | Pointer to **Int64** | Interval between the cert generations | [optional] + +## Examples + +- Prepare the resource +```powershell +$ScheduleHours = Initialize-PSSailpoint.BetaScheduleHours -Type LIST ` + -Values [1] ` + -Interval 2 +``` + +- Convert the resource to JSON +```powershell +$ScheduleHours | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ScheduleMonths.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ScheduleMonths.md new file mode 100644 index 000000000..02b513f35 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ScheduleMonths.md @@ -0,0 +1,39 @@ +--- +id: beta-schedule-months +title: ScheduleMonths +pagination_label: ScheduleMonths +sidebar_label: ScheduleMonths +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduleMonths', 'BetaScheduleMonths'] +slug: /tools/sdk/powershell/beta/models/schedule-months +tags: ['SDK', 'Software Development Kit', 'ScheduleMonths', 'BetaScheduleMonths'] +--- + + +# ScheduleMonths + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "LIST", "RANGE" ] | Enum type to specify months value | [required] +**Values** | **[]String** | Values of the months based on the enum type mentioned above | [required] +**Interval** | Pointer to **Int64** | Interval between the cert generations | [optional] + +## Examples + +- Prepare the resource +```powershell +$ScheduleMonths = Initialize-PSSailpoint.BetaScheduleMonths -Type LIST ` + -Values [1] ` + -Interval 2 +``` + +- Convert the resource to JSON +```powershell +$ScheduleMonths | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ScheduleType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ScheduleType.md new file mode 100644 index 000000000..899b52797 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ScheduleType.md @@ -0,0 +1,30 @@ +--- +id: beta-schedule-type +title: ScheduleType +pagination_label: ScheduleType +sidebar_label: ScheduleType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduleType', 'BetaScheduleType'] +slug: /tools/sdk/powershell/beta/models/schedule-type +tags: ['SDK', 'Software Development Kit', 'ScheduleType', 'BetaScheduleType'] +--- + + +# ScheduleType + +## Enum + + +* `DAILY` (value: `"DAILY"`) + +* `WEEKLY` (value: `"WEEKLY"`) + +* `MONTHLY` (value: `"MONTHLY"`) + +* `CALENDAR` (value: `"CALENDAR"`) + +* `ANNUALLY` (value: `"ANNUALLY"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ScheduledAttributes.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ScheduledAttributes.md new file mode 100644 index 000000000..34ab7c920 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ScheduledAttributes.md @@ -0,0 +1,43 @@ +--- +id: beta-scheduled-attributes +title: ScheduledAttributes +pagination_label: ScheduledAttributes +sidebar_label: ScheduledAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledAttributes', 'BetaScheduledAttributes'] +slug: /tools/sdk/powershell/beta/models/scheduled-attributes +tags: ['SDK', 'Software Development Kit', 'ScheduledAttributes', 'BetaScheduledAttributes'] +--- + + +# ScheduledAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Frequency** | **Enum** [ "daily", "weekly", "monthly", "yearly", "cronSchedule" ] | Frequency of execution | [required] +**TimeZone** | Pointer to **String** | Time zone identifier | [optional] +**CronString** | Pointer to **String** | | [optional] +**WeeklyDays** | Pointer to **[]String** | Scheduled days of the week for execution | [optional] +**WeeklyTimes** | Pointer to **[]String** | Scheduled execution times | [optional] + +## Examples + +- Prepare the resource +```powershell +$ScheduledAttributes = Initialize-PSSailpoint.BetaScheduledAttributes -Frequency null ` + -TimeZone America/Chicago ` + -CronString 0 9 * * 1 ` + -WeeklyDays Monday ` + -WeeklyTimes Monday +``` + +- Convert the resource to JSON +```powershell +$ScheduledAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Schema.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Schema.md new file mode 100644 index 000000000..529bc2623 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Schema.md @@ -0,0 +1,57 @@ +--- +id: beta-schema +title: Schema +pagination_label: Schema +sidebar_label: Schema +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Schema', 'BetaSchema'] +slug: /tools/sdk/powershell/beta/models/schema +tags: ['SDK', 'Software Development Kit', 'Schema', 'BetaSchema'] +--- + + +# Schema + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The id of the Schema. | [optional] +**Name** | Pointer to **String** | The name of the Schema. | [optional] +**NativeObjectType** | Pointer to **String** | The name of the object type on the native system that the schema represents. | [optional] +**IdentityAttribute** | Pointer to **String** | The name of the attribute used to calculate the unique identifier for an object in the schema. | [optional] +**DisplayAttribute** | Pointer to **String** | The name of the attribute used to calculate the display value for an object in the schema. | [optional] +**HierarchyAttribute** | Pointer to **String** | The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. | [optional] +**IncludePermissions** | Pointer to **Boolean** | Flag indicating whether or not the include permissions with the object data when aggregating the schema. | [optional] +**Features** | Pointer to **[]String** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**Configuration** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Holds any extra configuration data that the schema may require. | [optional] +**Attributes** | Pointer to [**[]AttributeDefinition**](attribute-definition) | The attribute definitions which form the schema. | [optional] +**Created** | Pointer to **System.DateTime** | The date the Schema was created. | [optional] +**Modified** | Pointer to **System.DateTime** | The date the Schema was last modified. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Schema = Initialize-PSSailpoint.BetaSchema -Id 2c9180835d191a86015d28455b4a2329 ` + -Name account ` + -NativeObjectType User ` + -IdentityAttribute sAMAccountName ` + -DisplayAttribute distinguishedName ` + -HierarchyAttribute memberOf ` + -IncludePermissions false ` + -Features [PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS] ` + -Configuration {groupMemberAttribute=member} ` + -Attributes [{name=sAMAccountName, type=STRING, isMultiValued=false, isEntitlement=false, isGroup=false}, {name=memberOf, type=STRING, schema={type=CONNECTOR_SCHEMA, id=2c9180887671ff8c01767b4671fc7d60, name=group}, description=Group membership, isMultiValued=true, isEntitlement=true, isGroup=true}] ` + -Created 2019-12-24T22:32:58.104Z ` + -Modified 2019-12-31T20:22:28.104Z +``` + +- Convert the resource to JSON +```powershell +$Schema | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SearchAttributeConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SearchAttributeConfig.md new file mode 100644 index 000000000..53967c8b1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SearchAttributeConfig.md @@ -0,0 +1,39 @@ +--- +id: beta-search-attribute-config +title: SearchAttributeConfig +pagination_label: SearchAttributeConfig +sidebar_label: SearchAttributeConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchAttributeConfig', 'BetaSearchAttributeConfig'] +slug: /tools/sdk/powershell/beta/models/search-attribute-config +tags: ['SDK', 'Software Development Kit', 'SearchAttributeConfig', 'BetaSearchAttributeConfig'] +--- + + +# SearchAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Name of the new attribute | [optional] +**DisplayName** | Pointer to **String** | The display name of the new attribute | [optional] +**ApplicationAttributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Map of application id and their associated attribute. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchAttributeConfig = Initialize-PSSailpoint.BetaSearchAttributeConfig -Name newMailAttribute ` + -DisplayName New Mail Attribute ` + -ApplicationAttributes {2c91808b79fd2422017a0b35d30f3968=employeeNumber, 2c91808b79fd2422017a0b36008f396b=employeeNumber} +``` + +- Convert the resource to JSON +```powershell +$SearchAttributeConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SearchFormDefinitionsByTenant400Response.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SearchFormDefinitionsByTenant400Response.md new file mode 100644 index 000000000..961a24f2a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SearchFormDefinitionsByTenant400Response.md @@ -0,0 +1,41 @@ +--- +id: beta-search-form-definitions-by-tenant400-response +title: SearchFormDefinitionsByTenant400Response +pagination_label: SearchFormDefinitionsByTenant400Response +sidebar_label: SearchFormDefinitionsByTenant400Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchFormDefinitionsByTenant400Response', 'BetaSearchFormDefinitionsByTenant400Response'] +slug: /tools/sdk/powershell/beta/models/search-form-definitions-by-tenant400-response +tags: ['SDK', 'Software Development Kit', 'SearchFormDefinitionsByTenant400Response', 'BetaSearchFormDefinitionsByTenant400Response'] +--- + + +# SearchFormDefinitionsByTenant400Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetailCode** | Pointer to **String** | | [optional] +**Messages** | Pointer to [**[]ErrorMessage**](error-message) | | [optional] +**StatusCode** | Pointer to **Int64** | | [optional] +**TrackingId** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchFormDefinitionsByTenant400Response = Initialize-PSSailpoint.BetaSearchFormDefinitionsByTenant400Response -DetailCode null ` + -Messages null ` + -StatusCode null ` + -TrackingId null +``` + +- Convert the resource to JSON +```powershell +$SearchFormDefinitionsByTenant400Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Section.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Section.md new file mode 100644 index 000000000..a2f87366c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Section.md @@ -0,0 +1,39 @@ +--- +id: beta-section +title: Section +pagination_label: Section +sidebar_label: Section +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Section', 'BetaSection'] +slug: /tools/sdk/powershell/beta/models/section +tags: ['SDK', 'Software Development Kit', 'Section', 'BetaSection'] +--- + + +# Section + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Name of the FormItem | [optional] +**Label** | Pointer to **String** | Label of the section | [optional] +**FormItems** | Pointer to [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | List of FormItems. FormItems can be SectionDetails and/or FieldDetails | [optional] + +## Examples + +- Prepare the resource +```powershell +$Section = Initialize-PSSailpoint.BetaSection -Name Field1 ` + -Label Section 1 ` + -FormItems [] +``` + +- Convert the resource to JSON +```powershell +$Section | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SectionDetails.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SectionDetails.md new file mode 100644 index 000000000..d8aa9fa79 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SectionDetails.md @@ -0,0 +1,39 @@ +--- +id: beta-section-details +title: SectionDetails +pagination_label: SectionDetails +sidebar_label: SectionDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SectionDetails', 'BetaSectionDetails'] +slug: /tools/sdk/powershell/beta/models/section-details +tags: ['SDK', 'Software Development Kit', 'SectionDetails', 'BetaSectionDetails'] +--- + + +# SectionDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Name of the FormItem | [optional] +**Label** | Pointer to **String** | Label of the section | [optional] +**FormItems** | Pointer to [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | List of FormItems. FormItems can be SectionDetails and/or FieldDetails | [optional] + +## Examples + +- Prepare the resource +```powershell +$SectionDetails = Initialize-PSSailpoint.BetaSectionDetails -Name Field1 ` + -Label Section 1 ` + -FormItems [] +``` + +- Convert the resource to JSON +```powershell +$SectionDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Sed.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Sed.md new file mode 100644 index 000000000..527d697fc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Sed.md @@ -0,0 +1,61 @@ +--- +id: beta-sed +title: Sed +pagination_label: Sed +sidebar_label: Sed +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Sed', 'BetaSed'] +slug: /tools/sdk/powershell/beta/models/sed +tags: ['SDK', 'Software Development Kit', 'Sed', 'BetaSed'] +--- + + +# Sed + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | name of the entitlement | [optional] +**ApprovedBy** | Pointer to **String** | entitlement approved by | [optional] +**ApprovedType** | Pointer to **String** | entitlement approved type | [optional] +**ApprovedWhen** | Pointer to **System.DateTime** | entitlement approved then | [optional] +**Attribute** | Pointer to **String** | entitlement attribute | [optional] +**Description** | Pointer to **String** | description of entitlement | [optional] +**DisplayName** | Pointer to **String** | entitlement display name | [optional] +**Id** | Pointer to **String** | sed id | [optional] +**SourceId** | Pointer to **String** | entitlement source id | [optional] +**SourceName** | Pointer to **String** | entitlement source name | [optional] +**Status** | Pointer to **String** | entitlement status | [optional] +**SuggestedDescription** | Pointer to **String** | llm suggested entitlement description | [optional] +**Type** | Pointer to **String** | entitlement type | [optional] +**Value** | Pointer to **String** | entitlement value | [optional] + +## Examples + +- Prepare the resource +```powershell +$Sed = Initialize-PSSailpoint.BetaSed -Name BatchInvoiceProcessing ` + -ApprovedBy 2c918086-76de-afbf-0176-f6d28f65565a ` + -ApprovedType admin ` + -ApprovedWhen null ` + -Attribute Role ` + -Description This entitlement allows automated processing of invoices in batches on a scheduled basis to streamline accounts payable procedures. ` + -DisplayName AWS-Cloud-Billing ` + -Id ead281ee-12a9-40ac-9534-36b5d7d65d53 ` + -SourceId 103f567b93ee49b991c40f9412f87643 ` + -SourceName IDN Salesforce ` + -Status suggested ` + -SuggestedDescription This entitlement allows automated processing of invoices in batches on a scheduled basis to streamline accounts payable ` + -Type group ` + -Value group +``` + +- Convert the resource to JSON +```powershell +$Sed | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedApproval.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedApproval.md new file mode 100644 index 000000000..55d41e456 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedApproval.md @@ -0,0 +1,35 @@ +--- +id: beta-sed-approval +title: SedApproval +pagination_label: SedApproval +sidebar_label: SedApproval +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SedApproval', 'BetaSedApproval'] +slug: /tools/sdk/powershell/beta/models/sed-approval +tags: ['SDK', 'Software Development Kit', 'SedApproval', 'BetaSedApproval'] +--- + + +# SedApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Items** | Pointer to **[]String** | List of SED id's | [optional] + +## Examples + +- Prepare the resource +```powershell +$SedApproval = Initialize-PSSailpoint.BetaSedApproval -Items 016629d1-1d25-463f-97f3-c6686846650 +``` + +- Convert the resource to JSON +```powershell +$SedApproval | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedApprovalStatus.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedApprovalStatus.md new file mode 100644 index 000000000..95720059b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedApprovalStatus.md @@ -0,0 +1,39 @@ +--- +id: beta-sed-approval-status +title: SedApprovalStatus +pagination_label: SedApprovalStatus +sidebar_label: SedApprovalStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SedApprovalStatus', 'BetaSedApprovalStatus'] +slug: /tools/sdk/powershell/beta/models/sed-approval-status +tags: ['SDK', 'Software Development Kit', 'SedApprovalStatus', 'BetaSedApprovalStatus'] +--- + + +# SedApprovalStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FailedReason** | Pointer to **String** | failed reason will be display if status is failed | [optional] +**Id** | Pointer to **String** | Sed id | [optional] +**Status** | Pointer to **String** | SUCCESS | FAILED | [optional] + +## Examples + +- Prepare the resource +```powershell +$SedApprovalStatus = Initialize-PSSailpoint.BetaSedApprovalStatus -FailedReason invalid status ` + -Id 016629d1-1d25-463f-97f3-0c6686846650 ` + -Status SUCCESS +``` + +- Convert the resource to JSON +```powershell +$SedApprovalStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedAssignee.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedAssignee.md new file mode 100644 index 000000000..ea0885c6b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedAssignee.md @@ -0,0 +1,37 @@ +--- +id: beta-sed-assignee +title: SedAssignee +pagination_label: SedAssignee +sidebar_label: SedAssignee +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SedAssignee', 'BetaSedAssignee'] +slug: /tools/sdk/powershell/beta/models/sed-assignee +tags: ['SDK', 'Software Development Kit', 'SedAssignee', 'BetaSedAssignee'] +--- + + +# SedAssignee + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY", "GROUP", "SOURCE_OWNER", "ENTITLEMENT_OWNER" ] | Type of assignment When value is PERSONA, the value MUST be SOURCE_OWNER or ENTITLEMENT_OWNER IDENTITY SED_ASSIGNEE_IDENTITY_TYPE GROUP SED_ASSIGNEE_GROUP_TYPE SOURCE_OWNER SED_ASSIGNEE_SOURCE_OWNER_TYPE ENTITLEMENT_OWNER SED_ASSIGNEE_ENTITLEMENT_OWNER_TYPE | [required] +**Value** | Pointer to **String** | Identity or Group identifier Empty when using source/entitlement owner personas | [optional] + +## Examples + +- Prepare the resource +```powershell +$SedAssignee = Initialize-PSSailpoint.BetaSedAssignee -Type SOURCE_OWNER ` + -Value 016629d1-1d25-463f-97f3-c6686846650 +``` + +- Convert the resource to JSON +```powershell +$SedAssignee | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedAssignment.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedAssignment.md new file mode 100644 index 000000000..7e0aadfc3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedAssignment.md @@ -0,0 +1,37 @@ +--- +id: beta-sed-assignment +title: SedAssignment +pagination_label: SedAssignment +sidebar_label: SedAssignment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SedAssignment', 'BetaSedAssignment'] +slug: /tools/sdk/powershell/beta/models/sed-assignment +tags: ['SDK', 'Software Development Kit', 'SedAssignment', 'BetaSedAssignment'] +--- + + +# SedAssignment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Assignee** | Pointer to [**SedAssignee**](sed-assignee) | | [optional] +**Items** | Pointer to **[]String** | List of SED id's | [optional] + +## Examples + +- Prepare the resource +```powershell +$SedAssignment = Initialize-PSSailpoint.BetaSedAssignment -Assignee null ` + -Items null +``` + +- Convert the resource to JSON +```powershell +$SedAssignment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedAssignmentResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedAssignmentResponse.md new file mode 100644 index 000000000..b64cf3f40 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedAssignmentResponse.md @@ -0,0 +1,35 @@ +--- +id: beta-sed-assignment-response +title: SedAssignmentResponse +pagination_label: SedAssignmentResponse +sidebar_label: SedAssignmentResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SedAssignmentResponse', 'BetaSedAssignmentResponse'] +slug: /tools/sdk/powershell/beta/models/sed-assignment-response +tags: ['SDK', 'Software Development Kit', 'SedAssignmentResponse', 'BetaSedAssignmentResponse'] +--- + + +# SedAssignmentResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchId** | Pointer to **String** | BatchId that groups all the ids together | [optional] + +## Examples + +- Prepare the resource +```powershell +$SedAssignmentResponse = Initialize-PSSailpoint.BetaSedAssignmentResponse -BatchId 016629d1-1d25-463f-97f3-0c6686846650 +``` + +- Convert the resource to JSON +```powershell +$SedAssignmentResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedBatchRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedBatchRequest.md new file mode 100644 index 000000000..d6f57e30f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedBatchRequest.md @@ -0,0 +1,37 @@ +--- +id: beta-sed-batch-request +title: SedBatchRequest +pagination_label: SedBatchRequest +sidebar_label: SedBatchRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SedBatchRequest', 'BetaSedBatchRequest'] +slug: /tools/sdk/powershell/beta/models/sed-batch-request +tags: ['SDK', 'Software Development Kit', 'SedBatchRequest', 'BetaSedBatchRequest'] +--- + + +# SedBatchRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Entitlements** | Pointer to **[]String** | list of entitlement ids | [optional] +**Seds** | Pointer to **[]String** | list of sed ids | [optional] + +## Examples + +- Prepare the resource +```powershell +$SedBatchRequest = Initialize-PSSailpoint.BetaSedBatchRequest -Entitlements null ` + -Seds null +``` + +- Convert the resource to JSON +```powershell +$SedBatchRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedBatchResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedBatchResponse.md new file mode 100644 index 000000000..a109a65a8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedBatchResponse.md @@ -0,0 +1,35 @@ +--- +id: beta-sed-batch-response +title: SedBatchResponse +pagination_label: SedBatchResponse +sidebar_label: SedBatchResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SedBatchResponse', 'BetaSedBatchResponse'] +slug: /tools/sdk/powershell/beta/models/sed-batch-response +tags: ['SDK', 'Software Development Kit', 'SedBatchResponse', 'BetaSedBatchResponse'] +--- + + +# SedBatchResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchId** | Pointer to **String** | BatchId that groups all the ids together | [optional] + +## Examples + +- Prepare the resource +```powershell +$SedBatchResponse = Initialize-PSSailpoint.BetaSedBatchResponse -BatchId 016629d1-1d25-463f-97f3-0c6686846650 +``` + +- Convert the resource to JSON +```powershell +$SedBatchResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedBatchStats.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedBatchStats.md new file mode 100644 index 000000000..4f40272cd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedBatchStats.md @@ -0,0 +1,43 @@ +--- +id: beta-sed-batch-stats +title: SedBatchStats +pagination_label: SedBatchStats +sidebar_label: SedBatchStats +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SedBatchStats', 'BetaSedBatchStats'] +slug: /tools/sdk/powershell/beta/models/sed-batch-stats +tags: ['SDK', 'Software Development Kit', 'SedBatchStats', 'BetaSedBatchStats'] +--- + + +# SedBatchStats + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchComplete** | Pointer to **Boolean** | batch complete | [optional] [default to $false] +**BatchId** | Pointer to **String** | batch Id | [optional] +**DiscoveredCount** | Pointer to **Int64** | discovered count | [optional] +**DiscoveryComplete** | Pointer to **Boolean** | discovery complete | [optional] [default to $false] +**ProcessedCount** | Pointer to **Int64** | processed count | [optional] + +## Examples + +- Prepare the resource +```powershell +$SedBatchStats = Initialize-PSSailpoint.BetaSedBatchStats -BatchComplete true ` + -BatchId 016629d1-1d25-463f-97f3-0c6686846650 ` + -DiscoveredCount 100 ` + -DiscoveryComplete true ` + -ProcessedCount 100 +``` + +- Convert the resource to JSON +```powershell +$SedBatchStats | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedBatchStatus.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedBatchStatus.md new file mode 100644 index 000000000..1d69395b5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedBatchStatus.md @@ -0,0 +1,35 @@ +--- +id: beta-sed-batch-status +title: SedBatchStatus +pagination_label: SedBatchStatus +sidebar_label: SedBatchStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SedBatchStatus', 'BetaSedBatchStatus'] +slug: /tools/sdk/powershell/beta/models/sed-batch-status +tags: ['SDK', 'Software Development Kit', 'SedBatchStatus', 'BetaSedBatchStatus'] +--- + + +# SedBatchStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **String** | status of batch | [optional] + +## Examples + +- Prepare the resource +```powershell +$SedBatchStatus = Initialize-PSSailpoint.BetaSedBatchStatus -Status OK +``` + +- Convert the resource to JSON +```powershell +$SedBatchStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedPatch.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedPatch.md new file mode 100644 index 000000000..43c4e1d1c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SedPatch.md @@ -0,0 +1,39 @@ +--- +id: beta-sed-patch +title: SedPatch +pagination_label: SedPatch +sidebar_label: SedPatch +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SedPatch', 'BetaSedPatch'] +slug: /tools/sdk/powershell/beta/models/sed-patch +tags: ['SDK', 'Software Development Kit', 'SedPatch', 'BetaSedPatch'] +--- + + +# SedPatch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | Pointer to **String** | desired operation | [optional] +**Path** | Pointer to **String** | field to be patched | [optional] +**Value** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | value to replace with | [optional] + +## Examples + +- Prepare the resource +```powershell +$SedPatch = Initialize-PSSailpoint.BetaSedPatch -Op replace ` + -Path status ` + -Value approved +``` + +- Convert the resource to JSON +```powershell +$SedPatch | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Segment.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Segment.md new file mode 100644 index 000000000..411627825 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Segment.md @@ -0,0 +1,49 @@ +--- +id: beta-segment +title: Segment +pagination_label: Segment +sidebar_label: Segment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Segment', 'BetaSegment'] +slug: /tools/sdk/powershell/beta/models/segment +tags: ['SDK', 'Software Development Kit', 'Segment', 'BetaSegment'] +--- + + +# Segment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The segment's ID. | [optional] +**Name** | Pointer to **String** | The segment's business name. | [optional] +**Created** | Pointer to **System.DateTime** | The time when the segment is created. | [optional] +**Modified** | Pointer to **System.DateTime** | The time when the segment is modified. | [optional] +**Description** | Pointer to **String** | The segment's optional description. | [optional] +**Owner** | Pointer to [**OwnerReferenceSegments**](owner-reference-segments) | | [optional] +**VisibilityCriteria** | Pointer to [**VisibilityCriteria**](visibility-criteria) | | [optional] +**Active** | Pointer to **Boolean** | This boolean indicates whether the segment is currently active. Inactive segments have no effect. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$Segment = Initialize-PSSailpoint.BetaSegment -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -Name segment-xyz ` + -Created 2020-01-01T00:00Z ` + -Modified 2020-01-01T00:00Z ` + -Description This segment represents xyz ` + -Owner null ` + -VisibilityCriteria null ` + -Active true +``` + +- Convert the resource to JSON +```powershell +$Segment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Selector.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Selector.md new file mode 100644 index 000000000..82f6a78bd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Selector.md @@ -0,0 +1,37 @@ +--- +id: beta-selector +title: Selector +pagination_label: Selector +sidebar_label: Selector +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Selector', 'BetaSelector'] +slug: /tools/sdk/powershell/beta/models/selector +tags: ['SDK', 'Software Development Kit', 'Selector', 'BetaSelector'] +--- + + +# Selector + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationId** | Pointer to **String** | The application id | [optional] +**AccountMatchConfig** | Pointer to [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Selector = Initialize-PSSailpoint.BetaSelector -ApplicationId 2c91808874ff91550175097daaec161c" ` + -AccountMatchConfig null +``` + +- Convert the resource to JSON +```powershell +$Selector | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SelectorAccountMatchConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SelectorAccountMatchConfig.md new file mode 100644 index 000000000..edccd37db --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SelectorAccountMatchConfig.md @@ -0,0 +1,35 @@ +--- +id: beta-selector-account-match-config +title: SelectorAccountMatchConfig +pagination_label: SelectorAccountMatchConfig +sidebar_label: SelectorAccountMatchConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SelectorAccountMatchConfig', 'BetaSelectorAccountMatchConfig'] +slug: /tools/sdk/powershell/beta/models/selector-account-match-config +tags: ['SDK', 'Software Development Kit', 'SelectorAccountMatchConfig', 'BetaSelectorAccountMatchConfig'] +--- + + +# SelectorAccountMatchConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MatchExpression** | Pointer to [**SelectorAccountMatchConfigMatchExpression**](selector-account-match-config-match-expression) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SelectorAccountMatchConfig = Initialize-PSSailpoint.BetaSelectorAccountMatchConfig -MatchExpression null +``` + +- Convert the resource to JSON +```powershell +$SelectorAccountMatchConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SelectorAccountMatchConfigMatchExpression.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SelectorAccountMatchConfigMatchExpression.md new file mode 100644 index 000000000..17508794b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SelectorAccountMatchConfigMatchExpression.md @@ -0,0 +1,37 @@ +--- +id: beta-selector-account-match-config-match-expression +title: SelectorAccountMatchConfigMatchExpression +pagination_label: SelectorAccountMatchConfigMatchExpression +sidebar_label: SelectorAccountMatchConfigMatchExpression +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SelectorAccountMatchConfigMatchExpression', 'BetaSelectorAccountMatchConfigMatchExpression'] +slug: /tools/sdk/powershell/beta/models/selector-account-match-config-match-expression +tags: ['SDK', 'Software Development Kit', 'SelectorAccountMatchConfigMatchExpression', 'BetaSelectorAccountMatchConfigMatchExpression'] +--- + + +# SelectorAccountMatchConfigMatchExpression + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MatchTerms** | Pointer to [**[]MatchTerm**](match-term) | | [optional] +**And** | Pointer to **Boolean** | If it is AND operators for match terms | [optional] [default to $true] + +## Examples + +- Prepare the resource +```powershell +$SelectorAccountMatchConfigMatchExpression = Initialize-PSSailpoint.BetaSelectorAccountMatchConfigMatchExpression -MatchTerms [{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}] ` + -And true +``` + +- Convert the resource to JSON +```powershell +$SelectorAccountMatchConfigMatchExpression | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SelfImportExportDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SelfImportExportDto.md new file mode 100644 index 000000000..03b038334 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SelfImportExportDto.md @@ -0,0 +1,39 @@ +--- +id: beta-self-import-export-dto +title: SelfImportExportDto +pagination_label: SelfImportExportDto +sidebar_label: SelfImportExportDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SelfImportExportDto', 'BetaSelfImportExportDto'] +slug: /tools/sdk/powershell/beta/models/self-import-export-dto +tags: ['SDK', 'Software Development Kit', 'SelfImportExportDto', 'BetaSelfImportExportDto'] +--- + + +# SelfImportExportDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "ACCESS_REQUEST_CONFIG", "ATTR_SYNC_SOURCE_CONFIG", "AUTH_ORG", "CAMPAIGN_FILTER", "FORM_DEFINITION", "GOVERNANCE_GROUP", "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "LIFECYCLE_STATE", "NOTIFICATION_TEMPLATE", "PASSWORD_POLICY", "PASSWORD_SYNC_GROUP", "PUBLIC_IDENTITIES_CONFIG", "ROLE", "RULE", "SEGMENT", "SERVICE_DESK_INTEGRATION", "SOD_POLICY", "SOURCE", "TAG", "TRANSFORM", "TRIGGER_SUBSCRIPTION", "WORKFLOW" ] | Imported/exported object's DTO type. Import is currently only possible with the IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. | [optional] +**Id** | Pointer to **String** | Imported/exported object's ID. | [optional] +**Name** | Pointer to **String** | Imported/exported object's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SelfImportExportDto = Initialize-PSSailpoint.BetaSelfImportExportDto -Type SOURCE ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name HR Active Directory +``` + +- Convert the resource to JSON +```powershell +$SelfImportExportDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SendAccountVerificationRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SendAccountVerificationRequest.md new file mode 100644 index 000000000..c3310fe9a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SendAccountVerificationRequest.md @@ -0,0 +1,37 @@ +--- +id: beta-send-account-verification-request +title: SendAccountVerificationRequest +pagination_label: SendAccountVerificationRequest +sidebar_label: SendAccountVerificationRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SendAccountVerificationRequest', 'BetaSendAccountVerificationRequest'] +slug: /tools/sdk/powershell/beta/models/send-account-verification-request +tags: ['SDK', 'Software Development Kit', 'SendAccountVerificationRequest', 'BetaSendAccountVerificationRequest'] +--- + + +# SendAccountVerificationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceName** | Pointer to **String** | The source name where identity account password should be reset | [optional] +**Via** | **Enum** [ "EMAIL_WORK", "EMAIL_PERSONAL", "LINK_WORK", "LINK_PERSONAL" ] | The method to send notification | [required] + +## Examples + +- Prepare the resource +```powershell +$SendAccountVerificationRequest = Initialize-PSSailpoint.BetaSendAccountVerificationRequest -SourceName Active Directory Source ` + -Via EMAIL_WORK +``` + +- Convert the resource to JSON +```powershell +$SendAccountVerificationRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SendTestNotificationRequestDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SendTestNotificationRequestDto.md new file mode 100644 index 000000000..977226da6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SendTestNotificationRequestDto.md @@ -0,0 +1,39 @@ +--- +id: beta-send-test-notification-request-dto +title: SendTestNotificationRequestDto +pagination_label: SendTestNotificationRequestDto +sidebar_label: SendTestNotificationRequestDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SendTestNotificationRequestDto', 'BetaSendTestNotificationRequestDto'] +slug: /tools/sdk/powershell/beta/models/send-test-notification-request-dto +tags: ['SDK', 'Software Development Kit', 'SendTestNotificationRequestDto', 'BetaSendTestNotificationRequestDto'] +--- + + +# SendTestNotificationRequestDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **String** | The template notification key. | [optional] +**Medium** | Pointer to **Enum** [ "EMAIL", "SLACK", "TEAMS" ] | The notification medium. Has to be one of the following enum values. | [optional] +**Context** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A Json object that denotes the context specific to the template. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SendTestNotificationRequestDto = Initialize-PSSailpoint.BetaSendTestNotificationRequestDto -Key cloud_manual_work_item_summary ` + -Medium null ` + -Context null +``` + +- Convert the resource to JSON +```powershell +$SendTestNotificationRequestDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SendTokenRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SendTokenRequest.md new file mode 100644 index 000000000..62e302fda --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SendTokenRequest.md @@ -0,0 +1,37 @@ +--- +id: beta-send-token-request +title: SendTokenRequest +pagination_label: SendTokenRequest +sidebar_label: SendTokenRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SendTokenRequest', 'BetaSendTokenRequest'] +slug: /tools/sdk/powershell/beta/models/send-token-request +tags: ['SDK', 'Software Development Kit', 'SendTokenRequest', 'BetaSendTokenRequest'] +--- + + +# SendTokenRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserAlias** | **String** | User alias from table spt_identity field named 'name' | [required] +**DeliveryType** | **Enum** [ "SMS_PERSONAL", "VOICE_PERSONAL", "SMS_WORK", "VOICE_WORK", "EMAIL_WORK", "EMAIL_PERSONAL" ] | Token delivery type | [required] + +## Examples + +- Prepare the resource +```powershell +$SendTokenRequest = Initialize-PSSailpoint.BetaSendTokenRequest -UserAlias will.albin ` + -DeliveryType EMAIL_WORK +``` + +- Convert the resource to JSON +```powershell +$SendTokenRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SendTokenResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SendTokenResponse.md new file mode 100644 index 000000000..72bb48bc0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SendTokenResponse.md @@ -0,0 +1,39 @@ +--- +id: beta-send-token-response +title: SendTokenResponse +pagination_label: SendTokenResponse +sidebar_label: SendTokenResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SendTokenResponse', 'BetaSendTokenResponse'] +slug: /tools/sdk/powershell/beta/models/send-token-response +tags: ['SDK', 'Software Development Kit', 'SendTokenResponse', 'BetaSendTokenResponse'] +--- + + +# SendTokenResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | Pointer to **String** | The token request ID | [optional] +**Status** | Pointer to **Enum** [ "SUCCESS", "FAILED" ] | Status of sending token | [optional] +**ErrorMessage** | Pointer to **String** | Error messages from token send request | [optional] + +## Examples + +- Prepare the resource +```powershell +$SendTokenResponse = Initialize-PSSailpoint.BetaSendTokenResponse -RequestId 089899f13a8f4da7824996191587bab9 ` + -Status SUCCESS ` + -ErrorMessage Unable to sent text message +``` + +- Convert the resource to JSON +```powershell +$SendTokenResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ServiceDeskIntegrationDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ServiceDeskIntegrationDto.md new file mode 100644 index 000000000..ff7fad207 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ServiceDeskIntegrationDto.md @@ -0,0 +1,53 @@ +--- +id: beta-service-desk-integration-dto +title: ServiceDeskIntegrationDto +pagination_label: ServiceDeskIntegrationDto +sidebar_label: ServiceDeskIntegrationDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskIntegrationDto', 'BetaServiceDeskIntegrationDto'] +slug: /tools/sdk/powershell/beta/models/service-desk-integration-dto +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationDto', 'BetaServiceDeskIntegrationDto'] +--- + + +# ServiceDeskIntegrationDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Service Desk integration's name. The name must be unique. | [required] +**Description** | **String** | Service Desk integration's description. | [required] +**Type** | **String** | Service Desk integration types: - ServiceNowSDIM - ServiceNow | [required][default to "ServiceNowSDIM"] +**OwnerRef** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**ClusterRef** | Pointer to [**SourceClusterDto**](source-cluster-dto) | | [optional] +**Cluster** | Pointer to **String** | Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). | [optional] +**ManagedSources** | Pointer to **[]String** | Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). | [optional] +**ProvisioningConfig** | Pointer to [**ProvisioningConfig**](provisioning-config) | | [optional] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Service Desk integration's attributes. Validation constraints enforced by the implementation. | [required] +**BeforeProvisioningRule** | Pointer to [**BeforeProvisioningRuleDto**](before-provisioning-rule-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ServiceDeskIntegrationDto = Initialize-PSSailpoint.BetaServiceDeskIntegrationDto -Name Service Desk Integration Name ` + -Description A very nice Service Desk integration ` + -Type ServiceNowSDIM ` + -OwnerRef null ` + -ClusterRef null ` + -Cluster xyzzy999 ` + -ManagedSources [2c9180835d191a86015d28455b4a2329, 2c5680835d191a85765d28455b4a9823] ` + -ProvisioningConfig null ` + -Attributes {property=value, key=value} ` + -BeforeProvisioningRule null +``` + +- Convert the resource to JSON +```powershell +$ServiceDeskIntegrationDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ServiceDeskIntegrationTemplateDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ServiceDeskIntegrationTemplateDto.md new file mode 100644 index 000000000..e450d5b4a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ServiceDeskIntegrationTemplateDto.md @@ -0,0 +1,47 @@ +--- +id: beta-service-desk-integration-template-dto +title: ServiceDeskIntegrationTemplateDto +pagination_label: ServiceDeskIntegrationTemplateDto +sidebar_label: ServiceDeskIntegrationTemplateDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskIntegrationTemplateDto', 'BetaServiceDeskIntegrationTemplateDto'] +slug: /tools/sdk/powershell/beta/models/service-desk-integration-template-dto +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationTemplateDto', 'BetaServiceDeskIntegrationTemplateDto'] +--- + + +# ServiceDeskIntegrationTemplateDto + +## Properties + +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] +**Type** | **String** | The 'type' property specifies the type of the Service Desk integration template. | [required][default to "Web Service SDIM"] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template. | [required] +**ProvisioningConfig** | [**ProvisioningConfig**](provisioning-config) | | [required] + +## Examples + +- Prepare the resource +```powershell +$ServiceDeskIntegrationTemplateDto = Initialize-PSSailpoint.BetaServiceDeskIntegrationTemplateDto -Id id12345 ` + -Name aName ` + -Created 2023-01-03T21:16:22.432Z ` + -Modified 2023-01-03T21:16:22.432Z ` + -Type Web Service SDIM ` + -Attributes null ` + -ProvisioningConfig null +``` + +- Convert the resource to JSON +```powershell +$ServiceDeskIntegrationTemplateDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ServiceDeskIntegrationTemplateType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ServiceDeskIntegrationTemplateType.md new file mode 100644 index 000000000..32f36e6ca --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ServiceDeskIntegrationTemplateType.md @@ -0,0 +1,39 @@ +--- +id: beta-service-desk-integration-template-type +title: ServiceDeskIntegrationTemplateType +pagination_label: ServiceDeskIntegrationTemplateType +sidebar_label: ServiceDeskIntegrationTemplateType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskIntegrationTemplateType', 'BetaServiceDeskIntegrationTemplateType'] +slug: /tools/sdk/powershell/beta/models/service-desk-integration-template-type +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationTemplateType', 'BetaServiceDeskIntegrationTemplateType'] +--- + + +# ServiceDeskIntegrationTemplateType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | This is the name of the type. | [optional] +**Type** | **String** | This is the type value for the type. | [required] +**ScriptName** | **String** | This is the scriptName attribute value for the type. | [required] + +## Examples + +- Prepare the resource +```powershell +$ServiceDeskIntegrationTemplateType = Initialize-PSSailpoint.BetaServiceDeskIntegrationTemplateType -Name aName ` + -Type aType ` + -ScriptName aScriptName +``` + +- Convert the resource to JSON +```powershell +$ServiceDeskIntegrationTemplateType | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ServiceDeskSource.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ServiceDeskSource.md new file mode 100644 index 000000000..b92d3dc53 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ServiceDeskSource.md @@ -0,0 +1,39 @@ +--- +id: beta-service-desk-source +title: ServiceDeskSource +pagination_label: ServiceDeskSource +sidebar_label: ServiceDeskSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskSource', 'BetaServiceDeskSource'] +slug: /tools/sdk/powershell/beta/models/service-desk-source +tags: ['SDK', 'Software Development Kit', 'ServiceDeskSource', 'BetaServiceDeskSource'] +--- + + +# ServiceDeskSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "SOURCE" ] | DTO type of source for service desk integration template. | [optional] +**Id** | Pointer to **String** | ID of source for service desk integration template. | [optional] +**Name** | Pointer to **String** | Human-readable name of source for service desk integration template. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ServiceDeskSource = Initialize-PSSailpoint.BetaServiceDeskSource -Type SOURCE ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name HR Active Directory +``` + +- Convert the resource to JSON +```powershell +$ServiceDeskSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SetIcon200Response.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SetIcon200Response.md new file mode 100644 index 000000000..66c2fadf3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SetIcon200Response.md @@ -0,0 +1,35 @@ +--- +id: beta-set-icon200-response +title: SetIcon200Response +pagination_label: SetIcon200Response +sidebar_label: SetIcon200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SetIcon200Response', 'BetaSetIcon200Response'] +slug: /tools/sdk/powershell/beta/models/set-icon200-response +tags: ['SDK', 'Software Development Kit', 'SetIcon200Response', 'BetaSetIcon200Response'] +--- + + +# SetIcon200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Icon** | Pointer to **String** | url to file with icon | [optional] + +## Examples + +- Prepare the resource +```powershell +$SetIcon200Response = Initialize-PSSailpoint.BetaSetIcon200Response -Icon +``` + +- Convert the resource to JSON +```powershell +$SetIcon200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SetIconRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SetIconRequest.md new file mode 100644 index 000000000..25e66c6e3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SetIconRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-set-icon-request +title: SetIconRequest +pagination_label: SetIconRequest +sidebar_label: SetIconRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SetIconRequest', 'BetaSetIconRequest'] +slug: /tools/sdk/powershell/beta/models/set-icon-request +tags: ['SDK', 'Software Development Kit', 'SetIconRequest', 'BetaSetIconRequest'] +--- + + +# SetIconRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Image** | **System.IO.FileInfo** | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] | [required] + +## Examples + +- Prepare the resource +```powershell +$SetIconRequest = Initialize-PSSailpoint.BetaSetIconRequest -Image \x00\x00\x00\x02 +``` + +- Convert the resource to JSON +```powershell +$SetIconRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SimIntegrationDetails.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SimIntegrationDetails.md new file mode 100644 index 000000000..02850d82b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SimIntegrationDetails.md @@ -0,0 +1,57 @@ +--- +id: beta-sim-integration-details +title: SimIntegrationDetails +pagination_label: SimIntegrationDetails +sidebar_label: SimIntegrationDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SimIntegrationDetails', 'BetaSimIntegrationDetails'] +slug: /tools/sdk/powershell/beta/models/sim-integration-details +tags: ['SDK', 'Software Development Kit', 'SimIntegrationDetails', 'BetaSimIntegrationDetails'] +--- + + +# SimIntegrationDetails + +## Properties + +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] +**Description** | Pointer to **String** | The description of the integration | [optional] +**Type** | Pointer to **String** | The integration type | [optional] +**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The attributes map containing the credentials used to configure the integration. | [optional] +**Sources** | Pointer to **[]String** | The list of sources (managed resources) | [optional] +**Cluster** | Pointer to **String** | The cluster/proxy | [optional] +**StatusMap** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Custom mapping between the integration result and the provisioning result | [optional] +**Request** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Request data to customize desc and body of the created ticket | [optional] +**BeforeProvisioningRule** | Pointer to [**SimIntegrationDetailsAllOfBeforeProvisioningRule**](sim-integration-details-all-of-before-provisioning-rule) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SimIntegrationDetails = Initialize-PSSailpoint.BetaSimIntegrationDetails -Id id12345 ` + -Name aName ` + -Created 2023-01-03T21:16:22.432Z ` + -Modified 2023-01-03T21:16:22.432Z ` + -Description Integration description ` + -Type ServiceNow Service Desk ` + -Attributes {"uid":"Walter White","firstname":"walter","cloudStatus":"UNREGISTERED","displayName":"Walter White","identificationNumber":"942","lastSyncDate":1470348809380,"email":"walter@gmail.com","lastname":"white"} ` + -Sources [2c9180835d191a86015d28455b4a2329, 2c5680835d191a85765d28455b4a9823] ` + -Cluster xyzzy999 ` + -StatusMap {closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued} ` + -Request {description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId} ` + -BeforeProvisioningRule null +``` + +- Convert the resource to JSON +```powershell +$SimIntegrationDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SimIntegrationDetailsAllOfBeforeProvisioningRule.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SimIntegrationDetailsAllOfBeforeProvisioningRule.md new file mode 100644 index 000000000..8bb59161e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SimIntegrationDetailsAllOfBeforeProvisioningRule.md @@ -0,0 +1,39 @@ +--- +id: beta-sim-integration-details-all-of-before-provisioning-rule +title: SimIntegrationDetailsAllOfBeforeProvisioningRule +pagination_label: SimIntegrationDetailsAllOfBeforeProvisioningRule +sidebar_label: SimIntegrationDetailsAllOfBeforeProvisioningRule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SimIntegrationDetailsAllOfBeforeProvisioningRule', 'BetaSimIntegrationDetailsAllOfBeforeProvisioningRule'] +slug: /tools/sdk/powershell/beta/models/sim-integration-details-all-of-before-provisioning-rule +tags: ['SDK', 'Software Development Kit', 'SimIntegrationDetailsAllOfBeforeProvisioningRule', 'BetaSimIntegrationDetailsAllOfBeforeProvisioningRule'] +--- + + +# SimIntegrationDetailsAllOfBeforeProvisioningRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **String** | ID of the rule | [optional] +**Name** | Pointer to **String** | Human-readable display name of the rule | [optional] + +## Examples + +- Prepare the resource +```powershell +$SimIntegrationDetailsAllOfBeforeProvisioningRule = Initialize-PSSailpoint.BetaSimIntegrationDetailsAllOfBeforeProvisioningRule -Type null ` + -Id 2c918085708c274401708c2a8a760001 ` + -Name Example Rule +``` + +- Convert the resource to JSON +```powershell +$SimIntegrationDetailsAllOfBeforeProvisioningRule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SlimDiscoveredApplications.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SlimDiscoveredApplications.md new file mode 100644 index 000000000..392bcf967 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SlimDiscoveredApplications.md @@ -0,0 +1,51 @@ +--- +id: beta-slim-discovered-applications +title: SlimDiscoveredApplications +pagination_label: SlimDiscoveredApplications +sidebar_label: SlimDiscoveredApplications +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SlimDiscoveredApplications', 'BetaSlimDiscoveredApplications'] +slug: /tools/sdk/powershell/beta/models/slim-discovered-applications +tags: ['SDK', 'Software Development Kit', 'SlimDiscoveredApplications', 'BetaSlimDiscoveredApplications'] +--- + + +# SlimDiscoveredApplications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Unique identifier for the discovered application. | [optional] +**Name** | Pointer to **String** | Name of the discovered application. | [optional] +**DiscoverySource** | Pointer to **String** | Source from which the application was discovered. | [optional] +**DiscoveredVendor** | Pointer to **String** | The vendor associated with the discovered application. | [optional] +**Description** | Pointer to **String** | A brief description of the discovered application. | [optional] +**RecommendedConnectors** | Pointer to **[]String** | List of recommended connectors for the application. | [optional] +**DiscoveredAt** | Pointer to **System.DateTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**CreatedAt** | Pointer to **System.DateTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**Status** | Pointer to **String** | The status of an application within the discovery source. By default this field is set to ""ACTIVE"" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to ""INACTIVE"". | [optional] + +## Examples + +- Prepare the resource +```powershell +$SlimDiscoveredApplications = Initialize-PSSailpoint.BetaSlimDiscoveredApplications -Id null ` + -Name ExampleApp ` + -DiscoverySource csv ` + -DiscoveredVendor ExampleVendor ` + -Description An application for managing examples. ` + -RecommendedConnectors [ConnectorA, ConnectorB] ` + -DiscoveredAt 2023-01-01T12:00Z ` + -CreatedAt 2023-01-01T12:00Z ` + -Status ACTIVE +``` + +- Convert the resource to JSON +```powershell +$SlimDiscoveredApplications | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Slimcampaign.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Slimcampaign.md new file mode 100644 index 000000000..98629c2db --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Slimcampaign.md @@ -0,0 +1,61 @@ +--- +id: beta-slimcampaign +title: Slimcampaign +pagination_label: Slimcampaign +sidebar_label: Slimcampaign +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Slimcampaign', 'BetaSlimcampaign'] +slug: /tools/sdk/powershell/beta/models/slimcampaign +tags: ['SDK', 'Software Development Kit', 'Slimcampaign', 'BetaSlimcampaign'] +--- + + +# Slimcampaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the campaign | [optional] [readonly] +**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Deadline** | Pointer to **System.DateTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required] +**EmailNotificationEnabled** | Pointer to **Boolean** | Enables email notification for this campaign | [optional] [default to $false] +**AutoRevokeAllowed** | Pointer to **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] +**RecommendationsEnabled** | Pointer to **Boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to $false] +**Status** | Pointer to **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **System.DateTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **Int32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$Slimcampaign = Initialize-PSSailpoint.BetaSlimcampaign -Id 2c9079b270a266a60170a2779fcb0007 ` + -Name Manager Campaign ` + -Description Everyone needs to be reviewed by their manager ` + -Deadline 2020-03-15T10:00:01.456Z ` + -Type MANAGER ` + -EmailNotificationEnabled false ` + -AutoRevokeAllowed false ` + -RecommendationsEnabled true ` + -Status ACTIVE ` + -CorrelatedStatus CORRELATED ` + -Created 2020-03-03T22:15:13.611Z ` + -TotalCertifications 100 ` + -CompletedCertifications 10 ` + -Alerts null +``` + +- Convert the resource to JSON +```powershell +$Slimcampaign | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodExemptCriteria.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodExemptCriteria.md new file mode 100644 index 000000000..d2dfc065c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodExemptCriteria.md @@ -0,0 +1,41 @@ +--- +id: beta-sod-exempt-criteria +title: SodExemptCriteria +pagination_label: SodExemptCriteria +sidebar_label: SodExemptCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodExemptCriteria', 'BetaSodExemptCriteria'] +slug: /tools/sdk/powershell/beta/models/sod-exempt-criteria +tags: ['SDK', 'Software Development Kit', 'SodExemptCriteria', 'BetaSodExemptCriteria'] +--- + + +# SodExemptCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Existing** | Pointer to **Boolean** | If the entitlement already belonged to the user or not. | [optional] [default to $false] +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **String** | Entitlement ID | [optional] +**Name** | Pointer to **String** | Entitlement name | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodExemptCriteria = Initialize-PSSailpoint.BetaSodExemptCriteria -Existing true ` + -Type null ` + -Id 2c918085771e9d3301773b3cb66f6398 ` + -Name My HR Entitlement +``` + +- Convert the resource to JSON +```powershell +$SodExemptCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodExemptCriteria1.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodExemptCriteria1.md new file mode 100644 index 000000000..91726d6d7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodExemptCriteria1.md @@ -0,0 +1,41 @@ +--- +id: beta-sod-exempt-criteria1 +title: SodExemptCriteria1 +pagination_label: SodExemptCriteria1 +sidebar_label: SodExemptCriteria1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodExemptCriteria1', 'BetaSodExemptCriteria1'] +slug: /tools/sdk/powershell/beta/models/sod-exempt-criteria1 +tags: ['SDK', 'Software Development Kit', 'SodExemptCriteria1', 'BetaSodExemptCriteria1'] +--- + + +# SodExemptCriteria1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Existing** | Pointer to **Boolean** | If the entitlement already belonged to the user or not. | [optional] [default to $false] +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **String** | Entitlement ID | [optional] +**Name** | Pointer to **String** | Entitlement name | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodExemptCriteria1 = Initialize-PSSailpoint.BetaSodExemptCriteria1 -Existing true ` + -Type null ` + -Id 2c918085771e9d3301773b3cb66f6398 ` + -Name My HR Entitlement +``` + +- Convert the resource to JSON +```powershell +$SodExemptCriteria1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodPolicy.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodPolicy.md new file mode 100644 index 000000000..46150fe23 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodPolicy.md @@ -0,0 +1,69 @@ +--- +id: beta-sod-policy +title: SodPolicy +pagination_label: SodPolicy +sidebar_label: SodPolicy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicy', 'BetaSodPolicy'] +slug: /tools/sdk/powershell/beta/models/sod-policy +tags: ['SDK', 'Software Development Kit', 'SodPolicy', 'BetaSodPolicy'] +--- + + +# SodPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Policy ID. | [optional] [readonly] +**Name** | Pointer to **String** | Policy business name. | [optional] +**Created** | Pointer to **System.DateTime** | The time when this SOD policy is created. | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | The time when this SOD policy is modified. | [optional] [readonly] +**Description** | Pointer to **String** | Optional description of the SOD policy. | [optional] +**OwnerRef** | Pointer to [**SodPolicyOwnerRef**](sod-policy-owner-ref) | | [optional] +**ExternalPolicyReference** | Pointer to **String** | Optional external policy reference. | [optional] +**PolicyQuery** | Pointer to **String** | Search query of the SOD policy. | [optional] +**CompensatingControls** | Pointer to **String** | Optional compensating controls (Mitigating Controls). | [optional] +**CorrectionAdvice** | Pointer to **String** | Optional correction advice. | [optional] +**State** | Pointer to **Enum** [ "ENFORCED", "NOT_ENFORCED" ] | Whether the policy is enforced or not. | [optional] +**Tags** | Pointer to **[]String** | Tags for the policy object. | [optional] +**CreatorId** | Pointer to **String** | Policy's creator ID. | [optional] [readonly] +**ModifierId** | Pointer to **String** | Policy's modifier ID. | [optional] [readonly] +**ViolationOwnerAssignmentConfig** | Pointer to [**ViolationOwnerAssignmentConfig**](violation-owner-assignment-config) | | [optional] +**Scheduled** | Pointer to **Boolean** | Defines whether a policy has been scheduled or not. | [optional] [default to $false] +**Type** | Pointer to **Enum** [ "GENERAL", "CONFLICTING_ACCESS_BASED" ] | Whether a policy is query based or conflicting access based. | [optional] [default to "GENERAL"] +**ConflictingAccessCriteria** | Pointer to [**SodPolicyConflictingAccessCriteria**](sod-policy-conflicting-access-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodPolicy = Initialize-PSSailpoint.BetaSodPolicy -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -Name policy-xyz ` + -Created 2020-01-01T00:00Z ` + -Modified 2020-01-01T00:00Z ` + -Description This policy ensures compliance of xyz ` + -OwnerRef null ` + -ExternalPolicyReference XYZ policy ` + -PolicyQuery @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf) ` + -CompensatingControls Have a manager review the transaction decisions for their "out of compliance" employee ` + -CorrectionAdvice Based on the role of the employee, managers should remove access that is not required for their job function. ` + -State ENFORCED ` + -Tags [TAG1, TAG2] ` + -CreatorId 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -ModifierId 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -ViolationOwnerAssignmentConfig null ` + -Scheduled true ` + -Type GENERAL ` + -ConflictingAccessCriteria null +``` + +- Convert the resource to JSON +```powershell +$SodPolicy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodPolicyConflictingAccessCriteria.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodPolicyConflictingAccessCriteria.md new file mode 100644 index 000000000..7602ee587 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodPolicyConflictingAccessCriteria.md @@ -0,0 +1,37 @@ +--- +id: beta-sod-policy-conflicting-access-criteria +title: SodPolicyConflictingAccessCriteria +pagination_label: SodPolicyConflictingAccessCriteria +sidebar_label: SodPolicyConflictingAccessCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicyConflictingAccessCriteria', 'BetaSodPolicyConflictingAccessCriteria'] +slug: /tools/sdk/powershell/beta/models/sod-policy-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodPolicyConflictingAccessCriteria', 'BetaSodPolicyConflictingAccessCriteria'] +--- + + +# SodPolicyConflictingAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] +**RightCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodPolicyConflictingAccessCriteria = Initialize-PSSailpoint.BetaSodPolicyConflictingAccessCriteria -LeftCriteria null ` + -RightCriteria null +``` + +- Convert the resource to JSON +```powershell +$SodPolicyConflictingAccessCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodPolicyDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodPolicyDto.md new file mode 100644 index 000000000..0ae64b6a2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodPolicyDto.md @@ -0,0 +1,39 @@ +--- +id: beta-sod-policy-dto +title: SodPolicyDto +pagination_label: SodPolicyDto +sidebar_label: SodPolicyDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicyDto', 'BetaSodPolicyDto'] +slug: /tools/sdk/powershell/beta/models/sod-policy-dto +tags: ['SDK', 'Software Development Kit', 'SodPolicyDto', 'BetaSodPolicyDto'] +--- + + +# SodPolicyDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "SOD_POLICY" ] | SOD policy DTO type. | [optional] +**Id** | Pointer to **String** | SOD policy ID. | [optional] +**Name** | Pointer to **String** | SOD policy display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodPolicyDto = Initialize-PSSailpoint.BetaSodPolicyDto -Type SOD_POLICY ` + -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -Name Business SOD Policy +``` + +- Convert the resource to JSON +```powershell +$SodPolicyDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodPolicyOwnerRef.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodPolicyOwnerRef.md new file mode 100644 index 000000000..decec2304 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodPolicyOwnerRef.md @@ -0,0 +1,39 @@ +--- +id: beta-sod-policy-owner-ref +title: SodPolicyOwnerRef +pagination_label: SodPolicyOwnerRef +sidebar_label: SodPolicyOwnerRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicyOwnerRef', 'BetaSodPolicyOwnerRef'] +slug: /tools/sdk/powershell/beta/models/sod-policy-owner-ref +tags: ['SDK', 'Software Development Kit', 'SodPolicyOwnerRef', 'BetaSodPolicyOwnerRef'] +--- + + +# SodPolicyOwnerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY", "GOVERNANCE_GROUP" ] | Owner type. | [optional] +**Id** | Pointer to **String** | Owner's ID. | [optional] +**Name** | Pointer to **String** | Owner's name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodPolicyOwnerRef = Initialize-PSSailpoint.BetaSodPolicyOwnerRef -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Support +``` + +- Convert the resource to JSON +```powershell +$SodPolicyOwnerRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodPolicySchedule.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodPolicySchedule.md new file mode 100644 index 000000000..523370635 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodPolicySchedule.md @@ -0,0 +1,51 @@ +--- +id: beta-sod-policy-schedule +title: SodPolicySchedule +pagination_label: SodPolicySchedule +sidebar_label: SodPolicySchedule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicySchedule', 'BetaSodPolicySchedule'] +slug: /tools/sdk/powershell/beta/models/sod-policy-schedule +tags: ['SDK', 'Software Development Kit', 'SodPolicySchedule', 'BetaSodPolicySchedule'] +--- + + +# SodPolicySchedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | SOD Policy schedule name | [optional] +**Created** | Pointer to **System.DateTime** | The time when this SOD policy schedule is created. | [optional] +**Modified** | Pointer to **System.DateTime** | The time when this SOD policy schedule is modified. | [optional] +**Description** | Pointer to **String** | SOD Policy schedule description | [optional] +**Schedule** | Pointer to [**Schedule1**](schedule1) | | [optional] +**Recipients** | Pointer to [**[]SodRecipient**](sod-recipient) | | [optional] +**EmailEmptyResults** | Pointer to **Boolean** | Indicates if empty results need to be emailed | [optional] +**CreatorId** | Pointer to **String** | Policy's creator ID | [optional] +**ModifierId** | Pointer to **String** | Policy's modifier ID | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodPolicySchedule = Initialize-PSSailpoint.BetaSodPolicySchedule -Name SCH-1584312283015 ` + -Created 2020-01-01T00:00Z ` + -Modified 2020-01-01T00:00Z ` + -Description Schedule for policy xyz ` + -Schedule null ` + -Recipients null ` + -EmailEmptyResults false ` + -CreatorId 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -ModifierId 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde +``` + +- Convert the resource to JSON +```powershell +$SodPolicySchedule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodRecipient.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodRecipient.md new file mode 100644 index 000000000..a69413578 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodRecipient.md @@ -0,0 +1,39 @@ +--- +id: beta-sod-recipient +title: SodRecipient +pagination_label: SodRecipient +sidebar_label: SodRecipient +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodRecipient', 'BetaSodRecipient'] +slug: /tools/sdk/powershell/beta/models/sod-recipient +tags: ['SDK', 'Software Development Kit', 'SodRecipient', 'BetaSodRecipient'] +--- + + +# SodRecipient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | SOD policy recipient DTO type. | [optional] +**Id** | Pointer to **String** | SOD policy recipient's identity ID. | [optional] +**Name** | Pointer to **String** | SOD policy recipient's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodRecipient = Initialize-PSSailpoint.BetaSodRecipient -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$SodRecipient | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodReportResultDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodReportResultDto.md new file mode 100644 index 000000000..ab6cab4eb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodReportResultDto.md @@ -0,0 +1,39 @@ +--- +id: beta-sod-report-result-dto +title: SodReportResultDto +pagination_label: SodReportResultDto +sidebar_label: SodReportResultDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodReportResultDto', 'BetaSodReportResultDto'] +slug: /tools/sdk/powershell/beta/models/sod-report-result-dto +tags: ['SDK', 'Software Development Kit', 'SodReportResultDto', 'BetaSodReportResultDto'] +--- + + +# SodReportResultDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "REPORT_RESULT" ] | SOD policy violation report result DTO type. | [optional] +**Id** | Pointer to **String** | SOD policy violation report result ID. | [optional] +**Name** | Pointer to **String** | Human-readable name of the SOD policy violation report result. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodReportResultDto = Initialize-PSSailpoint.BetaSodReportResultDto -Type REPORT_RESULT ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name SOD Policy 1 Violation +``` + +- Convert the resource to JSON +```powershell +$SodReportResultDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationCheckResult.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationCheckResult.md new file mode 100644 index 000000000..be78c7a0f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationCheckResult.md @@ -0,0 +1,41 @@ +--- +id: beta-sod-violation-check-result +title: SodViolationCheckResult +pagination_label: SodViolationCheckResult +sidebar_label: SodViolationCheckResult +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationCheckResult', 'BetaSodViolationCheckResult'] +slug: /tools/sdk/powershell/beta/models/sod-violation-check-result +tags: ['SDK', 'Software Development Kit', 'SodViolationCheckResult', 'BetaSodViolationCheckResult'] +--- + + +# SodViolationCheckResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to [**ErrorMessageDto**](error-message-dto) | | [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 completion of the violation check. | [optional] +**ViolationContexts** | Pointer to [**[]SodViolationContext**](sod-violation-context) | | [optional] +**ViolatedPolicies** | Pointer to [**[]SodPolicyDto**](sod-policy-dto) | A list of the SOD policies that were violated. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationCheckResult = Initialize-PSSailpoint.BetaSodViolationCheckResult -Message null ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -ViolationContexts null ` + -ViolatedPolicies null +``` + +- Convert the resource to JSON +```powershell +$SodViolationCheckResult | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationCheckResult1.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationCheckResult1.md new file mode 100644 index 000000000..7caa71c53 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationCheckResult1.md @@ -0,0 +1,41 @@ +--- +id: beta-sod-violation-check-result1 +title: SodViolationCheckResult1 +pagination_label: SodViolationCheckResult1 +sidebar_label: SodViolationCheckResult1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationCheckResult1', 'BetaSodViolationCheckResult1'] +slug: /tools/sdk/powershell/beta/models/sod-violation-check-result1 +tags: ['SDK', 'Software Development Kit', 'SodViolationCheckResult1', 'BetaSodViolationCheckResult1'] +--- + + +# SodViolationCheckResult1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to [**ErrorMessageDto**](error-message-dto) | | [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 completion of the violation check. | [optional] +**ViolationContexts** | Pointer to [**[]SodViolationContext1**](sod-violation-context1) | | [optional] +**ViolatedPolicies** | Pointer to [**[]SodPolicyDto**](sod-policy-dto) | A list of the Policies that were violated. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationCheckResult1 = Initialize-PSSailpoint.BetaSodViolationCheckResult1 -Message null ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -ViolationContexts null ` + -ViolatedPolicies null +``` + +- Convert the resource to JSON +```powershell +$SodViolationCheckResult1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationContext.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationContext.md new file mode 100644 index 000000000..5e23a5a51 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationContext.md @@ -0,0 +1,37 @@ +--- +id: beta-sod-violation-context +title: SodViolationContext +pagination_label: SodViolationContext +sidebar_label: SodViolationContext +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContext', 'BetaSodViolationContext'] +slug: /tools/sdk/powershell/beta/models/sod-violation-context +tags: ['SDK', 'Software Development Kit', 'SodViolationContext', 'BetaSodViolationContext'] +--- + + +# SodViolationContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policy** | Pointer to [**SodPolicyDto**](sod-policy-dto) | | [optional] +**ConflictingAccessCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteria**](sod-violation-context-conflicting-access-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationContext = Initialize-PSSailpoint.BetaSodViolationContext -Policy null ` + -ConflictingAccessCriteria null +``` + +- Convert the resource to JSON +```powershell +$SodViolationContext | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationContext1.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationContext1.md new file mode 100644 index 000000000..c053a75ca --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationContext1.md @@ -0,0 +1,37 @@ +--- +id: beta-sod-violation-context1 +title: SodViolationContext1 +pagination_label: SodViolationContext1 +sidebar_label: SodViolationContext1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContext1', 'BetaSodViolationContext1'] +slug: /tools/sdk/powershell/beta/models/sod-violation-context1 +tags: ['SDK', 'Software Development Kit', 'SodViolationContext1', 'BetaSodViolationContext1'] +--- + + +# SodViolationContext1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policy** | Pointer to [**SodPolicyDto**](sod-policy-dto) | | [optional] +**ConflictingAccessCriteria** | Pointer to [**SodViolationContext1ConflictingAccessCriteria**](sod-violation-context1-conflicting-access-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationContext1 = Initialize-PSSailpoint.BetaSodViolationContext1 -Policy null ` + -ConflictingAccessCriteria null +``` + +- Convert the resource to JSON +```powershell +$SodViolationContext1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationContext1ConflictingAccessCriteria.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationContext1ConflictingAccessCriteria.md new file mode 100644 index 000000000..beb977e32 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationContext1ConflictingAccessCriteria.md @@ -0,0 +1,37 @@ +--- +id: beta-sod-violation-context1-conflicting-access-criteria +title: SodViolationContext1ConflictingAccessCriteria +pagination_label: SodViolationContext1ConflictingAccessCriteria +sidebar_label: SodViolationContext1ConflictingAccessCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContext1ConflictingAccessCriteria', 'BetaSodViolationContext1ConflictingAccessCriteria'] +slug: /tools/sdk/powershell/beta/models/sod-violation-context1-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContext1ConflictingAccessCriteria', 'BetaSodViolationContext1ConflictingAccessCriteria'] +--- + + +# SodViolationContext1ConflictingAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**SodViolationContext1ConflictingAccessCriteriaLeftCriteria**](sod-violation-context1-conflicting-access-criteria-left-criteria) | | [optional] +**RightCriteria** | Pointer to [**SodViolationContext1ConflictingAccessCriteriaLeftCriteria**](sod-violation-context1-conflicting-access-criteria-left-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationContext1ConflictingAccessCriteria = Initialize-PSSailpoint.BetaSodViolationContext1ConflictingAccessCriteria -LeftCriteria null ` + -RightCriteria null +``` + +- Convert the resource to JSON +```powershell +$SodViolationContext1ConflictingAccessCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationContext1ConflictingAccessCriteriaLeftCriteria.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationContext1ConflictingAccessCriteriaLeftCriteria.md new file mode 100644 index 000000000..1b4a2d9ae --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationContext1ConflictingAccessCriteriaLeftCriteria.md @@ -0,0 +1,35 @@ +--- +id: beta-sod-violation-context1-conflicting-access-criteria-left-criteria +title: SodViolationContext1ConflictingAccessCriteriaLeftCriteria +pagination_label: SodViolationContext1ConflictingAccessCriteriaLeftCriteria +sidebar_label: SodViolationContext1ConflictingAccessCriteriaLeftCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContext1ConflictingAccessCriteriaLeftCriteria', 'BetaSodViolationContext1ConflictingAccessCriteriaLeftCriteria'] +slug: /tools/sdk/powershell/beta/models/sod-violation-context1-conflicting-access-criteria-left-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContext1ConflictingAccessCriteriaLeftCriteria', 'BetaSodViolationContext1ConflictingAccessCriteriaLeftCriteria'] +--- + + +# SodViolationContext1ConflictingAccessCriteriaLeftCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CriteriaList** | Pointer to [**[]SodExemptCriteria1**](sod-exempt-criteria1) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationContext1ConflictingAccessCriteriaLeftCriteria = Initialize-PSSailpoint.BetaSodViolationContext1ConflictingAccessCriteriaLeftCriteria -CriteriaList null +``` + +- Convert the resource to JSON +```powershell +$SodViolationContext1ConflictingAccessCriteriaLeftCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationContextCheckCompleted.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationContextCheckCompleted.md new file mode 100644 index 000000000..03c74d3e0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationContextCheckCompleted.md @@ -0,0 +1,39 @@ +--- +id: beta-sod-violation-context-check-completed +title: SodViolationContextCheckCompleted +pagination_label: SodViolationContextCheckCompleted +sidebar_label: SodViolationContextCheckCompleted +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContextCheckCompleted', 'BetaSodViolationContextCheckCompleted'] +slug: /tools/sdk/powershell/beta/models/sod-violation-context-check-completed +tags: ['SDK', 'Software Development Kit', 'SodViolationContextCheckCompleted', 'BetaSodViolationContextCheckCompleted'] +--- + + +# SodViolationContextCheckCompleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **Enum** [ "SUCCESS", "ERROR" ] | The status of SOD violation check | [optional] +**Uuid** | Pointer to **String** | The id of the Violation check event | [optional] +**ViolationCheckResult** | Pointer to [**SodViolationCheckResult**](sod-violation-check-result) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationContextCheckCompleted = Initialize-PSSailpoint.BetaSodViolationContextCheckCompleted -State SUCCESS ` + -Uuid f73d16e9-a038-46c5-b217-1246e15fdbdd ` + -ViolationCheckResult null +``` + +- Convert the resource to JSON +```powershell +$SodViolationContextCheckCompleted | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationContextCheckCompleted1.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationContextCheckCompleted1.md new file mode 100644 index 000000000..0e7f69030 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationContextCheckCompleted1.md @@ -0,0 +1,39 @@ +--- +id: beta-sod-violation-context-check-completed1 +title: SodViolationContextCheckCompleted1 +pagination_label: SodViolationContextCheckCompleted1 +sidebar_label: SodViolationContextCheckCompleted1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContextCheckCompleted1', 'BetaSodViolationContextCheckCompleted1'] +slug: /tools/sdk/powershell/beta/models/sod-violation-context-check-completed1 +tags: ['SDK', 'Software Development Kit', 'SodViolationContextCheckCompleted1', 'BetaSodViolationContextCheckCompleted1'] +--- + + +# SodViolationContextCheckCompleted1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **Enum** [ "SUCCESS", "ERROR" ] | The status of SOD violation check | [optional] +**Uuid** | Pointer to **String** | The id of the Violation check event | [optional] +**ViolationCheckResult** | Pointer to [**SodViolationCheckResult1**](sod-violation-check-result1) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationContextCheckCompleted1 = Initialize-PSSailpoint.BetaSodViolationContextCheckCompleted1 -State SUCCESS ` + -Uuid f73d16e9-a038-46c5-b217-1246e15fdbdd ` + -ViolationCheckResult null +``` + +- Convert the resource to JSON +```powershell +$SodViolationContextCheckCompleted1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationContextConflictingAccessCriteria.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationContextConflictingAccessCriteria.md new file mode 100644 index 000000000..8e759256c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationContextConflictingAccessCriteria.md @@ -0,0 +1,37 @@ +--- +id: beta-sod-violation-context-conflicting-access-criteria +title: SodViolationContextConflictingAccessCriteria +pagination_label: SodViolationContextConflictingAccessCriteria +sidebar_label: SodViolationContextConflictingAccessCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContextConflictingAccessCriteria', 'BetaSodViolationContextConflictingAccessCriteria'] +slug: /tools/sdk/powershell/beta/models/sod-violation-context-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContextConflictingAccessCriteria', 'BetaSodViolationContextConflictingAccessCriteria'] +--- + + +# SodViolationContextConflictingAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteriaLeftCriteria**](sod-violation-context-conflicting-access-criteria-left-criteria) | | [optional] +**RightCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteriaLeftCriteria**](sod-violation-context-conflicting-access-criteria-left-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationContextConflictingAccessCriteria = Initialize-PSSailpoint.BetaSodViolationContextConflictingAccessCriteria -LeftCriteria null ` + -RightCriteria null +``` + +- Convert the resource to JSON +```powershell +$SodViolationContextConflictingAccessCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md new file mode 100644 index 000000000..e882b3adb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md @@ -0,0 +1,35 @@ +--- +id: beta-sod-violation-context-conflicting-access-criteria-left-criteria +title: SodViolationContextConflictingAccessCriteriaLeftCriteria +pagination_label: SodViolationContextConflictingAccessCriteriaLeftCriteria +sidebar_label: SodViolationContextConflictingAccessCriteriaLeftCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContextConflictingAccessCriteriaLeftCriteria', 'BetaSodViolationContextConflictingAccessCriteriaLeftCriteria'] +slug: /tools/sdk/powershell/beta/models/sod-violation-context-conflicting-access-criteria-left-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContextConflictingAccessCriteriaLeftCriteria', 'BetaSodViolationContextConflictingAccessCriteriaLeftCriteria'] +--- + + +# SodViolationContextConflictingAccessCriteriaLeftCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CriteriaList** | Pointer to [**[]SodExemptCriteria**](sod-exempt-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationContextConflictingAccessCriteriaLeftCriteria = Initialize-PSSailpoint.BetaSodViolationContextConflictingAccessCriteriaLeftCriteria -CriteriaList null +``` + +- Convert the resource to JSON +```powershell +$SodViolationContextConflictingAccessCriteriaLeftCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Source.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Source.md new file mode 100644 index 000000000..04f8e4017 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Source.md @@ -0,0 +1,95 @@ +--- +id: beta-source +title: Source +pagination_label: Source +sidebar_label: Source +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Source', 'BetaSource'] +slug: /tools/sdk/powershell/beta/models/source +tags: ['SDK', 'Software Development Kit', 'Source', 'BetaSource'] +--- + + +# Source + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Source ID. | [optional] [readonly] +**Name** | **String** | Source's human-readable name. | [required] +**Description** | Pointer to **String** | Source's human-readable description. | [optional] +**Owner** | [**MultiHostIntegrationsOwner**](multi-host-integrations-owner) | | [required] +**Cluster** | Pointer to [**MultiHostIntegrationsCluster**](multi-host-integrations-cluster) | | [optional] +**AccountCorrelationConfig** | Pointer to [**MultiHostSourcesAccountCorrelationConfig**](multi-host-sources-account-correlation-config) | | [optional] +**AccountCorrelationRule** | Pointer to [**MultiHostSourcesAccountCorrelationRule**](multi-host-sources-account-correlation-rule) | | [optional] +**ManagerCorrelationMapping** | Pointer to [**ManagerCorrelationMapping**](manager-correlation-mapping) | | [optional] +**ManagerCorrelationRule** | Pointer to [**MultiHostSourcesManagerCorrelationRule**](multi-host-sources-manager-correlation-rule) | | [optional] +**BeforeProvisioningRule** | Pointer to [**MultiHostSourcesBeforeProvisioningRule**](multi-host-sources-before-provisioning-rule) | | [optional] +**Schemas** | Pointer to [**[]MultiHostSourcesSchemasInner**](multi-host-sources-schemas-inner) | List of references to schema objects. | [optional] +**PasswordPolicies** | Pointer to [**[]MultiHostSourcesPasswordPoliciesInner**](multi-host-sources-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional] +**Features** | Pointer to **[]String** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**Type** | Pointer to **String** | Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional] +**Connector** | **String** | Connector script name. | [required] +**ConnectorClass** | Pointer to **String** | Fully qualified name of the Java class that implements the connector interface. | [optional] +**ConnectorAttributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Connector specific configuration. This configuration will differ from type to type. | [optional] +**DeleteThreshold** | Pointer to **Int32** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional] +**Authoritative** | Pointer to **Boolean** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to $false] +**ManagementWorkgroup** | Pointer to [**MultiHostIntegrationsManagementWorkgroup**](multi-host-integrations-management-workgroup) | | [optional] +**Healthy** | Pointer to **Boolean** | When this is true, it indicates that the source is healthy. | [optional] [default to $false] +**Status** | Pointer to **Enum** [ "SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT", "SOURCE_STATE_ERROR_CLUSTER", "SOURCE_STATE_ERROR_SOURCE", "SOURCE_STATE_ERROR_VA", "SOURCE_STATE_FAILURE_CLUSTER", "SOURCE_STATE_FAILURE_SOURCE", "SOURCE_STATE_HEALTHY", "SOURCE_STATE_UNCHECKED_CLUSTER", "SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES", "SOURCE_STATE_UNCHECKED_SOURCE", "SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS" ] | Status identifier that gives specific information about why a source is or isn't healthy. | [optional] +**Since** | Pointer to **String** | Timestamp that shows when a source health check was last performed. | [optional] +**ConnectorId** | Pointer to **String** | Connector ID | [optional] +**ConnectorName** | Pointer to **String** | Name of the connector that was chosen during source creation. | [optional] +**ConnectionType** | Pointer to **String** | Type of connection (direct or file). | [optional] +**ConnectorImplementationId** | Pointer to **String** | Connector implementation ID. | [optional] +**Created** | Pointer to **System.DateTime** | Date-time when the source was created | [optional] +**Modified** | Pointer to **System.DateTime** | Date-time when the source was last modified. | [optional] +**CredentialProviderEnabled** | Pointer to **Boolean** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to $false] +**Category** | Pointer to **String** | Source category (e.g. null, CredentialProvider). | [optional] + +## Examples + +- Prepare the resource +```powershell +$Source = Initialize-PSSailpoint.BetaSource -Id 2c91808568c529c60168cca6f90c1324 ` + -Name My Source ` + -Description This is the corporate directory. ` + -Owner null ` + -Cluster null ` + -AccountCorrelationConfig null ` + -AccountCorrelationRule null ` + -ManagerCorrelationMapping null ` + -ManagerCorrelationRule null ` + -BeforeProvisioningRule null ` + -Schemas [{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}] ` + -PasswordPolicies [{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}] ` + -Features [PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS] ` + -Type OpenLDAP - Direct ` + -Connector active-directory ` + -ConnectorClass sailpoint.connector.LDAPConnector ` + -ConnectorAttributes {healthCheckTimeout=30, authSearchAttributes=[cn, uid, mail]} ` + -DeleteThreshold 10 ` + -Authoritative false ` + -ManagementWorkgroup null ` + -Healthy true ` + -Status SOURCE_STATE_HEALTHY ` + -Since 2021-09-28T15:48:29.3801666300Z ` + -ConnectorId active-directory ` + -ConnectorName Active Directory ` + -ConnectionType file ` + -ConnectorImplementationId delimited-file ` + -Created 2022-02-08T14:50:03.827Z ` + -Modified 2024-01-23T18:08:50.897Z ` + -CredentialProviderEnabled false ` + -Category CredentialProvider +``` + +- Convert the resource to JSON +```powershell +$Source | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Source1.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Source1.md new file mode 100644 index 000000000..8ced5b4c4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Source1.md @@ -0,0 +1,37 @@ +--- +id: beta-source1 +title: Source1 +pagination_label: Source1 +sidebar_label: Source1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Source1', 'BetaSource1'] +slug: /tools/sdk/powershell/beta/models/source1 +tags: ['SDK', 'Software Development Kit', 'Source1', 'BetaSource1'] +--- + + +# Source1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **String** | Attribute mapping type. | [optional] +**Properties** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Attribute mapping properties. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Source1 = Initialize-PSSailpoint.BetaSource1 -Type rule ` + -Properties {ruleType=IdentityAttribute, ruleName=Cloud Promote Identity Attribute} +``` + +- Convert the resource to JSON +```powershell +$Source1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceAccountCreated.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceAccountCreated.md new file mode 100644 index 000000000..a514f6f17 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceAccountCreated.md @@ -0,0 +1,49 @@ +--- +id: beta-source-account-created +title: SourceAccountCreated +pagination_label: SourceAccountCreated +sidebar_label: SourceAccountCreated +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAccountCreated', 'BetaSourceAccountCreated'] +slug: /tools/sdk/powershell/beta/models/source-account-created +tags: ['SDK', 'Software Development Kit', 'SourceAccountCreated', 'BetaSourceAccountCreated'] +--- + + +# SourceAccountCreated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Uuid** | Pointer to **String** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] +**Id** | **String** | SailPoint generated unique identifier. | [required] +**NativeIdentifier** | **String** | Unique ID of the account on the source. | [required] +**SourceId** | **String** | The ID of the source. | [required] +**SourceName** | **String** | The name of the source. | [required] +**IdentityId** | **String** | The ID of the identity that is correlated with this account. | [required] +**IdentityName** | **String** | The name of the identity that is correlated with this account. | [required] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceAccountCreated = Initialize-PSSailpoint.BetaSourceAccountCreated -Uuid b7264868-7201-415f-9118-b581d431c688 ` + -Id ee769173319b41d19ccec35ba52f237b ` + -NativeIdentifier E009 ` + -SourceId 2c918082814e693601816e09471b29b6 ` + -SourceName Active Directory ` + -IdentityId ee769173319b41d19ccec6c235423237b ` + -IdentityName john.doe ` + -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} +``` + +- Convert the resource to JSON +```powershell +$SourceAccountCreated | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceAccountDeleted.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceAccountDeleted.md new file mode 100644 index 000000000..af10b0aca --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceAccountDeleted.md @@ -0,0 +1,49 @@ +--- +id: beta-source-account-deleted +title: SourceAccountDeleted +pagination_label: SourceAccountDeleted +sidebar_label: SourceAccountDeleted +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAccountDeleted', 'BetaSourceAccountDeleted'] +slug: /tools/sdk/powershell/beta/models/source-account-deleted +tags: ['SDK', 'Software Development Kit', 'SourceAccountDeleted', 'BetaSourceAccountDeleted'] +--- + + +# SourceAccountDeleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Uuid** | Pointer to **String** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] +**Id** | **String** | SailPoint generated unique identifier. | [required] +**NativeIdentifier** | **String** | Unique ID of the account on the source. | [required] +**SourceId** | **String** | The ID of the source. | [required] +**SourceName** | **String** | The name of the source. | [required] +**IdentityId** | **String** | The ID of the identity that is correlated with this account. | [required] +**IdentityName** | **String** | The name of the identity that is correlated with this account. | [required] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceAccountDeleted = Initialize-PSSailpoint.BetaSourceAccountDeleted -Uuid b7264868-7201-415f-9118-b581d431c688 ` + -Id ee769173319b41d19ccec35ba52f237b ` + -NativeIdentifier E009 ` + -SourceId 2c918082814e693601816e09471b29b6 ` + -SourceName Active Directory ` + -IdentityId ee769173319b41d19ccec6c235423237b ` + -IdentityName john.doe ` + -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} +``` + +- Convert the resource to JSON +```powershell +$SourceAccountDeleted | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceAccountUpdated.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceAccountUpdated.md new file mode 100644 index 000000000..35d0250a6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceAccountUpdated.md @@ -0,0 +1,49 @@ +--- +id: beta-source-account-updated +title: SourceAccountUpdated +pagination_label: SourceAccountUpdated +sidebar_label: SourceAccountUpdated +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAccountUpdated', 'BetaSourceAccountUpdated'] +slug: /tools/sdk/powershell/beta/models/source-account-updated +tags: ['SDK', 'Software Development Kit', 'SourceAccountUpdated', 'BetaSourceAccountUpdated'] +--- + + +# SourceAccountUpdated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Uuid** | Pointer to **String** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] +**Id** | **String** | SailPoint generated unique identifier. | [required] +**NativeIdentifier** | **String** | Unique ID of the account on the source. | [required] +**SourceId** | **String** | The ID of the source. | [required] +**SourceName** | **String** | The name of the source. | [required] +**IdentityId** | **String** | The ID of the identity that is correlated with this account. | [required] +**IdentityName** | **String** | The name of the identity that is correlated with this account. | [required] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceAccountUpdated = Initialize-PSSailpoint.BetaSourceAccountUpdated -Uuid b7264868-7201-415f-9118-b581d431c688 ` + -Id ee769173319b41d19ccec35ba52f237b ` + -NativeIdentifier E009 ` + -SourceId 2c918082814e693601816e09471b29b6 ` + -SourceName Active Directory ` + -IdentityId ee769173319b41d19ccec6c235423237b ` + -IdentityName john.doe ` + -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} +``` + +- Convert the resource to JSON +```powershell +$SourceAccountUpdated | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceApp.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceApp.md new file mode 100644 index 000000000..7a7a3bb57 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceApp.md @@ -0,0 +1,57 @@ +--- +id: beta-source-app +title: SourceApp +pagination_label: SourceApp +sidebar_label: SourceApp +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceApp', 'BetaSourceApp'] +slug: /tools/sdk/powershell/beta/models/source-app +tags: ['SDK', 'Software Development Kit', 'SourceApp', 'BetaSourceApp'] +--- + + +# SourceApp + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The source app id | [optional] +**CloudAppId** | Pointer to **String** | The deprecated source app id | [optional] +**Name** | Pointer to **String** | The source app name | [optional] +**Created** | Pointer to **System.DateTime** | Time when the source app was created | [optional] +**Modified** | Pointer to **System.DateTime** | Time when the source app was last modified | [optional] +**Enabled** | Pointer to **Boolean** | True if the source app is enabled | [optional] [default to $false] +**ProvisionRequestEnabled** | Pointer to **Boolean** | True if the source app is provision request enabled | [optional] [default to $false] +**Description** | Pointer to **String** | The description of the source app | [optional] +**MatchAllAccounts** | Pointer to **Boolean** | True if the source app match all accounts | [optional] [default to $false] +**AppCenterEnabled** | Pointer to **Boolean** | True if the source app is shown in the app center | [optional] [default to $true] +**AccountSource** | Pointer to [**SourceAppAccountSource**](source-app-account-source) | | [optional] +**Owner** | Pointer to [**BaseReferenceDto**](base-reference-dto) | The owner of source app | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceApp = Initialize-PSSailpoint.BetaSourceApp -Id 2c91808874ff91550175097daaec161c ` + -CloudAppId 9854520 ` + -Name my app ` + -Created 2020-10-08T18:33:52.029Z ` + -Modified 2020-10-08T18:33:52.029Z ` + -Enabled true ` + -ProvisionRequestEnabled true ` + -Description the source app for engineers ` + -MatchAllAccounts true ` + -AppCenterEnabled true ` + -AccountSource null ` + -Owner null +``` + +- Convert the resource to JSON +```powershell +$SourceApp | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceAppAccountSource.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceAppAccountSource.md new file mode 100644 index 000000000..483a667fb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceAppAccountSource.md @@ -0,0 +1,43 @@ +--- +id: beta-source-app-account-source +title: SourceAppAccountSource +pagination_label: SourceAppAccountSource +sidebar_label: SourceAppAccountSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAppAccountSource', 'BetaSourceAppAccountSource'] +slug: /tools/sdk/powershell/beta/models/source-app-account-source +tags: ['SDK', 'Software Development Kit', 'SourceAppAccountSource', 'BetaSourceAppAccountSource'] +--- + + +# SourceAppAccountSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The source ID | [optional] +**Type** | Pointer to **String** | The source type, will always be ""SOURCE"" | [optional] +**Name** | Pointer to **String** | The source name | [optional] +**UseForPasswordManagement** | Pointer to **Boolean** | If the source is used for password management | [optional] [default to $false] +**PasswordPolicies** | Pointer to [**[]BaseReferenceDto**](base-reference-dto) | The password policies for the source | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceAppAccountSource = Initialize-PSSailpoint.BetaSourceAppAccountSource -Id 2c9180827ca885d7017ca8ce28a000eb ` + -Type SOURCE ` + -Name ODS-AD-Source ` + -UseForPasswordManagement false ` + -PasswordPolicies [{type=PASSWORD_POLICY, id=006a072ecc6647f68bba9f4a4ad34649, name=Password Policy 1}] +``` + +- Convert the resource to JSON +```powershell +$SourceAppAccountSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceAppBulkUpdateRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceAppBulkUpdateRequest.md new file mode 100644 index 000000000..dd1e49c24 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceAppBulkUpdateRequest.md @@ -0,0 +1,37 @@ +--- +id: beta-source-app-bulk-update-request +title: SourceAppBulkUpdateRequest +pagination_label: SourceAppBulkUpdateRequest +sidebar_label: SourceAppBulkUpdateRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAppBulkUpdateRequest', 'BetaSourceAppBulkUpdateRequest'] +slug: /tools/sdk/powershell/beta/models/source-app-bulk-update-request +tags: ['SDK', 'Software Development Kit', 'SourceAppBulkUpdateRequest', 'BetaSourceAppBulkUpdateRequest'] +--- + + +# SourceAppBulkUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AppIds** | **[]String** | List of source app ids to update | [required] +**JsonPatch** | [**[]JsonPatchOperation**](json-patch-operation) | The JSONPatch payload used to update the source app. | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceAppBulkUpdateRequest = Initialize-PSSailpoint.BetaSourceAppBulkUpdateRequest -AppIds [2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e, 2c91808a7624751a01762f19d692220f] ` + -JsonPatch [{op=replace, path=/enabled, value=false}, {op=replace, path=/matchAllAccounts, value=false}] +``` + +- Convert the resource to JSON +```powershell +$SourceAppBulkUpdateRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceAppCreateDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceAppCreateDto.md new file mode 100644 index 000000000..05f725450 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceAppCreateDto.md @@ -0,0 +1,41 @@ +--- +id: beta-source-app-create-dto +title: SourceAppCreateDto +pagination_label: SourceAppCreateDto +sidebar_label: SourceAppCreateDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAppCreateDto', 'BetaSourceAppCreateDto'] +slug: /tools/sdk/powershell/beta/models/source-app-create-dto +tags: ['SDK', 'Software Development Kit', 'SourceAppCreateDto', 'BetaSourceAppCreateDto'] +--- + + +# SourceAppCreateDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | The source app name | [required] +**Description** | **String** | The description of the source app | [required] +**MatchAllAccounts** | Pointer to **Boolean** | True if the source app match all accounts | [optional] [default to $false] +**AccountSource** | [**SourceAppCreateDtoAccountSource**](source-app-create-dto-account-source) | | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceAppCreateDto = Initialize-PSSailpoint.BetaSourceAppCreateDto -Name my app ` + -Description the source app for engineers ` + -MatchAllAccounts true ` + -AccountSource null +``` + +- Convert the resource to JSON +```powershell +$SourceAppCreateDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceAppCreateDtoAccountSource.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceAppCreateDtoAccountSource.md new file mode 100644 index 000000000..743b75b4a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceAppCreateDtoAccountSource.md @@ -0,0 +1,39 @@ +--- +id: beta-source-app-create-dto-account-source +title: SourceAppCreateDtoAccountSource +pagination_label: SourceAppCreateDtoAccountSource +sidebar_label: SourceAppCreateDtoAccountSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAppCreateDtoAccountSource', 'BetaSourceAppCreateDtoAccountSource'] +slug: /tools/sdk/powershell/beta/models/source-app-create-dto-account-source +tags: ['SDK', 'Software Development Kit', 'SourceAppCreateDtoAccountSource', 'BetaSourceAppCreateDtoAccountSource'] +--- + + +# SourceAppCreateDtoAccountSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The source ID | [required] +**Type** | Pointer to **String** | The source type, will always be ""SOURCE"" | [optional] +**Name** | Pointer to **String** | The source name | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceAppCreateDtoAccountSource = Initialize-PSSailpoint.BetaSourceAppCreateDtoAccountSource -Id 2c9180827ca885d7017ca8ce28a000eb ` + -Type SOURCE ` + -Name ODS-AD-Source +``` + +- Convert the resource to JSON +```powershell +$SourceAppCreateDtoAccountSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceAppPatchDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceAppPatchDto.md new file mode 100644 index 000000000..60a52c9a0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceAppPatchDto.md @@ -0,0 +1,59 @@ +--- +id: beta-source-app-patch-dto +title: SourceAppPatchDto +pagination_label: SourceAppPatchDto +sidebar_label: SourceAppPatchDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAppPatchDto', 'BetaSourceAppPatchDto'] +slug: /tools/sdk/powershell/beta/models/source-app-patch-dto +tags: ['SDK', 'Software Development Kit', 'SourceAppPatchDto', 'BetaSourceAppPatchDto'] +--- + + +# SourceAppPatchDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The source app id | [optional] +**CloudAppId** | Pointer to **String** | The deprecated source app id | [optional] +**Name** | Pointer to **String** | The source app name | [optional] +**Created** | Pointer to **System.DateTime** | Time when the source app was created | [optional] +**Modified** | Pointer to **System.DateTime** | Time when the source app was last modified | [optional] +**Enabled** | Pointer to **Boolean** | True if the source app is enabled | [optional] [default to $false] +**ProvisionRequestEnabled** | Pointer to **Boolean** | True if the source app is provision request enabled | [optional] [default to $false] +**Description** | Pointer to **String** | The description of the source app | [optional] +**MatchAllAccounts** | Pointer to **Boolean** | True if the source app match all accounts | [optional] [default to $false] +**AppCenterEnabled** | Pointer to **Boolean** | True if the source app is shown in the app center | [optional] [default to $true] +**AccessProfiles** | Pointer to **[]String** | List of IDs of access profiles | [optional] +**AccountSource** | Pointer to [**SourceAppAccountSource**](source-app-account-source) | | [optional] +**Owner** | Pointer to [**BaseReferenceDto**](base-reference-dto) | The owner of source app | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceAppPatchDto = Initialize-PSSailpoint.BetaSourceAppPatchDto -Id 2c91808874ff91550175097daaec161c ` + -CloudAppId 9854520 ` + -Name my app ` + -Created 2020-10-08T18:33:52.029Z ` + -Modified 2020-10-08T18:33:52.029Z ` + -Enabled true ` + -ProvisionRequestEnabled true ` + -Description the source app for engineers ` + -MatchAllAccounts true ` + -AppCenterEnabled true ` + -AccessProfiles [2c9180857725c14301772a93bb77242d, c9dc28e148a24d65b3ccb5fb8ca5ddd9] ` + -AccountSource null ` + -Owner null +``` + +- Convert the resource to JSON +```powershell +$SourceAppPatchDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceClusterDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceClusterDto.md new file mode 100644 index 000000000..6aeaaa9a4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceClusterDto.md @@ -0,0 +1,39 @@ +--- +id: beta-source-cluster-dto +title: SourceClusterDto +pagination_label: SourceClusterDto +sidebar_label: SourceClusterDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceClusterDto', 'BetaSourceClusterDto'] +slug: /tools/sdk/powershell/beta/models/source-cluster-dto +tags: ['SDK', 'Software Development Kit', 'SourceClusterDto', 'BetaSourceClusterDto'] +--- + + +# SourceClusterDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "CLUSTER" ] | Source cluster DTO type. | [optional] +**Id** | Pointer to **String** | Source cluster ID. | [optional] +**Name** | Pointer to **String** | Source cluster display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceClusterDto = Initialize-PSSailpoint.BetaSourceClusterDto -Type CLUSTER ` + -Id 2c9180847a7fccdd017aa5896f9f4f6f ` + -Name Training VA +``` + +- Convert the resource to JSON +```powershell +$SourceClusterDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceCode.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceCode.md new file mode 100644 index 000000000..054f1b508 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceCode.md @@ -0,0 +1,37 @@ +--- +id: beta-source-code +title: SourceCode +pagination_label: SourceCode +sidebar_label: SourceCode +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceCode', 'BetaSourceCode'] +slug: /tools/sdk/powershell/beta/models/source-code +tags: ['SDK', 'Software Development Kit', 'SourceCode', 'BetaSourceCode'] +--- + + +# SourceCode + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | **String** | the version of the code | [required] +**Script** | **String** | The code | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceCode = Initialize-PSSailpoint.BetaSourceCode -Version 1.0 ` + -Script return "Mr. " + firstName; +``` + +- Convert the resource to JSON +```powershell +$SourceCode | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceCreated.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceCreated.md new file mode 100644 index 000000000..ffb93de9a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceCreated.md @@ -0,0 +1,45 @@ +--- +id: beta-source-created +title: SourceCreated +pagination_label: SourceCreated +sidebar_label: SourceCreated +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceCreated', 'BetaSourceCreated'] +slug: /tools/sdk/powershell/beta/models/source-created +tags: ['SDK', 'Software Development Kit', 'SourceCreated', 'BetaSourceCreated'] +--- + + +# SourceCreated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the source. | [required] +**Name** | **String** | Human friendly name of the source. | [required] +**Type** | **String** | The connection type. | [required] +**Created** | **System.DateTime** | The date and time the source was created. | [required] +**Connector** | **String** | The connector type used to connect to the source. | [required] +**Actor** | [**SourceCreatedActor**](source-created-actor) | | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceCreated = Initialize-PSSailpoint.BetaSourceCreated -Id 2c9180866166b5b0016167c32ef31a66 ` + -Name Test source ` + -Type DIRECT_CONNECT ` + -Created 2021-03-29T22:01:50.474Z ` + -Connector active-directory ` + -Actor null +``` + +- Convert the resource to JSON +```powershell +$SourceCreated | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceCreatedActor.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceCreatedActor.md new file mode 100644 index 000000000..8c552ccf0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceCreatedActor.md @@ -0,0 +1,39 @@ +--- +id: beta-source-created-actor +title: SourceCreatedActor +pagination_label: SourceCreatedActor +sidebar_label: SourceCreatedActor +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceCreatedActor', 'BetaSourceCreatedActor'] +slug: /tools/sdk/powershell/beta/models/source-created-actor +tags: ['SDK', 'Software Development Kit', 'SourceCreatedActor', 'BetaSourceCreatedActor'] +--- + + +# SourceCreatedActor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | DTO type of identity who created the source. | [required] +**Id** | **String** | ID of identity who created the source. | [required] +**Name** | **String** | Display name of identity who created the source. | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceCreatedActor = Initialize-PSSailpoint.BetaSourceCreatedActor -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20648 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$SourceCreatedActor | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceCreationErrors.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceCreationErrors.md new file mode 100644 index 000000000..1c1cb271f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceCreationErrors.md @@ -0,0 +1,45 @@ +--- +id: beta-source-creation-errors +title: SourceCreationErrors +pagination_label: SourceCreationErrors +sidebar_label: SourceCreationErrors +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceCreationErrors', 'BetaSourceCreationErrors'] +slug: /tools/sdk/powershell/beta/models/source-creation-errors +tags: ['SDK', 'Software Development Kit', 'SourceCreationErrors', 'BetaSourceCreationErrors'] +--- + + +# SourceCreationErrors + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MultihostId** | Pointer to **String** | Multi-Host Integration ID. | [optional] [readonly] +**SourceName** | Pointer to **String** | Source's human-readable name. | [optional] +**SourceError** | Pointer to **String** | Source's human-readable description. | [optional] +**Created** | Pointer to **System.DateTime** | Date-time when the source was created | [optional] +**Modified** | Pointer to **System.DateTime** | Date-time when the source was last modified. | [optional] +**Operation** | Pointer to **String** | operation category (e.g. DELETE). | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceCreationErrors = Initialize-PSSailpoint.BetaSourceCreationErrors -MultihostId 2c91808568c529c60168cca6f90c1324 ` + -SourceName My Source ` + -SourceError Source with internal name "My Source [source]" already exists. ` + -Created 2022-02-08T14:50:03.827Z ` + -Modified 2024-01-23T18:08:50.897Z ` + -Operation DELETE +``` + +- Convert the resource to JSON +```powershell +$SourceCreationErrors | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceDeleted.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceDeleted.md new file mode 100644 index 000000000..38ae0ee6f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceDeleted.md @@ -0,0 +1,45 @@ +--- +id: beta-source-deleted +title: SourceDeleted +pagination_label: SourceDeleted +sidebar_label: SourceDeleted +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceDeleted', 'BetaSourceDeleted'] +slug: /tools/sdk/powershell/beta/models/source-deleted +tags: ['SDK', 'Software Development Kit', 'SourceDeleted', 'BetaSourceDeleted'] +--- + + +# SourceDeleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the source. | [required] +**Name** | **String** | Human friendly name of the source. | [required] +**Type** | **String** | The connection type. | [required] +**Deleted** | **System.DateTime** | The date and time the source was deleted. | [required] +**Connector** | **String** | The connector type used to connect to the source. | [required] +**Actor** | [**SourceDeletedActor**](source-deleted-actor) | | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceDeleted = Initialize-PSSailpoint.BetaSourceDeleted -Id 2c9180866166b5b0016167c32ef31a66 ` + -Name Test source ` + -Type DIRECT_CONNECT ` + -Deleted 2021-03-29T22:01:50.474Z ` + -Connector active-directory ` + -Actor null +``` + +- Convert the resource to JSON +```powershell +$SourceDeleted | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceDeletedActor.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceDeletedActor.md new file mode 100644 index 000000000..62d8ebbc0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceDeletedActor.md @@ -0,0 +1,39 @@ +--- +id: beta-source-deleted-actor +title: SourceDeletedActor +pagination_label: SourceDeletedActor +sidebar_label: SourceDeletedActor +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceDeletedActor', 'BetaSourceDeletedActor'] +slug: /tools/sdk/powershell/beta/models/source-deleted-actor +tags: ['SDK', 'Software Development Kit', 'SourceDeletedActor', 'BetaSourceDeletedActor'] +--- + + +# SourceDeletedActor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | DTO type of identity who deleted the source. | [required] +**Id** | **String** | ID of identity who deleted the source. | [required] +**Name** | **String** | Display name of identity who deleted the source. | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceDeletedActor = Initialize-PSSailpoint.BetaSourceDeletedActor -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20648 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$SourceDeletedActor | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceEntitlementRequestConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceEntitlementRequestConfig.md new file mode 100644 index 000000000..7830796f5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceEntitlementRequestConfig.md @@ -0,0 +1,35 @@ +--- +id: beta-source-entitlement-request-config +title: SourceEntitlementRequestConfig +pagination_label: SourceEntitlementRequestConfig +sidebar_label: SourceEntitlementRequestConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceEntitlementRequestConfig', 'BetaSourceEntitlementRequestConfig'] +slug: /tools/sdk/powershell/beta/models/source-entitlement-request-config +tags: ['SDK', 'Software Development Kit', 'SourceEntitlementRequestConfig', 'BetaSourceEntitlementRequestConfig'] +--- + + +# SourceEntitlementRequestConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestConfig** | Pointer to [**EntitlementAccessRequestConfig**](entitlement-access-request-config) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceEntitlementRequestConfig = Initialize-PSSailpoint.BetaSourceEntitlementRequestConfig -AccessRequestConfig null +``` + +- Convert the resource to JSON +```powershell +$SourceEntitlementRequestConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceSyncJob.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceSyncJob.md new file mode 100644 index 000000000..e9c517db7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceSyncJob.md @@ -0,0 +1,39 @@ +--- +id: beta-source-sync-job +title: SourceSyncJob +pagination_label: SourceSyncJob +sidebar_label: SourceSyncJob +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceSyncJob', 'BetaSourceSyncJob'] +slug: /tools/sdk/powershell/beta/models/source-sync-job +tags: ['SDK', 'Software Development Kit', 'SourceSyncJob', 'BetaSourceSyncJob'] +--- + + +# SourceSyncJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Job ID. | [required] +**Status** | **Enum** [ "QUEUED", "IN_PROGRESS", "SUCCESS", "ERROR" ] | The job status. | [required] +**Payload** | [**SourceSyncPayload**](source-sync-payload) | | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceSyncJob = Initialize-PSSailpoint.BetaSourceSyncJob -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -Status IN_PROGRESS ` + -Payload null +``` + +- Convert the resource to JSON +```powershell +$SourceSyncJob | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceSyncPayload.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceSyncPayload.md new file mode 100644 index 000000000..396ded92c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceSyncPayload.md @@ -0,0 +1,37 @@ +--- +id: beta-source-sync-payload +title: SourceSyncPayload +pagination_label: SourceSyncPayload +sidebar_label: SourceSyncPayload +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceSyncPayload', 'BetaSourceSyncPayload'] +slug: /tools/sdk/powershell/beta/models/source-sync-payload +tags: ['SDK', 'Software Development Kit', 'SourceSyncPayload', 'BetaSourceSyncPayload'] +--- + + +# SourceSyncPayload + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **String** | Payload type. | [required] +**DataJson** | **String** | Payload type. | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceSyncPayload = Initialize-PSSailpoint.BetaSourceSyncPayload -Type SYNCHRONIZE_SOURCE_ATTRIBUTES ` + -DataJson {"sourceId":"2c918083746f642c01746f990884012a"} +``` + +- Convert the resource to JSON +```powershell +$SourceSyncPayload | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceUpdated.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceUpdated.md new file mode 100644 index 000000000..e5a117fb1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceUpdated.md @@ -0,0 +1,45 @@ +--- +id: beta-source-updated +title: SourceUpdated +pagination_label: SourceUpdated +sidebar_label: SourceUpdated +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceUpdated', 'BetaSourceUpdated'] +slug: /tools/sdk/powershell/beta/models/source-updated +tags: ['SDK', 'Software Development Kit', 'SourceUpdated', 'BetaSourceUpdated'] +--- + + +# SourceUpdated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the source. | [required] +**Name** | **String** | The user friendly name of the source. | [required] +**Type** | **String** | The connection type of the source. | [required] +**Modified** | **System.DateTime** | The date and time the source was modified. | [required] +**Connector** | **String** | The connector type used to connect to the source. | [required] +**Actor** | [**SourceUpdatedActor**](source-updated-actor) | | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceUpdated = Initialize-PSSailpoint.BetaSourceUpdated -Id 2c9180866166b5b0016167c32ef31a66 ` + -Name Corporate Active Directory ` + -Type DIRECT_CONNECT ` + -Modified 2021-03-29T22:01:50.474Z ` + -Connector active-directory ` + -Actor null +``` + +- Convert the resource to JSON +```powershell +$SourceUpdated | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceUpdatedActor.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceUpdatedActor.md new file mode 100644 index 000000000..d27eb321c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceUpdatedActor.md @@ -0,0 +1,39 @@ +--- +id: beta-source-updated-actor +title: SourceUpdatedActor +pagination_label: SourceUpdatedActor +sidebar_label: SourceUpdatedActor +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceUpdatedActor', 'BetaSourceUpdatedActor'] +slug: /tools/sdk/powershell/beta/models/source-updated-actor +tags: ['SDK', 'Software Development Kit', 'SourceUpdatedActor', 'BetaSourceUpdatedActor'] +--- + + +# SourceUpdatedActor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | DTO type of identity who updated the source. | [required] +**Id** | Pointer to **String** | ID of identity who updated the source. | [optional] +**Name** | **String** | Display name of identity who updated the source. | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceUpdatedActor = Initialize-PSSailpoint.BetaSourceUpdatedActor -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20648 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$SourceUpdatedActor | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceUsage.md new file mode 100644 index 000000000..e34543ab6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceUsage.md @@ -0,0 +1,37 @@ +--- +id: beta-source-usage +title: SourceUsage +pagination_label: SourceUsage +sidebar_label: SourceUsage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceUsage', 'BetaSourceUsage'] +slug: /tools/sdk/powershell/beta/models/source-usage +tags: ['SDK', 'Software Development Kit', 'SourceUsage', 'BetaSourceUsage'] +--- + + +# SourceUsage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Date** | Pointer to **System.DateTime** | The first day of the month for which activity is aggregated. | [optional] +**Count** | Pointer to **Double** | The average number of days that accounts were active within this source, for the month. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` + -Count 10.45 +``` + +- Convert the resource to JSON +```powershell +$SourceUsage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceUsageStatus.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceUsageStatus.md new file mode 100644 index 000000000..3cf02d5dc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SourceUsageStatus.md @@ -0,0 +1,35 @@ +--- +id: beta-source-usage-status +title: SourceUsageStatus +pagination_label: SourceUsageStatus +sidebar_label: SourceUsageStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceUsageStatus', 'BetaSourceUsageStatus'] +slug: /tools/sdk/powershell/beta/models/source-usage-status +tags: ['SDK', 'Software Development Kit', 'SourceUsageStatus', 'BetaSourceUsageStatus'] +--- + + +# SourceUsageStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **Enum** [ "COMPLETE", "INCOMPLETE" ] | Source Usage Status. Acceptable values are: - COMPLETE - This status means that an activity data source has been setup and usage insights are available for the source. - INCOMPLETE - This status means that an activity data source has not been setup and usage insights are not available for the source. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceUsageStatus = Initialize-PSSailpoint.BetaSourceUsageStatus -Status COMPLETE +``` + +- Convert the resource to JSON +```powershell +$SourceUsageStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigExportJob.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigExportJob.md new file mode 100644 index 000000000..275059643 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigExportJob.md @@ -0,0 +1,47 @@ +--- +id: beta-sp-config-export-job +title: SpConfigExportJob +pagination_label: SpConfigExportJob +sidebar_label: SpConfigExportJob +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigExportJob', 'BetaSpConfigExportJob'] +slug: /tools/sdk/powershell/beta/models/sp-config-export-job +tags: ['SDK', 'Software Development Kit', 'SpConfigExportJob', 'BetaSpConfigExportJob'] +--- + + +# SpConfigExportJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | **String** | Unique id assigned to this job. | [required] +**Status** | **Enum** [ "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "CANCELLED", "FAILED" ] | Status of the job. | [required] +**Type** | **Enum** [ "EXPORT", "IMPORT" ] | Type of the job, either export or import. | [required] +**Expiration** | **System.DateTime** | The time until which the artifacts will be available for download. | [required] +**Created** | **System.DateTime** | The time the job was started. | [required] +**Modified** | **System.DateTime** | The time of the last update to the job. | [required] +**Description** | Pointer to **String** | Optional user defined description/name for export job. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SpConfigExportJob = Initialize-PSSailpoint.BetaSpConfigExportJob -JobId 3469b87d-48ca-439a-868f-2160001da8c1 ` + -Status COMPLETE ` + -Type IMPORT ` + -Expiration 2021-05-11T22:23:16Z ` + -Created 2021-05-11T22:23:16Z ` + -Modified 2021-05-11T22:23:16Z ` + -Description ETS configuration objects from Acme-Solar sandbox +``` + +- Convert the resource to JSON +```powershell +$SpConfigExportJob | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigExportJobStatus.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigExportJobStatus.md new file mode 100644 index 000000000..8d5e6acb5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigExportJobStatus.md @@ -0,0 +1,49 @@ +--- +id: beta-sp-config-export-job-status +title: SpConfigExportJobStatus +pagination_label: SpConfigExportJobStatus +sidebar_label: SpConfigExportJobStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigExportJobStatus', 'BetaSpConfigExportJobStatus'] +slug: /tools/sdk/powershell/beta/models/sp-config-export-job-status +tags: ['SDK', 'Software Development Kit', 'SpConfigExportJobStatus', 'BetaSpConfigExportJobStatus'] +--- + + +# SpConfigExportJobStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | **String** | Unique id assigned to this job. | [required] +**Status** | **Enum** [ "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "CANCELLED", "FAILED" ] | Status of the job. | [required] +**Type** | **Enum** [ "EXPORT", "IMPORT" ] | Type of the job, either export or import. | [required] +**Expiration** | **System.DateTime** | The time until which the artifacts will be available for download. | [required] +**Created** | **System.DateTime** | The time the job was started. | [required] +**Modified** | **System.DateTime** | The time of the last update to the job. | [required] +**Description** | Pointer to **String** | Optional user defined description/name for export job. | [optional] +**Completed** | Pointer to **System.DateTime** | The time the job was completed. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SpConfigExportJobStatus = Initialize-PSSailpoint.BetaSpConfigExportJobStatus -JobId 3469b87d-48ca-439a-868f-2160001da8c1 ` + -Status COMPLETE ` + -Type IMPORT ` + -Expiration 2021-05-11T22:23:16Z ` + -Created 2021-05-11T22:23:16Z ` + -Modified 2021-05-11T22:23:16Z ` + -Description ETS configuration objects from Acme-Solar sandbox ` + -Completed 2021-05-11T22:23:16Z +``` + +- Convert the resource to JSON +```powershell +$SpConfigExportJobStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigExportResults.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigExportResults.md new file mode 100644 index 000000000..dca1e4bfd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigExportResults.md @@ -0,0 +1,45 @@ +--- +id: beta-sp-config-export-results +title: SpConfigExportResults +pagination_label: SpConfigExportResults +sidebar_label: SpConfigExportResults +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigExportResults', 'BetaSpConfigExportResults'] +slug: /tools/sdk/powershell/beta/models/sp-config-export-results +tags: ['SDK', 'Software Development Kit', 'SpConfigExportResults', 'BetaSpConfigExportResults'] +--- + + +# SpConfigExportResults + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | Pointer to **Int32** | Current version of the export results object. | [optional] +**Timestamp** | Pointer to **System.DateTime** | Time the export was completed. | [optional] +**Tenant** | Pointer to **String** | Name of the tenant where this export originated. | [optional] +**Description** | Pointer to **String** | Optional user defined description/name for export job. | [optional] +**Options** | Pointer to [**ExportOptions**](export-options) | | [optional] +**Objects** | Pointer to [**[]ConfigObject**](config-object) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SpConfigExportResults = Initialize-PSSailpoint.BetaSpConfigExportResults -Version 1 ` + -Timestamp 2021-05-11T22:23:16Z ` + -Tenant sample-tenant ` + -Description Export Job 1 Test ` + -Options null ` + -Objects null +``` + +- Convert the resource to JSON +```powershell +$SpConfigExportResults | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigImportJobStatus.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigImportJobStatus.md new file mode 100644 index 000000000..76a107934 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigImportJobStatus.md @@ -0,0 +1,49 @@ +--- +id: beta-sp-config-import-job-status +title: SpConfigImportJobStatus +pagination_label: SpConfigImportJobStatus +sidebar_label: SpConfigImportJobStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigImportJobStatus', 'BetaSpConfigImportJobStatus'] +slug: /tools/sdk/powershell/beta/models/sp-config-import-job-status +tags: ['SDK', 'Software Development Kit', 'SpConfigImportJobStatus', 'BetaSpConfigImportJobStatus'] +--- + + +# SpConfigImportJobStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | **String** | Unique id assigned to this job. | [required] +**Status** | **Enum** [ "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "CANCELLED", "FAILED" ] | Status of the job. | [required] +**Type** | **Enum** [ "EXPORT", "IMPORT" ] | Type of the job, either export or import. | [required] +**Expiration** | **System.DateTime** | The time until which the artifacts will be available for download. | [required] +**Created** | **System.DateTime** | The time the job was started. | [required] +**Modified** | **System.DateTime** | The time of the last update to the job. | [required] +**Message** | Pointer to **String** | This message contains additional information about the overall status of the job. | [optional] +**Completed** | Pointer to **System.DateTime** | The time the job was completed. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SpConfigImportJobStatus = Initialize-PSSailpoint.BetaSpConfigImportJobStatus -JobId 3469b87d-48ca-439a-868f-2160001da8c1 ` + -Status COMPLETE ` + -Type IMPORT ` + -Expiration 2021-05-11T22:23:16Z ` + -Created 2021-05-11T22:23:16Z ` + -Modified 2021-05-11T22:23:16Z ` + -Message Download import results for details. ` + -Completed 2021-05-11T22:23:16Z +``` + +- Convert the resource to JSON +```powershell +$SpConfigImportJobStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigImportResults.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigImportResults.md new file mode 100644 index 000000000..21ca81115 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigImportResults.md @@ -0,0 +1,37 @@ +--- +id: beta-sp-config-import-results +title: SpConfigImportResults +pagination_label: SpConfigImportResults +sidebar_label: SpConfigImportResults +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigImportResults', 'BetaSpConfigImportResults'] +slug: /tools/sdk/powershell/beta/models/sp-config-import-results +tags: ['SDK', 'Software Development Kit', 'SpConfigImportResults', 'BetaSpConfigImportResults'] +--- + + +# SpConfigImportResults + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Results** | [**map[string]ObjectImportResult**](object-import-result) | The results of an object configuration import job. | [required] +**ExportJobId** | Pointer to **String** | If a backup was performed before the import, this will contain the jobId of the backup job. This id can be used to retrieve the json file of the backup export. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SpConfigImportResults = Initialize-PSSailpoint.BetaSpConfigImportResults -Results {results={TRIGGER_SUBSCRIPTION={infos=[{key=IMPORT_PREVIEW, text=Object to be imported: [c953134c-2224-42f2-a84e-fa5cbb395904, Test 2], detail=null}, {key=IMPORT_PREVIEW, text=Object to be imported: [be9e116d-08e1-49fc-ab7f-fa585e96c9e4, Test 1], detail=null}], warnings=[], errors=[], importedObjects=[]}}} ` + -ExportJobId be9e116d-08e1-49fc-ab7f-fa585e96c9e4 +``` + +- Convert the resource to JSON +```powershell +$SpConfigImportResults | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigJob.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigJob.md new file mode 100644 index 000000000..787c09a6b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigJob.md @@ -0,0 +1,45 @@ +--- +id: beta-sp-config-job +title: SpConfigJob +pagination_label: SpConfigJob +sidebar_label: SpConfigJob +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigJob', 'BetaSpConfigJob'] +slug: /tools/sdk/powershell/beta/models/sp-config-job +tags: ['SDK', 'Software Development Kit', 'SpConfigJob', 'BetaSpConfigJob'] +--- + + +# SpConfigJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | **String** | Unique id assigned to this job. | [required] +**Status** | **Enum** [ "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "CANCELLED", "FAILED" ] | Status of the job. | [required] +**Type** | **Enum** [ "EXPORT", "IMPORT" ] | Type of the job, either export or import. | [required] +**Expiration** | **System.DateTime** | The time until which the artifacts will be available for download. | [required] +**Created** | **System.DateTime** | The time the job was started. | [required] +**Modified** | **System.DateTime** | The time of the last update to the job. | [required] + +## Examples + +- Prepare the resource +```powershell +$SpConfigJob = Initialize-PSSailpoint.BetaSpConfigJob -JobId 3469b87d-48ca-439a-868f-2160001da8c1 ` + -Status COMPLETE ` + -Type IMPORT ` + -Expiration 2021-05-11T22:23:16Z ` + -Created 2021-05-11T22:23:16Z ` + -Modified 2021-05-11T22:23:16Z +``` + +- Convert the resource to JSON +```powershell +$SpConfigJob | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigMessage.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigMessage.md new file mode 100644 index 000000000..502f2df29 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigMessage.md @@ -0,0 +1,39 @@ +--- +id: beta-sp-config-message +title: SpConfigMessage +pagination_label: SpConfigMessage +sidebar_label: SpConfigMessage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigMessage', 'BetaSpConfigMessage'] +slug: /tools/sdk/powershell/beta/models/sp-config-message +tags: ['SDK', 'Software Development Kit', 'SpConfigMessage', 'BetaSpConfigMessage'] +--- + + +# SpConfigMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | **String** | Message key. | [required] +**Text** | **String** | Message text. | [required] +**Details** | [**map[string]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Message details if any, in key:value pairs. | [required] + +## Examples + +- Prepare the resource +```powershell +$SpConfigMessage = Initialize-PSSailpoint.BetaSpConfigMessage -Key UNKNOWN_REFERENCE_RESOLVER ` + -Text Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity] ` + -Details {details=message details} +``` + +- Convert the resource to JSON +```powershell +$SpConfigMessage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigObject.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigObject.md new file mode 100644 index 000000000..bc3b49710 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigObject.md @@ -0,0 +1,47 @@ +--- +id: beta-sp-config-object +title: SpConfigObject +pagination_label: SpConfigObject +sidebar_label: SpConfigObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigObject', 'BetaSpConfigObject'] +slug: /tools/sdk/powershell/beta/models/sp-config-object +tags: ['SDK', 'Software Development Kit', 'SpConfigObject', 'BetaSpConfigObject'] +--- + + +# SpConfigObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectType** | Pointer to **String** | The object type this configuration is for. | [optional] +**ReferenceExtractors** | Pointer to **[]String** | List of json paths within an exported object of this type that represent references that need to be resolved. | [optional] +**SignatureRequired** | Pointer to **Boolean** | If true, this type of object will be JWS signed and cannot be modified before import. | [optional] [default to $false] +**LegacyObject** | Pointer to **Boolean** | Whether this is a legacy object | [optional] [default to $false] +**OnePerTenant** | Pointer to **Boolean** | Whether there is only one object of this type | [optional] [default to $false] +**Exportable** | Pointer to **Boolean** | Whether this object can be exported or it is just a reference object | [optional] [default to $false] +**Rules** | Pointer to [**SpConfigRules**](sp-config-rules) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SpConfigObject = Initialize-PSSailpoint.BetaSpConfigObject -ObjectType TRIGGER_SUBSCRIPTION ` + -ReferenceExtractors [$.owner] ` + -SignatureRequired false ` + -LegacyObject false ` + -OnePerTenant false ` + -Exportable true ` + -Rules null +``` + +- Convert the resource to JSON +```powershell +$SpConfigObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigRule.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigRule.md new file mode 100644 index 000000000..7fc146e2d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigRule.md @@ -0,0 +1,39 @@ +--- +id: beta-sp-config-rule +title: SpConfigRule +pagination_label: SpConfigRule +sidebar_label: SpConfigRule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigRule', 'BetaSpConfigRule'] +slug: /tools/sdk/powershell/beta/models/sp-config-rule +tags: ['SDK', 'Software Development Kit', 'SpConfigRule', 'BetaSpConfigRule'] +--- + + +# SpConfigRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Path** | Pointer to **String** | JSONPath expression denoting the path within the object where a value substitution should be applied | [optional] +**Value** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Value to be assigned at the jsonPath location within the object | [optional] +**Mode** | Pointer to **[]String** | Draft modes to which this rule will apply | [optional] + +## Examples + +- Prepare the resource +```powershell +$SpConfigRule = Initialize-PSSailpoint.BetaSpConfigRule -Path $.enabled ` + -Value null ` + -Mode [RESTORE, PROMOTE] +``` + +- Convert the resource to JSON +```powershell +$SpConfigRule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigRules.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigRules.md new file mode 100644 index 000000000..cdfb016d2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SpConfigRules.md @@ -0,0 +1,39 @@ +--- +id: beta-sp-config-rules +title: SpConfigRules +pagination_label: SpConfigRules +sidebar_label: SpConfigRules +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigRules', 'BetaSpConfigRules'] +slug: /tools/sdk/powershell/beta/models/sp-config-rules +tags: ['SDK', 'Software Development Kit', 'SpConfigRules', 'BetaSpConfigRules'] +--- + + +# SpConfigRules + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TakeFromTargetRules** | Pointer to [**[]SpConfigRule**](sp-config-rule) | | [optional] +**DefaultRules** | Pointer to [**[]SpConfigRule**](sp-config-rule) | | [optional] +**Editable** | Pointer to **Boolean** | Whether this object can be edited | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$SpConfigRules = Initialize-PSSailpoint.BetaSpConfigRules -TakeFromTargetRules null ` + -DefaultRules null ` + -Editable true +``` + +- Convert the resource to JSON +```powershell +$SpConfigRules | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Split.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Split.md new file mode 100644 index 000000000..02bda74a9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Split.md @@ -0,0 +1,43 @@ +--- +id: beta-split +title: Split +pagination_label: Split +sidebar_label: Split +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Split', 'BetaSplit'] +slug: /tools/sdk/powershell/beta/models/split +tags: ['SDK', 'Software Development Kit', 'Split', 'BetaSplit'] +--- + + +# Split + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Delimiter** | **String** | This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data | [required] +**Index** | **String** | An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc. | [required] +**Throws** | Pointer to **Boolean** | A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) `true` - The transform should return ""IndexOutOfBoundsException"" `false` - The transform should return null If not provided, the transform will default to false and return a null | [optional] [default to $false] +**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] + +## Examples + +- Prepare the resource +```powershell +$Split = Initialize-PSSailpoint.BetaSplit -Delimiter , ` + -Index 5 ` + -Throws true ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Split | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/StandardLevel.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/StandardLevel.md new file mode 100644 index 000000000..b3d7cae06 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/StandardLevel.md @@ -0,0 +1,34 @@ +--- +id: beta-standard-level +title: StandardLevel +pagination_label: StandardLevel +sidebar_label: StandardLevel +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'StandardLevel', 'BetaStandardLevel'] +slug: /tools/sdk/powershell/beta/models/standard-level +tags: ['SDK', 'Software Development Kit', 'StandardLevel', 'BetaStandardLevel'] +--- + + +# StandardLevel + +## Enum + + +* `false` (value: `"false"`) + +* `FATAL` (value: `"FATAL"`) + +* `ERROR` (value: `"ERROR"`) + +* `WARN` (value: `"WARN"`) + +* `INFO` (value: `"INFO"`) + +* `DEBUG` (value: `"DEBUG"`) + +* `TRACE` (value: `"TRACE"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/StartInvocationInput.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/StartInvocationInput.md new file mode 100644 index 000000000..fd5a9a598 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/StartInvocationInput.md @@ -0,0 +1,39 @@ +--- +id: beta-start-invocation-input +title: StartInvocationInput +pagination_label: StartInvocationInput +sidebar_label: StartInvocationInput +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'StartInvocationInput', 'BetaStartInvocationInput'] +slug: /tools/sdk/powershell/beta/models/start-invocation-input +tags: ['SDK', 'Software Development Kit', 'StartInvocationInput', 'BetaStartInvocationInput'] +--- + + +# StartInvocationInput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TriggerId** | Pointer to **String** | Trigger ID | [optional] +**VarInput** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Trigger input payload. Its schema is defined in the trigger definition. | [optional] +**ContentJson** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | JSON map of invocation metadata | [optional] + +## Examples + +- Prepare the resource +```powershell +$StartInvocationInput = Initialize-PSSailpoint.BetaStartInvocationInput -TriggerId idn:access-requested ` + -VarInput {identityId=201327fda1c44704ac01181e963d463c} ` + -ContentJson {workflowId=1234} +``` + +- Convert the resource to JSON +```powershell +$StartInvocationInput | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/StartLauncher200Response.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/StartLauncher200Response.md new file mode 100644 index 000000000..ff4f0de05 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/StartLauncher200Response.md @@ -0,0 +1,35 @@ +--- +id: beta-start-launcher200-response +title: StartLauncher200Response +pagination_label: StartLauncher200Response +sidebar_label: StartLauncher200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'StartLauncher200Response', 'BetaStartLauncher200Response'] +slug: /tools/sdk/powershell/beta/models/start-launcher200-response +tags: ['SDK', 'Software Development Kit', 'StartLauncher200Response', 'BetaStartLauncher200Response'] +--- + + +# StartLauncher200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InteractiveProcessId** | **String** | ID of the Interactive Process that was launched | [required] + +## Examples + +- Prepare the resource +```powershell +$StartLauncher200Response = Initialize-PSSailpoint.BetaStartLauncher200Response -InteractiveProcessId 5da68cfe-2d60-4b09-858f-0d03acd2f47a +``` + +- Convert the resource to JSON +```powershell +$StartLauncher200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Static.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Static.md new file mode 100644 index 000000000..3462f63a7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Static.md @@ -0,0 +1,37 @@ +--- +id: beta-static +title: Static +pagination_label: Static +sidebar_label: Static +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Static', 'BetaStatic'] +slug: /tools/sdk/powershell/beta/models/static +tags: ['SDK', 'Software Development Kit', 'Static', 'BetaStatic'] +--- + + +# Static + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Values** | **String** | This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language. | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$Static = Initialize-PSSailpoint.BetaStatic -Values string$variable ` + -RequiresPeriodicRefresh false +``` + +- Convert the resource to JSON +```powershell +$Static | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/StatusResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/StatusResponse.md new file mode 100644 index 000000000..589f0915f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/StatusResponse.md @@ -0,0 +1,43 @@ +--- +id: beta-status-response +title: StatusResponse +pagination_label: StatusResponse +sidebar_label: StatusResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'StatusResponse', 'BetaStatusResponse'] +slug: /tools/sdk/powershell/beta/models/status-response +tags: ['SDK', 'Software Development Kit', 'StatusResponse', 'BetaStatusResponse'] +--- + + +# StatusResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the source | [optional] [readonly] +**Name** | Pointer to **String** | Name of the source | [optional] [readonly] +**Status** | Pointer to **Enum** [ "SUCCESS", "FAILURE" ] | The status of the health check. | [optional] [readonly] +**ElapsedMillis** | Pointer to **Int32** | The number of milliseconds spent on the entire request. | [optional] [readonly] +**Details** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The document contains the results of the health check. The schema of this document depends on the type of source used. | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$StatusResponse = Initialize-PSSailpoint.BetaStatusResponse -Id 2c91808568c529c60168cca6f90c1313 ` + -Name ODS-AD-Test [source-999999] ` + -Status SUCCESS ` + -ElapsedMillis 1000 ` + -Details {useTLSForIQService=false, IQService={TLS Port=0, .NET CLR Version=4.0.30319.42000, SecondaryServiceStatus=Running, Port=5050, Host=AUTOMATION-AD, Name=IQService, IQServiceStatus=Running, SecondaryService=IQService-Instance1-Secondary, Version=IQService Sep-2020, secondaryPort=5051, OS Architecture=AMD64, Operating System=Microsoft Windows Server 2012 R2 Standard, highestDotNetVersion=4.8 or later, Build Time=09/22/2020 06:34 AM -0500}, IQServiceClientAuthEnabled=false, requestProcessedOn=1/19/2021 1:47:14 PM} +``` + +- Convert the resource to JSON +```powershell +$StatusResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Subscription.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Subscription.md new file mode 100644 index 000000000..5012b9c58 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Subscription.md @@ -0,0 +1,55 @@ +--- +id: beta-subscription +title: Subscription +pagination_label: Subscription +sidebar_label: Subscription +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Subscription', 'BetaSubscription'] +slug: /tools/sdk/powershell/beta/models/subscription +tags: ['SDK', 'Software Development Kit', 'Subscription', 'BetaSubscription'] +--- + + +# Subscription + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Subscription ID. | [required] +**Name** | **String** | Subscription name. | [required] +**Description** | Pointer to **String** | Subscription description. | [optional] +**TriggerId** | **String** | ID of trigger subscribed to. | [required] +**TriggerName** | **String** | Trigger name of trigger subscribed to. | [required] +**Type** | [**SubscriptionType**](subscription-type) | | [required] +**ResponseDeadline** | Pointer to **String** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to "PT1H"] +**HttpConfig** | Pointer to [**HttpConfig**](http-config) | | [optional] +**EventBridgeConfig** | Pointer to [**EventBridgeConfig**](event-bridge-config) | | [optional] +**Enabled** | **Boolean** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [required][default to $true] +**VarFilter** | Pointer to **String** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Subscription = Initialize-PSSailpoint.BetaSubscription -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -Name Access request subscription ` + -Description Access requested to site xyz ` + -TriggerId idn:access-request-post-approval ` + -TriggerName Access Requested ` + -Type null ` + -ResponseDeadline PT1H ` + -HttpConfig null ` + -EventBridgeConfig null ` + -Enabled true ` + -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] +``` + +- Convert the resource to JSON +```powershell +$Subscription | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SubscriptionPatchRequestInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SubscriptionPatchRequestInner.md new file mode 100644 index 000000000..7c86bf309 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SubscriptionPatchRequestInner.md @@ -0,0 +1,39 @@ +--- +id: beta-subscription-patch-request-inner +title: SubscriptionPatchRequestInner +pagination_label: SubscriptionPatchRequestInner +sidebar_label: SubscriptionPatchRequestInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SubscriptionPatchRequestInner', 'BetaSubscriptionPatchRequestInner'] +slug: /tools/sdk/powershell/beta/models/subscription-patch-request-inner +tags: ['SDK', 'Software Development Kit', 'SubscriptionPatchRequestInner', 'BetaSubscriptionPatchRequestInner'] +--- + + +# SubscriptionPatchRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | **Enum** [ "add", "remove", "replace", "move", "copy" ] | The operation to be performed | [required] +**Path** | **String** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required] +**Value** | Pointer to [**SubscriptionPatchRequestInnerValue**](subscription-patch-request-inner-value) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SubscriptionPatchRequestInner = Initialize-PSSailpoint.BetaSubscriptionPatchRequestInner -Op replace ` + -Path /description ` + -Value null +``` + +- Convert the resource to JSON +```powershell +$SubscriptionPatchRequestInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SubscriptionPatchRequestInnerValue.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SubscriptionPatchRequestInnerValue.md new file mode 100644 index 000000000..8a449c9dd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SubscriptionPatchRequestInnerValue.md @@ -0,0 +1,34 @@ +--- +id: beta-subscription-patch-request-inner-value +title: SubscriptionPatchRequestInnerValue +pagination_label: SubscriptionPatchRequestInnerValue +sidebar_label: SubscriptionPatchRequestInnerValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SubscriptionPatchRequestInnerValue', 'BetaSubscriptionPatchRequestInnerValue'] +slug: /tools/sdk/powershell/beta/models/subscription-patch-request-inner-value +tags: ['SDK', 'Software Development Kit', 'SubscriptionPatchRequestInnerValue', 'BetaSubscriptionPatchRequestInnerValue'] +--- + + +# SubscriptionPatchRequestInnerValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$SubscriptionPatchRequestInnerValue = Initialize-PSSailpoint.BetaSubscriptionPatchRequestInnerValue +``` + +- Convert the resource to JSON +```powershell +$SubscriptionPatchRequestInnerValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SubscriptionPatchRequestInnerValueAnyOfInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SubscriptionPatchRequestInnerValueAnyOfInner.md new file mode 100644 index 000000000..ddf196957 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SubscriptionPatchRequestInnerValueAnyOfInner.md @@ -0,0 +1,34 @@ +--- +id: beta-subscription-patch-request-inner-value-any-of-inner +title: SubscriptionPatchRequestInnerValueAnyOfInner +pagination_label: SubscriptionPatchRequestInnerValueAnyOfInner +sidebar_label: SubscriptionPatchRequestInnerValueAnyOfInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SubscriptionPatchRequestInnerValueAnyOfInner', 'BetaSubscriptionPatchRequestInnerValueAnyOfInner'] +slug: /tools/sdk/powershell/beta/models/subscription-patch-request-inner-value-any-of-inner +tags: ['SDK', 'Software Development Kit', 'SubscriptionPatchRequestInnerValueAnyOfInner', 'BetaSubscriptionPatchRequestInnerValueAnyOfInner'] +--- + + +# SubscriptionPatchRequestInnerValueAnyOfInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$SubscriptionPatchRequestInnerValueAnyOfInner = Initialize-PSSailpoint.BetaSubscriptionPatchRequestInnerValueAnyOfInner +``` + +- Convert the resource to JSON +```powershell +$SubscriptionPatchRequestInnerValueAnyOfInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SubscriptionPostRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SubscriptionPostRequest.md new file mode 100644 index 000000000..74fb9574b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SubscriptionPostRequest.md @@ -0,0 +1,51 @@ +--- +id: beta-subscription-post-request +title: SubscriptionPostRequest +pagination_label: SubscriptionPostRequest +sidebar_label: SubscriptionPostRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SubscriptionPostRequest', 'BetaSubscriptionPostRequest'] +slug: /tools/sdk/powershell/beta/models/subscription-post-request +tags: ['SDK', 'Software Development Kit', 'SubscriptionPostRequest', 'BetaSubscriptionPostRequest'] +--- + + +# SubscriptionPostRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Subscription name. | [required] +**Description** | Pointer to **String** | Subscription description. | [optional] +**TriggerId** | **String** | ID of trigger subscribed to. | [required] +**Type** | [**SubscriptionType**](subscription-type) | | [required] +**ResponseDeadline** | Pointer to **String** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to "PT1H"] +**HttpConfig** | Pointer to [**HttpConfig**](http-config) | | [optional] +**EventBridgeConfig** | Pointer to [**EventBridgeConfig**](event-bridge-config) | | [optional] +**Enabled** | Pointer to **Boolean** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [optional] [default to $true] +**VarFilter** | Pointer to **String** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SubscriptionPostRequest = Initialize-PSSailpoint.BetaSubscriptionPostRequest -Name Access request subscription ` + -Description Access requested to site xyz ` + -TriggerId idn:access-requested ` + -Type null ` + -ResponseDeadline PT1H ` + -HttpConfig null ` + -EventBridgeConfig null ` + -Enabled true ` + -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] +``` + +- Convert the resource to JSON +```powershell +$SubscriptionPostRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SubscriptionPutRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SubscriptionPutRequest.md new file mode 100644 index 000000000..b73384f62 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SubscriptionPutRequest.md @@ -0,0 +1,49 @@ +--- +id: beta-subscription-put-request +title: SubscriptionPutRequest +pagination_label: SubscriptionPutRequest +sidebar_label: SubscriptionPutRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SubscriptionPutRequest', 'BetaSubscriptionPutRequest'] +slug: /tools/sdk/powershell/beta/models/subscription-put-request +tags: ['SDK', 'Software Development Kit', 'SubscriptionPutRequest', 'BetaSubscriptionPutRequest'] +--- + + +# SubscriptionPutRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Subscription name. | [optional] +**Description** | Pointer to **String** | Subscription description. | [optional] +**Type** | Pointer to [**SubscriptionType**](subscription-type) | | [optional] +**ResponseDeadline** | Pointer to **String** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to "PT1H"] +**HttpConfig** | Pointer to [**HttpConfig**](http-config) | | [optional] +**EventBridgeConfig** | Pointer to [**EventBridgeConfig**](event-bridge-config) | | [optional] +**Enabled** | Pointer to **Boolean** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [optional] [default to $true] +**VarFilter** | Pointer to **String** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SubscriptionPutRequest = Initialize-PSSailpoint.BetaSubscriptionPutRequest -Name Access request subscription ` + -Description Access requested to site xyz ` + -Type null ` + -ResponseDeadline PT1H ` + -HttpConfig null ` + -EventBridgeConfig null ` + -Enabled true ` + -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] +``` + +- Convert the resource to JSON +```powershell +$SubscriptionPutRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SubscriptionType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SubscriptionType.md new file mode 100644 index 000000000..a502e9fa2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/SubscriptionType.md @@ -0,0 +1,30 @@ +--- +id: beta-subscription-type +title: SubscriptionType +pagination_label: SubscriptionType +sidebar_label: SubscriptionType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SubscriptionType', 'BetaSubscriptionType'] +slug: /tools/sdk/powershell/beta/models/subscription-type +tags: ['SDK', 'Software Development Kit', 'SubscriptionType', 'BetaSubscriptionType'] +--- + + +# SubscriptionType + +## Enum + + +* `HTTP` (value: `"HTTP"`) + +* `EVENTBRIDGE` (value: `"EVENTBRIDGE"`) + +* `INLINE` (value: `"INLINE"`) + +* `SCRIPT` (value: `"SCRIPT"`) + +* `WORKFLOW` (value: `"WORKFLOW"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Substring.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Substring.md new file mode 100644 index 000000000..e23d3a9a2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Substring.md @@ -0,0 +1,45 @@ +--- +id: beta-substring +title: Substring +pagination_label: Substring +sidebar_label: Substring +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Substring', 'BetaSubstring'] +slug: /tools/sdk/powershell/beta/models/substring +tags: ['SDK', 'Software Development Kit', 'Substring', 'BetaSubstring'] +--- + + +# Substring + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarBegin** | **Int32** | The index of the first character to include in the returned substring. If `begin` is set to -1, the transform will begin at character 0 of the input data | [required] +**BeginOffset** | Pointer to **Int32** | This integer value is the number of characters to add to the begin attribute when returning a substring. This attribute is only used if begin is not -1. | [optional] +**VarEnd** | Pointer to **Int32** | The index of the first character to exclude from the returned substring. If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. | [optional] +**EndOffset** | Pointer to **Int32** | This integer value is the number of characters to add to the end attribute when returning a substring. This attribute is only used if end is provided and is not -1. | [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] + +## Examples + +- Prepare the resource +```powershell +$Substring = Initialize-PSSailpoint.BetaSubstring -VarBegin 1 ` + -BeginOffset 3 ` + -VarEnd 6 ` + -EndOffset 1 ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Substring | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Tag.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Tag.md new file mode 100644 index 000000000..c8d07ef7c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Tag.md @@ -0,0 +1,43 @@ +--- +id: beta-tag +title: Tag +pagination_label: Tag +sidebar_label: Tag +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Tag', 'BetaTag'] +slug: /tools/sdk/powershell/beta/models/tag +tags: ['SDK', 'Software Development Kit', 'Tag', 'BetaTag'] +--- + + +# Tag + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Tag id | [required][readonly] +**Name** | **String** | Name of the tag. | [required] +**Created** | **System.DateTime** | Date the tag was created. | [required][readonly] +**Modified** | **System.DateTime** | Date the tag was last modified. | [required][readonly] +**TagCategoryRefs** | [**[]TagTagCategoryRefsInner**](tag-tag-category-refs-inner) | | [required][readonly] + +## Examples + +- Prepare the resource +```powershell +$Tag = Initialize-PSSailpoint.BetaTag -Id 449ecdc0-d4ff-4341-acf6-92f6f7ce604f ` + -Name PCI ` + -Created 2022-05-04T14:48:49Z ` + -Modified 2022-07-14T16:31:11Z ` + -TagCategoryRefs null +``` + +- Convert the resource to JSON +```powershell +$Tag | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TagTagCategoryRefsInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TagTagCategoryRefsInner.md new file mode 100644 index 000000000..9090d455b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TagTagCategoryRefsInner.md @@ -0,0 +1,39 @@ +--- +id: beta-tag-tag-category-refs-inner +title: TagTagCategoryRefsInner +pagination_label: TagTagCategoryRefsInner +sidebar_label: TagTagCategoryRefsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TagTagCategoryRefsInner', 'BetaTagTagCategoryRefsInner'] +slug: /tools/sdk/powershell/beta/models/tag-tag-category-refs-inner +tags: ['SDK', 'Software Development Kit', 'TagTagCategoryRefsInner', 'BetaTagTagCategoryRefsInner'] +--- + + +# TagTagCategoryRefsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "APPLICATION", "CAMPAIGN", "ENTITLEMENT", "IDENTITY", "ROLE", "SOD_POLICY", "SOURCE" ] | DTO type of the tagged object's category. | [optional] +**Id** | Pointer to **String** | Tagged object's ID. | [optional] +**Name** | Pointer to **String** | Tagged object's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$TagTagCategoryRefsInner = Initialize-PSSailpoint.BetaTagTagCategoryRefsInner -Type ENTITLEMENT ` + -Id 2c91809773dee32014e13e122092014e ` + -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local +``` + +- Convert the resource to JSON +```powershell +$TagTagCategoryRefsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaggedObject.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaggedObject.md new file mode 100644 index 000000000..4008abe99 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaggedObject.md @@ -0,0 +1,37 @@ +--- +id: beta-tagged-object +title: TaggedObject +pagination_label: TaggedObject +sidebar_label: TaggedObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaggedObject', 'BetaTaggedObject'] +slug: /tools/sdk/powershell/beta/models/tagged-object +tags: ['SDK', 'Software Development Kit', 'TaggedObject', 'BetaTaggedObject'] +--- + + +# TaggedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectRef** | Pointer to [**TaggedObjectObjectRef**](tagged-object-object-ref) | | [optional] +**Tags** | Pointer to **[]String** | Labels to be applied to an Object | [optional] + +## Examples + +- Prepare the resource +```powershell +$TaggedObject = Initialize-PSSailpoint.BetaTaggedObject -ObjectRef null ` + -Tags [BU_FINANCE, PCI] +``` + +- Convert the resource to JSON +```powershell +$TaggedObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaggedObjectDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaggedObjectDto.md new file mode 100644 index 000000000..0ac299775 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaggedObjectDto.md @@ -0,0 +1,39 @@ +--- +id: beta-tagged-object-dto +title: TaggedObjectDto +pagination_label: TaggedObjectDto +sidebar_label: TaggedObjectDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaggedObjectDto', 'BetaTaggedObjectDto'] +slug: /tools/sdk/powershell/beta/models/tagged-object-dto +tags: ['SDK', 'Software Development Kit', 'TaggedObjectDto', 'BetaTaggedObjectDto'] +--- + + +# TaggedObjectDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "APPLICATION", "CAMPAIGN", "ENTITLEMENT", "IDENTITY", "ROLE", "SOD_POLICY", "SOURCE" ] | DTO type | [optional] +**Id** | Pointer to **String** | ID of the object this reference applies to | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object this reference applies to | [optional] + +## Examples + +- Prepare the resource +```powershell +$TaggedObjectDto = Initialize-PSSailpoint.BetaTaggedObjectDto -Type IDENTITY ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$TaggedObjectDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaggedObjectObjectRef.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaggedObjectObjectRef.md new file mode 100644 index 000000000..ff33fe89b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaggedObjectObjectRef.md @@ -0,0 +1,39 @@ +--- +id: beta-tagged-object-object-ref +title: TaggedObjectObjectRef +pagination_label: TaggedObjectObjectRef +sidebar_label: TaggedObjectObjectRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaggedObjectObjectRef', 'BetaTaggedObjectObjectRef'] +slug: /tools/sdk/powershell/beta/models/tagged-object-object-ref +tags: ['SDK', 'Software Development Kit', 'TaggedObjectObjectRef', 'BetaTaggedObjectObjectRef'] +--- + + +# TaggedObjectObjectRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "APPLICATION", "CAMPAIGN", "ENTITLEMENT", "IDENTITY", "ROLE", "SOD_POLICY", "SOURCE" ] | DTO type | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] + +## Examples + +- Prepare the resource +```powershell +$TaggedObjectObjectRef = Initialize-PSSailpoint.BetaTaggedObjectObjectRef -Type IDENTITY ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$TaggedObjectObjectRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Target.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Target.md new file mode 100644 index 000000000..f0659680c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Target.md @@ -0,0 +1,39 @@ +--- +id: beta-target +title: Target +pagination_label: Target +sidebar_label: Target +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Target', 'BetaTarget'] +slug: /tools/sdk/powershell/beta/models/target +tags: ['SDK', 'Software Development Kit', 'Target', 'BetaTarget'] +--- + + +# Target + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Target ID | [optional] +**Type** | Pointer to **Enum** [ "APPLICATION", "IDENTITY" ] | Target type | [optional] +**Name** | Pointer to **String** | Target name | [optional] + +## Examples + +- Prepare the resource +```powershell +$Target = Initialize-PSSailpoint.BetaTarget -Id c6dc37bf508149b28ce5b7d90ca4bbf9 ` + -Type APPLICATION ` + -Name Active Directory [source] +``` + +- Convert the resource to JSON +```powershell +$Target | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaskDefinitionSummary.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaskDefinitionSummary.md new file mode 100644 index 000000000..979169f92 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaskDefinitionSummary.md @@ -0,0 +1,45 @@ +--- +id: beta-task-definition-summary +title: TaskDefinitionSummary +pagination_label: TaskDefinitionSummary +sidebar_label: TaskDefinitionSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskDefinitionSummary', 'BetaTaskDefinitionSummary'] +slug: /tools/sdk/powershell/beta/models/task-definition-summary +tags: ['SDK', 'Software Development Kit', 'TaskDefinitionSummary', 'BetaTaskDefinitionSummary'] +--- + + +# TaskDefinitionSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | System-generated unique ID of the TaskDefinition | [required] +**UniqueName** | **String** | Name of the TaskDefinition | [required] +**Description** | **String** | Description of the TaskDefinition | [required] +**ParentName** | **String** | Name of the parent of the TaskDefinition | [required] +**Executor** | **String** | Executor of the TaskDefinition | [required] +**Arguments** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Formal parameters of the TaskDefinition, without values | [required] + +## Examples + +- Prepare the resource +```powershell +$TaskDefinitionSummary = Initialize-PSSailpoint.BetaTaskDefinitionSummary -Id 2c91808475b4334b0175e1dff64b63c5 ` + -UniqueName Cloud Account Aggregation ` + -Description Aggregates from the specified application. ` + -ParentName Cloud Account Aggregation ` + -Executor sailpoint.task.ServiceTaskExecutor ` + -Arguments null +``` + +- Convert the resource to JSON +```powershell +$TaskDefinitionSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaskResultDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaskResultDto.md new file mode 100644 index 000000000..87b0d696a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaskResultDto.md @@ -0,0 +1,39 @@ +--- +id: beta-task-result-dto +title: TaskResultDto +pagination_label: TaskResultDto +sidebar_label: TaskResultDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskResultDto', 'BetaTaskResultDto'] +slug: /tools/sdk/powershell/beta/models/task-result-dto +tags: ['SDK', 'Software Development Kit', 'TaskResultDto', 'BetaTaskResultDto'] +--- + + +# TaskResultDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "TASK_RESULT" ] | Task result DTO type. | [optional] +**Id** | Pointer to **String** | Task result ID. | [optional] +**Name** | Pointer to **String** | Task result display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$TaskResultDto = Initialize-PSSailpoint.BetaTaskResultDto -Type TASK_RESULT ` + -Id 464ae7bf791e49fdb74606a2e4a89635 ` + -Name null +``` + +- Convert the resource to JSON +```powershell +$TaskResultDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaskResultResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaskResultResponse.md new file mode 100644 index 000000000..993b7d5ef --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaskResultResponse.md @@ -0,0 +1,39 @@ +--- +id: beta-task-result-response +title: TaskResultResponse +pagination_label: TaskResultResponse +sidebar_label: TaskResultResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskResultResponse', 'BetaTaskResultResponse'] +slug: /tools/sdk/powershell/beta/models/task-result-response +tags: ['SDK', 'Software Development Kit', 'TaskResultResponse', 'BetaTaskResultResponse'] +--- + + +# TaskResultResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **String** | the type of response reference | [optional] +**Id** | Pointer to **String** | the task ID | [optional] +**Name** | Pointer to **String** | the task name (not used in this endpoint, always null) | [optional] + +## Examples + +- Prepare the resource +```powershell +$TaskResultResponse = Initialize-PSSailpoint.BetaTaskResultResponse -Type TASK_RESULT ` + -Id 78733556-9ea3-4f59-bf69-e5cd92b011b4 ` + -Name null +``` + +- Convert the resource to JSON +```powershell +$TaskResultResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaskResultSimplified.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaskResultSimplified.md new file mode 100644 index 000000000..5cc703cab --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaskResultSimplified.md @@ -0,0 +1,47 @@ +--- +id: beta-task-result-simplified +title: TaskResultSimplified +pagination_label: TaskResultSimplified +sidebar_label: TaskResultSimplified +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskResultSimplified', 'BetaTaskResultSimplified'] +slug: /tools/sdk/powershell/beta/models/task-result-simplified +tags: ['SDK', 'Software Development Kit', 'TaskResultSimplified', 'BetaTaskResultSimplified'] +--- + + +# TaskResultSimplified + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Task identifier | [optional] +**Name** | Pointer to **String** | Task name | [optional] +**Description** | Pointer to **String** | Task description | [optional] +**Launcher** | Pointer to **String** | User or process who launched the task | [optional] +**Completed** | Pointer to **System.DateTime** | Date time of completion | [optional] +**Launched** | Pointer to **System.DateTime** | Date time when the task was launched | [optional] +**CompletionStatus** | Pointer to **Enum** [ "Success", "Warning", "Error", "Terminated", "TempError" ] | Task result status | [optional] + +## Examples + +- Prepare the resource +```powershell +$TaskResultSimplified = Initialize-PSSailpoint.BetaTaskResultSimplified -Id ff8081814d977c21014da056804a0af3 ` + -Name Background Object Terminator c8f030f2-b1a6-4e33-99e8-6935bc18735d ` + -Description Generic task for terminating data in the overlay, used by the TerminationService. ` + -Launcher support ` + -Completed null ` + -Launched null ` + -CompletionStatus Success +``` + +- Convert the resource to JSON +```powershell +$TaskResultSimplified | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaskReturnDetails.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaskReturnDetails.md new file mode 100644 index 000000000..c6e612e98 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaskReturnDetails.md @@ -0,0 +1,37 @@ +--- +id: beta-task-return-details +title: TaskReturnDetails +pagination_label: TaskReturnDetails +sidebar_label: TaskReturnDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskReturnDetails', 'BetaTaskReturnDetails'] +slug: /tools/sdk/powershell/beta/models/task-return-details +tags: ['SDK', 'Software Development Kit', 'TaskReturnDetails', 'BetaTaskReturnDetails'] +--- + + +# TaskReturnDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Display name of the TaskReturnDetails | [required] +**AttributeName** | **String** | Attribute the TaskReturnDetails is for | [required] + +## Examples + +- Prepare the resource +```powershell +$TaskReturnDetails = Initialize-PSSailpoint.BetaTaskReturnDetails -Name label ` + -AttributeName identityCount +``` + +- Convert the resource to JSON +```powershell +$TaskReturnDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaskStatus.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaskStatus.md new file mode 100644 index 000000000..be95282fe --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaskStatus.md @@ -0,0 +1,69 @@ +--- +id: beta-task-status +title: TaskStatus +pagination_label: TaskStatus +sidebar_label: TaskStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskStatus', 'BetaTaskStatus'] +slug: /tools/sdk/powershell/beta/models/task-status +tags: ['SDK', 'Software Development Kit', 'TaskStatus', 'BetaTaskStatus'] +--- + + +# TaskStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | System-generated unique ID of the task this TaskStatus represents | [required] +**Type** | **Enum** [ "QUARTZ", "QPOC", "QUEUED_TASK" ] | Type of task this TaskStatus represents | [required] +**UniqueName** | **String** | Name of the task this TaskStatus represents | [required] +**Description** | **String** | Description of the task this TaskStatus represents | [required] +**ParentName** | **String** | Name of the parent of the task this TaskStatus represents | [required] +**Launcher** | **String** | Service to execute the task this TaskStatus represents | [required] +**Target** | Pointer to [**Target**](target) | | [optional] +**Created** | **System.DateTime** | Creation date of the task this TaskStatus represents | [required] +**Modified** | **System.DateTime** | Last modification date of the task this TaskStatus represents | [required] +**Launched** | **System.DateTime** | Launch date of the task this TaskStatus represents | [required] +**Completed** | **System.DateTime** | Completion date of the task this TaskStatus represents | [required] +**CompletionStatus** | **Enum** [ "SUCCESS", "WARNING", "ERROR", "TERMINATED", "TEMPERROR" ] | Completion status of the task this TaskStatus represents | [required] +**Messages** | [**[]TaskStatusMessage**](task-status-message) | Messages associated with the task this TaskStatus represents | [required] +**Returns** | [**[]TaskReturnDetails**](task-return-details) | Return values from the task this TaskStatus represents | [required] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Attributes of the task this TaskStatus represents | [required] +**Progress** | **String** | Current progress of the task this TaskStatus represents | [required] +**PercentComplete** | **Int32** | Current percentage completion of the task this TaskStatus represents | [required] +**TaskDefinitionSummary** | Pointer to [**TaskDefinitionSummary**](task-definition-summary) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$TaskStatus = Initialize-PSSailpoint.BetaTaskStatus -Id id12345 ` + -Type QUARTZ ` + -UniqueName Big Task ` + -Description A Really Big Task ` + -ParentName Parent Task ` + -Launcher sweep ` + -Target null ` + -Created 2020-07-11T21:23:15Z ` + -Modified 2020-07-11T21:23:15Z ` + -Launched 2020-07-11T21:23:15Z ` + -Completed 2020-07-11T21:23:15Z ` + -CompletionStatus SUCCESS ` + -Messages null ` + -Returns null ` + -Attributes {identityCount=0} ` + -Progress Started ` + -PercentComplete 100 ` + -TaskDefinitionSummary null +``` + +- Convert the resource to JSON +```powershell +$TaskStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaskStatusMessage.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaskStatusMessage.md new file mode 100644 index 000000000..249cfeab0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaskStatusMessage.md @@ -0,0 +1,41 @@ +--- +id: beta-task-status-message +title: TaskStatusMessage +pagination_label: TaskStatusMessage +sidebar_label: TaskStatusMessage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskStatusMessage', 'BetaTaskStatusMessage'] +slug: /tools/sdk/powershell/beta/models/task-status-message +tags: ['SDK', 'Software Development Kit', 'TaskStatusMessage', 'BetaTaskStatusMessage'] +--- + + +# TaskStatusMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "INFO", "WARN", "ERROR" ] | Type of the message | [required] +**LocalizedText** | [**LocalizedMessage**](localized-message) | | [required] +**Key** | **String** | Key of the message | [required] +**Parameters** | [**[]TaskStatusMessageParametersInner**](task-status-message-parameters-inner) | Message parameters for internationalization | [required] + +## Examples + +- Prepare the resource +```powershell +$TaskStatusMessage = Initialize-PSSailpoint.BetaTaskStatusMessage -Type INFO ` + -LocalizedText null ` + -Key akey ` + -Parameters [{name=value}] +``` + +- Convert the resource to JSON +```powershell +$TaskStatusMessage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaskStatusMessageParametersInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaskStatusMessageParametersInner.md new file mode 100644 index 000000000..1aca985b0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TaskStatusMessageParametersInner.md @@ -0,0 +1,34 @@ +--- +id: beta-task-status-message-parameters-inner +title: TaskStatusMessageParametersInner +pagination_label: TaskStatusMessageParametersInner +sidebar_label: TaskStatusMessageParametersInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskStatusMessageParametersInner', 'BetaTaskStatusMessageParametersInner'] +slug: /tools/sdk/powershell/beta/models/task-status-message-parameters-inner +tags: ['SDK', 'Software Development Kit', 'TaskStatusMessageParametersInner', 'BetaTaskStatusMessageParametersInner'] +--- + + +# TaskStatusMessageParametersInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$TaskStatusMessageParametersInner = Initialize-PSSailpoint.BetaTaskStatusMessageParametersInner +``` + +- Convert the resource to JSON +```powershell +$TaskStatusMessageParametersInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TemplateBulkDeleteDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TemplateBulkDeleteDto.md new file mode 100644 index 000000000..756dcd7d0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TemplateBulkDeleteDto.md @@ -0,0 +1,39 @@ +--- +id: beta-template-bulk-delete-dto +title: TemplateBulkDeleteDto +pagination_label: TemplateBulkDeleteDto +sidebar_label: TemplateBulkDeleteDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TemplateBulkDeleteDto', 'BetaTemplateBulkDeleteDto'] +slug: /tools/sdk/powershell/beta/models/template-bulk-delete-dto +tags: ['SDK', 'Software Development Kit', 'TemplateBulkDeleteDto', 'BetaTemplateBulkDeleteDto'] +--- + + +# TemplateBulkDeleteDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | **String** | | [required] +**Medium** | Pointer to **Enum** [ "EMAIL", "PHONE", "SMS" ] | | [optional] +**Locale** | Pointer to **String** | The locale for the message text, a BCP 47 language tag. | [optional] + +## Examples + +- Prepare the resource +```powershell +$TemplateBulkDeleteDto = Initialize-PSSailpoint.BetaTemplateBulkDeleteDto -Key cloud_manual_work_item_summary ` + -Medium EMAIL ` + -Locale en +``` + +- Convert the resource to JSON +```powershell +$TemplateBulkDeleteDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TemplateDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TemplateDto.md new file mode 100644 index 000000000..5f5ba7992 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TemplateDto.md @@ -0,0 +1,65 @@ +--- +id: beta-template-dto +title: TemplateDto +pagination_label: TemplateDto +sidebar_label: TemplateDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TemplateDto', 'BetaTemplateDto'] +slug: /tools/sdk/powershell/beta/models/template-dto +tags: ['SDK', 'Software Development Kit', 'TemplateDto', 'BetaTemplateDto'] +--- + + +# TemplateDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | **String** | The key of the template | [required] +**Name** | Pointer to **String** | The name of the Task Manager Subscription | [optional] +**Medium** | **Enum** [ "EMAIL", "PHONE", "SMS", "SLACK", "TEAMS" ] | The message medium. More mediums may be added in the future. | [required] +**Locale** | **String** | The locale for the message text, a BCP 47 language tag. | [required] +**Subject** | Pointer to **String** | The subject line in the template | [optional] +**Header** | Pointer to **String** | The header value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**Body** | Pointer to **String** | The body in the template | [optional] +**Footer** | Pointer to **String** | The footer value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**VarFrom** | Pointer to **String** | The ""From:"" address in the template | [optional] +**ReplyTo** | Pointer to **String** | The ""Reply To"" line in the template | [optional] +**Description** | Pointer to **String** | The description in the template | [optional] +**Id** | Pointer to **String** | This is auto-generated. | [optional] +**Created** | Pointer to **System.DateTime** | The time when this template is created. This is auto-generated. | [optional] +**Modified** | Pointer to **System.DateTime** | The time when this template was last modified. This is auto-generated. | [optional] +**SlackTemplate** | Pointer to **String** | | [optional] +**TeamsTemplate** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$TemplateDto = Initialize-PSSailpoint.BetaTemplateDto -Key cloud_manual_work_item_summary ` + -Name Task Manager Subscription ` + -Medium EMAIL ` + -Locale en ` + -Subject You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}. ` + -Header null ` + -Body Please go to the task manager ` + -Footer null ` + -VarFrom $__global.emailFromAddress ` + -ReplyTo $__global.emailFromAddress ` + -Description Daily digest - sent if number of outstanding tasks for task owner > 0 ` + -Id c17bea3a-574d-453c-9e04-4365fbf5af0b ` + -Created 2020-01-01T00:00Z ` + -Modified 2020-01-01T00:00Z ` + -SlackTemplate null ` + -TeamsTemplate null +``` + +- Convert the resource to JSON +```powershell +$TemplateDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TemplateDtoDefault.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TemplateDtoDefault.md new file mode 100644 index 000000000..07ed8d01d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TemplateDtoDefault.md @@ -0,0 +1,59 @@ +--- +id: beta-template-dto-default +title: TemplateDtoDefault +pagination_label: TemplateDtoDefault +sidebar_label: TemplateDtoDefault +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TemplateDtoDefault', 'BetaTemplateDtoDefault'] +slug: /tools/sdk/powershell/beta/models/template-dto-default +tags: ['SDK', 'Software Development Kit', 'TemplateDtoDefault', 'BetaTemplateDtoDefault'] +--- + + +# TemplateDtoDefault + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **String** | The key of the default template | [optional] +**Name** | Pointer to **String** | The name of the default template | [optional] +**Medium** | Pointer to **Enum** [ "EMAIL", "PHONE", "SMS", "SLACK", "TEAMS" ] | The message medium. More mediums may be added in the future. | [optional] +**Locale** | Pointer to **String** | The locale for the message text, a BCP 47 language tag. | [optional] +**Subject** | Pointer to **String** | The subject of the default template | [optional] +**Header** | Pointer to **String** | The header value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**Body** | Pointer to **String** | The body of the default template | [optional] +**Footer** | Pointer to **String** | The footer value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**VarFrom** | Pointer to **String** | The ""From:"" address of the default template | [optional] +**ReplyTo** | Pointer to **String** | The ""Reply To"" field of the default template | [optional] +**Description** | Pointer to **String** | The description of the default template | [optional] +**SlackTemplate** | Pointer to [**TemplateSlack**](template-slack) | | [optional] +**TeamsTemplate** | Pointer to [**TemplateTeams**](template-teams) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$TemplateDtoDefault = Initialize-PSSailpoint.BetaTemplateDtoDefault -Key cloud_manual_work_item_summary ` + -Name Task Manager Subscription ` + -Medium EMAIL ` + -Locale en ` + -Subject You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}. ` + -Header null ` + -Body Please go to the task manager ` + -Footer null ` + -VarFrom $__global.emailFromAddress ` + -ReplyTo $__global.emailFromAddress ` + -Description Daily digest - sent if number of outstanding tasks for task owner > 0 ` + -SlackTemplate null ` + -TeamsTemplate null +``` + +- Convert the resource to JSON +```powershell +$TemplateDtoDefault | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TemplateSlack.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TemplateSlack.md new file mode 100644 index 000000000..171074287 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TemplateSlack.md @@ -0,0 +1,55 @@ +--- +id: beta-template-slack +title: TemplateSlack +pagination_label: TemplateSlack +sidebar_label: TemplateSlack +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TemplateSlack', 'BetaTemplateSlack'] +slug: /tools/sdk/powershell/beta/models/template-slack +tags: ['SDK', 'Software Development Kit', 'TemplateSlack', 'BetaTemplateSlack'] +--- + + +# TemplateSlack + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **String** | | [optional] +**Text** | Pointer to **String** | | [optional] +**Blocks** | Pointer to **String** | | [optional] +**Attachments** | Pointer to **String** | | [optional] +**NotificationType** | Pointer to **String** | | [optional] +**ApprovalId** | Pointer to **String** | | [optional] +**RequestId** | Pointer to **String** | | [optional] +**RequestedById** | Pointer to **String** | | [optional] +**IsSubscription** | Pointer to **Boolean** | | [optional] +**AutoApprovalData** | Pointer to [**TemplateSlackAutoApprovalData**](template-slack-auto-approval-data) | | [optional] +**CustomFields** | Pointer to [**TemplateSlackCustomFields**](template-slack-custom-fields) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$TemplateSlack = Initialize-PSSailpoint.BetaTemplateSlack -Key null ` + -Text null ` + -Blocks null ` + -Attachments null ` + -NotificationType null ` + -ApprovalId null ` + -RequestId null ` + -RequestedById null ` + -IsSubscription null ` + -AutoApprovalData null ` + -CustomFields null +``` + +- Convert the resource to JSON +```powershell +$TemplateSlack | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TemplateSlackAutoApprovalData.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TemplateSlackAutoApprovalData.md new file mode 100644 index 000000000..66c78428f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TemplateSlackAutoApprovalData.md @@ -0,0 +1,43 @@ +--- +id: beta-template-slack-auto-approval-data +title: TemplateSlackAutoApprovalData +pagination_label: TemplateSlackAutoApprovalData +sidebar_label: TemplateSlackAutoApprovalData +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TemplateSlackAutoApprovalData', 'BetaTemplateSlackAutoApprovalData'] +slug: /tools/sdk/powershell/beta/models/template-slack-auto-approval-data +tags: ['SDK', 'Software Development Kit', 'TemplateSlackAutoApprovalData', 'BetaTemplateSlackAutoApprovalData'] +--- + + +# TemplateSlackAutoApprovalData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsAutoApproved** | Pointer to **String** | | [optional] +**ItemId** | Pointer to **String** | | [optional] +**ItemType** | Pointer to **String** | | [optional] +**AutoApprovalMessageJSON** | Pointer to **String** | | [optional] +**AutoApprovalTitle** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$TemplateSlackAutoApprovalData = Initialize-PSSailpoint.BetaTemplateSlackAutoApprovalData -IsAutoApproved null ` + -ItemId null ` + -ItemType null ` + -AutoApprovalMessageJSON null ` + -AutoApprovalTitle null +``` + +- Convert the resource to JSON +```powershell +$TemplateSlackAutoApprovalData | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TemplateSlackCustomFields.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TemplateSlackCustomFields.md new file mode 100644 index 000000000..80bcf722a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TemplateSlackCustomFields.md @@ -0,0 +1,41 @@ +--- +id: beta-template-slack-custom-fields +title: TemplateSlackCustomFields +pagination_label: TemplateSlackCustomFields +sidebar_label: TemplateSlackCustomFields +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TemplateSlackCustomFields', 'BetaTemplateSlackCustomFields'] +slug: /tools/sdk/powershell/beta/models/template-slack-custom-fields +tags: ['SDK', 'Software Development Kit', 'TemplateSlackCustomFields', 'BetaTemplateSlackCustomFields'] +--- + + +# TemplateSlackCustomFields + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestType** | Pointer to **String** | | [optional] +**ContainsDeny** | Pointer to **String** | | [optional] +**CampaignId** | Pointer to **String** | | [optional] +**CampaignStatus** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$TemplateSlackCustomFields = Initialize-PSSailpoint.BetaTemplateSlackCustomFields -RequestType null ` + -ContainsDeny null ` + -CampaignId null ` + -CampaignStatus null +``` + +- Convert the resource to JSON +```powershell +$TemplateSlackCustomFields | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TemplateTeams.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TemplateTeams.md new file mode 100644 index 000000000..3a98f22dd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TemplateTeams.md @@ -0,0 +1,55 @@ +--- +id: beta-template-teams +title: TemplateTeams +pagination_label: TemplateTeams +sidebar_label: TemplateTeams +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TemplateTeams', 'BetaTemplateTeams'] +slug: /tools/sdk/powershell/beta/models/template-teams +tags: ['SDK', 'Software Development Kit', 'TemplateTeams', 'BetaTemplateTeams'] +--- + + +# TemplateTeams + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **String** | | [optional] +**Title** | Pointer to **String** | | [optional] +**Text** | Pointer to **String** | | [optional] +**MessageJSON** | Pointer to **String** | | [optional] +**IsSubscription** | Pointer to **Boolean** | | [optional] +**ApprovalId** | Pointer to **String** | | [optional] +**RequestId** | Pointer to **String** | | [optional] +**RequestedById** | Pointer to **String** | | [optional] +**NotificationType** | Pointer to **String** | | [optional] +**AutoApprovalData** | Pointer to [**TemplateSlackAutoApprovalData**](template-slack-auto-approval-data) | | [optional] +**CustomFields** | Pointer to [**TemplateSlackCustomFields**](template-slack-custom-fields) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$TemplateTeams = Initialize-PSSailpoint.BetaTemplateTeams -Key null ` + -Title null ` + -Text null ` + -MessageJSON null ` + -IsSubscription null ` + -ApprovalId null ` + -RequestId null ` + -RequestedById null ` + -NotificationType null ` + -AutoApprovalData null ` + -CustomFields null +``` + +- Convert the resource to JSON +```powershell +$TemplateTeams | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Tenant.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Tenant.md new file mode 100644 index 000000000..f1fddcd82 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Tenant.md @@ -0,0 +1,47 @@ +--- +id: beta-tenant +title: Tenant +pagination_label: Tenant +sidebar_label: Tenant +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Tenant', 'BetaTenant'] +slug: /tools/sdk/powershell/beta/models/tenant +tags: ['SDK', 'Software Development Kit', 'Tenant', 'BetaTenant'] +--- + + +# Tenant + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The unique identifier for the Tenant | [optional] [readonly] +**Name** | Pointer to **String** | Abbreviated name of the Tenant | [optional] +**FullName** | Pointer to **String** | Human-readable name of the Tenant | [optional] +**Pod** | Pointer to **String** | Deployment pod for the Tenant | [optional] +**Region** | Pointer to **String** | Deployment region for the Tenant | [optional] +**Description** | Pointer to **String** | Description of the Tenant | [optional] +**Products** | Pointer to [**[]Product**](product) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Tenant = Initialize-PSSailpoint.BetaTenant -Id 2c91808568c529c60168cca6f90c1324 ` + -Name acme ` + -FullName Acme, Inc ` + -Pod example-pod ` + -Region us-east-1 ` + -Description Description of the Tenant ` + -Products null +``` + +- Convert the resource to JSON +```powershell +$Tenant | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TenantConfigurationDetails.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TenantConfigurationDetails.md new file mode 100644 index 000000000..43ff878c7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TenantConfigurationDetails.md @@ -0,0 +1,35 @@ +--- +id: beta-tenant-configuration-details +title: TenantConfigurationDetails +pagination_label: TenantConfigurationDetails +sidebar_label: TenantConfigurationDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TenantConfigurationDetails', 'BetaTenantConfigurationDetails'] +slug: /tools/sdk/powershell/beta/models/tenant-configuration-details +tags: ['SDK', 'Software Development Kit', 'TenantConfigurationDetails', 'BetaTenantConfigurationDetails'] +--- + + +# TenantConfigurationDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Disabled** | Pointer to **Boolean** | Flag to determine if Reassignment Configuration is enabled or disabled for a tenant. When this flag is set to true, Reassignment Configuration is disabled. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$TenantConfigurationDetails = Initialize-PSSailpoint.BetaTenantConfigurationDetails -Disabled true +``` + +- Convert the resource to JSON +```powershell +$TenantConfigurationDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TenantConfigurationRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TenantConfigurationRequest.md new file mode 100644 index 000000000..16585702e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TenantConfigurationRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-tenant-configuration-request +title: TenantConfigurationRequest +pagination_label: TenantConfigurationRequest +sidebar_label: TenantConfigurationRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TenantConfigurationRequest', 'BetaTenantConfigurationRequest'] +slug: /tools/sdk/powershell/beta/models/tenant-configuration-request +tags: ['SDK', 'Software Development Kit', 'TenantConfigurationRequest', 'BetaTenantConfigurationRequest'] +--- + + +# TenantConfigurationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConfigDetails** | Pointer to [**TenantConfigurationDetails**](tenant-configuration-details) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$TenantConfigurationRequest = Initialize-PSSailpoint.BetaTenantConfigurationRequest -ConfigDetails null +``` + +- Convert the resource to JSON +```powershell +$TenantConfigurationRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TenantConfigurationResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TenantConfigurationResponse.md new file mode 100644 index 000000000..ee782813e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TenantConfigurationResponse.md @@ -0,0 +1,37 @@ +--- +id: beta-tenant-configuration-response +title: TenantConfigurationResponse +pagination_label: TenantConfigurationResponse +sidebar_label: TenantConfigurationResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TenantConfigurationResponse', 'BetaTenantConfigurationResponse'] +slug: /tools/sdk/powershell/beta/models/tenant-configuration-response +tags: ['SDK', 'Software Development Kit', 'TenantConfigurationResponse', 'BetaTenantConfigurationResponse'] +--- + + +# TenantConfigurationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AuditDetails** | Pointer to [**AuditDetails**](audit-details) | | [optional] +**ConfigDetails** | Pointer to [**TenantConfigurationDetails**](tenant-configuration-details) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$TenantConfigurationResponse = Initialize-PSSailpoint.BetaTenantConfigurationResponse -AuditDetails null ` + -ConfigDetails null +``` + +- Convert the resource to JSON +```powershell +$TenantConfigurationResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TenantUiMetadataItemResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TenantUiMetadataItemResponse.md new file mode 100644 index 000000000..ae32c3acc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TenantUiMetadataItemResponse.md @@ -0,0 +1,39 @@ +--- +id: beta-tenant-ui-metadata-item-response +title: TenantUiMetadataItemResponse +pagination_label: TenantUiMetadataItemResponse +sidebar_label: TenantUiMetadataItemResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TenantUiMetadataItemResponse', 'BetaTenantUiMetadataItemResponse'] +slug: /tools/sdk/powershell/beta/models/tenant-ui-metadata-item-response +tags: ['SDK', 'Software Development Kit', 'TenantUiMetadataItemResponse', 'BetaTenantUiMetadataItemResponse'] +--- + + +# TenantUiMetadataItemResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IframeWhiteList** | Pointer to **String** | Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use ""null"". It will only allow include into iframe non authenticated portions of the product, such as password reset. | [optional] +**UsernameLabel** | Pointer to **String** | Descriptor for the username input field. If you would like to reset the value use ""null"". | [optional] +**UsernameEmptyText** | Pointer to **String** | Placeholder text displayed in the username input field. If you would like to reset the value use ""null"". | [optional] + +## Examples + +- Prepare the resource +```powershell +$TenantUiMetadataItemResponse = Initialize-PSSailpoint.BetaTenantUiMetadataItemResponse -IframeWhiteList http://example.com http://example2.com ` + -UsernameLabel Email ` + -UsernameEmptyText Please provide your work email address... +``` + +- Convert the resource to JSON +```powershell +$TenantUiMetadataItemResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TenantUiMetadataItemUpdateRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TenantUiMetadataItemUpdateRequest.md new file mode 100644 index 000000000..bbb1a3de4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TenantUiMetadataItemUpdateRequest.md @@ -0,0 +1,39 @@ +--- +id: beta-tenant-ui-metadata-item-update-request +title: TenantUiMetadataItemUpdateRequest +pagination_label: TenantUiMetadataItemUpdateRequest +sidebar_label: TenantUiMetadataItemUpdateRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TenantUiMetadataItemUpdateRequest', 'BetaTenantUiMetadataItemUpdateRequest'] +slug: /tools/sdk/powershell/beta/models/tenant-ui-metadata-item-update-request +tags: ['SDK', 'Software Development Kit', 'TenantUiMetadataItemUpdateRequest', 'BetaTenantUiMetadataItemUpdateRequest'] +--- + + +# TenantUiMetadataItemUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IframeWhiteList** | Pointer to **String** | Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use ""null"". It will only allow include into iframe non authenticated portions of the product, such as password reset. | [optional] +**UsernameLabel** | Pointer to **String** | Descriptor for the username input field. If you would like to reset the value use ""null"". | [optional] +**UsernameEmptyText** | Pointer to **String** | Placeholder text displayed in the username input field. If you would like to reset the value use ""null"". | [optional] + +## Examples + +- Prepare the resource +```powershell +$TenantUiMetadataItemUpdateRequest = Initialize-PSSailpoint.BetaTenantUiMetadataItemUpdateRequest -IframeWhiteList http://example.com http://example2.com ` + -UsernameLabel Email ` + -UsernameEmptyText Please provide your work email address... +``` + +- Convert the resource to JSON +```powershell +$TenantUiMetadataItemUpdateRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TestExternalExecuteWorkflow200Response.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TestExternalExecuteWorkflow200Response.md new file mode 100644 index 000000000..8a92c1f90 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TestExternalExecuteWorkflow200Response.md @@ -0,0 +1,35 @@ +--- +id: beta-test-external-execute-workflow200-response +title: TestExternalExecuteWorkflow200Response +pagination_label: TestExternalExecuteWorkflow200Response +sidebar_label: TestExternalExecuteWorkflow200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TestExternalExecuteWorkflow200Response', 'BetaTestExternalExecuteWorkflow200Response'] +slug: /tools/sdk/powershell/beta/models/test-external-execute-workflow200-response +tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflow200Response', 'BetaTestExternalExecuteWorkflow200Response'] +--- + + +# TestExternalExecuteWorkflow200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Payload** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The input that was received | [optional] + +## Examples + +- Prepare the resource +```powershell +$TestExternalExecuteWorkflow200Response = Initialize-PSSailpoint.BetaTestExternalExecuteWorkflow200Response -Payload {test=hello world} +``` + +- Convert the resource to JSON +```powershell +$TestExternalExecuteWorkflow200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TestExternalExecuteWorkflowRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TestExternalExecuteWorkflowRequest.md new file mode 100644 index 000000000..346e155bd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TestExternalExecuteWorkflowRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-test-external-execute-workflow-request +title: TestExternalExecuteWorkflowRequest +pagination_label: TestExternalExecuteWorkflowRequest +sidebar_label: TestExternalExecuteWorkflowRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TestExternalExecuteWorkflowRequest', 'BetaTestExternalExecuteWorkflowRequest'] +slug: /tools/sdk/powershell/beta/models/test-external-execute-workflow-request +tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflowRequest', 'BetaTestExternalExecuteWorkflowRequest'] +--- + + +# TestExternalExecuteWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarInput** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The test input for the workflow | [optional] + +## Examples + +- Prepare the resource +```powershell +$TestExternalExecuteWorkflowRequest = Initialize-PSSailpoint.BetaTestExternalExecuteWorkflowRequest -VarInput {test=hello world} +``` + +- Convert the resource to JSON +```powershell +$TestExternalExecuteWorkflowRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TestInvocation.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TestInvocation.md new file mode 100644 index 000000000..66ecfcc96 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TestInvocation.md @@ -0,0 +1,41 @@ +--- +id: beta-test-invocation +title: TestInvocation +pagination_label: TestInvocation +sidebar_label: TestInvocation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TestInvocation', 'BetaTestInvocation'] +slug: /tools/sdk/powershell/beta/models/test-invocation +tags: ['SDK', 'Software Development Kit', 'TestInvocation', 'BetaTestInvocation'] +--- + + +# TestInvocation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TriggerId** | **String** | Trigger ID | [required] +**VarInput** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Mock input to use for test invocation. This must adhere to the input schema defined in the trigger being invoked. If this property is omitted, then the default trigger sample payload will be sent. | [optional] +**ContentJson** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | JSON map of invocation metadata. | [required] +**SubscriptionIds** | Pointer to **[]String** | Only send the test event to the subscription IDs listed. If omitted, the test event will be sent to all subscribers. | [optional] + +## Examples + +- Prepare the resource +```powershell +$TestInvocation = Initialize-PSSailpoint.BetaTestInvocation -TriggerId idn:access-request-post-approval ` + -VarInput {identityId=201327fda1c44704ac01181e963d463c} ` + -ContentJson {workflowId=1234} ` + -SubscriptionIds [0f11f2a4-7c94-4bf3-a2bd-742580fe3bde] +``` + +- Convert the resource to JSON +```powershell +$TestInvocation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TestSourceConnectionMultihost200Response.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TestSourceConnectionMultihost200Response.md new file mode 100644 index 000000000..d823f27f6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TestSourceConnectionMultihost200Response.md @@ -0,0 +1,43 @@ +--- +id: beta-test-source-connection-multihost200-response +title: TestSourceConnectionMultihost200Response +pagination_label: TestSourceConnectionMultihost200Response +sidebar_label: TestSourceConnectionMultihost200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TestSourceConnectionMultihost200Response', 'BetaTestSourceConnectionMultihost200Response'] +slug: /tools/sdk/powershell/beta/models/test-source-connection-multihost200-response +tags: ['SDK', 'Software Development Kit', 'TestSourceConnectionMultihost200Response', 'BetaTestSourceConnectionMultihost200Response'] +--- + + +# TestSourceConnectionMultihost200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Success** | Pointer to **Boolean** | Source's test connection status. | [optional] +**Message** | Pointer to **String** | Source's test connection message. | [optional] +**Timing** | Pointer to **Int32** | Source's test connection timing. | [optional] +**ResultType** | Pointer to **Enum** [ "SOURCE_STATE_ERROR_CLUSTER", "SOURCE_STATE_ERROR_SOURCE", "SOURCE_STATE_ERROR_VA", "SOURCE_STATE_FAILURE_CLUSTER", "SOURCE_STATE_FAILURE_SOURCE", "SOURCE_STATE_HEALTHY", "SOURCE_STATE_UNCHECKED_CLUSTER", "SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES", "SOURCE_STATE_UNCHECKED_SOURCE", "SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS", "SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT" ] | Source's human-readable result type. | [optional] +**TestConnectionDetails** | Pointer to **String** | Source's human-readable test connection details. | [optional] + +## Examples + +- Prepare the resource +```powershell +$TestSourceConnectionMultihost200Response = Initialize-PSSailpoint.BetaTestSourceConnectionMultihost200Response -Success true ` + -Message Tes. ` + -Timing null ` + -ResultType SOURCE_STATE_HEALTHY ` + -TestConnectionDetails null +``` + +- Convert the resource to JSON +```powershell +$TestSourceConnectionMultihost200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TestWorkflow200Response.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TestWorkflow200Response.md new file mode 100644 index 000000000..c841570ad --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TestWorkflow200Response.md @@ -0,0 +1,35 @@ +--- +id: beta-test-workflow200-response +title: TestWorkflow200Response +pagination_label: TestWorkflow200Response +sidebar_label: TestWorkflow200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TestWorkflow200Response', 'BetaTestWorkflow200Response'] +slug: /tools/sdk/powershell/beta/models/test-workflow200-response +tags: ['SDK', 'Software Development Kit', 'TestWorkflow200Response', 'BetaTestWorkflow200Response'] +--- + + +# TestWorkflow200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**WorkflowExecutionId** | Pointer to **String** | The workflow execution id | [optional] + +## Examples + +- Prepare the resource +```powershell +$TestWorkflow200Response = Initialize-PSSailpoint.BetaTestWorkflow200Response -WorkflowExecutionId 0e11cefa-96e7-4b67-90d0-065bc1da5753 +``` + +- Convert the resource to JSON +```powershell +$TestWorkflow200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TestWorkflowRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TestWorkflowRequest.md new file mode 100644 index 000000000..902b92b2b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TestWorkflowRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-test-workflow-request +title: TestWorkflowRequest +pagination_label: TestWorkflowRequest +sidebar_label: TestWorkflowRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TestWorkflowRequest', 'BetaTestWorkflowRequest'] +slug: /tools/sdk/powershell/beta/models/test-workflow-request +tags: ['SDK', 'Software Development Kit', 'TestWorkflowRequest', 'BetaTestWorkflowRequest'] +--- + + +# TestWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarInput** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The test input for the workflow. | [required] + +## Examples + +- Prepare the resource +```powershell +$TestWorkflowRequest = Initialize-PSSailpoint.BetaTestWorkflowRequest -VarInput null +``` + +- Convert the resource to JSON +```powershell +$TestWorkflowRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TokenAuthRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TokenAuthRequest.md new file mode 100644 index 000000000..72ddffedd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TokenAuthRequest.md @@ -0,0 +1,39 @@ +--- +id: beta-token-auth-request +title: TokenAuthRequest +pagination_label: TokenAuthRequest +sidebar_label: TokenAuthRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TokenAuthRequest', 'BetaTokenAuthRequest'] +slug: /tools/sdk/powershell/beta/models/token-auth-request +tags: ['SDK', 'Software Development Kit', 'TokenAuthRequest', 'BetaTokenAuthRequest'] +--- + + +# TokenAuthRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Token** | **String** | Token value | [required] +**UserAlias** | **String** | User alias from table spt_identity field named 'name' | [required] +**DeliveryType** | **Enum** [ "SMS_PERSONAL", "VOICE_PERSONAL", "SMS_WORK", "VOICE_WORK", "EMAIL_WORK", "EMAIL_PERSONAL" ] | Token delivery type | [required] + +## Examples + +- Prepare the resource +```powershell +$TokenAuthRequest = Initialize-PSSailpoint.BetaTokenAuthRequest -Token 12345 ` + -UserAlias will.albin ` + -DeliveryType EMAIL_WORK +``` + +- Convert the resource to JSON +```powershell +$TokenAuthRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TokenAuthResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TokenAuthResponse.md new file mode 100644 index 000000000..31884f187 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TokenAuthResponse.md @@ -0,0 +1,35 @@ +--- +id: beta-token-auth-response +title: TokenAuthResponse +pagination_label: TokenAuthResponse +sidebar_label: TokenAuthResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TokenAuthResponse', 'BetaTokenAuthResponse'] +slug: /tools/sdk/powershell/beta/models/token-auth-response +tags: ['SDK', 'Software Development Kit', 'TokenAuthResponse', 'BetaTokenAuthResponse'] +--- + + +# TokenAuthResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **Enum** [ "PENDING", "SUCCESS", "FAILED", "LOCKOUT", "NOT_ENOUGH_DATA" ] | MFA Authentication status | [optional] + +## Examples + +- Prepare the resource +```powershell +$TokenAuthResponse = Initialize-PSSailpoint.BetaTokenAuthResponse -Status PENDING +``` + +- Convert the resource to JSON +```powershell +$TokenAuthResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Transform.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Transform.md new file mode 100644 index 000000000..dfdba59b8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Transform.md @@ -0,0 +1,39 @@ +--- +id: beta-transform +title: Transform +pagination_label: Transform +sidebar_label: Transform +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Transform', 'BetaTransform'] +slug: /tools/sdk/powershell/beta/models/transform +tags: ['SDK', 'Software Development Kit', 'Transform', 'BetaTransform'] +--- + + +# Transform + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Unique name of this transform | [required] +**Type** | **Enum** [ "accountAttribute", "base64Decode", "base64Encode", "concat", "conditional", "dateCompare", "dateFormat", "dateMath", "decomposeDiacriticalMarks", "e164phone", "firstValid", "rule", "identityAttribute", "indexOf", "iso3166", "lastIndexOf", "leftPad", "lookup", "lower", "normalizeNames", "randomAlphaNumeric", "randomNumeric", "reference", "replaceAll", "replace", "rightPad", "split", "static", "substring", "trim", "upper", "usernameGenerator", "uuid", "displayName", "rfc5646" ] | The type of transform operation | [required] +**Attributes** | [**TransformAttributes**](transform-attributes) | | [required] + +## Examples + +- Prepare the resource +```powershell +$Transform = Initialize-PSSailpoint.BetaTransform -Name Timestamp To Date ` + -Type dateFormat ` + -Attributes null +``` + +- Convert the resource to JSON +```powershell +$Transform | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TransformAttributes.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TransformAttributes.md new file mode 100644 index 000000000..f8f9bf39a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TransformAttributes.md @@ -0,0 +1,115 @@ +--- +id: beta-transform-attributes +title: TransformAttributes +pagination_label: TransformAttributes +sidebar_label: TransformAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TransformAttributes', 'BetaTransformAttributes'] +slug: /tools/sdk/powershell/beta/models/transform-attributes +tags: ['SDK', 'Software Development Kit', 'TransformAttributes', 'BetaTransformAttributes'] +--- + + +# TransformAttributes + +## Properties + +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] +**Values** | **String** | This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language. | [required] +**Expression** | **String** | A string value of the date and time components to operation on, along with the math operations to execute. | [required] +**PositiveCondition** | **String** | The output of the transform if the expression evalutes to true | [required] +**NegativeCondition** | **String** | The output of the transform if the expression evalutes to false | [required] +**FirstDate** | [**DateCompareFirstDate**](date-compare-first-date) | | [required] +**SecondDate** | [**DateCompareSecondDate**](date-compare-second-date) | | [required] +**Operator** | **Enum** [ "LT", "LTE", "GT", "GTE" ] | This is the comparison to perform. | Operation | Description | | --------- | ------- | | LT | Strictly less than: `firstDate < secondDate` | | LTE | Less than or equal to: `firstDate <= secondDate` | | GT | Strictly greater than: `firstDate > secondDate` | | GTE | Greater than or equal to: `firstDate >= secondDate` | | [required] +**InputFormat** | Pointer to [**DateFormatInputFormat**](date-format-input-format) | | [optional] +**OutputFormat** | Pointer to [**DateFormatOutputFormat**](date-format-output-format) | | [optional] +**RoundUp** | Pointer to **Boolean** | A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. If not provided, the transform will default to `false` `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) | [optional] [default to $false] +**DefaultRegion** | Pointer to **String** | This is an optional attribute that can be used to define the region of the phone number to format into. If defaultRegion is not provided, it will take US as the default country. The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) | [optional] +**IgnoreErrors** | Pointer to **Boolean** | a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. | [optional] [default to $false] +**Name** | **String** | The system (camel-cased) name of the identity attribute to bring in | [required] +**Operation** | **String** | The operation to perform `getReferenceIdentityAttribute` | [required] +**IncludeNumbers** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include numbers | [required] +**IncludeSpecialChars** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include special characters | [required] +**Length** | **String** | An integer value for the desired length of the final output string | [required] +**Uid** | **String** | This is the SailPoint User Name (uid) value of the identity whose attribute is desired As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. | [required] +**Substring** | **String** | A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring. | [required] +**Format** | Pointer to **String** | An optional value to denote which ISO 3166 format to return. Valid values are: `alpha2` - Two-character country code (e.g., ""US""); this is the default value if no format is supplied `alpha3` - Three-character country code (e.g., ""USA"") `numeric` - The numeric country code (e.g., ""840"") | [optional] +**Padding** | Pointer to **String** | A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space ("" "") character for padding | [optional] +**Table** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value. | [required] +**Id** | **String** | This ID specifies the name of the pre-existing transform which you want to use within your current transform | [required] +**Regex** | **String** | This can be a string or a regex pattern in which you want to replace. | [required] +**Replacement** | **String** | This is the replacement string that should be substituded wherever the string or pattern is found. | [required] +**Delimiter** | **String** | This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data | [required] +**Index** | **String** | An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc. | [required] +**Throws** | Pointer to **Boolean** | A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) `true` - The transform should return ""IndexOutOfBoundsException"" `false` - The transform should return null If not provided, the transform will default to false and return a null | [optional] [default to $false] +**VarBegin** | **Int32** | The index of the first character to include in the returned substring. If `begin` is set to -1, the transform will begin at character 0 of the input data | [required] +**BeginOffset** | Pointer to **Int32** | This integer value is the number of characters to add to the begin attribute when returning a substring. This attribute is only used if begin is not -1. | [optional] +**VarEnd** | Pointer to **Int32** | The index of the first character to exclude from the returned substring. If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. | [optional] +**EndOffset** | Pointer to **Int32** | This integer value is the number of characters to add to the end attribute when returning a substring. This attribute is only used if end is provided and is not -1. | [optional] + +## Examples + +- Prepare the resource +```powershell +$TransformAttributes = Initialize-PSSailpoint.BetaTransformAttributes -SourceName Workday ` + -AttributeName DEPARTMENT ` + -AccountSortAttribute created ` + -AccountSortDescending false ` + -AccountReturnFirstLink false ` + -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` + -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` + -Values string$variable ` + -Expression now+1w ` + -PositiveCondition true ` + -NegativeCondition false ` + -FirstDate null ` + -SecondDate null ` + -Operator LT ` + -InputFormat null ` + -OutputFormat null ` + -RoundUp false ` + -DefaultRegion US ` + -IgnoreErrors false ` + -Name email ` + -Operation getReferenceIdentityAttribute ` + -IncludeNumbers true ` + -IncludeSpecialChars true ` + -Length 4 ` + -Uid 2c91808570313110017040b06f344ec9 ` + -Substring admin_ ` + -Format alpha2 ` + -Padding 0 ` + -Table {-= , "=', ñ=n} ` + -Id Existing Transform ` + -Regex [^a-zA-Z] ` + -Replacement ` + -Delimiter , ` + -Index 5 ` + -Throws true ` + -VarBegin 1 ` + -BeginOffset 3 ` + -VarEnd 6 ` + -EndOffset 1 +``` + +- Convert the resource to JSON +```powershell +$TransformAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TransformDefinition.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TransformDefinition.md new file mode 100644 index 000000000..f1756b183 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TransformDefinition.md @@ -0,0 +1,37 @@ +--- +id: beta-transform-definition +title: TransformDefinition +pagination_label: TransformDefinition +sidebar_label: TransformDefinition +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TransformDefinition', 'BetaTransformDefinition'] +slug: /tools/sdk/powershell/beta/models/transform-definition +tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'BetaTransformDefinition'] +--- + + +# TransformDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **String** | The type of the transform definition. | [optional] +**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Arbitrary key-value pairs to store any metadata for the object | [optional] + +## Examples + +- Prepare the resource +```powershell +$TransformDefinition = Initialize-PSSailpoint.BetaTransformDefinition -Type accountAttribute ` + -Attributes {attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53} +``` + +- Convert the resource to JSON +```powershell +$TransformDefinition | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TransformDefinition1.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TransformDefinition1.md new file mode 100644 index 000000000..88d5c9f2d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TransformDefinition1.md @@ -0,0 +1,37 @@ +--- +id: beta-transform-definition1 +title: TransformDefinition1 +pagination_label: TransformDefinition1 +sidebar_label: TransformDefinition1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TransformDefinition1', 'BetaTransformDefinition1'] +slug: /tools/sdk/powershell/beta/models/transform-definition1 +tags: ['SDK', 'Software Development Kit', 'TransformDefinition1', 'BetaTransformDefinition1'] +--- + + +# TransformDefinition1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **String** | The type of the transform definition. | [optional] +**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Arbitrary key-value pairs to store any metadata for the object | [optional] + +## Examples + +- Prepare the resource +```powershell +$TransformDefinition1 = Initialize-PSSailpoint.BetaTransformDefinition1 -Type accountAttribute ` + -Attributes {attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53} +``` + +- Convert the resource to JSON +```powershell +$TransformDefinition1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TransformRead.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TransformRead.md new file mode 100644 index 000000000..81abec684 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TransformRead.md @@ -0,0 +1,43 @@ +--- +id: beta-transform-read +title: TransformRead +pagination_label: TransformRead +sidebar_label: TransformRead +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TransformRead', 'BetaTransformRead'] +slug: /tools/sdk/powershell/beta/models/transform-read +tags: ['SDK', 'Software Development Kit', 'TransformRead', 'BetaTransformRead'] +--- + + +# TransformRead + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Unique name of this transform | [required] +**Type** | **Enum** [ "accountAttribute", "base64Decode", "base64Encode", "concat", "conditional", "dateCompare", "dateFormat", "dateMath", "decomposeDiacriticalMarks", "e164phone", "firstValid", "rule", "identityAttribute", "indexOf", "iso3166", "lastIndexOf", "leftPad", "lookup", "lower", "normalizeNames", "randomAlphaNumeric", "randomNumeric", "reference", "replaceAll", "replace", "rightPad", "split", "static", "substring", "trim", "upper", "usernameGenerator", "uuid", "displayName", "rfc5646" ] | The type of transform operation | [required] +**Attributes** | [**TransformAttributes**](transform-attributes) | | [required] +**Id** | **String** | Unique ID of this transform | [required] +**Internal** | **Boolean** | Indicates whether this is an internal SailPoint-created transform or a customer-created transform | [required][default to $false] + +## Examples + +- Prepare the resource +```powershell +$TransformRead = Initialize-PSSailpoint.BetaTransformRead -Name Timestamp To Date ` + -Type dateFormat ` + -Attributes null ` + -Id 2cd78adghjkja34jh2b1hkjhasuecd ` + -Internal false +``` + +- Convert the resource to JSON +```powershell +$TransformRead | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TransformRule.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TransformRule.md new file mode 100644 index 000000000..a0f894ef0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TransformRule.md @@ -0,0 +1,37 @@ +--- +id: beta-transform-rule +title: TransformRule +pagination_label: TransformRule +sidebar_label: TransformRule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TransformRule', 'BetaTransformRule'] +slug: /tools/sdk/powershell/beta/models/transform-rule +tags: ['SDK', 'Software Development Kit', 'TransformRule', 'BetaTransformRule'] +--- + + +# TransformRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | This is the name of the Transform rule that needs to be invoked by the transform | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$TransformRule = Initialize-PSSailpoint.BetaTransformRule -Name Transform Calculation Rule ` + -RequiresPeriodicRefresh false +``` + +- Convert the resource to JSON +```powershell +$TransformRule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TranslationMessage.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TranslationMessage.md new file mode 100644 index 000000000..9d5e50829 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TranslationMessage.md @@ -0,0 +1,37 @@ +--- +id: beta-translation-message +title: TranslationMessage +pagination_label: TranslationMessage +sidebar_label: TranslationMessage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TranslationMessage', 'BetaTranslationMessage'] +slug: /tools/sdk/powershell/beta/models/translation-message +tags: ['SDK', 'Software Development Kit', 'TranslationMessage', 'BetaTranslationMessage'] +--- + + +# TranslationMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **String** | The key of the translation message | [optional] +**Values** | Pointer to **[]String** | The values corresponding to the translation messages | [optional] + +## Examples + +- Prepare the resource +```powershell +$TranslationMessage = Initialize-PSSailpoint.BetaTranslationMessage -Key recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH ` + -Values [75, department] +``` + +- Convert the resource to JSON +```powershell +$TranslationMessage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Trigger.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Trigger.md new file mode 100644 index 000000000..a069bd51e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Trigger.md @@ -0,0 +1,49 @@ +--- +id: beta-trigger +title: Trigger +pagination_label: Trigger +sidebar_label: Trigger +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Trigger', 'BetaTrigger'] +slug: /tools/sdk/powershell/beta/models/trigger +tags: ['SDK', 'Software Development Kit', 'Trigger', 'BetaTrigger'] +--- + + +# Trigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Unique identifier of the trigger. | [required] +**Name** | **String** | Trigger Name. | [required] +**Type** | [**TriggerType**](trigger-type) | | [required] +**Description** | Pointer to **String** | Trigger Description. | [optional] +**InputSchema** | **String** | The JSON schema of the payload that will be sent by the trigger to the subscribed service. | [required] +**ExampleInput** | [**TriggerExampleInput**](trigger-example-input) | | [required] +**OutputSchema** | Pointer to **String** | The JSON schema of the response that will be sent by the subscribed service to the trigger in response to an event. This only applies to a trigger type of `REQUEST_RESPONSE`. | [optional] +**ExampleOutput** | Pointer to [**TriggerExampleOutput**](trigger-example-output) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Trigger = Initialize-PSSailpoint.BetaTrigger -Id idn:access-request-dynamic-approver ` + -Name Access Request Dynamic Approver ` + -Type null ` + -Description Trigger for getting a dynamic approver. ` + -InputSchema {"definitions":{"record:AccessRequestDynamicApproverInput":{"type":"object","required":["accessRequestId","requestedFor","requestedItems","requestedBy"],"additionalProperties":true,"properties":{"accessRequestId":{"type":"string"},"requestedFor":{"$ref":"#/definitions/record:requestedForIdentityRef"},"requestedItems":{"type":"array","items":{"$ref":"#/definitions/record:requestedObjectRef"}},"requestedBy":{"$ref":"#/definitions/record:requestedByIdentityRef"}}},"record:requestedForIdentityRef":{"type":"object","required":["id","name","type"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}},"record:requestedObjectRef":{"type":"object","optional":["description","comment"],"required":["id","name","type","operation"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"oneOf":[{"type":"null"},{"type":"string"}]},"type":{"type":"string"},"operation":{"type":"string"},"comment":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"record:requestedByIdentityRef":{"type":"object","required":["type","id","name"],"additionalProperties":true,"properties":{"type":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}}},"$ref":"#/definitions/record:AccessRequestDynamicApproverInput"} ` + -ExampleInput null ` + -OutputSchema {"definitions":{"record:AccessRequestDynamicApproverOutput":{"type":["null","object"],"required":["id","name","type"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}},"$ref":"#/definitions/record:AccessRequestDynamicApproverOutput"} ` + -ExampleOutput null +``` + +- Convert the resource to JSON +```powershell +$Trigger | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TriggerExampleInput.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TriggerExampleInput.md new file mode 100644 index 000000000..dfb1deefe --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TriggerExampleInput.md @@ -0,0 +1,131 @@ +--- +id: beta-trigger-example-input +title: TriggerExampleInput +pagination_label: TriggerExampleInput +sidebar_label: TriggerExampleInput +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TriggerExampleInput', 'BetaTriggerExampleInput'] +slug: /tools/sdk/powershell/beta/models/trigger-example-input +tags: ['SDK', 'Software Development Kit', 'TriggerExampleInput', 'BetaTriggerExampleInput'] +--- + + +# TriggerExampleInput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestId** | **String** | The unique ID of the access request. | [required] +**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required] +**RequestedItems** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details of the access items being requested. | [required] +**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required] +**RequestedItemsStatus** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details on the outcome of each access item. | [required] +**Source** | [**AccountUncorrelatedSource**](account-uncorrelated-source) | | [required] +**Status** | **Enum** [ "Success", "Failed", "Terminated" ] | The overall status of the collection. | [required] +**Started** | **System.DateTime** | The date and time when the account collection started. | [required] +**Completed** | **System.DateTime** | The date and time when the account collection finished. | [required] +**Errors** | **[]String** | A list of any accumulated error messages that occurred during provisioning. | [required] +**Warnings** | **[]String** | A list of any accumulated warning messages that occurred during provisioning. | [required] +**Stats** | [**AccountsCollectedForAggregationStats**](accounts-collected-for-aggregation-stats) | | [required] +**Identity** | [**IdentityDeletedIdentity**](identity-deleted-identity) | | [required] +**Account** | [**AccountUncorrelatedAccount**](account-uncorrelated-account) | | [required] +**Changes** | [**[]IdentityAttributesChangedChangesInner**](identity-attributes-changed-changes-inner) | A list of one or more identity attributes that changed on the identity. | [required] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required] +**EntitlementCount** | Pointer to **Int32** | The number of entitlements associated with this account. | [optional] +**Campaign** | [**CampaignGeneratedCampaign**](campaign-generated-campaign) | | [required] +**Certification** | [**CertificationSignedOffCertification**](certification-signed-off-certification) | | [required] +**TrackingNumber** | **String** | The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. | [required] +**Sources** | **String** | One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. | [required] +**Action** | Pointer to **String** | Origin of where the provisioning request came from. | [optional] +**Recipient** | [**ProvisioningCompletedRecipient**](provisioning-completed-recipient) | | [required] +**Requester** | Pointer to [**ProvisioningCompletedRequester**](provisioning-completed-requester) | | [optional] +**AccountRequests** | [**[]ProvisioningCompletedAccountRequestsInner**](provisioning-completed-account-requests-inner) | A list of provisioning instructions to perform on an account-by-account basis. | [required] +**FileName** | **String** | A name for the report file. | [required] +**OwnerEmail** | **String** | The email address of the identity that owns the saved search. | [required] +**OwnerName** | **String** | The name of the identity that owns the saved search. | [required] +**Query** | **String** | The search query that was used to generate the report. | [required] +**SearchName** | **String** | The name of the saved search. | [required] +**SearchResults** | [**SavedSearchCompleteSearchResults**](saved-search-complete-search-results) | | [required] +**SignedS3Url** | **String** | The Amazon S3 URL to download the report from. | [required] +**Uuid** | Pointer to **String** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] +**Id** | **String** | The unique ID of the source. | [required] +**NativeIdentifier** | **String** | Unique ID of the account on the source. | [required] +**SourceId** | **String** | The ID of the source. | [required] +**SourceName** | **String** | The name of the source. | [required] +**IdentityId** | **String** | The ID of the identity that is correlated with this account. | [required] +**IdentityName** | **String** | The name of the identity that is correlated with this account. | [required] +**Name** | **String** | The user friendly name of the source. | [required] +**Type** | **String** | The connection type of the source. | [required] +**Created** | **System.DateTime** | The date and time the status change occurred. | [required] +**Connector** | **String** | The connector type used to connect to the source. | [required] +**Actor** | [**SourceUpdatedActor**](source-updated-actor) | | [required] +**Deleted** | **System.DateTime** | The date and time the source was deleted. | [required] +**Modified** | **System.DateTime** | The date and time the source was modified. | [required] +**Application** | [**VAClusterStatusChangeEventApplication**](va-cluster-status-change-event-application) | | [required] +**HealthCheckResult** | [**VAClusterStatusChangeEventHealthCheckResult**](va-cluster-status-change-event-health-check-result) | | [required] +**PreviousHealthCheckResult** | [**VAClusterStatusChangeEventPreviousHealthCheckResult**](va-cluster-status-change-event-previous-health-check-result) | | [required] + +## Examples + +- Prepare the resource +```powershell +$TriggerExampleInput = Initialize-PSSailpoint.BetaTriggerExampleInput -AccessRequestId 2c91808b6ef1d43e016efba0ce470904 ` + -RequestedFor null ` + -RequestedItems null ` + -RequestedBy null ` + -RequestedItemsStatus null ` + -Source null ` + -Status Success ` + -Started 2020-06-29T22:01:50.474Z ` + -Completed 2020-06-29T22:02:04.090Z ` + -Errors null ` + -Warnings null ` + -Stats null ` + -Identity null ` + -Account null ` + -Changes null ` + -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} ` + -EntitlementCount 0 ` + -Campaign null ` + -Certification null ` + -TrackingNumber 4b4d982dddff4267ab12f0f1e72b5a6d ` + -Sources Corp AD, Corp LDAP, Corp Salesforce ` + -Action IdentityRefresh ` + -Recipient null ` + -Requester null ` + -AccountRequests null ` + -FileName Modified.zip ` + -OwnerEmail test@sailpoint.com ` + -OwnerName Cloud Support ` + -Query modified:[now-7y/d TO now] ` + -SearchName Modified Activity ` + -SearchResults null ` + -SignedS3Url https://sptcbu-org-data-useast1.s3.amazonaws.com/arsenal-john/reports/Events%20Export.2020-05-06%2018%2759%20GMT.3e580592-86e4-4953-8aea-49e6ef20a086.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200506T185919Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=AKIAV5E54XOGTS4Q4L7A%2F20200506%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2e732bb97a12a1fd8a215613e3c31fcdae8ba1fb6a25916843ab5b51d2ddefbc ` + -Uuid b7264868-7201-415f-9118-b581d431c688 ` + -Id 2c9180866166b5b0016167c32ef31a66 ` + -NativeIdentifier E009 ` + -SourceId 2c918082814e693601816e09471b29b6 ` + -SourceName Active Directory ` + -IdentityId ee769173319b41d19ccec6c235423237b ` + -IdentityName john.doe ` + -Name Corporate Active Directory ` + -Type DIRECT_CONNECT ` + -Created 2020-06-29T22:01:50.474Z ` + -Connector active-directory ` + -Actor null ` + -Deleted 2021-03-29T22:01:50.474Z ` + -Modified 2021-03-29T22:01:50.474Z ` + -Application null ` + -HealthCheckResult null ` + -PreviousHealthCheckResult null +``` + +- Convert the resource to JSON +```powershell +$TriggerExampleInput | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TriggerExampleOutput.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TriggerExampleOutput.md new file mode 100644 index 000000000..7e67b3578 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TriggerExampleOutput.md @@ -0,0 +1,45 @@ +--- +id: beta-trigger-example-output +title: TriggerExampleOutput +pagination_label: TriggerExampleOutput +sidebar_label: TriggerExampleOutput +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TriggerExampleOutput', 'BetaTriggerExampleOutput'] +slug: /tools/sdk/powershell/beta/models/trigger-example-output +tags: ['SDK', 'Software Development Kit', 'TriggerExampleOutput', 'BetaTriggerExampleOutput'] +--- + + +# TriggerExampleOutput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the identity to add to the approver list for the access request. | [required] +**Name** | **String** | The name of the identity to add to the approver list for the access request. | [required] +**Type** | **Enum** [ "IDENTITY", "GOVERNANCE_GROUP" ] | The type of object being referenced. | [required] +**Approved** | **Boolean** | Whether or not to approve the access request. | [required] +**Comment** | **String** | A comment about the decision to approve or deny the request. | [required] +**Approver** | **String** | The name of the entity that approved or denied the request. | [required] + +## Examples + +- Prepare the resource +```powershell +$TriggerExampleOutput = Initialize-PSSailpoint.BetaTriggerExampleOutput -Id 2c91808b6ef1d43e016efba0ce470906 ` + -Name Adam Adams ` + -Type IDENTITY ` + -Approved false ` + -Comment This access should be denied, because this will cause an SOD violation. ` + -Approver AcmeCorpExternalIntegration +``` + +- Convert the resource to JSON +```powershell +$TriggerExampleOutput | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TriggerType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TriggerType.md new file mode 100644 index 000000000..8cb1f2148 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/TriggerType.md @@ -0,0 +1,24 @@ +--- +id: beta-trigger-type +title: TriggerType +pagination_label: TriggerType +sidebar_label: TriggerType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TriggerType', 'BetaTriggerType'] +slug: /tools/sdk/powershell/beta/models/trigger-type +tags: ['SDK', 'Software Development Kit', 'TriggerType', 'BetaTriggerType'] +--- + + +# TriggerType + +## Enum + + +* `REQUEST_RESPONSE` (value: `"REQUEST_RESPONSE"`) + +* `FIRE_AND_FORGET` (value: `"FIRE_AND_FORGET"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Trim.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Trim.md new file mode 100644 index 000000000..33e1ce205 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Trim.md @@ -0,0 +1,37 @@ +--- +id: beta-trim +title: Trim +pagination_label: Trim +sidebar_label: Trim +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Trim', 'BetaTrim'] +slug: /tools/sdk/powershell/beta/models/trim +tags: ['SDK', 'Software Development Kit', 'Trim', 'BetaTrim'] +--- + + +# Trim + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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] + +## Examples + +- Prepare the resource +```powershell +$Trim = Initialize-PSSailpoint.BetaTrim -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Trim | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UUIDGenerator.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UUIDGenerator.md new file mode 100644 index 000000000..08a57e1c0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UUIDGenerator.md @@ -0,0 +1,35 @@ +--- +id: beta-uuid-generator +title: UUIDGenerator +pagination_label: UUIDGenerator +sidebar_label: UUIDGenerator +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UUIDGenerator', 'BetaUUIDGenerator'] +slug: /tools/sdk/powershell/beta/models/uuid-generator +tags: ['SDK', 'Software Development Kit', 'UUIDGenerator', 'BetaUUIDGenerator'] +--- + + +# UUIDGenerator + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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] + +## Examples + +- Prepare the resource +```powershell +$UUIDGenerator = Initialize-PSSailpoint.BetaUUIDGenerator -RequiresPeriodicRefresh false +``` + +- Convert the resource to JSON +```powershell +$UUIDGenerator | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UpdateAccessProfilesInBulk412Response.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UpdateAccessProfilesInBulk412Response.md new file mode 100644 index 000000000..c3fb1d28a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UpdateAccessProfilesInBulk412Response.md @@ -0,0 +1,35 @@ +--- +id: beta-update-access-profiles-in-bulk412-response +title: UpdateAccessProfilesInBulk412Response +pagination_label: UpdateAccessProfilesInBulk412Response +sidebar_label: UpdateAccessProfilesInBulk412Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UpdateAccessProfilesInBulk412Response', 'BetaUpdateAccessProfilesInBulk412Response'] +slug: /tools/sdk/powershell/beta/models/update-access-profiles-in-bulk412-response +tags: ['SDK', 'Software Development Kit', 'UpdateAccessProfilesInBulk412Response', 'BetaUpdateAccessProfilesInBulk412Response'] +--- + + +# UpdateAccessProfilesInBulk412Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A message describing the error | [optional] + +## Examples + +- Prepare the resource +```powershell +$UpdateAccessProfilesInBulk412Response = Initialize-PSSailpoint.BetaUpdateAccessProfilesInBulk412Response -Message API/Feature not enabled for your organization. +``` + +- Convert the resource to JSON +```powershell +$UpdateAccessProfilesInBulk412Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UpdateMultiHostSourcesRequestInner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UpdateMultiHostSourcesRequestInner.md new file mode 100644 index 000000000..5ee3ce3dd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UpdateMultiHostSourcesRequestInner.md @@ -0,0 +1,39 @@ +--- +id: beta-update-multi-host-sources-request-inner +title: UpdateMultiHostSourcesRequestInner +pagination_label: UpdateMultiHostSourcesRequestInner +sidebar_label: UpdateMultiHostSourcesRequestInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UpdateMultiHostSourcesRequestInner', 'BetaUpdateMultiHostSourcesRequestInner'] +slug: /tools/sdk/powershell/beta/models/update-multi-host-sources-request-inner +tags: ['SDK', 'Software Development Kit', 'UpdateMultiHostSourcesRequestInner', 'BetaUpdateMultiHostSourcesRequestInner'] +--- + + +# UpdateMultiHostSourcesRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | **Enum** [ "add", "replace" ] | The operation to be performed | [required] +**Path** | **String** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required] +**Value** | Pointer to [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$UpdateMultiHostSourcesRequestInner = Initialize-PSSailpoint.BetaUpdateMultiHostSourcesRequestInner -Op replace ` + -Path /description ` + -Value null +``` + +- Convert the resource to JSON +```powershell +$UpdateMultiHostSourcesRequestInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UpdateMultiHostSourcesRequestInnerValue.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UpdateMultiHostSourcesRequestInnerValue.md new file mode 100644 index 000000000..5d052e8b1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UpdateMultiHostSourcesRequestInnerValue.md @@ -0,0 +1,34 @@ +--- +id: beta-update-multi-host-sources-request-inner-value +title: UpdateMultiHostSourcesRequestInnerValue +pagination_label: UpdateMultiHostSourcesRequestInnerValue +sidebar_label: UpdateMultiHostSourcesRequestInnerValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UpdateMultiHostSourcesRequestInnerValue', 'BetaUpdateMultiHostSourcesRequestInnerValue'] +slug: /tools/sdk/powershell/beta/models/update-multi-host-sources-request-inner-value +tags: ['SDK', 'Software Development Kit', 'UpdateMultiHostSourcesRequestInnerValue', 'BetaUpdateMultiHostSourcesRequestInnerValue'] +--- + + +# UpdateMultiHostSourcesRequestInnerValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$UpdateMultiHostSourcesRequestInnerValue = Initialize-PSSailpoint.BetaUpdateMultiHostSourcesRequestInnerValue +``` + +- Convert the resource to JSON +```powershell +$UpdateMultiHostSourcesRequestInnerValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Upper.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Upper.md new file mode 100644 index 000000000..d5d6a3239 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Upper.md @@ -0,0 +1,37 @@ +--- +id: beta-upper +title: Upper +pagination_label: Upper +sidebar_label: Upper +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Upper', 'BetaUpper'] +slug: /tools/sdk/powershell/beta/models/upper +tags: ['SDK', 'Software Development Kit', 'Upper', 'BetaUpper'] +--- + + +# Upper + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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] + +## Examples + +- Prepare the resource +```powershell +$Upper = Initialize-PSSailpoint.BetaUpper -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Upper | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UsageType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UsageType.md new file mode 100644 index 000000000..4b5883e69 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UsageType.md @@ -0,0 +1,52 @@ +--- +id: beta-usage-type +title: UsageType +pagination_label: UsageType +sidebar_label: UsageType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UsageType', 'BetaUsageType'] +slug: /tools/sdk/powershell/beta/models/usage-type +tags: ['SDK', 'Software Development Kit', 'UsageType', 'BetaUsageType'] +--- + + +# UsageType + +## Enum + + +* `CREATE` (value: `"CREATE"`) + +* `UPDATE` (value: `"UPDATE"`) + +* `ENABLE` (value: `"ENABLE"`) + +* `DISABLE` (value: `"DISABLE"`) + +* `DELETE` (value: `"DELETE"`) + +* `ASSIGN` (value: `"ASSIGN"`) + +* `UNASSIGN` (value: `"UNASSIGN"`) + +* `CREATE_GROUP` (value: `"CREATE_GROUP"`) + +* `UPDATE_GROUP` (value: `"UPDATE_GROUP"`) + +* `DELETE_GROUP` (value: `"DELETE_GROUP"`) + +* `REGISTER` (value: `"REGISTER"`) + +* `CREATE_IDENTITY` (value: `"CREATE_IDENTITY"`) + +* `UPDATE_IDENTITY` (value: `"UPDATE_IDENTITY"`) + +* `EDIT_GROUP` (value: `"EDIT_GROUP"`) + +* `UNLOCK` (value: `"UNLOCK"`) + +* `CHANGE_PASSWORD` (value: `"CHANGE_PASSWORD"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UserApp.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UserApp.md new file mode 100644 index 000000000..f27d17947 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UserApp.md @@ -0,0 +1,55 @@ +--- +id: beta-user-app +title: UserApp +pagination_label: UserApp +sidebar_label: UserApp +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UserApp', 'BetaUserApp'] +slug: /tools/sdk/powershell/beta/models/user-app +tags: ['SDK', 'Software Development Kit', 'UserApp', 'BetaUserApp'] +--- + + +# UserApp + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The user app id | [optional] +**Created** | Pointer to **System.DateTime** | Time when the user app was created | [optional] +**Modified** | Pointer to **System.DateTime** | Time when the user app was last modified | [optional] +**HasMultipleAccounts** | Pointer to **Boolean** | True if the owner has multiple accounts for the source | [optional] [default to $false] +**UseForPasswordManagement** | Pointer to **Boolean** | True if the source has password feature | [optional] [default to $false] +**ProvisionRequestEnabled** | Pointer to **Boolean** | True if the source app related to the user app is provision request enabled | [optional] [default to $false] +**AppCenterEnabled** | Pointer to **Boolean** | True if the source app related to the user app is shown in the app center | [optional] [default to $true] +**SourceApp** | Pointer to [**UserAppSourceApp**](user-app-source-app) | | [optional] +**Source** | Pointer to [**UserAppSource**](user-app-source) | | [optional] +**Account** | Pointer to [**UserAppAccount**](user-app-account) | | [optional] +**Owner** | Pointer to [**UserAppOwner**](user-app-owner) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$UserApp = Initialize-PSSailpoint.BetaUserApp -Id 2c91808874ff91550175097daaec161c ` + -Created 2020-10-08T18:33:52.029Z ` + -Modified 2020-10-08T18:33:52.029Z ` + -HasMultipleAccounts false ` + -UseForPasswordManagement true ` + -ProvisionRequestEnabled true ` + -AppCenterEnabled true ` + -SourceApp null ` + -Source null ` + -Account null ` + -Owner null +``` + +- Convert the resource to JSON +```powershell +$UserApp | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UserAppAccount.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UserAppAccount.md new file mode 100644 index 000000000..a27943f57 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UserAppAccount.md @@ -0,0 +1,39 @@ +--- +id: beta-user-app-account +title: UserAppAccount +pagination_label: UserAppAccount +sidebar_label: UserAppAccount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UserAppAccount', 'BetaUserAppAccount'] +slug: /tools/sdk/powershell/beta/models/user-app-account +tags: ['SDK', 'Software Development Kit', 'UserAppAccount', 'BetaUserAppAccount'] +--- + + +# UserAppAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | the account ID | [optional] +**Type** | Pointer to **String** | It will always be ""ACCOUNT"" | [optional] +**Name** | Pointer to **String** | the account name | [optional] + +## Examples + +- Prepare the resource +```powershell +$UserAppAccount = Initialize-PSSailpoint.BetaUserAppAccount -Id 85d173e7d57e496569df763231d6deb6a ` + -Type ACCOUNT ` + -Name test account +``` + +- Convert the resource to JSON +```powershell +$UserAppAccount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UserAppOwner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UserAppOwner.md new file mode 100644 index 000000000..2068e6cd3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UserAppOwner.md @@ -0,0 +1,41 @@ +--- +id: beta-user-app-owner +title: UserAppOwner +pagination_label: UserAppOwner +sidebar_label: UserAppOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UserAppOwner', 'BetaUserAppOwner'] +slug: /tools/sdk/powershell/beta/models/user-app-owner +tags: ['SDK', 'Software Development Kit', 'UserAppOwner', 'BetaUserAppOwner'] +--- + + +# UserAppOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The identity ID | [optional] +**Type** | Pointer to **String** | It will always be ""IDENTITY"" | [optional] +**Name** | Pointer to **String** | The identity name | [optional] +**Alias** | Pointer to **String** | The identity alias | [optional] + +## Examples + +- Prepare the resource +```powershell +$UserAppOwner = Initialize-PSSailpoint.BetaUserAppOwner -Id 2c9180827ca885d7017ca8ce28a000eb ` + -Type IDENTITY ` + -Name John ` + -Alias John.Doe +``` + +- Convert the resource to JSON +```powershell +$UserAppOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UserAppSource.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UserAppSource.md new file mode 100644 index 000000000..0f87137a8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UserAppSource.md @@ -0,0 +1,39 @@ +--- +id: beta-user-app-source +title: UserAppSource +pagination_label: UserAppSource +sidebar_label: UserAppSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UserAppSource', 'BetaUserAppSource'] +slug: /tools/sdk/powershell/beta/models/user-app-source +tags: ['SDK', 'Software Development Kit', 'UserAppSource', 'BetaUserAppSource'] +--- + + +# UserAppSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | the source ID | [optional] +**Type** | Pointer to **String** | It will always be ""SOURCE"" | [optional] +**Name** | Pointer to **String** | the source name | [optional] + +## Examples + +- Prepare the resource +```powershell +$UserAppSource = Initialize-PSSailpoint.BetaUserAppSource -Id 9870808a7190d06e01719938fcd20792 ` + -Type SOURCE ` + -Name test-source +``` + +- Convert the resource to JSON +```powershell +$UserAppSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UserAppSourceApp.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UserAppSourceApp.md new file mode 100644 index 000000000..348de4a1b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/UserAppSourceApp.md @@ -0,0 +1,39 @@ +--- +id: beta-user-app-source-app +title: UserAppSourceApp +pagination_label: UserAppSourceApp +sidebar_label: UserAppSourceApp +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UserAppSourceApp', 'BetaUserAppSourceApp'] +slug: /tools/sdk/powershell/beta/models/user-app-source-app +tags: ['SDK', 'Software Development Kit', 'UserAppSourceApp', 'BetaUserAppSourceApp'] +--- + + +# UserAppSourceApp + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | the source app ID | [optional] +**Type** | Pointer to **String** | It will always be ""APPLICATION"" | [optional] +**Name** | Pointer to **String** | the source app name | [optional] + +## Examples + +- Prepare the resource +```powershell +$UserAppSourceApp = Initialize-PSSailpoint.BetaUserAppSourceApp -Id edcb0951812949d085b60cd8bf35bc78 ` + -Type APPLICATION ` + -Name test-app +``` + +- Convert the resource to JSON +```powershell +$UserAppSourceApp | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/V3ConnectorDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/V3ConnectorDto.md new file mode 100644 index 000000000..5d4bce9b3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/V3ConnectorDto.md @@ -0,0 +1,49 @@ +--- +id: beta-v3-connector-dto +title: V3ConnectorDto +pagination_label: V3ConnectorDto +sidebar_label: V3ConnectorDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'V3ConnectorDto', 'BetaV3ConnectorDto'] +slug: /tools/sdk/powershell/beta/models/v3-connector-dto +tags: ['SDK', 'Software Development Kit', 'V3ConnectorDto', 'BetaV3ConnectorDto'] +--- + + +# V3ConnectorDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The connector name | [optional] +**Type** | Pointer to **String** | The connector type | [optional] +**ScriptName** | Pointer to **String** | The connector script name | [optional] +**ClassName** | Pointer to **String** | The connector class name. | [optional] +**Features** | Pointer to **[]String** | The list of features supported by the connector | [optional] +**DirectConnect** | Pointer to **Boolean** | true if the source is a direct connect source | [optional] [default to $false] +**ConnectorMetadata** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Object containing metadata pertinent to the UI to be used | [optional] +**Status** | Pointer to **String** | The connector status | [optional] + +## Examples + +- Prepare the resource +```powershell +$V3ConnectorDto = Initialize-PSSailpoint.BetaV3ConnectorDto -Name name ` + -Type ServiceNow ` + -ScriptName servicenow ` + -ClassName sailpoint.connector.OpenConnectorAdapter ` + -Features [PROVISIONING, SYNC_PROVISIONING, SEARCH, UNSTRUCTURED_TARGETS] ` + -DirectConnect true ` + -ConnectorMetadata {supportedUI=EXTJS, platform=ccg, shortDesc=connector description} ` + -Status RELEASED +``` + +- Convert the resource to JSON +```powershell +$V3ConnectorDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VAClusterStatusChangeEvent.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VAClusterStatusChangeEvent.md new file mode 100644 index 000000000..2bd2a2cc3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VAClusterStatusChangeEvent.md @@ -0,0 +1,43 @@ +--- +id: beta-va-cluster-status-change-event +title: VAClusterStatusChangeEvent +pagination_label: VAClusterStatusChangeEvent +sidebar_label: VAClusterStatusChangeEvent +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VAClusterStatusChangeEvent', 'BetaVAClusterStatusChangeEvent'] +slug: /tools/sdk/powershell/beta/models/va-cluster-status-change-event +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEvent', 'BetaVAClusterStatusChangeEvent'] +--- + + +# VAClusterStatusChangeEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | **System.DateTime** | The date and time the status change occurred. | [required] +**Type** | **Enum** [ "SOURCE", "CLUSTER" ] | The type of the object that initiated this event. | [required] +**Application** | [**VAClusterStatusChangeEventApplication**](va-cluster-status-change-event-application) | | [required] +**HealthCheckResult** | [**VAClusterStatusChangeEventHealthCheckResult**](va-cluster-status-change-event-health-check-result) | | [required] +**PreviousHealthCheckResult** | [**VAClusterStatusChangeEventPreviousHealthCheckResult**](va-cluster-status-change-event-previous-health-check-result) | | [required] + +## Examples + +- Prepare the resource +```powershell +$VAClusterStatusChangeEvent = Initialize-PSSailpoint.BetaVAClusterStatusChangeEvent -Created 2020-06-29T22:01:50.474Z ` + -Type CLUSTER ` + -Application null ` + -HealthCheckResult null ` + -PreviousHealthCheckResult null +``` + +- Convert the resource to JSON +```powershell +$VAClusterStatusChangeEvent | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VAClusterStatusChangeEventApplication.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VAClusterStatusChangeEventApplication.md new file mode 100644 index 000000000..cff14db88 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VAClusterStatusChangeEventApplication.md @@ -0,0 +1,39 @@ +--- +id: beta-va-cluster-status-change-event-application +title: VAClusterStatusChangeEventApplication +pagination_label: VAClusterStatusChangeEventApplication +sidebar_label: VAClusterStatusChangeEventApplication +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VAClusterStatusChangeEventApplication', 'BetaVAClusterStatusChangeEventApplication'] +slug: /tools/sdk/powershell/beta/models/va-cluster-status-change-event-application +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventApplication', 'BetaVAClusterStatusChangeEventApplication'] +--- + + +# VAClusterStatusChangeEventApplication + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The GUID of the application | [required] +**Name** | **String** | The name of the application | [required] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Custom map of attributes for a source. This will only be populated if type is `SOURCE` and the source has a proxy. | [required] + +## Examples + +- Prepare the resource +```powershell +$VAClusterStatusChangeEventApplication = Initialize-PSSailpoint.BetaVAClusterStatusChangeEventApplication -Id 2c9180866166b5b0016167c32ef31a66 ` + -Name Production VA Cluster ` + -Attributes null +``` + +- Convert the resource to JSON +```powershell +$VAClusterStatusChangeEventApplication | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VAClusterStatusChangeEventHealthCheckResult.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VAClusterStatusChangeEventHealthCheckResult.md new file mode 100644 index 000000000..bb19c224e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VAClusterStatusChangeEventHealthCheckResult.md @@ -0,0 +1,39 @@ +--- +id: beta-va-cluster-status-change-event-health-check-result +title: VAClusterStatusChangeEventHealthCheckResult +pagination_label: VAClusterStatusChangeEventHealthCheckResult +sidebar_label: VAClusterStatusChangeEventHealthCheckResult +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VAClusterStatusChangeEventHealthCheckResult', 'BetaVAClusterStatusChangeEventHealthCheckResult'] +slug: /tools/sdk/powershell/beta/models/va-cluster-status-change-event-health-check-result +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventHealthCheckResult', 'BetaVAClusterStatusChangeEventHealthCheckResult'] +--- + + +# VAClusterStatusChangeEventHealthCheckResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | **String** | Detailed message of the result of the health check. | [required] +**ResultType** | **String** | The type of the health check result. | [required] +**Status** | **Enum** [ "Succeeded", "Failed" ] | The status of the health check. | [required] + +## Examples + +- Prepare the resource +```powershell +$VAClusterStatusChangeEventHealthCheckResult = Initialize-PSSailpoint.BetaVAClusterStatusChangeEventHealthCheckResult -Message Test Connection failed with exception. Error message - java.lang Exception ` + -ResultType SOURCE_STATE_ERROR_CLUSTER ` + -Status Succeeded +``` + +- Convert the resource to JSON +```powershell +$VAClusterStatusChangeEventHealthCheckResult | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md new file mode 100644 index 000000000..e29be859b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md @@ -0,0 +1,39 @@ +--- +id: beta-va-cluster-status-change-event-previous-health-check-result +title: VAClusterStatusChangeEventPreviousHealthCheckResult +pagination_label: VAClusterStatusChangeEventPreviousHealthCheckResult +sidebar_label: VAClusterStatusChangeEventPreviousHealthCheckResult +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VAClusterStatusChangeEventPreviousHealthCheckResult', 'BetaVAClusterStatusChangeEventPreviousHealthCheckResult'] +slug: /tools/sdk/powershell/beta/models/va-cluster-status-change-event-previous-health-check-result +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventPreviousHealthCheckResult', 'BetaVAClusterStatusChangeEventPreviousHealthCheckResult'] +--- + + +# VAClusterStatusChangeEventPreviousHealthCheckResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | **String** | Detailed message of the result of the health check. | [required] +**ResultType** | **String** | The type of the health check result. | [required] +**Status** | **Enum** [ "Succeeded", "Failed" ] | The status of the health check. | [required] + +## Examples + +- Prepare the resource +```powershell +$VAClusterStatusChangeEventPreviousHealthCheckResult = Initialize-PSSailpoint.BetaVAClusterStatusChangeEventPreviousHealthCheckResult -Message Test Connection failed with exception. Error message - java.lang Exception ` + -ResultType SOURCE_STATE_ERROR_CLUSTER ` + -Status Failed +``` + +- Convert the resource to JSON +```powershell +$VAClusterStatusChangeEventPreviousHealthCheckResult | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ValidateFilterInputDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ValidateFilterInputDto.md new file mode 100644 index 000000000..0d30a1d87 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ValidateFilterInputDto.md @@ -0,0 +1,37 @@ +--- +id: beta-validate-filter-input-dto +title: ValidateFilterInputDto +pagination_label: ValidateFilterInputDto +sidebar_label: ValidateFilterInputDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ValidateFilterInputDto', 'BetaValidateFilterInputDto'] +slug: /tools/sdk/powershell/beta/models/validate-filter-input-dto +tags: ['SDK', 'Software Development Kit', 'ValidateFilterInputDto', 'BetaValidateFilterInputDto'] +--- + + +# ValidateFilterInputDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarInput** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Mock input to evaluate filter expression against. | [required] +**VarFilter** | **String** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [required] + +## Examples + +- Prepare the resource +```powershell +$ValidateFilterInputDto = Initialize-PSSailpoint.BetaValidateFilterInputDto -VarInput {identityId=201327fda1c44704ac01181e963d463c} ` + -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] +``` + +- Convert the resource to JSON +```powershell +$ValidateFilterInputDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ValidateFilterOutputDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ValidateFilterOutputDto.md new file mode 100644 index 000000000..981da0252 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ValidateFilterOutputDto.md @@ -0,0 +1,39 @@ +--- +id: beta-validate-filter-output-dto +title: ValidateFilterOutputDto +pagination_label: ValidateFilterOutputDto +sidebar_label: ValidateFilterOutputDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ValidateFilterOutputDto', 'BetaValidateFilterOutputDto'] +slug: /tools/sdk/powershell/beta/models/validate-filter-output-dto +tags: ['SDK', 'Software Development Kit', 'ValidateFilterOutputDto', 'BetaValidateFilterOutputDto'] +--- + + +# ValidateFilterOutputDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsValid** | Pointer to **Boolean** | When this field is true, the filter expression is valid against the input. | [optional] [default to $false] +**IsValidJSONPath** | Pointer to **Boolean** | When this field is true, the filter expression is using a valid JSON path. | [optional] [default to $false] +**IsPathExist** | Pointer to **Boolean** | When this field is true, the filter expression is using an existing path. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$ValidateFilterOutputDto = Initialize-PSSailpoint.BetaValidateFilterOutputDto -IsValid true ` + -IsValidJSONPath true ` + -IsPathExist true +``` + +- Convert the resource to JSON +```powershell +$ValidateFilterOutputDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Value.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Value.md new file mode 100644 index 000000000..70bccb6fa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Value.md @@ -0,0 +1,37 @@ +--- +id: beta-value +title: Value +pagination_label: Value +sidebar_label: Value +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Value', 'BetaValue'] +slug: /tools/sdk/powershell/beta/models/value +tags: ['SDK', 'Software Development Kit', 'Value', 'BetaValue'] +--- + + +# Value + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **String** | The type of attribute value | [optional] +**Value** | Pointer to **String** | The attribute value | [optional] + +## Examples + +- Prepare the resource +```powershell +$Value = Initialize-PSSailpoint.BetaValue -Type STRING ` + -Value Austin +``` + +- Convert the resource to JSON +```powershell +$Value | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VendorConnectorMapping.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VendorConnectorMapping.md new file mode 100644 index 000000000..ed78b2acc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VendorConnectorMapping.md @@ -0,0 +1,51 @@ +--- +id: beta-vendor-connector-mapping +title: VendorConnectorMapping +pagination_label: VendorConnectorMapping +sidebar_label: VendorConnectorMapping +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMapping', 'BetaVendorConnectorMapping'] +slug: /tools/sdk/powershell/beta/models/vendor-connector-mapping +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMapping', 'BetaVendorConnectorMapping'] +--- + + +# VendorConnectorMapping + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The unique identifier for the vendor-connector mapping. | [optional] +**Vendor** | Pointer to **String** | The name of the vendor. | [optional] +**Connector** | Pointer to **String** | The name of the connector. | [optional] +**CreatedAt** | Pointer to **System.DateTime** | The creation timestamp of the mapping. | [optional] +**CreatedBy** | Pointer to **String** | The identifier of the user who created the mapping. | [optional] +**UpdatedAt** | Pointer to [**VendorConnectorMappingUpdatedAt**](vendor-connector-mapping-updated-at) | | [optional] +**UpdatedBy** | Pointer to [**VendorConnectorMappingUpdatedBy**](vendor-connector-mapping-updated-by) | | [optional] +**DeletedAt** | Pointer to [**VendorConnectorMappingDeletedAt**](vendor-connector-mapping-deleted-at) | | [optional] +**DeletedBy** | Pointer to [**VendorConnectorMappingDeletedBy**](vendor-connector-mapping-deleted-by) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$VendorConnectorMapping = Initialize-PSSailpoint.BetaVendorConnectorMapping -Id 78733556-9ea3-4f59-bf69-e5cd92b011b4 ` + -Vendor Example vendor ` + -Connector Example connector ` + -CreatedAt 2024-03-13T12:56:19.391294Z ` + -CreatedBy admin ` + -UpdatedAt null ` + -UpdatedBy null ` + -DeletedAt null ` + -DeletedBy null +``` + +- Convert the resource to JSON +```powershell +$VendorConnectorMapping | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VendorConnectorMappingDeletedAt.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VendorConnectorMappingDeletedAt.md new file mode 100644 index 000000000..fb5223d26 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VendorConnectorMappingDeletedAt.md @@ -0,0 +1,37 @@ +--- +id: beta-vendor-connector-mapping-deleted-at +title: VendorConnectorMappingDeletedAt +pagination_label: VendorConnectorMappingDeletedAt +sidebar_label: VendorConnectorMappingDeletedAt +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMappingDeletedAt', 'BetaVendorConnectorMappingDeletedAt'] +slug: /tools/sdk/powershell/beta/models/vendor-connector-mapping-deleted-at +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingDeletedAt', 'BetaVendorConnectorMappingDeletedAt'] +--- + + +# VendorConnectorMappingDeletedAt + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Time** | Pointer to **System.DateTime** | The timestamp when the mapping was deleted, represented in ISO 8601 format, if applicable. | [optional] +**Valid** | Pointer to **Boolean** | A flag indicating if the 'Time' field is set and valid, i.e., if the mapping has been deleted. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$VendorConnectorMappingDeletedAt = Initialize-PSSailpoint.BetaVendorConnectorMappingDeletedAt -Time 0001-01-01T00:00Z ` + -Valid false +``` + +- Convert the resource to JSON +```powershell +$VendorConnectorMappingDeletedAt | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VendorConnectorMappingDeletedBy.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VendorConnectorMappingDeletedBy.md new file mode 100644 index 000000000..e2bdc4b6f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VendorConnectorMappingDeletedBy.md @@ -0,0 +1,37 @@ +--- +id: beta-vendor-connector-mapping-deleted-by +title: VendorConnectorMappingDeletedBy +pagination_label: VendorConnectorMappingDeletedBy +sidebar_label: VendorConnectorMappingDeletedBy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMappingDeletedBy', 'BetaVendorConnectorMappingDeletedBy'] +slug: /tools/sdk/powershell/beta/models/vendor-connector-mapping-deleted-by +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingDeletedBy', 'BetaVendorConnectorMappingDeletedBy'] +--- + + +# VendorConnectorMappingDeletedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**String** | Pointer to **String** | The identifier of the user who deleted the mapping, if applicable. | [optional] +**Valid** | Pointer to **Boolean** | A flag indicating if the 'String' field is set and valid, i.e., if the mapping has been deleted. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$VendorConnectorMappingDeletedBy = Initialize-PSSailpoint.BetaVendorConnectorMappingDeletedBy -String ` + -Valid false +``` + +- Convert the resource to JSON +```powershell +$VendorConnectorMappingDeletedBy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VendorConnectorMappingUpdatedAt.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VendorConnectorMappingUpdatedAt.md new file mode 100644 index 000000000..1b5f84df3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VendorConnectorMappingUpdatedAt.md @@ -0,0 +1,37 @@ +--- +id: beta-vendor-connector-mapping-updated-at +title: VendorConnectorMappingUpdatedAt +pagination_label: VendorConnectorMappingUpdatedAt +sidebar_label: VendorConnectorMappingUpdatedAt +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMappingUpdatedAt', 'BetaVendorConnectorMappingUpdatedAt'] +slug: /tools/sdk/powershell/beta/models/vendor-connector-mapping-updated-at +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingUpdatedAt', 'BetaVendorConnectorMappingUpdatedAt'] +--- + + +# VendorConnectorMappingUpdatedAt + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Time** | Pointer to **System.DateTime** | The timestamp when the mapping was last updated, represented in ISO 8601 format. | [optional] +**Valid** | Pointer to **Boolean** | A flag indicating if the 'Time' field is set and valid. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$VendorConnectorMappingUpdatedAt = Initialize-PSSailpoint.BetaVendorConnectorMappingUpdatedAt -Time 2024-03-14T12:56:19.391294Z ` + -Valid true +``` + +- Convert the resource to JSON +```powershell +$VendorConnectorMappingUpdatedAt | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VendorConnectorMappingUpdatedBy.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VendorConnectorMappingUpdatedBy.md new file mode 100644 index 000000000..d66e01337 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VendorConnectorMappingUpdatedBy.md @@ -0,0 +1,37 @@ +--- +id: beta-vendor-connector-mapping-updated-by +title: VendorConnectorMappingUpdatedBy +pagination_label: VendorConnectorMappingUpdatedBy +sidebar_label: VendorConnectorMappingUpdatedBy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMappingUpdatedBy', 'BetaVendorConnectorMappingUpdatedBy'] +slug: /tools/sdk/powershell/beta/models/vendor-connector-mapping-updated-by +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingUpdatedBy', 'BetaVendorConnectorMappingUpdatedBy'] +--- + + +# VendorConnectorMappingUpdatedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**String** | Pointer to **String** | The identifier of the user who last updated the mapping, if available. | [optional] +**Valid** | Pointer to **Boolean** | A flag indicating if the 'String' field is set and valid. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$VendorConnectorMappingUpdatedBy = Initialize-PSSailpoint.BetaVendorConnectorMappingUpdatedBy -String user-67891 ` + -Valid true +``` + +- Convert the resource to JSON +```powershell +$VendorConnectorMappingUpdatedBy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VerificationPollRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VerificationPollRequest.md new file mode 100644 index 000000000..68afdf14b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VerificationPollRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-verification-poll-request +title: VerificationPollRequest +pagination_label: VerificationPollRequest +sidebar_label: VerificationPollRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VerificationPollRequest', 'BetaVerificationPollRequest'] +slug: /tools/sdk/powershell/beta/models/verification-poll-request +tags: ['SDK', 'Software Development Kit', 'VerificationPollRequest', 'BetaVerificationPollRequest'] +--- + + +# VerificationPollRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | **String** | Verification request Id | [required] + +## Examples + +- Prepare the resource +```powershell +$VerificationPollRequest = Initialize-PSSailpoint.BetaVerificationPollRequest -RequestId 089899f13a8f4da7824996191587bab9 +``` + +- Convert the resource to JSON +```powershell +$VerificationPollRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VerificationResponse.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VerificationResponse.md new file mode 100644 index 000000000..c7735083b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VerificationResponse.md @@ -0,0 +1,39 @@ +--- +id: beta-verification-response +title: VerificationResponse +pagination_label: VerificationResponse +sidebar_label: VerificationResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VerificationResponse', 'BetaVerificationResponse'] +slug: /tools/sdk/powershell/beta/models/verification-response +tags: ['SDK', 'Software Development Kit', 'VerificationResponse', 'BetaVerificationResponse'] +--- + + +# VerificationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | Pointer to **String** | The verificationPollRequest request ID | [optional] +**Status** | Pointer to **Enum** [ "PENDING", "SUCCESS", "FAILED", "LOCKOUT", "NOT_ENOUGH_DATA" ] | MFA Authentication status | [optional] +**VarError** | Pointer to **String** | Error messages from MFA verification request | [optional] + +## Examples + +- Prepare the resource +```powershell +$VerificationResponse = Initialize-PSSailpoint.BetaVerificationResponse -RequestId 089899f13a8f4da7824996191587bab9 ` + -Status SUCCESS ` + -VarError Unable to connect DUO Service during verification +``` + +- Convert the resource to JSON +```powershell +$VerificationResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ViolationContext.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ViolationContext.md new file mode 100644 index 000000000..edbe98ab7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ViolationContext.md @@ -0,0 +1,37 @@ +--- +id: beta-violation-context +title: ViolationContext +pagination_label: ViolationContext +sidebar_label: ViolationContext +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationContext', 'BetaViolationContext'] +slug: /tools/sdk/powershell/beta/models/violation-context +tags: ['SDK', 'Software Development Kit', 'ViolationContext', 'BetaViolationContext'] +--- + + +# ViolationContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policy** | Pointer to [**ViolationContextPolicy**](violation-context-policy) | | [optional] +**ConflictingAccessCriteria** | Pointer to [**ExceptionAccessCriteria**](exception-access-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ViolationContext = Initialize-PSSailpoint.BetaViolationContext -Policy null ` + -ConflictingAccessCriteria null +``` + +- Convert the resource to JSON +```powershell +$ViolationContext | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ViolationContextPolicy.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ViolationContextPolicy.md new file mode 100644 index 000000000..006675464 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ViolationContextPolicy.md @@ -0,0 +1,39 @@ +--- +id: beta-violation-context-policy +title: ViolationContextPolicy +pagination_label: ViolationContextPolicy +sidebar_label: ViolationContextPolicy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationContextPolicy', 'BetaViolationContextPolicy'] +slug: /tools/sdk/powershell/beta/models/violation-context-policy +tags: ['SDK', 'Software Development Kit', 'ViolationContextPolicy', 'BetaViolationContextPolicy'] +--- + + +# ViolationContextPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | The type of object supported for SOD policy violations. | [optional] +**Id** | Pointer to **String** | SOD policy ID. | [optional] +**Name** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ViolationContextPolicy = Initialize-PSSailpoint.BetaViolationContextPolicy -Type ENTITLEMENT ` + -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -Name A very cool policy name +``` + +- Convert the resource to JSON +```powershell +$ViolationContextPolicy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ViolationOwnerAssignmentConfig.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ViolationOwnerAssignmentConfig.md new file mode 100644 index 000000000..791dbe1f2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ViolationOwnerAssignmentConfig.md @@ -0,0 +1,37 @@ +--- +id: beta-violation-owner-assignment-config +title: ViolationOwnerAssignmentConfig +pagination_label: ViolationOwnerAssignmentConfig +sidebar_label: ViolationOwnerAssignmentConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationOwnerAssignmentConfig', 'BetaViolationOwnerAssignmentConfig'] +slug: /tools/sdk/powershell/beta/models/violation-owner-assignment-config +tags: ['SDK', 'Software Development Kit', 'ViolationOwnerAssignmentConfig', 'BetaViolationOwnerAssignmentConfig'] +--- + + +# ViolationOwnerAssignmentConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AssignmentRule** | Pointer to **Enum** [ "MANAGER", "STATIC" ] | Details about the violations owner. MANAGER - identity's manager STATIC - Governance Group or Identity | [optional] +**OwnerRef** | Pointer to [**ViolationOwnerAssignmentConfigOwnerRef**](violation-owner-assignment-config-owner-ref) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ViolationOwnerAssignmentConfig = Initialize-PSSailpoint.BetaViolationOwnerAssignmentConfig -AssignmentRule MANAGER ` + -OwnerRef null +``` + +- Convert the resource to JSON +```powershell +$ViolationOwnerAssignmentConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ViolationOwnerAssignmentConfigOwnerRef.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ViolationOwnerAssignmentConfigOwnerRef.md new file mode 100644 index 000000000..87532b1d1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ViolationOwnerAssignmentConfigOwnerRef.md @@ -0,0 +1,39 @@ +--- +id: beta-violation-owner-assignment-config-owner-ref +title: ViolationOwnerAssignmentConfigOwnerRef +pagination_label: ViolationOwnerAssignmentConfigOwnerRef +sidebar_label: ViolationOwnerAssignmentConfigOwnerRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationOwnerAssignmentConfigOwnerRef', 'BetaViolationOwnerAssignmentConfigOwnerRef'] +slug: /tools/sdk/powershell/beta/models/violation-owner-assignment-config-owner-ref +tags: ['SDK', 'Software Development Kit', 'ViolationOwnerAssignmentConfigOwnerRef', 'BetaViolationOwnerAssignmentConfigOwnerRef'] +--- + + +# ViolationOwnerAssignmentConfigOwnerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY", "GOVERNANCE_GROUP", "MANAGER" ] | Owner type. | [optional] +**Id** | Pointer to **String** | Owner's ID. | [optional] +**Name** | Pointer to **String** | Owner's name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ViolationOwnerAssignmentConfigOwnerRef = Initialize-PSSailpoint.BetaViolationOwnerAssignmentConfigOwnerRef -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Support +``` + +- Convert the resource to JSON +```powershell +$ViolationOwnerAssignmentConfigOwnerRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ViolationPrediction.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ViolationPrediction.md new file mode 100644 index 000000000..62fdddc6c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/ViolationPrediction.md @@ -0,0 +1,35 @@ +--- +id: beta-violation-prediction +title: ViolationPrediction +pagination_label: ViolationPrediction +sidebar_label: ViolationPrediction +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationPrediction', 'BetaViolationPrediction'] +slug: /tools/sdk/powershell/beta/models/violation-prediction +tags: ['SDK', 'Software Development Kit', 'ViolationPrediction', 'BetaViolationPrediction'] +--- + + +# ViolationPrediction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ViolationContexts** | Pointer to [**[]ViolationContext**](violation-context) | List of Violation Contexts | [optional] + +## Examples + +- Prepare the resource +```powershell +$ViolationPrediction = Initialize-PSSailpoint.BetaViolationPrediction -ViolationContexts null +``` + +- Convert the resource to JSON +```powershell +$ViolationPrediction | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VisibilityCriteria.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VisibilityCriteria.md new file mode 100644 index 000000000..81063a785 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/VisibilityCriteria.md @@ -0,0 +1,35 @@ +--- +id: beta-visibility-criteria +title: VisibilityCriteria +pagination_label: VisibilityCriteria +sidebar_label: VisibilityCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VisibilityCriteria', 'BetaVisibilityCriteria'] +slug: /tools/sdk/powershell/beta/models/visibility-criteria +tags: ['SDK', 'Software Development Kit', 'VisibilityCriteria', 'BetaVisibilityCriteria'] +--- + + +# VisibilityCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Expression** | Pointer to [**Expression**](expression) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$VisibilityCriteria = Initialize-PSSailpoint.BetaVisibilityCriteria -Expression null +``` + +- Convert the resource to JSON +```powershell +$VisibilityCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkItemForward.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkItemForward.md new file mode 100644 index 000000000..aace00f79 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkItemForward.md @@ -0,0 +1,39 @@ +--- +id: beta-work-item-forward +title: WorkItemForward +pagination_label: WorkItemForward +sidebar_label: WorkItemForward +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemForward', 'BetaWorkItemForward'] +slug: /tools/sdk/powershell/beta/models/work-item-forward +tags: ['SDK', 'Software Development Kit', 'WorkItemForward', 'BetaWorkItemForward'] +--- + + +# WorkItemForward + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TargetOwnerId** | **String** | The ID of the identity to forward this work item to. | [required] +**Comment** | **String** | Comments to send to the target owner | [required] +**SendNotifications** | Pointer to **Boolean** | If true, send a notification to the target owner. | [optional] [default to $true] + +## Examples + +- Prepare the resource +```powershell +$WorkItemForward = Initialize-PSSailpoint.BetaWorkItemForward -TargetOwnerId 2c9180835d2e5168015d32f890ca1581 ` + -Comment I'm going on vacation. ` + -SendNotifications true +``` + +- Convert the resource to JSON +```powershell +$WorkItemForward | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkItemState.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkItemState.md new file mode 100644 index 000000000..1abcc3a21 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkItemState.md @@ -0,0 +1,32 @@ +--- +id: beta-work-item-state +title: WorkItemState +pagination_label: WorkItemState +sidebar_label: WorkItemState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemState', 'BetaWorkItemState'] +slug: /tools/sdk/powershell/beta/models/work-item-state +tags: ['SDK', 'Software Development Kit', 'WorkItemState', 'BetaWorkItemState'] +--- + + +# WorkItemState + +## Enum + + +* `Finished` (value: `"Finished"`) + +* `Rejected` (value: `"Rejected"`) + +* `Returned` (value: `"Returned"`) + +* `Expired` (value: `"Expired"`) + +* `Pending` (value: `"Pending"`) + +* `Canceled` (value: `"Canceled"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkItemType.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkItemType.md new file mode 100644 index 000000000..aa6395079 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkItemType.md @@ -0,0 +1,50 @@ +--- +id: beta-work-item-type +title: WorkItemType +pagination_label: WorkItemType +sidebar_label: WorkItemType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemType', 'BetaWorkItemType'] +slug: /tools/sdk/powershell/beta/models/work-item-type +tags: ['SDK', 'Software Development Kit', 'WorkItemType', 'BetaWorkItemType'] +--- + + +# WorkItemType + +## Enum + + +* `Unknown` (value: `"Unknown"`) + +* `Generic` (value: `"Generic"`) + +* `Certification` (value: `"Certification"`) + +* `Remediation` (value: `"Remediation"`) + +* `Delegation` (value: `"Delegation"`) + +* `Approval` (value: `"Approval"`) + +* `ViolationReview` (value: `"ViolationReview"`) + +* `Form` (value: `"Form"`) + +* `PolicyViolation` (value: `"PolicyViolation"`) + +* `Challenge` (value: `"Challenge"`) + +* `ImpactAnalysis` (value: `"ImpactAnalysis"`) + +* `Signoff` (value: `"Signoff"`) + +* `Event` (value: `"Event"`) + +* `ManualAction` (value: `"ManualAction"`) + +* `Test` (value: `"Test"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkItems.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkItems.md new file mode 100644 index 000000000..323d318d9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkItems.md @@ -0,0 +1,67 @@ +--- +id: beta-work-items +title: WorkItems +pagination_label: WorkItems +sidebar_label: WorkItems +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItems', 'BetaWorkItems'] +slug: /tools/sdk/powershell/beta/models/work-items +tags: ['SDK', 'Software Development Kit', 'WorkItems', 'BetaWorkItems'] +--- + + +# WorkItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the work item | [optional] +**RequesterId** | Pointer to **String** | ID of the requester | [optional] +**RequesterDisplayName** | Pointer to **String** | The displayname of the requester | [optional] +**OwnerId** | Pointer to **String** | The ID of the owner | [optional] +**OwnerName** | Pointer to **String** | The name of the owner | [optional] +**Created** | Pointer to **System.DateTime** | | [optional] +**Modified** | Pointer to **System.DateTime** | | [optional] +**Description** | Pointer to **String** | The description of the work item | [optional] +**State** | Pointer to [**WorkItemState**](work-item-state) | | [optional] +**Type** | Pointer to [**WorkItemType**](work-item-type) | | [optional] +**RemediationItems** | Pointer to [**[]RemediationItemDetails**](remediation-item-details) | | [optional] +**ApprovalItems** | Pointer to [**[]ApprovalItemDetails**](approval-item-details) | | [optional] +**Name** | Pointer to **String** | The work item name | [optional] +**Completed** | Pointer to **System.DateTime** | | [optional] +**NumItems** | Pointer to **Int32** | The number of items in the work item | [optional] +**Errors** | Pointer to **[]String** | | [optional] +**Form** | Pointer to [**FormDetails**](form-details) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkItems = Initialize-PSSailpoint.BetaWorkItems -Id 2c9180835d2e5168015d32f890ca1581 ` + -RequesterId 2c9180835d2e5168015d32f890ca1581 ` + -RequesterDisplayName John Smith ` + -OwnerId 2c9180835d2e5168015d32f890ca1581 ` + -OwnerName Jason Smith ` + -Created 2017-07-11T18:45:37.098Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Description Create account on source 'AD' ` + -State null ` + -Type null ` + -RemediationItems null ` + -ApprovalItems null ` + -Name Account Create ` + -Completed 2018-10-19T13:49:37.385Z ` + -NumItems 19 ` + -Errors [The work item ID that was specified was not found.] ` + -Form null +``` + +- Convert the resource to JSON +```powershell +$WorkItems | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkItemsCount.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkItemsCount.md new file mode 100644 index 000000000..52119e887 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkItemsCount.md @@ -0,0 +1,35 @@ +--- +id: beta-work-items-count +title: WorkItemsCount +pagination_label: WorkItemsCount +sidebar_label: WorkItemsCount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemsCount', 'BetaWorkItemsCount'] +slug: /tools/sdk/powershell/beta/models/work-items-count +tags: ['SDK', 'Software Development Kit', 'WorkItemsCount', 'BetaWorkItemsCount'] +--- + + +# WorkItemsCount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | Pointer to **Int32** | The count of work items | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkItemsCount = Initialize-PSSailpoint.BetaWorkItemsCount -Count 29 +``` + +- Convert the resource to JSON +```powershell +$WorkItemsCount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkItemsSummary.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkItemsSummary.md new file mode 100644 index 000000000..5ec6ae431 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkItemsSummary.md @@ -0,0 +1,39 @@ +--- +id: beta-work-items-summary +title: WorkItemsSummary +pagination_label: WorkItemsSummary +sidebar_label: WorkItemsSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemsSummary', 'BetaWorkItemsSummary'] +slug: /tools/sdk/powershell/beta/models/work-items-summary +tags: ['SDK', 'Software Development Kit', 'WorkItemsSummary', 'BetaWorkItemsSummary'] +--- + + +# WorkItemsSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Open** | Pointer to **Int32** | The count of open work items | [optional] +**Completed** | Pointer to **Int32** | The count of completed work items | [optional] +**Total** | Pointer to **Int32** | The count of total work items | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkItemsSummary = Initialize-PSSailpoint.BetaWorkItemsSummary -Open 29 ` + -Completed 1 ` + -Total 30 +``` + +- Convert the resource to JSON +```powershell +$WorkItemsSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Workflow.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Workflow.md new file mode 100644 index 000000000..9f942265a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/Workflow.md @@ -0,0 +1,59 @@ +--- +id: beta-workflow +title: Workflow +pagination_label: Workflow +sidebar_label: Workflow +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Workflow', 'BetaWorkflow'] +slug: /tools/sdk/powershell/beta/models/workflow +tags: ['SDK', 'Software Development Kit', 'Workflow', 'BetaWorkflow'] +--- + + +# Workflow + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the workflow | [optional] +**Owner** | Pointer to [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] +**Description** | Pointer to **String** | Description of what the workflow accomplishes | [optional] +**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] +**Enabled** | Pointer to **Boolean** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to $false] +**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] +**Id** | Pointer to **String** | Workflow ID. This is a UUID generated upon creation. | [optional] +**Modified** | Pointer to **System.DateTime** | The date and time the workflow was modified. | [optional] +**ModifiedBy** | Pointer to [**WorkflowModifiedBy**](workflow-modified-by) | | [optional] +**ExecutionCount** | Pointer to **Int32** | The number of times this workflow has been executed. | [optional] +**FailureCount** | Pointer to **Int32** | The number of times this workflow has failed during execution. | [optional] +**Created** | Pointer to **System.DateTime** | The date and time the workflow was created. | [optional] +**Creator** | Pointer to [**WorkflowAllOfCreator**](workflow-all-of-creator) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Workflow = Initialize-PSSailpoint.BetaWorkflow -Name Send Email ` + -Owner null ` + -Description Send an email to the identity who's attributes changed. ` + -Definition null ` + -Enabled false ` + -Trigger null ` + -Id d201c5e9-d37b-4aff-af14-66414f39d569 ` + -Modified 2023-12-05T15:18:27.699132301Z ` + -ModifiedBy null ` + -ExecutionCount 2 ` + -FailureCount 0 ` + -Created 2022-01-10T16:06:16.636381447Z ` + -Creator null +``` + +- Convert the resource to JSON +```powershell +$Workflow | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowAllOfCreator.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowAllOfCreator.md new file mode 100644 index 000000000..726f88897 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowAllOfCreator.md @@ -0,0 +1,39 @@ +--- +id: beta-workflow-all-of-creator +title: WorkflowAllOfCreator +pagination_label: WorkflowAllOfCreator +sidebar_label: WorkflowAllOfCreator +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowAllOfCreator', 'BetaWorkflowAllOfCreator'] +slug: /tools/sdk/powershell/beta/models/workflow-all-of-creator +tags: ['SDK', 'Software Development Kit', 'WorkflowAllOfCreator', 'BetaWorkflowAllOfCreator'] +--- + + +# WorkflowAllOfCreator + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Workflow creator's DTO type. | [optional] +**Id** | Pointer to **String** | Workflow creator's identity ID. | [optional] +**Name** | Pointer to **String** | Workflow creator's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowAllOfCreator = Initialize-PSSailpoint.BetaWorkflowAllOfCreator -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$WorkflowAllOfCreator | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowBody.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowBody.md new file mode 100644 index 000000000..b4d722141 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowBody.md @@ -0,0 +1,45 @@ +--- +id: beta-workflow-body +title: WorkflowBody +pagination_label: WorkflowBody +sidebar_label: WorkflowBody +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowBody', 'BetaWorkflowBody'] +slug: /tools/sdk/powershell/beta/models/workflow-body +tags: ['SDK', 'Software Development Kit', 'WorkflowBody', 'BetaWorkflowBody'] +--- + + +# WorkflowBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the workflow | [optional] +**Owner** | Pointer to [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] +**Description** | Pointer to **String** | Description of what the workflow accomplishes | [optional] +**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] +**Enabled** | Pointer to **Boolean** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to $false] +**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowBody = Initialize-PSSailpoint.BetaWorkflowBody -Name Send Email ` + -Owner null ` + -Description Send an email to the identity who's attributes changed. ` + -Definition null ` + -Enabled false ` + -Trigger null +``` + +- Convert the resource to JSON +```powershell +$WorkflowBody | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowBodyOwner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowBodyOwner.md new file mode 100644 index 000000000..414c0de97 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowBodyOwner.md @@ -0,0 +1,39 @@ +--- +id: beta-workflow-body-owner +title: WorkflowBodyOwner +pagination_label: WorkflowBodyOwner +sidebar_label: WorkflowBodyOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowBodyOwner', 'BetaWorkflowBodyOwner'] +slug: /tools/sdk/powershell/beta/models/workflow-body-owner +tags: ['SDK', 'Software Development Kit', 'WorkflowBodyOwner', 'BetaWorkflowBodyOwner'] +--- + + +# WorkflowBodyOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of object that is referenced | [optional] +**Id** | Pointer to **String** | The unique ID of the object | [optional] +**Name** | Pointer to **String** | The name of the object | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowBodyOwner = Initialize-PSSailpoint.BetaWorkflowBodyOwner -Type IDENTITY ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$WorkflowBodyOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowDefinition.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowDefinition.md new file mode 100644 index 000000000..3bfeddea1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowDefinition.md @@ -0,0 +1,37 @@ +--- +id: beta-workflow-definition +title: WorkflowDefinition +pagination_label: WorkflowDefinition +sidebar_label: WorkflowDefinition +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowDefinition', 'BetaWorkflowDefinition'] +slug: /tools/sdk/powershell/beta/models/workflow-definition +tags: ['SDK', 'Software Development Kit', 'WorkflowDefinition', 'BetaWorkflowDefinition'] +--- + + +# WorkflowDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Start** | Pointer to **String** | The name of the starting step. | [optional] +**Steps** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowDefinition = Initialize-PSSailpoint.BetaWorkflowDefinition -Start Send Email Test ` + -Steps {Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=ACTION}, success={type=success}} +``` + +- Convert the resource to JSON +```powershell +$WorkflowDefinition | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowExecution.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowExecution.md new file mode 100644 index 000000000..dcc0ff15e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowExecution.md @@ -0,0 +1,45 @@ +--- +id: beta-workflow-execution +title: WorkflowExecution +pagination_label: WorkflowExecution +sidebar_label: WorkflowExecution +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowExecution', 'BetaWorkflowExecution'] +slug: /tools/sdk/powershell/beta/models/workflow-execution +tags: ['SDK', 'Software Development Kit', 'WorkflowExecution', 'BetaWorkflowExecution'] +--- + + +# WorkflowExecution + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Workflow execution ID. | [optional] +**WorkflowId** | Pointer to **String** | Workflow ID. | [optional] +**RequestId** | Pointer to **String** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] +**StartTime** | Pointer to **System.DateTime** | Date/time when the workflow started. | [optional] +**CloseTime** | Pointer to **System.DateTime** | Date/time when the workflow ended. | [optional] +**Status** | Pointer to **Enum** [ "Completed", "Failed", "Canceled", "Executing" ] | Workflow execution status. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowExecution = Initialize-PSSailpoint.BetaWorkflowExecution -Id b393f4e2-4785-4d7f-ab27-3a6b8ded4c81 ` + -WorkflowId d201c5d9-d37b-4a2f-af14-66414f39d568 ` + -RequestId 41e12a74fa7b4a6a98ae47887b64acdb ` + -StartTime 2022-02-07T20:13:29.356648026Z ` + -CloseTime 2022-02-07T20:13:31.682410165Z ` + -Status Completed +``` + +- Convert the resource to JSON +```powershell +$WorkflowExecution | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowExecutionEvent.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowExecutionEvent.md new file mode 100644 index 000000000..9b8b766c0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowExecutionEvent.md @@ -0,0 +1,39 @@ +--- +id: beta-workflow-execution-event +title: WorkflowExecutionEvent +pagination_label: WorkflowExecutionEvent +sidebar_label: WorkflowExecutionEvent +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowExecutionEvent', 'BetaWorkflowExecutionEvent'] +slug: /tools/sdk/powershell/beta/models/workflow-execution-event +tags: ['SDK', 'Software Development Kit', 'WorkflowExecutionEvent', 'BetaWorkflowExecutionEvent'] +--- + + +# WorkflowExecutionEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "WorkflowExecutionScheduled", "WorkflowExecutionStarted", "WorkflowExecutionCompleted", "WorkflowExecutionFailed", "WorkflowTaskScheduled", "WorkflowTaskStarted", "WorkflowTaskCompleted", "WorkflowTaskFailed", "ActivityTaskScheduled", "ActivityTaskStarted", "ActivityTaskCompleted", "ActivityTaskFailed" ] | The type of event | [optional] +**Timestamp** | Pointer to **System.DateTime** | The date-time when the event occurred | [optional] +**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Additional attributes associated with the event | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowExecutionEvent = Initialize-PSSailpoint.BetaWorkflowExecutionEvent -Type WorkflowTaskScheduled ` + -Timestamp 2022-02-07T20:13:31.640618296Z ` + -Attributes {} +``` + +- Convert the resource to JSON +```powershell +$WorkflowExecutionEvent | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowLibraryAction.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowLibraryAction.md new file mode 100644 index 000000000..10a9ede54 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowLibraryAction.md @@ -0,0 +1,57 @@ +--- +id: beta-workflow-library-action +title: WorkflowLibraryAction +pagination_label: WorkflowLibraryAction +sidebar_label: WorkflowLibraryAction +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryAction', 'BetaWorkflowLibraryAction'] +slug: /tools/sdk/powershell/beta/models/workflow-library-action +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryAction', 'BetaWorkflowLibraryAction'] +--- + + +# WorkflowLibraryAction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Action ID. This is a static namespaced ID for the action | [optional] +**Name** | Pointer to **String** | Action Name | [optional] +**Type** | Pointer to **String** | Action type | [optional] +**Description** | Pointer to **String** | Action Description | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the action accepts | [optional] +**ExampleOutput** | Pointer to [**WorkflowLibraryActionExampleOutput**](workflow-library-action-example-output) | | [optional] +**Deprecated** | Pointer to **Boolean** | | [optional] +**DeprecatedBy** | Pointer to **System.DateTime** | | [optional] +**VersionNumber** | Pointer to **Int32** | Version number | [optional] +**IsSimulationEnabled** | Pointer to **Boolean** | | [optional] +**IsDynamicSchema** | Pointer to **Boolean** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**OutputSchema** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Defines the output schema, if any, that this action produces. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowLibraryAction = Initialize-PSSailpoint.BetaWorkflowLibraryAction -Id sp:create-campaign ` + -Name Create Certification Campaign ` + -Type ACTION ` + -Description Generates a certification campaign. ` + -FormFields null ` + -ExampleOutput null ` + -Deprecated null ` + -DeprecatedBy null ` + -VersionNumber null ` + -IsSimulationEnabled null ` + -IsDynamicSchema false ` + -OutputSchema {definitions={}, properties={autoRevokeAllowed={$id=#sp:create-campaign/autoRevokeAllowed, default=true, examples=[false], title=autoRevokeAllowed, type=boolean}, deadline={$id=#sp:create-campaign/deadline, default=, examples=[2020-12-25T06:00:00.468Z], format=date-time, pattern=^.*$, title=deadline, type=string}, description={$id=#sp:create-campaign/description, default=, examples=[A review of everyone's access by their manager.], pattern=^.*$, title=description, type=string}, emailNotificationEnabled={$id=#sp:create-campaign/emailNotificationEnabled, default=true, examples=[false], title=emailNotificationEnabled, type=boolean}, filter={$id=#sp:create-campaign/filter, properties={id={$id=#sp:create-campaign/filter/id, default=, examples=[e0adaae69852e8fe8b8a3d48e5ce757c], pattern=^.*$, title=id, type=string}, type={$id=#sp:create-campaign/filter/type, default=, examples=[CAMPAIGN_FILTER], pattern=^.*$, title=type, type=string}}, title=filter, type=object}, id={$id=#sp:create-campaign/id, default=, examples=[2c918086719eec070171a7e3355a360a], pattern=^.*$, title=id, type=string}, name={$id=#sp:create-campaign/name, default=, examples=[Manager Review], pattern=^.*$, title=name, type=string}, recommendationsEnabled={$id=#sp:create-campaign/recommendationsEnabled, default=true, examples=[false], title=recommendationEnabled, type=boolean}, type={$id=#sp:create-campaign/type, default=, examples=[MANAGER], pattern=^.*$, title=type, type=string}}, title=sp:create-campaign, type=object} +``` + +- Convert the resource to JSON +```powershell +$WorkflowLibraryAction | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowLibraryActionExampleOutput.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowLibraryActionExampleOutput.md new file mode 100644 index 000000000..04873a947 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowLibraryActionExampleOutput.md @@ -0,0 +1,34 @@ +--- +id: beta-workflow-library-action-example-output +title: WorkflowLibraryActionExampleOutput +pagination_label: WorkflowLibraryActionExampleOutput +sidebar_label: WorkflowLibraryActionExampleOutput +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryActionExampleOutput', 'BetaWorkflowLibraryActionExampleOutput'] +slug: /tools/sdk/powershell/beta/models/workflow-library-action-example-output +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryActionExampleOutput', 'BetaWorkflowLibraryActionExampleOutput'] +--- + + +# WorkflowLibraryActionExampleOutput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$WorkflowLibraryActionExampleOutput = Initialize-PSSailpoint.BetaWorkflowLibraryActionExampleOutput +``` + +- Convert the resource to JSON +```powershell +$WorkflowLibraryActionExampleOutput | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowLibraryFormFields.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowLibraryFormFields.md new file mode 100644 index 000000000..97562db7e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowLibraryFormFields.md @@ -0,0 +1,45 @@ +--- +id: beta-workflow-library-form-fields +title: WorkflowLibraryFormFields +pagination_label: WorkflowLibraryFormFields +sidebar_label: WorkflowLibraryFormFields +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryFormFields', 'BetaWorkflowLibraryFormFields'] +slug: /tools/sdk/powershell/beta/models/workflow-library-form-fields +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryFormFields', 'BetaWorkflowLibraryFormFields'] +--- + + +# WorkflowLibraryFormFields + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **String** | Description of the form field | [optional] +**HelpText** | Pointer to **String** | Describes the form field in the UI | [optional] +**Label** | Pointer to **String** | A human readable name for this form field in the UI | [optional] +**Name** | Pointer to **String** | The name of the input attribute | [optional] +**Required** | Pointer to **Boolean** | Denotes if this field is a required attribute | [optional] +**Type** | Pointer to **Enum** [ "text", "textarea", "boolean", "email", "url", "number", "json", "checkbox", "jsonpath", "select", "multiType", "duration", "toggle", "formPicker", "identityPicker", "governanceGroupPicker", "string", "object", "array", "secret", "keyValuePairs", "emailPicker", "advancedToggle", "variableCreator", "htmlEditor" ] | The type of the form field | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowLibraryFormFields = Initialize-PSSailpoint.BetaWorkflowLibraryFormFields -Description First value to compare ` + -HelpText The name to give to this certification campaign. ` + -Label Campaign Name ` + -Name name ` + -Required false ` + -Type text +``` + +- Convert the resource to JSON +```powershell +$WorkflowLibraryFormFields | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowLibraryOperator.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowLibraryOperator.md new file mode 100644 index 000000000..143ee4165 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowLibraryOperator.md @@ -0,0 +1,51 @@ +--- +id: beta-workflow-library-operator +title: WorkflowLibraryOperator +pagination_label: WorkflowLibraryOperator +sidebar_label: WorkflowLibraryOperator +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryOperator', 'BetaWorkflowLibraryOperator'] +slug: /tools/sdk/powershell/beta/models/workflow-library-operator +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryOperator', 'BetaWorkflowLibraryOperator'] +--- + + +# WorkflowLibraryOperator + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Operator ID. | [optional] +**Name** | Pointer to **String** | Operator friendly name | [optional] +**Type** | Pointer to **String** | Operator type | [optional] +**Description** | Pointer to **String** | Description of the operator | [optional] +**IsDynamicSchema** | Pointer to **Boolean** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**Deprecated** | Pointer to **Boolean** | | [optional] +**DeprecatedBy** | Pointer to **System.DateTime** | | [optional] +**IsSimulationEnabled** | Pointer to **Boolean** | | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the operator accepts | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowLibraryOperator = Initialize-PSSailpoint.BetaWorkflowLibraryOperator -Id sp:compare-boolean ` + -Name Compare Boolean Values ` + -Type OPERATOR ` + -Description Compare two boolean values and decide what happens based on the result. ` + -IsDynamicSchema false ` + -Deprecated null ` + -DeprecatedBy null ` + -IsSimulationEnabled null ` + -FormFields [{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] +``` + +- Convert the resource to JSON +```powershell +$WorkflowLibraryOperator | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowLibraryTrigger.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowLibraryTrigger.md new file mode 100644 index 000000000..b91cc6da1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowLibraryTrigger.md @@ -0,0 +1,55 @@ +--- +id: beta-workflow-library-trigger +title: WorkflowLibraryTrigger +pagination_label: WorkflowLibraryTrigger +sidebar_label: WorkflowLibraryTrigger +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryTrigger', 'BetaWorkflowLibraryTrigger'] +slug: /tools/sdk/powershell/beta/models/workflow-library-trigger +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryTrigger', 'BetaWorkflowLibraryTrigger'] +--- + + +# WorkflowLibraryTrigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Trigger ID. This is a static namespaced ID for the trigger. | [optional] +**Type** | Pointer to **Enum** [ "EVENT", "SCHEDULED", "EXTERNAL" ] | Trigger type | [optional] +**Deprecated** | Pointer to **Boolean** | | [optional] +**DeprecatedBy** | Pointer to **System.DateTime** | | [optional] +**IsSimulationEnabled** | Pointer to **Boolean** | | [optional] +**OutputSchema** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Example output schema | [optional] +**Name** | Pointer to **String** | Trigger Name | [optional] +**Description** | Pointer to **String** | Trigger Description | [optional] +**IsDynamicSchema** | Pointer to **Boolean** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**InputExample** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Example trigger payload if applicable | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the trigger accepts | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowLibraryTrigger = Initialize-PSSailpoint.BetaWorkflowLibraryTrigger -Id idn:identity-attributes-changed ` + -Type EVENT ` + -Deprecated null ` + -DeprecatedBy null ` + -IsSimulationEnabled null ` + -OutputSchema null ` + -Name Identity Attributes Changed ` + -Description One or more identity attributes changed. ` + -IsDynamicSchema false ` + -InputExample {changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} ` + -FormFields [] +``` + +- Convert the resource to JSON +```powershell +$WorkflowLibraryTrigger | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowModifiedBy.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowModifiedBy.md new file mode 100644 index 000000000..0ae6a9c11 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowModifiedBy.md @@ -0,0 +1,39 @@ +--- +id: beta-workflow-modified-by +title: WorkflowModifiedBy +pagination_label: WorkflowModifiedBy +sidebar_label: WorkflowModifiedBy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowModifiedBy', 'BetaWorkflowModifiedBy'] +slug: /tools/sdk/powershell/beta/models/workflow-modified-by +tags: ['SDK', 'Software Development Kit', 'WorkflowModifiedBy', 'BetaWorkflowModifiedBy'] +--- + + +# WorkflowModifiedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | | [optional] +**Id** | Pointer to **String** | Identity ID | [optional] +**Name** | Pointer to **String** | Human-readable display name of identity. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowModifiedBy = Initialize-PSSailpoint.BetaWorkflowModifiedBy -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Thomas Edison +``` + +- Convert the resource to JSON +```powershell +$WorkflowModifiedBy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowOAuthClient.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowOAuthClient.md new file mode 100644 index 000000000..f932e87af --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowOAuthClient.md @@ -0,0 +1,39 @@ +--- +id: beta-workflow-o-auth-client +title: WorkflowOAuthClient +pagination_label: WorkflowOAuthClient +sidebar_label: WorkflowOAuthClient +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowOAuthClient', 'BetaWorkflowOAuthClient'] +slug: /tools/sdk/powershell/beta/models/workflow-o-auth-client +tags: ['SDK', 'Software Development Kit', 'WorkflowOAuthClient', 'BetaWorkflowOAuthClient'] +--- + + +# WorkflowOAuthClient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | OAuth client ID for the trigger. This is a UUID generated upon creation. | [optional] +**Secret** | Pointer to **String** | OAuthClient secret. | [optional] +**Url** | Pointer to **String** | URL for the external trigger to invoke | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowOAuthClient = Initialize-PSSailpoint.BetaWorkflowOAuthClient -Id 1a58c03a6bf64dc2876f6988c6e2c7b7 ` + -Secret 00cc24a7fe810fe06a7cb38bc168ae104d703c7abb296f9944dc68e69ddb578b ` + -Url https://tenant.api.identitynow.com/beta/workflows/execute/external/c17bea3a-574d-453c-9e04-4365fbf5af0b +``` + +- Convert the resource to JSON +```powershell +$WorkflowOAuthClient | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowTrigger.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowTrigger.md new file mode 100644 index 000000000..2ed241c07 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowTrigger.md @@ -0,0 +1,39 @@ +--- +id: beta-workflow-trigger +title: WorkflowTrigger +pagination_label: WorkflowTrigger +sidebar_label: WorkflowTrigger +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowTrigger', 'BetaWorkflowTrigger'] +slug: /tools/sdk/powershell/beta/models/workflow-trigger +tags: ['SDK', 'Software Development Kit', 'WorkflowTrigger', 'BetaWorkflowTrigger'] +--- + + +# WorkflowTrigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "EVENT", "EXTERNAL", "SCHEDULED", "" ] | The trigger type | [required] +**DisplayName** | Pointer to **String** | | [optional] +**Attributes** | [**WorkflowTriggerAttributes**](workflow-trigger-attributes) | | [required] + +## Examples + +- Prepare the resource +```powershell +$WorkflowTrigger = Initialize-PSSailpoint.BetaWorkflowTrigger -Type EVENT ` + -DisplayName null ` + -Attributes null +``` + +- Convert the resource to JSON +```powershell +$WorkflowTrigger | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowTriggerAttributes.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowTriggerAttributes.md new file mode 100644 index 000000000..74709cade --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkflowTriggerAttributes.md @@ -0,0 +1,55 @@ +--- +id: beta-workflow-trigger-attributes +title: WorkflowTriggerAttributes +pagination_label: WorkflowTriggerAttributes +sidebar_label: WorkflowTriggerAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowTriggerAttributes', 'BetaWorkflowTriggerAttributes'] +slug: /tools/sdk/powershell/beta/models/workflow-trigger-attributes +tags: ['SDK', 'Software Development Kit', 'WorkflowTriggerAttributes', 'BetaWorkflowTriggerAttributes'] +--- + + +# WorkflowTriggerAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the trigger | [required] +**VarFilter** | Pointer to **String** | JSON path expression that will limit which events the trigger will fire on | [optional] +**Description** | Pointer to **String** | Additional context about the external trigger | [optional] +**Name** | Pointer to **String** | A unique name for the external trigger | [optional] +**ClientId** | Pointer to **String** | OAuth Client ID to authenticate with this trigger | [optional] +**Url** | Pointer to **String** | URL to invoke this workflow | [optional] +**Frequency** | **Enum** [ "daily", "weekly", "monthly", "yearly", "cronSchedule" ] | Frequency of execution | [required] +**TimeZone** | Pointer to **String** | Time zone identifier | [optional] +**CronString** | Pointer to **String** | | [optional] +**WeeklyDays** | Pointer to **[]String** | Scheduled days of the week for execution | [optional] +**WeeklyTimes** | Pointer to **[]String** | Scheduled execution times | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowTriggerAttributes = Initialize-PSSailpoint.BetaWorkflowTriggerAttributes -Id idn:identity-attributes-changed ` + -VarFilter $.changes[?(@.attribute == 'manager')] ` + -Description Run a search and notify the results ` + -Name search-and-notify ` + -ClientId 87e239b2-b85b-4bde-b9a7-55bf304ddcdc ` + -Url https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d ` + -Frequency null ` + -TimeZone America/Chicago ` + -CronString 0 9 * * 1 ` + -WeeklyDays Monday ` + -WeeklyTimes Monday +``` + +- Convert the resource to JSON +```powershell +$WorkflowTriggerAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkgroupBulkDeleteRequest.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkgroupBulkDeleteRequest.md new file mode 100644 index 000000000..b4cd2ed39 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkgroupBulkDeleteRequest.md @@ -0,0 +1,35 @@ +--- +id: beta-workgroup-bulk-delete-request +title: WorkgroupBulkDeleteRequest +pagination_label: WorkgroupBulkDeleteRequest +sidebar_label: WorkgroupBulkDeleteRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkgroupBulkDeleteRequest', 'BetaWorkgroupBulkDeleteRequest'] +slug: /tools/sdk/powershell/beta/models/workgroup-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'WorkgroupBulkDeleteRequest', 'BetaWorkgroupBulkDeleteRequest'] +--- + + +# WorkgroupBulkDeleteRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]String** | List of IDs of Governance Groups to be deleted. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkgroupBulkDeleteRequest = Initialize-PSSailpoint.BetaWorkgroupBulkDeleteRequest -Ids [567a697e-885b-495a-afc5-d55e1c23a302, c7b0f7b2-1e78-4063-b294-a555333dacd2] +``` + +- Convert the resource to JSON +```powershell +$WorkgroupBulkDeleteRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkgroupConnectionDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkgroupConnectionDto.md new file mode 100644 index 000000000..54e77c8a9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkgroupConnectionDto.md @@ -0,0 +1,37 @@ +--- +id: beta-workgroup-connection-dto +title: WorkgroupConnectionDto +pagination_label: WorkgroupConnectionDto +sidebar_label: WorkgroupConnectionDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkgroupConnectionDto', 'BetaWorkgroupConnectionDto'] +slug: /tools/sdk/powershell/beta/models/workgroup-connection-dto +tags: ['SDK', 'Software Development Kit', 'WorkgroupConnectionDto', 'BetaWorkgroupConnectionDto'] +--- + + +# WorkgroupConnectionDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Object** | Pointer to [**ConnectedObject**](connected-object) | | [optional] +**ConnectionType** | Pointer to **Enum** [ "AccessRequestReviewer", "Owner", "ManagementWorkgroup" ] | Connection Type. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkgroupConnectionDto = Initialize-PSSailpoint.BetaWorkgroupConnectionDto -Object null ` + -ConnectionType AccessRequestReviewer +``` + +- Convert the resource to JSON +```powershell +$WorkgroupConnectionDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkgroupDeleteItem.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkgroupDeleteItem.md new file mode 100644 index 000000000..4c0cd0890 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkgroupDeleteItem.md @@ -0,0 +1,45 @@ +--- +id: beta-workgroup-delete-item +title: WorkgroupDeleteItem +pagination_label: WorkgroupDeleteItem +sidebar_label: WorkgroupDeleteItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkgroupDeleteItem', 'BetaWorkgroupDeleteItem'] +slug: /tools/sdk/powershell/beta/models/workgroup-delete-item +tags: ['SDK', 'Software Development Kit', 'WorkgroupDeleteItem', 'BetaWorkgroupDeleteItem'] +--- + + +# WorkgroupDeleteItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Id of the Governance Group. | [required] +**Status** | **Int32** | The HTTP response status code returned for an individual Governance Group that is requested for deletion during a bulk delete operation. > 204 - Governance Group deleted successfully. > 409 - Governance Group is in use,hence can not be deleted. > 404 - Governance Group not found. | [required] +**Description** | Pointer to **String** | Human readable status description and containing additional context information about success or failures etc. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkgroupDeleteItem = Initialize-PSSailpoint.BetaWorkgroupDeleteItem -Id 464ae7bf791e49fdb74606a2e4a89635 ` + -Status 204 ` + -Description +> Governance Group deleted successfully. + +> Unable to delete Governance Group f80bba83-98c4-4ec2-81c8-373c00e9663b because it is in use. + +> Referenced Governance Group 2b711763-ed35-42a2-a80c-8f1ce0dc4a7f was not found. + +``` + +- Convert the resource to JSON +```powershell +$WorkgroupDeleteItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkgroupDto.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkgroupDto.md new file mode 100644 index 000000000..a11359080 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkgroupDto.md @@ -0,0 +1,49 @@ +--- +id: beta-workgroup-dto +title: WorkgroupDto +pagination_label: WorkgroupDto +sidebar_label: WorkgroupDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkgroupDto', 'BetaWorkgroupDto'] +slug: /tools/sdk/powershell/beta/models/workgroup-dto +tags: ['SDK', 'Software Development Kit', 'WorkgroupDto', 'BetaWorkgroupDto'] +--- + + +# WorkgroupDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Owner** | Pointer to [**WorkgroupDtoOwner**](workgroup-dto-owner) | | [optional] +**Id** | Pointer to **String** | Governance group ID. | [optional] [readonly] +**Name** | Pointer to **String** | Governance group name. | [optional] +**Description** | Pointer to **String** | Governance group description. | [optional] +**MemberCount** | Pointer to **Int64** | Number of members in the governance group. | [optional] [readonly] +**ConnectionCount** | Pointer to **Int64** | Number of connections in the governance group. | [optional] [readonly] +**Created** | Pointer to **System.DateTime** | | [optional] +**Modified** | Pointer to **System.DateTime** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkgroupDto = Initialize-PSSailpoint.BetaWorkgroupDto -Owner null ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name DB Access Governance Group ` + -Description Description of the Governance Group ` + -MemberCount 1641498673000 ` + -ConnectionCount 1641498673000 ` + -Created 2022-01-06T19:51:13Z ` + -Modified 2022-01-06T19:51:13Z +``` + +- Convert the resource to JSON +```powershell +$WorkgroupDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkgroupDtoOwner.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkgroupDtoOwner.md new file mode 100644 index 000000000..4ac6d8cb9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkgroupDtoOwner.md @@ -0,0 +1,43 @@ +--- +id: beta-workgroup-dto-owner +title: WorkgroupDtoOwner +pagination_label: WorkgroupDtoOwner +sidebar_label: WorkgroupDtoOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkgroupDtoOwner', 'BetaWorkgroupDtoOwner'] +slug: /tools/sdk/powershell/beta/models/workgroup-dto-owner +tags: ['SDK', 'Software Development Kit', 'WorkgroupDtoOwner', 'BetaWorkgroupDtoOwner'] +--- + + +# WorkgroupDtoOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Owner's DTO type. | [optional] +**Id** | Pointer to **String** | Owner's identity ID. | [optional] +**Name** | Pointer to **String** | Owner's name. | [optional] +**DisplayName** | Pointer to **String** | The display name of the identity | [optional] [readonly] +**EmailAddress** | Pointer to **String** | The primary email address of the identity | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$WorkgroupDtoOwner = Initialize-PSSailpoint.BetaWorkgroupDtoOwner -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Support ` + -DisplayName Support ` + -EmailAddress support@sailpoint.com +``` + +- Convert the resource to JSON +```powershell +$WorkgroupDtoOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkgroupMemberAddItem.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkgroupMemberAddItem.md new file mode 100644 index 000000000..a7bcf609c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkgroupMemberAddItem.md @@ -0,0 +1,43 @@ +--- +id: beta-workgroup-member-add-item +title: WorkgroupMemberAddItem +pagination_label: WorkgroupMemberAddItem +sidebar_label: WorkgroupMemberAddItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkgroupMemberAddItem', 'BetaWorkgroupMemberAddItem'] +slug: /tools/sdk/powershell/beta/models/workgroup-member-add-item +tags: ['SDK', 'Software Development Kit', 'WorkgroupMemberAddItem', 'BetaWorkgroupMemberAddItem'] +--- + + +# WorkgroupMemberAddItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Identifier of identity in bulk member add request. | [required] +**Status** | **Int32** | The HTTP response status code returned for an individual member that is requested for addition during a bulk add operation. The HTTP response status code returned for an individual Governance Group is requested for deletion. > 201 - Identity is added into Governance Group members list. > 409 - Identity is already member of Governance Group. | [required] +**Description** | Pointer to **String** | Human readable status description and containing additional context information about success or failures etc. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkgroupMemberAddItem = Initialize-PSSailpoint.BetaWorkgroupMemberAddItem -Id 464ae7bf791e49fdb74606a2e4a89635 ` + -Status 201 ` + -Description +> Identity is added into Governance Group members list. + +> Unable to set Membership of Identity "3244d5f2d04447498520f54c6789ae33" to Governance Group "f80bba83-98c4-4ec2-81c8-373c00e9663b"; the relationship already exists. + +``` + +- Convert the resource to JSON +```powershell +$WorkgroupMemberAddItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkgroupMemberDeleteItem.md b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkgroupMemberDeleteItem.md new file mode 100644 index 000000000..4cf110cd0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/docs/Models/WorkgroupMemberDeleteItem.md @@ -0,0 +1,43 @@ +--- +id: beta-workgroup-member-delete-item +title: WorkgroupMemberDeleteItem +pagination_label: WorkgroupMemberDeleteItem +sidebar_label: WorkgroupMemberDeleteItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkgroupMemberDeleteItem', 'BetaWorkgroupMemberDeleteItem'] +slug: /tools/sdk/powershell/beta/models/workgroup-member-delete-item +tags: ['SDK', 'Software Development Kit', 'WorkgroupMemberDeleteItem', 'BetaWorkgroupMemberDeleteItem'] +--- + + +# WorkgroupMemberDeleteItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Identifier of identity in bulk member add /remove request. | [required] +**Status** | **Int32** | The HTTP response status code returned for an individual member that is requested for deletion during a bulk delete operation. > 204 - Identity is removed from Governance Group members list. > 404 - Identity is not member of Governance Group. | [required] +**Description** | Pointer to **String** | Human readable status description and containing additional context information about success or failures etc. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkgroupMemberDeleteItem = Initialize-PSSailpoint.BetaWorkgroupMemberDeleteItem -Id 464ae7bf791e49fdb74606a2e4a89635 ` + -Status 204 ` + -Description +> Identity deleted from Governance Group members list. + +> Referenced Governance Group Member with Identity Id "bc3a744678534eb78a8002ee2085df64" was not found. + +``` + +- Convert the resource to JSON +```powershell +$WorkgroupMemberDeleteItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Examples/code_examples_overlay.yaml b/docs/tools/sdk/powershell/Reference/V2024/docs/Examples/code_examples_overlay.yaml new file mode 100644 index 000000000..f33a5cbbb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Examples/code_examples_overlay.yaml @@ -0,0 +1,17122 @@ +- path: /access-model-metadata/attributes/{key} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Key = "iscPrivacy" # String | Technical name of the Attribute. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Access Model Metadata Attribute + + try { + Get-V2024AccessModelMetadataAttribute-V2024Key $Key -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessModelMetadataAttribute -V2024Key $Key -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute" + Write-Host $_.ErrorDetails + } +- path: /access-model-metadata/attributes/{key}/values/{value} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Key = "iscPrivacy" # String | Technical name of the Attribute. + $Value = "public" # String | Technical name of the Attribute value. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Access Model Metadata Value + + try { + Get-V2024AccessModelMetadataAttributeValue-V2024Key $Key -V2024Value $Value -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessModelMetadataAttributeValue -V2024Key $Key -V2024Value $Value -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue" + Write-Host $_.ErrorDetails + } +- path: /access-model-metadata/attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "name eq "Privacy"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) + + # List Access Model Metadata Attributes + + try { + Get-V2024AccessModelMetadataAttribute-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessModelMetadataAttribute -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute" + Write-Host $_.ErrorDetails + } +- path: /access-model-metadata/attributes/{key}/values + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Key = "iscPrivacy" # String | Technical name of the Attribute. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List Access Model Metadata Values + + try { + Get-V2024AccessModelMetadataAttributeValue-V2024Key $Key -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessModelMetadataAttributeValue -V2024Key $Key -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue" + Write-Host $_.ErrorDetails + } +- path: /access-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessProfile = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "description" : "Collection of entitlements to read/write the employee database", + "source" : { + "name" : "ODS-AD-SOURCE", + "id" : "2c91809773dee3610173fdb0b6061ef4", + "type" : "SOURCE" + }, + "enabled" : true, + "revocationRequestConfig" : { + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ] + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "accessRequestConfig" : { + "commentsRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "name" : "Employee-database-read-write", + "provisioningCriteria" : { + "children" : [ { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, + "modified" : "2021-03-02T20:22:28.104Z", + "id" : "2c91808a7190d06e01719938fcd20792", + "requestable" : true + } + "@ + + # Create Access Profile + + try { + $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile + New-V2024AccessProfile-V2024AccessProfile $Result + + # Below is a request that includes all optional parameters + # New-V2024AccessProfile -V2024AccessProfile $AccessProfile + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete + + # Delete the specified Access Profile + + try { + Remove-V2024AccessProfile-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024AccessProfile -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessProfileBulkDeleteRequest = @" + { + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + } + "@ + + # Delete Access Profile(s) + + try { + $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest + Remove-V2024AccessProfilesInBulk-V2024AccessProfileBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024AccessProfilesInBulk -V2024AccessProfileBulkDeleteRequest $AccessProfileBulkDeleteRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfilesInBulk" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile + + # Get an Access Profile + + try { + Get-V2024AccessProfile-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccessProfile -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + + # List Access Profile's Entitlements + + try { + Get-V2024AccessProfileEntitlements-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccessProfileEntitlements -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfileEntitlements" + Write-Host $_.ErrorDetails + } +- path: /access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin. (optional) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Composite operators supported: *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + + # List Access Profiles + + try { + Get-V2024AccessProfiles + + # Below is a request that includes all optional parameters + # Get-V2024AccessProfiles -V2024ForSubadmin $ForSubadmin -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters -V2024ForSegmentIds $ForSegmentIds -V2024IncludeUnsegmented $IncludeUnsegmented + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfiles" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Access Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AccessProfile-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AccessProfile -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/bulk-update-requestable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ + + + # Update Access Profile(s) requestable field. + + try { + $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner + Update-V2024AccessProfilesInBulk-V2024XSailPointExperimental $XSailPointExperimental -V2024AccessProfileBulkUpdateRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-V2024AccessProfilesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessProfileBulkUpdateRequestInner $AccessProfileBulkUpdateRequestInner + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AccessProfilesInBulk" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + } + "@ + + # Approve Access Request Approval + + try { + Approve-V2024AccessRequest-V2024ApprovalId $ApprovalId + + # Below is a request that includes all optional parameters + # Approve-V2024AccessRequest -V2024ApprovalId $ApprovalId -V2024CommentDto $CommentDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $ForwardApprovalDto = @" + { + "newOwnerId" : "2c91808568c529c60168cca6f90c1314", + "comment" : "2c91808568c529c60168cca6f90c1313" + } + "@ + + # Forward Access Request Approval + + try { + $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto + Invoke-V2024ForwardAccessRequest-V2024ApprovalId $ApprovalId -V2024ForwardApprovalDto $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024ForwardAccessRequest -V2024ApprovalId $ApprovalId -V2024ForwardApprovalDto $ForwardApprovalDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ForwardAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/approval-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + + # Get Access Requests Approvals Number + + try { + Get-V2024AccessRequestApprovalSummary + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestApprovalSummary -V2024OwnerId $OwnerId -V2024FromDate $FromDate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestApprovalSummary" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{accessRequestId}/approvers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessRequestId = "2c91808568c529c60168cca6f90c1313" # String | Access Request ID. + $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) + $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) + + # Access Request Approvers + + try { + Get-V2024AccessRequestApprovers-V2024AccessRequestId $AccessRequestId + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestApprovers -V2024AccessRequestId $AccessRequestId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestApprovers" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) + $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Completed Access Request Approvals List + + try { + Get-V2024CompletedApprovals + + # Below is a request that includes all optional parameters + # Get-V2024CompletedApprovals -V2024OwnerId $OwnerId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompletedApprovals" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/pending + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional) + $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Pending Access Request Approvals List + + try { + Get-V2024PendingApprovals + + # Below is a request that includes all optional parameters + # Get-V2024PendingApprovals -V2024OwnerId $OwnerId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingApprovals" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/reject + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + } + "@ + + # Reject Access Request Approval + + try { + $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto + Deny-V2024AccessRequest-V2024ApprovalId $ApprovalId -V2024CommentDto $Result + + # Below is a request that includes all optional parameters + # Deny-V2024AccessRequest -V2024ApprovalId $ApprovalId -V2024CommentDto $CommentDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID. + $RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID. + $Type = "ENTITLEMENT" # String | Requested access item's type. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Return access request identity metrics + + try { + Get-V2024AccessRequestIdentityMetrics-V2024IdentityId $IdentityId -V2024RequestedObjectId $RequestedObjectId -V2024Type $Type -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestIdentityMetrics -V2024IdentityId $IdentityId -V2024RequestedObjectId $RequestedObjectId -V2024Type $Type -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestIdentityMetrics" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/bulk-approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $BulkApproveAccessRequest = @" + { + "comment" : "I approve these request items", + "approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ] + } + "@ + + # Bulk Approve Access Request + + try { + $Result = ConvertFrom-JsonToBulkApproveAccessRequest -Json $BulkApproveAccessRequest + Approve-V2024BulkAccessRequest-V2024BulkApproveAccessRequest $Result + + # Below is a request that includes all optional parameters + # Approve-V2024BulkAccessRequest -V2024BulkApproveAccessRequest $BulkApproveAccessRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024BulkAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-requests/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CancelAccessRequest = @" + { + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + } + "@ + + # Cancel Access Request + + try { + $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest + Suspend-V2024AccessRequest-V2024CancelAccessRequest $Result + + # Below is a request that includes all optional parameters + # Suspend-V2024AccessRequest -V2024CancelAccessRequest $CancelAccessRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-requests/bulk-cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $BulkCancelAccessRequest = @" + { + "accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ], + "comment" : "I requested this role by mistake." + } + "@ + + # Bulk Cancel Access Request + + try { + $Result = ConvertFrom-JsonToBulkCancelAccessRequest -Json $BulkCancelAccessRequest + Suspend-V2024AccessRequestInBulk-V2024BulkCancelAccessRequest $Result + + # Below is a request that includes all optional parameters + # Suspend-V2024AccessRequestInBulk -V2024BulkCancelAccessRequest $BulkCancelAccessRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024AccessRequestInBulk" + Write-Host $_.ErrorDetails + } +- path: /access-requests/close + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CloseAccessRequest = @" + { + "executionStatus" : "Terminated", + "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "completionStatus" : "Failure", + "message" : "The IdentityNow Administrator manually closed this request." + } + "@ + + # Close Access Request + + try { + $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest + Close-V2024AccessRequest-V2024XSailPointExperimental $XSailPointExperimental -V2024CloseAccessRequest $Result + + # Below is a request that includes all optional parameters + # Close-V2024AccessRequest -V2024XSailPointExperimental $XSailPointExperimental -V2024CloseAccessRequest $CloseAccessRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-V2024AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessRequest = @" + { + "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + } ] + } + "@ + + # Submit Access Request + + try { + $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest + New-V2024AccessRequest-V2024AccessRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024AccessRequest -V2024AccessRequest $AccessRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Access Request Configuration + + try { + Get-V2024AccessRequestConfig + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /access-request-status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) + $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) + $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + $Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) + $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + # Access Request Status + + try { + Get-V2024AccessRequestStatus + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestStatus -V2024RequestedFor $RequestedFor -V2024RequestedBy $RequestedBy -V2024RegardingIdentity $RegardingIdentity -V2024AssignedTo $AssignedTo -V2024Count $Count -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters -V2024Sorters $Sorters -V2024RequestState $RequestState + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestStatus" + Write-Host $_.ErrorDetails + } +- path: /access-request-administration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) + $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) + $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + $Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name, accessRequestId** (optional) + $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + # Access Request Status for Administrators + + try { + Get-V2024AdministratorsAccessRequestStatus + + # Below is a request that includes all optional parameters + # Get-V2024AdministratorsAccessRequestStatus -V2024RequestedFor $RequestedFor -V2024RequestedBy $RequestedBy -V2024RegardingIdentity $RegardingIdentity -V2024AssignedTo $AssignedTo -V2024Count $Count -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters -V2024Sorters $Sorters -V2024RequestState $RequestState + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AdministratorsAccessRequestStatus" + Write-Host $_.ErrorDetails + } +- path: /access-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessRequestConfig = @" + { + "requestOnBehalfOfConfig" : { + "allowRequestOnBehalfOfEmployeeByManager" : true, + "allowRequestOnBehalfOfAnyoneByAnyone" : true + }, + "approvalReminderAndEscalationConfig" : { + "fallbackApproverRef" : { + "name" : "Alison Ferguso", + "id" : "5168015d32f890ca15812c9180835d2e", + "type" : "IDENTITY", + "email" : "alison.ferguso@identitysoon.com" + }, + "maxReminders" : 1, + "daysUntilEscalation" : 0, + "daysBetweenReminders" : 0 + }, + "autoApprovalEnabled" : true, + "entitlementRequestConfig" : { + "requestCommentsRequired" : false, + "deniedCommentsRequired" : false, + "allowEntitlementRequest" : true, + "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + }, + "reauthorizationEnabled" : true, + "approvalsMustBeExternal" : true + } + "@ + + # Update Access Request Configuration + + try { + $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig + Set-V2024AccessRequestConfig-V2024AccessRequestConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024AccessRequestConfig -V2024AccessRequestConfig $AccessRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024AccessRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /account-activities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id + + # Get an Account Activity + + try { + Get-V2024AccountActivity-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccountActivity -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountActivity" + Write-Host $_.ErrorDetails + } +- path: /account-activities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "2c91808568c529c60168cca6f90c1313" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c91808568c529c60168cca6f90c1313" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c91808568c529c60168cca6f90c1313" # String | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "type eq "Identity Refresh"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) + + # List Account Activities + + try { + Get-V2024AccountActivities + + # Below is a request that includes all optional parameters + # Get-V2024AccountActivities -V2024RequestedFor $RequestedFor -V2024RequestedBy $RequestedBy -V2024RegardingIdentity $RegardingIdentity -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountActivities" + Write-Host $_.ErrorDetails + } +- path: /account-aggregations/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # In-progress Account Aggregation status + + try { + Get-V2024AccountAggregationStatus-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccountAggregationStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountAggregationStatus" + Write-Host $_.ErrorDetails + } +- path: /accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccountAttributesCreate = @" + { + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Create Account + + try { + $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate + New-V2024Account-V2024AccountAttributesCreate $Result + + # Below is a request that includes all optional parameters + # New-V2024Account -V2024AccountAttributesCreate $AccountAttributesCreate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Delete Account + + try { + Remove-V2024Account-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Account -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Remove Account + + try { + Remove-V2024AccountAsync-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024AccountAsync -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountAsync" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Disable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Disable-V2024Account-V2024Id $Id -V2024AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Disable-V2024Account -V2024Id $Id -V2024AccountToggleRequest $AccountToggleRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024Account" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/{id}/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808384203c2d018437e631158309" # String | The identity id. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Disable IDN Account for Identity + + try { + Disable-V2024AccountForIdentity-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Disable-V2024AccountForIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountForIdentity" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentitiesAccountsBulkRequest = @" + { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } + "@ + + # Disable IDN Accounts for Identities + + try { + $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest + Disable-V2024AccountsForIdentities-V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result + + # Below is a request that includes all optional parameters + # Disable-V2024AccountsForIdentities -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountsForIdentities" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Enable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Enable-V2024Account-V2024Id $Id -V2024AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Enable-V2024Account -V2024Id $Id -V2024AccountToggleRequest $AccountToggleRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024Account" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/{id}/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808384203c2d018437e631158309" # String | The identity id. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Enable IDN Account for Identity + + try { + Enable-V2024AccountForIdentity-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Enable-V2024AccountForIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountForIdentity" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentitiesAccountsBulkRequest = @" + { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } + "@ + + # Enable IDN Accounts for Identities + + try { + $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest + Enable-V2024AccountsForIdentities-V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result + + # Below is a request that includes all optional parameters + # Enable-V2024AccountsForIdentities -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountsForIdentities" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Account Details + + try { + Get-V2024Account-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Account -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Account Entitlements + + try { + Get-V2024AccountEntitlements-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccountEntitlements -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountEntitlements" + Write-Host $_.ErrorDetails + } +- path: /accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) + $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + + # Accounts List + + try { + Get-V2024Accounts + + # Below is a request that includes all optional parameters + # Get-V2024Accounts -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024DetailLevel $DetailLevel -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Accounts" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $AccountAttributes = @" + { + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Update Account + + try { + $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes + Send-V2024Account-V2024Id $Id -V2024AccountAttributes $Result + + # Below is a request that includes all optional parameters + # Send-V2024Account -V2024Id $Id -V2024AccountAttributes $AccountAttributes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/reload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + + # Reload Account + + try { + Submit-V2024ReloadAccount-V2024Id $Id + + # Below is a request that includes all optional parameters + # Submit-V2024ReloadAccount -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReloadAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/unlock + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. + $AccountUnlockRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + } + "@ + + # Unlock Account + + try { + $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest + Unlock-V2024Account-V2024Id $Id -V2024AccountUnlockRequest $Result + + # Below is a request that includes all optional parameters + # Unlock-V2024Account -V2024Id $Id -V2024AccountUnlockRequest $AccountUnlockRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-V2024Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"[{op=remove, path=/identityId}]"@ + + + # Update Account + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2024Account-V2024Id $Id -V2024RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024Account -V2024Id $Id -V2024RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Account" + Write-Host $_.ErrorDetails + } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-V2024UsagesByAccountId-V2024AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-V2024UsagesByAccountId -V2024AccountId $AccountId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesByAccountId" + Write-Host $_.ErrorDetails + } +- path: /discovered-applications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) + $Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) + + # Get Discovered Applications for Tenant + + try { + Get-V2024DiscoveredApplications + + # Below is a request that includes all optional parameters + # Get-V2024DiscoveredApplications -V2024Limit $Limit -V2024Offset $Offset -V2024Detail $Detail -V2024Filter $Filter -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DiscoveredApplications" + Write-Host $_.ErrorDetails + } +- path: /manual-discover-applications-template + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Download CSV Template for Discovery + + try { + Get-V2024ManualDiscoverApplicationsCsvTemplate + + # Below is a request that includes all optional parameters + # Get-V2024ManualDiscoverApplicationsCsvTemplate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } +- path: /manual-discover-applications + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + + # Upload CSV to Discover Applications + + try { + Send-V2024ManualDiscoverApplicationsCsvTemplate-V2024File $File + + # Below is a request that includes all optional parameters + # Send-V2024ManualDiscoverApplicationsCsvTemplate -V2024File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } +- path: /generic-approvals/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that is to be returned + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get an approval + + try { + Get-V2024Approval-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Approval -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Approval" + Write-Host $_.ErrorDetails + } +- path: /generic-approvals + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Mine = $true # Boolean | Returns the list of approvals for the current caller (optional) + $RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID (optional) + $Filters = "filters=status eq PENDING" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* (optional) + + # Get Approvals + + try { + Get-V2024Approvals-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Approvals -V2024XSailPointExperimental $XSailPointExperimental -V2024Mine $Mine -V2024RequesterId $RequesterId -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Approvals" + Write-Host $_.ErrorDetails + } +- path: /source-apps + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceAppCreateDto = @" + { + "name" : "my app", + "description" : "the source app for engineers", + "accountSource" : { + "name" : "ODS-AD-Source", + "id" : "2c9180827ca885d7017ca8ce28a000eb", + "type" : "SOURCE" + }, + "matchAllAccounts" : true + } + "@ + + # Create source app + + try { + $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto + New-V2024SourceApp-V2024XSailPointExperimental $XSailPointExperimental -V2024SourceAppCreateDto $Result + + # Below is a request that includes all optional parameters + # New-V2024SourceApp -V2024XSailPointExperimental $XSailPointExperimental -V2024SourceAppCreateDto $SourceAppCreateDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id}/access-profiles/bulk-remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @"[c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9]"@ + + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + + # Bulk remove access profiles from the specified source app + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-V2024AccessProfilesFromSourceAppByBulk-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-V2024AccessProfilesFromSourceAppByBulk -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $RequestBody -V2024Limit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfilesFromSourceAppByBulk" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete source app by ID + + try { + Remove-V2024SourceApp-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024SourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get source app by ID + + try { + Get-V2024SourceApp-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id}/access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "name eq "developer access profile"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + # List access profiles for the specified source app + + try { + Get-V2024AccessProfilesForSourceApp-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessProfilesForSourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfilesForSourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/all + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) + $Filters = "enabled eq true" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) + + # List all source apps + + try { + Get-V2024AllSourceApp-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AllSourceApp -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllSourceApp" + Write-Host $_.ErrorDetails + } +- path: /user-apps/all + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List all user apps + + try { + Get-V2024AllUserApps-V2024Filters $Filters -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AllUserApps -V2024Filters $Filters -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllUserApps" + Write-Host $_.ErrorDetails + } +- path: /source-apps/assigned + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (optional) + $Filters = "name eq "source app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + # List assigned source apps + + try { + Get-V2024AssignedSourceApp-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AssignedSourceApp -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AssignedSourceApp" + Write-Host $_.ErrorDetails + } +- path: /user-apps/{id}/available-accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List available accounts for user app + + try { + Get-V2024AvailableAccountsForUserApp-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AvailableAccountsForUserApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AvailableAccountsForUserApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) + $Filters = "name eq "source app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + # List available source apps + + try { + Get-V2024AvailableSourceApps-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AvailableSourceApps -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AvailableSourceApps" + Write-Host $_.ErrorDetails + } +- path: /user-apps + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) + + # List owned user apps + + try { + Get-V2024OwnedUserApps-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024OwnedUserApps -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OwnedUserApps" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app to patch + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch source app by ID + + try { + Update-V2024SourceApp-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024SourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceApp" + Write-Host $_.ErrorDetails + } +- path: /user-apps/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app to patch + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch user app by ID + + try { + Update-V2024UserApp-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024UserApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024UserApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceAppBulkUpdateRequest = @" + { + "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : false + }, { + "op" : "replace", + "path" : "/matchAllAccounts", + "value" : false + } ] + } + "@ + + # Bulk update source apps + + try { + Update-V2024SourceAppsInBulk-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024SourceAppsInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024SourceAppBulkUpdateRequest $SourceAppBulkUpdateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceAppsInBulk" + Write-Host $_.ErrorDetails + } +- path: /auth-profiles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. + + # Get Auth Profile. + + try { + Get-V2024ProfileConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ProfileConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProfileConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get list of Auth Profiles. + + try { + Get-V2024ProfileConfigList-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ProfileConfigList -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProfileConfigList" + Write-Host $_.ErrorDetails + } +- path: /auth-profiles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Auth Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ProfileConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ProfileConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProfileConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-users/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + + # Auth User Details + + try { + Get-V2024AuthUser-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AuthUser -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthUser" + Write-Host $_.ErrorDetails + } +- path: /auth-users/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Auth User Update + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthUser-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthUser -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthUser" + Write-Host $_.ErrorDetails + } +- path: /brandings + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "MyName" # String | name of branding item + $ProductName = "MyProductName" # String | product name + $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) + $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) + $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) + $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) + $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) + $FileStandard = # System.IO.FileInfo | png file with logo (optional) + + # Create a branding item + + try { + New-V2024BrandingItem-V2024Name $Name -V2024ProductName $ProductName + + # Below is a request that includes all optional parameters + # New-V2024BrandingItem -V2024Name $Name -V2024ProductName $ProductName -V2024ActionButtonColor $ActionButtonColor -V2024ActiveLinkColor $ActiveLinkColor -V2024NavigationColor $NavigationColor -V2024EmailFromAddress $EmailFromAddress -V2024LoginInformationalMessage $LoginInformationalMessage -V2024FileStandard $FileStandard + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024BrandingItem" + Write-Host $_.ErrorDetails + } +- path: /brandings/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "default" # String | The name of the branding item to be deleted + + # Delete a branding item + + try { + Remove-V2024Branding-V2024Name $Name + + # Below is a request that includes all optional parameters + # Remove-V2024Branding -V2024Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Branding" + Write-Host $_.ErrorDetails + } +- path: /brandings/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "default" # String | The name of the branding item to be retrieved + + # Get a branding item + + try { + Get-V2024Branding-V2024Name $Name + + # Below is a request that includes all optional parameters + # Get-V2024Branding -V2024Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Branding" + Write-Host $_.ErrorDetails + } +- path: /brandings + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List of branding items + + try { + Get-V2024BrandingList + + # Below is a request that includes all optional parameters + # Get-V2024BrandingList + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BrandingList" + Write-Host $_.ErrorDetails + } +- path: /brandings/{name} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "default" # String | The name of the branding item to be retrieved + $Name2 = "Name_example" # String | name of branding item + $ProductName = "MyProductName" # String | product name + $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) + $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) + $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) + $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) + $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) + $FileStandard = # System.IO.FileInfo | png file with logo (optional) + + # Update a branding item + + try { + Set-V2024BrandingItem-V2024Name $Name -V2024Name2 $Name2 -V2024ProductName $ProductName + + # Below is a request that includes all optional parameters + # Set-V2024BrandingItem -V2024Name $Name -V2024Name2 $Name2 -V2024ProductName $ProductName -V2024ActionButtonColor $ActionButtonColor -V2024ActiveLinkColor $ActiveLinkColor -V2024NavigationColor $NavigationColor -V2024EmailFromAddress $EmailFromAddress -V2024LoginInformationalMessage $LoginInformationalMessage -V2024FileStandard $FileStandard + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024BrandingItem" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CampaignFilterDetails = @" + { + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + } + "@ + + # Create Campaign Filter + + try { + $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails + New-V2024CampaignFilter-V2024CampaignFilterDetails $Result + + # Below is a request that includes all optional parameters + # New-V2024CampaignFilter -V2024CampaignFilterDetails $CampaignFilterDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CampaignFilter" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters/delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filters to delete. + $RequestBody = @""@ + + + # Deletes Campaign Filters + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-V2024CampaignFilters-V2024RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-V2024CampaignFilters -V2024RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignFilters" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved. + + # Get Campaign Filter by ID + + try { + Get-V2024CampaignFilterById-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CampaignFilterById -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignFilterById" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Start = 0 # Int32 | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $IncludeSystemFilters = $true # Boolean | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to $true) + + # List Campaign Filters + + try { + Get-V2024CampaignFilters + + # Below is a request that includes all optional parameters + # Get-V2024CampaignFilters -V2024Limit $Limit -V2024Start $Start -V2024IncludeSystemFilters $IncludeSystemFilters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignFilters" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FilterId = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter being modified. + $CampaignFilterDetails = @" + { + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + } + "@ + + # Updates a Campaign Filter + + try { + $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails + Update-V2024CampaignFilter-V2024FilterId $FilterId -V2024CampaignFilterDetails $Result + + # Below is a request that includes all optional parameters + # Update-V2024CampaignFilter -V2024FilterId $FilterId -V2024CampaignFilterDetails $CampaignFilterDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CampaignFilter" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/complete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $CampaignCompleteOptions = @" + { + "autoCompleteAction" : "REVOKE" + } + "@ + + # Complete a Campaign + + try { + Complete-V2024Campaign-V2024Id $Id + + # Below is a request that includes all optional parameters + # Complete-V2024Campaign -V2024Id $Id -V2024CampaignCompleteOptions $CampaignCompleteOptions + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Campaign = @" + { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + } + "@ + + # Create a campaign + + try { + $Result = ConvertFrom-JsonToCampaign -Json $Campaign + New-V2024Campaign-V2024Campaign $Result + + # Below is a request that includes all optional parameters + # New-V2024Campaign -V2024Campaign $Campaign + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CampaignTemplate = @" + { + "ownerRef" : { + "name" : "Mister Manager", + "id" : "2c918086676d3e0601677611dbde220f", + "type" : "IDENTITY", + "email" : "mr.manager@example.com" + }, + "deadlineDuration" : "P2W", + "created" : "2020-03-05T22:44:00.364Z", + "scheduled" : false, + "name" : "Manager Campaign Template", + "description" : "Template for the annual manager campaign.", + "modified" : "2020-03-05T22:52:09.969Z", + "campaign" : { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }, + "id" : "2c9079b270a266a60170a277bb960008" + } + "@ + + # Create a Campaign Template + + try { + $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate + New-V2024CampaignTemplate-V2024CampaignTemplate $Result + + # Below is a request that includes all optional parameters + # New-V2024CampaignTemplate -V2024CampaignTemplate $CampaignTemplate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. + + # Delete a Campaign Template + + try { + Remove-V2024CampaignTemplate-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024CampaignTemplate -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. + + # Delete Campaign Template Schedule + + try { + Remove-V2024CampaignTemplateSchedule-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024CampaignTemplateSchedule -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaigns/delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CampaignsDeleteRequest = @" + { + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + } + "@ + + # Delete Campaigns + + try { + $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest + Remove-V2024Campaigns-V2024CampaignsDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024Campaigns -V2024CampaignsDeleteRequest $CampaignsDeleteRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Campaigns" + Write-Host $_.ErrorDetails + } +- path: /campaigns + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Manager Campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) + + # List Campaigns + + try { + Get-V2024ActiveCampaigns + + # Below is a request that includes all optional parameters + # Get-V2024ActiveCampaigns -V2024Detail $Detail -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ActiveCampaigns" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + + # Get Campaign + + try { + Get-V2024Campaign-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Campaign -V2024Id $Id -V2024Detail $Detail + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/reports + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. + + # Get Campaign Reports + + try { + Get-V2024CampaignReports-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CampaignReports -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignReports" + Write-Host $_.ErrorDetails + } +- path: /campaigns/reports-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Campaign Reports Configuration + + try { + Get-V2024CampaignReportsConfig + + # Below is a request that includes all optional parameters + # Get-V2024CampaignReportsConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignReportsConfig" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. + + # Get a Campaign Template + + try { + Get-V2024CampaignTemplate-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CampaignTemplate -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. + + # Get Campaign Template Schedule + + try { + Get-V2024CampaignTemplateSchedule-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CampaignTemplateSchedule -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $Filters = "name eq "manager template"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + + # List Campaign Templates + + try { + Get-V2024CampaignTemplates + + # Below is a request that includes all optional parameters + # Get-V2024CampaignTemplates -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplates" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/reassign + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID + $AdminReviewReassign = @" + { + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } + } + "@ + + # Reassign Certifications + + try { + $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign + Move-V2024-V2024Id $Id -V2024AdminReviewReassign $Result + + # Below is a request that includes all optional parameters + # Move-V2024 -V2024Id $Id -V2024AdminReviewReassign $AdminReviewReassign + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-V2024" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update a Campaign Template + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024CampaignTemplate-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024CampaignTemplate -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaigns/reports-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CampaignReportsConfig = @" + { + "identityAttributeColumns" : [ "firstname", "lastname" ] + } + "@ + + # Set Campaign Reports Configuration + + try { + $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig + Set-V2024CampaignReportsConfig-V2024CampaignReportsConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024CampaignReportsConfig -V2024CampaignReportsConfig $CampaignReportsConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024CampaignReportsConfig" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template being scheduled. + $Schedule = @" + { + "hours" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "months" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "timeZoneId" : "CST", + "days" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "expiration" : "2000-01-23T04:56:07.000+00:00", + "type" : "WEEKLY" + } + "@ + + # Set Campaign Template Schedule + + try { + Set-V2024CampaignTemplateSchedule-V2024Id $Id + + # Below is a request that includes all optional parameters + # Set-V2024CampaignTemplateSchedule -V2024Id $Id -V2024Schedule $Schedule + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/activate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $ActivateCampaignOptions = @" + { + "timeZone" : "-05:00" + } + "@ + + # Activate a Campaign + + try { + Start-V2024Campaign-V2024Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024Campaign -V2024Id $Id -V2024ActivateCampaignOptions $ActivateCampaignOptions + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/run-remediation-scan + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. + + # Run Campaign Remediation Scan + + try { + Start-V2024CampaignRemediationScan-V2024Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024CampaignRemediationScan -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024CampaignRemediationScan" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/run-report/{type} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. + $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run. + + # Run Campaign Report + + try { + Start-V2024CampaignReport-V2024Id $Id -V2024Type $Type + + # Below is a request that includes all optional parameters + # Start-V2024CampaignReport -V2024Id $Id -V2024Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024CampaignReport" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/generate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. + + # Generate a Campaign from Template + + try { + Start-V2024GenerateCampaignTemplate-V2024Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024GenerateCampaignTemplate -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024GenerateCampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update a Campaign + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Campaign-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Campaign -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Campaign" + Write-Host $_.ErrorDetails + } +- path: /certification-tasks/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID + + # Certification Task by ID + + try { + Get-V2024CertificationTask-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CertificationTask -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CertificationTask" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id + + # Identity Certification by ID + + try { + Get-V2024IdentityCertification-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentityCertification -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertification" + Write-Host $_.ErrorDetails + } +- path: /certifications/{certificationId}/access-review-items/{itemId}/permissions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID + $Filters = "target eq "SYS.OBJAUTH2"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Permissions for Entitlement Certification Item + + try { + Get-V2024IdentityCertificationItemPermissions-V2024CertificationId $CertificationId -V2024ItemId $ItemId + + # Below is a request that includes all optional parameters + # Get-V2024IdentityCertificationItemPermissions -V2024CertificationId $CertificationId -V2024ItemId $ItemId -V2024Filters $Filters -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertificationItemPermissions" + Write-Host $_.ErrorDetails + } +- path: /certification-tasks + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReviewerIdentity = "Ada.1de82e55078344" # String | The ID of reviewer identity. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "type eq "ADMIN_REASSIGN"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) + + # List of Pending Certification Tasks + + try { + Get-V2024PendingCertificationTasks + + # Below is a request that includes all optional parameters + # Get-V2024PendingCertificationTasks -V2024ReviewerIdentity $ReviewerIdentity -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingCertificationTasks" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reviewers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) + + # List of Reviewers for certification + + try { + Get-V2024CertificationReviewers-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CertificationReviewers -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CertificationReviewers" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/access-review-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name,-accessProfile.sourceName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) + $Entitlements = "identityEntitlement" # String | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) + $AccessProfiles = "accessProfile1" # String | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) + $Roles = "userRole" # String | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) + + # List of Access Review Items + + try { + Get-V2024IdentityAccessReviewItems-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAccessReviewItems -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters -V2024Entitlements $Entitlements -V2024AccessProfiles $AccessProfiles -V2024Roles $Roles + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessReviewItems" + Write-Host $_.ErrorDetails + } +- path: /certifications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReviewerIdentity = "me" # String | Reviewer's identity. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) + $Sorters = "name,due" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) + + # List Identity Campaign Certifications + + try { + Get-V2024IdentityCertifications + + # Below is a request that includes all optional parameters + # Get-V2024IdentityCertifications -V2024ReviewerIdentity $ReviewerIdentity -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertifications" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decide + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campaign certification on which to make decisions + $ReviewDecision = @"{ + "comments" : "This user no longer needs access to this source", + "decision" : "APPROVE", + "proposedEndDate" : "2017-07-11T18:45:37.098Z", + "recommendation" : { + "reasons" : [ "Reason 1", "Reason 2" ], + "recommendation" : "recommendation", + "timestamp" : "2020-06-01T13:49:37.385Z" + }, + "id" : "ef38f94347e94562b5bb8424a56397d8", + "bulk" : true + }"@ + + + # Decide on a Certification Item + + try { + $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision + Select-V2024IdentityDecision-V2024Id $Id -V2024ReviewDecision $Result + + # Below is a request that includes all optional parameters + # Select-V2024IdentityDecision -V2024Id $Id -V2024ReviewDecision $ReviewDecision + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-V2024IdentityDecision" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reassign + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $ReviewReassign = @" + { + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + } + "@ + + # Reassign Identities or Items + + try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Invoke-V2024ReassignIdentityCertifications-V2024Id $Id -V2024ReviewReassign $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024ReassignIdentityCertifications -V2024Id $Id -V2024ReviewReassign $ReviewReassign + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ReassignIdentityCertifications" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/sign-off + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + + # Finalize Identity Certification Decisions + + try { + Invoke-V2024SignOffIdentityCertification-V2024Id $Id + + # Below is a request that includes all optional parameters + # Invoke-V2024SignOffIdentityCertification -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024SignOffIdentityCertification" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reassign-async + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $ReviewReassign = @" + { + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + } + "@ + + # Reassign Certifications Asynchronously + + try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Submit-V2024ReassignCertsAsync-V2024Id $Id -V2024ReviewReassign $Result + + # Below is a request that includes all optional parameters + # Submit-V2024ReassignCertsAsync -V2024Id $Id -V2024ReviewReassign $ReviewReassign + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReassignCertsAsync" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + + # Access Summaries + + try { + Get-V2024IdentityAccessSummaries-V2024Id $Id -V2024Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAccessSummaries -V2024Id $Id -V2024Type $Type -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-V2024IdentityDecisionSummary-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentityDecisionSummary -V2024Id $Id -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Identity Summaries for Campaign Certification + + try { + Get-V2024IdentitySummaries-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySummaries -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-V2024IdentitySummary-V2024Id $Id -V2024IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySummary -V2024Id $Id -V2024IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummary" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/deploys + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $DeployRequest = @" + { + "draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" + } + "@ + + # Create a Deploy + + try { + $Result = ConvertFrom-JsonToDeployRequest -Json $DeployRequest + New-V2024Deploy-V2024DeployRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024Deploy -V2024DeployRequest $DeployRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Deploy" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingRequest = @" + { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } + "@ + + # Creates an object mapping + + try { + $Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest + New-V2024ObjectMapping-V2024SourceOrg $SourceOrg -V2024ObjectMappingRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ObjectMapping -V2024SourceOrg $SourceOrg -V2024ObjectMappingRequest $ObjectMappingRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMapping" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-create + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingBulkCreateRequest = @" + { + "newObjectsMappings" : [ { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + }, { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } ] + } + "@ + + # Bulk creates object mappings + + try { + $Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest + New-V2024ObjectMappings-V2024SourceOrg $SourceOrg -V2024ObjectMappingBulkCreateRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ObjectMappings -V2024SourceOrg $SourceOrg -V2024ObjectMappingBulkCreateRequest $ObjectMappingBulkCreateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMappings" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Name = "MyName" # String | Name that will be assigned to the uploaded configuration file. + + # Upload a Configuration + + try { + New-V2024UploadedConfiguration-V2024Data $Data -V2024Name $Name + + # Below is a request that includes all optional parameters + # New-V2024UploadedConfiguration -V2024Data $Data -V2024Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024UploadedConfiguration" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the backup to delete. + + # Delete a Backup + + try { + Remove-V2024Backup-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Backup -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Backup" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/drafts/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the draft to delete. + + # Delete a draft + + try { + Remove-V2024Draft-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Draft -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Draft" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of the object mapping to be deleted. + + # Deletes an object mapping + + try { + Remove-V2024ObjectMapping-V2024SourceOrg $SourceOrg -V2024ObjectMappingId $ObjectMappingId + + # Below is a request that includes all optional parameters + # Remove-V2024ObjectMapping -V2024SourceOrg $SourceOrg -V2024ObjectMappingId $ObjectMappingId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ObjectMapping" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. + + # Delete an Uploaded Configuration + + try { + Remove-V2024UploadedConfiguration-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024UploadedConfiguration -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024UploadedConfiguration" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/deploys/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the deploy. + + # Get a Deploy + + try { + Get-V2024Deploy-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Deploy -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Deploy" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceOrg = "source-org" # String | The name of the source org. + + # Gets list of object mappings + + try { + Get-V2024ObjectMappings-V2024SourceOrg $SourceOrg + + # Below is a request that includes all optional parameters + # Get-V2024ObjectMappings -V2024SourceOrg $SourceOrg + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ObjectMappings" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. + + # Get an Uploaded Configuration + + try { + Get-V2024UploadedConfiguration-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024UploadedConfiguration -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UploadedConfiguration" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) + + # List Backups + + try { + Get-V2024Backups + + # Below is a request that includes all optional parameters + # Get-V2024Backups -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Backups" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/deploys + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Deploys + + try { + Get-V2024Deploys + + # Below is a request that includes all optional parameters + # Get-V2024Deploys + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Deploys" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/drafts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* (optional) + + # List Drafts + + try { + Get-V2024Drafts + + # Below is a request that includes all optional parameters + # Get-V2024Drafts -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Drafts" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) + + # List Uploaded Configurations + + try { + Get-V2024UploadedConfigurations + + # Below is a request that includes all optional parameters + # Get-V2024UploadedConfigurations -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UploadedConfigurations" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingBulkPatchRequest = @" + { + "patches" : { + "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : true + } ], + "00bece34-f50d-4227-8878-76f620b5a971" : [ { + "op" : "replace", + "path" : "/targetValue", + "value" : "New Target Value" + } ] + } + } + "@ + + # Bulk updates object mappings + + try { + $Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest + Update-V2024ObjectMappings-V2024SourceOrg $SourceOrg -V2024ObjectMappingBulkPatchRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024ObjectMappings -V2024SourceOrg $SourceOrg -V2024ObjectMappingBulkPatchRequest $ObjectMappingBulkPatchRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ObjectMappings" + Write-Host $_.ErrorDetails + } +- path: /connector-rules + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ConnectorRuleCreateRequest = @" + { + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "type" : "BuildMap" + } + "@ + + # Create Connector Rule + + try { + $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest + New-V2024ConnectorRule-V2024XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleCreateRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ConnectorRule -V2024XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleCreateRequest $ConnectorRuleCreateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete Connector Rule + + try { + Remove-V2024ConnectorRule-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024ConnectorRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to get. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Connector Rule + + try { + Get-V2024ConnectorRule-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Connector Rules + + try { + Get-V2024ConnectorRuleList-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorRuleList -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorRuleList" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to update. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ConnectorRuleUpdateRequest = @" + { + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", + "type" : "BuildMap" + } + "@ + + # Update Connector Rule + + try { + Send-V2024ConnectorRule-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleUpdateRequest $ConnectorRuleUpdateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/validate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceCode = @" + { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + } + "@ + + # Validate Connector Rule + + try { + $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode + Test-V2024ConnectorRule-V2024XSailPointExperimental $XSailPointExperimental -V2024SourceCode $Result + + # Below is a request that includes all optional parameters + # Test-V2024ConnectorRule -V2024XSailPointExperimental $XSailPointExperimental -V2024SourceCode $SourceCode + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connectors + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $V3CreateConnectorDto = @" + { + "name" : "custom connector", + "directConnect" : true, + "className" : "sailpoint.connector.OpenConnectorAdapter", + "type" : "custom connector type", + "status" : "RELEASED" + } + "@ + + # Create Custom Connector + + try { + $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto + New-V2024CustomConnector-V2024V3CreateConnectorDto $Result + + # Below is a request that includes all optional parameters + # New-V2024CustomConnector -V2024V3CreateConnectorDto $V3CreateConnectorDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CustomConnector" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + # Delete Connector by Script Name + + try { + Remove-V2024CustomConnector-V2024ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Remove-V2024CustomConnector -V2024ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CustomConnector" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Get Connector by Script Name + + try { + Get-V2024Connector-V2024ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024Connector -V2024ScriptName $ScriptName -V2024Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Connector" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/correlation-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + + # Get Connector Correlation Configuration + + try { + Get-V2024ConnectorCorrelationConfig-V2024ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorCorrelationConfig -V2024ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorCorrelationConfig" + Write-Host $_.ErrorDetails + } +- path: /connectors + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "directConnect eq "true"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Get Connector List + + try { + Get-V2024ConnectorList + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorList -V2024Filters $Filters -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorList" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + # Get Connector Source Configuration + + try { + Get-V2024ConnectorSourceConfig-V2024ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorSourceConfig -V2024ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorSourceConfig" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-template + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + # Get Connector Source Template + + try { + Get-V2024ConnectorSourceTemplate-V2024ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorSourceTemplate -V2024ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorSourceTemplate" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/translations/{locale} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + + # Get Connector Translations + + try { + Get-V2024ConnectorTranslations-V2024ScriptName $ScriptName -V2024Locale $Locale + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorTranslations -V2024ScriptName $ScriptName -V2024Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorTranslations" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/correlation-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + $File = # System.IO.FileInfo | connector correlation config xml file + + # Update Connector Correlation Configuration + + try { + Send-V2024ConnectorCorrelationConfig-V2024ScriptName $ScriptName -V2024File $File + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorCorrelationConfig -V2024ScriptName $ScriptName -V2024File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorCorrelationConfig" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $File = # System.IO.FileInfo | connector source config xml file + + # Update Connector Source Configuration + + try { + Send-V2024ConnectorSourceConfig-V2024ScriptName $ScriptName -V2024File $File + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorSourceConfig -V2024ScriptName $ScriptName -V2024File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorSourceConfig" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-template + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $File = # System.IO.FileInfo | connector source template xml file + + # Update Connector Source Template + + try { + Send-V2024ConnectorSourceTemplate-V2024ScriptName $ScriptName -V2024File $File + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorSourceTemplate -V2024ScriptName $ScriptName -V2024File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorSourceTemplate" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/translations/{locale} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + + # Update Connector Translations + + try { + Send-V2024ConnectorTranslations-V2024ScriptName $ScriptName -V2024Locale $Locale + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorTranslations -V2024ScriptName $ScriptName -V2024Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorTranslations" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Connector by Script Name + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Connector-V2024ScriptName $ScriptName -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Connector -V2024ScriptName $ScriptName -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Connector" + Write-Host $_.ErrorDetails + } +- path: /form-definitions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Body = @" + { + "owner" : { + "name" : "Grant Smith", + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "formConditions" : [ { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + }, { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + } ], + "formInput" : [ { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + }, { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + } ], + "name" : "My form", + "description" : "My form description", + "usedBy" : [ { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + }, { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + } ], + "formElements" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + } ] + } + "@ + + # Creates a form definition. + + try { + New-V2024FormDefinition-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2024FormDefinition -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinition" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/forms-action-dynamic-schema + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Body = @" + { + "description" : "A description", + "attributes" : { + "formDefinitionId" : "00000000-0000-0000-0000-000000000000" + }, + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "action", + "versionNumber" : 1 + } + "@ + + # Generate JSON Schema dynamically. + + try { + New-V2024FormDefinitionDynamicSchema-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2024FormDefinitionDynamicSchema -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionDynamicSchema" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID}/upload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $File = # System.IO.FileInfo | File specifying the multipart + + # Upload new form definition file. + + try { + New-V2024FormDefinitionFileRequest-V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024File $File + + # Below is a request that includes all optional parameters + # New-V2024FormDefinitionFileRequest -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionFileRequest" + Write-Host $_.ErrorDetails + } +- path: /form-instances + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Body = @" + { + "formInput" : { + "input1" : "Sales" + }, + "standAloneForm" : false, + "createdBy" : { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "WORKFLOW_EXECUTION" + }, + "recipients" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + } ], + "expire" : "2023-08-12T20:14:57.74486Z", + "formDefinitionId" : "00000000-0000-0000-0000-000000000000", + "state" : "ASSIGNED", + "ttl" : 1571827560 + } + "@ + + # Creates a form instance. + + try { + New-V2024FormInstance-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2024FormInstance -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormInstance" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Deletes a form definition. + + try { + Remove-V2024FormDefinition-V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024FormDefinition -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024FormDefinition" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + $Filters = "name sw "my form"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") + + # List form definitions by tenant. + + try { + Export-V2024FormDefinitionsByTenant-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2024FormDefinitionsByTenant -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024FormDefinitionsByTenant" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID}/file/{fileID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID Form definition ID + $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Download definition file by fileId. + + try { + Get-V2024FileFromS3-V2024FormDefinitionID $FormDefinitionID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024FileFromS3 -V2024FormDefinitionID $FormDefinitionID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FileFromS3" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Return a form definition. + + try { + Get-V2024FormDefinitionByKey-V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024FormDefinitionByKey -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormDefinitionByKey" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Returns a form instance. + + try { + Get-V2024FormInstanceByKey-V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024FormInstanceByKey -V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceByKey" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID}/file/{fileID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | FormInstanceID Form instance ID + $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Download instance file by fileId. + + try { + Get-V2024FormInstanceFile-V2024FormInstanceID $FormInstanceID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024FormInstanceFile -V2024FormInstanceID $FormInstanceID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceFile" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + + + + + + $Body = @"[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]"@ + + + # Import form definitions from export. + + try { + Import-V2024FormDefinitions-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Import-V2024FormDefinitions -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024FormDefinitions" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) + $Body = @"[{op=replace, path=/description, value=test-description}]"@ + + + # Patch a form definition. + + try { + Update-V2024FormDefinition-V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024FormDefinition -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormDefinition" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) + $Body = @"[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]"@ + + + # Patch a form instance. + + try { + Update-V2024FormInstance-V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024FormInstance -V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormInstance" + Write-Host $_.ErrorDetails + } +- path: /form-definitions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 250 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + $Filters = "name sw "my form"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") + + # Export form definitions by tenant. + + try { + Search-V2024FormDefinitionsByTenant-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Search-V2024FormDefinitionsByTenant -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormDefinitionsByTenant" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID}/data-source/{formElementID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID + $FormElementID = "1" # String | Form element ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + $Filters = "value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) + $Query = "support" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) + + # Retrieves dynamic data by element. + + try { + Search-V2024FormElementDataByElementID-V2024FormInstanceID $FormInstanceID -V2024FormElementID $FormElementID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Search-V2024FormElementDataByElementID -V2024FormInstanceID $FormInstanceID -V2024FormElementID $FormElementID -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Filters $Filters -V2024Query $Query + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormElementDataByElementID" + Write-Host $_.ErrorDetails + } +- path: /form-instances + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List form instances by tenant. + + try { + Search-V2024FormInstancesByTenant-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Search-V2024FormInstancesByTenant -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormInstancesByTenant" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/predefined-select-options + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List predefined select options. + + try { + Search-V2024PreDefinedSelectOptions-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Search-V2024PreDefinedSelectOptions -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PreDefinedSelectOptions" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID}/data-source + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 10 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) + $Filters = "value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) + $Query = "ac" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) + $FormElementPreviewRequest = @" + { + "dataSource" : { + "config" : { + "indices" : [ "identities" ], + "query" : "*", + "aggregationBucketField" : "attributes.cloudStatus.exact", + "objectType" : "IDENTITY" + }, + "dataSourceType" : "STATIC" + } + } + "@ + + # Preview form definition data source. + + try { + Show-V2024PreviewDataSource-V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Show-V2024PreviewDataSource -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Filters $Filters -V2024Query $Query -V2024FormElementPreviewRequest $FormElementPreviewRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024PreviewDataSource" + Write-Host $_.ErrorDetails + } +- path: /custom-password-instructions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CustomPasswordInstruction = @" + { + "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", + "pageId" : "change-password:enter-password", + "locale" : "en" + } + "@ + + # Create Custom Password Instructions + + try { + $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction + New-V2024CustomPasswordInstructions-V2024XSailPointExperimental $XSailPointExperimental -V2024CustomPasswordInstruction $Result + + # Below is a request that includes all optional parameters + # New-V2024CustomPasswordInstructions -V2024XSailPointExperimental $XSailPointExperimental -V2024CustomPasswordInstruction $CustomPasswordInstruction + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CustomPasswordInstructions" + Write-Host $_.ErrorDetails + } +- path: /custom-password-instructions/{pageId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to delete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) + + # Delete Custom Password Instructions by page ID + + try { + Remove-V2024CustomPasswordInstructions-V2024PageId $PageId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024CustomPasswordInstructions -V2024PageId $PageId -V2024XSailPointExperimental $XSailPointExperimental -V2024Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CustomPasswordInstructions" + Write-Host $_.ErrorDetails + } +- path: /custom-password-instructions/{pageId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to query. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) + + # Get Custom Password Instructions by Page ID + + try { + Get-V2024CustomPasswordInstructions-V2024PageId $PageId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024CustomPasswordInstructions -V2024PageId $PageId -V2024XSailPointExperimental $XSailPointExperimental -V2024Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomPasswordInstructions" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $Dimension = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "name" : "Dimension 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "id" : "2c918086749d78830174a1a40e121518", + "membership" : { + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, + "type" : "STANDARD" + }, + "parentId" : "2c918086749d78830174a1a40e121518" + } + "@ + + # Create a Dimension + + try { + $Result = ConvertFrom-JsonToDimension -Json $Dimension + New-V2024Dimension-V2024RoleId $RoleId -V2024Dimension $Result + + # Below is a request that includes all optional parameters + # New-V2024Dimension -V2024RoleId $RoleId -V2024Dimension $Dimension + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Dimension" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimensions. + $DimensionBulkDeleteRequest = @" + { + "dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } + "@ + + # Delete Dimension(s) + + try { + $Result = ConvertFrom-JsonToDimensionBulkDeleteRequest -Json $DimensionBulkDeleteRequest + Remove-V2024BulkDimensions-V2024RoleId $RoleId -V2024DimensionBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024BulkDimensions -V2024RoleId $RoleId -V2024DimensionBulkDeleteRequest $DimensionBulkDeleteRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024BulkDimensions" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions/{dimensionId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + + # Delete a Dimension + + try { + Remove-V2024Dimension-V2024RoleId $RoleId -V2024DimensionId $DimensionId + + # Below is a request that includes all optional parameters + # Remove-V2024Dimension -V2024RoleId $RoleId -V2024DimensionId $DimensionId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Dimension" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions/{dimensionId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + + # Get a Dimension under Role. + + try { + Get-V2024Dimension-V2024RoleId $RoleId -V2024DimensionId $DimensionId + + # Below is a request that includes all optional parameters + # Get-V2024Dimension -V2024RoleId $RoleId -V2024DimensionId $DimensionId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Dimension" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions/{dimensionId}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + + # List Dimension's Entitlements + + try { + Get-V2024DimensionEntitlements-V2024RoleId $RoleId -V2024DimensionId $DimensionId + + # Below is a request that includes all optional parameters + # Get-V2024DimensionEntitlements -V2024RoleId $RoleId -V2024DimensionId $DimensionId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DimensionEntitlements" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions/{dimensionId}/access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | ID of the Dimension + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "source.id eq "2c91808982f979270182f99e386d00fa"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + + # List Dimension's Access Profiles + + try { + Get-V2024DimensionAccessProfiles-V2024RoleId $RoleId -V2024DimensionId $DimensionId + + # Below is a request that includes all optional parameters + # Get-V2024DimensionAccessProfiles -V2024RoleId $RoleId -V2024DimensionId $DimensionId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DimensionAccessProfiles" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq '2c918086749d78830174a1a40e121518'" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + + # List Dimensions + + try { + Get-V2024Dimensions-V2024RoleId $RoleId + + # Below is a request that includes all optional parameters + # Get-V2024Dimensions -V2024RoleId $RoleId -V2024ForSubadmin $ForSubadmin -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Dimensions" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions/{dimensionId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Dimension + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Dimension-V2024RoleId $RoleId -V2024DimensionId $DimensionId -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Dimension -V2024RoleId $RoleId -V2024DimensionId $DimensionId -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Dimension" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Add metadata to an entitlement. + + try { + New-V2024AccessModelMetadataForEntitlement-V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2024AccessModelMetadataForEntitlement -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessModelMetadataForEntitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Remove metadata from an entitlement. + + try { + Remove-V2024AccessModelMetadataFromEntitlement-V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024AccessModelMetadataFromEntitlement -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessModelMetadataFromEntitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get an entitlement + + try { + Get-V2024Entitlement-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Entitlement -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/entitlement-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Entitlement Request Config + + try { + Get-V2024EntitlementRequestConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementRequestConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /entitlements/aggregate/sources/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) + + # Aggregate Entitlements + + try { + Import-V2024EntitlementsBySource-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Import-V2024EntitlementsBySource -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024CsvFile $CsvFile + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024EntitlementsBySource" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/children + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + # List of entitlements children + + try { + Get-V2024EntitlementChildren-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementChildren -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChildren" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/parents + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + # List of entitlements parents + + try { + Get-V2024EntitlementParents-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementParents -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementParents" + Write-Host $_.ErrorDetails + } +- path: /entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) + $SegmentedForIdentity = "me" # String | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) + $ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) + $IncludeUnsegmented = $true # Boolean | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to $true) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) + + # Gets a list of entitlements. + + try { + Get-V2024Entitlements-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Entitlements -V2024XSailPointExperimental $XSailPointExperimental -V2024AccountId $AccountId -V2024SegmentedForIdentity $SegmentedForIdentity -V2024ForSegmentIds $ForSegmentIds -V2024IncludeUnsegmented $IncludeUnsegmented -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlements" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch an entitlement + + try { + Update-V2024Entitlement-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024Entitlement -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Entitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/entitlement-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $EntitlementRequestConfig = @" + { + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + } + "@ + + # Replace Entitlement Request Config + + try { + $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig + Send-V2024EntitlementRequestConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024EntitlementRequestConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024EntitlementRequestConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024EntitlementRequestConfig $EntitlementRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024EntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /entitlements/reset/sources/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Reset Source Entitlements + + try { + Reset-V2024SourceEntitlements-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Reset-V2024SourceEntitlements -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024SourceEntitlements" + Write-Host $_.ErrorDetails + } +- path: /entitlements/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $EntitlementBulkUpdateRequest = @" + { + "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/privileged", + "value" : false + }, { + "op" : "replace", + "path" : "/requestable", + "value" : false + } ] + } + "@ + + # Bulk update an entitlement list + + try { + $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest + Update-V2024EntitlementsInBulk-V2024XSailPointExperimental $XSailPointExperimental -V2024EntitlementBulkUpdateRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024EntitlementsInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024EntitlementBulkUpdateRequest $EntitlementBulkUpdateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsInBulk" + Write-Host $_.ErrorDetails + } +- path: /auth-org/network-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $NetworkConfiguration = @" + { + "range" : [ "1.3.7.2", "255.255.255.252/30" ], + "whitelisted" : true, + "geolocation" : [ "CA", "FR", "HT" ] + } + "@ + + # Create security network configuration. + + try { + $Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration + New-V2024AuthOrgNetworkConfig-V2024NetworkConfiguration $Result + + # Below is a request that includes all optional parameters + # New-V2024AuthOrgNetworkConfig -V2024NetworkConfiguration $NetworkConfiguration + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/network-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get security network configuration. + + try { + Get-V2024AuthOrgNetworkConfig + + # Below is a request that includes all optional parameters + # Get-V2024AuthOrgNetworkConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/network-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update security network configuration. + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthOrgNetworkConfig-V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthOrgNetworkConfig -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } +- path: /workgroups + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $WorkgroupDto = @" + { + "owner" : { + "emailAddress" : "support@sailpoint.com", + "displayName" : "Support", + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "connectionCount" : 1641498673000, + "created" : "2022-01-06T19:51:13Z", + "memberCount" : 1641498673000, + "name" : "DB Access Governance Group", + "description" : "Description of the Governance Group", + "modified" : "2022-01-06T19:51:13Z", + "id" : "2c91808568c529c60168cca6f90c1313" + } + "@ + + # Create a new Governance Group. + + try { + $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto + New-V2024Workgroup-V2024XSailPointExperimental $XSailPointExperimental -V2024WorkgroupDto $Result + + # Below is a request that includes all optional parameters + # New-V2024Workgroup -V2024XSailPointExperimental $XSailPointExperimental -V2024WorkgroupDto $WorkgroupDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete a Governance Group + + try { + Remove-V2024Workgroup-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/members/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityPreviewResponseIdentity = @""@ + + + # Remove members from Governance Group + + try { + $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity + Remove-V2024WorkgroupMembers-V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result + + # Below is a request that includes all optional parameters + # Remove-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $IdentityPreviewResponseIdentity + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupMembers" + Write-Host $_.ErrorDetails + } +- path: /workgroups/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $WorkgroupBulkDeleteRequest = @" + { + "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] + } + "@ + + # Delete Governance Group(s) + + try { + $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest + Remove-V2024WorkgroupsInBulk-V2024XSailPointExperimental $XSailPointExperimental -V2024WorkgroupBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024WorkgroupsInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024WorkgroupBulkDeleteRequest $WorkgroupBulkDeleteRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupsInBulk" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Governance Group by Id + + try { + Get-V2024Workgroup-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/connections + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + + # List connections for Governance Group + + try { + Get-V2024Connections-V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Connections -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Connections" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/members + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + + # List Governance Group Members + + try { + Get-V2024WorkgroupMembers-V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkgroupMembers" + Write-Host $_.ErrorDetails + } +- path: /workgroups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw "Test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional) + + # List Governance Groups + + try { + Get-V2024Workgroups-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Workgroups -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workgroups" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Governance Group + + try { + Update-V2024Workgroup-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/members/bulk-add + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityPreviewResponseIdentity = @""@ + + + # Add members to Governance Group + + try { + $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity + Update-V2024WorkgroupMembers-V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result + + # Below is a request that includes all optional parameters + # Update-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $IdentityPreviewResponseIdentity + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024WorkgroupMembers" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/ignored-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessRequestRecommendationActionItemDto = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Notification of Ignored Access Request Recommendations + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-V2024AccessRequestRecommendationsIgnoredItem-V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-V2024AccessRequestRecommendationsIgnoredItem -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsIgnoredItem" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/requested-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessRequestRecommendationActionItemDto = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Notification of Requested Access Request Recommendations + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-V2024AccessRequestRecommendationsRequestedItem-V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-V2024AccessRequestRecommendationsRequestedItem -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsRequestedItem" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/viewed-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessRequestRecommendationActionItemDto = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Notification of Viewed Access Request Recommendations + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-V2024AccessRequestRecommendationsViewedItem-V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-V2024AccessRequestRecommendationsViewedItem -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsViewedItem" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/viewed-items/bulk-create + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessRequestRecommendationActionItemDto = @"{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }"@ + + + # Notification of Viewed Access Request Recommendations in Bulk + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-V2024AccessRequestRecommendationsViewedItems-V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-V2024AccessRequestRecommendationsViewedItems -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsViewedItems" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityId = "2c91808570313110017040b06f344ec9" # String | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") + $Limit = 56 # Int32 | Max number of results to return. (optional) (default to 15) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $IncludeTranslationMessages = $false # Boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to $false) + $Filters = "access.name co "admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) + + # Identity Access Request Recommendations + + try { + Get-V2024AccessRequestRecommendations-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestRecommendations -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityId $IdentityId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024IncludeTranslationMessages $IncludeTranslationMessages -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendations" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/ignored-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "identityId eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + + # List of Ignored Access Request Recommendations + + try { + Get-V2024AccessRequestRecommendationsIgnoredItems-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestRecommendationsIgnoredItems -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsIgnoredItems" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/requested-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + + # List of Requested Access Request Recommendations + + try { + Get-V2024AccessRequestRecommendationsRequestedItems-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestRecommendationsRequestedItems -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsRequestedItems" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/viewed-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + + # List of Viewed Access Request Recommendations + + try { + Get-V2024AccessRequestRecommendationsViewedItems-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestRecommendationsViewedItems -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsViewedItems" + Write-Host $_.ErrorDetails + } +- path: /common-access + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CommonAccessItemRequest = @" + { + "access" : { + "ownerName" : "ownerName", + "name" : "name", + "description" : "description", + "id" : "id", + "type" : "ACCESS_PROFILE", + "ownerId" : "ownerId" + }, + "status" : "CONFIRMED" + } + "@ + + # Create common access items + + try { + $Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest + New-V2024CommonAccess-V2024XSailPointExperimental $XSailPointExperimental -V2024CommonAccessItemRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024CommonAccess -V2024XSailPointExperimental $XSailPointExperimental -V2024CommonAccessItemRequest $CommonAccessItemRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CommonAccess" + Write-Host $_.ErrorDetails + } +- path: /common-access + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.type eq "ROLE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) + + # Get a paginated list of common access + + try { + Get-V2024CommonAccess-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024CommonAccess -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CommonAccess" + Write-Host $_.ErrorDetails + } +- path: /common-access/update-status + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CommonAccessIDStatus = @"{ + "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], + "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] + }"@ + + + # Bulk update common access status + + try { + $Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus + Update-V2024CommonAccessStatusInBulk-V2024XSailPointExperimental $XSailPointExperimental -V2024CommonAccessIDStatus $Result + + # Below is a request that includes all optional parameters + # Update-V2024CommonAccessStatusInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024CommonAccessIDStatus $CommonAccessIDStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CommonAccessStatusInBulk" + Write-Host $_.ErrorDetails + } +- path: /outliers/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + + # IAI Identity Outliers Export + + try { + Export-V2024OutliersZip-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2024OutliersZip -V2024XSailPointExperimental $XSailPointExperimental -V2024Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024OutliersZip" + Write-Host $_.ErrorDetails + } +- path: /outlier-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + $Filters = "snapshotDate ge "2022-02-07T20:13:29.356648026Z"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* (optional) + $Sorters = "snapshotDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** (optional) + + # IAI Identity Outliers Summary + + try { + Get-V2024IdentityOutlierSnapshots-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityOutlierSnapshots -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Type $Type -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOutlierSnapshots" + Write-Host $_.ErrorDetails + } +- path: /outliers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + $Filters = "attributes.displayName sw "John" and certStatus eq "false"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) + $Sorters = "attributes.displayName,firstDetectionDate,-score" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** (optional) + + # IAI Get Identity Outliers + + try { + Get-V2024IdentityOutliers-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityOutliers -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Type $Type -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOutliers" + Write-Host $_.ErrorDetails + } +- path: /outlier-summaries/latest + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + + # IAI Identity Outliers Latest Summary + + try { + Get-V2024LatestIdentityOutlierSnapshots-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024LatestIdentityOutlierSnapshots -V2024XSailPointExperimental $XSailPointExperimental -V2024Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LatestIdentityOutlierSnapshots" + Write-Host $_.ErrorDetails + } +- path: /outlier-feature-summaries/{outlierFeatureId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OutlierFeatureId = "04654b66-7561-4090-94f9-abee0722a1af" # String | Contributing feature id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get identity outlier contibuting feature summary + + try { + Get-V2024OutlierContributingFeatureSummary-V2024OutlierFeatureId $OutlierFeatureId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024OutlierContributingFeatureSummary -V2024OutlierFeatureId $OutlierFeatureId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OutlierContributingFeatureSummary" + Write-Host $_.ErrorDetails + } +- path: /outliers/{outlierId}/contributing-features + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $IncludeTranslationMessages = "include-translation-messages=" # String | Whether or not to include translation messages object in returned response (optional) + $Sorters = "importance" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** (optional) + + # Get identity outlier's contibuting features + + try { + Get-V2024PeerGroupOutliersContributingFeatures-V2024OutlierId $OutlierId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PeerGroupOutliersContributingFeatures -V2024OutlierId $OutlierId -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024IncludeTranslationMessages $IncludeTranslationMessages -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PeerGroupOutliersContributingFeatures" + Write-Host $_.ErrorDetails + } +- path: /outliers/ignore + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ + + + # IAI Identity Outliers Ignore + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Invoke-V2024IgnoreIdentityOutliers-V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024IgnoreIdentityOutliers -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024IgnoreIdentityOutliers" + Write-Host $_.ErrorDetails + } +- path: /outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id + $ContributingFeatureName = "radical_entitlement_count" # String | The name of contributing feature + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $AccessType = "ENTITLEMENT" # String | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) + $Sorters = "displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) + + # Gets a list of access items associated with each identity outlier contributing feature + + try { + Get-V2024OutliersContributingFeatureAccessItems-V2024OutlierId $OutlierId -V2024ContributingFeatureName $ContributingFeatureName -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024OutliersContributingFeatureAccessItems -V2024OutlierId $OutlierId -V2024ContributingFeatureName $ContributingFeatureName -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024AccessType $AccessType -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OutliersContributingFeatureAccessItems" + Write-Host $_.ErrorDetails + } +- path: /outliers/unignore + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ + + + # IAI Identity Outliers Unignore + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Invoke-V2024UnIgnoreIdentityOutliers-V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024UnIgnoreIdentityOutliers -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnIgnoreIdentityOutliers" + Write-Host $_.ErrorDetails + } +- path: /peer-group-strategies/{strategy}/identity-outliers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Strategy = "entitlement" # String | The strategy used to create peer groups. Currently, 'entitlement' is supported. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Identity Outliers List + + try { + Get-V2024PeerGroupOutliers-V2024Strategy $Strategy -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PeerGroupOutliers -V2024Strategy $Strategy -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PeerGroupOutliers" + Write-Host $_.ErrorDetails + } +- path: /recommendations/request + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RecommendationRequestDto = @" + { + "prescribeMode" : false, + "excludeInterpretations" : false, + "requests" : [ { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + }, { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + } ], + "includeTranslationMessages" : false, + "includeDebugInformation" : true + } + "@ + + # Returns a Recommendation Based on Object + + try { + $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto + Get-V2024Recommendations-V2024XSailPointExperimental $XSailPointExperimental -V2024RecommendationRequestDto $Result + + # Below is a request that includes all optional parameters + # Get-V2024Recommendations -V2024XSailPointExperimental $XSailPointExperimental -V2024RecommendationRequestDto $RecommendationRequestDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Recommendations" + Write-Host $_.ErrorDetails + } +- path: /recommendations/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get certification recommendation config values + + try { + Get-V2024RecommendationsConfig-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RecommendationsConfig -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RecommendationsConfig" + Write-Host $_.ErrorDetails + } +- path: /recommendations/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RecommendationConfigDto = @" + { + "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], + "peerGroupPercentageThreshold" : 0.5, + "runAutoSelectOnce" : false, + "onlyTuneThreshold" : false + } + "@ + + # Update certification recommendation config values + + try { + $Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto + Update-V2024RecommendationsConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024RecommendationConfigDto $Result + + # Below is a request that includes all optional parameters + # Update-V2024RecommendationsConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024RecommendationConfigDto $RecommendationConfigDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RecommendationsConfig" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $MinEntitlementPopularity = 56 # Int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to $true) + $RoleMiningPotentialRoleProvisionRequest = @" + { + "includeIdentities" : true, + "roleName" : "Finance - Accounting", + "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", + "roleDescription" : "General access for accounting department", + "directlyAssignedEntitlements" : false + } + "@ + + # Create request to provision a potential role into an actual role. + + try { + New-V2024PotentialRoleProvisionRequest-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2024PotentialRoleProvisionRequest -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024MinEntitlementPopularity $MinEntitlementPopularity -V2024IncludeCommonAccess $IncludeCommonAccess -V2024RoleMiningPotentialRoleProvisionRequest $RoleMiningPotentialRoleProvisionRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PotentialRoleProvisionRequest" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RoleMiningSessionDto = @" + { + "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", + "prescribedPruneThreshold" : 10, + "pruneThreshold" : 50, + "saved" : true, + "potentialRolesReadyCount" : 0, + "scope" : { + "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], + "attributeFilterCriteria" : { + "displayName" : { + "untranslated" : "Location: Miami" + }, + "ariaLabel" : { + "untranslated" : "Location: Miami" + }, + "data" : { + "displayName" : { + "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" + }, + "name" : "location", + "operator" : "EQUALS", + "values" : [ "Miami" ] + } + }, + "criteria" : "source.name:DataScienceDataset" + }, + "potentialRoleCount" : 0, + "name" : "Saved RM Session - 07/10", + "minNumIdentitiesInPotentialRole" : 20, + "identityCount" : 0, + "type" : "SPECIALIZED" + } + "@ + + # Create a role mining session + + try { + $Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto + New-V2024RoleMiningSessions-V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningSessionDto $Result + + # Below is a request that includes all optional parameters + # New-V2024RoleMiningSessions -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningSessionDto $RoleMiningSessionDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024RoleMiningSessions" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session + $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Export (download) details for a potential role in a role mining session + + try { + Invoke-V2024DownloadRoleMiningPotentialRoleZip-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024ExportId $ExportId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Invoke-V2024DownloadRoleMiningPotentialRoleZip -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024ExportId $ExportId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024DownloadRoleMiningPotentialRoleZip" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Export (download) details for a potential role in a role mining session + + try { + Export-V2024RoleMiningPotentialRole-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2024RoleMiningPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RoleMiningPotentialRoleExportRequest = @" + { + "minEntitlementPopularity" : 0, + "includeCommonAccess" : true + } + "@ + + # Asynchronously export details for a potential role in a role mining session and upload to S3 + + try { + Export-V2024RoleMiningPotentialRoleAsync-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2024RoleMiningPotentialRoleAsync -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleExportRequest $RoleMiningPotentialRoleExportRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRoleAsync" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session + $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Retrieve status of a potential role export job + + try { + Export-V2024RoleMiningPotentialRoleStatus-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024ExportId $ExportId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2024RoleMiningPotentialRoleStatus -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024ExportId $ExportId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRoleStatus" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) + $Filters = "(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true))" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all potential role summaries + + try { + Get-V2024AllPotentialRoleSummaries-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AllPotentialRoleSummaries -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllPotentialRoleSummaries" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) + + # Retrieves entitlement popularity distribution for a potential role in a role mining session + + try { + Get-V2024EntitlementDistributionPotentialRole-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementDistributionPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024IncludeCommonAccess $IncludeCommonAccess + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementDistributionPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) (default to $true) + $Sorters = "popularity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) + $Filters = "applicationName sw "AD"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves entitlements for a potential role in a role mining session + + try { + Get-V2024EntitlementsPotentialRole-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementsPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024IncludeCommonAccess $IncludeCommonAccess -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "populariity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** (optional) + $Filters = "applicationName sw "AD"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves excluded entitlements for a potential role in a role mining session + + try { + Get-V2024ExcludedEntitlementsPotentialRole-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ExcludedEntitlementsPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ExcludedEntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves identities for a potential role in a role mining session + + try { + Get-V2024IdentitiesPotentialRole-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentitiesPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitiesPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Retrieves a specific potential role + + try { + Get-V2024PotentialRole-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "applicationName sw "test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves the applications of a potential role for a role mining session + + try { + Get-V2024PotentialRoleApplications-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PotentialRoleApplications -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleApplications" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "entitlementRef.name sw "test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves the entitlements of a potential role for a role mining session + + try { + Get-V2024PotentialRoleEntitlements-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PotentialRoleEntitlements -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleEntitlements" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PotentialRoleId = "e0cc5d7d-bf7f-4f81-b2af-8885b09d9923" # String | A potential role id + $SourceId = "2c9180877620c1460176267f336a106f" # String | A source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "-usageCount" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves potential role source usage + + try { + Get-V2024PotentialRoleSourceIdentityUsage-V2024PotentialRoleId $PotentialRoleId -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PotentialRoleSourceIdentityUsage -V2024PotentialRoleId $PotentialRoleId -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleSourceIdentityUsage" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** (optional) + $Filters = "(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true))" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all potential role summaries + + try { + Get-V2024PotentialRoleSummaries-V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PotentialRoleSummaries -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleSummaries" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/{potentialRoleId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Retrieves a specific potential role + + try { + Get-V2024RoleMiningPotentialRole-V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleMiningPotentialRole -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be retrieved. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get a role mining session + + try { + Get-V2024RoleMiningSession-V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleMiningSession -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSession" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get role mining session status state + + try { + Get-V2024RoleMiningSessionStatus-V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleMiningSessionStatus -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSessionStatus" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "saved eq "true" and name sw "RM Session"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* (optional) + $Sorters = "createdBy,createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all role mining sessions + + try { + Get-V2024RoleMiningSessions-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleMiningSessions -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters -V2024Sorters $Sorters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSessions" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/saved + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all saved potential roles + + try { + Get-V2024SavedPotentialRoles-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SavedPotentialRoles -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedPotentialRoles" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ + + + # Update a potential role + + try { + $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner + Update-V2024PotentialRole-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-V2024PotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $PatchPotentialRoleRequestInner + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/{potentialRoleId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ + + + # Update a potential role + + try { + $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner + Update-V2024PotentialRole0-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-V2024PotentialRole0 -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $PatchPotentialRoleRequestInner + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PotentialRole0" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be patched + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a role mining session + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024RoleMiningSession-V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024RoleMiningSession -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RoleMiningSession" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RoleMiningPotentialRoleEditEntitlements = @" + { + "ids" : [ "entId1", "entId2" ], + "exclude" : true + } + "@ + + # Edit entitlements for a potential role to exclude some entitlements + + try { + $Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements + Update-V2024EntitlementsPotentialRole-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleEditEntitlements $Result + + # Below is a request that includes all optional parameters + # Update-V2024EntitlementsPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleEditEntitlements $RoleMiningPotentialRoleEditEntitlements + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /icons/{objectType}/{objectId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ObjectType = "application" # String | Object type. Available options ['application'] + $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete an icon + + try { + Remove-V2024Icon-V2024ObjectType $ObjectType -V2024ObjectId $ObjectId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024Icon -V2024ObjectType $ObjectType -V2024ObjectId $ObjectId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Icon" + Write-Host $_.ErrorDetails + } +- path: /icons/{objectType}/{objectId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ObjectType = "application" # String | Object type. Available options ['application'] + $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] + + # Update an icon + + try { + Set-V2024Icon-V2024ObjectType $ObjectType -V2024ObjectId $ObjectId -V2024XSailPointExperimental $XSailPointExperimental -V2024Image $Image + + # Below is a request that includes all optional parameters + # Set-V2024Icon -V2024ObjectType $ObjectType -V2024ObjectId $ObjectId -V2024XSailPointExperimental $XSailPointExperimental -V2024Image $Image + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024Icon" + Write-Host $_.ErrorDetails + } +- path: /identities/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete identity + + try { + Remove-V2024Identity-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024Identity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Identity" + Write-Host $_.ErrorDetails + } +- path: /identities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Identity Details + + try { + Get-V2024Identity-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Identity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Identity" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/ownership + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "ff8081814d2a8036014d701f3fbf53fa" # String | Identity ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get ownership details + + try { + Get-V2024IdentityOwnershipDetails-V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityOwnershipDetails -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOwnershipDetails" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/role-assignments/{assignmentId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + $AssignmentId = "1cbb0705b38c4226b1334eadd8874086" # String | Assignment Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Role assignment details + + try { + Get-V2024RoleAssignment-V2024IdentityId $IdentityId -V2024AssignmentId $AssignmentId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleAssignment -V2024IdentityId $IdentityId -V2024AssignmentId $AssignmentId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignment" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/role-assignments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id to get the role assignments for + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RoleId = "e7697a1e96d04db1ac7b0f4544915d2c" # String | Role Id to filter the role assignments with (optional) + $RoleName = "Engineer" # String | Role name to filter the role assignments with (optional) + + # List role assignments + + try { + Get-V2024RoleAssignments-V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleAssignments -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleId $RoleId -V2024RoleName $RoleName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignments" + Write-Host $_.ErrorDetails + } +- path: /identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) + $Sorters = "name,-cloudStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) + $DefaultFilter = "CORRELATED_ONLY" # String | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to "CORRELATED_ONLY") + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Identities + + try { + Get-V2024Identities-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Identities -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters -V2024Sorters $Sorters -V2024DefaultFilter $DefaultFilter -V2024Count $Count -V2024Limit $Limit -V2024Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Identities" + Write-Host $_.ErrorDetails + } +- path: /identities/{id}/reset + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Reset an identity + + try { + Reset-V2024Identity-V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Reset-V2024Identity -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024Identity" + Write-Host $_.ErrorDetails + } +- path: /identities/{id}/verification/account/send + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + $SendAccountVerificationRequest = @" + { + "sourceName" : "Active Directory Source", + "via" : "EMAIL_WORK" + } + "@ + + # Send password reset email + + try { + $Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest + Send-V2024IdentityVerificationAccountToken-V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id -V2024SendAccountVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2024IdentityVerificationAccountToken -V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id -V2024SendAccountVerificationRequest $SendAccountVerificationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityVerificationAccountToken" + Write-Host $_.ErrorDetails + } +- path: /identities/invite + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $InviteIdentitiesRequest = @" + { + "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], + "uninvited" : false + } + "@ + + # Invite identities to register + + try { + $Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest + Start-V2024IdentitiesInvite-V2024XSailPointExperimental $XSailPointExperimental -V2024InviteIdentitiesRequest $Result + + # Below is a request that includes all optional parameters + # Start-V2024IdentitiesInvite -V2024XSailPointExperimental $XSailPointExperimental -V2024InviteIdentitiesRequest $InviteIdentitiesRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentitiesInvite" + Write-Host $_.ErrorDetails + } +- path: /identities/process + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ProcessIdentitiesRequest = @" + { + "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] + } + "@ + + # Process a list of identityIds + + try { + $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest + Start-V2024IdentityProcessing-V2024XSailPointExperimental $XSailPointExperimental -V2024ProcessIdentitiesRequest $Result + + # Below is a request that includes all optional parameters + # Start-V2024IdentityProcessing -V2024XSailPointExperimental $XSailPointExperimental -V2024ProcessIdentitiesRequest $ProcessIdentitiesRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentityProcessing" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/synchronize-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "MyIdentityId" # String | The Identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Attribute synchronization for single identity. + + try { + Sync-V2024hronizeAttributesForIdentity-V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Sync-V2024hronizeAttributesForIdentity -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024hronizeAttributesForIdentity" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityAttribute = @" + { + "standard" : false, + "system" : false, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + } + "@ + + # Create Identity Attribute + + try { + $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute + New-V2024IdentityAttribute-V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result + + # Below is a request that includes all optional parameters + # New-V2024IdentityAttribute -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $IdentityAttribute + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "displayName" # String | The attribute's technical name. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete Identity Attribute + + try { + Remove-V2024IdentityAttribute-V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/bulk-delete + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityAttributeNames = @" + { + "ids" : [ "name", "displayName" ] + } + "@ + + # Bulk delete Identity Attributes + + try { + $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames + Remove-V2024IdentityAttributesInBulk-V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttributeNames $Result + + # Below is a request that includes all optional parameters + # Remove-V2024IdentityAttributesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttributeNames $IdentityAttributeNames + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttributesInBulk" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "displayName" # String | The attribute's technical name. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Identity Attribute + + try { + Get-V2024IdentityAttribute-V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IncludeSystem = $false # Boolean | Include 'system' attributes in the response. (optional) (default to $false) + $IncludeSilent = $false # Boolean | Include 'silent' attributes in the response. (optional) (default to $false) + $SearchableOnly = $false # Boolean | Include only 'searchable' attributes in the response. (optional) (default to $false) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Identity Attributes + + try { + Get-V2024IdentityAttributes-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAttributes -V2024XSailPointExperimental $XSailPointExperimental -V2024IncludeSystem $IncludeSystem -V2024IncludeSilent $IncludeSilent -V2024SearchableOnly $SearchableOnly -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAttributes" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/{name} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "displayName" # String | The attribute's technical name. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityAttribute = @" + { + "standard" : false, + "system" : false, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + } + "@ + + # Update Identity Attribute + + try { + $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute + Send-V2024IdentityAttribute-V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result + + # Below is a request that includes all optional parameters + # Send-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $IdentityAttribute + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/compare + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Snapshot1 = "2007-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) + $Snapshot2 = "2008-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) + $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) + + + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Gets a difference of count for each access item types for the given identity between 2 snapshots + + try { + Compare-V2024IdentitySnapshots-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Compare-V2024IdentitySnapshots -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Snapshot1 $Snapshot1 -V2024Snapshot2 $Snapshot2 -V2024AccessItemTypes $AccessItemTypes -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2024IdentitySnapshots" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/compare/{access-type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $AccessType = "accessProfile" # String | The specific type which needs to be compared + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessAssociated = $false # Boolean | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) + $Snapshot1 = "2008-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) + $Snapshot2 = "2009-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Gets a list of differences of specific accessType for the given identity between 2 snapshots + + try { + Compare-V2024IdentitySnapshotsAccessType-V2024Id $Id -V2024AccessType $AccessType -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Compare-V2024IdentitySnapshotsAccessType -V2024Id $Id -V2024AccessType $AccessType -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessAssociated $AccessAssociated -V2024Snapshot1 $Snapshot1 -V2024Snapshot2 $Snapshot2 -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2024IdentitySnapshotsAccessType" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get latest snapshot of identity + + try { + Get-V2024HistoricalIdentity-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024HistoricalIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentity" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/events + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $From = "2024-03-01T13:00:00Z" # String | The optional instant until which access events are returned (optional) + $EventTypes = "MyEventTypes" # String[] | An optional list of event types to return. If null or empty, all events are returned (optional) + + $EventTypes = @"[AccessAddedEvent, AccessRemovedEvent]"@ + $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) + + $AccessItemTypes = @"[entitlement, account]"@ + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Lists all events for the given identity + + try { + Get-V2024HistoricalIdentityEvents-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024HistoricalIdentityEvents -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024From $From -V2024EventTypes $EventTypes -V2024AccessItemTypes $AccessItemTypes -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentityEvents" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshots/{date} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Date = "2007-03-01T13:00:00Z" # String | The specified date + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Gets an identity snapshot at a given date + + try { + Get-V2024IdentitySnapshot-V2024Id $Id -V2024Date $Date -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySnapshot -V2024Id $Id -V2024Date $Date -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshot" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshot-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Before = "2007-03-01T13:00:00Z" # String | The date before which snapshot summary is required (optional) + $Interval = "day" # String | The interval indicating day or month. Defaults to month if not specified (optional) + $TimeZone = "UTC" # String | The time zone. Defaults to UTC if not provided (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Gets the summary for the event count for a specific identity + + try { + Get-V2024IdentitySnapshotSummary-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySnapshotSummary -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Before $Before -V2024Interval $Interval -V2024TimeZone $TimeZone -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshotSummary" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/start-date + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Gets the start date of the identity + + try { + Get-V2024IdentityStartDate-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityStartDate -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityStartDate" + Write-Host $_.ErrorDetails + } +- path: /historical-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $StartsWithQuery = "Ada" # String | This param is used for starts-with search for first, last and display name of the identity (optional) + $IsDeleted = $true # Boolean | Indicates if we want to only list down deleted identities or not. (optional) + $IsActive = $true # Boolean | Indicates if we want to only list active or inactive identities. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # Lists all the identities + + try { + Get-V2024HistoricalIdentities-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024HistoricalIdentities -V2024XSailPointExperimental $XSailPointExperimental -V2024StartsWithQuery $StartsWithQuery -V2024IsDeleted $IsDeleted -V2024IsActive $IsActive -V2024Limit $Limit -V2024Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentities" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Type = "account" # String | The type of access item for the identity. If not provided, it defaults to account (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Access Items by Identity + + try { + Get-V2024IdentityAccessItems-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAccessItems -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Type $Type -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessItems" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshots/{date}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Date = "2007-03-01T13:00:00Z" # String | The specified date + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Type = "account" # String | The access item type (optional) + + # Gets the list of identity access items at a given date filterd by item type + + try { + Get-V2024IdentitySnapshotAccessItems-V2024Id $Id -V2024Date $Date -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySnapshotAccessItems -V2024Id $Id -V2024Date $Date -V2024XSailPointExperimental $XSailPointExperimental -V2024Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshotAccessItems" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshots + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Start = "2007-03-01T13:00:00Z" # String | The specified start date (optional) + $Interval = "day" # String | The interval indicating the range in day or month for the specified interval-name (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Lists all the snapshots for the identity + + try { + Get-V2024IdentitySnapshots-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySnapshots -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Start $Start -V2024Interval $Interval -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshots" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfile = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + } + "@ + + # Create an Identity Profile + + try { + $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile + New-V2024IdentityProfile-V2024IdentityProfile $Result + + # Below is a request that includes all optional parameters + # New-V2024IdentityProfile -V2024IdentityProfile $IdentityProfile + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. + + # Delete an Identity Profile + + try { + Remove-V2024IdentityProfile-V2024IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Remove-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body. + $RequestBody = @""@ + + + # Delete Identity Profiles + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-V2024IdentityProfiles-V2024RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-V2024IdentityProfiles -V2024RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) + + # Export Identity Profiles + + try { + Export-V2024IdentityProfiles + + # Below is a request that includes all optional parameters + # Export-V2024IdentityProfiles -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. + + # Get default Identity Attribute Config + + try { + Get-V2024DefaultIdentityAttributeConfig-V2024IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-V2024DefaultIdentityAttributeConfig -V2024IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultIdentityAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. + + # Get single Identity Profile + + try { + Get-V2024IdentityProfile-V2024IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + + + + + $IdentityProfileExportedObject = @"{ + "self" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "version" : 1, + "object" : { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + } + }"@ + + + # Import Identity Profiles + + try { + $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject + Import-V2024IdentityProfiles-V2024IdentityProfileExportedObject $Result + + # Below is a request that includes all optional parameters + # Import-V2024IdentityProfiles -V2024IdentityProfileExportedObject $IdentityProfileExportedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) + + # Identity Profiles List + + try { + Get-V2024IdentityProfiles + + # Below is a request that includes all optional parameters + # Get-V2024IdentityProfiles -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/identity-preview + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityPreviewRequest = @" + { + "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + } + } + "@ + + # Generate Identity Profile Preview + + try { + $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest + Show-V2024IdentityPreview-V2024IdentityPreviewRequest $Result + + # Below is a request that includes all optional parameters + # Show-V2024IdentityPreview -V2024IdentityPreviewRequest $IdentityPreviewRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024IdentityPreview" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/process-identities + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed + + # Process identities under profile + + try { + Sync-V2024IdentityProfile-V2024IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Sync-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update the Identity Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024IdentityProfile-V2024IdentityProfileId $IdentityProfileId -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleState = @" + { + "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], + "emailNotificationOption" : { + "notifyManagers" : true, + "notifySpecificUsers" : true, + "emailAddressList" : [ "test@test.com", "test2@test.com" ], + "notifyAllAdmins" : true + }, + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Lifecycle description", + "accountActions" : [ { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }, { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } ], + "id" : "id12345", + "identityCount" : 42, + "technicalName" : "Technical Name", + "identityState" : "identityState", + "enabled" : true + } + "@ + + # Create Lifecycle State + + try { + $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState + New-V2024LifecycleState-V2024IdentityProfileId $IdentityProfileId -V2024LifecycleState $Result + + # Below is a request that includes all optional parameters + # New-V2024LifecycleState -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleState $LifecycleState + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + + # Delete Lifecycle State + + try { + Remove-V2024LifecycleState-V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Remove-V2024LifecycleState -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + + # Get Lifecycle State + + try { + Get-V2024LifecycleState-V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Get-V2024LifecycleState -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Lists LifecycleStates + + try { + Get-V2024LifecycleStates-V2024IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-V2024LifecycleStates -V2024IdentityProfileId $IdentityProfileId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LifecycleStates" + Write-Host $_.ErrorDetails + } +- path: /identities/{identity-id}/set-lifecycle-state + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "2c9180857893f1290178944561990364" # String | ID of the identity to update. + $SetLifecycleStateRequest = @" + + "@ + + # Set Lifecycle State + + try { + $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest + Set-V2024LifecycleState-V2024IdentityId $IdentityId -V2024SetLifecycleStateRequest $Result + + # Below is a request that includes all optional parameters + # Set-V2024LifecycleState -V2024IdentityId $IdentityId -V2024SetLifecycleStateRequest $SetLifecycleStateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Lifecycle State + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024LifecycleStates-V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024LifecycleStates -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024LifecycleStates" + Write-Host $_.ErrorDetails + } +- path: /managed-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ManagedClientRequest = @" + { + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + } + "@ + + # Create Managed Client + + try { + $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest + New-V2024ManagedClient-V2024ManagedClientRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ManagedClient -V2024ManagedClientRequest $ManagedClientRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Delete Managed Client + + try { + Remove-V2024ManagedClient-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ManagedClient -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Get Managed Client + + try { + Get-V2024ManagedClient-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClient -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "aClientId" # String | Managed client ID to get status for. + $Type = "CCG" # ManagedClientType | Managed client type to get status for. + + # Get Managed Client Status + + try { + Get-V2024ManagedClientStatus-V2024Id $Id -V2024Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClientStatus -V2024Id $Id -V2024Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + + # Get Managed Clients + + try { + Get-V2024ManagedClients + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClients -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClients" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Client + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ManagedClient-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ManagedClient -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ManagedClusterRequest = @" + { + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + } + "@ + + # Create Create Managed Cluster + + try { + $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest + New-V2024ManagedCluster-V2024ManagedClusterRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ManagedCluster -V2024ManagedClusterRequest $ManagedClusterRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) + + # Delete Managed Cluster + + try { + Remove-V2024ManagedCluster-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ManagedCluster -V2024Id $Id -V2024RemoveClients $RemoveClients + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. + + # Get Managed Cluster Log Configuration + + try { + Get-V2024ClientLogConfiguration-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ClientLogConfiguration -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + + # Get Managed Cluster + + try { + Get-V2024ManagedCluster-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ManagedCluster -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + + # Get Managed Clusters + + try { + Get-V2024ManagedClusters + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClusters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusters" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. + $PutClientLogConfigurationRequest = @" + + "@ + + # Update Managed Cluster Log Configuration + + try { + $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest + Send-V2024ClientLogConfiguration-V2024Id $Id -V2024PutClientLogConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2024ClientLogConfiguration -V2024Id $Id -V2024PutClientLogConfigurationRequest $PutClientLogConfigurationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Cluster + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ManagedCluster-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ManagedCluster -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Configuration of Duo MFA method + + try { + Get-V2024MFADuoConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFADuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + # Configuration of KBA MFA method + + try { + Get-V2024MFAKbaConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFAKbaConfig -V2024AllLanguages $AllLanguages + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAKbaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Configuration of Okta MFA method + + try { + Get-V2024MFAOktaConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFAOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MfaDuoConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Duo MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-V2024MFADuoConfig-V2024MfaDuoConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFADuoConfig -V2024MfaDuoConfig $MfaDuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ + + + # Set MFA KBA configuration + + try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-V2024MFAKBAConfig-V2024KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $KbaAnswerRequestItem + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAKBAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MfaOktaConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Okta MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-V2024MFAOktaConfig-V2024MfaOktaConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFAOktaConfig -V2024MfaOktaConfig $MfaOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + # MFA method's test configuration + + try { + Test-V2024MFAConfig-V2024Method $Method + + # Below is a request that includes all optional parameters + # Test-V2024MFAConfig -V2024Method $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024MFAConfig" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) + $NonEmployeeApprovalDecision = @" + { + "comment" : "Approved by manager" + } + "@ + + # Approve a Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision + Approve-V2024NonEmployeeRequest-V2024Id $Id -V2024NonEmployeeApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Approve-V2024NonEmployeeRequest -V2024Id $Id -V2024NonEmployeeApprovalDecision $NonEmployeeApprovalDecision + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Create Non-Employee Record + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-V2024NonEmployeeRecord-V2024NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-V2024NonEmployeeRecord -V2024NonEmployeeRequestBody $NonEmployeeRequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Create Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-V2024NonEmployeeRequest-V2024NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-V2024NonEmployeeRequest -V2024NonEmployeeRequestBody $NonEmployeeRequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $NonEmployeeSourceRequestBody = @" + { + "owner" : { + "id" : "2c91808570313110017040b06f344ec9" + }, + "managementWorkgroup" : "123299", + "accountManagers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ], + "name" : "Retail", + "description" : "Source description", + "approvers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ] + } + "@ + + # Create Non-Employee Source + + try { + $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody + New-V2024NonEmployeeSource-V2024NonEmployeeSourceRequestBody $Result + + # Below is a request that includes all optional parameters + # New-V2024NonEmployeeSource -V2024NonEmployeeSourceRequestBody $NonEmployeeSourceRequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + $NonEmployeeSchemaAttributeBody = @" + { + "helpText" : "The unique identifier for the account", + "label" : "Account Name", + "placeholder" : "Enter a unique user name for this account.", + "type" : "TEXT", + "technicalName" : "account.name", + "required" : true + } + "@ + + # Create a new Schema Attribute for Non-Employee Source + + try { + $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody + New-V2024NonEmployeeSourceSchemaAttributes-V2024SourceId $SourceId -V2024NonEmployeeSchemaAttributeBody $Result + + # Below is a request that includes all optional parameters + # New-V2024NonEmployeeSourceSchemaAttributes -V2024SourceId $SourceId -V2024NonEmployeeSchemaAttributeBody $NonEmployeeSchemaAttributeBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) + + # Delete Non-Employee Record + + try { + Remove-V2024NonEmployeeRecord-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeRecord -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $DeleteNonEmployeeRecordsInBulkRequest = @" + + "@ + + # Delete Multiple Non-Employee Records + + try { + $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest + Remove-V2024NonEmployeeRecordsInBulk-V2024DeleteNonEmployeeRecordsInBulkRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeRecordsInBulk -V2024DeleteNonEmployeeRecordsInBulkRequest $DeleteNonEmployeeRecordsInBulkRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format + + # Delete Non-Employee Request + + try { + Remove-V2024NonEmployeeRequest-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeRequest -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # Delete a Schema Attribute for Non-Employee Source + + try { + Remove-V2024NonEmployeeSchemaAttribute-V2024AttributeId $AttributeId -V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeSchemaAttribute -V2024AttributeId $AttributeId -V2024SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id + + # Delete Non-Employee Source + + try { + Remove-V2024NonEmployeeSource-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeSource -V2024SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # Delete all custom schema attributes for Non-Employee Source + + try { + Remove-V2024NonEmployeeSourceSchemaAttributes-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeSourceSchemaAttributes -V2024SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employees/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) + + # Exports Non-Employee Records to CSV + + try { + Export-V2024NonEmployeeRecords-V2024Id $Id + + # Below is a request that includes all optional parameters + # Export-V2024NonEmployeeRecords -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024NonEmployeeRecords" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/schema-attributes-template/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID) + + # Exports Source Schema Template + + try { + Export-V2024NonEmployeeSourceSchemaTemplate-V2024Id $Id + + # Below is a request that includes all optional parameters + # Export-V2024NonEmployeeSourceSchemaTemplate -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024NonEmployeeSourceSchemaTemplate" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) + $IncludeDetail = $true # Boolean | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) + + # Get a non-employee approval item detail + + try { + Get-V2024NonEmployeeApproval-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeApproval -V2024Id $Id -V2024IncludeDetail $IncludeDetail + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApproval" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/summary/{requested-for} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + + # Get Summary of Non-Employee Approval Requests + + try { + Get-V2024NonEmployeeApprovalSummary-V2024RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeApprovalSummary -V2024RequestedFor $RequestedFor + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApprovalSummary" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source ID (UUID) + + # Obtain the status of bulk upload on the source + + try { + Get-V2024NonEmployeeBulkUploadStatus-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeBulkUploadStatus -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeBulkUploadStatus" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) + + # Get a Non-Employee Record + + try { + Get-V2024NonEmployeeRecord-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRecord -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID) + + # Get a Non-Employee Request + + try { + Get-V2024NonEmployeeRequest-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRequest -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/summary/{requested-for} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + + # Get Summary of Non-Employee Requests + + try { + Get-V2024NonEmployeeRequestSummary-V2024RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRequestSummary -V2024RequestedFor $RequestedFor + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequestSummary" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # Get Schema Attribute Non-Employee Source + + try { + Get-V2024NonEmployeeSchemaAttribute-V2024AttributeId $AttributeId -V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeSchemaAttribute -V2024AttributeId $AttributeId -V2024SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id + + # Get a Non-Employee Source + + try { + Get-V2024NonEmployeeSource-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeSource -V2024SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # List Schema Attributes Non-Employee Source + + try { + Get-V2024NonEmployeeSourceSchemaAttributes-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeSourceSchemaAttributes -V2024SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) + $Data = # System.IO.FileInfo | + + # Imports, or Updates, Non-Employee Records + + try { + Import-V2024NonEmployeeRecordsInBulk-V2024Id $Id -V2024Data $Data + + # Below is a request that includes all optional parameters + # Import-V2024NonEmployeeRecordsInBulk -V2024Id $Id -V2024Data $Data + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024NonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity for whom the request was made. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "approvalStatus eq "Pending"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Get List of Non-Employee Approval Requests + + try { + Get-V2024NonEmployeeApprovals + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeApprovals -V2024RequestedFor $RequestedFor -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApprovals" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "accountName,sourceId" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) + $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + + # List Non-Employee Records + + try { + Get-V2024NonEmployeeRecords + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRecords -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRecords" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "e136567de87e4d029e60b3c3c55db56d" # String | The identity for whom the request was made. *me* indicates the current user. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "created,approvalStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) + $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + + # List Non-Employee Requests + + try { + Get-V2024NonEmployeeRequests-V2024RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRequests -V2024RequestedFor $RequestedFor -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequests" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $NonEmployeeCount = $true # Boolean | The flag to determine whether return a non-employee count associate with source. (optional) + $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) + + # List Non-Employee Sources + + try { + Get-V2024NonEmployeeSources-V2024RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeSources -V2024RequestedFor $RequestedFor -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024NonEmployeeCount $NonEmployeeCount -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSources" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Non-Employee Record + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024NonEmployeeRecord-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024NonEmployeeRecord -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Schema Attribute for Non-Employee Source + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024NonEmployeeSchemaAttribute-V2024AttributeId $AttributeId -V2024SourceId $SourceId -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024NonEmployeeSchemaAttribute -V2024AttributeId $AttributeId -V2024SourceId $SourceId -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Non-Employee Source + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024NonEmployeeSource-V2024SourceId $SourceId -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024NonEmployeeSource -V2024SourceId $SourceId -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id}/reject + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) + $NonEmployeeRejectApprovalDecision = @" + { + "comment" : "approved" + } + "@ + + # Reject a Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision + Deny-V2024NonEmployeeRequest-V2024Id $Id -V2024NonEmployeeRejectApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Deny-V2024NonEmployeeRequest -V2024Id $Id -V2024NonEmployeeRejectApprovalDecision $NonEmployeeRejectApprovalDecision + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Update Non-Employee Record + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + Update-V2024NonEmployeeRecord-V2024Id $Id -V2024NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024NonEmployeeRecord -V2024Id $Id -V2024NonEmployeeRequestBody $NonEmployeeRequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /verified-domains + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $DomainAddress = @" + { + "domain" : "sailpoint.com" + } + "@ + + # Verify domain address via DKIM + + try { + $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress + New-V2024DomainDkim-V2024XSailPointExperimental $XSailPointExperimental -V2024DomainAddress $Result + + # Below is a request that includes all optional parameters + # New-V2024DomainDkim -V2024XSailPointExperimental $XSailPointExperimental -V2024DomainAddress $DomainAddress + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DomainDkim" + Write-Host $_.ErrorDetails + } +- path: /notification-templates + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TemplateDto = @" + { + "slackTemplate" : "slackTemplate", + "footer" : "footer", + "teamsTemplate" : "teamsTemplate", + "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", + "created" : "2020-01-01T00:00:00Z", + "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", + "medium" : "EMAIL", + "locale" : "en", + "body" : "Please go to the task manager", + "name" : "Task Manager Subscription", + "replyTo" : "$__global.emailFromAddress", + "header" : "header", + "modified" : "2020-01-01T00:00:00Z", + "from" : "$__global.emailFromAddress", + "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", + "key" : "cloud_manual_work_item_summary" + } + "@ + + # Create Notification Template + + try { + $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto + New-V2024NotificationTemplate-V2024XSailPointExperimental $XSailPointExperimental -V2024TemplateDto $Result + + # Below is a request that includes all optional parameters + # New-V2024NotificationTemplate -V2024XSailPointExperimental $XSailPointExperimental -V2024TemplateDto $TemplateDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NotificationTemplate" + Write-Host $_.ErrorDetails + } +- path: /verified-from-addresses + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $EmailStatusDto = @" + { + "isVerifiedByDomain" : false, + "verificationStatus" : "PENDING", + "id" : "id", + "email" : "sender@example.com" + } + "@ + + # Create Verified From Address + + try { + $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto + New-V2024VerifiedFromAddress-V2024XSailPointExperimental $XSailPointExperimental -V2024EmailStatusDto $Result + + # Below is a request that includes all optional parameters + # New-V2024VerifiedFromAddress -V2024XSailPointExperimental $XSailPointExperimental -V2024EmailStatusDto $EmailStatusDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VerifiedFromAddress" + Write-Host $_.ErrorDetails + } +- path: /notification-templates/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TemplateBulkDeleteDto = @"{ + "medium" : "EMAIL", + "locale" : "en", + "key" : "cloud_manual_work_item_summary" + }"@ + + + # Bulk Delete Notification Templates + + try { + $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto + Remove-V2024NotificationTemplatesInBulk-V2024XSailPointExperimental $XSailPointExperimental -V2024TemplateBulkDeleteDto $Result + + # Below is a request that includes all optional parameters + # Remove-V2024NotificationTemplatesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024TemplateBulkDeleteDto $TemplateBulkDeleteDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NotificationTemplatesInBulk" + Write-Host $_.ErrorDetails + } +- path: /verified-from-addresses/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "MyId" # String | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete Verified From Address + + try { + Remove-V2024VerifiedFromAddress-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024VerifiedFromAddress -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024VerifiedFromAddress" + Write-Host $_.ErrorDetails + } +- path: /verified-domains + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get DKIM Attributes + + try { + Get-V2024DkimAttributes-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024DkimAttributes -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DkimAttributes" + Write-Host $_.ErrorDetails + } +- path: /mail-from-attributes/{identity} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get MAIL FROM Attributes + + try { + Get-V2024MailFromAttributes-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024MailFromAttributes -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MailFromAttributes" + Write-Host $_.ErrorDetails + } +- path: /notification-templates/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Notification Template By Id + + try { + Get-V2024NotificationTemplate-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NotificationTemplate -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplate" + Write-Host $_.ErrorDetails + } +- path: /notification-template-context + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Notification Template Context + + try { + Get-V2024NotificationsTemplateContext-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NotificationsTemplateContext -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationsTemplateContext" + Write-Host $_.ErrorDetails + } +- path: /verified-from-addresses + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "email eq "john.doe@company.com"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* (optional) + $Sorters = "email" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) + + # List From Addresses + + try { + Get-V2024FromAddresses-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024FromAddresses -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FromAddresses" + Write-Host $_.ErrorDetails + } +- path: /notification-preferences/{key} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List Notification Preferences for tenant. + + try { + Get-V2024NotificationPreferences-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NotificationPreferences -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationPreferences" + Write-Host $_.ErrorDetails + } +- path: /notification-template-defaults + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "key eq "cloud_manual_work_item_summary"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + # List Notification Template Defaults + + try { + Get-V2024NotificationTemplateDefaults-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NotificationTemplateDefaults -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplateDefaults" + Write-Host $_.ErrorDetails + } +- path: /notification-templates + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "medium eq "EMAIL"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + # List Notification Templates + + try { + Get-V2024NotificationTemplates-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NotificationTemplates -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplates" + Write-Host $_.ErrorDetails + } +- path: /mail-from-attributes + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $MailFromAttributesDto = @" + { + "identity" : "BobSmith@sailpoint.com", + "mailFromDomain" : "example.sailpoint.com" + } + "@ + + # Change MAIL FROM domain + + try { + $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto + Send-V2024MailFromAttributes-V2024XSailPointExperimental $XSailPointExperimental -V2024MailFromAttributesDto $Result + + # Below is a request that includes all optional parameters + # Send-V2024MailFromAttributes -V2024XSailPointExperimental $XSailPointExperimental -V2024MailFromAttributesDto $MailFromAttributesDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024MailFromAttributes" + Write-Host $_.ErrorDetails + } +- path: /send-test-notification + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SendTestNotificationRequestDto = @" + { + "context" : "{}", + "medium" : "EMAIL", + "key" : "cloud_manual_work_item_summary" + } + "@ + + # Send Test Notification + + try { + $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto + Send-V2024TestNotification-V2024XSailPointExperimental $XSailPointExperimental -V2024SendTestNotificationRequestDto $Result + + # Below is a request that includes all optional parameters + # Send-V2024TestNotification -V2024XSailPointExperimental $XSailPointExperimental -V2024SendTestNotificationRequestDto $SendTestNotificationRequestDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TestNotification" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreateOAuthClientRequest = @" + { + "internal" : false, + "businessName" : "Acme-Solar", + "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", + "refreshTokenValiditySeconds" : 86400, + "type" : "CONFIDENTIAL", + "redirectUris" : [ "http://localhost:12345" ], + "enabled" : true, + "accessType" : "OFFLINE", + "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], + "strongAuthSupported" : false, + "homepageUrl" : "http://localhost:12345", + "accessTokenValiditySeconds" : 750, + "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], + "name" : "Demo API Client", + "claimsSupported" : false + } + "@ + + # Create OAuth Client + + try { + $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest + New-V2024OauthClient-V2024CreateOAuthClientRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024OauthClient -V2024CreateOAuthClientRequest $CreateOAuthClientRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024OauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + + # Delete OAuth Client + + try { + Remove-V2024OauthClient-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024OauthClient -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024OauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + + # Get OAuth Client + + try { + Get-V2024OauthClient-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024OauthClient -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + + # List OAuth Clients + + try { + Get-V2024OauthClients + + # Below is a request that includes all optional parameters + # Get-V2024OauthClients -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OauthClients" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch OAuth Client + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024OauthClient-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024OauthClient -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024OauthClient" + Write-Host $_.ErrorDetails + } +- path: /org-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Org Config Settings + + try { + Get-V2024OrgConfig-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024OrgConfig -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OrgConfig" + Write-Host $_.ErrorDetails + } +- path: /org-config/valid-time-zones + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Get Valid Time Zones + + try { + Get-V2024ValidTimeZones-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ValidTimeZones -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ValidTimeZones" + Write-Host $_.ErrorDetails + } +- path: /org-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Org Config + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024OrgConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024OrgConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024OrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Create Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + New-V2024PasswordOrgConfig-V2024PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # New-V2024PasswordOrgConfig -V2024PasswordOrgConfig $PasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Password Org Config + + try { + Get-V2024PasswordOrgConfig + + # Below is a request that includes all optional parameters + # Get-V2024PasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Update Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + Send-V2024PasswordOrgConfig-V2024PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024PasswordOrgConfig -V2024PasswordOrgConfig $PasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-dictionary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Password Dictionary + + try { + Get-V2024PasswordDictionary + + # Below is a request that includes all optional parameters + # Get-V2024PasswordDictionary + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordDictionary" + Write-Host $_.ErrorDetails + } +- path: /password-dictionary + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $File = # System.IO.FileInfo | (optional) + + # Update Password Dictionary + + try { + Send-V2024PasswordDictionary + + # Below is a request that includes all optional parameters + # Send-V2024PasswordDictionary -V2024File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PasswordDictionary" + Write-Host $_.ErrorDetails + } +- path: /generate-password-reset-token/digit + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $PasswordDigitTokenReset = @" + { + "durationMinutes" : 5, + "length" : 8, + "userId" : "Abby.Smith" + } + "@ + + # Generate a digit token + + try { + $Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset + New-V2024DigitToken-V2024XSailPointExperimental $XSailPointExperimental -V2024PasswordDigitTokenReset $Result + + # Below is a request that includes all optional parameters + # New-V2024DigitToken -V2024XSailPointExperimental $XSailPointExperimental -V2024PasswordDigitTokenReset $PasswordDigitTokenReset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DigitToken" + Write-Host $_.ErrorDetails + } +- path: /password-change-status/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID + + # Get Password Change Request Status + + try { + Get-V2024PasswordChangeStatus-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024PasswordChangeStatus -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordChangeStatus" + Write-Host $_.ErrorDetails + } +- path: /query-password-info + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordInfoQueryDTO = @" + { + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + } + "@ + + # Query Password Info + + try { + $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO + Search-V2024PasswordInfo-V2024PasswordInfoQueryDTO $Result + + # Below is a request that includes all optional parameters + # Search-V2024PasswordInfo -V2024PasswordInfoQueryDTO $PasswordInfoQueryDTO + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PasswordInfo" + Write-Host $_.ErrorDetails + } +- path: /set-password + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordChangeRequest = @" + { + "sourceId" : "8a807d4c73c545510173c545d4b60246", + "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "identityId" : "8a807d4c73c545510173c545f0a002ff", + "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" + } + "@ + + # Set Identity's Password + + try { + $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest + Set-V2024Password-V2024PasswordChangeRequest $Result + + # Below is a request that includes all optional parameters + # Set-V2024Password -V2024PasswordChangeRequest $PasswordChangeRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024Password" + Write-Host $_.ErrorDetails + } +- path: /password-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordPolicyV3Dto = @" + { + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + } + "@ + + # Create Password Policy + + try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + New-V2024PasswordPolicy-V2024PasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # New-V2024PasswordPolicy -V2024PasswordPolicyV3Dto $PasswordPolicyV3Dto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. + + # Delete Password Policy by ID + + try { + Remove-V2024PasswordPolicy-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024PasswordPolicy -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. + + # Get Password Policy by ID + + try { + Get-V2024PasswordPolicyById-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024PasswordPolicyById -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordPolicyById" + Write-Host $_.ErrorDetails + } +- path: /password-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Password Policies + + try { + Get-V2024PasswordPolicies + + # Below is a request that includes all optional parameters + # Get-V2024PasswordPolicies -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordPolicies" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update. + $PasswordPolicyV3Dto = @" + { + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + } + "@ + + # Update Password Policy by ID + + try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + Set-V2024PasswordPolicy-V2024Id $Id -V2024PasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # Set-V2024PasswordPolicy -V2024Id $Id -V2024PasswordPolicyV3Dto $PasswordPolicyV3Dto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024PasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordSyncGroup = @" + { + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } + "@ + + # Create Password Sync Group + + try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + New-V2024PasswordSyncGroup-V2024PasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # New-V2024PasswordSyncGroup -V2024PasswordSyncGroup $PasswordSyncGroup + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. + + # Delete Password Sync Group by ID + + try { + Remove-V2024PasswordSyncGroup-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024PasswordSyncGroup -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. + + # Get Password Sync Group by ID + + try { + Get-V2024PasswordSyncGroup-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024PasswordSyncGroup -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Get Password Sync Group List + + try { + Get-V2024PasswordSyncGroups + + # Below is a request that includes all optional parameters + # Get-V2024PasswordSyncGroups -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordSyncGroups" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to update. + $PasswordSyncGroup = @" + { + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } + "@ + + # Update Password Sync Group by ID + + try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + Update-V2024PasswordSyncGroup-V2024Id $Id -V2024PasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # Update-V2024PasswordSyncGroup -V2024Id $Id -V2024PasswordSyncGroup $PasswordSyncGroup + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreatePersonalAccessTokenRequest = @" + { + "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], + "accessTokenValiditySeconds" : 36900, + "name" : "NodeJS Integration" + } + "@ + + # Create Personal Access Token + + try { + $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest + New-V2024PersonalAccessToken-V2024CreatePersonalAccessTokenRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024PersonalAccessToken -V2024CreatePersonalAccessTokenRequest $CreatePersonalAccessTokenRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id + + # Delete Personal Access Token + + try { + Remove-V2024PersonalAccessToken-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024PersonalAccessToken -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "2c9180867b50d088017b554662fb281e" # String | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) + $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + + # List Personal Access Tokens + + try { + Get-V2024PersonalAccessTokens + + # Below is a request that includes all optional parameters + # Get-V2024PersonalAccessTokens -V2024OwnerId $OwnerId -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PersonalAccessTokens" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Personal Access Token + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024PersonalAccessToken-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024PersonalAccessToken -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /public-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "firstname eq "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) + $AddCoreFilters = $false # Boolean | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be ""spadmin"" or ""cloudadmin"". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to $false) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Get list of public identities + + try { + Get-V2024PublicIdentities + + # Below is a request that includes all optional parameters + # Get-V2024PublicIdentities -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024AddCoreFilters $AddCoreFilters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PublicIdentities" + Write-Host $_.ErrorDetails + } +- path: /public-identities-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get the Public Identities Configuration + + try { + Get-V2024PublicIdentityConfig + + # Below is a request that includes all optional parameters + # Get-V2024PublicIdentityConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PublicIdentityConfig" + Write-Host $_.ErrorDetails + } +- path: /public-identities-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PublicIdentityConfig = @" + { + "modified" : "2018-06-25T20:22:28.104Z", + "attributes" : [ { + "name" : "Country", + "key" : "country" + }, { + "name" : "Country", + "key" : "country" + } ], + "modifiedBy" : { + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + } + "@ + + # Update the Public Identities Configuration + + try { + $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig + Update-V2024PublicIdentityConfig-V2024PublicIdentityConfig $Result + + # Below is a request that includes all optional parameters + # Update-V2024PublicIdentityConfig -V2024PublicIdentityConfig $PublicIdentityConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PublicIdentityConfig" + Write-Host $_.ErrorDetails + } +- path: /reports/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel + + # Cancel Report + + try { + Suspend-V2024Report-V2024Id $Id + + # Below is a request that includes all optional parameters + # Suspend-V2024Report -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024Report" + Write-Host $_.ErrorDetails + } +- path: /reports/{taskResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report + $FileFormat = "csv" # String | Output format of the requested report file + $Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional) + $Auditable = $true # Boolean | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to $false) + + # Get Report File + + try { + Get-V2024Report-V2024TaskResultId $TaskResultId -V2024FileFormat $FileFormat + + # Below is a request that includes all optional parameters + # Get-V2024Report -V2024TaskResultId $TaskResultId -V2024FileFormat $FileFormat -V2024Name $Name -V2024Auditable $Auditable + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Report" + Write-Host $_.ErrorDetails + } +- path: /reports/{taskResultId}/result + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report + $Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false) + + # Get Report Result + + try { + Get-V2024ReportResult-V2024TaskResultId $TaskResultId + + # Below is a request that includes all optional parameters + # Get-V2024ReportResult -V2024TaskResultId $TaskResultId -V2024Completed $Completed + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReportResult" + Write-Host $_.ErrorDetails + } +- path: /reports/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReportDetails = @" + { + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } + } + "@ + + # Run Report + + try { + $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails + Start-V2024Report-V2024ReportDetails $Result + + # Below is a request that includes all optional parameters + # Start-V2024Report -V2024ReportDetails $ReportDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024Report" + Write-Host $_.ErrorDetails + } +- path: /requestable-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) + $Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. (optional) + + $Types = @"ROLE,ACCESS_PROFILE"@ + $Term = "Finance Role" # String | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) + $Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional) + + $Statuses = @"[ASSIGNED, PENDING]"@ + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw "bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Requestable Objects List + + try { + Get-V2024RequestableObjects + + # Below is a request that includes all optional parameters + # Get-V2024RequestableObjects -V2024IdentityId $IdentityId -V2024Types $Types -V2024Term $Term -V2024Statuses $Statuses -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RequestableObjects" + Write-Host $_.ErrorDetails + } +- path: /role-insights/requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Generate insights for roles + + try { + New-V2024RoleInsightRequests-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2024RoleInsightRequests -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024RoleInsightRequests" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/entitlement-changes/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "identitiesWithAccess" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) + $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + + # Download entitlement insights for a role + + try { + Invoke-V2024DownloadRoleInsightsEntitlementsChanges-V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Invoke-V2024DownloadRoleInsightsEntitlementsChanges -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024DownloadRoleInsightsEntitlementsChanges" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/entitlement-changes/{entitlementId}/identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $EntitlementId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The entitlement id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $HasEntitlement = $true # Boolean | Identity has this entitlement or not (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "name sw "Jan"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) + + # Get identities for a suggested entitlement (for a role) + + try { + Get-V2024EntitlementChangesIdentities-V2024InsightId $InsightId -V2024EntitlementId $EntitlementId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementChangesIdentities -V2024InsightId $InsightId -V2024EntitlementId $EntitlementId -V2024XSailPointExperimental $XSailPointExperimental -V2024HasEntitlement $HasEntitlement -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChangesIdentities" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get a single role insight + + try { + Get-V2024RoleInsight-V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsight -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsight" + Write-Host $_.ErrorDetails + } +- path: /role-insights + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "numberOfUpdates" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) + $Filters = "name sw "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) + + # Get role insights + + try { + Get-V2024RoleInsights-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsights -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsights" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/current-entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + + # Get current entitlement for a role + + try { + Get-V2024RoleInsightsCurrentEntitlements-V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsightsCurrentEntitlements -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsCurrentEntitlements" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/entitlement-changes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) + $Filters = "name sw "Admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + + # Get entitlement insights for a role + + try { + Get-V2024RoleInsightsEntitlementsChanges-V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsightsEntitlementsChanges -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsEntitlementsChanges" + Write-Host $_.ErrorDetails + } +- path: /role-insights/requests/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insights request id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Returns metadata from prior request. + + try { + Get-V2024RoleInsightsRequests-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsightsRequests -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsRequests" + Write-Host $_.ErrorDetails + } +- path: /role-insights/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get role insights summary information + + try { + Get-V2024RoleInsightsSummary-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsightsSummary -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsSummary" + Write-Host $_.ErrorDetails + } +- path: /roles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Role = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "dimensional" : false, + "created" : "2021-03-01T22:32:58.104Z", + "dimensionRefs" : [ { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + }, { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + } ], + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "membership" : { + "identities" : [ { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } ], + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, + "type" : "IDENTITY_LIST" + }, + "enabled" : true, + "revocationRequestConfig" : { + "commentsRequired" : false, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : false + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "legacyMembershipInfo" : { + "type" : "IDENTITY_LIST" + }, + "accessRequestConfig" : { + "commentsRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "name" : "Role 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "accessModelMetadata" : { + "attributes" : [ { + "key" : "iscPrivacy", + "name" : "Privacy", + "multiselect" : false, + "status" : "active", + "type" : "governance", + "objectTypes" : [ "all" ], + "description" : "Specifies the level of privacy associated with an access item.", + "values" : [ { + "value" : "public", + "name" : "Public", + "status" : "active" + } ] + } ] + }, + "id" : "2c918086749d78830174a1a40e121518", + "requestable" : true + } + "@ + + # Create a Role + + try { + $Result = ConvertFrom-JsonToRole -Json $Role + New-V2024Role-V2024Role $Result + + # Below is a request that includes all optional parameters + # New-V2024Role -V2024Role $Role + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Role" + Write-Host $_.ErrorDetails + } +- path: /roles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleBulkDeleteRequest = @" + { + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } + "@ + + # Delete Role(s) + + try { + $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest + Remove-V2024BulkRoles-V2024RoleBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024BulkRoles -V2024RoleBulkDeleteRequest $RoleBulkDeleteRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024BulkRoles" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The role's id. + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + + # Remove a Metadata From Role. + + try { + Remove-V2024MetadataFromRoleByKeyAndValue-V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue + + # Below is a request that includes all optional parameters + # Remove-V2024MetadataFromRoleByKeyAndValue -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MetadataFromRoleByKeyAndValue" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + + # Delete a Role + + try { + Remove-V2024Role-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Role -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Role" + Write-Host $_.ErrorDetails + } +- path: /roles/access-model-metadata/bulk-update + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Bulk-Update Statuses + + try { + Get-V2024BulkUpdateStatus + + # Below is a request that includes all optional parameters + # Get-V2024BulkUpdateStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BulkUpdateStatus" + Write-Host $_.ErrorDetails + } +- path: /roles/access-model-metadata/bulk-update/id + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of the bulk update task. + + # Get Bulk-Update Status by ID + + try { + Get-V2024BulkUpdateStatusById-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024BulkUpdateStatusById -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BulkUpdateStatusById" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + + # Get a Role + + try { + Get-V2024Role-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Role -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Role" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/assigned-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role for which the assigned Identities are to be listed + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw Joe" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) + $Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) + + # List Identities assigned a Role + + try { + Get-V2024RoleAssignedIdentities-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024RoleAssignedIdentities -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignedIdentities" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the containing role + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + + # List role's Entitlements + + try { + Get-V2024RoleEntitlements-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleEntitlements -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleEntitlements" + Write-Host $_.ErrorDetails + } +- path: /roles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + + # List Roles + + try { + Get-V2024Roles + + # Below is a request that includes all optional parameters + # Get-V2024Roles -V2024ForSubadmin $ForSubadmin -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters -V2024ForSegmentIds $ForSegmentIds -V2024IncludeUnsegmented $IncludeUnsegmented + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Roles" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Role + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Role-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Role -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Role" + Write-Host $_.ErrorDetails + } +- path: /roles/filter + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + $Limit = 50 # Int32 | Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + $RoleListFilterDTO = @" + { + "ammKeyValues" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "secret" ] + } ], + "filters" : "dimensional eq false" + } + "@ + + # Filter Roles by Metadata + + try { + Search-V2024RolesByFilter + + # Below is a request that includes all optional parameters + # Search-V2024RolesByFilter -V2024ForSubadmin $ForSubadmin -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024ForSegmentIds $ForSegmentIds -V2024IncludeUnsegmented $IncludeUnsegmented -V2024RoleListFilterDTO $RoleListFilterDTO + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024RolesByFilter" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of a role + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + + # Add a Metadata to Role. + + try { + Update-V2024AttributeKeyAndValueToRole-V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue + + # Below is a request that includes all optional parameters + # Update-V2024AttributeKeyAndValueToRole -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AttributeKeyAndValueToRole" + Write-Host $_.ErrorDetails + } +- path: /roles/access-model-metadata/bulk-update/filter + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleMetadataBulkUpdateByFilterRequest = @" + { + "values" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "topSecret" ] + } ], + "filters" : " requestable eq false", + "replaceScope" : "ALL", + "operation" : "REPLACE" + } + "@ + + # Bulk-Update Roles' Metadata by Filters + + try { + $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByFilterRequest -Json $RoleMetadataBulkUpdateByFilterRequest + Update-V2024RolesMetadataByFilter-V2024RoleMetadataBulkUpdateByFilterRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024RolesMetadataByFilter -V2024RoleMetadataBulkUpdateByFilterRequest $RoleMetadataBulkUpdateByFilterRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByFilter" + Write-Host $_.ErrorDetails + } +- path: /roles/access-model-metadata/bulk-update/ids + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleMetadataBulkUpdateByIdRequest = @" + { + "roles" : [ "b1db89554cfa431cb8b9921ea38d9367" ], + "values" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "topSecret" ] + } ], + "replaceScope" : "ALL", + "operation" : "REPLACE" + } + "@ + + # Bulk-Update Roles' Metadata by ID + + try { + $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByIdRequest -Json $RoleMetadataBulkUpdateByIdRequest + Update-V2024RolesMetadataByIds-V2024RoleMetadataBulkUpdateByIdRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024RolesMetadataByIds -V2024RoleMetadataBulkUpdateByIdRequest $RoleMetadataBulkUpdateByIdRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByIds" + Write-Host $_.ErrorDetails + } +- path: /roles/access-model-metadata/bulk-update/query + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleMetadataBulkUpdateByQueryRequest = @" + { + "query" : { + "query\"" : { + "indices" : [ "roles" ], + "queryType" : "TEXT", + "textQuery" : { + "terms" : [ "test123" ], + "fields" : [ "id" ], + "matchAny" : false, + "contains" : true + }, + "includeNested" : false + } + }, + "values" : [ { + "attributeValue" : [ "topSecret" ], + "attributeKey" : "iscFederalClassifications" + }, { + "attributeValue" : [ "topSecret" ], + "attributeKey" : "iscFederalClassifications" + } ], + "replaceScope" : "ALL", + "operation" : "REPLACE" + } + "@ + + # Bulk-Update Roles' Metadata by Query + + try { + $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByQueryRequest -Json $RoleMetadataBulkUpdateByQueryRequest + Update-V2024RolesMetadataByQuery-V2024RoleMetadataBulkUpdateByQueryRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024RolesMetadataByQuery -V2024RoleMetadataBulkUpdateByQueryRequest $RoleMetadataBulkUpdateByQueryRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByQuery" + Write-Host $_.ErrorDetails + } +- path: /saved-searches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreateSavedSearchRequest = @" + + "@ + + # Create a saved search + + try { + $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest + New-V2024SavedSearch-V2024CreateSavedSearchRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024SavedSearch -V2024CreateSavedSearchRequest $CreateSavedSearchRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Delete document by ID + + try { + Remove-V2024SavedSearch-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SavedSearch -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id}/execute + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $SearchArguments = @" + { + "owner" : "", + "recipients" : [ { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" + } + "@ + + # Execute a saved search by ID + + try { + $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments + Invoke-V2024ExecuteSavedSearch-V2024Id $Id -V2024SearchArguments $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024ExecuteSavedSearch -V2024Id $Id -V2024SearchArguments $SearchArguments + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ExecuteSavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Return saved search by ID + + try { + Get-V2024SavedSearch-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SavedSearch -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) + + # A list of Saved Searches + + try { + Get-V2024SavedSearches + + # Below is a request that includes all optional parameters + # Get-V2024SavedSearches -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearches" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $SavedSearch = @" + { + "owner" : { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2018-06-25T20:22:28.104Z", + "columns" : { + "identity" : [ { + "field" : "displayName", + "header" : "Display Name" + }, { + "field" : "e-mail", + "header" : "Work Email" + } ] + }, + "query" : "@accounts(disabled:true)", + "description" : "Disabled accounts", + "orderBy" : { + "identity" : [ "lastName", "firstName" ], + "role" : [ "name" ] + }, + "sort" : [ "displayName" ], + "filters" : { + "terms" : [ "account_count", "account_count" ], + "range" : { + "lower" : { + "inclusive" : false, + "value" : "1" + }, + "upper" : { + "inclusive" : false, + "value" : "1" + } + }, + "exclude" : false, + "type" : "RANGE" + }, + "ownerId" : "2c91808568c529c60168cca6f90c1313", + "indices" : [ "identities" ], + "public" : false, + "name" : "Disabled accounts", + "modified" : "2018-06-25T20:22:28.104Z", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "fields" : [ "disabled" ] + } + "@ + + # Updates an existing saved search + + try { + $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch + Send-V2024SavedSearch-V2024Id $Id -V2024SavedSearch $Result + + # Below is a request that includes all optional parameters + # Send-V2024SavedSearch -V2024Id $Id -V2024SavedSearch $SavedSearch + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreateScheduledSearchRequest = @" + {savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]} + "@ + + # Create a new scheduled search + + try { + $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest + New-V2024ScheduledSearch-V2024CreateScheduledSearchRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ScheduledSearch -V2024CreateScheduledSearchRequest $CreateScheduledSearchRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Delete a Scheduled Search + + try { + Remove-V2024ScheduledSearch-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ScheduledSearch -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Get a Scheduled Search + + try { + Get-V2024ScheduledSearch-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ScheduledSearch -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional) + + # List scheduled searches + + try { + Get-V2024ScheduledSearch + + # Below is a request that includes all optional parameters + # Get-V2024ScheduledSearch -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id}/unsubscribe + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $TypedReference = @" + { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + "@ + + # Unsubscribe a recipient from Scheduled Search + + try { + $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference + Invoke-V2024UnsubscribeScheduledSearch-V2024Id $Id -V2024TypedReference $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024UnsubscribeScheduledSearch -V2024Id $Id -V2024TypedReference $TypedReference + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnsubscribeScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $ScheduledSearch = @" + { + "owner" : { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "displayQueryDetails" : false, + "created" : "", + "description" : "Daily disabled accounts", + "ownerId" : "2c9180867624cbd7017642d8c8c81f67", + "enabled" : false, + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "recipients" : [ { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + } ], + "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", + "name" : "Daily disabled accounts", + "modified" : "", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "emailEmptyResults" : false + } + "@ + + # Update an existing Scheduled Search + + try { + $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch + Update-V2024ScheduledSearch-V2024Id $Id -V2024ScheduledSearch $Result + + # Below is a request that includes all optional parameters + # Update-V2024ScheduledSearch -V2024Id $Id -V2024ScheduledSearch $ScheduledSearch + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /search/aggregate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + } + "@ + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Perform a Search Query Aggregation + + try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-V2024Aggregate-V2024Search $Result + + # Below is a request that includes all optional parameters + # Search-V2024Aggregate -V2024Search $Search -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Aggregate" + Write-Host $_.ErrorDetails + } +- path: /search/count + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + } + "@ + + # Count Documents Satisfying a Query + + try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-V2024Count-V2024Search $Result + + # Below is a request that includes all optional parameters + # Search-V2024Count -V2024Search $Search + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Count" + Write-Host $_.ErrorDetails + } +- path: /search/{index}/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Get a Document by ID + + try { + Search-V2024Get-V2024Index $Index -V2024Id $Id + + # Below is a request that includes all optional parameters + # Search-V2024Get -V2024Index $Index -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Get" + Write-Host $_.ErrorDetails + } +- path: /search + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + } + "@ + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Perform Search + + try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-V2024Post-V2024Search $Result + + # Below is a request that includes all optional parameters + # Search-V2024Post -V2024Search $Search -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Post" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SearchAttributeConfig = @" + { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } + "@ + + # Create Extended Search Attributes + + try { + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-V2024SearchAttributeConfig-V2024SearchAttributeConfig $Result + + # Below is a request that includes all optional parameters + # New-V2024SearchAttributeConfig -V2024SearchAttributeConfig $SearchAttributeConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. + + # Delete Extended Search Attribute + + try { + Remove-V2024SearchAttributeConfig-V2024Name $Name + + # Below is a request that includes all optional parameters + # Remove-V2024SearchAttributeConfig -V2024Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Extended Search Attributes + + try { + Get-V2024SearchAttributeConfig + + # Below is a request that includes all optional parameters + # Get-V2024SearchAttributeConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to retrieve. + + # Get Extended Search Attribute + + try { + Get-V2024SingleSearchAttributeConfig-V2024Name $Name + + # Below is a request that includes all optional parameters + # Get-V2024SingleSearchAttributeConfig -V2024Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SingleSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Extended Search Attribute + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SearchAttributeConfig-V2024Name $Name -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SearchAttributeConfig -V2024Name $Name -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /segments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Segment = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + } + "@ + + # Create Segment + + try { + $Result = ConvertFrom-JsonToSegment -Json $Segment + New-V2024Segment-V2024Segment $Result + + # Below is a request that includes all optional parameters + # New-V2024Segment -V2024Segment $Segment + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Segment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + + # Delete Segment by ID + + try { + Remove-V2024Segment-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Segment -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Segment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + + # Get Segment by ID + + try { + Get-V2024Segment-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Segment -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segment" + Write-Host $_.ErrorDetails + } +- path: /segments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Segments + + try { + Get-V2024Segments + + # Below is a request that includes all optional parameters + # Get-V2024Segments -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segments" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. + $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ + + + # Update Segment + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2024Segment-V2024Id $Id -V2024RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024Segment -V2024Id $Id -V2024RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Segment" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } + "@ + + # Create new Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-V2024ServiceDeskIntegration-V2024ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # New-V2024ServiceDeskIntegration -V2024ServiceDeskIntegrationDto $ServiceDeskIntegrationDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "anId" # String | ID of Service Desk integration to delete + + # Delete a Service Desk integration + + try { + Remove-V2024ServiceDeskIntegration-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ServiceDeskIntegration -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "anId" # String | ID of the Service Desk integration to get + + # Get a Service Desk integration + + try { + Get-V2024ServiceDeskIntegration-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ServiceDeskIntegration -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + + # Service Desk integration template by scriptName + + try { + Get-V2024ServiceDeskIntegrationTemplate-V2024ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024ServiceDeskIntegrationTemplate -V2024ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrationTemplate" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Service Desk integration types + + try { + Get-V2024ServiceDeskIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-V2024ServiceDeskIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrationTypes" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "name eq "John Doe"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List existing Service Desk integrations + + try { + Get-V2024ServiceDeskIntegrations + + # Below is a request that includes all optional parameters + # Get-V2024ServiceDeskIntegrations -V2024Offset $Offset -V2024Limit $Limit -V2024Sorters $Sorters -V2024Filters $Filters -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrations" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get the time check configuration + + try { + Get-V2024StatusCheckDetails + + # Below is a request that includes all optional parameters + # Get-V2024StatusCheckDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $PatchServiceDeskIntegrationRequest = @" + + "@ + + # Patch a Service Desk Integration + + try { + $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest + Update-V2024ServiceDeskIntegration-V2024Id $Id -V2024PatchServiceDeskIntegrationRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024ServiceDeskIntegration -V2024Id $Id -V2024PatchServiceDeskIntegrationRequest $PatchServiceDeskIntegrationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } + "@ + + # Update a Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-V2024ServiceDeskIntegration-V2024Id $Id -V2024ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # Send-V2024ServiceDeskIntegration -V2024Id $Id -V2024ServiceDeskIntegrationDto $ServiceDeskIntegrationDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $QueuedCheckConfigDetails = @" + { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } + "@ + + # Update the time check configuration + + try { + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-V2024StatusCheckDetails-V2024QueuedCheckConfigDetails $Result + + # Below is a request that includes all optional parameters + # Update-V2024StatusCheckDetails -V2024QueuedCheckConfigDetails $QueuedCheckConfigDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024StatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Create new SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-V2024SIMIntegration-V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # New-V2024SIMIntegration -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $SimIntegrationDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "12345" # String | The id of the integration to delete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete a SIM integration + + try { + Remove-V2024SIMIntegration-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get a SIM integration details. + + try { + Get-V2024SIMIntegration-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List the existing SIM integrations. + + try { + Get-V2024SIMIntegrations-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SIMIntegrations -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegrations" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" + "@ + + # Patch a SIM beforeProvisioningRule attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024BeforeProvisioningRule-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024BeforeProvisioningRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $JsonPatch + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" + "@ + + # Patch a SIM attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024SIMAttributes-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024SIMAttributes -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $JsonPatch + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Update an existing SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + Send-V2024SIMIntegration-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # Send-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $SimIntegrationDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Create SOD policy + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-V2024SodPolicy-V2024SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-V2024SodPolicy -V2024SodPolicy $SodPolicy + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-V2024SodPolicy-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SodPolicy -V2024Id $Id -V2024Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-V2024SodPolicySchedule-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SodPolicySchedule -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. + + # Download custom violation report + + try { + Get-V2024CustomViolationReport-V2024ReportResultId $ReportResultId -V2024FileName $FileName + + # Below is a request that includes all optional parameters + # Get-V2024CustomViolationReport -V2024ReportResultId $ReportResultId -V2024FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-V2024DefaultViolationReport-V2024ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2024DefaultViolationReport -V2024ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get multi-report run task status + + try { + Get-V2024SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-V2024SodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodAllReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + + # Get SOD policy by ID + + try { + Get-V2024SodPolicy-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicy -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + + # Get SOD policy schedule + + try { + Get-V2024SodPolicySchedule-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicySchedule -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + + # Get violation report run status + + try { + Get-V2024SodViolationReportRunStatus-V2024ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2024SodViolationReportRunStatus -V2024ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + + # Get SOD violation report status + + try { + Get-V2024SodViolationReportStatus-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodViolationReportStatus -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + + # List SOD policies + + try { + Get-V2024SodPolicies + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicies -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicies" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch SOD policy by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SodPolicy-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SodPolicy -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-V2024PolicySchedule-V2024Id $Id -V2024SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-V2024PolicySchedule -V2024Id $Id -V2024SodPolicySchedule $SodPolicySchedule + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-V2024SodPolicy-V2024Id $Id -V2024SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-V2024SodPolicy -V2024Id $Id -V2024SodPolicy $SodPolicy + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Evaluate one policy by ID + + try { + Start-V2024EvaluateSodPolicy-V2024Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024EvaluateSodPolicy -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024EvaluateSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + } + "@ + + # Runs all policies for org + + try { + Start-V2024SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-V2024SodAllPoliciesForOrg -V2024MultiPolicyRequest $MultiPolicyRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-V2024SodPolicy-V2024Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024SodPolicy -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityWithNewAccess = @" + { + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-V2024PredictSodViolations-V2024IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-V2024PredictSodViolations -V2024IdentityWithNewAccess $IdentityWithNewAccess + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityWithNewAccess1 = @" + {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} + "@ + + # Check SOD violations + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-V2024ViolationCheck-V2024IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-V2024ViolationCheck -V2024IdentityWithNewAccess1 $IdentityWithNewAccess1 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + $ProvisioningPolicyDto = @" + { + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + } + "@ + + # Create Provisioning Policy + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + New-V2024ProvisioningPolicy-V2024SourceId $SourceId -V2024ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # New-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024ProvisioningPolicyDto $ProvisioningPolicyDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Source = @" + { + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + } + "@ + $ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) + + # Creates a source in IdentityNow. + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + New-V2024Source-V2024Source $Result + + # Below is a request that includes all optional parameters + # New-V2024Source -V2024Source $Source -V2024ProvisionAsCsv $ProvisionAsCsv + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schedules + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Schedule1 = @" + + "@ + + # Create Schedule on Source + + try { + $Result = ConvertFrom-JsonToSchedule1 -Json $Schedule1 + New-V2024SourceSchedule-V2024SourceId $SourceId -V2024Schedule1 $Result + + # Below is a request that includes all optional parameters + # New-V2024SourceSchedule -V2024SourceId $SourceId -V2024Schedule1 $Schedule1 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceSchedule" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Create Schema on Source + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + New-V2024SourceSchema-V2024SourceId $SourceId -V2024Schema $Result + + # Below is a request that includes all optional parameters + # New-V2024SourceSchema -V2024SourceId $SourceId -V2024Schema $Schema + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/remove-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ebbf35756e1140699ce52b233121384a" # String | The source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Remove All Accounts in a Source + + try { + Remove-V2024AccountsAsync-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024AccountsAsync -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountsAsync" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/native-change-detection-config + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete Native Change Detection Configuration + + try { + Remove-V2024NativeChangeDetectionConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024NativeChangeDetectionConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + # Delete Provisioning Policy by UsageType + + try { + Remove-V2024ProvisioningPolicy-V2024SourceId $SourceId -V2024UsageType $UsageType + + # Below is a request that includes all optional parameters + # Remove-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024UsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Delete Source by ID + + try { + Remove-V2024Source-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Source -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schedules/{scheduleType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. + + # Delete Source Schedule by type. + + try { + Remove-V2024SourceSchedule-V2024SourceId $SourceId -V2024ScheduleType $ScheduleType + + # Below is a request that includes all optional parameters + # Remove-V2024SourceSchedule -V2024SourceId $SourceId -V2024ScheduleType $ScheduleType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceSchedule" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + + # Delete Source Schema by ID + + try { + Remove-V2024SourceSchema-V2024SourceId $SourceId -V2024SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Remove-V2024SourceSchema -V2024SourceId $SourceId -V2024SchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + + # Downloads source accounts schema template + + try { + Get-V2024AccountsSchema-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccountsSchema -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/correlation-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + + # Get Source Correlation Configuration + + try { + Get-V2024CorrelationConfig-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CorrelationConfig -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CorrelationConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + + # Downloads source entitlements schema template + + try { + Get-V2024EntitlementsSchema-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementsSchema -V2024Id $Id -V2024SchemaName $SchemaName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/native-change-detection-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Native Change Detection Configuration + + try { + Get-V2024NativeChangeDetectionConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NativeChangeDetectionConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + # Get Provisioning Policy by UsageType + + try { + Get-V2024ProvisioningPolicy-V2024SourceId $SourceId -V2024UsageType $UsageType + + # Below is a request that includes all optional parameters + # Get-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024UsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Get Source by ID + + try { + Get-V2024Source-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Source -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/attribute-sync-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Attribute Sync Config + + try { + Get-V2024SourceAttrSyncConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SourceAttrSyncConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceAttrSyncConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/connectors/source-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "MyId" # String | The Source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Gets source config with language translations + + try { + Get-V2024SourceConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SourceConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/entitlement-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Source Entitlement Request Configuration + + try { + Get-V2024SourceEntitlementRequestConfig-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SourceEntitlementRequestConfig -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/source-health + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + + # Fetches source health by id + + try { + Get-V2024SourceHealth-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024SourceHealth -V2024SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceHealth" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schedules/{scheduleType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. + + # Get Source Schedule by Type + + try { + Get-V2024SourceSchedule-V2024SourceId $SourceId -V2024ScheduleType $ScheduleType + + # Below is a request that includes all optional parameters + # Get-V2024SourceSchedule -V2024SourceId $SourceId -V2024ScheduleType $ScheduleType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchedule" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schedules + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # List Schedules on Source + + try { + Get-V2024SourceSchedules-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024SourceSchedules -V2024SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchedules" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + + # Get Source Schema by ID + + try { + Get-V2024SourceSchema-V2024SourceId $SourceId -V2024SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Get-V2024SourceSchema -V2024SourceId $SourceId -V2024SchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) + $IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional) + + # List Schemas on Source + + try { + Get-V2024SourceSchemas-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024SourceSchemas -V2024SourceId $SourceId -V2024IncludeTypes $IncludeTypes -V2024IncludeNames $IncludeNames + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchemas" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/load-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) + $DisableOptimization = "MyDisableOptimization" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) + + # Account Aggregation + + try { + Import-V2024Accounts-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Import-V2024Accounts -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024File $File -V2024DisableOptimization $DisableOptimization + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024Accounts" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $File = # System.IO.FileInfo | (optional) + + # Uploads source accounts schema template + + try { + Import-V2024AccountsSchema-V2024Id $Id + + # Below is a request that includes all optional parameters + # Import-V2024AccountsSchema -V2024Id $Id -V2024File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024AccountsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/upload-connector-file + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $File = # System.IO.FileInfo | (optional) + + # Upload connector file to source + + try { + Import-V2024ConnectorFile-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-V2024ConnectorFile -V2024SourceId $SourceId -V2024File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024ConnectorFile" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + $File = # System.IO.FileInfo | (optional) + + # Uploads source entitlements schema template + + try { + Import-V2024EntitlementsSchema-V2024Id $Id + + # Below is a request that includes all optional parameters + # Import-V2024EntitlementsSchema -V2024Id $Id -V2024SchemaName $SchemaName -V2024File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024EntitlementsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/load-uncorrelated-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $File = # System.IO.FileInfo | (optional) + + # Process Uncorrelated Accounts + + try { + Import-V2024UncorrelatedAccounts-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Import-V2024UncorrelatedAccounts -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024UncorrelatedAccounts" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + + # Lists ProvisioningPolicies + + try { + Get-V2024ProvisioningPolicies-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024ProvisioningPolicies -V2024SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProvisioningPolicies" + Write-Host $_.ErrorDetails + } +- path: /sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Employees"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) + $ForSubadmin = "name" # String | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) + $IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false) + + # Lists all sources in IdentityNow. + + try { + Get-V2024Sources + + # Below is a request that includes all optional parameters + # Get-V2024Sources -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters -V2024ForSubadmin $ForSubadmin -V2024IncludeIDNSource $IncludeIDNSource + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Sources" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/peek-resource-objects + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ResourceObjectsRequest = @" + { + "maxCount" : 100, + "objectType" : "group" + } + "@ + + # Peek source connector's resource objects + + try { + $Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest + Receive-V2024ResourceObjects-V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental -V2024ResourceObjectsRequest $Result + + # Below is a request that includes all optional parameters + # Receive-V2024ResourceObjects -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental -V2024ResourceObjectsRequest $ResourceObjectsRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Receive-V2024ResourceObjects" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/ping-cluster + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Ping cluster for source connector + + try { + Ping-V2024Cluster-V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Ping-V2024Cluster -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-V2024Cluster" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/correlation-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $CorrelationConfig = @" + { + "attributeAssignments" : [ { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + }, { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + } ], + "name" : "Source [source] Account Correlation", + "id" : "2c9180835d191a86015d28455b4a2329" + } + "@ + + # Update Source Correlation Configuration + + try { + $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig + Send-V2024CorrelationConfig-V2024Id $Id -V2024CorrelationConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024CorrelationConfig -V2024Id $Id -V2024CorrelationConfig $CorrelationConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024CorrelationConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/native-change-detection-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $NativeChangeDetectionConfig = @" + { + "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], + "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], + "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], + "allNonEntitlementAttributes" : false, + "allEntitlements" : false, + "enabled" : true + } + "@ + + # Update Native Change Detection Configuration + + try { + $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig + Send-V2024NativeChangeDetectionConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024NativeChangeDetectionConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024NativeChangeDetectionConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024NativeChangeDetectionConfig $NativeChangeDetectionConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024NativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $ProvisioningPolicyDto = @" + { + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + } + "@ + + # Update Provisioning Policy by UsageType + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Send-V2024ProvisioningPolicy-V2024SourceId $SourceId -V2024UsageType $UsageType -V2024ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Send-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024UsageType $UsageType -V2024ProvisioningPolicyDto $ProvisioningPolicyDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Source = @" + { + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + } + "@ + + # Update Source (Full) + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + Send-V2024Source-V2024Id $Id -V2024Source $Result + + # Below is a request that includes all optional parameters + # Send-V2024Source -V2024Id $Id -V2024Source $Source + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/attribute-sync-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AttrSyncSourceConfig = @" + { + "attributes" : [ { + "name" : "email", + "displayName" : "Email", + "enabled" : true, + "target" : "mail" + }, { + "name" : "firstname", + "displayName" : "First Name", + "enabled" : false, + "target" : "givenName" + } ], + "source" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + } + } + "@ + + # Update Attribute Sync Config + + try { + $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig + Send-V2024SourceAttrSyncConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024AttrSyncSourceConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024SourceAttrSyncConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024AttrSyncSourceConfig $AttrSyncSourceConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SourceAttrSyncConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Update Source Schema (Full) + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + Send-V2024SourceSchema-V2024SourceId $SourceId -V2024SchemaId $SchemaId -V2024Schema $Result + + # Below is a request that includes all optional parameters + # Send-V2024SourceSchema -V2024SourceId $SourceId -V2024SchemaId $SchemaId -V2024Schema $Schema + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/synchronize-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "MyId" # String | The Source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Synchronize single source attributes. + + try { + Sync-V2024AttributesForSource-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Sync-V2024AttributesForSource -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024AttributesForSource" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/test-configuration + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Test configuration for source connector + + try { + Test-V2024SourceConfiguration-V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Test-V2024SourceConfiguration -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SourceConfiguration" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/check-connection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Check connection for source connector. + + try { + Test-V2024SourceConnection-V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Test-V2024SourceConnection -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SourceConnection" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/password-policies + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $PasswordPolicyHoldersDtoInner = @""@ + + + # Update Password Policy + + try { + $Result = ConvertFrom-JsonToPasswordPolicyHoldersDtoInner -Json $PasswordPolicyHoldersDtoInner + Update-V2024PasswordPolicyHolders-V2024SourceId $SourceId -V2024PasswordPolicyHoldersDtoInner $Result + + # Below is a request that includes all optional parameters + # Update-V2024PasswordPolicyHolders -V2024SourceId $SourceId -V2024PasswordPolicyHoldersDtoInner $PasswordPolicyHoldersDtoInner + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PasswordPolicyHolders" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ProvisioningPolicyDto = @"{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }"@ + + + # Bulk Update Provisioning Policies + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Update-V2024ProvisioningPoliciesInBulk-V2024SourceId $SourceId -V2024ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Update-V2024ProvisioningPoliciesInBulk -V2024SourceId $SourceId -V2024ProvisioningPolicyDto $ProvisioningPolicyDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPoliciesInBulk" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Partial update of Provisioning Policy + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ProvisioningPolicy-V2024SourceId $SourceId -V2024UsageType $UsageType -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024UsageType $UsageType -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Source-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Source -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/entitlement-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceEntitlementRequestConfig = @" + { + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + } + "@ + + # Update Source Entitlement Request Configuration + + try { + $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig + Update-V2024SourceEntitlementRequestConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024SourceEntitlementRequestConfig $Result + + # Below is a request that includes all optional parameters + # Update-V2024SourceEntitlementRequestConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024SourceEntitlementRequestConfig $SourceEntitlementRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schedules/{scheduleType} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source Schedule (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SourceSchedule-V2024SourceId $SourceId -V2024ScheduleType $ScheduleType -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SourceSchedule -V2024SourceId $SourceId -V2024ScheduleType $ScheduleType -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchedule" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source Schema (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SourceSchema-V2024SourceId $SourceId -V2024SchemaId $SchemaId -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SourceSchema -V2024SourceId $SourceId -V2024SchemaId $SchemaId -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-V2024StatusBySourceId-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024StatusBySourceId -V2024SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusBySourceId" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns source usage insights + + try { + Get-V2024UsagesBySourceId-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024UsagesBySourceId -V2024SourceId $SourceId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesBySourceId" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ExportPayload = @" + { + "description" : "Export Job 1 Test" + } + "@ + + # Initiates configuration objects export job + + try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-V2024SpConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024ExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-V2024SpConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024ExportPayload $ExportPayload + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Download export job result. + + try { + Get-V2024SpConfigExport-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigExport -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get export job status + + try { + Get-V2024SpConfigExportStatus-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigExportStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Download import job result + + try { + Get-V2024SpConfigImport-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigImport -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get import job status + + try { + Get-V2024SpConfigImportStatus-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigImportStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) + $Options = @" + "@ + + # Initiates configuration objects import job + + try { + Import-V2024SpConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024Data $Data + + # Below is a request that includes all optional parameters + # Import-V2024SpConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024Data $Data -V2024Preview $Preview -V2024Options $Options + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get config object details + + try { + Get-V2024SpConfigObjects-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigObjects -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-batches/{batchId}/stats + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Submit Sed Batch Stats Request + + try { + Get-V2024SedBatchStats-V2024BatchId $BatchId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SedBatchStats -V2024BatchId $BatchId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatchStats" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-batches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List Sed Batch Request + + try { + Get-V2024SedBatches-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SedBatches -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatches" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-descriptions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = limit=25 # Int64 | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) + $Filters = "displayName co "Read and Write"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) + $Sorters = "sorters=displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) + $Count = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) + $CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) + $RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) + $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) + + # List Suggested Entitlement Descriptions + + try { + Get-V2024Seds-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Seds -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Filters $Filters -V2024Sorters $Sorters -V2024Count $Count -V2024CountOnly $CountOnly -V2024RequestedByAnyone $RequestedByAnyone -V2024ShowPendingStatusOnly $ShowPendingStatusOnly + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Seds" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-descriptions + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SedPatch = @"{ + "op" : "replace", + "path" : "status", + "value" : "approved" + }"@ + + + # Patch Suggested Entitlement Description + + try { + $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch + Update-V2024Sed-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SedPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024Sed -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SedPatch $SedPatch + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Sed" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-approvals + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SedApproval = @"{ + "items" : "016629d1-1d25-463f-97f3-c6686846650" + }"@ + + + # Submit Bulk Approval Request + + try { + $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval + Submit-V2024SedApproval-V2024XSailPointExperimental $XSailPointExperimental -V2024SedApproval $Result + + # Below is a request that includes all optional parameters + # Submit-V2024SedApproval -V2024XSailPointExperimental $XSailPointExperimental -V2024SedApproval $SedApproval + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedApproval" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-assignments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SedAssignment = @" + { + "assignee" : { + "type" : "SOURCE_OWNER", + "value" : "016629d1-1d25-463f-97f3-c6686846650" + }, + "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] + } + "@ + + # Submit Sed Assignment Request + + try { + $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment + Submit-V2024SedAssignment-V2024XSailPointExperimental $XSailPointExperimental -V2024SedAssignment $Result + + # Below is a request that includes all optional parameters + # Submit-V2024SedAssignment -V2024XSailPointExperimental $XSailPointExperimental -V2024SedAssignment $SedAssignment + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedAssignment" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-batches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SedBatchRequest = @" + { + "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + } + "@ + + # Submit Sed Batch Request + + try { + Submit-V2024SedBatchRequest-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Submit-V2024SedBatchRequest -V2024XSailPointExperimental $XSailPointExperimental -V2024SedBatchRequest $SedBatchRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedBatchRequest" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "ACCESS_PROFILE" # String | The type of object to delete tags from. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from. + + # Delete Object Tags + + try { + Remove-V2024TaggedObject-V2024Type $Type -V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024TaggedObject -V2024Type $Type -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/bulk-remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $BulkRemoveTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Remove Tags from Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject + Remove-V2024TagsToManyObject-V2024BulkRemoveTaggedObject $Result + + # Below is a request that includes all optional parameters + # Remove-V2024TagsToManyObject -V2024BulkRemoveTaggedObject $BulkRemoveTaggedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TagsToManyObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + + # Get Tagged Object + + try { + Get-V2024TaggedObject-V2024Type $Type -V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024TaggedObject -V2024Type $Type -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "tagName eq "BU_FINANCE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + + # List Tagged Objects + + try { + Get-V2024TaggedObjects + + # Below is a request that includes all optional parameters + # Get-V2024TaggedObjects -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObjects" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "objectRef.id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + + # List Tagged Objects by Type + + try { + Get-V2024TaggedObjectsByType-V2024Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024TaggedObjectsByType -V2024Type $Type -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObjectsByType" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to update. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to update. + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Update Tagged Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Send-V2024TaggedObject-V2024Type $Type -V2024Id $Id -V2024TaggedObject $Result + + # Below is a request that includes all optional parameters + # Send-V2024TaggedObject -V2024Type $Type -V2024Id $Id -V2024TaggedObject $TaggedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Add Tag to Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Set-V2024TagToObject-V2024TaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-V2024TagToObject -V2024TaggedObject $TaggedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagToObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/bulk-add + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $BulkAddTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Tag Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject + Set-V2024TagsToManyObjects-V2024BulkAddTaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-V2024TagsToManyObjects -V2024BulkAddTaggedObject $BulkAddTaggedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagsToManyObjects" + Write-Host $_.ErrorDetails + } +- path: /task-status/pending-tasks + method: HEAD + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieve Pending Task List Headers + + try { + Get-V2024PendingTaskHeaders-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PendingTaskHeaders -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingTaskHeaders" + Write-Host $_.ErrorDetails + } +- path: /task-status/pending-tasks + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieve Pending Task Status List + + try { + Get-V2024PendingTasks-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PendingTasks -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingTasks" + Write-Host $_.ErrorDetails + } +- path: /task-status/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Task Status by ID + + try { + Get-V2024TaskStatus-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024TaskStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaskStatus" + Write-Host $_.ErrorDetails + } +- path: /task-status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "completionStatus eq "Success"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) + $Sorters = "-created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) + + # Retrieve Task Status List + + try { + Get-V2024TaskStatusList-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024TaskStatusList -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaskStatusList" + Write-Host $_.ErrorDetails + } +- path: /task-status/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Task Status by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024TaskStatus-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024TaskStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024TaskStatus" + Write-Host $_.ErrorDetails + } +- path: /tenant + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Tenant Information. + + try { + Get-V2024Tenant-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Tenant -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Tenant" + Write-Host $_.ErrorDetails + } +- path: /transforms + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Create transform + + try { + $Result = ConvertFrom-JsonToTransform -Json $Transform + New-V2024Transform-V2024Transform $Result + + # Below is a request that includes all optional parameters + # New-V2024Transform -V2024Transform $Transform + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Transform" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete + + # Delete a transform + + try { + Remove-V2024Transform-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Transform -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Transform" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve + + # Transform by ID + + try { + Get-V2024Transform-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Transform -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Transform" + Write-Host $_.ErrorDetails + } +- path: /transforms + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional) + $Filters = "name eq "Uppercase"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) + + # List transforms + + try { + Get-V2024Transforms + + # Below is a request that includes all optional parameters + # Get-V2024Transforms -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Name $Name -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Transforms" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Update a transform + + try { + Update-V2024Transform-V2024Id $Id + + # Below is a request that includes all optional parameters + # Update-V2024Transform -V2024Id $Id -V2024Transform $Transform + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Transform" + Write-Host $_.ErrorDetails + } +- path: /trigger-invocations/{id}/complete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the invocation to complete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CompleteInvocation = @" + { + "output" : { + "approved" : false + }, + "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "error" : "Access request is denied." + } + "@ + + # Complete Trigger Invocation + + try { + $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation + Complete-V2024TriggerInvocation-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024CompleteInvocation $Result + + # Below is a request that includes all optional parameters + # Complete-V2024TriggerInvocation -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024CompleteInvocation $CompleteInvocation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024TriggerInvocation" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SubscriptionPostRequest = @" + { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "triggerId" : "idn:access-requested", + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + } + "@ + + # Create a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest + New-V2024Subscription-V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPostRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024Subscription -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPostRequest $SubscriptionPostRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Subscription" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete a Subscription + + try { + Remove-V2024Subscription-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024Subscription -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Subscription" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional) + $Sorters = "triggerName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) + + # List Subscriptions + + try { + Get-V2024Subscriptions-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Subscriptions -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Subscriptions" + Write-Host $_.ErrorDetails + } +- path: /trigger-invocations/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "triggerId eq "idn:access-request-dynamic-approver"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) + + # List Latest Invocation Statuses + + try { + Get-V2024TriggerInvocationStatus-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024TriggerInvocationStatus -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TriggerInvocationStatus" + Write-Host $_.ErrorDetails + } +- path: /triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "idn:access-request-post-approval"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** (optional) + + # List Triggers + + try { + Get-V2024Triggers-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Triggers -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Triggers" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription to patch + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SubscriptionPatchRequestInner = @""@ + + + # Patch a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner + Update-V2024Subscription-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPatchRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-V2024Subscription -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPatchRequestInner $SubscriptionPatchRequestInner + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription" + Write-Host $_.ErrorDetails + } +- path: /trigger-invocations/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TestInvocation = @" + { + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + }, + "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], + "triggerId" : "idn:access-request-post-approval", + "contentJson" : { + "workflowId" : 1234 + } + } + "@ + + # Start a Test Invocation + + try { + $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation + Start-V2024TestTriggerInvocation-V2024XSailPointExperimental $XSailPointExperimental -V2024TestInvocation $Result + + # Below is a request that includes all optional parameters + # Start-V2024TestTriggerInvocation -V2024XSailPointExperimental $XSailPointExperimental -V2024TestInvocation $TestInvocation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024TestTriggerInvocation" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/validate-filter + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ValidateFilterInputDto = @" + { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + } + } + "@ + + # Validate a Subscription Filter + + try { + $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto + Test-V2024SubscriptionFilter-V2024XSailPointExperimental $XSailPointExperimental -V2024ValidateFilterInputDto $Result + + # Below is a request that includes all optional parameters + # Test-V2024SubscriptionFilter -V2024XSailPointExperimental $XSailPointExperimental -V2024ValidateFilterInputDto $ValidateFilterInputDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SubscriptionFilter" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SubscriptionPutRequest = @" + { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + } + "@ + + # Update a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest + Update-V2024Subscription-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPutRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024Subscription -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPutRequest $SubscriptionPutRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription" + Write-Host $_.ErrorDetails + } +- path: /ui-metadata/tenant + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get a tenant UI metadata + + try { + Get-V2024TenantUiMetadata-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024TenantUiMetadata -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantUiMetadata" + Write-Host $_.ErrorDetails + } +- path: /ui-metadata/tenant + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TenantUiMetadataItemUpdateRequest = @" + { + "usernameEmptyText" : "Please provide your work email address...", + "usernameLabel" : "Email", + "iframeWhiteList" : "http://example.com http://example2.com" + } + "@ + + # Update tenant UI metadata + + try { + $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest + Set-V2024TenantUiMetadata-V2024XSailPointExperimental $XSailPointExperimental -V2024TenantUiMetadataItemUpdateRequest $Result + + # Below is a request that includes all optional parameters + # Set-V2024TenantUiMetadata -V2024XSailPointExperimental $XSailPointExperimental -V2024TenantUiMetadataItemUpdateRequest $TenantUiMetadataItemUpdateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TenantUiMetadata" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $VendorConnectorMapping = @" + { + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + } + "@ + + # Create Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + New-V2024VendorConnectorMapping-V2024VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # New-V2024VendorConnectorMapping -V2024VendorConnectorMapping $VendorConnectorMapping + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VendorConnectorMapping" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $VendorConnectorMapping = @" + { + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + } + "@ + + # Delete Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + Remove-V2024VendorConnectorMapping-V2024VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # Remove-V2024VendorConnectorMapping -V2024VendorConnectorMapping $VendorConnectorMapping + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024VendorConnectorMapping" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Vendor Connector Mappings + + try { + Get-V2024VendorConnectorMappings + + # Below is a request that includes all optional parameters + # Get-V2024VendorConnectorMappings + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024VendorConnectorMappings" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-V2024WorkflowExecution-V2024Id $Id + + # Below is a request that includes all optional parameters + # Suspend-V2024WorkflowExecution -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $CreateExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + New-V2024ExternalExecuteWorkflow-V2024Id $Id + + # Below is a request that includes all optional parameters + # New-V2024ExternalExecuteWorkflow -V2024Id $Id -V2024CreateExternalExecuteWorkflowRequest $CreateExternalExecuteWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreateWorkflowRequest = @" + {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-V2024Workflow-V2024CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024Workflow -V2024CreateWorkflowRequest $CreateWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + New-V2024WorkflowExternalTrigger-V2024Id $Id + + # Below is a request that includes all optional parameters + # New-V2024WorkflowExternalTrigger -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024WorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-V2024Workflow-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Workflow -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Get Workflow By Id + + try { + Get-V2024Workflow-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Workflow -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-V2024WorkflowExecution-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecution -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + + # Get Workflow Execution History + + try { + Get-V2024WorkflowExecutionHistory-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecutionHistory -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-V2024WorkflowExecutions-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecutions -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Complete Workflow Library + + try { + Get-V2024CompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-V2024CompleteWorkflowLibrary -V2024Limit $Limit -V2024Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Actions + + try { + Get-V2024WorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryActions -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Workflow Library Operators + + try { + Get-V2024WorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Triggers + + try { + Get-V2024WorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryTriggers -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Workflows + + try { + Get-V2024Workflows + + # Below is a request that includes all optional parameters + # Get-V2024Workflows + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Workflow-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Workflow -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-V2024Workflow-V2024Id $Id -V2024WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-V2024Workflow -V2024Id $Id -V2024WorkflowBody $WorkflowBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-V2024ExternalExecuteWorkflow-V2024Id $Id + + # Below is a request that includes all optional parameters + # Test-V2024ExternalExecuteWorkflow -V2024Id $Id -V2024TestExternalExecuteWorkflowRequest $TestExternalExecuteWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-V2024Workflow-V2024Id $Id -V2024TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-V2024Workflow -V2024Id $Id -V2024TestWorkflowRequest $TestWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Approve an Approval Item + + try { + Approve-V2024ApprovalItem-V2024Id $Id -V2024ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Approve-V2024ApprovalItem -V2024Id $Id -V2024ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk approve Approval Items + + try { + Approve-V2024ApprovalItemsInBulk-V2024Id $Id + + # Below is a request that includes all optional parameters + # Approve-V2024ApprovalItemsInBulk -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Complete a Work Item + + try { + Complete-V2024WorkItem-V2024Id $Id + + # Below is a request that includes all optional parameters + # Complete-V2024WorkItem -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024WorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Completed Work Items + + try { + Get-V2024CompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-V2024CompletedWorkItems -V2024OwnerId $OwnerId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # Count Completed Work Items + + try { + Get-V2024CountCompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-V2024CountCompletedWorkItems -V2024OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountCompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) + + # Count Work Items + + try { + Get-V2024CountWorkItems + + # Below is a request that includes all optional parameters + # Get-V2024CountWorkItems -V2024OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. + + # Get a Work Item + + try { + Get-V2024WorkItem-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkItem -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # Work Items Summary + + try { + Get-V2024WorkItemsSummary + + # Below is a request that includes all optional parameters + # Get-V2024WorkItemsSummary -V2024OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItemsSummary" + Write-Host $_.ErrorDetails + } +- path: /work-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # List Work Items + + try { + Get-V2024WorkItems + + # Below is a request that includes all optional parameters + # Get-V2024WorkItems -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Reject an Approval Item + + try { + Deny-V2024ApprovalItem-V2024Id $Id -V2024ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Deny-V2024ApprovalItem -V2024Id $Id -V2024ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk reject Approval Items + + try { + Deny-V2024ApprovalItemsInBulk-V2024Id $Id + + # Below is a request that includes all optional parameters + # Deny-V2024ApprovalItemsInBulk -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $WorkItemForward = @" + { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } + "@ + + # Forward a Work Item + + try { + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Send-V2024WorkItemForward-V2024Id $Id -V2024WorkItemForward $Result + + # Below is a request that includes all optional parameters + # Send-V2024WorkItemForward -V2024Id $Id -V2024WorkItemForward $WorkItemForward + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024WorkItemForward" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName + + # Submit Account Selections + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-V2024AccountSelection-V2024Id $Id -V2024RequestBody $Result + + # Below is a request that includes all optional parameters + # Submit-V2024AccountSelection -V2024Id $Id -V2024RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024AccountSelection" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ + + # Create a Reassignment Configuration + + try { + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + New-V2024ReassignmentConfiguration-V2024XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ReassignmentConfiguration -V2024XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $ConfigurationItemRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId}/{configType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete Reassignment Configuration + + try { + Remove-V2024ReassignmentConfiguration-V2024IdentityId $IdentityId -V2024ConfigType $ConfigType -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024ReassignmentConfiguration -V2024IdentityId $IdentityId -V2024ConfigType $ConfigType -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId}/evaluate/{configType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) + + $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ + + # Evaluate Reassignment Configuration + + try { + Get-V2024EvaluateReassignmentConfiguration-V2024IdentityId $IdentityId -V2024ConfigType $ConfigType -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EvaluateReassignmentConfiguration -V2024IdentityId $IdentityId -V2024ConfigType $ConfigType -V2024XSailPointExperimental $XSailPointExperimental -V2024ExclusionFilters $ExclusionFilters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EvaluateReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List Reassignment Config Types + + try { + Get-V2024ReassignmentConfigTypes-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ReassignmentConfigTypes -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigTypes" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Reassignment Configuration + + try { + Get-V2024ReassignmentConfiguration-V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ReassignmentConfiguration -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/tenant-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Tenant-wide Reassignment Configuration settings + + try { + Get-V2024TenantConfigConfiguration-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024TenantConfigConfiguration -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantConfigConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List Reassignment Configurations + + try { + Get-V2024ReassignmentConfigurations-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ReassignmentConfigurations -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigurations" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ + + # Update Reassignment Configuration + + try { + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + Send-V2024ReassignmentConfig-V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2024ReassignmentConfig -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $ConfigurationItemRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ReassignmentConfig" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/tenant-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TenantConfigurationRequest = @" + { + "configDetails" : { + "disabled" : true + } + } + "@ + + # Update Tenant-wide Reassignment Configuration settings + + try { + $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest + Send-V2024TenantConfiguration-V2024XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2024TenantConfiguration -V2024XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $TenantConfigurationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TenantConfiguration" + Write-Host $_.ErrorDetails + } diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccessModelMetadataApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccessModelMetadataApi.md new file mode 100644 index 000000000..541c8b3c4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccessModelMetadataApi.md @@ -0,0 +1,213 @@ + +--- +id: v2024-access-model-metadata +title: AccessModelMetadata +pagination_label: AccessModelMetadata +sidebar_label: AccessModelMetadata +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessModelMetadata', 'V2024AccessModelMetadata'] +slug: /tools/sdk/powershell/v2024/methods/access-model-metadata +tags: ['SDK', 'Software Development Kit', 'AccessModelMetadata', 'V2024AccessModelMetadata'] +--- + +# AccessModelMetadata + Use this API to create and manage metadata attributes for your Access Model. +Access Model Metadata allows you to add contextual information to your ISC Access Model items using pre-defined metadata for risk, regulations, privacy levels, etc., or by creating your own metadata attributes to reflect the unique needs of your organization. This release of the API includes support for entitlement metadata. Support for role and access profile metadata will be introduced in a subsequent release. + +Common usages for Access Model metadata include: + +- Organizing and categorizing access items to make it easier for your users to search for and find the access rights they want to request, certify, or manage. + +- Providing richer information about access that is being acted on to allow stakeholders to make better decisions when approving, certifying, or managing access rights. + +- Identifying access that may requires additional approval requirements or be subject to more frequent review. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024AccessModelMetadataAttribute**](#get-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes/{key}` | Get Access Model Metadata Attribute +[**Get-V2024AccessModelMetadataAttributeValue**](#get-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values/{value}` | Get Access Model Metadata Value +[**Get-V2024AccessModelMetadataAttribute**](#list-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes` | List Access Model Metadata Attributes +[**Get-V2024AccessModelMetadataAttributeValue**](#list-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values` | List Access Model Metadata Values + +## get-access-model-metadata-attribute +Get single Access Model Metadata Attribute + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Key | **String** | True | Technical name of the Attribute. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**AttributeDTO**](../models/attribute-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | OK | AttributeDTO +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Key = "iscPrivacy" # String | Technical name of the Attribute. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get Access Model Metadata Attribute + +try { + Get-V2024AccessModelMetadataAttribute-V2024Key $Key -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessModelMetadataAttribute -V2024Key $Key -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-access-model-metadata-attribute-value +Get single Access Model Metadata Attribute Value + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Key | **String** | True | Technical name of the Attribute. +Path | Value | **String** | True | Technical name of the Attribute value. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**AttributeValueDTO**](../models/attribute-value-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | OK | AttributeValueDTO +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Key = "iscPrivacy" # String | Technical name of the Attribute. +$Value = "public" # String | Technical name of the Attribute value. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get Access Model Metadata Value + +try { + Get-V2024AccessModelMetadataAttributeValue-V2024Key $Key -V2024Value $Value -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessModelMetadataAttributeValue -V2024Key $Key -V2024Value $Value -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-access-model-metadata-attribute +Get a list of Access Model Metadata Attributes + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* + +### Return type +[**AttributeDTO[]**](../models/attribute-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | OK | AttributeDTO[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Filters = 'name eq "Privacy"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) + +# List Access Model Metadata Attributes + +try { + Get-V2024AccessModelMetadataAttribute-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessModelMetadataAttribute -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-access-model-metadata-attribute-value +Get a list of Access Model Metadata Attribute Values + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Key | **String** | True | Technical name of the Attribute. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**AttributeValueDTO[]**](../models/attribute-value-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | OK | AttributeValueDTO[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Key = "iscPrivacy" # String | Technical name of the Attribute. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# List Access Model Metadata Values + +try { + Get-V2024AccessModelMetadataAttributeValue-V2024Key $Key -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessModelMetadataAttributeValue -V2024Key $Key -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccessProfilesApi.md new file mode 100644 index 000000000..7de7bbb44 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccessProfilesApi.md @@ -0,0 +1,574 @@ + +--- +id: v2024-access-profiles +title: AccessProfiles +pagination_label: AccessProfiles +sidebar_label: AccessProfiles +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfiles', 'V2024AccessProfiles'] +slug: /tools/sdk/powershell/v2024/methods/access-profiles +tags: ['SDK', 'Software Development Kit', 'AccessProfiles', 'V2024AccessProfiles'] +--- + +# AccessProfiles + Use this API to implement and customize access profile functionality. +With this functionality in place, administrators can create access profiles and configure them for use throughout Identity Security Cloud, enabling users to get the access they need quickly and securely. + +Access profiles group entitlements, which represent access rights on sources. + +For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +Access profiles are the most important units of access in Identity Security Cloud. Identity Security Cloud uses access profiles in many features, including the following: + +- Provisioning: When you use the Provisioning Service, lifecycle states and roles both grant access to users in the form of access profiles. + +- Certifications: You can approve or revoke access profiles in certification campaigns, just like entitlements. + +- Access Requests: You can assign access profiles to applications, and when a user requests access to the app associated with an access profile and someone approves the request, access is granted to both the application and its associated access profile. + +- Roles: You can group one or more access profiles into a role to quickly assign access items based on an identity's role. + +In Identity Security Cloud, administrators can use the Access drop-down menu and select Access Profiles to view, configure, and delete existing access profiles, as well as create new ones. +Administrators can enable and disable an access profile, and they can also make the following configurations: + +- Manage Entitlements: Manage the profile's access by adding and removing entitlements. + +- Access Requests: Configure access profiles to be requestable and establish an approval process for any requests that the access profile be granted or revoked. +Do not configure an access profile to be requestable without first establishing a secure access request approval process for the access profile. + +- Multiple Account Options: Define the logic Identity Security Cloud uses to provision access to an identity with multiple accounts on the source. + +Refer to [Managing Access Profiles](https://documentation.sailpoint.com/saas/help/access/access-profiles.html) for more information about access profiles. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024AccessProfile**](#create-access-profile) | **POST** `/access-profiles` | Create Access Profile +[**Remove-V2024AccessProfile**](#delete-access-profile) | **DELETE** `/access-profiles/{id}` | Delete the specified Access Profile +[**Remove-V2024AccessProfilesInBulk**](#delete-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-delete` | Delete Access Profile(s) +[**Get-V2024AccessProfile**](#get-access-profile) | **GET** `/access-profiles/{id}` | Get an Access Profile +[**Get-V2024AccessProfileEntitlements**](#get-access-profile-entitlements) | **GET** `/access-profiles/{id}/entitlements` | List Access Profile's Entitlements +[**Get-V2024AccessProfiles**](#list-access-profiles) | **GET** `/access-profiles` | List Access Profiles +[**Update-V2024AccessProfile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified Access Profile +[**Update-V2024AccessProfilesInBulk**](#update-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-update-requestable` | Update Access Profile(s) requestable field. + +## create-access-profile +Use this API to create an access profile. +A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source. +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | AccessProfile | [**AccessProfile**](../models/access-profile) | True | + +### Return type +[**AccessProfile**](../models/access-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Access profile created. | AccessProfile +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$AccessProfile = @"{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "description" : "Collection of entitlements to read/write the employee database", + "source" : { + "name" : "ODS-AD-SOURCE", + "id" : "2c91809773dee3610173fdb0b6061ef4", + "type" : "SOURCE" + }, + "enabled" : true, + "revocationRequestConfig" : { + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ] + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "accessRequestConfig" : { + "commentsRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "name" : "Employee-database-read-write", + "provisioningCriteria" : { + "children" : [ { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, + "modified" : "2021-03-02T20:22:28.104Z", + "id" : "2c91808a7190d06e01719938fcd20792", + "requestable" : true +}"@ + +# Create Access Profile + +try { + $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile + New-V2024AccessProfile-V2024AccessProfile $Result + + # Below is a request that includes all optional parameters + # New-V2024AccessProfile -V2024AccessProfile $AccessProfile +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-access-profile +This API deletes an existing Access Profile. + +The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. + +A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Access Profile to delete + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Returned when an access profile cannot be deleted as it's being used. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete + +# Delete the specified Access Profile + +try { + Remove-V2024AccessProfile-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024AccessProfile -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-access-profiles-in-bulk +This endpoint initiates a bulk deletion of one or more access profiles. +When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. +This endpoint can only bulk delete up to a limit of 50 access profiles per request. +By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. +A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they're able to administer. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | AccessProfileBulkDeleteRequest | [**AccessProfileBulkDeleteRequest**](../models/access-profile-bulk-delete-request) | True | + +### Return type +[**AccessProfileBulkDeleteResponse**](../models/access-profile-bulk-delete-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returned only if **bestEffortOnly** is **false**, and one or more Access Profiles are in use. | AccessProfileBulkDeleteResponse +202 | Returned if at least one deletion will be performed. | AccessProfileBulkDeleteResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$AccessProfileBulkDeleteRequest = @"{ + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true +}"@ + +# Delete Access Profile(s) + +try { + $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest + Remove-V2024AccessProfilesInBulk-V2024AccessProfileBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024AccessProfilesInBulk -V2024AccessProfileBulkDeleteRequest $AccessProfileBulkDeleteRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfilesInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-access-profile +This API returns an Access Profile by its ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Access Profile + +### Return type +[**AccessProfile**](../models/access-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An AccessProfile | AccessProfile +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile + +# Get an Access Profile + +try { + Get-V2024AccessProfile-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccessProfile -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-access-profile-entitlements +Use this API to get a list of an access profile's entitlements. +A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. +>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the access profile containing the entitlements. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** + +### Return type +[**Entitlement[]**](../models/entitlement) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of entitlements. | Entitlement[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements. +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'attribute eq "memberOf"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + +# List Access Profile's Entitlements + +try { + Get-V2024AccessProfileEntitlements-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccessProfileEntitlements -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfileEntitlements" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-access-profiles +Use this API to get a list of access profiles. +>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | ForSubadmin | **String** | (optional) | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin. + Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Composite operators supported: *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** + Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. + Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. + +### Return type +[**AccessProfile[]**](../models/access-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of access profiles. | AccessProfile[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin. (optional) +$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'name eq "SailPoint Support"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Composite operators supported: *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) +$ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) +$IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + +# List Access Profiles + +try { + Get-V2024AccessProfiles + + # Below is a request that includes all optional parameters + # Get-V2024AccessProfiles -V2024ForSubadmin $ForSubadmin -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters -V2024ForSegmentIds $ForSegmentIds -V2024IncludeUnsegmented $IncludeUnsegmented +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfiles" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-access-profile +This API updates an existing Access Profile. The following fields are patchable: + +**name** + +**description** + +**enabled** + +**owner** + +**requestable** + +**accessRequestConfig** + +**revokeRequestConfig** + +**segments** + +**entitlements** + +**provisioningCriteria** + +**source** (must be updated with entitlements belonging to new source in the same API call) + +If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example "Replace Source" in the examples dropdown. + +A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. +> The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. + +> You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Access Profile to patch + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**AccessProfile**](../models/access-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the Access Profile as updated. | AccessProfile +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | + + +# Patch a specified Access Profile + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AccessProfile-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AccessProfile -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AccessProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-access-profiles-in-bulk +This API initiates a bulk update of field requestable for one or more Access Profiles. + +> If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** + list of the response.Requestable field of these Access Profiles marked as **true** or **false**. + +> If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. + A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | AccessProfileBulkUpdateRequestInner | [**[]AccessProfileBulkUpdateRequestInner**](../models/access-profile-bulk-update-request-inner) | True | + +### Return type +[**AccessProfileUpdateItem[]**](../models/access-profile-update-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +207 | List of updated and not updated Access Profiles. | AccessProfileUpdateItem[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +412 | Precondition Failed - Returned in response if API/Feature not enabled for an organization. | UpdateAccessProfilesInBulk412Response +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ # AccessProfileBulkUpdateRequestInner[] | + + +# Update Access Profile(s) requestable field. + +try { + $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner + Update-V2024AccessProfilesInBulk-V2024XSailPointExperimental $XSailPointExperimental -V2024AccessProfileBulkUpdateRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-V2024AccessProfilesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessProfileBulkUpdateRequestInner $AccessProfileBulkUpdateRequestInner +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AccessProfilesInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccessRequestApprovalsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccessRequestApprovalsApi.md new file mode 100644 index 000000000..d01e46321 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccessRequestApprovalsApi.md @@ -0,0 +1,399 @@ + +--- +id: v2024-access-request-approvals +title: AccessRequestApprovals +pagination_label: AccessRequestApprovals +sidebar_label: AccessRequestApprovals +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestApprovals', 'V2024AccessRequestApprovals'] +slug: /tools/sdk/powershell/v2024/methods/access-request-approvals +tags: ['SDK', 'Software Development Kit', 'AccessRequestApprovals', 'V2024AccessRequestApprovals'] +--- + +# AccessRequestApprovals + Use this API to implement and customize access request approval functionality. +With this functionality in place, administrators can delegate qualified users to review users' requests for access or managers' requests to revoke team members' access to applications, entitlements, or roles. +This enables more qualified users to review access requests and the others to spend their time on other tasks. + +In Identity Security Cloud, users can request access to applications, entitlements, and roles, and managers can request that team members' access be revoked. +For applications and entitlements, administrators can set access profiles to require approval from the access profile owner, the application owner, the source owner, the requesting user's manager, or a governance group for access to be granted or revoked. +For roles, administrators can also set roles to allow access requests and require approval from the role owner, the requesting user's manager, or a governance group for access to be granted or revoked. +If the administrator designates a governance group as the required approver, any governance group member can approve the requests. + +When a user submits an access request, Identity Security Cloud sends the first required approver in the queue an email notification, based on the access request configuration's approval and reminder escalation configuration. + +In Approvals in Identity Security Cloud, required approvers can view pending access requests under the Requested tab and approve or deny them, or the approvers can reassign the requests to different reviewers for approval. +If the required approver approves the request and is the only reviewer required, Identity Security Cloud grants or revokes access, based on the request. +If multiple reviewers are required, Identity Security Cloud sends the request to the next reviewer in the queue, based on the access request configuration's approval reminder and escalation configuration. +The required approver can then view any completed access requests under the Reviewed tab. + +Refer to [Access Requests](https://documentation.sailpoint.com/saas/help/requests/index.html) for more information about access request approvals. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Approve-V2024AccessRequest**](#approve-access-request) | **POST** `/access-request-approvals/{approvalId}/approve` | Approve Access Request Approval +[**Invoke-V2024ForwardAccessRequest**](#forward-access-request) | **POST** `/access-request-approvals/{approvalId}/forward` | Forward Access Request Approval +[**Get-V2024AccessRequestApprovalSummary**](#get-access-request-approval-summary) | **GET** `/access-request-approvals/approval-summary` | Get Access Requests Approvals Number +[**Get-V2024AccessRequestApprovers**](#list-access-request-approvers) | **GET** `/access-request-approvals/{accessRequestId}/approvers` | Access Request Approvers +[**Get-V2024CompletedApprovals**](#list-completed-approvals) | **GET** `/access-request-approvals/completed` | Completed Access Request Approvals List +[**Get-V2024PendingApprovals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending Access Request Approvals List +[**Deny-V2024AccessRequest**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval + +## approve-access-request +Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ApprovalId | **String** | True | Approval ID. + Body | CommentDto | [**CommentDto**](../models/comment-dto) | (optional) | Reviewer's comment. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. +$CommentDto = @"{ + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." +}"@ + +# Approve Access Request Approval + +try { + Approve-V2024AccessRequest-V2024ApprovalId $ApprovalId + + # Below is a request that includes all optional parameters + # Approve-V2024AccessRequest -V2024ApprovalId $ApprovalId -V2024CommentDto $CommentDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024AccessRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## forward-access-request +Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ApprovalId | **String** | True | Approval ID. + Body | ForwardApprovalDto | [**ForwardApprovalDto**](../models/forward-approval-dto) | True | Information about the forwarded approval. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. +$ForwardApprovalDto = @"{ + "newOwnerId" : "2c91808568c529c60168cca6f90c1314", + "comment" : "2c91808568c529c60168cca6f90c1313" +}"@ + +# Forward Access Request Approval + +try { + $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto + Invoke-V2024ForwardAccessRequest-V2024ApprovalId $ApprovalId -V2024ForwardApprovalDto $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024ForwardAccessRequest -V2024ApprovalId $ApprovalId -V2024ForwardApprovalDto $ForwardApprovalDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ForwardAccessRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-access-request-approval-summary +Use this API to return the number of pending, approved and rejected access requests approvals. See the "owner-id" query parameter for authorization information. info. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | OwnerId | **String** | (optional) | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. + Query | FromDate | **String** | (optional) | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. + +### Return type +[**ApprovalSummary**](../models/approval-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Number of pending, approved, rejected access request approvals. | ApprovalSummary +400 | Client Error - Returned if the query parameter is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OwnerId = "2c91808568c529c60168cca6f90c1313" # String | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) +$FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + +# Get Access Requests Approvals Number + +try { + Get-V2024AccessRequestApprovalSummary + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestApprovalSummary -V2024OwnerId $OwnerId -V2024FromDate $FromDate +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestApprovalSummary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-access-request-approvers +This API endpoint returns the list of approvers for the given access request id. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | AccessRequestId | **String** | True | Access Request ID. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. + Query | Offset | **Int32** | (optional) | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. + Query | Count | **Boolean** | (optional) (default to $false) | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. + +### Return type +[**AccessRequestApproversListResponse[]**](../models/access-request-approvers-list-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Approvers. | AccessRequestApproversListResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$AccessRequestId = "2c91808568c529c60168cca6f90c1313" # String | Access Request ID. +$Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) +$Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) +$Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) + +# Access Request Approvers + +try { + Get-V2024AccessRequestApprovers-V2024AccessRequestId $AccessRequestId + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestApprovers -V2024AccessRequestId $AccessRequestId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestApprovers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-completed-approvals +This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | OwnerId | **String** | (optional) | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** + +### Return type +[**CompletedApproval[]**](../models/completed-approval) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Completed Approvals. | CompletedApproval[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) +$Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + +# Completed Access Request Approvals List + +try { + Get-V2024CompletedApprovals + + # Below is a request that includes all optional parameters + # Get-V2024CompletedApprovals -V2024OwnerId $OwnerId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompletedApprovals" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-pending-approvals +This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | OwnerId | **String** | (optional) | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** + +### Return type +[**PendingApproval[]**](../models/pending-approval) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Pending Approvals. | PendingApproval[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional) +$Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + +# Pending Access Request Approvals List + +try { + Get-V2024PendingApprovals + + # Below is a request that includes all optional parameters + # Get-V2024PendingApprovals -V2024OwnerId $OwnerId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingApprovals" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## reject-access-request +Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ApprovalId | **String** | True | Approval ID. + Body | CommentDto | [**CommentDto**](../models/comment-dto) | True | Reviewer's comment. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. +$CommentDto = @"{ + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." +}"@ + +# Reject Access Request Approval + +try { + $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto + Deny-V2024AccessRequest-V2024ApprovalId $ApprovalId -V2024CommentDto $Result + + # Below is a request that includes all optional parameters + # Deny-V2024AccessRequest -V2024ApprovalId $ApprovalId -V2024CommentDto $CommentDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024AccessRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccessRequestIdentityMetricsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccessRequestIdentityMetricsApi.md new file mode 100644 index 000000000..9c3282222 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccessRequestIdentityMetricsApi.md @@ -0,0 +1,74 @@ + +--- +id: v2024-access-request-identity-metrics +title: AccessRequestIdentityMetrics +pagination_label: AccessRequestIdentityMetrics +sidebar_label: AccessRequestIdentityMetrics +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestIdentityMetrics', 'V2024AccessRequestIdentityMetrics'] +slug: /tools/sdk/powershell/v2024/methods/access-request-identity-metrics +tags: ['SDK', 'Software Development Kit', 'AccessRequestIdentityMetrics', 'V2024AccessRequestIdentityMetrics'] +--- + +# AccessRequestIdentityMetrics + Use this API to implement access request identity metrics functionality. +With this functionality in place, access request reviewers can see relevant details about the requested access item and associated source activity. +This allows reviewers to see how many of the identities who share a manager with the access requester have this same type of access and how many of them have had activity in the related source. +This additional context about whether the access has been granted before and how often it has been used can help those approving access requests make more informed decisions. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024AccessRequestIdentityMetrics**](#get-access-request-identity-metrics) | **GET** `/access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type}` | Return access request identity metrics + +## get-access-request-identity-metrics +Use this API to return information access metrics. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityId | **String** | True | Manager's identity ID. +Path | RequestedObjectId | **String** | True | Requested access item's ID. +Path | Type | **String** | True | Requested access item's type. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Summary of the resource access and source activity for the direct reports of the provided manager. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID. +$RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID. +$Type = "ENTITLEMENT" # String | Requested access item's type. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Return access request identity metrics + +try { + Get-V2024AccessRequestIdentityMetrics-V2024IdentityId $IdentityId -V2024RequestedObjectId $RequestedObjectId -V2024Type $Type -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestIdentityMetrics -V2024IdentityId $IdentityId -V2024RequestedObjectId $RequestedObjectId -V2024Type $Type -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestIdentityMetrics" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccessRequestsApi.md new file mode 100644 index 000000000..4c2da1c81 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccessRequestsApi.md @@ -0,0 +1,606 @@ + +--- +id: v2024-access-requests +title: AccessRequests +pagination_label: AccessRequests +sidebar_label: AccessRequests +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequests', 'V2024AccessRequests'] +slug: /tools/sdk/powershell/v2024/methods/access-requests +tags: ['SDK', 'Software Development Kit', 'AccessRequests', 'V2024AccessRequests'] +--- + +# AccessRequests + Use this API to implement and customize access request functionality. +With this functionality in place, users can request access to applications, entitlements, or roles, and managers can request that team members' access be revoked. +This allows users to get access to the tools they need quickly and securely, and it allows managers to take away access to those tools. + +Identity Security Cloud's Access Request service allows end users to request access that requires approval before it can be granted to users and enables qualified users to review those requests and approve or deny them. + +In the Request Center in Identity Security Cloud, users can view available applications, roles, and entitlements and request access to them. +If the requested tools requires approval, the requests appear as 'Pending' under the My Requests tab until the required approver approves, rejects, or cancels them. + +Users can use My Requests to track and/or cancel the requests. + +In My Team on the Identity Security Cloud Home, managers can submit requests to revoke their team members' access. +They can use the My Requests tab under Request Center to track and/or cancel the requests. + +Refer to [Requesting Access](https://documentation.sailpoint.com/saas/user-help/requests/requesting_access.html) for more information about access requests. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Approve-V2024BulkAccessRequest**](#approve-bulk-access-request) | **POST** `/access-request-approvals/bulk-approve` | Bulk Approve Access Request +[**Suspend-V2024AccessRequest**](#cancel-access-request) | **POST** `/access-requests/cancel` | Cancel Access Request +[**Suspend-V2024AccessRequestInBulk**](#cancel-access-request-in-bulk) | **POST** `/access-requests/bulk-cancel` | Bulk Cancel Access Request +[**Close-V2024AccessRequest**](#close-access-request) | **POST** `/access-requests/close` | Close Access Request +[**New-V2024AccessRequest**](#create-access-request) | **POST** `/access-requests` | Submit Access Request +[**Get-V2024AccessRequestConfig**](#get-access-request-config) | **GET** `/access-request-config` | Get Access Request Configuration +[**Get-V2024AccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status +[**Get-V2024AdministratorsAccessRequestStatus**](#list-administrators-access-request-status) | **GET** `/access-request-administration` | Access Request Status for Administrators +[**Set-V2024AccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration + +## approve-bulk-access-request +This API endpoint allows approving pending access requests in bulk. Maximum of 50 approval ids can be provided in the request for one single invocation. ORG_ADMIN or users with rights "idn:access-request-administration:write" can approve the access requests in bulk. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | BulkApproveAccessRequest | [**BulkApproveAccessRequest**](../models/bulk-approve-access-request) | True | + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$BulkApproveAccessRequest = @"{ + "comment" : "I approve these request items", + "approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ] +}"@ + +# Bulk Approve Access Request + +try { + $Result = ConvertFrom-JsonToBulkApproveAccessRequest -Json $BulkApproveAccessRequest + Approve-V2024BulkAccessRequest-V2024BulkApproveAccessRequest $Result + + # Below is a request that includes all optional parameters + # Approve-V2024BulkAccessRequest -V2024BulkApproveAccessRequest $BulkApproveAccessRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024BulkAccessRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## cancel-access-request +This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. +In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CancelAccessRequest | [**CancelAccessRequest**](../models/cancel-access-request) | True | + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CancelAccessRequest = @"{ + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." +}"@ + +# Cancel Access Request + +try { + $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest + Suspend-V2024AccessRequest-V2024CancelAccessRequest $Result + + # Below is a request that includes all optional parameters + # Suspend-V2024AccessRequest -V2024CancelAccessRequest $CancelAccessRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024AccessRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## cancel-access-request-in-bulk +This API endpoint allows cancelling pending access requests in bulk. Maximum of 50 access request ids can be provided in the request for one single invocation. +Only ORG_ADMIN or users with rights "idn:access-request-administration:write" can cancel the access requests in bulk. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | BulkCancelAccessRequest | [**BulkCancelAccessRequest**](../models/bulk-cancel-access-request) | True | + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$BulkCancelAccessRequest = @"{ + "accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ], + "comment" : "I requested this role by mistake." +}"@ + +# Bulk Cancel Access Request + +try { + $Result = ConvertFrom-JsonToBulkCancelAccessRequest -Json $BulkCancelAccessRequest + Suspend-V2024AccessRequestInBulk-V2024BulkCancelAccessRequest $Result + + # Below is a request that includes all optional parameters + # Suspend-V2024AccessRequestInBulk -V2024BulkCancelAccessRequest $BulkCancelAccessRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024AccessRequestInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## close-access-request +This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). + +To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND "Access Request". Use the Column Chooser to select 'Tracking Number', and use the 'Download' button to export a CSV containing the tracking numbers. + +To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). + +Input the IDs from either source. + +To track the status of endpoint requests, navigate to Search and use this query: name:"Close Identity Requests". Search will include "Close Identity Requests Started" audits when requests are initiated and "Close Identity Requests Completed" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. + +This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/provisioning-completed/) for each access request that is closed. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | CloseAccessRequest | [**CloseAccessRequest**](../models/close-access-request) | True | + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$CloseAccessRequest = @"{ + "executionStatus" : "Terminated", + "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "completionStatus" : "Failure", + "message" : "The IdentityNow Administrator manually closed this request." +}"@ + +# Close Access Request + +try { + $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest + Close-V2024AccessRequest-V2024XSailPointExperimental $XSailPointExperimental -V2024CloseAccessRequest $Result + + # Below is a request that includes all optional parameters + # Close-V2024AccessRequest -V2024XSailPointExperimental $XSailPointExperimental -V2024CloseAccessRequest $CloseAccessRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-V2024AccessRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-access-request +Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. + +Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request +has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn't return an error +if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. + +It's best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can +be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also +use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting +an access request to ensure that you aren't requesting access that is already granted. If you use this API to request access that an identity already has, the API will ignore the request. +These ignored requests do not display when you use the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) API. + +There are two types of access request: + +__GRANT_ACCESS__ +* Can be requested for multiple identities in a single request. +* Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. +* Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. +* Roles, access profiles and entitlements can be requested. +* While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. + +__REVOKE_ACCESS__ +* Can only be requested for a single identity at a time. +* You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. +* Does not support self request. Only manager can request to revoke access for their directly managed employees. +* If a `removeDate` is specified, then the access will be removed on that date and time only for roles, access profiles and entitlements. +* Roles, access profiles, and entitlements can be requested for revocation. +* Revoke requests for entitlements are limited to 1 entitlement per access request currently. +* You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. +* Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | AccessRequest | [**AccessRequest**](../models/access-request) | True | + +### Return type +[**AccessRequestResponse**](../models/access-request-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Access Request Response. | AccessRequestResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$AccessRequest = @"{ + "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + } ] +}"@ + +# Submit Access Request + +try { + $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest + New-V2024AccessRequest-V2024AccessRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024AccessRequest -V2024AccessRequest $AccessRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-access-request-config +This endpoint returns the current access-request configuration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**AccessRequestConfig**](../models/access-request-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Access Request Configuration Details. | AccessRequestConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Access Request Configuration + +try { + Get-V2024AccessRequestConfig + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-access-request-status +Use this API to return a list of access request statuses based on the specified query parameters. +If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. +Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | RequestedFor | **String** | (optional) | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | RequestedBy | **String** | (optional) | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | RegardingIdentity | **String** | (optional) | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. + Query | AssignedTo | **String** | (optional) | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. + Query | Count | **Boolean** | (optional) (default to $false) | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. + Query | Offset | **Int32** | (optional) | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** + Query | RequestState | **String** | (optional) | Filter the results by the state of the request. The only valid value is *EXECUTING*. + +### Return type +[**RequestedItemStatus[]**](../models/requested-item-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of requested item statuses. | RequestedItemStatus[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) +$RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) +$RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) +$AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) +$Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) +$Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) +$Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) +$Filters = 'accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) +$Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) +$RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + +# Access Request Status + +try { + Get-V2024AccessRequestStatus + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestStatus -V2024RequestedFor $RequestedFor -V2024RequestedBy $RequestedBy -V2024RegardingIdentity $RegardingIdentity -V2024AssignedTo $AssignedTo -V2024Count $Count -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters -V2024Sorters $Sorters -V2024RequestState $RequestState +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-administrators-access-request-status +Use this API to get access request statuses of all the access requests in the org based on the specified query parameters. +Any user with user level ORG_ADMIN or scope idn:access-request-administration:read can access this endpoint to get the access request statuses + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | RequestedFor | **String** | (optional) | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | RequestedBy | **String** | (optional) | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | RegardingIdentity | **String** | (optional) | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. + Query | AssignedTo | **String** | (optional) | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. + Query | Count | **Boolean** | (optional) (default to $false) | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. + Query | Offset | **Int32** | (optional) | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name, accessRequestId** + Query | RequestState | **String** | (optional) | Filter the results by the state of the request. The only valid value is *EXECUTING*. + +### Return type +[**AccessRequestAdminItemStatus[]**](../models/access-request-admin-item-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of requested item statuses. | AccessRequestAdminItemStatus[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) +$RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) +$RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) +$AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) +$Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) +$Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) +$Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) +$Filters = 'accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) +$Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name, accessRequestId** (optional) +$RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + +# Access Request Status for Administrators + +try { + Get-V2024AdministratorsAccessRequestStatus + + # Below is a request that includes all optional parameters + # Get-V2024AdministratorsAccessRequestStatus -V2024RequestedFor $RequestedFor -V2024RequestedBy $RequestedBy -V2024RegardingIdentity $RegardingIdentity -V2024AssignedTo $AssignedTo -V2024Count $Count -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters -V2024Sorters $Sorters -V2024RequestState $RequestState +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AdministratorsAccessRequestStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-access-request-config +This endpoint replaces the current access-request configuration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | AccessRequestConfig | [**AccessRequestConfig**](../models/access-request-config) | True | + +### Return type +[**AccessRequestConfig**](../models/access-request-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Access Request Configuration Details. | AccessRequestConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$AccessRequestConfig = @"{ + "requestOnBehalfOfConfig" : { + "allowRequestOnBehalfOfEmployeeByManager" : true, + "allowRequestOnBehalfOfAnyoneByAnyone" : true + }, + "approvalReminderAndEscalationConfig" : { + "fallbackApproverRef" : { + "name" : "Alison Ferguso", + "id" : "5168015d32f890ca15812c9180835d2e", + "type" : "IDENTITY", + "email" : "alison.ferguso@identitysoon.com" + }, + "maxReminders" : 1, + "daysUntilEscalation" : 0, + "daysBetweenReminders" : 0 + }, + "autoApprovalEnabled" : true, + "entitlementRequestConfig" : { + "requestCommentsRequired" : false, + "deniedCommentsRequired" : false, + "allowEntitlementRequest" : true, + "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + }, + "reauthorizationEnabled" : true, + "approvalsMustBeExternal" : true +}"@ + +# Update Access Request Configuration + +try { + $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig + Set-V2024AccessRequestConfig-V2024AccessRequestConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024AccessRequestConfig -V2024AccessRequestConfig $AccessRequestConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024AccessRequestConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccountActivitiesApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccountActivitiesApi.md new file mode 100644 index 000000000..068696fa2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccountActivitiesApi.md @@ -0,0 +1,155 @@ + +--- +id: v2024-account-activities +title: AccountActivities +pagination_label: AccountActivities +sidebar_label: AccountActivities +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivities', 'V2024AccountActivities'] +slug: /tools/sdk/powershell/v2024/methods/account-activities +tags: ['SDK', 'Software Development Kit', 'AccountActivities', 'V2024AccountActivities'] +--- + +# AccountActivities + Use this API to implement account activity tracking functionality. +With this functionality in place, users can track source account activity in Identity Security Cloud, which greatly improves traceability in the system. + +An account activity refers to a log of each action performed on a source account. This is useful for auditing the changes performed on an account throughout its life. +In Identity Security Cloud's Search, users can search for account activities and select the activity's row to get an overview of the activity's account action and view its progress, its involved sources, and its most basic metadata, such as the identity requesting the option and the recipient. + +Account activity includes most actions Identity Security Cloud completes on source accounts. Users can search in Identity Security Cloud for the following account action types: + +- Access Request: These include any access requests the source account is involved in. + +- Account Attribute Updates: These include updates to a single attribute on an account on a source. + +- Account State Update: These include locking or unlocking actions on an account on a source. + +- Certification: These include actions removing an entitlement from an account on a source as a result of the entitlement's revocation during a certification. + +- Cloud Automated `Lifecyclestate`: These include automated lifecycle state changes that result in a source account's correlated identity being assigned to a different lifecycle state. +Identity Security Cloud replaces the `Lifecyclestate` variable with the name of the lifecycle state it has moved the account's identity to. + +- Identity Attribute Update: These include updates to a source account's correlated identity attributes as the result of a provisioning action. +When you update an identity attribute that also updates an identity's lifecycle state, the cloud automated `Lifecyclestate` event also displays. +Account Activity does not include attribute updates that occur as a result of aggregation. + +- Identity Refresh: These include correlated identity refreshes that occur for an account on a source whenever the account's correlated identity profile gets a new role or updates. +These also include refreshes that occur whenever Identity Security Cloud assigns an application to the account's correlated identity based on the application's being assigned to All Users From Source or Specific Users From Source. + +- Lifecycle State Refresh: These include the actions that took place when a lifecycle state changed. This event only occurs after a cloud automated `Lifecyclestate` change or a lifecycle state change. + +- Lifecycle State Change: These include the account activities that result from an identity's manual assignment to a null lifecycle state. + +- Password Change: These include password changes on sources. + +Refer to [Account Activity](https://documentation.sailpoint.com/saas/help/search/index.html#account-activity) for more information about account activities. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024AccountActivity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get an Account Activity +[**Get-V2024AccountActivities**](#list-account-activities) | **GET** `/account-activities` | List Account Activities + +## get-account-activity +This gets a single account activity by its id. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The account activity id + +### Return type +[**AccountActivity**](../models/account-activity) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An account activity object | AccountActivity +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id + +# Get an Account Activity + +try { + Get-V2024AccountActivity-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccountActivity -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountActivity" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-account-activities +This gets a collection of account activities that satisfy the given query parameters. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | RequestedFor | **String** | (optional) | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | RequestedBy | **String** | (optional) | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | RegardingIdentity | **String** | (optional) | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** + +### Return type +[**AccountActivity[]**](../models/account-activity) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of account activities | AccountActivity[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RequestedFor = "2c91808568c529c60168cca6f90c1313" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) +$RequestedBy = "2c91808568c529c60168cca6f90c1313" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) +$RegardingIdentity = "2c91808568c529c60168cca6f90c1313" # String | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'type eq "Identity Refresh"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) +$Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) + +# List Account Activities + +try { + Get-V2024AccountActivities + + # Below is a request that includes all optional parameters + # Get-V2024AccountActivities -V2024RequestedFor $RequestedFor -V2024RequestedBy $RequestedBy -V2024RegardingIdentity $RegardingIdentity -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountActivities" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccountAggregationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccountAggregationsApi.md new file mode 100644 index 000000000..b506ccc79 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccountAggregationsApi.md @@ -0,0 +1,83 @@ + +--- +id: v2024-account-aggregations +title: AccountAggregations +pagination_label: AccountAggregations +sidebar_label: AccountAggregations +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAggregations', 'V2024AccountAggregations'] +slug: /tools/sdk/powershell/v2024/methods/account-aggregations +tags: ['SDK', 'Software Development Kit', 'AccountAggregations', 'V2024AccountAggregations'] +--- + +# AccountAggregations + Use this API to implement account aggregation progress tracking functionality. +With this functionality in place, administrators can view in-progress account aggregations, their statuses, and their relevant details. + +An account aggregation refers to the process Identity Security Cloud uses to gather and load account data from a source into Identity Security Cloud. + +Whenever Identity Security Cloud is in the process of aggregating a source, it adds an entry to the Aggregation Activity Log, along with its relevant details. +To view aggregation activity, administrators can select the Connections drop-down menu, select Sources, and select the relevant source, select its Import Data tab, and select Account Aggregation. +In Account Aggregation, administrators can view the account aggregations' statuses and details in the Account Activity Log. + +Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about account aggregations. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024AccountAggregationStatus**](#get-account-aggregation-status) | **GET** `/account-aggregations/{id}/status` | In-progress Account Aggregation status + +## get-account-aggregation-status +This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. + +Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. + +Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. + +*Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* +required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The account aggregation id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**AccountAggregationStatus**](../models/account-aggregation-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An account aggregation status object | AccountAggregationStatus +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# In-progress Account Aggregation status + +try { + Get-V2024AccountAggregationStatus-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccountAggregationStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountAggregationStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccountUsagesApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccountUsagesApi.md new file mode 100644 index 000000000..b7c565c9a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccountUsagesApi.md @@ -0,0 +1,75 @@ + +--- +id: v2024-account-usages +title: AccountUsages +pagination_label: AccountUsages +sidebar_label: AccountUsages +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUsages', 'V2024AccountUsages'] +slug: /tools/sdk/powershell/v2024/methods/account-usages +tags: ['SDK', 'Software Development Kit', 'AccountUsages', 'V2024AccountUsages'] +--- + +# AccountUsages + Use this API to implement account usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' source accounts are being used. +This allows organizations to get the information they need to start optimizing and securing source account usage. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024UsagesByAccountId**](#get-usages-by-account-id) | **GET** `/account-usages/{accountId}/summaries` | Returns account usage insights + +## get-usages-by-account-id +This API returns a summary of account usage insights for past 12 months. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | AccountId | **String** | True | ID of IDN account + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** + +### Return type +[**AccountUsage[]**](../models/account-usage) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Summary of account usage insights for past 12 months. | AccountUsage[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + +# Returns account usage insights + +try { + Get-V2024UsagesByAccountId-V2024AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-V2024UsagesByAccountId -V2024AccountId $AccountId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesByAccountId" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccountsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccountsApi.md new file mode 100644 index 000000000..b5a82583e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AccountsApi.md @@ -0,0 +1,860 @@ + +--- +id: v2024-accounts +title: Accounts +pagination_label: Accounts +sidebar_label: Accounts +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Accounts', 'V2024Accounts'] +slug: /tools/sdk/powershell/v2024/methods/accounts +tags: ['SDK', 'Software Development Kit', 'Accounts', 'V2024Accounts'] +--- + +# Accounts + Use this API to implement and customize account functionality. +With this functionality in place, administrators can manage users' access across sources in Identity Security Cloud. + +In Identity Security Cloud, an account refers to a user's account on a supported source. +This typically includes a unique identifier for the user, a unique password, a set of permissions associated with the source and a set of attributes. Identity Security Cloud loads accounts through the creation of sources in Identity Security Cloud. + +Administrators can correlate users' identities with the users' accounts on the different sources they use. +This allows Identity Security Cloud to govern the access of identities and all their correlated accounts securely and cohesively. + +To view the accounts on a source and their correlated identities, administrators can use the Connections drop-down menu, select Sources, select the relevant source, and select its Account tab. + +To view and edit source account statuses for an identity in Identity Security Cloud, administrators can use the Identities drop-down menu, select Identity List, select the relevant identity, and select its Accounts tab. +Administrators can toggle an account's Actions to aggregate the account, enable/disable it, unlock it, or remove it from the identity. + +Accounts can have the following statuses: + +- Enabled: The account is enabled. The user can access it. + +- Disabled: The account is disabled, and the user cannot access it, but the identity is not disabled in Identity Security Cloud. This can occur when an administrator disables the account or when the user's lifecycle state changes. + +- Locked: The account is locked. This may occur when someone has entered an incorrect password for the account too many times. + +- Pending: The account is currently updating. This status typically lasts seconds. + +Administrators can select the source account to view its attributes, entitlements, and the last time the account's password was changed. + +Refer to [Managing User Accounts](https://documentation.sailpoint.com/saas/help/common/users/user_access.html#managing-user-accounts) for more information about accounts. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024Account**](#create-account) | **POST** `/accounts` | Create Account +[**Remove-V2024Account**](#delete-account) | **DELETE** `/accounts/{id}` | Delete Account +[**Remove-V2024AccountAsync**](#delete-account-async) | **POST** `/accounts/{id}/remove` | Remove Account +[**Disable-V2024Account**](#disable-account) | **POST** `/accounts/{id}/disable` | Disable Account +[**Disable-V2024AccountForIdentity**](#disable-account-for-identity) | **POST** `/identities-accounts/{id}/disable` | Disable IDN Account for Identity +[**Disable-V2024AccountsForIdentities**](#disable-accounts-for-identities) | **POST** `/identities-accounts/disable` | Disable IDN Accounts for Identities +[**Enable-V2024Account**](#enable-account) | **POST** `/accounts/{id}/enable` | Enable Account +[**Enable-V2024AccountForIdentity**](#enable-account-for-identity) | **POST** `/identities-accounts/{id}/enable` | Enable IDN Account for Identity +[**Enable-V2024AccountsForIdentities**](#enable-accounts-for-identities) | **POST** `/identities-accounts/enable` | Enable IDN Accounts for Identities +[**Get-V2024Account**](#get-account) | **GET** `/accounts/{id}` | Account Details +[**Get-V2024AccountEntitlements**](#get-account-entitlements) | **GET** `/accounts/{id}/entitlements` | Account Entitlements +[**Get-V2024Accounts**](#list-accounts) | **GET** `/accounts` | Accounts List +[**Send-V2024Account**](#put-account) | **PUT** `/accounts/{id}` | Update Account +[**Submit-V2024ReloadAccount**](#submit-reload-account) | **POST** `/accounts/{id}/reload` | Reload Account +[**Unlock-V2024Account**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account +[**Update-V2024Account**](#update-account) | **PATCH** `/accounts/{id}` | Update Account + +## create-account +Submit an account creation task - the API then returns the task ID. + +You must include the `sourceId` where the account will be created in the `attributes` object. + +This endpoint creates an account on the source record in your ISC tenant. +This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. + +However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. +The endpoint doesn't actually provision the account on the target source, which means that if the account doesn't also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. + +By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | AccountAttributesCreate | [**AccountAttributesCreate**](../models/account-attributes-create) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Async task details. | AccountsAsyncResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$AccountAttributesCreate = @"{ + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } +}"@ + +# Create Account + +try { + $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate + New-V2024Account-V2024AccountAttributesCreate $Result + + # Below is a request that includes all optional parameters + # New-V2024Account -V2024AccountAttributesCreate $AccountAttributesCreate +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Account" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-account +Use this API to delete an account. +This endpoint submits an account delete task and returns the task ID. +This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. +>**NOTE: You can only delete accounts from sources of the "DelimitedFile" type.** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Account ID. + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Async task details. | AccountsAsyncResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + +# Delete Account + +try { + Remove-V2024Account-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Account -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Account" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-account-async +Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. + +This endpoint is good for: +* Removing accounts that no longer exist on the source. +* Removing accounts that won't be aggregated following updates to the source configuration. +* Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The account id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**TaskResultDto**](../models/task-result-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted. Returns task result details of removal request. | TaskResultDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Remove Account + +try { + Remove-V2024AccountAsync-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024AccountAsync -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountAsync" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## disable-account +This API submits a task to disable the account and returns the task ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The account id + Body | AccountToggleRequest | [**AccountToggleRequest**](../models/account-toggle-request) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Async task details | AccountsAsyncResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id +$AccountToggleRequest = @"{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" +}"@ + +# Disable Account + +try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Disable-V2024Account-V2024Id $Id -V2024AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Disable-V2024Account -V2024Id $Id -V2024AccountToggleRequest $AccountToggleRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024Account" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## disable-account-for-identity +This API submits a task to disable IDN account for a single identity. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity id. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808384203c2d018437e631158309" # String | The identity id. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Disable IDN Account for Identity + +try { + Disable-V2024AccountForIdentity-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Disable-V2024AccountForIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountForIdentity" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## disable-accounts-for-identities +This API submits tasks to disable IDN account for each identity provided in the request body. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | IdentitiesAccountsBulkRequest | [**IdentitiesAccountsBulkRequest**](../models/identities-accounts-bulk-request) | True | + +### Return type +[**BulkIdentitiesAccountsResponse[]**](../models/bulk-identities-accounts-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +207 | Bulk response details. | BulkIdentitiesAccountsResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$IdentitiesAccountsBulkRequest = @"{ + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] +}"@ + +# Disable IDN Accounts for Identities + +try { + $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest + Disable-V2024AccountsForIdentities-V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result + + # Below is a request that includes all optional parameters + # Disable-V2024AccountsForIdentities -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountsForIdentities" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## enable-account +This API submits a task to enable account and returns the task ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The account id + Body | AccountToggleRequest | [**AccountToggleRequest**](../models/account-toggle-request) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Async task details | AccountsAsyncResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id +$AccountToggleRequest = @"{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" +}"@ + +# Enable Account + +try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Enable-V2024Account-V2024Id $Id -V2024AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Enable-V2024Account -V2024Id $Id -V2024AccountToggleRequest $AccountToggleRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024Account" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## enable-account-for-identity +This API submits a task to enable IDN account for a single identity. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity id. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808384203c2d018437e631158309" # String | The identity id. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Enable IDN Account for Identity + +try { + Enable-V2024AccountForIdentity-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Enable-V2024AccountForIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountForIdentity" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## enable-accounts-for-identities +This API submits tasks to enable IDN account for each identity provided in the request body. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | IdentitiesAccountsBulkRequest | [**IdentitiesAccountsBulkRequest**](../models/identities-accounts-bulk-request) | True | + +### Return type +[**BulkIdentitiesAccountsResponse[]**](../models/bulk-identities-accounts-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +207 | Bulk response details. | BulkIdentitiesAccountsResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$IdentitiesAccountsBulkRequest = @"{ + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] +}"@ + +# Enable IDN Accounts for Identities + +try { + $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest + Enable-V2024AccountsForIdentities-V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result + + # Below is a request that includes all optional parameters + # Enable-V2024AccountsForIdentities -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountsForIdentities" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-account +Use this API to return the details for a single account by its ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Account ID. + +### Return type +[**Account**](../models/account) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Account object. | Account +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + +# Account Details + +try { + Get-V2024Account-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Account -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Account" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-account-entitlements +This API returns entitlements of the account. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The account id + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**EntitlementDto[]**](../models/entitlement-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An array of account entitlements | EntitlementDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Account Entitlements + +try { + Get-V2024AccountEntitlements-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccountEntitlements -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountEntitlements" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-accounts +List accounts. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | DetailLevel | **String** | (optional) | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** + +### Return type +[**Account[]**](../models/account) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of account objects. | Account[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) +$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (optional) +$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + +# Accounts List + +try { + Get-V2024Accounts + + # Below is a request that includes all optional parameters + # Get-V2024Accounts -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024DetailLevel $DetailLevel -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Accounts" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-account +Use this API to update an account with a PUT request. + +This endpoint submits an account update task and returns the task ID. + +>**Note: You can only use this PUT endpoint to update accounts from flat file sources.** + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Account ID. + Body | AccountAttributes | [**AccountAttributes**](../models/account-attributes) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Async task details. | AccountsAsyncResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. +$AccountAttributes = @"{ + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } +}"@ + +# Update Account + +try { + $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes + Send-V2024Account-V2024Id $Id -V2024AccountAttributes $Result + + # Below is a request that includes all optional parameters + # Send-V2024Account -V2024Id $Id -V2024AccountAttributes $AccountAttributes +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Account" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## submit-reload-account +This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The account id + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Async task details | AccountsAsyncResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + +# Reload Account + +try { + Submit-V2024ReloadAccount-V2024Id $Id + + # Below is a request that includes all optional parameters + # Submit-V2024ReloadAccount -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReloadAccount" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## unlock-account +This API submits a task to unlock an account and returns the task ID. +To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The account ID. + Body | AccountUnlockRequest | [**AccountUnlockRequest**](../models/account-unlock-request) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Async task details | AccountsAsyncResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. +$AccountUnlockRequest = @"{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false +}"@ + +# Unlock Account + +try { + $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest + Unlock-V2024Account-V2024Id $Id -V2024AccountUnlockRequest $Result + + # Below is a request that includes all optional parameters + # Unlock-V2024Account -V2024Id $Id -V2024AccountUnlockRequest $AccountUnlockRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-V2024Account" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-account +Use this API to update account details. + +This API supports updating an account's correlation by modifying the `identityId` and `manuallyCorrelated` fields. +To reassign an account from one identity to another, replace the current `identityId` with a new value. +If the account you're assigning was provisioned by Identity Security Cloud (ISC), it's possible for ISC to create a new account +for the previous identity as soon as the account is moved. If the account you're assigning is authoritative, +this causes the previous identity to become uncorrelated and can even result in its deletion. +All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. + +>**Note:** The `attributes` field can only be modified for flat file accounts. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Account ID. + Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | True | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. +$RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"[{op=remove, path=/identityId}]"@ # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +# Update Account + +try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2024Account-V2024Id $Id -V2024RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024Account -V2024Id $Id -V2024RequestBody $RequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Account" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ApplicationDiscoveryApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ApplicationDiscoveryApi.md new file mode 100644 index 000000000..307b44bc3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ApplicationDiscoveryApi.md @@ -0,0 +1,163 @@ + +--- +id: v2024-application-discovery +title: ApplicationDiscovery +pagination_label: ApplicationDiscovery +sidebar_label: ApplicationDiscovery +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApplicationDiscovery', 'V2024ApplicationDiscovery'] +slug: /tools/sdk/powershell/v2024/methods/application-discovery +tags: ['SDK', 'Software Development Kit', 'ApplicationDiscovery', 'V2024ApplicationDiscovery'] +--- + +# ApplicationDiscovery + Use this API to implement application discovery functionality. +With this functionality in place, you can discover applications within your Okta connector and receive connector recommendations by manually uploading application names. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024DiscoveredApplications**](#get-discovered-applications) | **GET** `/discovered-applications` | Get Discovered Applications for Tenant +[**Get-V2024ManualDiscoverApplicationsCsvTemplate**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download CSV Template for Discovery +[**Send-V2024ManualDiscoverApplicationsCsvTemplate**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload CSV to Discover Applications + +## get-discovered-applications +Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Detail | **String** | (optional) | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. + Query | Filter | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** + +### Return type +[**GetDiscoveredApplications200ResponseInner[]**](../models/get-discovered-applications200-response-inner) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of discovered applications. By default, the API returns a list of SLIM discovered applications. | GetDiscoveredApplications200ResponseInner[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) +$Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) + +# Get Discovered Applications for Tenant + +try { + Get-V2024DiscoveredApplications + + # Below is a request that includes all optional parameters + # Get-V2024DiscoveredApplications -V2024Limit $Limit -V2024Offset $Offset -V2024Detail $Detail -V2024Filter $Filter -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DiscoveredApplications" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-manual-discover-applications-csv-template +Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values 'Example Application' and 'Example Description'. + +The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**ManualDiscoverApplicationsTemplate**](../models/manual-discover-applications-template) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A CSV file download was successful. | ManualDiscoverApplicationsTemplate +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: text/csv, application/json + +### Example +```powershell + +# Download CSV Template for Discovery + +try { + Get-V2024ManualDiscoverApplicationsCsvTemplate + + # Below is a request that includes all optional parameters + # Get-V2024ManualDiscoverApplicationsCsvTemplate +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## send-manual-discover-applications-csv-template +Uploading a CSV file with application data for manual correlation to specific ISC connectors. +If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | File | **System.IO.FileInfo** | True | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The CSV has been successfully processed. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + +# Upload CSV to Discover Applications + +try { + Send-V2024ManualDiscoverApplicationsCsvTemplate-V2024File $File + + # Below is a request that includes all optional parameters + # Send-V2024ManualDiscoverApplicationsCsvTemplate -V2024File $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ApprovalsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ApprovalsApi.md new file mode 100644 index 000000000..186379543 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ApprovalsApi.md @@ -0,0 +1,119 @@ + +--- +id: v2024-approvals +title: Approvals +pagination_label: Approvals +sidebar_label: Approvals +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Approvals', 'V2024Approvals'] +slug: /tools/sdk/powershell/v2024/methods/approvals +tags: ['SDK', 'Software Development Kit', 'Approvals', 'V2024Approvals'] +--- + +# Approvals + Use this API to implement approval functionality. With this functionality in place, you can get generic approvals and modify them. + +The main advantages this API has vs [Access Request Approvals](https://developer.sailpoint.com/docs/api/beta/access-request-approvals) are that you can use it to get generic approvals individually or in batches and make changes to those approvals. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024Approval**](#get-approval) | **GET** `/generic-approvals/{id}` | Get an approval +[**Get-V2024Approvals**](#get-approvals) | **GET** `/generic-approvals` | Get Approvals + +## get-approval +Retrieve a single approval for a given approval ID. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the approval that is to be returned + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**Approval**](../models/approval) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Approval object | Approval +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that is to be returned +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get an approval + +try { + Get-V2024Approval-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Approval -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Approval" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-approvals +Retrieve a list of approvals, which can be filtered by requester ID, status, or reference type. "Mine" query parameter can be used and it will return all approvals for the current approver. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals. +Absence of all query parameters will will default to mine=true. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Mine | **Boolean** | (optional) | Returns the list of approvals for the current caller + Query | RequesterId | **String** | (optional) | Returns the list of approvals for a given requester ID + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* + +### Return type +[**Approval[]**](../models/approval) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Approvals | Approval[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Mine = $true # Boolean | Returns the list of approvals for the current caller (optional) +$RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID (optional) +$Filters = 'filters=status eq PENDING' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* (optional) + +# Get Approvals + +try { + Get-V2024Approvals-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Approvals -V2024XSailPointExperimental $XSailPointExperimental -V2024Mine $Mine -V2024RequesterId $RequesterId -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Approvals" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AppsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AppsApi.md new file mode 100644 index 000000000..bdbc5412a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AppsApi.md @@ -0,0 +1,751 @@ + +--- +id: v2024-apps +title: Apps +pagination_label: Apps +sidebar_label: Apps +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Apps', 'V2024Apps'] +slug: /tools/sdk/powershell/v2024/methods/apps +tags: ['SDK', 'Software Development Kit', 'Apps', 'V2024Apps'] +--- + +# Apps + Use this API to implement source application functionality. +With this functionality in place, you can create, customize, and manage applications within sources. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024SourceApp**](#create-source-app) | **POST** `/source-apps` | Create source app +[**Remove-V2024AccessProfilesFromSourceAppByBulk**](#delete-access-profiles-from-source-app-by-bulk) | **POST** `/source-apps/{id}/access-profiles/bulk-remove` | Bulk remove access profiles from the specified source app +[**Remove-V2024SourceApp**](#delete-source-app) | **DELETE** `/source-apps/{id}` | Delete source app by ID +[**Get-V2024SourceApp**](#get-source-app) | **GET** `/source-apps/{id}` | Get source app by ID +[**Get-V2024AccessProfilesForSourceApp**](#list-access-profiles-for-source-app) | **GET** `/source-apps/{id}/access-profiles` | List access profiles for the specified source app +[**Get-V2024AllSourceApp**](#list-all-source-app) | **GET** `/source-apps/all` | List all source apps +[**Get-V2024AllUserApps**](#list-all-user-apps) | **GET** `/user-apps/all` | List all user apps +[**Get-V2024AssignedSourceApp**](#list-assigned-source-app) | **GET** `/source-apps/assigned` | List assigned source apps +[**Get-V2024AvailableAccountsForUserApp**](#list-available-accounts-for-user-app) | **GET** `/user-apps/{id}/available-accounts` | List available accounts for user app +[**Get-V2024AvailableSourceApps**](#list-available-source-apps) | **GET** `/source-apps` | List available source apps +[**Get-V2024OwnedUserApps**](#list-owned-user-apps) | **GET** `/user-apps` | List owned user apps +[**Update-V2024SourceApp**](#patch-source-app) | **PATCH** `/source-apps/{id}` | Patch source app by ID +[**Update-V2024UserApp**](#patch-user-app) | **PATCH** `/user-apps/{id}` | Patch user app by ID +[**Update-V2024SourceAppsInBulk**](#update-source-apps-in-bulk) | **POST** `/source-apps/bulk-update` | Bulk update source apps + +## create-source-app +This endpoint creates a source app using the given source app payload + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | SourceAppCreateDto | [**SourceAppCreateDto**](../models/source-app-create-dto) | True | + +### Return type +[**SourceApp**](../models/source-app) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the source app as created. | SourceApp +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$SourceAppCreateDto = @"{ + "name" : "my app", + "description" : "the source app for engineers", + "accountSource" : { + "name" : "ODS-AD-Source", + "id" : "2c9180827ca885d7017ca8ce28a000eb", + "type" : "SOURCE" + }, + "matchAllAccounts" : true +}"@ + +# Create source app + +try { + $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto + New-V2024SourceApp-V2024XSailPointExperimental $XSailPointExperimental -V2024SourceAppCreateDto $Result + + # Below is a request that includes all optional parameters + # New-V2024SourceApp -V2024XSailPointExperimental $XSailPointExperimental -V2024SourceAppCreateDto $SourceAppCreateDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceApp" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-access-profiles-from-source-app-by-bulk +This API returns the final list of access profiles for the specified source app after removing + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the source app + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | RequestBody | **[]String** | True | + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**AccessProfileDetails[]**](../models/access-profile-details) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The final list of access profiles for the specified source app | AccessProfileDetails[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the source app +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$RequestBody = "MyRequestBody" # String[] | + $RequestBody = @"[c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9]"@ # String[] | + +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + +# Bulk remove access profiles from the specified source app + +try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-V2024AccessProfilesFromSourceAppByBulk-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-V2024AccessProfilesFromSourceAppByBulk -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $RequestBody -V2024Limit $Limit +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfilesFromSourceAppByBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-source-app +Use this API to delete a specific source app + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | source app ID. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**SourceApp**](../models/source-app) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the source app as deleted. | SourceApp +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Delete source app by ID + +try { + Remove-V2024SourceApp-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024SourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceApp" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-source-app +This API returns a source app by its ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the source app + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**SourceApp**](../models/source-app) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the source app. | SourceApp +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the source app +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get source app by ID + +try { + Get-V2024SourceApp-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceApp" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-access-profiles-for-source-app +This API returns the list of access profiles for the specified source app + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the source app + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* + +### Return type +[**AccessProfileDetails[]**](../models/access-profile-details) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of access profiles for the specified source app | AccessProfileDetails[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the source app +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Filters = 'name eq "developer access profile"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + +# List access profiles for the specified source app + +try { + Get-V2024AccessProfilesForSourceApp-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessProfilesForSourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfilesForSourceApp" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-all-source-app +This API returns the list of all source apps for the org. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* + +### Return type +[**SourceApp[]**](../models/source-app) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of source apps | SourceApp[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) +$Filters = 'enabled eq true' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) + +# List all source apps + +try { + Get-V2024AllSourceApp-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AllSourceApp -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset -V2024Sorters $Sorters -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllSourceApp" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-all-user-apps +This API returns the list of all user apps with specified filters. +This API must be used with **filters** query parameter. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Filters | **String** | True | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**UserApp[]**](../models/user-app) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of user apps | UserApp[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Filters = 'name eq "user app name"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + +# List all user apps + +try { + Get-V2024AllUserApps-V2024Filters $Filters -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AllUserApps -V2024Filters $Filters -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllUserApps" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-assigned-source-app +This API returns the list of source apps assigned for logged in user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* + +### Return type +[**SourceApp[]**](../models/source-app) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of source apps | SourceApp[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (optional) +$Filters = 'name eq "source app name"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + +# List assigned source apps + +try { + Get-V2024AssignedSourceApp-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AssignedSourceApp -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset -V2024Sorters $Sorters -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AssignedSourceApp" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-available-accounts-for-user-app +This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the user app + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**AppAccountDetails[]**](../models/app-account-details) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of available accounts for the specified user app | AppAccountDetails[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the user app +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# List available accounts for user app + +try { + Get-V2024AvailableAccountsForUserApp-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AvailableAccountsForUserApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AvailableAccountsForUserApp" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-available-source-apps +This API returns the list of source apps available for access request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* + +### Return type +[**SourceApp[]**](../models/source-app) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of source apps | SourceApp[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) +$Filters = 'name eq "source app name"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + +# List available source apps + +try { + Get-V2024AvailableSourceApps-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AvailableSourceApps -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset -V2024Sorters $Sorters -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AvailableSourceApps" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-owned-user-apps +This API returns the list of user apps assigned to logged in user + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + +### Return type +[**UserApp[]**](../models/user-app) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of user apps | UserApp[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Filters = 'name eq "user app name"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) + +# List owned user apps + +try { + Get-V2024OwnedUserApps-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024OwnedUserApps -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OwnedUserApps" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-source-app +This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. +Name, description and owner can't be empty or null. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the source app to patch + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) | + +### Return type +[**SourceAppPatchDto**](../models/source-app-patch-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the source app as updated. | SourceAppPatchDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the source app to patch +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | (optional) + + +# Patch source app by ID + +try { + Update-V2024SourceApp-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024SourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceApp" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-user-app +This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: **account** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the user app to patch + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) | + +### Return type +[**UserApp**](../models/user-app) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the user app as updated. | UserApp +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the user app to patch +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | (optional) + + +# Patch user app by ID + +try { + Update-V2024UserApp-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024UserApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024UserApp" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-source-apps-in-bulk +This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. +The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. +Name, description and owner can't be empty or null. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | SourceAppBulkUpdateRequest | [**SourceAppBulkUpdateRequest**](../models/source-app-bulk-update-request) | (optional) | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$SourceAppBulkUpdateRequest = @"{ + "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : false + }, { + "op" : "replace", + "path" : "/matchAllAccounts", + "value" : false + } ] +}"@ + +# Bulk update source apps + +try { + Update-V2024SourceAppsInBulk-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024SourceAppsInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024SourceAppBulkUpdateRequest $SourceAppBulkUpdateRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceAppsInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AuthProfileApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AuthProfileApi.md new file mode 100644 index 000000000..83f4a7d7a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AuthProfileApi.md @@ -0,0 +1,170 @@ + +--- +id: v2024-auth-profile +title: AuthProfile +pagination_label: AuthProfile +sidebar_label: AuthProfile +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AuthProfile', 'V2024AuthProfile'] +slug: /tools/sdk/powershell/v2024/methods/auth-profile +tags: ['SDK', 'Software Development Kit', 'AuthProfile', 'V2024AuthProfile'] +--- + +# AuthProfile + Use this API to implement Auth Profile functionality. +With this functionality in place, users can read authentication profiles and make changes to them. + +An authentication profile represents an identity profile's authentication configuration. +When the identity profile is created, its authentication profile is also created. +An authentication profile includes information like its authentication profile type (`BLOCK`, `MFA`, `NON_PTA`, PTA`) and settings controlling whether or not it blocks access from off network or untrusted geographies. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024ProfileConfig**](#get-profile-config) | **GET** `/auth-profiles/{id}` | Get Auth Profile. +[**Get-V2024ProfileConfigList**](#get-profile-config-list) | **GET** `/auth-profiles` | Get list of Auth Profiles. +[**Update-V2024ProfileConfig**](#patch-profile-config) | **PATCH** `/auth-profiles/{id}` | Patch a specified Auth Profile + +## get-profile-config +This API returns auth profile information. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. +Path | Id | **String** | True | ID of the Auth Profile to patch. + +### Return type +[**AuthProfile**](../models/auth-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Auth Profile | AuthProfile +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. + +# Get Auth Profile. + +try { + Get-V2024ProfileConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ProfileConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProfileConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-profile-config-list +This API returns a list of auth profiles. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**AuthProfileSummary**](../models/auth-profile-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Auth Profiles | AuthProfileSummary +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get list of Auth Profiles. + +try { + Get-V2024ProfileConfigList-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ProfileConfigList -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProfileConfigList" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-profile-config +This API updates an existing Auth Profile. The following fields are patchable: +**offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Auth Profile to patch. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**AuthProfile**](../models/auth-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the Auth Profile as updated. | AuthProfile +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | + + +# Patch a specified Auth Profile + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ProfileConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ProfileConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProfileConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AuthUsersApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AuthUsersApi.md new file mode 100644 index 000000000..aff442119 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024AuthUsersApi.md @@ -0,0 +1,126 @@ + +--- +id: v2024-auth-users +title: AuthUsers +pagination_label: AuthUsers +sidebar_label: AuthUsers +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AuthUsers', 'V2024AuthUsers'] +slug: /tools/sdk/powershell/v2024/methods/auth-users +tags: ['SDK', 'Software Development Kit', 'AuthUsers', 'V2024AuthUsers'] +--- + +# AuthUsers + Use this API to implement user authentication system functionality. +With this functionality in place, users can get a user's authentication system details, including their capabilities, and modify those capabilities. +The user's capabilities refer to their access to different systems, or authorization, within the tenant, like access to certifications (CERT_ADMIN) or reports (REPORT_ADMIN). +These capabilities also determine a user's access to the different APIs. +This API provides users with a way to determine a user's access and make quick and easy changes to that access. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024AuthUser**](#get-auth-user) | **GET** `/auth-users/{id}` | Auth User Details +[**Update-V2024AuthUser**](#patch-auth-user) | **PATCH** `/auth-users/{id}` | Auth User Update + +## get-auth-user +Return the specified user's authentication system details. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Identity ID + +### Return type +[**AuthUser**](../models/auth-user) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The specified user's authentication system details. | AuthUser +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + +# Auth User Details + +try { + Get-V2024AuthUser-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AuthUser -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthUser" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-auth-user +Use a PATCH request to update an existing user in the authentication system. +Use this endpoint to modify these fields: + * `capabilities` + +A '400.1.1 Illegal update attempt' detail code indicates that you attempted to PATCH a field that is not allowed. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Identity ID + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**AuthUser**](../models/auth-user) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Auth user updated. | AuthUser +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +# Auth User Update + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthUser-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthUser -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthUser" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024BrandingApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024BrandingApi.md new file mode 100644 index 000000000..395f47023 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024BrandingApi.md @@ -0,0 +1,272 @@ + +--- +id: v2024-branding +title: Branding +pagination_label: Branding +sidebar_label: Branding +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Branding', 'V2024Branding'] +slug: /tools/sdk/powershell/v2024/methods/branding +tags: ['SDK', 'Software Development Kit', 'Branding', 'V2024Branding'] +--- + +# Branding + Use this API to implement and customize branding functionality. +With this functionality in place, administrators can get and manage existing branding items, and they can also create new branding items and configure them for use throughout Identity Security Cloud. +The Branding APIs provide administrators with a way to customize branding items. +This customization includes details like their colors, logos, and other information. +Refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html) for more information about certifications. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024BrandingItem**](#create-branding-item) | **POST** `/brandings` | Create a branding item +[**Remove-V2024Branding**](#delete-branding) | **DELETE** `/brandings/{name}` | Delete a branding item +[**Get-V2024Branding**](#get-branding) | **GET** `/brandings/{name}` | Get a branding item +[**Get-V2024BrandingList**](#get-branding-list) | **GET** `/brandings` | List of branding items +[**Set-V2024BrandingItem**](#set-branding-item) | **PUT** `/brandings/{name}` | Update a branding item + +## create-branding-item +This API endpoint creates a branding item. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | Name | **String** | True | name of branding item + | ProductName | **String** | True | product name + | ActionButtonColor | **String** | (optional) | hex value of color for action button + | ActiveLinkColor | **String** | (optional) | hex value of color for link + | NavigationColor | **String** | (optional) | hex value of color for navigation bar + | EmailFromAddress | **String** | (optional) | email from address + | LoginInformationalMessage | **String** | (optional) | login information message + | FileStandard | **System.IO.FileInfo** | (optional) | png file with logo + +### Return type +[**BrandingItem**](../models/branding-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Branding item created | BrandingItem +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$Name = "MyName" # String | name of branding item +$ProductName = "MyProductName" # String | product name +$ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) +$ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) +$NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) +$EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) +$LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) +$FileStandard = # System.IO.FileInfo | png file with logo (optional) + +# Create a branding item + +try { + New-V2024BrandingItem-V2024Name $Name -V2024ProductName $ProductName + + # Below is a request that includes all optional parameters + # New-V2024BrandingItem -V2024Name $Name -V2024ProductName $ProductName -V2024ActionButtonColor $ActionButtonColor -V2024ActiveLinkColor $ActiveLinkColor -V2024NavigationColor $NavigationColor -V2024EmailFromAddress $EmailFromAddress -V2024LoginInformationalMessage $LoginInformationalMessage -V2024FileStandard $FileStandard +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024BrandingItem" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-branding +This API endpoint delete information for an existing branding item by name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Name | **String** | True | The name of the branding item to be deleted + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Name = "default" # String | The name of the branding item to be deleted + +# Delete a branding item + +try { + Remove-V2024Branding-V2024Name $Name + + # Below is a request that includes all optional parameters + # Remove-V2024Branding -V2024Name $Name +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Branding" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-branding +This API endpoint retrieves information for an existing branding item by name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Name | **String** | True | The name of the branding item to be retrieved + +### Return type +[**BrandingItem**](../models/branding-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A branding item object | BrandingItem +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Name = "default" # String | The name of the branding item to be retrieved + +# Get a branding item + +try { + Get-V2024Branding-V2024Name $Name + + # Below is a request that includes all optional parameters + # Get-V2024Branding -V2024Name $Name +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Branding" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-branding-list +This API endpoint returns a list of branding items. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**BrandingItem[]**](../models/branding-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of branding items. | BrandingItem[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List of branding items + +try { + Get-V2024BrandingList + + # Below is a request that includes all optional parameters + # Get-V2024BrandingList +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BrandingList" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-branding-item +This API endpoint updates information for an existing branding item. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Name | **String** | True | The name of the branding item to be retrieved + | Name2 | **String** | True | name of branding item + | ProductName | **String** | True | product name + | ActionButtonColor | **String** | (optional) | hex value of color for action button + | ActiveLinkColor | **String** | (optional) | hex value of color for link + | NavigationColor | **String** | (optional) | hex value of color for navigation bar + | EmailFromAddress | **String** | (optional) | email from address + | LoginInformationalMessage | **String** | (optional) | login information message + | FileStandard | **System.IO.FileInfo** | (optional) | png file with logo + +### Return type +[**BrandingItem**](../models/branding-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Branding item updated | BrandingItem +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$Name = "default" # String | The name of the branding item to be retrieved +$Name2 = "Name_example" # String | name of branding item +$ProductName = "MyProductName" # String | product name +$ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) +$ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) +$NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) +$EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) +$LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) +$FileStandard = # System.IO.FileInfo | png file with logo (optional) + +# Update a branding item + +try { + Set-V2024BrandingItem-V2024Name $Name -V2024Name2 $Name2 -V2024ProductName $ProductName + + # Below is a request that includes all optional parameters + # Set-V2024BrandingItem -V2024Name $Name -V2024Name2 $Name2 -V2024ProductName $ProductName -V2024ActionButtonColor $ActionButtonColor -V2024ActiveLinkColor $ActiveLinkColor -V2024NavigationColor $NavigationColor -V2024EmailFromAddress $EmailFromAddress -V2024LoginInformationalMessage $LoginInformationalMessage -V2024FileStandard $FileStandard +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024BrandingItem" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024CertificationCampaignFiltersApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024CertificationCampaignFiltersApi.md new file mode 100644 index 000000000..16c0c81c5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024CertificationCampaignFiltersApi.md @@ -0,0 +1,310 @@ + +--- +id: v2024-certification-campaign-filters +title: CertificationCampaignFilters +pagination_label: CertificationCampaignFilters +sidebar_label: CertificationCampaignFilters +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationCampaignFilters', 'V2024CertificationCampaignFilters'] +slug: /tools/sdk/powershell/v2024/methods/certification-campaign-filters +tags: ['SDK', 'Software Development Kit', 'CertificationCampaignFilters', 'V2024CertificationCampaignFilters'] +--- + +# CertificationCampaignFilters + Use this API to implement the certification campaign filter functionality. These filters can be used to create a certification campaign that includes a subset of your entitlements or users to certify. + +For example, if for a certification campaign an organization wants to certify only specific users or entitlements, then those can be included/excluded on the basis of campaign filters. + +For more information about creating a campaign filter, refer to [Creating a Campaign Filter](https://documentation.sailpoint.com/saas/help/certs/campaign_filters.html#creating-a-campaign-filter) + +You can create campaign filters using any of the following criteria types: + +- Access Profile : This criteria type includes or excludes access profiles from a campaign. + +- Account Attribute : This criteria type includes or excludes certification items that match a specified value in an account attribute. + +- Entitlement : This criteria type includes or excludes entitlements from a campaign. + +- Identity : This criteria type includes or excludes specific identities from your campaign. + +- Identity Attribute : This criteria type includes or excludes identities based on whether they have an identity attribute that matches criteria you've chosen. + +- Role : This criteria type includes or excludes roles, as opposed to identities. + +- Source : This criteria type includes or excludes entitlements from a source you select. + +For more information about these criteria types, refer to [Types of Campaign Filters](https://documentation.sailpoint.com/saas/help/certs/campaign_filters.html#types-of-campaign-filters) + +Once the campaign filter is created, it can be linked while creating the campaign. The generated campaign will have the items to review as per the campaign filter. + +For example, An inclusion campaign filter is created with a source of Source 1, an operation of Equals, and an entitlement of Entitlement 1. When this filter is selected, only users who have Entitlement 1 are included in the campaign, and only Entitlement 1 is shown in the certification. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024CampaignFilter**](#create-campaign-filter) | **POST** `/campaign-filters` | Create Campaign Filter +[**Remove-V2024CampaignFilters**](#delete-campaign-filters) | **POST** `/campaign-filters/delete` | Deletes Campaign Filters +[**Get-V2024CampaignFilterById**](#get-campaign-filter-by-id) | **GET** `/campaign-filters/{id}` | Get Campaign Filter by ID +[**Get-V2024CampaignFilters**](#list-campaign-filters) | **GET** `/campaign-filters` | List Campaign Filters +[**Update-V2024CampaignFilter**](#update-campaign-filter) | **POST** `/campaign-filters/{id}` | Updates a Campaign Filter + +## create-campaign-filter +Use this API to create a campaign filter based on filter details and criteria. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CampaignFilterDetails | [**CampaignFilterDetails**](../models/campaign-filter-details) | True | + +### Return type +[**CampaignFilterDetails**](../models/campaign-filter-details) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Created successfully. | CampaignFilterDetails +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CampaignFilterDetails = @"{ + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] +}"@ + +# Create Campaign Filter + +try { + $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails + New-V2024CampaignFilter-V2024CampaignFilterDetails $Result + + # Below is a request that includes all optional parameters + # New-V2024CampaignFilter -V2024CampaignFilterDetails $CampaignFilterDetails +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CampaignFilter" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-campaign-filters +Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | RequestBody | **[]String** | True | A json list of IDs of campaign filters to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filters to delete. + $RequestBody = @""@ # String[] | A json list of IDs of campaign filters to delete. + + +# Deletes Campaign Filters + +try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-V2024CampaignFilters-V2024RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-V2024CampaignFilters -V2024RequestBody $RequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignFilters" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-campaign-filter-by-id +Retrieves information for an existing campaign filter using the filter's ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the campaign filter to be retrieved. + +### Return type +[**CampaignFilterDetails**](../models/campaign-filter-details) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A campaign filter object. | CampaignFilterDetails +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved. + +# Get Campaign Filter by ID + +try { + Get-V2024CampaignFilterById-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CampaignFilterById -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignFilterById" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-campaign-filters +Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Start | **Int32** | (optional) (default to 0) | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | IncludeSystemFilters | **Boolean** | (optional) (default to $true) | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. + +### Return type +[**ListCampaignFilters200Response**](../models/list-campaign-filters200-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of campaign filter objects. | ListCampaignFilters200Response +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Start = 0 # Int32 | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$IncludeSystemFilters = $true # Boolean | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to $true) + +# List Campaign Filters + +try { + Get-V2024CampaignFilters + + # Below is a request that includes all optional parameters + # Get-V2024CampaignFilters -V2024Limit $Limit -V2024Start $Start -V2024IncludeSystemFilters $IncludeSystemFilters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignFilters" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-campaign-filter +Updates an existing campaign filter using the filter's ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | FilterId | **String** | True | The ID of the campaign filter being modified. + Body | CampaignFilterDetails | [**CampaignFilterDetails**](../models/campaign-filter-details) | True | A campaign filter details with updated field values. + +### Return type +[**CampaignFilterDetails**](../models/campaign-filter-details) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Created successfully. | CampaignFilterDetails +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$FilterId = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter being modified. +$CampaignFilterDetails = @"{ + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] +}"@ + +# Updates a Campaign Filter + +try { + $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails + Update-V2024CampaignFilter-V2024FilterId $FilterId -V2024CampaignFilterDetails $Result + + # Below is a request that includes all optional parameters + # Update-V2024CampaignFilter -V2024FilterId $FilterId -V2024CampaignFilterDetails $CampaignFilterDetails +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CampaignFilter" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024CertificationCampaignsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024CertificationCampaignsApi.md new file mode 100644 index 000000000..76b3d8e38 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024CertificationCampaignsApi.md @@ -0,0 +1,1404 @@ + +--- +id: v2024-certification-campaigns +title: CertificationCampaigns +pagination_label: CertificationCampaigns +sidebar_label: CertificationCampaigns +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationCampaigns', 'V2024CertificationCampaigns'] +slug: /tools/sdk/powershell/v2024/methods/certification-campaigns +tags: ['SDK', 'Software Development Kit', 'CertificationCampaigns', 'V2024CertificationCampaigns'] +--- + +# CertificationCampaigns + Use this API to implement certification campaign functionality. +With this functionality in place, administrators can create, customize, and manage certification campaigns for their organizations' use. +Certification campaigns provide Identity Security Cloud users with an interactive review process they can use to identify and verify access to systems. +Campaigns help organizations reduce risk of inappropriate access and satisfy audit requirements. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification campaign as a way of showing that a user's access has been reviewed and approved by multiple managers. +Once this campaign has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Identity Security Cloud provides two simple campaign types users can create without using search queries, Manager and Source Owner campaigns: + +You can create these types of campaigns without using any search queries in Identity Security Cloud: + +- ManagerCampaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access is certified by their managers. +You only need to provide a name and description to create one. + +- Source Owner Campaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access to a source is certified by its source owners. +You only need to provide a name and description to create one. +You can specify the sources whose owners you want involved or just run it across all sources. + +For more information about these campaign types, refer to [Starting a Manager or Source Owner Campaign](https://documentation.sailpoint.com/saas/help/certs/starting_campaign.html). + +One useful way to create certification campaigns in Identity Security Cloud is to use a specific search and then run a campaign on the results returned by that search. +This allows you to be much more specific about whom you are certifying in your campaigns and what access you are certifying in your campaigns. +For example, you can search for all identities who are managed by "Amanda.Ross" and also have the access to the "Accounting" role and then run a certification campaign based on that search to ensure that the returned identities are appropriately certified. + +You can use Identity Security Cloud search queries to create these types of campaigns: + +- Identities: Use this campaign type to review and revoke access items for specific identities. +You can either build a search query and create a campaign certifying all identities returned by that query, or you can search for individual identities and add those identities to the certification campaign. + +- Access Items: Use this campaign type to review and revoke a set of roles, access profiles, or entitlements from the identities that have them. +You can either build a search query and create a campaign certifying all access items returned by that query, or you can search for individual access items and add those items to the certification campaign. + +- Role Composition: Use this campaign type to review a role's composition, including its title, description, and membership criteria. +You can either build a search query and create a campaign certifying all roles returned by that query, or you can search for individual roles and add those roles to the certification campaign. + +- Uncorrelated Accounts: Use this campaign type to certify source accounts that aren't linked to an authoritative identity in Identity Security Cloud. +You can use this campaign type to view all the uncorrelated accounts for a source and certify them. + +For more information about search-based campaigns, refer to [Starting a Campaign from Search](https://documentation.sailpoint.com/saas/help/certs/starting_search_campaign.html). + +Once you have generated your campaign, it becomes available for preview. +An administrator can review the campaign and make changes, or if it's ready and accurate, activate it. + +Once the campaign is active, organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers. +Those reviewers can view any of the certifications they either need to review (active) or have already reviewed (completed). + +When a certification campaign is in progress, certification reviewers see the listed active certifications whose involved identities they can review. +Reviewers can then make decisions to grant or revoke access, as well as reassign the certification to another reviewer. If the reviewer chooses this option, they must provide a reason for reassignment in the form of a comment. + +Once a reviewer has made decisions on all the certification's involved access items, he or she must "Sign Off" to complete the review process. +Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. + +Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. +In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. +In this situation, the certification campaign completes once all the remediation requests are completed. + +The end of a certification campaign is determined by its deadline, its completion status, or by an administrator's decision. + +For more information about certifications and certification campaigns, refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html). + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Complete-V2024Campaign**](#complete-campaign) | **POST** `/campaigns/{id}/complete` | Complete a Campaign +[**New-V2024Campaign**](#create-campaign) | **POST** `/campaigns` | Create a campaign +[**New-V2024CampaignTemplate**](#create-campaign-template) | **POST** `/campaign-templates` | Create a Campaign Template +[**Remove-V2024CampaignTemplate**](#delete-campaign-template) | **DELETE** `/campaign-templates/{id}` | Delete a Campaign Template +[**Remove-V2024CampaignTemplateSchedule**](#delete-campaign-template-schedule) | **DELETE** `/campaign-templates/{id}/schedule` | Delete Campaign Template Schedule +[**Remove-V2024Campaigns**](#delete-campaigns) | **POST** `/campaigns/delete` | Delete Campaigns +[**Get-V2024ActiveCampaigns**](#get-active-campaigns) | **GET** `/campaigns` | List Campaigns +[**Get-V2024Campaign**](#get-campaign) | **GET** `/campaigns/{id}` | Get Campaign +[**Get-V2024CampaignReports**](#get-campaign-reports) | **GET** `/campaigns/{id}/reports` | Get Campaign Reports +[**Get-V2024CampaignReportsConfig**](#get-campaign-reports-config) | **GET** `/campaigns/reports-configuration` | Get Campaign Reports Configuration +[**Get-V2024CampaignTemplate**](#get-campaign-template) | **GET** `/campaign-templates/{id}` | Get a Campaign Template +[**Get-V2024CampaignTemplateSchedule**](#get-campaign-template-schedule) | **GET** `/campaign-templates/{id}/schedule` | Get Campaign Template Schedule +[**Get-V2024CampaignTemplates**](#get-campaign-templates) | **GET** `/campaign-templates` | List Campaign Templates +[**Move-V2024**](#move) | **POST** `/campaigns/{id}/reassign` | Reassign Certifications +[**Update-V2024CampaignTemplate**](#patch-campaign-template) | **PATCH** `/campaign-templates/{id}` | Update a Campaign Template +[**Set-V2024CampaignReportsConfig**](#set-campaign-reports-config) | **PUT** `/campaigns/reports-configuration` | Set Campaign Reports Configuration +[**Set-V2024CampaignTemplateSchedule**](#set-campaign-template-schedule) | **PUT** `/campaign-templates/{id}/schedule` | Set Campaign Template Schedule +[**Start-V2024Campaign**](#start-campaign) | **POST** `/campaigns/{id}/activate` | Activate a Campaign +[**Start-V2024CampaignRemediationScan**](#start-campaign-remediation-scan) | **POST** `/campaigns/{id}/run-remediation-scan` | Run Campaign Remediation Scan +[**Start-V2024CampaignReport**](#start-campaign-report) | **POST** `/campaigns/{id}/run-report/{type}` | Run Campaign Report +[**Start-V2024GenerateCampaignTemplate**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a Campaign from Template +[**Update-V2024Campaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a Campaign + +## complete-campaign +:::caution + +This endpoint will run successfully for any campaigns that are **past due**. + +This endpoint will return a content error if the campaign is **not past due**. + +::: + +Use this API to complete a certification campaign. This functionality is provided to admins so that they +can complete a certification even if all items have not been completed. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Campaign ID. + Body | CampaignCompleteOptions | [**CampaignCompleteOptions**](../models/campaign-complete-options) | (optional) | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. +$CampaignCompleteOptions = @"{ + "autoCompleteAction" : "REVOKE" +}"@ + +# Complete a Campaign + +try { + Complete-V2024Campaign-V2024Id $Id + + # Below is a request that includes all optional parameters + # Complete-V2024Campaign -V2024Id $Id -V2024CampaignCompleteOptions $CampaignCompleteOptions +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024Campaign" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-campaign +Use this API to create a certification campaign with the information provided in the request body. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Campaign | [**Campaign**](../models/campaign) | True | + +### Return type +[**Campaign**](../models/campaign) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | This response indicates that the requested campaign was successfully created, and the API returns its representation. | Campaign +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Campaign = @"{ + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" +}"@ + +# Create a campaign + +try { + $Result = ConvertFrom-JsonToCampaign -Json $Campaign + New-V2024Campaign-V2024Campaign $Result + + # Below is a request that includes all optional parameters + # New-V2024Campaign -V2024Campaign $Campaign +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Campaign" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-campaign-template +Use this API to create a certification campaign template based on campaign. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CampaignTemplate | [**CampaignTemplate**](../models/campaign-template) | True | + +### Return type +[**CampaignTemplate**](../models/campaign-template) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Created successfully. | CampaignTemplate +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CampaignTemplate = @"{ + "ownerRef" : { + "name" : "Mister Manager", + "id" : "2c918086676d3e0601677611dbde220f", + "type" : "IDENTITY", + "email" : "mr.manager@example.com" + }, + "deadlineDuration" : "P2W", + "created" : "2020-03-05T22:44:00.364Z", + "scheduled" : false, + "name" : "Manager Campaign Template", + "description" : "Template for the annual manager campaign.", + "modified" : "2020-03-05T22:52:09.969Z", + "campaign" : { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }, + "id" : "2c9079b270a266a60170a277bb960008" +}"@ + +# Create a Campaign Template + +try { + $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate + New-V2024CampaignTemplate-V2024CampaignTemplate $Result + + # Below is a request that includes all optional parameters + # New-V2024CampaignTemplate -V2024CampaignTemplate $CampaignTemplate +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CampaignTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-campaign-template +Use this API to delete a certification campaign template by ID. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign template being deleted. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. + +# Delete a Campaign Template + +try { + Remove-V2024CampaignTemplate-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024CampaignTemplate -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-campaign-template-schedule +Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign template whose schedule is being deleted. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. + +# Delete Campaign Template Schedule + +try { + Remove-V2024CampaignTemplateSchedule-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024CampaignTemplateSchedule -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignTemplateSchedule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-campaigns +Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CampaignsDeleteRequest | [**CampaignsDeleteRequest**](../models/campaigns-delete-request) | True | IDs of the campaigns to delete. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CampaignsDeleteRequest = @"{ + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] +}"@ + +# Delete Campaigns + +try { + $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest + Remove-V2024Campaigns-V2024CampaignsDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024Campaigns -V2024CampaignsDeleteRequest $CampaignsDeleteRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Campaigns" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-active-campaigns +Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Detail | **String** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** + +### Return type +[**GetActiveCampaigns200ResponseInner[]**](../models/get-active-campaigns200-response-inner) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of campaign objects. By default list of SLIM campaigns is returned. | GetActiveCampaigns200ResponseInner[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'name eq "Manager Campaign"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) + +# List Campaigns + +try { + Get-V2024ActiveCampaigns + + # Below is a request that includes all optional parameters + # Get-V2024ActiveCampaigns -V2024Detail $Detail -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ActiveCampaigns" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-campaign +Use this API to get information for an existing certification campaign by the campaign's ID. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign to be retrieved. + Query | Detail | **String** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. + +### Return type +[**GetActiveCampaigns200ResponseInner**](../models/get-active-campaigns200-response-inner) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Requested campaign object. | GetActiveCampaigns200ResponseInner +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. +$Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + +# Get Campaign + +try { + Get-V2024Campaign-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Campaign -V2024Id $Id -V2024Detail $Detail +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Campaign" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-campaign-reports +Use this API to fetch all reports for a certification campaign by campaign ID. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign whose reports are being fetched. + +### Return type +[**CampaignReport[]**](../models/campaign-report) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Array of campaign report objects. | CampaignReport[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. + +# Get Campaign Reports + +try { + Get-V2024CampaignReports-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CampaignReports -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignReports" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-campaign-reports-config +Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**CampaignReportsConfig**](../models/campaign-reports-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Campaign report configuration. | CampaignReportsConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Campaign Reports Configuration + +try { + Get-V2024CampaignReportsConfig + + # Below is a request that includes all optional parameters + # Get-V2024CampaignReportsConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignReportsConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-campaign-template +Use this API to fetch a certification campaign template by ID. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Requested campaign template's ID. + +### Return type +[**CampaignTemplate**](../models/campaign-template) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Data for the campaign matching the given ID. | CampaignTemplate +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. + +# Get a Campaign Template + +try { + Get-V2024CampaignTemplate-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CampaignTemplate -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-campaign-template-schedule +Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign template whose schedule is being fetched. + +### Return type +[**Schedule**](../models/schedule) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Current schedule for the campaign template. See the [Set Campaign Template Schedule endpoint documentation](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule) for more examples. | Schedule +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. + +# Get Campaign Template Schedule + +try { + Get-V2024CampaignTemplateSchedule-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CampaignTemplateSchedule -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplateSchedule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-campaign-templates +Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. + +The API returns all campaign templates matching the query parameters. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* + +### Return type +[**CampaignTemplate[]**](../models/campaign-template) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of campaign template objects. | CampaignTemplate[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) +$Filters = 'name eq "manager template"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + +# List Campaign Templates + +try { + Get-V2024CampaignTemplates + + # Below is a request that includes all optional parameters + # Get-V2024CampaignTemplates -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplates" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## move +This API reassigns the specified certifications from one identity to another. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The certification campaign ID + Body | AdminReviewReassign | [**AdminReviewReassign**](../models/admin-review-reassign) | True | + +### Return type +[**CertificationTask**](../models/certification-task) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | The reassign task that has been submitted. | CertificationTask +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID +$AdminReviewReassign = @"{ + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } +}"@ + +# Reassign Certifications + +try { + $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign + Move-V2024-V2024Id $Id -V2024AdminReviewReassign $Result + + # Below is a request that includes all optional parameters + # Move-V2024 -V2024Id $Id -V2024AdminReviewReassign $AdminReviewReassign +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-V2024" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-campaign-template +Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign template being modified. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) + +### Return type +[**CampaignTemplate**](../models/campaign-template) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | This response indicates that the PATCH operation succeeded, and the API returns the template's new representation. | CampaignTemplate +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) + + +# Update a Campaign Template + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024CampaignTemplate-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024CampaignTemplate -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CampaignTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-campaign-reports-config +Use this API to overwrite the configuration for campaign reports. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CampaignReportsConfig | [**CampaignReportsConfig**](../models/campaign-reports-config) | True | Campaign report configuration. + +### Return type +[**CampaignReportsConfig**](../models/campaign-reports-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The persisted campaign report configuration. | CampaignReportsConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CampaignReportsConfig = @"{ + "identityAttributeColumns" : [ "firstname", "lastname" ] +}"@ + +# Set Campaign Reports Configuration + +try { + $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig + Set-V2024CampaignReportsConfig-V2024CampaignReportsConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024CampaignReportsConfig -V2024CampaignReportsConfig $CampaignReportsConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024CampaignReportsConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-campaign-template-schedule +Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign template being scheduled. + Body | Schedule | [**Schedule**](../models/schedule) | (optional) | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template being scheduled. +$Schedule = @"{ + "hours" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "months" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "timeZoneId" : "CST", + "days" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "expiration" : "2000-01-23T04:56:07.000+00:00", + "type" : "WEEKLY" +}"@ + +# Set Campaign Template Schedule + +try { + Set-V2024CampaignTemplateSchedule-V2024Id $Id + + # Below is a request that includes all optional parameters + # Set-V2024CampaignTemplateSchedule -V2024Id $Id -V2024Schedule $Schedule +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024CampaignTemplateSchedule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-campaign +Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Campaign ID. + Body | ActivateCampaignOptions | [**ActivateCampaignOptions**](../models/activate-campaign-options) | (optional) | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. +$ActivateCampaignOptions = @"{ + "timeZone" : "-05:00" +}"@ + +# Activate a Campaign + +try { + Start-V2024Campaign-V2024Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024Campaign -V2024Id $Id -V2024ActivateCampaignOptions $ActivateCampaignOptions +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024Campaign" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-campaign-remediation-scan +Use this API to run a remediation scan task for a certification campaign. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign the remediation scan is being run for. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. + +# Run Campaign Remediation Scan + +try { + Start-V2024CampaignRemediationScan-V2024Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024CampaignRemediationScan -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024CampaignRemediationScan" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-campaign-report +Use this API to run a report for a certification campaign. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign the report is being run for. +Path | Type | [**ReportType**](../models/report-type) | True | Type of the report to run. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. +$Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run. + +# Run Campaign Report + +try { + Start-V2024CampaignReport-V2024Id $Id -V2024Type $Type + + # Below is a request that includes all optional parameters + # Start-V2024CampaignReport -V2024Id $Id -V2024Type $Type +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024CampaignReport" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-generate-campaign-template +Use this API to generate a new certification campaign from a campaign template. + +The campaign object contained in the template has special formatting applied to its name and description +fields that determine the generated campaign's name/description. Placeholders in those fields are +formatted with the current date and time upon generation. + +Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For +example, "%Y" inserts the current year, and a campaign template named "Campaign for %y" generates a +campaign called "Campaign for 2020" (assuming the year at generation time is 2020). + +Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign template to use for generation. + +### Return type +[**CampaignReference**](../models/campaign-reference) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | This response indicates that a campaign was successfully generated from this template, and the API returns a reference to the new campaign. | CampaignReference +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. + +# Generate a Campaign from Template + +try { + Start-V2024GenerateCampaignTemplate-V2024Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024GenerateCampaignTemplate -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024GenerateCampaignTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-campaign +Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign template being modified. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline + +### Return type +[**SlimCampaign**](../models/slim-campaign) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | This response indicates that the PATCH operation succeeded, and the API returns the campaign's new representation. | SlimCampaign +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline + + +# Update a Campaign + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Campaign-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Campaign -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Campaign" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024CertificationSummariesApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024CertificationSummariesApi.md new file mode 100644 index 000000000..a9199253a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024CertificationSummariesApi.md @@ -0,0 +1,237 @@ + +--- +id: v2024-certification-summaries +title: CertificationSummaries +pagination_label: CertificationSummaries +sidebar_label: CertificationSummaries +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationSummaries', 'V2024CertificationSummaries'] +slug: /tools/sdk/powershell/v2024/methods/certification-summaries +tags: ['SDK', 'Software Development Kit', 'CertificationSummaries', 'V2024CertificationSummaries'] +--- + +# CertificationSummaries + Use this API to implement certification summary functionality. +With this functionality in place, administrators and designated certification reviewers can review summaries of identity certification campaigns and draw conclusions about the campaigns' scope, security, and effectiveness. +Implementing certification summary functionality improves organizations' ability to review their [certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html) and helps them satisfy audit and regulatory requirements by enabling them to trace access changes and the decisions made in their review processes. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. +Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Certification summaries provide information about identity certification campaigns such as the identities involved, the number of decisions made, and the access changed. +For example, an administrator or designated certification reviewer can examine the Manager Certification campaign to get an overview of how many entitlement decisions are made in that campaign as opposed to role decisions, which identities would be affected by changes to the campaign, and how those identities' access would be affected. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024IdentityAccessSummaries**](#get-identity-access-summaries) | **GET** `/certifications/{id}/access-summaries/{type}` | Access Summaries +[**Get-V2024IdentityDecisionSummary**](#get-identity-decision-summary) | **GET** `/certifications/{id}/decision-summary` | Summary of Certification Decisions +[**Get-V2024IdentitySummaries**](#get-identity-summaries) | **GET** `/certifications/{id}/identity-summaries` | Identity Summaries for Campaign Certification +[**Get-V2024IdentitySummary**](#get-identity-summary) | **GET** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for Identity + +## get-identity-access-summaries +This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity campaign certification ID +Path | Type | **String** | True | The type of access review item to retrieve summaries for + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** + +### Return type +[**AccessSummary[]**](../models/access-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of access summaries | AccessSummary[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID +$Type = "ROLE" # String | The type of access review item to retrieve summaries for +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'access.id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) +$Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + +# Access Summaries + +try { + Get-V2024IdentityAccessSummaries-V2024Id $Id -V2024Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAccessSummaries -V2024Id $Id -V2024Type $Type -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessSummaries" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-decision-summary +This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The certification ID + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* + +### Return type +[**IdentityCertDecisionSummary**](../models/identity-cert-decision-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Summary of the decisions made | IdentityCertDecisionSummary +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID +$Filters = 'identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + +# Summary of Certification Decisions + +try { + Get-V2024IdentityDecisionSummary-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentityDecisionSummary -V2024Id $Id -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityDecisionSummary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-summaries +This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity campaign certification ID + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** + +### Return type +[**CertificationIdentitySummary[]**](../models/certification-identity-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of identity summaries | CertificationIdentitySummary[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + +# Identity Summaries for Campaign Certification + +try { + Get-V2024IdentitySummaries-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySummaries -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummaries" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-summary +This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity campaign certification ID +Path | IdentitySummaryId | **String** | True | The identity summary ID + +### Return type +[**CertificationIdentitySummary**](../models/certification-identity-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An identity summary | CertificationIdentitySummary +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID +$IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + +# Summary for Identity + +try { + Get-V2024IdentitySummary-V2024Id $Id -V2024IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySummary -V2024Id $Id -V2024IdentitySummaryId $IdentitySummaryId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024CertificationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024CertificationsApi.md new file mode 100644 index 000000000..087fa7a1a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024CertificationsApi.md @@ -0,0 +1,627 @@ + +--- +id: v2024-certifications +title: Certifications +pagination_label: Certifications +sidebar_label: Certifications +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Certifications', 'V2024Certifications'] +slug: /tools/sdk/powershell/v2024/methods/certifications +tags: ['SDK', 'Software Development Kit', 'Certifications', 'V2024Certifications'] +--- + +# Certifications + Use this API to implement certification functionality. +With this functionality in place, administrators and designated certification reviewers can review users' access certifications and decide whether to approve access, revoke it, or reassign the review to another reviewer. +Implementing certifications improves organizations' data security by reducing inappropriate access through a distributed review process and helping them satisfy audit and regulatory requirements. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. +Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers. +Those reviewers can select the 'Certifications' tab to view any of the certifications they either need to review or have already reviewed under the 'Active' and 'Completed' tabs, respectively. + +When a certification campaign is in progress, certification reviewers will see certifications listed under 'Active,' where they can review the involved identities. +Under the 'Decision' column on the right, next to each access item, reviewers can select the checkmark to approve access, select the 'X' to revoke access, or they can toggle the 'More Options' menu to reassign the certification to another reviewer and provide a reason for reassignment in the form of a comment. + +Once a reviewer has made decisions on all the certification's involved access items, he or she must select 'Sign Off' to complete the review process. +Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. + +Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. +In this situation, the certification campaign completes once all the remediation requests are completed. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024CertificationTask**](#get-certification-task) | **GET** `/certification-tasks/{id}` | Certification Task by ID +[**Get-V2024IdentityCertification**](#get-identity-certification) | **GET** `/certifications/{id}` | Identity Certification by ID +[**Get-V2024IdentityCertificationItemPermissions**](#get-identity-certification-item-permissions) | **GET** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for Entitlement Certification Item +[**Get-V2024PendingCertificationTasks**](#get-pending-certification-tasks) | **GET** `/certification-tasks` | List of Pending Certification Tasks +[**Get-V2024CertificationReviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of Reviewers for certification +[**Get-V2024IdentityAccessReviewItems**](#list-identity-access-review-items) | **GET** `/certifications/{id}/access-review-items` | List of Access Review Items +[**Get-V2024IdentityCertifications**](#list-identity-certifications) | **GET** `/certifications` | List Identity Campaign Certifications +[**Select-V2024IdentityDecision**](#make-identity-decision) | **POST** `/certifications/{id}/decide` | Decide on a Certification Item +[**Invoke-V2024ReassignIdentityCertifications**](#reassign-identity-certifications) | **POST** `/certifications/{id}/reassign` | Reassign Identities or Items +[**Invoke-V2024SignOffIdentityCertification**](#sign-off-identity-certification) | **POST** `/certifications/{id}/sign-off` | Finalize Identity Certification Decisions +[**Submit-V2024ReassignCertsAsync**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously + +## get-certification-task +This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The task ID + +### Return type +[**CertificationTask**](../models/certification-task) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A certification task | CertificationTask +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID + +# Certification Task by ID + +try { + Get-V2024CertificationTask-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CertificationTask -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CertificationTask" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-certification +This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The certification id + +### Return type +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An identity campaign certification object | IdentityCertificationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id + +# Identity Certification by ID + +try { + Get-V2024IdentityCertification-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentityCertification -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertification" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-certification-item-permissions +This API returns the permissions associated with an entitlement certification item based on the certification item's ID. Reviewers for this certification can also call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | CertificationId | **String** | True | The certification ID +Path | ItemId | **String** | True | The certification item ID + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**PermissionDto[]**](../models/permission-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of permissions associated with the given itemId | PermissionDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID +$ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID +$Filters = 'target eq "SYS.OBJAUTH2"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Permissions for Entitlement Certification Item + +try { + Get-V2024IdentityCertificationItemPermissions-V2024CertificationId $CertificationId -V2024ItemId $ItemId + + # Below is a request that includes all optional parameters + # Get-V2024IdentityCertificationItemPermissions -V2024CertificationId $CertificationId -V2024ItemId $ItemId -V2024Filters $Filters -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertificationItemPermissions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-pending-certification-tasks +This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | ReviewerIdentity | **String** | (optional) | The ID of reviewer identity. *me* indicates the current user. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* + +### Return type +[**CertificationTask[]**](../models/certification-task) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of pending certification tasks | CertificationTask[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$ReviewerIdentity = "Ada.1de82e55078344" # String | The ID of reviewer identity. *me* indicates the current user. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'type eq "ADMIN_REASSIGN"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) + +# List of Pending Certification Tasks + +try { + Get-V2024PendingCertificationTasks + + # Below is a request that includes all optional parameters + # Get-V2024PendingCertificationTasks -V2024ReviewerIdentity $ReviewerIdentity -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingCertificationTasks" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-certification-reviewers +This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The certification ID + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** + +### Return type +[**IdentityReferenceWithNameAndEmail[]**](../models/identity-reference-with-name-and-email) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of reviewers | IdentityReferenceWithNameAndEmail[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'name eq "Bob"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) + +# List of Reviewers for certification + +try { + Get-V2024CertificationReviewers-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CertificationReviewers -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CertificationReviewers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-identity-access-review-items +This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity campaign certification ID + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** + Query | Entitlements | **String** | (optional) | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. + Query | AccessProfiles | **String** | (optional) | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. + Query | Roles | **String** | (optional) | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. + +### Return type +[**AccessReviewItem[]**](../models/access-review-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of access review items | AccessReviewItem[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) +$Sorters = "access.name,-accessProfile.sourceName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) +$Entitlements = "identityEntitlement" # String | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) +$AccessProfiles = "accessProfile1" # String | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) +$Roles = "userRole" # String | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) + +# List of Access Review Items + +try { + Get-V2024IdentityAccessReviewItems-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAccessReviewItems -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters -V2024Entitlements $Entitlements -V2024AccessProfiles $AccessProfiles -V2024Roles $Roles +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessReviewItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-identity-certifications +Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | ReviewerIdentity | **String** | (optional) | Reviewer's identity. *me* indicates the current user. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** + +### Return type +[**IdentityCertificationDto[]**](../models/identity-certification-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of identity campaign certifications. | IdentityCertificationDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$ReviewerIdentity = "me" # String | Reviewer's identity. *me* indicates the current user. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) +$Sorters = "name,due" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) + +# List Identity Campaign Certifications + +try { + Get-V2024IdentityCertifications + + # Below is a request that includes all optional parameters + # Get-V2024IdentityCertifications -V2024ReviewerIdentity $ReviewerIdentity -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertifications" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## make-identity-decision +The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the identity campaign certification on which to make decisions + Body | ReviewDecision | [**[]ReviewDecision**](../models/review-decision) | True | A non-empty array of decisions to be made. + +### Return type +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An identity campaign certification object | IdentityCertificationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campaign certification on which to make decisions + $ReviewDecision = @"{ + "comments" : "This user no longer needs access to this source", + "decision" : "APPROVE", + "proposedEndDate" : "2017-07-11T18:45:37.098Z", + "recommendation" : { + "reasons" : [ "Reason 1", "Reason 2" ], + "recommendation" : "recommendation", + "timestamp" : "2020-06-01T13:49:37.385Z" + }, + "id" : "ef38f94347e94562b5bb8424a56397d8", + "bulk" : true +}"@ # ReviewDecision[] | A non-empty array of decisions to be made. + + +# Decide on a Certification Item + +try { + $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision + Select-V2024IdentityDecision-V2024Id $Id -V2024ReviewDecision $Result + + # Below is a request that includes all optional parameters + # Select-V2024IdentityDecision -V2024Id $Id -V2024ReviewDecision $ReviewDecision +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-V2024IdentityDecision" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## reassign-identity-certifications +This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity campaign certification ID + Body | ReviewReassign | [**ReviewReassign**](../models/review-reassign) | True | + +### Return type +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An identity campaign certification details after completing the reassignment. | IdentityCertificationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID +$ReviewReassign = @"{ + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] +}"@ + +# Reassign Identities or Items + +try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Invoke-V2024ReassignIdentityCertifications-V2024Id $Id -V2024ReviewReassign $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024ReassignIdentityCertifications -V2024Id $Id -V2024ReviewReassign $ReviewReassign +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ReassignIdentityCertifications" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## sign-off-identity-certification +This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity campaign certification ID + +### Return type +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An identity campaign certification object | IdentityCertificationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + +# Finalize Identity Certification Decisions + +try { + Invoke-V2024SignOffIdentityCertification-V2024Id $Id + + # Below is a request that includes all optional parameters + # Invoke-V2024SignOffIdentityCertification -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024SignOffIdentityCertification" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## submit-reassign-certs-async +This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another +reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the +reassignment is complete. + +Reviewers for this certification can also call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity campaign certification ID + Body | ReviewReassign | [**ReviewReassign**](../models/review-reassign) | True | + +### Return type +[**CertificationTask**](../models/certification-task) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A certification task object for the reassignment which can be queried for status. | CertificationTask +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID +$ReviewReassign = @"{ + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] +}"@ + +# Reassign Certifications Asynchronously + +try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Submit-V2024ReassignCertsAsync-V2024Id $Id -V2024ReviewReassign $Result + + # Below is a request that includes all optional parameters + # Submit-V2024ReassignCertsAsync -V2024Id $Id -V2024ReviewReassign $ReviewReassign +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReassignCertsAsync" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ConfigurationHubApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ConfigurationHubApi.md new file mode 100644 index 000000000..8c4aeb435 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ConfigurationHubApi.md @@ -0,0 +1,809 @@ + +--- +id: v2024-configuration-hub +title: ConfigurationHub +pagination_label: ConfigurationHub +sidebar_label: ConfigurationHub +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigurationHub', 'V2024ConfigurationHub'] +slug: /tools/sdk/powershell/v2024/methods/configuration-hub +tags: ['SDK', 'Software Development Kit', 'ConfigurationHub', 'V2024ConfigurationHub'] +--- + +# ConfigurationHub + Use this API to implement and customize configuration settings management. With this functionality, you can access the Configuration Hub actions and build your own automated pipeline for Identity Security Cloud configuration change delivery and deployment. + +Common usages for Configuration Hub includes: + +- Upload configuration file - Configuration files can be managed and deployed using Configuration Hub by uploading a JSON file which contains configuration data. +- Manage object mapping - Create rules to map and substitute attributes when migrating configurations. +- Manage backups for configuration settings +- Manage configuration drafts +- Upload configurations and manage object mappings between tenants. + +Refer to [Using the SailPoint Configuration Hub](https://documentation.sailpoint.com/saas/help/confighub/config_hub.html) for more information about Configuration Hub. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024Deploy**](#create-deploy) | **POST** `/configuration-hub/deploys` | Create a Deploy +[**New-V2024ObjectMapping**](#create-object-mapping) | **POST** `/configuration-hub/object-mappings/{sourceOrg}` | Creates an object mapping +[**New-V2024ObjectMappings**](#create-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-create` | Bulk creates object mappings +[**New-V2024UploadedConfiguration**](#create-uploaded-configuration) | **POST** `/configuration-hub/backups/uploads` | Upload a Configuration +[**Remove-V2024Backup**](#delete-backup) | **DELETE** `/configuration-hub/backups/{id}` | Delete a Backup +[**Remove-V2024Draft**](#delete-draft) | **DELETE** `/configuration-hub/drafts/{id}` | Delete a draft +[**Remove-V2024ObjectMapping**](#delete-object-mapping) | **DELETE** `/configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}` | Deletes an object mapping +[**Remove-V2024UploadedConfiguration**](#delete-uploaded-configuration) | **DELETE** `/configuration-hub/backups/uploads/{id}` | Delete an Uploaded Configuration +[**Get-V2024Deploy**](#get-deploy) | **GET** `/configuration-hub/deploys/{id}` | Get a Deploy +[**Get-V2024ObjectMappings**](#get-object-mappings) | **GET** `/configuration-hub/object-mappings/{sourceOrg}` | Gets list of object mappings +[**Get-V2024UploadedConfiguration**](#get-uploaded-configuration) | **GET** `/configuration-hub/backups/uploads/{id}` | Get an Uploaded Configuration +[**Get-V2024Backups**](#list-backups) | **GET** `/configuration-hub/backups` | List Backups +[**Get-V2024Deploys**](#list-deploys) | **GET** `/configuration-hub/deploys` | List Deploys +[**Get-V2024Drafts**](#list-drafts) | **GET** `/configuration-hub/drafts` | List Drafts +[**Get-V2024UploadedConfigurations**](#list-uploaded-configurations) | **GET** `/configuration-hub/backups/uploads` | List Uploaded Configurations +[**Update-V2024ObjectMappings**](#update-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings + +## create-deploy +This API performs a deploy based on an existing daft. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | DeployRequest | [**DeployRequest**](../models/deploy-request) | True | The deploy request body. + +### Return type +[**DeployResponse**](../models/deploy-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Deploy job accepted and queued for processing. | DeployResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$DeployRequest = @"{ + "draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" +}"@ + +# Create a Deploy + +try { + $Result = ConvertFrom-JsonToDeployRequest -Json $DeployRequest + New-V2024Deploy-V2024DeployRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024Deploy -V2024DeployRequest $DeployRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Deploy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-object-mapping +This creates an object mapping between current org and source org. +Source org should be "default" when creating an object mapping that is not to be associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceOrg | **String** | True | The name of the source org. + Body | ObjectMappingRequest | [**ObjectMappingRequest**](../models/object-mapping-request) | True | The object mapping request body. + +### Return type +[**ObjectMappingResponse**](../models/object-mapping-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The created object mapping between current org and source org. | ObjectMappingResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceOrg = "source-org" # String | The name of the source org. +$ObjectMappingRequest = @"{ + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" +}"@ + +# Creates an object mapping + +try { + $Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest + New-V2024ObjectMapping-V2024SourceOrg $SourceOrg -V2024ObjectMappingRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ObjectMapping -V2024SourceOrg $SourceOrg -V2024ObjectMappingRequest $ObjectMappingRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMapping" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-object-mappings +This creates a set of object mappings (Max 25) between current org and source org. +Source org should be "default" when creating object mappings that are not to be associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceOrg | **String** | True | The name of the source org. + Body | ObjectMappingBulkCreateRequest | [**ObjectMappingBulkCreateRequest**](../models/object-mapping-bulk-create-request) | True | The bulk create object mapping request body. + +### Return type +[**ObjectMappingBulkCreateResponse**](../models/object-mapping-bulk-create-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The created object mapping between current org and source org. | ObjectMappingBulkCreateResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceOrg = "source-org" # String | The name of the source org. +$ObjectMappingBulkCreateRequest = @"{ + "newObjectsMappings" : [ { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + }, { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } ] +}"@ + +# Bulk creates object mappings + +try { + $Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest + New-V2024ObjectMappings-V2024SourceOrg $SourceOrg -V2024ObjectMappingBulkCreateRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ObjectMappings -V2024SourceOrg $SourceOrg -V2024ObjectMappingBulkCreateRequest $ObjectMappingBulkCreateRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMappings" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-uploaded-configuration +This API uploads a JSON configuration file into a tenant. + +Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. + +Refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects) for more information about supported objects. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | Data | **System.IO.FileInfo** | True | JSON file containing the objects to be imported. + | Name | **String** | True | Name that will be assigned to the uploaded configuration file. + +### Return type +[**BackupResponse**](../models/backup-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Upload job accepted and queued for processing. | BackupResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$Data = # System.IO.FileInfo | JSON file containing the objects to be imported. +$Name = "MyName" # String | Name that will be assigned to the uploaded configuration file. + +# Upload a Configuration + +try { + New-V2024UploadedConfiguration-V2024Data $Data -V2024Name $Name + + # Below is a request that includes all optional parameters + # New-V2024UploadedConfiguration -V2024Data $Data -V2024Name $Name +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024UploadedConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-backup +This API deletes an existing backup for the current tenant. + +On success, this endpoint will return an empty response. + +The backup id can be obtained from the response after a backup was successfully created, or from the list backups endpoint. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The id of the backup to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the backup to delete. + +# Delete a Backup + +try { + Remove-V2024Backup-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Backup -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Backup" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-draft +This API deletes an existing draft for the current tenant. + +On success, this endpoint will return an empty response. + +The draft id can be obtained from the response after a draft was successfully created, or from the list drafts endpoint. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The id of the draft to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the draft to delete. + +# Delete a draft + +try { + Remove-V2024Draft-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Draft -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Draft" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-object-mapping +This deletes an existing object mapping. +Source org should be "default" when deleting an object mapping that is not associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceOrg | **String** | True | The name of the source org. +Path | ObjectMappingId | **String** | True | The id of the object mapping to be deleted. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceOrg = "source-org" # String | The name of the source org. +$ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of the object mapping to be deleted. + +# Deletes an object mapping + +try { + Remove-V2024ObjectMapping-V2024SourceOrg $SourceOrg -V2024ObjectMappingId $ObjectMappingId + + # Below is a request that includes all optional parameters + # Remove-V2024ObjectMapping -V2024SourceOrg $SourceOrg -V2024ObjectMappingId $ObjectMappingId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ObjectMapping" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-uploaded-configuration +This API deletes an uploaded configuration based on Id. + +On success, this endpoint will return an empty response. + +The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The id of the uploaded configuration. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. + +# Delete an Uploaded Configuration + +try { + Remove-V2024UploadedConfiguration-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024UploadedConfiguration -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024UploadedConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-deploy +This API gets an existing deploy for the current tenant. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The id of the deploy. + +### Return type +[**DeployResponse**](../models/deploy-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Gets the details of a deploy. | DeployResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the deploy. + +# Get a Deploy + +try { + Get-V2024Deploy-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Deploy -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Deploy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-object-mappings +This gets a list of existing object mappings between current org and source org. +Source org should be "default" when getting object mappings that are not associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:read + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceOrg | **String** | True | The name of the source org. + +### Return type +[**ObjectMappingResponse[]**](../models/object-mapping-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of existing object mappings between current org and source org. | ObjectMappingResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceOrg = "source-org" # String | The name of the source org. + +# Gets list of object mappings + +try { + Get-V2024ObjectMappings-V2024SourceOrg $SourceOrg + + # Below is a request that includes all optional parameters + # Get-V2024ObjectMappings -V2024SourceOrg $SourceOrg +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ObjectMappings" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-uploaded-configuration +This API gets an existing uploaded configuration for the current tenant. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The id of the uploaded configuration. + +### Return type +[**BackupResponse**](../models/backup-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Gets an uploaded configuration details. | BackupResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. + +# Get an Uploaded Configuration + +try { + Get-V2024UploadedConfiguration-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024UploadedConfiguration -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UploadedConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-backups +This API gets a list of existing backups for the current tenant. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* + +### Return type +[**BackupResponse[]**](../models/backup-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of existing backups. | BackupResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Filters = 'status eq "COMPLETE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) + +# List Backups + +try { + Get-V2024Backups + + # Below is a request that includes all optional parameters + # Get-V2024Backups -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Backups" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-deploys +This API gets a list of deploys for the current tenant. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**DeployResponse[]**](../models/deploy-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of existing deploys. | DeployResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List Deploys + +try { + Get-V2024Deploys + + # Below is a request that includes all optional parameters + # Get-V2024Deploys +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Deploys" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-drafts +This API gets a list of existing drafts for the current tenant. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* + +### Return type +[**DraftResponse[]**](../models/draft-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of existing drafts. | DraftResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Filters = 'status eq "COMPLETE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* (optional) + +# List Drafts + +try { + Get-V2024Drafts + + # Below is a request that includes all optional parameters + # Get-V2024Drafts -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Drafts" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-uploaded-configurations +This API gets a list of existing uploaded configurations for the current tenant. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* + +### Return type +[**BackupResponse[]**](../models/backup-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of existing uploaded configurations. | BackupResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Filters = 'status eq "COMPLETE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) + +# List Uploaded Configurations + +try { + Get-V2024UploadedConfigurations + + # Below is a request that includes all optional parameters + # Get-V2024UploadedConfigurations -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UploadedConfigurations" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-object-mappings +This updates a set of object mappings, only enabled and targetValue fields can be updated. +Source org should be "default" when updating object mappings that are not associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceOrg | **String** | True | The name of the source org. + Body | ObjectMappingBulkPatchRequest | [**ObjectMappingBulkPatchRequest**](../models/object-mapping-bulk-patch-request) | True | The object mapping request body. + +### Return type +[**ObjectMappingBulkPatchResponse**](../models/object-mapping-bulk-patch-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The updated object mappings. | ObjectMappingBulkPatchResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceOrg = "source-org" # String | The name of the source org. +$ObjectMappingBulkPatchRequest = @"{ + "patches" : { + "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : true + } ], + "00bece34-f50d-4227-8878-76f620b5a971" : [ { + "op" : "replace", + "path" : "/targetValue", + "value" : "New Target Value" + } ] + } +}"@ + +# Bulk updates object mappings + +try { + $Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest + Update-V2024ObjectMappings-V2024SourceOrg $SourceOrg -V2024ObjectMappingBulkPatchRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024ObjectMappings -V2024SourceOrg $SourceOrg -V2024ObjectMappingBulkPatchRequest $ObjectMappingBulkPatchRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ObjectMappings" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ConnectorRuleManagementApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ConnectorRuleManagementApi.md new file mode 100644 index 000000000..854ea7846 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ConnectorRuleManagementApi.md @@ -0,0 +1,363 @@ + +--- +id: v2024-connector-rule-management +title: ConnectorRuleManagement +pagination_label: ConnectorRuleManagement +sidebar_label: ConnectorRuleManagement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorRuleManagement', 'V2024ConnectorRuleManagement'] +slug: /tools/sdk/powershell/v2024/methods/connector-rule-management +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleManagement', 'V2024ConnectorRuleManagement'] +--- + +# ConnectorRuleManagement + Use this API to implement connector rule management functionality. +With this functionality in place, administrators can implement connector-executed rules in a programmatic, scalable way. + +In Identity Security Cloud (ISC), [rules](https://developer.sailpoint.com/docs/extensibility/rules) serve as a flexible configuration framework you can leverage to perform complex or advanced configurations. +[Connector-executed rules](https://developer.sailpoint.com/docs/extensibility/rules/connector-rules) are rules that are executed in the ISC virtual appliance (VA), usually extensions of the [connector](https://documentation.sailpoint.com/connectors/isc/landingpages/help/landingpages/isc_landing.html) itself, the bridge between the data source and ISC. + +This API allows administrators to view existing connector-executed rules, make changes to them, delete them, and create new ones from the available types. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024ConnectorRule**](#create-connector-rule) | **POST** `/connector-rules` | Create Connector Rule +[**Remove-V2024ConnectorRule**](#delete-connector-rule) | **DELETE** `/connector-rules/{id}` | Delete Connector Rule +[**Get-V2024ConnectorRule**](#get-connector-rule) | **GET** `/connector-rules/{id}` | Get Connector Rule +[**Get-V2024ConnectorRuleList**](#get-connector-rule-list) | **GET** `/connector-rules` | List Connector Rules +[**Send-V2024ConnectorRule**](#put-connector-rule) | **PUT** `/connector-rules/{id}` | Update Connector Rule +[**Test-V2024ConnectorRule**](#test-connector-rule) | **POST** `/connector-rules/validate` | Validate Connector Rule + +## create-connector-rule +Create a connector rule from the available types. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | ConnectorRuleCreateRequest | [**ConnectorRuleCreateRequest**](../models/connector-rule-create-request) | True | Connector rule to create. + +### Return type +[**ConnectorRuleResponse**](../models/connector-rule-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Created connector rule. | ConnectorRuleResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$ConnectorRuleCreateRequest = @"{ + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "type" : "BuildMap" +}"@ + +# Create Connector Rule + +try { + $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest + New-V2024ConnectorRule-V2024XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleCreateRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ConnectorRule -V2024XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleCreateRequest $ConnectorRuleCreateRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ConnectorRule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-connector-rule +Delete the connector rule for the given ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the connector rule to delete. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Delete Connector Rule + +try { + Remove-V2024ConnectorRule-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024ConnectorRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ConnectorRule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-connector-rule +Get a connector rule by ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the connector rule to get. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**ConnectorRuleResponse**](../models/connector-rule-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Connector rule with the given ID. | ConnectorRuleResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to get. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get Connector Rule + +try { + Get-V2024ConnectorRule-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorRule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-connector-rule-list +List existing connector rules. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**ConnectorRuleResponse[]**](../models/connector-rule-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of connector rules. | ConnectorRuleResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# List Connector Rules + +try { + Get-V2024ConnectorRuleList-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorRuleList -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorRuleList" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-connector-rule +Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the connector rule to update. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | ConnectorRuleUpdateRequest | [**ConnectorRuleUpdateRequest**](../models/connector-rule-update-request) | (optional) | Connector rule with updated data. + +### Return type +[**ConnectorRuleResponse**](../models/connector-rule-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated connector rule. | ConnectorRuleResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to update. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$ConnectorRuleUpdateRequest = @"{ + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", + "type" : "BuildMap" +}"@ + +# Update Connector Rule + +try { + Send-V2024ConnectorRule-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleUpdateRequest $ConnectorRuleUpdateRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorRule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## test-connector-rule +Detect issues within the connector rule's code to fix and list them. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | SourceCode | [**SourceCode**](../models/source-code) | True | Code to validate. + +### Return type +[**ConnectorRuleValidationResponse**](../models/connector-rule-validation-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Status of the code's eligibility as a connector rule. | ConnectorRuleValidationResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$SourceCode = @"{ + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" +}"@ + +# Validate Connector Rule + +try { + $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode + Test-V2024ConnectorRule-V2024XSailPointExperimental $XSailPointExperimental -V2024SourceCode $Result + + # Below is a request that includes all optional parameters + # Test-V2024ConnectorRule -V2024XSailPointExperimental $XSailPointExperimental -V2024SourceCode $SourceCode +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ConnectorRule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ConnectorsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ConnectorsApi.md new file mode 100644 index 000000000..d4c850b9a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ConnectorsApi.md @@ -0,0 +1,654 @@ + +--- +id: v2024-connectors +title: Connectors +pagination_label: Connectors +sidebar_label: Connectors +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Connectors', 'V2024Connectors'] +slug: /tools/sdk/powershell/v2024/methods/connectors +tags: ['SDK', 'Software Development Kit', 'Connectors', 'V2024Connectors'] +--- + +# Connectors + Use this API to implement connector functionality. +With this functionality in place, administrators can view available connectors. + +Connectors are the bridges Identity Security Cloud uses to communicate with and aggregate data from sources. +For example, if it is necessary to set up a connection between Identity Security Cloud and the Active Directory source, a connector can bridge the two and enable Identity Security Cloud to synchronize data between the systems. +This ensures account entitlements and states are correct throughout the organization. + +In Identity Security Cloud, administrators can use the Connections drop-down menu and select Sources to view the available source connectors. + +Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about the connectors available in Identity Security Cloud. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/) for more information about the SaaS custom connectors that do not need VAs (virtual appliances) to communicate with their sources. + +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about using connectors in Identity Security Cloud. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024CustomConnector**](#create-custom-connector) | **POST** `/connectors` | Create Custom Connector +[**Remove-V2024CustomConnector**](#delete-custom-connector) | **DELETE** `/connectors/{scriptName}` | Delete Connector by Script Name +[**Get-V2024Connector**](#get-connector) | **GET** `/connectors/{scriptName}` | Get Connector by Script Name +[**Get-V2024ConnectorCorrelationConfig**](#get-connector-correlation-config) | **GET** `/connectors/{scriptName}/correlation-config` | Get Connector Correlation Configuration +[**Get-V2024ConnectorList**](#get-connector-list) | **GET** `/connectors` | Get Connector List +[**Get-V2024ConnectorSourceConfig**](#get-connector-source-config) | **GET** `/connectors/{scriptName}/source-config` | Get Connector Source Configuration +[**Get-V2024ConnectorSourceTemplate**](#get-connector-source-template) | **GET** `/connectors/{scriptName}/source-template` | Get Connector Source Template +[**Get-V2024ConnectorTranslations**](#get-connector-translations) | **GET** `/connectors/{scriptName}/translations/{locale}` | Get Connector Translations +[**Send-V2024ConnectorCorrelationConfig**](#put-connector-correlation-config) | **PUT** `/connectors/{scriptName}/correlation-config` | Update Connector Correlation Configuration +[**Send-V2024ConnectorSourceConfig**](#put-connector-source-config) | **PUT** `/connectors/{scriptName}/source-config` | Update Connector Source Configuration +[**Send-V2024ConnectorSourceTemplate**](#put-connector-source-template) | **PUT** `/connectors/{scriptName}/source-template` | Update Connector Source Template +[**Send-V2024ConnectorTranslations**](#put-connector-translations) | **PUT** `/connectors/{scriptName}/translations/{locale}` | Update Connector Translations +[**Update-V2024Connector**](#update-connector) | **PATCH** `/connectors/{scriptName}` | Update Connector by Script Name + +## create-custom-connector +Create custom connector. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | V3CreateConnectorDto | [**V3CreateConnectorDto**](../models/v3-create-connector-dto) | True | + +### Return type +[**V3ConnectorDto**](../models/v3-connector-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A Connector Dto object | V3ConnectorDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$V3CreateConnectorDto = @"{ + "name" : "custom connector", + "directConnect" : true, + "className" : "sailpoint.connector.OpenConnectorAdapter", + "type" : "custom connector type", + "status" : "RELEASED" +}"@ + +# Create Custom Connector + +try { + $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto + New-V2024CustomConnector-V2024V3CreateConnectorDto $Result + + # Below is a request that includes all optional parameters + # New-V2024CustomConnector -V2024V3CreateConnectorDto $V3CreateConnectorDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CustomConnector" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-custom-connector +Delete a custom connector that using its script name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ScriptName | **String** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + +# Delete Connector by Script Name + +try { + Remove-V2024CustomConnector-V2024ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Remove-V2024CustomConnector -V2024ScriptName $ScriptName +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CustomConnector" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-connector +Fetches a connector that using its script name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ScriptName | **String** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + Query | Locale | **String** | (optional) | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + +### Return type +[**ConnectorDetail**](../models/connector-detail) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A Connector Dto object | ConnectorDetail +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. +$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + +# Get Connector by Script Name + +try { + Get-V2024Connector-V2024ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024Connector -V2024ScriptName $ScriptName -V2024Locale $Locale +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Connector" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-connector-correlation-config +Fetches a connector's correlation config using its script name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ScriptName | **String** | True | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + +### Return type +**String** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The connector's correlation config | String +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + +### Example +```powershell +$ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + +# Get Connector Correlation Configuration + +try { + Get-V2024ConnectorCorrelationConfig-V2024ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorCorrelationConfig -V2024ScriptName $ScriptName +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorCorrelationConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-connector-list +Fetches list of connectors that have 'RELEASED' status using filtering and pagination. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Locale | **String** | (optional) | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + +### Return type +[**V3ConnectorDto[]**](../models/v3-connector-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A Connector Dto object | V3ConnectorDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Filters = 'directConnect eq "true"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + +# Get Connector List + +try { + Get-V2024ConnectorList + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorList -V2024Filters $Filters -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Locale $Locale +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorList" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-connector-source-config +Fetches a connector's source config using its script name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ScriptName | **String** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + +### Return type +**String** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The connector's source template | String +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + +### Example +```powershell +$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + +# Get Connector Source Configuration + +try { + Get-V2024ConnectorSourceConfig-V2024ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorSourceConfig -V2024ScriptName $ScriptName +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorSourceConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-connector-source-template +Fetches a connector's source template using its script name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ScriptName | **String** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + +### Return type +**String** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The connector's source template | String +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + +### Example +```powershell +$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + +# Get Connector Source Template + +try { + Get-V2024ConnectorSourceTemplate-V2024ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorSourceTemplate -V2024ScriptName $ScriptName +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorSourceTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-connector-translations +Fetches a connector's translations using its script name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ScriptName | **String** | True | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. +Path | Locale | **String** | True | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + +### Return type +**String** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The connector's translations | String +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: text/plain, application/json + +### Example +```powershell +$ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. +$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + +# Get Connector Translations + +try { + Get-V2024ConnectorTranslations-V2024ScriptName $ScriptName -V2024Locale $Locale + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorTranslations -V2024ScriptName $ScriptName -V2024Locale $Locale +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorTranslations" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-connector-correlation-config +Update a connector's correlation config using its script name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ScriptName | **String** | True | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + | File | **System.IO.FileInfo** | True | connector correlation config xml file + +### Return type +[**UpdateDetail**](../models/update-detail) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The connector's update detail | UpdateDetail +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. +$File = # System.IO.FileInfo | connector correlation config xml file + +# Update Connector Correlation Configuration + +try { + Send-V2024ConnectorCorrelationConfig-V2024ScriptName $ScriptName -V2024File $File + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorCorrelationConfig -V2024ScriptName $ScriptName -V2024File $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorCorrelationConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-connector-source-config +Update a connector's source config using its script name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ScriptName | **String** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + | File | **System.IO.FileInfo** | True | connector source config xml file + +### Return type +[**UpdateDetail**](../models/update-detail) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The connector's update detail | UpdateDetail +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. +$File = # System.IO.FileInfo | connector source config xml file + +# Update Connector Source Configuration + +try { + Send-V2024ConnectorSourceConfig-V2024ScriptName $ScriptName -V2024File $File + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorSourceConfig -V2024ScriptName $ScriptName -V2024File $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorSourceConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-connector-source-template +Update a connector's source template using its script name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ScriptName | **String** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + | File | **System.IO.FileInfo** | True | connector source template xml file + +### Return type +[**UpdateDetail**](../models/update-detail) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The connector's update detail | UpdateDetail +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. +$File = # System.IO.FileInfo | connector source template xml file + +# Update Connector Source Template + +try { + Send-V2024ConnectorSourceTemplate-V2024ScriptName $ScriptName -V2024File $File + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorSourceTemplate -V2024ScriptName $ScriptName -V2024File $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorSourceTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-connector-translations +Update a connector's translations using its script name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ScriptName | **String** | True | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. +Path | Locale | **String** | True | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + +### Return type +[**UpdateDetail**](../models/update-detail) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The connector's update detail | UpdateDetail +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. +$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + +# Update Connector Translations + +try { + Send-V2024ConnectorTranslations-V2024ScriptName $ScriptName -V2024Locale $Locale + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorTranslations -V2024ScriptName $ScriptName -V2024Locale $Locale +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorTranslations" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-connector +This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +The following fields are patchable: + + +* connectorMetadata + +* applicationXml + +* correlationConfigXml + +* sourceConfigXml + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ScriptName | **String** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of connector detail update operations + +### Return type +[**ConnectorDetail**](../models/connector-detail) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A updated Connector Dto object | ConnectorDetail +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of connector detail update operations + + +# Update Connector by Script Name + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Connector-V2024ScriptName $ScriptName -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Connector -V2024ScriptName $ScriptName -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Connector" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024CustomFormsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024CustomFormsApi.md new file mode 100644 index 000000000..40370dd9d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024CustomFormsApi.md @@ -0,0 +1,1050 @@ + +--- +id: v2024-custom-forms +title: CustomForms +pagination_label: CustomForms +sidebar_label: CustomForms +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CustomForms', 'V2024CustomForms'] +slug: /tools/sdk/powershell/v2024/methods/custom-forms +tags: ['SDK', 'Software Development Kit', 'CustomForms', 'V2024CustomForms'] +--- + +# CustomForms + Use this API to build and manage custom forms. +With this functionality in place, administrators can create and view form definitions and form instances. + +Forms are composed of sections and fields. Sections split the form into logical groups of fields and fields are the data collection points within the form. Configure conditions to modify elements of the form as the responder provides input. Create form inputs to pass information from a calling feature, like a workflow, to your form. + +Forms can be used within workflows as an action or as a trigger. The Form Action allows you to assign a form as a step in a running workflow, suspending the workflow until the form is submitted or times out, and the workflow resumes. The Form Submitted Trigger initiates a workflow when a form is submitted. The trigger can be configured to initiate on submission of a full form, a form element with any value, or a form element with a particular value. + +Refer to [Forms](https://documentation.sailpoint.com/saas/help/forms/index.html) for more information about using forms in Identity Security Cloud. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024FormDefinition**](#create-form-definition) | **POST** `/form-definitions` | Creates a form definition. +[**New-V2024FormDefinitionDynamicSchema**](#create-form-definition-dynamic-schema) | **POST** `/form-definitions/forms-action-dynamic-schema` | Generate JSON Schema dynamically. +[**New-V2024FormDefinitionFileRequest**](#create-form-definition-file-request) | **POST** `/form-definitions/{formDefinitionID}/upload` | Upload new form definition file. +[**New-V2024FormInstance**](#create-form-instance) | **POST** `/form-instances` | Creates a form instance. +[**Remove-V2024FormDefinition**](#delete-form-definition) | **DELETE** `/form-definitions/{formDefinitionID}` | Deletes a form definition. +[**Export-V2024FormDefinitionsByTenant**](#export-form-definitions-by-tenant) | **GET** `/form-definitions/export` | List form definitions by tenant. +[**Get-V2024FileFromS3**](#get-file-from-s3) | **GET** `/form-definitions/{formDefinitionID}/file/{fileID}` | Download definition file by fileId. +[**Get-V2024FormDefinitionByKey**](#get-form-definition-by-key) | **GET** `/form-definitions/{formDefinitionID}` | Return a form definition. +[**Get-V2024FormInstanceByKey**](#get-form-instance-by-key) | **GET** `/form-instances/{formInstanceID}` | Returns a form instance. +[**Get-V2024FormInstanceFile**](#get-form-instance-file) | **GET** `/form-instances/{formInstanceID}/file/{fileID}` | Download instance file by fileId. +[**Import-V2024FormDefinitions**](#import-form-definitions) | **POST** `/form-definitions/import` | Import form definitions from export. +[**Update-V2024FormDefinition**](#patch-form-definition) | **PATCH** `/form-definitions/{formDefinitionID}` | Patch a form definition. +[**Update-V2024FormInstance**](#patch-form-instance) | **PATCH** `/form-instances/{formInstanceID}` | Patch a form instance. +[**Search-V2024FormDefinitionsByTenant**](#search-form-definitions-by-tenant) | **GET** `/form-definitions` | Export form definitions by tenant. +[**Search-V2024FormElementDataByElementID**](#search-form-element-data-by-element-id) | **GET** `/form-instances/{formInstanceID}/data-source/{formElementID}` | Retrieves dynamic data by element. +[**Search-V2024FormInstancesByTenant**](#search-form-instances-by-tenant) | **GET** `/form-instances` | List form instances by tenant. +[**Search-V2024PreDefinedSelectOptions**](#search-pre-defined-select-options) | **GET** `/form-definitions/predefined-select-options` | List predefined select options. +[**Show-V2024PreviewDataSource**](#show-preview-data-source) | **POST** `/form-definitions/{formDefinitionID}/data-source` | Preview form definition data source. + +## create-form-definition + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | Body | [**CreateFormDefinitionRequest**](../models/create-form-definition-request) | (optional) | Body is the request payload to create form definition request + +### Return type +[**FormDefinitionResponse**](../models/form-definition-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Returns a new form definition | FormDefinitionResponse +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Body = @"{ + "owner" : { + "name" : "Grant Smith", + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "formConditions" : [ { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + }, { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + } ], + "formInput" : [ { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + }, { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + } ], + "name" : "My form", + "description" : "My form description", + "usedBy" : [ { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + }, { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + } ], + "formElements" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + } ] +}"@ + +# Creates a form definition. + +try { + New-V2024FormDefinition-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2024FormDefinition -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinition" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-form-definition-dynamic-schema + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | Body | [**FormDefinitionDynamicSchemaRequest**](../models/form-definition-dynamic-schema-request) | (optional) | Body is the request payload to create a form definition dynamic schema + +### Return type +[**FormDefinitionDynamicSchemaResponse**](../models/form-definition-dynamic-schema-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns a form elements dynamic schema | FormDefinitionDynamicSchemaResponse +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response +404 | An error with the item not found | SearchFormDefinitionsByTenant400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Body = @"{ + "description" : "A description", + "attributes" : { + "formDefinitionId" : "00000000-0000-0000-0000-000000000000" + }, + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "action", + "versionNumber" : 1 +}"@ + +# Generate JSON Schema dynamically. + +try { + New-V2024FormDefinitionDynamicSchema-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2024FormDefinitionDynamicSchema -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionDynamicSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-form-definition-file-request +Parameter `{formDefinitionID}` should match a form definition ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | FormDefinitionID | **String** | True | FormDefinitionID String specifying FormDefinitionID + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + | File | **System.IO.FileInfo** | True | File specifying the multipart + +### Return type +[**FormDefinitionFileUploadResponse**](../models/form-definition-file-upload-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Returns a new form definition file | FormDefinitionFileUploadResponse +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response +404 | An error with the item not found | SearchFormDefinitionsByTenant400Response +413 | An error with payload size too large | SearchFormDefinitionsByTenant400Response +415 | An error with unsupported media type | SearchFormDefinitionsByTenant400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response +503 | An external service is not available | SearchFormDefinitionsByTenant400Response + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$File = # System.IO.FileInfo | File specifying the multipart + +# Upload new form definition file. + +try { + New-V2024FormDefinitionFileRequest-V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024File $File + + # Below is a request that includes all optional parameters + # New-V2024FormDefinitionFileRequest -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024File $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionFileRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-form-instance + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | Body | [**CreateFormInstanceRequest**](../models/create-form-instance-request) | (optional) | Body is the request payload to create a form instance + +### Return type +[**FormInstanceResponse**](../models/form-instance-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Returns a new form instance | FormInstanceResponse +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Body = @"{ + "formInput" : { + "input1" : "Sales" + }, + "standAloneForm" : false, + "createdBy" : { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "WORKFLOW_EXECUTION" + }, + "recipients" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + } ], + "expire" : "2023-08-12T20:14:57.74486Z", + "formDefinitionId" : "00000000-0000-0000-0000-000000000000", + "state" : "ASSIGNED", + "ttl" : 1571827560 +}"@ + +# Creates a form instance. + +try { + New-V2024FormInstance-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2024FormInstance -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormInstance" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-form-definition +Parameter `{formDefinitionID}` should match a form definition ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | FormDefinitionID | **String** | True | Form definition ID + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | Returns an empty body | SystemCollectionsHashtable +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response +404 | An error with the item not found | SearchFormDefinitionsByTenant400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Deletes a form definition. + +try { + Remove-V2024FormDefinition-V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024FormDefinition -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024FormDefinition" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## export-form-definitions-by-tenant +No parameters required. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Offset | **Int64** | (optional) (default to 0) | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. + Query | Limit | **Int64** | (optional) (default to 250) | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* + Query | Sorters | **String** | (optional) (default to "name") | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** + +### Return type +[**ExportFormDefinitionsByTenant200ResponseInner[]**](../models/export-form-definitions-by-tenant200-response-inner) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns a list of form definition objects by tenant used by SP-Config | ExportFormDefinitionsByTenant200ResponseInner[] +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) +$Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) +$Filters = 'name sw "my form"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") + +# List form definitions by tenant. + +try { + Export-V2024FormDefinitionsByTenant-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2024FormDefinitionsByTenant -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024FormDefinitionsByTenant" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-file-from-s3 + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | FormDefinitionID | **String** | True | FormDefinitionID Form definition ID +Path | FileID | **String** | True | FileID String specifying the hashed name of the uploaded file we are retrieving. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +**System.IO.FileInfo** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns a file that is referred to by fileID and associated with the formDefinitionID | System.IO.FileInfo +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response +404 | An error with the item not found | SearchFormDefinitionsByTenant400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response +503 | An external service is not available | SearchFormDefinitionsByTenant400Response + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json, image/jpeg, image/png, application/octet-stream + +### Example +```powershell +$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID Form definition ID +$FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Download definition file by fileId. + +try { + Get-V2024FileFromS3-V2024FormDefinitionID $FormDefinitionID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024FileFromS3 -V2024FormDefinitionID $FormDefinitionID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FileFromS3" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-form-definition-by-key +Parameter `{formDefinitionID}` should match a form definition ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | FormDefinitionID | **String** | True | Form definition ID + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**FormDefinitionResponse**](../models/form-definition-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns a form definition | FormDefinitionResponse +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response +404 | An error with the item not found | SearchFormDefinitionsByTenant400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Return a form definition. + +try { + Get-V2024FormDefinitionByKey-V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024FormDefinitionByKey -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormDefinitionByKey" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-form-instance-by-key +Parameter `{formInstanceID}` should match a form instance ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | FormInstanceID | **String** | True | Form instance ID + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**FormInstanceResponse**](../models/form-instance-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns a form instance by its key | FormInstanceResponse +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response +404 | An error with the item not found | SearchFormDefinitionsByTenant400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Returns a form instance. + +try { + Get-V2024FormInstanceByKey-V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024FormInstanceByKey -V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceByKey" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-form-instance-file + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | FormInstanceID | **String** | True | FormInstanceID Form instance ID +Path | FileID | **String** | True | FileID String specifying the hashed name of the uploaded file we are retrieving. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +**System.IO.FileInfo** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns a file that is referred to by fileID and associated with the formInstanceID | System.IO.FileInfo +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response +404 | An error with the item not found | SearchFormDefinitionsByTenant400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response +503 | An external service is not available | SearchFormDefinitionsByTenant400Response + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json, image/jpeg, image/png, application/octet-stream + +### Example +```powershell +$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | FormInstanceID Form instance ID +$FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Download instance file by fileId. + +try { + Get-V2024FormInstanceFile-V2024FormInstanceID $FormInstanceID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024FormInstanceFile -V2024FormInstanceID $FormInstanceID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceFile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-form-definitions + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | Body | [**[]ExportFormDefinitionsByTenant200ResponseInner**](../models/export-form-definitions-by-tenant200-response-inner) | (optional) | Body is the request payload to import form definitions + +### Return type +[**ImportFormDefinitions202Response**](../models/import-form-definitions202-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Returns statuses of those form definition objects imported | ImportFormDefinitions202Response +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + + + + + + $Body = @"[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]"@ # ExportFormDefinitionsByTenant200ResponseInner[] | Body is the request payload to import form definitions (optional) + + +# Import form definitions from export. + +try { + Import-V2024FormDefinitions-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Import-V2024FormDefinitions -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024FormDefinitions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-form-definition +Parameter `{formDefinitionID}` should match a form definition ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | FormDefinitionID | **String** | True | Form definition ID + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | Body | [**[]System.Collections.Hashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | (optional) | Body is the request payload to patch a form definition, check: https://jsonpatch.com + +### Return type +[**FormDefinitionResponse**](../models/form-definition-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns the form definition updated | FormDefinitionResponse +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response +404 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Body = @{ key_example = } # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) + $Body = @"[{op=replace, path=/description, value=test-description}]"@ # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) + + +# Patch a form definition. + +try { + Update-V2024FormDefinition-V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024FormDefinition -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormDefinition" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-form-instance +Parameter `{formInstanceID}` should match a form instance ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | FormInstanceID | **String** | True | Form instance ID + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | Body | [**[]System.Collections.Hashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | (optional) | Body is the request payload to patch a form instance, check: https://jsonpatch.com + +### Return type +[**FormInstanceResponse**](../models/form-instance-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns the form instance updated | FormInstanceResponse +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response +404 | An error with the item not found | SearchFormDefinitionsByTenant400Response +409 | An error with the request property conflicts with stored | SearchFormDefinitionsByTenant400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Body = @{ key_example = } # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) + $Body = @"[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]"@ # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) + + +# Patch a form instance. + +try { + Update-V2024FormInstance-V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024FormInstance -V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormInstance" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## search-form-definitions-by-tenant +No parameters required. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Offset | **Int64** | (optional) (default to 0) | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. + Query | Limit | **Int64** | (optional) (default to 250) | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* + Query | Sorters | **String** | (optional) (default to "name") | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** + +### Return type +[**ListFormDefinitionsByTenantResponse**](../models/list-form-definitions-by-tenant-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns a list of form definitions by tenant | ListFormDefinitionsByTenantResponse +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Offset = 250 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) +$Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) +$Filters = 'name sw "my form"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") + +# Export form definitions by tenant. + +try { + Search-V2024FormDefinitionsByTenant-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Search-V2024FormDefinitionsByTenant -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormDefinitionsByTenant" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## search-form-element-data-by-element-id +Parameter `{formInstanceID}` should match a form instance ID. +Parameter `{formElementID}` should match a form element ID at the data source configuration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | FormInstanceID | **String** | True | Form instance ID +Path | FormElementID | **String** | True | Form element ID + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int64** | (optional) (default to 250) | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` + Query | Query | **String** | (optional) | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. + +### Return type +[**ListFormElementDataByElementIDResponse**](../models/list-form-element-data-by-element-id-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Retrieves dynamic data to aid in correctly completing a valid form by form element ID from data source configuration | ListFormElementDataByElementIDResponse +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response +404 | An error with the item not found | SearchFormDefinitionsByTenant400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID +$FormElementID = "1" # String | Form element ID +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) +$Filters = 'value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"')` (optional) +$Query = "support" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) + +# Retrieves dynamic data by element. + +try { + Search-V2024FormElementDataByElementID-V2024FormInstanceID $FormInstanceID -V2024FormElementID $FormElementID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Search-V2024FormElementDataByElementID -V2024FormInstanceID $FormInstanceID -V2024FormElementID $FormElementID -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Filters $Filters -V2024Query $Query +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormElementDataByElementID" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## search-form-instances-by-tenant +No parameters required. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**ListFormInstancesByTenantResponse**](../models/list-form-instances-by-tenant-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns a list of form instances by tenant | ListFormInstancesByTenantResponse +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# List form instances by tenant. + +try { + Search-V2024FormInstancesByTenant-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Search-V2024FormInstancesByTenant -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormInstancesByTenant" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## search-pre-defined-select-options +No parameters required. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**ListPredefinedSelectOptionsResponse**](../models/list-predefined-select-options-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns a list of available predefined select options | ListPredefinedSelectOptionsResponse +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# List predefined select options. + +try { + Search-V2024PreDefinedSelectOptions-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Search-V2024PreDefinedSelectOptions -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PreDefinedSelectOptions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## show-preview-data-source + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | FormDefinitionID | **String** | True | Form definition ID + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int64** | (optional) (default to 10) | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` + Query | Query | **String** | (optional) | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. + Body | FormElementPreviewRequest | [**FormElementPreviewRequest**](../models/form-element-preview-request) | (optional) | Body is the request payload to create a form definition dynamic schema + +### Return type +[**PreviewDataSourceResponse**](../models/preview-data-source-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns a preview of a form definition data source | PreviewDataSourceResponse +400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response +401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response +403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response +404 | An error with the item not found | SearchFormDefinitionsByTenant400Response +429 | Too many requests | ModelError +500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 10 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) +$Filters = 'value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"')` (optional) +$Query = "ac" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) +$FormElementPreviewRequest = @"{ + "dataSource" : { + "config" : { + "indices" : [ "identities" ], + "query" : "*", + "aggregationBucketField" : "attributes.cloudStatus.exact", + "objectType" : "IDENTITY" + }, + "dataSourceType" : "STATIC" + } +}"@ + +# Preview form definition data source. + +try { + Show-V2024PreviewDataSource-V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Show-V2024PreviewDataSource -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Filters $Filters -V2024Query $Query -V2024FormElementPreviewRequest $FormElementPreviewRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024PreviewDataSource" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024CustomPasswordInstructionsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024CustomPasswordInstructionsApi.md new file mode 100644 index 000000000..1015413da --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024CustomPasswordInstructionsApi.md @@ -0,0 +1,172 @@ + +--- +id: v2024-custom-password-instructions +title: CustomPasswordInstructions +pagination_label: CustomPasswordInstructions +sidebar_label: CustomPasswordInstructions +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CustomPasswordInstructions', 'V2024CustomPasswordInstructions'] +slug: /tools/sdk/powershell/v2024/methods/custom-password-instructions +tags: ['SDK', 'Software Development Kit', 'CustomPasswordInstructions', 'V2024CustomPasswordInstructions'] +--- + +# CustomPasswordInstructions + Use this API to implement custom password instruction functionality. +With this functionality in place, administrators can create custom password instructions to help users reset their passwords, change them, unlock their accounts, or recover their usernames. +This allows administrators to emphasize password policies or provide organization-specific instructions. + +Administrators must first use [Update Password Org Config](https://developer.sailpoint.com/docs/api/beta/put-password-org-config/) to set `customInstructionsEnabled` to `true`. + +Once they have enabled custom instructions, they can use [Create Custom Password Instructions](https://developer.sailpoint.com/docs/api/beta/create-custom-password-instructions/) to create custom page content for the specific pageId they select. + +For example, an administrator can use the pageId forget-username:user-email to set the custom text for the case when users forget their usernames and must enter their emails. + +Refer to [Creating Custom Instruction Text](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html#creating-custom-instruction-text) for more information about creating custom password instructions. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024CustomPasswordInstructions**](#create-custom-password-instructions) | **POST** `/custom-password-instructions` | Create Custom Password Instructions +[**Remove-V2024CustomPasswordInstructions**](#delete-custom-password-instructions) | **DELETE** `/custom-password-instructions/{pageId}` | Delete Custom Password Instructions by page ID +[**Get-V2024CustomPasswordInstructions**](#get-custom-password-instructions) | **GET** `/custom-password-instructions/{pageId}` | Get Custom Password Instructions by Page ID + +## create-custom-password-instructions +This API creates the custom password instructions for the specified page ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | CustomPasswordInstruction | [**CustomPasswordInstruction**](../models/custom-password-instruction) | True | + +### Return type +[**CustomPasswordInstruction**](../models/custom-password-instruction) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the custom password instructions. | CustomPasswordInstruction +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$CustomPasswordInstruction = @"{ + "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", + "pageId" : "change-password:enter-password", + "locale" : "en" +}"@ + +# Create Custom Password Instructions + +try { + $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction + New-V2024CustomPasswordInstructions-V2024XSailPointExperimental $XSailPointExperimental -V2024CustomPasswordInstruction $Result + + # Below is a request that includes all optional parameters + # New-V2024CustomPasswordInstructions -V2024XSailPointExperimental $XSailPointExperimental -V2024CustomPasswordInstruction $CustomPasswordInstruction +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CustomPasswordInstructions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-custom-password-instructions +This API delete the custom password instructions for the specified page ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | PageId | **String** | True | The page ID of custom password instructions to delete. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Locale | **String** | (optional) | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$PageId = "change-password:enter-password" # String | The page ID of custom password instructions to delete. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) + +# Delete Custom Password Instructions by page ID + +try { + Remove-V2024CustomPasswordInstructions-V2024PageId $PageId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024CustomPasswordInstructions -V2024PageId $PageId -V2024XSailPointExperimental $XSailPointExperimental -V2024Locale $Locale +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CustomPasswordInstructions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-custom-password-instructions +This API returns the custom password instructions for the specified page ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | PageId | **String** | True | The page ID of custom password instructions to query. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Locale | **String** | (optional) | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". + +### Return type +[**CustomPasswordInstruction**](../models/custom-password-instruction) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the custom password instructions. | CustomPasswordInstruction +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$PageId = "change-password:enter-password" # String | The page ID of custom password instructions to query. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) + +# Get Custom Password Instructions by Page ID + +try { + Get-V2024CustomPasswordInstructions-V2024PageId $PageId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024CustomPasswordInstructions -V2024PageId $PageId -V2024XSailPointExperimental $XSailPointExperimental -V2024Locale $Locale +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomPasswordInstructions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024DimensionsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024DimensionsApi.md new file mode 100644 index 000000000..f3298397a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024DimensionsApi.md @@ -0,0 +1,530 @@ + +--- +id: v2024-dimensions +title: Dimensions +pagination_label: Dimensions +sidebar_label: Dimensions +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Dimensions', 'V2024Dimensions'] +slug: /tools/sdk/powershell/v2024/methods/dimensions +tags: ['SDK', 'Software Development Kit', 'Dimensions', 'V2024Dimensions'] +--- + +# Dimensions + Use this API to implement and customize dynamic role functionality. With this functionality in place, administrators can create dimensions and configure them for use throughout Identity Security Cloud. Identity Security Cloud can use established criteria to automatically assign the dimensions to qualified users. This enables users to get all the access they need quickly and securely and administrators to spend their time on other tasks. Entitlements represent the most granular level of access in Identity Security Cloud. +Access profiles represent the next level and often group entitlements. Dimension represent access selectively based on the evaluation of contextual information that is available or provided. Each Dimension include context attributes and access selection expressions which map criteria to access right assignments. Each dimension can contain up to 5 context attributes. Dynamic Access Roles represent the broadest level of access and often group access profiles ,entitlements and dimensions.Each Dynamic Access Role may contain one or more Dimensions. + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024Dimension**](#create-dimension) | **POST** `/roles/{roleId}/dimensions` | Create a Dimension +[**Remove-V2024BulkDimensions**](#delete-bulk-dimensions) | **POST** `/roles/{roleId}/dimensions/bulk-delete` | Delete Dimension(s) +[**Remove-V2024Dimension**](#delete-dimension) | **DELETE** `/roles/{roleId}/dimensions/{dimensionId}` | Delete a Dimension +[**Get-V2024Dimension**](#get-dimension) | **GET** `/roles/{roleId}/dimensions/{dimensionId}` | Get a Dimension under Role. +[**Get-V2024DimensionEntitlements**](#get-dimension-entitlements) | **GET** `/roles/{roleId}/dimensions/{dimensionId}/entitlements` | List Dimension's Entitlements +[**Get-V2024DimensionAccessProfiles**](#list-dimension-access-profiles) | **GET** `/roles/{roleId}/dimensions/{dimensionId}/access-profiles` | List Dimension's Access Profiles +[**Get-V2024Dimensions**](#list-dimensions) | **GET** `/roles/{roleId}/dimensions` | List Dimensions +[**Update-V2024Dimension**](#patch-dimension) | **PATCH** `/roles/{roleId}/dimensions/{dimensionId}` | Patch a specified Dimension + +## create-dimension +This API creates a dimension. +You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. +Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. +The maximum supported length for the description field is 2000 characters. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | RoleId | **String** | True | Parent Role Id of the dimension. + Body | Dimension | [**Dimension**](../models/dimension) | True | + +### Return type +[**Dimension**](../models/dimension) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Dimension created | Dimension +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. +$Dimension = @"{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "name" : "Dimension 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "id" : "2c918086749d78830174a1a40e121518", + "membership" : { + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, + "type" : "STANDARD" + }, + "parentId" : "2c918086749d78830174a1a40e121518" +}"@ + +# Create a Dimension + +try { + $Result = ConvertFrom-JsonToDimension -Json $Dimension + New-V2024Dimension-V2024RoleId $RoleId -V2024Dimension $Result + + # Below is a request that includes all optional parameters + # New-V2024Dimension -V2024RoleId $RoleId -V2024Dimension $Dimension +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Dimension" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-bulk-dimensions +This endpoint initiates a bulk deletion of one or more dimensions. +When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. +This endpoint can only bulk delete up to a limit of 50 roles per request. +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all dimensions included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | RoleId | **String** | True | Parent Role Id of the dimensions. + Body | DimensionBulkDeleteRequest | [**DimensionBulkDeleteRequest**](../models/dimension-bulk-delete-request) | True | + +### Return type +[**TaskResultDto**](../models/task-result-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Returns an object with the id of the task performing the delete operation. | TaskResultDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimensions. +$DimensionBulkDeleteRequest = @"{ + "dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] +}"@ + +# Delete Dimension(s) + +try { + $Result = ConvertFrom-JsonToDimensionBulkDeleteRequest -Json $DimensionBulkDeleteRequest + Remove-V2024BulkDimensions-V2024RoleId $RoleId -V2024DimensionBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024BulkDimensions -V2024RoleId $RoleId -V2024DimensionBulkDeleteRequest $DimensionBulkDeleteRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024BulkDimensions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-dimension +This API deletes a Dimension by its ID. +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles/Entitlements included in the Dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | RoleId | **String** | True | Parent Role Id of the dimension. +Path | DimensionId | **String** | True | Id of the Dimension + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. +$DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + +# Delete a Dimension + +try { + Remove-V2024Dimension-V2024RoleId $RoleId -V2024DimensionId $DimensionId + + # Below is a request that includes all optional parameters + # Remove-V2024Dimension -V2024RoleId $RoleId -V2024DimensionId $DimensionId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Dimension" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-dimension +This API returns a Dimension by its ID. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles or Entitlements included in the Dimension or Parent Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | RoleId | **String** | True | Parent Role Id of the dimension. +Path | DimensionId | **String** | True | Id of the Dimension + +### Return type +[**Dimension**](../models/dimension) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Dimension | Dimension +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. +$DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + +# Get a Dimension under Role. + +try { + Get-V2024Dimension-V2024RoleId $RoleId -V2024DimensionId $DimensionId + + # Below is a request that includes all optional parameters + # Get-V2024Dimension -V2024RoleId $RoleId -V2024DimensionId $DimensionId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Dimension" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-dimension-entitlements +This API lists the Entitlements associated with a given dimension. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | RoleId | **String** | True | Parent Role Id of the dimension. +Path | DimensionId | **String** | True | Id of the Dimension + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** + +### Return type +[**Entitlement1[]**](../models/entitlement1) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Entitlements | Entitlement1[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. +$DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'attribute eq "memberOf"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + +# List Dimension's Entitlements + +try { + Get-V2024DimensionEntitlements-V2024RoleId $RoleId -V2024DimensionId $DimensionId + + # Below is a request that includes all optional parameters + # Get-V2024DimensionEntitlements -V2024RoleId $RoleId -V2024DimensionId $DimensionId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DimensionEntitlements" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-dimension-access-profiles +This API lists the Access Profiles associated with a given Dimension + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | RoleId | **String** | True | Parent Role Id of the dimension. +Path | DimensionId | **String** | True | ID of the Dimension + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** + +### Return type +[**AccessProfile[]**](../models/access-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Access Profiles | AccessProfile[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. +$DimensionId = "2c9180835d191a86015d28455b4a2329" # String | ID of the Dimension +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'source.id eq "2c91808982f979270182f99e386d00fa"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + +# List Dimension's Access Profiles + +try { + Get-V2024DimensionAccessProfiles-V2024RoleId $RoleId -V2024DimensionId $DimensionId + + # Below is a request that includes all optional parameters + # Get-V2024DimensionAccessProfiles -V2024RoleId $RoleId -V2024DimensionId $DimensionId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DimensionAccessProfiles" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-dimensions +This API returns a list of dimensions under a specified role. + +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | RoleId | **String** | True | Parent Role Id of the dimension. + Query | ForSubadmin | **String** | (optional) | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. + Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** + +### Return type +[**Dimension[]**](../models/dimension) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Dimensions | Dimension[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. +$ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) +$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq '2c918086749d78830174a1a40e121518'' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + +# List Dimensions + +try { + Get-V2024Dimensions-V2024RoleId $RoleId + + # Below is a request that includes all optional parameters + # Get-V2024Dimensions -V2024RoleId $RoleId -V2024ForSubadmin $ForSubadmin -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Dimensions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-dimension +This API updates an existing dimension using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: **name** **description** **owner** **accessProfiles** **entitlements** **membership** +A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles/entitlements included in the dimension are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +The maximum supported length for the description field is 2000 characters. +When you use this API to modify a dimension's membership identities, you can only modify up to a limit of 500 membership identities at a time. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | RoleId | **String** | True | Parent Role Id of the dimension. +Path | DimensionId | **String** | True | Id of the Dimension + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**Dimension**](../models/dimension) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the Dimension as updated. | Dimension +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. +$DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | + + +# Patch a specified Dimension + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Dimension-V2024RoleId $RoleId -V2024DimensionId $DimensionId -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Dimension -V2024RoleId $RoleId -V2024DimensionId $DimensionId -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Dimension" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024EntitlementsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024EntitlementsApi.md new file mode 100644 index 000000000..523c1d6de --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024EntitlementsApi.md @@ -0,0 +1,715 @@ + +--- +id: v2024-entitlements +title: Entitlements +pagination_label: Entitlements +sidebar_label: Entitlements +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Entitlements', 'V2024Entitlements'] +slug: /tools/sdk/powershell/v2024/methods/entitlements +tags: ['SDK', 'Software Development Kit', 'Entitlements', 'V2024Entitlements'] +--- + +# Entitlements + Use this API to implement and customize entitlement functionality. +With this functionality in place, administrators can view entitlements and configure them for use throughout Identity Security Cloud in certifications, access profiles, and roles. +Administrators in Identity Security Cloud can then grant users access to the entitlements or configure them so users themselves can request access to the entitlements whenever they need them. +With a good approval process, this entitlement functionality allows users to gain the specific access they need on sources quickly and securely. + +Entitlements represent access rights on sources. +Entitlements are the most granular form of access in Identity Security Cloud. +Entitlements are often grouped into access profiles, and access profiles themselves are often grouped into roles, the broadest form of access in Identity Security Cloud. + +For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +An administrator can then create an even broader set of access in the form of a role grouping the 'AD Developers' access profile with another profile, 'GitHub Developers,' grouping entitlements for the GitHub source. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +When users need both the 'AD Developers' access profile and the 'GitHub Developers' access profile, they can request access to the role grouping both. + +Administrators often use roles and access profiles within those roles to manage access so that users can gain access more quickly, but the hierarchy of access all starts with entitlements. + +Anywhere entitlements appear, you can select them to find more information about the following: + +- Cloud Access Details: These provide details about the cloud access entitlements on cloud-enabled sources. + +- Permissions: Permissions represent individual units of read/write/admin access to a system. + +- Relationships: These list each entitlement's parent and child relationships. + +- Type: This is the entitlement's type. Some sources support multiple types, each with a different attribute schema. + +Identity Security Cloud uses entitlements in many features, including the following: + +- Certifications: Entitlements can be revoked from an identity that no longer needs them. + +- Roles: Roles can group access profiles which themselves group entitlements. You can grant and revoke access on a broad level with roles. Role membership criteria can grant roles to identities based on whether they have certain entitlements or attributes. + +- Access Profiles: Access profiles group entitlements. +They are the most important units of access in Identity Security Cloud. +Identity Security Cloud uses them in provisioning, certifications, and access requests, and administrators can configure them to grant very broad or very granular access. + +You cannot delete entitlements directly from Identity Security Cloud. +Entitlements are deleted based on their inclusion in aggregations. + +Refer to [Deleting Entitlements](https://documentation.sailpoint.com/saas/help/access/entitlements.html#deleting-entitlements) more information about deleting entitlements. + +Refer to [Entitlements](https://documentation.sailpoint.com/saas/help/access/entitlements.html) for more information about entitlements. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024AccessModelMetadataForEntitlement**](#create-access-model-metadata-for-entitlement) | **POST** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add metadata to an entitlement. +[**Remove-V2024AccessModelMetadataFromEntitlement**](#delete-access-model-metadata-from-entitlement) | **DELETE** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove metadata from an entitlement. +[**Get-V2024Entitlement**](#get-entitlement) | **GET** `/entitlements/{id}` | Get an entitlement +[**Get-V2024EntitlementRequestConfig**](#get-entitlement-request-config) | **GET** `/entitlements/{id}/entitlement-request-config` | Get Entitlement Request Config +[**Import-V2024EntitlementsBySource**](#import-entitlements-by-source) | **POST** `/entitlements/aggregate/sources/{id}` | Aggregate Entitlements +[**Get-V2024EntitlementChildren**](#list-entitlement-children) | **GET** `/entitlements/{id}/children` | List of entitlements children +[**Get-V2024EntitlementParents**](#list-entitlement-parents) | **GET** `/entitlements/{id}/parents` | List of entitlements parents +[**Get-V2024Entitlements**](#list-entitlements) | **GET** `/entitlements` | Gets a list of entitlements. +[**Update-V2024Entitlement**](#patch-entitlement) | **PATCH** `/entitlements/{id}` | Patch an entitlement +[**Send-V2024EntitlementRequestConfig**](#put-entitlement-request-config) | **PUT** `/entitlements/{id}/entitlement-request-config` | Replace Entitlement Request Config +[**Reset-V2024SourceEntitlements**](#reset-source-entitlements) | **POST** `/entitlements/reset/sources/{id}` | Reset Source Entitlements +[**Update-V2024EntitlementsInBulk**](#update-entitlements-in-bulk) | **POST** `/entitlements/bulk-update` | Bulk update an entitlement list + +## create-access-model-metadata-for-entitlement +Add single Access Model Metadata to an entitlement. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The entitlement id. +Path | AttributeKey | **String** | True | Technical name of the Attribute. +Path | AttributeValue | **String** | True | Technical name of the Attribute Value. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**Entitlement1**](../models/entitlement1) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | OK | Entitlement1 +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. +$AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. +$AttributeValue = "public" # String | Technical name of the Attribute Value. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Add metadata to an entitlement. + +try { + New-V2024AccessModelMetadataForEntitlement-V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2024AccessModelMetadataForEntitlement -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessModelMetadataForEntitlement" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-access-model-metadata-from-entitlement +Remove single Access Model Metadata from an entitlement. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The entitlement id. +Path | AttributeKey | **String** | True | Technical name of the Attribute. +Path | AttributeValue | **String** | True | Technical name of the Attribute Value. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | OK | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. +$AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. +$AttributeValue = "public" # String | Technical name of the Attribute Value. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Remove metadata from an entitlement. + +try { + Remove-V2024AccessModelMetadataFromEntitlement-V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024AccessModelMetadataFromEntitlement -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessModelMetadataFromEntitlement" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-entitlement +This API returns an entitlement by its ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The entitlement ID + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**Entitlement1**](../models/entitlement1) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An entitlement | Entitlement1 +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get an entitlement + +try { + Get-V2024Entitlement-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Entitlement -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlement" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-entitlement-request-config +This API returns the entitlement request config for a specified entitlement. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Entitlement Id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**EntitlementRequestConfig**](../models/entitlement-request-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An Entitlement Request Config | EntitlementRequestConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get Entitlement Request Config + +try { + Get-V2024EntitlementRequestConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementRequestConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementRequestConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-entitlements-by-source +Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). + +If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. + +If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source Id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + | CsvFile | **System.IO.FileInfo** | (optional) | The CSV file containing the source entitlements to aggregate. + +### Return type +[**LoadEntitlementTask**](../models/load-entitlement-task) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Aggregate Entitlements Task | LoadEntitlementTask +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) + +# Aggregate Entitlements + +try { + Import-V2024EntitlementsBySource-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Import-V2024EntitlementsBySource -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024CsvFile $CsvFile +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024EntitlementsBySource" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-entitlement-children +This API returns a list of all child entitlements of a given entitlement. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Entitlement Id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* + +### Return type +[**Entitlement1[]**](../models/entitlement1) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of entitlements children from an entitlement | Entitlement1[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) +$Filters = 'attribute eq "memberOf"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + +# List of entitlements children + +try { + Get-V2024EntitlementChildren-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementChildren -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChildren" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-entitlement-parents +This API returns a list of all parent entitlements of a given entitlement. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Entitlement Id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* + +### Return type +[**Entitlement1[]**](../models/entitlement1) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of entitlements parents from an entitlement | Entitlement1[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) +$Filters = 'attribute eq "memberOf"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + +# List of entitlements parents + +try { + Get-V2024EntitlementParents-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementParents -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementParents" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-entitlements +This API returns a list of entitlements. + +This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). + +Any authenticated token can call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | AccountId | **String** | (optional) | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). + Query | SegmentedForIdentity | **String** | (optional) | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. + Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). + Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* + +### Return type +[**Entitlement1[]**](../models/entitlement1) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of entitlements | Entitlement1[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) +$SegmentedForIdentity = "me" # String | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) +$ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) +$IncludeUnsegmented = $true # Boolean | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to $true) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) +$Filters = 'attribute eq "memberOf"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) + +# Gets a list of entitlements. + +try { + Get-V2024Entitlements-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Entitlements -V2024XSailPointExperimental $XSailPointExperimental -V2024AccountId $AccountId -V2024SegmentedForIdentity $SegmentedForIdentity -V2024ForSegmentIds $ForSegmentIds -V2024IncludeUnsegmented $IncludeUnsegmented -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlements" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-entitlement +This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields** + +When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the entitlement to patch + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) | + +### Return type +[**Entitlement1**](../models/entitlement1) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the entitlement as updated. | Entitlement1 +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | (optional) + + +# Patch an entitlement + +try { + Update-V2024Entitlement-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024Entitlement -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Entitlement" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-entitlement-request-config +This API replaces the entitlement request config for a specified entitlement. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Entitlement ID + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | EntitlementRequestConfig | [**EntitlementRequestConfig**](../models/entitlement-request-config) | True | + +### Return type +[**EntitlementRequestConfig**](../models/entitlement-request-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the entitlement request config as updated. | EntitlementRequestConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$EntitlementRequestConfig = @"{ + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } +}"@ + +# Replace Entitlement Request Config + +try { + $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig + Send-V2024EntitlementRequestConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024EntitlementRequestConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024EntitlementRequestConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024EntitlementRequestConfig $EntitlementRequestConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024EntitlementRequestConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## reset-source-entitlements +Remove all entitlements from a specific source. +To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of source for the entitlement reset + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**EntitlementSourceResetBaseReferenceDto**](../models/entitlement-source-reset-base-reference-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Entitlement source reset task result | EntitlementSourceResetBaseReferenceDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Reset Source Entitlements + +try { + Reset-V2024SourceEntitlements-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Reset-V2024SourceEntitlements -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024SourceEntitlements" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-entitlements-in-bulk +"This API applies an update to every entitlement of the list.\n\nThe\ + \ number of entitlements to update is limited to 50 items maximum.\n\nThe JsonPatch\ + \ update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\ + \ allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"\ + value\": boolean }** **{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\"\ + : boolean }**`" + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | EntitlementBulkUpdateRequest | [**EntitlementBulkUpdateRequest**](../models/entitlement-bulk-update-request) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$EntitlementBulkUpdateRequest = @"{ + "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/privileged", + "value" : false + }, { + "op" : "replace", + "path" : "/requestable", + "value" : false + } ] +}"@ + +# Bulk update an entitlement list + +try { + $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest + Update-V2024EntitlementsInBulk-V2024XSailPointExperimental $XSailPointExperimental -V2024EntitlementBulkUpdateRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024EntitlementsInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024EntitlementBulkUpdateRequest $EntitlementBulkUpdateRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024GlobalTenantSecuritySettingsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024GlobalTenantSecuritySettingsApi.md new file mode 100644 index 000000000..8bd013ca3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024GlobalTenantSecuritySettingsApi.md @@ -0,0 +1,166 @@ + +--- +id: v2024-global-tenant-security-settings +title: GlobalTenantSecuritySettings +pagination_label: GlobalTenantSecuritySettings +sidebar_label: GlobalTenantSecuritySettings +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GlobalTenantSecuritySettings', 'V2024GlobalTenantSecuritySettings'] +slug: /tools/sdk/powershell/v2024/methods/global-tenant-security-settings +tags: ['SDK', 'Software Development Kit', 'GlobalTenantSecuritySettings', 'V2024GlobalTenantSecuritySettings'] +--- + +# GlobalTenantSecuritySettings + Use this API to implement and customize global tenant security settings. +With this functionality in place, administrators can manage the global security settings that a tenant/org has. +This API can be used to configure the networks and Geographies allowed to access Identity Security Cloud URLs. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024AuthOrgNetworkConfig**](#create-auth-org-network-config) | **POST** `/auth-org/network-config` | Create security network configuration. +[**Get-V2024AuthOrgNetworkConfig**](#get-auth-org-network-config) | **GET** `/auth-org/network-config` | Get security network configuration. +[**Update-V2024AuthOrgNetworkConfig**](#patch-auth-org-network-config) | **PATCH** `/auth-org/network-config` | Update security network configuration. + +## create-auth-org-network-config +This API returns the details of an org's network auth configuration. Requires security scope of: 'sp:auth-org:manage' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | NetworkConfiguration | [**NetworkConfiguration**](../models/network-configuration) | True | Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + +### Return type +[**NetworkConfiguration**](../models/network-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Network configuration for the tenant. | NetworkConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$NetworkConfiguration = @"{ + "range" : [ "1.3.7.2", "255.255.255.252/30" ], + "whitelisted" : true, + "geolocation" : [ "CA", "FR", "HT" ] +}"@ + +# Create security network configuration. + +try { + $Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration + New-V2024AuthOrgNetworkConfig-V2024NetworkConfiguration $Result + + # Below is a request that includes all optional parameters + # New-V2024AuthOrgNetworkConfig -V2024NetworkConfiguration $NetworkConfiguration +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-auth-org-network-config +This API returns the details of an org's network auth configuration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**NetworkConfiguration**](../models/network-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Network configuration for the tenant's auth org. | NetworkConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get security network configuration. + +try { + Get-V2024AuthOrgNetworkConfig + + # Below is a request that includes all optional parameters + # Get-V2024AuthOrgNetworkConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-auth-org-network-config +This API updates an existing network configuration for an org using PATCH + Requires security scope of: 'sp:auth-org:manage' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + +### Return type +[**NetworkConfiguration**](../models/network-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated Auth Org network configuration. | NetworkConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + + +# Update security network configuration. + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthOrgNetworkConfig-V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthOrgNetworkConfig -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024GovernanceGroupsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024GovernanceGroupsApi.md new file mode 100644 index 000000000..4943e5e2c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024GovernanceGroupsApi.md @@ -0,0 +1,555 @@ + +--- +id: v2024-governance-groups +title: GovernanceGroups +pagination_label: GovernanceGroups +sidebar_label: GovernanceGroups +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GovernanceGroups', 'V2024GovernanceGroups'] +slug: /tools/sdk/powershell/v2024/methods/governance-groups +tags: ['SDK', 'Software Development Kit', 'GovernanceGroups', 'V2024GovernanceGroups'] +--- + +# GovernanceGroups + Use this API to implement and customize Governance Group functionality. With this functionality in place, administrators can create Governance Groups and configure them for use throughout Identity Security Cloud. + +A governance group is a group of users that can make governance decisions about access. If your organization has the Access Request or Certifications service, you can configure governance groups to review access requests or certifications. A governance group can determine whether specific access is appropriate for a user. + +Refer to [Creating and Managing Governance Groups](https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html) for more information about how to build Governance Groups in the visual builder in the Identity Security Cloud UI. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024Workgroup**](#create-workgroup) | **POST** `/workgroups` | Create a new Governance Group. +[**Remove-V2024Workgroup**](#delete-workgroup) | **DELETE** `/workgroups/{id}` | Delete a Governance Group +[**Remove-V2024WorkgroupMembers**](#delete-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-delete` | Remove members from Governance Group +[**Remove-V2024WorkgroupsInBulk**](#delete-workgroups-in-bulk) | **POST** `/workgroups/bulk-delete` | Delete Governance Group(s) +[**Get-V2024Workgroup**](#get-workgroup) | **GET** `/workgroups/{id}` | Get Governance Group by Id +[**Get-V2024Connections**](#list-connections) | **GET** `/workgroups/{workgroupId}/connections` | List connections for Governance Group +[**Get-V2024WorkgroupMembers**](#list-workgroup-members) | **GET** `/workgroups/{workgroupId}/members` | List Governance Group Members +[**Get-V2024Workgroups**](#list-workgroups) | **GET** `/workgroups` | List Governance Groups +[**Update-V2024Workgroup**](#patch-workgroup) | **PATCH** `/workgroups/{id}` | Patch a Governance Group +[**Update-V2024WorkgroupMembers**](#update-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-add` | Add members to Governance Group + +## create-workgroup +This API creates a new Governance Group. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | WorkgroupDto | [**WorkgroupDto**](../models/workgroup-dto) | True | + +### Return type +[**WorkgroupDto**](../models/workgroup-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Governance Group object created. | WorkgroupDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$WorkgroupDto = @"{ + "owner" : { + "emailAddress" : "support@sailpoint.com", + "displayName" : "Support", + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "connectionCount" : 1641498673000, + "created" : "2022-01-06T19:51:13Z", + "memberCount" : 1641498673000, + "name" : "DB Access Governance Group", + "description" : "Description of the Governance Group", + "modified" : "2022-01-06T19:51:13Z", + "id" : "2c91808568c529c60168cca6f90c1313" +}"@ + +# Create a new Governance Group. + +try { + $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto + New-V2024Workgroup-V2024XSailPointExperimental $XSailPointExperimental -V2024WorkgroupDto $Result + + # Below is a request that includes all optional parameters + # New-V2024Workgroup -V2024XSailPointExperimental $XSailPointExperimental -V2024WorkgroupDto $WorkgroupDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workgroup" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-workgroup +This API deletes a Governance Group by its ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Governance Group + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Delete a Governance Group + +try { + Remove-V2024Workgroup-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workgroup" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-workgroup-members +This API removes one or more members from a Governance Group. A +> **Following field of Identity is an optional field in the request.** + +> **name** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | WorkgroupId | **String** | True | ID of the Governance Group. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | IdentityPreviewResponseIdentity | [**[]IdentityPreviewResponseIdentity**](../models/identity-preview-response-identity) | True | List of identities to be removed from a Governance Group members list. + +### Return type +[**WorkgroupMemberDeleteItem[]**](../models/workgroup-member-delete-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +207 | List of deleted and not deleted identities from Governance Group members list. | WorkgroupMemberDeleteItem[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityPreviewResponseIdentity = @""@ # IdentityPreviewResponseIdentity[] | List of identities to be removed from a Governance Group members list. + + +# Remove members from Governance Group + +try { + $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity + Remove-V2024WorkgroupMembers-V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result + + # Below is a request that includes all optional parameters + # Remove-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $IdentityPreviewResponseIdentity +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupMembers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-workgroups-in-bulk + +This API initiates a bulk deletion of one or more Governance Groups. + +> If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. + +> If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. + +> If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. + +> If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. + +> **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | WorkgroupBulkDeleteRequest | [**WorkgroupBulkDeleteRequest**](../models/workgroup-bulk-delete-request) | True | + +### Return type +[**WorkgroupDeleteItem[]**](../models/workgroup-delete-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +207 | Governance Group bulk delete response. | WorkgroupDeleteItem[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$WorkgroupBulkDeleteRequest = @"{ + "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] +}"@ + +# Delete Governance Group(s) + +try { + $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest + Remove-V2024WorkgroupsInBulk-V2024XSailPointExperimental $XSailPointExperimental -V2024WorkgroupBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024WorkgroupsInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024WorkgroupBulkDeleteRequest $WorkgroupBulkDeleteRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupsInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-workgroup +This API returns a Governance Groups by its ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Governance Group + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**WorkgroupDto**](../models/workgroup-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A Governance Group | WorkgroupDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get Governance Group by Id + +try { + Get-V2024Workgroup-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workgroup" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-connections +This API returns list of connections associated with a Governance Group. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | WorkgroupId | **String** | True | ID of the Governance Group. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** + +### Return type +[**WorkgroupConnectionDto[]**](../models/workgroup-connection-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List all connections associated with a Governance Group. | WorkgroupConnectionDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + +# List connections for Governance Group + +try { + Get-V2024Connections-V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Connections -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Connections" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-workgroup-members +This API returns list of members associated with a Governance Group. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | WorkgroupId | **String** | True | ID of the Governance Group. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** + +### Return type +[**ListWorkgroupMembers200ResponseInner[]**](../models/list-workgroup-members200-response-inner) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List all members associated with a Governance Group. | ListWorkgroupMembers200ResponseInner[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + +# List Governance Group Members + +try { + Get-V2024WorkgroupMembers-V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkgroupMembers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-workgroups +This API returns list of Governance Groups + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** + +### Return type +[**WorkgroupDto[]**](../models/workgroup-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Governance Groups | WorkgroupDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'name sw "Test"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional) + +# List Governance Groups + +try { + Get-V2024Workgroups-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Workgroups -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workgroups" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-workgroup +This API updates an existing governance group by ID. The following fields and objects are patchable: +* name +* description +* owner + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Governance Group + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) | + +### Return type +[**WorkgroupDto**](../models/workgroup-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A Governance Group. | WorkgroupDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | (optional) + + +# Patch a Governance Group + +try { + Update-V2024Workgroup-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workgroup" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-workgroup-members +This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. + +> **Following field of Identity is an optional field in the request.** + +> **name** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | WorkgroupId | **String** | True | ID of the Governance Group. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | IdentityPreviewResponseIdentity | [**[]IdentityPreviewResponseIdentity**](../models/identity-preview-response-identity) | True | List of identities to be added to a Governance Group members list. + +### Return type +[**WorkgroupMemberAddItem[]**](../models/workgroup-member-add-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +207 | List of added and not added identities into Governance Group members list. | WorkgroupMemberAddItem[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityPreviewResponseIdentity = @""@ # IdentityPreviewResponseIdentity[] | List of identities to be added to a Governance Group members list. + + +# Add members to Governance Group + +try { + $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity + Update-V2024WorkgroupMembers-V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result + + # Below is a request that includes all optional parameters + # Update-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $IdentityPreviewResponseIdentity +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024WorkgroupMembers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IAIAccessRequestRecommendationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IAIAccessRequestRecommendationsApi.md new file mode 100644 index 000000000..e1be43337 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IAIAccessRequestRecommendationsApi.md @@ -0,0 +1,446 @@ + +--- +id: v2024-iai-access-request-recommendations +title: IAIAccessRequestRecommendations +pagination_label: IAIAccessRequestRecommendations +sidebar_label: IAIAccessRequestRecommendations +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IAIAccessRequestRecommendations', 'V2024IAIAccessRequestRecommendations'] +slug: /tools/sdk/powershell/v2024/methods/iai-access-request-recommendations +tags: ['SDK', 'Software Development Kit', 'IAIAccessRequestRecommendations', 'V2024IAIAccessRequestRecommendations'] +--- + +# IAIAccessRequestRecommendations + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Add-V2024AccessRequestRecommendationsIgnoredItem**](#add-access-request-recommendations-ignored-item) | **POST** `/ai-access-request-recommendations/ignored-items` | Notification of Ignored Access Request Recommendations +[**Add-V2024AccessRequestRecommendationsRequestedItem**](#add-access-request-recommendations-requested-item) | **POST** `/ai-access-request-recommendations/requested-items` | Notification of Requested Access Request Recommendations +[**Add-V2024AccessRequestRecommendationsViewedItem**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Notification of Viewed Access Request Recommendations +[**Add-V2024AccessRequestRecommendationsViewedItems**](#add-access-request-recommendations-viewed-items) | **POST** `/ai-access-request-recommendations/viewed-items/bulk-create` | Notification of Viewed Access Request Recommendations in Bulk +[**Get-V2024AccessRequestRecommendations**](#get-access-request-recommendations) | **GET** `/ai-access-request-recommendations` | Identity Access Request Recommendations +[**Get-V2024AccessRequestRecommendationsIgnoredItems**](#get-access-request-recommendations-ignored-items) | **GET** `/ai-access-request-recommendations/ignored-items` | List of Ignored Access Request Recommendations +[**Get-V2024AccessRequestRecommendationsRequestedItems**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List of Requested Access Request Recommendations +[**Get-V2024AccessRequestRecommendationsViewedItems**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List of Viewed Access Request Recommendations + +## add-access-request-recommendations-ignored-item +This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | AccessRequestRecommendationActionItemDto | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access item to ignore for an identity. + +### Return type +[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Recommendation successfully stored as ignored. | AccessRequestRecommendationActionItemResponseDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$AccessRequestRecommendationActionItemDto = @"{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" +}"@ + +# Notification of Ignored Access Request Recommendations + +try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-V2024AccessRequestRecommendationsIgnoredItem-V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-V2024AccessRequestRecommendationsIgnoredItem -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsIgnoredItem" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## add-access-request-recommendations-requested-item +This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | AccessRequestRecommendationActionItemDto | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access item that was requested for an identity. + +### Return type +[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Notification successfully acknowledged. | AccessRequestRecommendationActionItemResponseDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$AccessRequestRecommendationActionItemDto = @"{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" +}"@ + +# Notification of Requested Access Request Recommendations + +try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-V2024AccessRequestRecommendationsRequestedItem-V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-V2024AccessRequestRecommendationsRequestedItem -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsRequestedItem" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## add-access-request-recommendations-viewed-item +This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | AccessRequestRecommendationActionItemDto | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access that was viewed for an identity. + +### Return type +[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Recommendation successfully stored as viewed. | AccessRequestRecommendationActionItemResponseDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$AccessRequestRecommendationActionItemDto = @"{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" +}"@ + +# Notification of Viewed Access Request Recommendations + +try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-V2024AccessRequestRecommendationsViewedItem-V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-V2024AccessRequestRecommendationsViewedItem -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsViewedItem" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## add-access-request-recommendations-viewed-items +This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | AccessRequestRecommendationActionItemDto | [**[]AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access items that were viewed for an identity. + +### Return type +[**AccessRequestRecommendationActionItemResponseDto[]**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Recommendations successfully stored as viewed. | AccessRequestRecommendationActionItemResponseDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessRequestRecommendationActionItemDto = @"{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" +}"@ # AccessRequestRecommendationActionItemDto[] | The recommended access items that were viewed for an identity. + + +# Notification of Viewed Access Request Recommendations in Bulk + +try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-V2024AccessRequestRecommendationsViewedItems-V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-V2024AccessRequestRecommendationsViewedItems -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsViewedItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-access-request-recommendations +This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | IdentityId | **String** | (optional) (default to "me") | Get access request recommendations for an identityId. *me* indicates the current user. + Query | Limit | **Int32** | (optional) (default to 15) | Max number of results to return. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | IncludeTranslationMessages | **Boolean** | (optional) (default to $false) | If *true* it will populate a list of translation messages in the response. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. + +### Return type +[**AccessRequestRecommendationItemDetail[]**](../models/access-request-recommendation-item-detail) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of access request recommendations for the identityId | AccessRequestRecommendationItemDetail[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$IdentityId = "2c91808570313110017040b06f344ec9" # String | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") +$Limit = 56 # Int32 | Max number of results to return. (optional) (default to 15) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$IncludeTranslationMessages = $false # Boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to $false) +$Filters = 'access.name co "admin"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) +$Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) + +# Identity Access Request Recommendations + +try { + Get-V2024AccessRequestRecommendations-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestRecommendations -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityId $IdentityId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024IncludeTranslationMessages $IncludeTranslationMessages -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendations" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-access-request-recommendations-ignored-items +This API returns the list of ignored access request recommendations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** + +### Return type +[**AccessRequestRecommendationActionItemResponseDto[]**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns list of ignored access request recommendations. | AccessRequestRecommendationActionItemResponseDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'identityId eq "2c9180846b0a0583016b299f210c1314"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) +$Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + +# List of Ignored Access Request Recommendations + +try { + Get-V2024AccessRequestRecommendationsIgnoredItems-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestRecommendationsIgnoredItems -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsIgnoredItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-access-request-recommendations-requested-items +This API returns a list of requested access request recommendations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** + +### Return type +[**AccessRequestRecommendationActionItemResponseDto[]**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns the list of requested access request recommendations. | AccessRequestRecommendationActionItemResponseDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'access.id eq "2c9180846b0a0583016b299f210c1314"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) +$Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + +# List of Requested Access Request Recommendations + +try { + Get-V2024AccessRequestRecommendationsRequestedItems-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestRecommendationsRequestedItems -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsRequestedItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-access-request-recommendations-viewed-items +This API returns the list of viewed access request recommendations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** + +### Return type +[**AccessRequestRecommendationActionItemResponseDto[]**](../models/access-request-recommendation-action-item-response-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns list of viewed access request recommendations. | AccessRequestRecommendationActionItemResponseDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'access.id eq "2c9180846b0a0583016b299f210c1314"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) +$Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + +# List of Viewed Access Request Recommendations + +try { + Get-V2024AccessRequestRecommendationsViewedItems-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestRecommendationsViewedItems -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsViewedItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IAICommonAccessApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IAICommonAccessApi.md new file mode 100644 index 000000000..3ee707021 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IAICommonAccessApi.md @@ -0,0 +1,179 @@ + +--- +id: v2024-iai-common-access +title: IAICommonAccess +pagination_label: IAICommonAccess +sidebar_label: IAICommonAccess +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IAICommonAccess', 'V2024IAICommonAccess'] +slug: /tools/sdk/powershell/v2024/methods/iai-common-access +tags: ['SDK', 'Software Development Kit', 'IAICommonAccess', 'V2024IAICommonAccess'] +--- + +# IAICommonAccess + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024CommonAccess**](#create-common-access) | **POST** `/common-access` | Create common access items +[**Get-V2024CommonAccess**](#get-common-access) | **GET** `/common-access` | Get a paginated list of common access +[**Update-V2024CommonAccessStatusInBulk**](#update-common-access-status-in-bulk) | **POST** `/common-access/update-status` | Bulk update common access status + +## create-common-access +This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | CommonAccessItemRequest | [**CommonAccessItemRequest**](../models/common-access-item-request) | True | + +### Return type +[**CommonAccessItemResponse**](../models/common-access-item-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Returns details of the common access classification request. | CommonAccessItemResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$CommonAccessItemRequest = @"{ + "access" : { + "ownerName" : "ownerName", + "name" : "name", + "description" : "description", + "id" : "id", + "type" : "ACCESS_PROFILE", + "ownerId" : "ownerId" + }, + "status" : "CONFIRMED" +}"@ + +# Create common access items + +try { + $Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest + New-V2024CommonAccess-V2024XSailPointExperimental $XSailPointExperimental -V2024CommonAccessItemRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024CommonAccess -V2024XSailPointExperimental $XSailPointExperimental -V2024CommonAccessItemRequest $CommonAccessItemRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CommonAccess" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-common-access +This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. + +### Return type +[**CommonAccessResponse[]**](../models/common-access-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of common access for a customer. | CommonAccessResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'access.type eq "ROLE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) +$Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) + +# Get a paginated list of common access + +try { + Get-V2024CommonAccess-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024CommonAccess -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CommonAccess" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-common-access-status-in-bulk +This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | CommonAccessIDStatus | [**[]CommonAccessIDStatus**](../models/common-access-id-status) | True | Confirm or deny in bulk the common access ids that are (or aren't) common access + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CommonAccessIDStatus = @"{ + "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], + "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] +}"@ # CommonAccessIDStatus[] | Confirm or deny in bulk the common access ids that are (or aren't) common access + + +# Bulk update common access status + +try { + $Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus + Update-V2024CommonAccessStatusInBulk-V2024XSailPointExperimental $XSailPointExperimental -V2024CommonAccessIDStatus $Result + + # Below is a request that includes all optional parameters + # Update-V2024CommonAccessStatusInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024CommonAccessIDStatus $CommonAccessIDStatus +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CommonAccessStatusInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IAIOutliersApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IAIOutliersApi.md new file mode 100644 index 000000000..d33eec04e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IAIOutliersApi.md @@ -0,0 +1,489 @@ + +--- +id: v2024-iai-outliers +title: IAIOutliers +pagination_label: IAIOutliers +sidebar_label: IAIOutliers +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IAIOutliers', 'V2024IAIOutliers'] +slug: /tools/sdk/powershell/v2024/methods/iai-outliers +tags: ['SDK', 'Software Development Kit', 'IAIOutliers', 'V2024IAIOutliers'] +--- + +# IAIOutliers + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Export-V2024OutliersZip**](#export-outliers-zip) | **GET** `/outliers/export` | IAI Identity Outliers Export +[**Get-V2024IdentityOutlierSnapshots**](#get-identity-outlier-snapshots) | **GET** `/outlier-summaries` | IAI Identity Outliers Summary +[**Get-V2024IdentityOutliers**](#get-identity-outliers) | **GET** `/outliers` | IAI Get Identity Outliers +[**Get-V2024LatestIdentityOutlierSnapshots**](#get-latest-identity-outlier-snapshots) | **GET** `/outlier-summaries/latest` | IAI Identity Outliers Latest Summary +[**Get-V2024OutlierContributingFeatureSummary**](#get-outlier-contributing-feature-summary) | **GET** `/outlier-feature-summaries/{outlierFeatureId}` | Get identity outlier contibuting feature summary +[**Get-V2024PeerGroupOutliersContributingFeatures**](#get-peer-group-outliers-contributing-features) | **GET** `/outliers/{outlierId}/contributing-features` | Get identity outlier's contibuting features +[**Invoke-V2024IgnoreIdentityOutliers**](#ignore-identity-outliers) | **POST** `/outliers/ignore` | IAI Identity Outliers Ignore +[**Get-V2024OutliersContributingFeatureAccessItems**](#list-outliers-contributing-feature-access-items) | **GET** `/outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items` | Gets a list of access items associated with each identity outlier contributing feature +[**Invoke-V2024UnIgnoreIdentityOutliers**](#un-ignore-identity-outliers) | **POST** `/outliers/unignore` | IAI Identity Outliers Unignore + +## export-outliers-zip +This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. + +Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Type | **String** | (optional) | Type of the identity outliers snapshot to filter on + +### Return type +**System.IO.FileInfo** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns zip of two CSVs to download. One CSV for ignored outliers and the other for non-ignored outliers. | System.IO.FileInfo +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + +# IAI Identity Outliers Export + +try { + Export-V2024OutliersZip-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2024OutliersZip -V2024XSailPointExperimental $XSailPointExperimental -V2024Type $Type +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024OutliersZip" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-outlier-snapshots +This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Type | **String** | (optional) | Type of the identity outliers snapshot to filter on + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** + +### Return type +[**OutlierSummary[]**](../models/outlier-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers | OutlierSummary[] +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) +$Filters = 'snapshotDate ge "2022-02-07T20:13:29.356648026Z"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* (optional) +$Sorters = "snapshotDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** (optional) + +# IAI Identity Outliers Summary + +try { + Get-V2024IdentityOutlierSnapshots-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityOutlierSnapshots -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Type $Type -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOutlierSnapshots" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-outliers +This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Type | **String** | (optional) | Type of the identity outliers snapshot to filter on + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** + +### Return type +[**Outlier[]**](../models/outlier) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns list of objects. Each object contains information about outliers. | Outlier[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) +$Filters = 'attributes.displayName sw "John" and certStatus eq "false"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) +$Sorters = "attributes.displayName,firstDetectionDate,-score" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** (optional) + +# IAI Get Identity Outliers + +try { + Get-V2024IdentityOutliers-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityOutliers -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Type $Type -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOutliers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-latest-identity-outlier-snapshots +This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Type | **String** | (optional) | Type of the identity outliers snapshot to filter on + +### Return type +[**LatestOutlierSummary[]**](../models/latest-outlier-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers. | LatestOutlierSummary[] +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + +# IAI Identity Outliers Latest Summary + +try { + Get-V2024LatestIdentityOutlierSnapshots-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024LatestIdentityOutlierSnapshots -V2024XSailPointExperimental $XSailPointExperimental -V2024Type $Type +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LatestIdentityOutlierSnapshots" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-outlier-contributing-feature-summary +This API returns a summary of a contributing feature for an identity outlier. + +The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | OutlierFeatureId | **String** | True | Contributing feature id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**OutlierFeatureSummary**](../models/outlier-feature-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns selected contributing feature summary for an outlier. | OutlierFeatureSummary +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OutlierFeatureId = "04654b66-7561-4090-94f9-abee0722a1af" # String | Contributing feature id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get identity outlier contibuting feature summary + +try { + Get-V2024OutlierContributingFeatureSummary-V2024OutlierFeatureId $OutlierFeatureId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024OutlierContributingFeatureSummary -V2024OutlierFeatureId $OutlierFeatureId -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OutlierContributingFeatureSummary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-peer-group-outliers-contributing-features +This API returns a list of contributing feature objects for a single outlier. + +The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | OutlierId | **String** | True | The outlier id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | IncludeTranslationMessages | **String** | (optional) | Whether or not to include translation messages object in returned response + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** + +### Return type +[**OutlierContributingFeature[]**](../models/outlier-contributing-feature) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns list of objects. Each object contains a feature and metadata about that feature. | OutlierContributingFeature[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$IncludeTranslationMessages = "include-translation-messages=" # String | Whether or not to include translation messages object in returned response (optional) +$Sorters = "importance" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** (optional) + +# Get identity outlier's contibuting features + +try { + Get-V2024PeerGroupOutliersContributingFeatures-V2024OutlierId $OutlierId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PeerGroupOutliersContributingFeatures -V2024OutlierId $OutlierId -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024IncludeTranslationMessages $IncludeTranslationMessages -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PeerGroupOutliersContributingFeatures" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## ignore-identity-outliers +This API receives a list of identity IDs in the request, changes the outliers to be ignored. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | RequestBody | **[]String** | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ # String[] | + + +# IAI Identity Outliers Ignore + +try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Invoke-V2024IgnoreIdentityOutliers-V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024IgnoreIdentityOutliers -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $RequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024IgnoreIdentityOutliers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-outliers-contributing-feature-access-items +This API returns a list of the enriched access items associated with each feature filtered by the access item type. + +The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | OutlierId | **String** | True | The outlier id +Path | ContributingFeatureName | **String** | True | The name of contributing feature + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | AccessType | **String** | (optional) | The type of access item for the identity outlier contributing feature. If not provided, it returns all. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** + +### Return type +[**OutliersContributingFeatureAccessItems[]**](../models/outliers-contributing-feature-access-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The list of access items. | OutliersContributingFeatureAccessItems[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id +$ContributingFeatureName = "radical_entitlement_count" # String | The name of contributing feature +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$AccessType = "ENTITLEMENT" # String | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) +$Sorters = "displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) + +# Gets a list of access items associated with each identity outlier contributing feature + +try { + Get-V2024OutliersContributingFeatureAccessItems-V2024OutlierId $OutlierId -V2024ContributingFeatureName $ContributingFeatureName -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024OutliersContributingFeatureAccessItems -V2024OutlierId $OutlierId -V2024ContributingFeatureName $ContributingFeatureName -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024AccessType $AccessType -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OutliersContributingFeatureAccessItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## un-ignore-identity-outliers +This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | RequestBody | **[]String** | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ # String[] | + + +# IAI Identity Outliers Unignore + +try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Invoke-V2024UnIgnoreIdentityOutliers-V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024UnIgnoreIdentityOutliers -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $RequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnIgnoreIdentityOutliers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IAIPeerGroupStrategiesApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IAIPeerGroupStrategiesApi.md new file mode 100644 index 000000000..40277b60b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IAIPeerGroupStrategiesApi.md @@ -0,0 +1,72 @@ + +--- +id: v2024-iai-peer-group-strategies +title: IAIPeerGroupStrategies +pagination_label: IAIPeerGroupStrategies +sidebar_label: IAIPeerGroupStrategies +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IAIPeerGroupStrategies', 'V2024IAIPeerGroupStrategies'] +slug: /tools/sdk/powershell/v2024/methods/iai-peer-group-strategies +tags: ['SDK', 'Software Development Kit', 'IAIPeerGroupStrategies', 'V2024IAIPeerGroupStrategies'] +--- + +# IAIPeerGroupStrategies + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024PeerGroupOutliers**](#get-peer-group-outliers) | **GET** `/peer-group-strategies/{strategy}/identity-outliers` | Identity Outliers List + +## get-peer-group-outliers +-- Deprecated : See 'IAI Outliers' This API will be used by Identity Governance systems to identify identities that are not included in an organization's peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Strategy | **String** | True | The strategy used to create peer groups. Currently, 'entitlement' is supported. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**PeerGroupMember[]**](../models/peer-group-member) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of identities that are not included in peer groups. | PeerGroupMember[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Strategy = "entitlement" # String | The strategy used to create peer groups. Currently, 'entitlement' is supported. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Identity Outliers List + +try { + Get-V2024PeerGroupOutliers-V2024Strategy $Strategy -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PeerGroupOutliers -V2024Strategy $Strategy -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PeerGroupOutliers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IAIRecommendationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IAIRecommendationsApi.md new file mode 100644 index 000000000..a0a51a5cd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IAIRecommendationsApi.md @@ -0,0 +1,177 @@ + +--- +id: v2024-iai-recommendations +title: IAIRecommendations +pagination_label: IAIRecommendations +sidebar_label: IAIRecommendations +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IAIRecommendations', 'V2024IAIRecommendations'] +slug: /tools/sdk/powershell/v2024/methods/iai-recommendations +tags: ['SDK', 'Software Development Kit', 'IAIRecommendations', 'V2024IAIRecommendations'] +--- + +# IAIRecommendations + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024Recommendations**](#get-recommendations) | **POST** `/recommendations/request` | Returns a Recommendation Based on Object +[**Get-V2024RecommendationsConfig**](#get-recommendations-config) | **GET** `/recommendations/config` | Get certification recommendation config values +[**Update-V2024RecommendationsConfig**](#update-recommendations-config) | **PUT** `/recommendations/config` | Update certification recommendation config values + +## get-recommendations +The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | RecommendationRequestDto | [**RecommendationRequestDto**](../models/recommendation-request-dto) | True | + +### Return type +[**RecommendationResponseDto**](../models/recommendation-response-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The recommendations for a customer | RecommendationResponseDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$RecommendationRequestDto = @"{ + "prescribeMode" : false, + "excludeInterpretations" : false, + "requests" : [ { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + }, { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + } ], + "includeTranslationMessages" : false, + "includeDebugInformation" : true +}"@ + +# Returns a Recommendation Based on Object + +try { + $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto + Get-V2024Recommendations-V2024XSailPointExperimental $XSailPointExperimental -V2024RecommendationRequestDto $Result + + # Below is a request that includes all optional parameters + # Get-V2024Recommendations -V2024XSailPointExperimental $XSailPointExperimental -V2024RecommendationRequestDto $RecommendationRequestDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Recommendations" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-recommendations-config +Retrieves configuration attributes used by certification recommendations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**RecommendationConfigDto**](../models/recommendation-config-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Cert recommendation configuration attributes | RecommendationConfigDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get certification recommendation config values + +try { + Get-V2024RecommendationsConfig-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RecommendationsConfig -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RecommendationsConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-recommendations-config +Updates configuration attributes used by certification recommendations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | RecommendationConfigDto | [**RecommendationConfigDto**](../models/recommendation-config-dto) | True | + +### Return type +[**RecommendationConfigDto**](../models/recommendation-config-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Cert recommendation configuration attributes after update | RecommendationConfigDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$RecommendationConfigDto = @"{ + "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], + "peerGroupPercentageThreshold" : 0.5, + "runAutoSelectOnce" : false, + "onlyTuneThreshold" : false +}"@ + +# Update certification recommendation config values + +try { + $Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto + Update-V2024RecommendationsConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024RecommendationConfigDto $Result + + # Below is a request that includes all optional parameters + # Update-V2024RecommendationsConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024RecommendationConfigDto $RecommendationConfigDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RecommendationsConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IAIRoleMiningApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IAIRoleMiningApi.md new file mode 100644 index 000000000..9323b6813 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IAIRoleMiningApi.md @@ -0,0 +1,1362 @@ + +--- +id: v2024-iai-role-mining +title: IAIRoleMining +pagination_label: IAIRoleMining +sidebar_label: IAIRoleMining +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IAIRoleMining', 'V2024IAIRoleMining'] +slug: /tools/sdk/powershell/v2024/methods/iai-role-mining +tags: ['SDK', 'Software Development Kit', 'IAIRoleMining', 'V2024IAIRoleMining'] +--- + +# IAIRoleMining + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024PotentialRoleProvisionRequest**](#create-potential-role-provision-request) | **POST** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision` | Create request to provision a potential role into an actual role. +[**New-V2024RoleMiningSessions**](#create-role-mining-sessions) | **POST** `/role-mining-sessions` | Create a role mining session +[**Invoke-V2024DownloadRoleMiningPotentialRoleZip**](#download-role-mining-potential-role-zip) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download` | Export (download) details for a potential role in a role mining session +[**Export-V2024RoleMiningPotentialRole**](#export-role-mining-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export` | Export (download) details for a potential role in a role mining session +[**Export-V2024RoleMiningPotentialRoleAsync**](#export-role-mining-potential-role-async) | **POST** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async` | Asynchronously export details for a potential role in a role mining session and upload to S3 +[**Export-V2024RoleMiningPotentialRoleStatus**](#export-role-mining-potential-role-status) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}` | Retrieve status of a potential role export job +[**Get-V2024AllPotentialRoleSummaries**](#get-all-potential-role-summaries) | **GET** `/role-mining-potential-roles` | Retrieves all potential role summaries +[**Get-V2024EntitlementDistributionPotentialRole**](#get-entitlement-distribution-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution` | Retrieves entitlement popularity distribution for a potential role in a role mining session +[**Get-V2024EntitlementsPotentialRole**](#get-entitlements-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities` | Retrieves entitlements for a potential role in a role mining session +[**Get-V2024ExcludedEntitlementsPotentialRole**](#get-excluded-entitlements-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements` | Retrieves excluded entitlements for a potential role in a role mining session +[**Get-V2024IdentitiesPotentialRole**](#get-identities-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities` | Retrieves identities for a potential role in a role mining session +[**Get-V2024PotentialRole**](#get-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}` | Retrieves a specific potential role +[**Get-V2024PotentialRoleApplications**](#get-potential-role-applications) | **GET** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications` | Retrieves the applications of a potential role for a role mining session +[**Get-V2024PotentialRoleEntitlements**](#get-potential-role-entitlements) | **GET** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements` | Retrieves the entitlements of a potential role for a role mining session +[**Get-V2024PotentialRoleSourceIdentityUsage**](#get-potential-role-source-identity-usage) | **GET** `/role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage` | Retrieves potential role source usage +[**Get-V2024PotentialRoleSummaries**](#get-potential-role-summaries) | **GET** `/role-mining-sessions/{sessionId}/potential-role-summaries` | Retrieves all potential role summaries +[**Get-V2024RoleMiningPotentialRole**](#get-role-mining-potential-role) | **GET** `/role-mining-potential-roles/{potentialRoleId}` | Retrieves a specific potential role +[**Get-V2024RoleMiningSession**](#get-role-mining-session) | **GET** `/role-mining-sessions/{sessionId}` | Get a role mining session +[**Get-V2024RoleMiningSessionStatus**](#get-role-mining-session-status) | **GET** `/role-mining-sessions/{sessionId}/status` | Get role mining session status state +[**Get-V2024RoleMiningSessions**](#get-role-mining-sessions) | **GET** `/role-mining-sessions` | Retrieves all role mining sessions +[**Get-V2024SavedPotentialRoles**](#get-saved-potential-roles) | **GET** `/role-mining-potential-roles/saved` | Retrieves all saved potential roles +[**Update-V2024PotentialRole**](#patch-potential-role) | **PATCH** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}` | Update a potential role +[**Update-V2024PotentialRole0**](#patch-potential-role-0) | **PATCH** `/role-mining-potential-roles/{potentialRoleId}` | Update a potential role +[**Update-V2024RoleMiningSession**](#patch-role-mining-session) | **PATCH** `/role-mining-sessions/{sessionId}` | Patch a role mining session +[**Update-V2024EntitlementsPotentialRole**](#update-entitlements-potential-role) | **POST** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements` | Edit entitlements for a potential role to exclude some entitlements + +## create-potential-role-provision-request +This method starts a job to provision a potential role + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | MinEntitlementPopularity | **Int32** | (optional) (default to 0) | Minimum popularity required for an entitlement to be included in the provisioned role. + Query | IncludeCommonAccess | **Boolean** | (optional) (default to $true) | Boolean determining whether common access entitlements will be included in the provisioned role. + Body | RoleMiningPotentialRoleProvisionRequest | [**RoleMiningPotentialRoleProvisionRequest**](../models/role-mining-potential-role-provision-request) | (optional) | Required information to create a new role + +### Return type +[**RoleMiningPotentialRoleSummary**](../models/role-mining-potential-role-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted. Returns a potential role summary including the status of the provison request | RoleMiningPotentialRoleSummary +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$MinEntitlementPopularity = 56 # Int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) +$IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to $true) +$RoleMiningPotentialRoleProvisionRequest = @"{ + "includeIdentities" : true, + "roleName" : "Finance - Accounting", + "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", + "roleDescription" : "General access for accounting department", + "directlyAssignedEntitlements" : false +}"@ + +# Create request to provision a potential role into an actual role. + +try { + New-V2024PotentialRoleProvisionRequest-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2024PotentialRoleProvisionRequest -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024MinEntitlementPopularity $MinEntitlementPopularity -V2024IncludeCommonAccess $IncludeCommonAccess -V2024RoleMiningPotentialRoleProvisionRequest $RoleMiningPotentialRoleProvisionRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PotentialRoleProvisionRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-role-mining-sessions +This submits a create role mining session request to the role mining application. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | RoleMiningSessionDto | [**RoleMiningSessionDto**](../models/role-mining-session-dto) | True | Role mining session parameters + +### Return type +[**RoleMiningSessionResponse**](../models/role-mining-session-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Submitted a role mining session request | RoleMiningSessionResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$RoleMiningSessionDto = @"{ + "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", + "prescribedPruneThreshold" : 10, + "pruneThreshold" : 50, + "saved" : true, + "potentialRolesReadyCount" : 0, + "scope" : { + "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], + "attributeFilterCriteria" : { + "displayName" : { + "untranslated" : "Location: Miami" + }, + "ariaLabel" : { + "untranslated" : "Location: Miami" + }, + "data" : { + "displayName" : { + "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" + }, + "name" : "location", + "operator" : "EQUALS", + "values" : [ "Miami" ] + } + }, + "criteria" : "source.name:DataScienceDataset" + }, + "potentialRoleCount" : 0, + "name" : "Saved RM Session - 07/10", + "minNumIdentitiesInPotentialRole" : 20, + "identityCount" : 0, + "type" : "SPECIALIZED" +}"@ + +# Create a role mining session + +try { + $Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto + New-V2024RoleMiningSessions-V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningSessionDto $Result + + # Below is a request that includes all optional parameters + # New-V2024RoleMiningSessions -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningSessionDto $RoleMiningSessionDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024RoleMiningSessions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## download-role-mining-potential-role-zip +This endpoint downloads a completed export of information for a potential role in a role mining session. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session +Path | ExportId | **String** | True | The id of a previously run export job for this potential role + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +**System.IO.FileInfo** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a zip file containing csv files for identities and entitlements for the potential role. | System.IO.FileInfo +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session +$ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Export (download) details for a potential role in a role mining session + +try { + Invoke-V2024DownloadRoleMiningPotentialRoleZip-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024ExportId $ExportId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Invoke-V2024DownloadRoleMiningPotentialRoleZip -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024ExportId $ExportId -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024DownloadRoleMiningPotentialRoleZip" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## export-role-mining-potential-role +This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +**System.IO.FileInfo** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a zip file containing csv files for identities and entitlements for the potential role. | System.IO.FileInfo +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Export (download) details for a potential role in a role mining session + +try { + Export-V2024RoleMiningPotentialRole-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2024RoleMiningPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRole" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## export-role-mining-potential-role-async +This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | RoleMiningPotentialRoleExportRequest | [**RoleMiningPotentialRoleExportRequest**](../models/role-mining-potential-role-export-request) | (optional) | + +### Return type +[**RoleMiningPotentialRoleExportResponse**](../models/role-mining-potential-role-export-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Job Submitted. Returns a reportId that can be used to download the zip once complete | RoleMiningPotentialRoleExportResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$RoleMiningPotentialRoleExportRequest = @"{ + "minEntitlementPopularity" : 0, + "includeCommonAccess" : true +}"@ + +# Asynchronously export details for a potential role in a role mining session and upload to S3 + +try { + Export-V2024RoleMiningPotentialRoleAsync-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2024RoleMiningPotentialRoleAsync -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleExportRequest $RoleMiningPotentialRoleExportRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRoleAsync" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## export-role-mining-potential-role-status +This endpoint retrieves information about the current status of a potential role export. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session +Path | ExportId | **String** | True | The id of a previously run export job for this potential role + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**RoleMiningPotentialRoleExportResponse**](../models/role-mining-potential-role-export-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Success. Returns the current status of this export | RoleMiningPotentialRoleExportResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session +$ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Retrieve status of a potential role export job + +try { + Export-V2024RoleMiningPotentialRoleStatus-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024ExportId $ExportId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2024RoleMiningPotentialRoleStatus -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024ExportId $ExportId -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRoleStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-all-potential-role-summaries +Returns all potential role summaries that match the query parameters + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**RoleMiningPotentialRoleSummary[]**](../models/role-mining-potential-role-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns all potential role summaries that match the query parameters. | RoleMiningPotentialRoleSummary[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) +$Filters = '(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true))' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Retrieves all potential role summaries + +try { + Get-V2024AllPotentialRoleSummaries-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AllPotentialRoleSummaries -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllPotentialRoleSummaries" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-entitlement-distribution-potential-role +This method returns entitlement popularity distribution for a potential role in a role mining session. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | IncludeCommonAccess | **Boolean** | (optional) | Boolean determining whether common access entitlements will be included or not + +### Return type +**System.Collections.Hashtable** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a map containing entitlement popularity distribution for a potential role. | System.Collections.Hashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) + +# Retrieves entitlement popularity distribution for a potential role in a role mining session + +try { + Get-V2024EntitlementDistributionPotentialRole-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementDistributionPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024IncludeCommonAccess $IncludeCommonAccess +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementDistributionPotentialRole" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-entitlements-potential-role +This method returns entitlements for a potential role in a role mining session. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | IncludeCommonAccess | **Boolean** | (optional) (default to $true) | Boolean determining whether common access entitlements will be included or not + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**RoleMiningEntitlement[]**](../models/role-mining-entitlement) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of entitlements for a potential role. | RoleMiningEntitlement[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) (default to $true) +$Sorters = "popularity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) +$Filters = 'applicationName sw "AD"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Retrieves entitlements for a potential role in a role mining session + +try { + Get-V2024EntitlementsPotentialRole-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementsPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024IncludeCommonAccess $IncludeCommonAccess -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementsPotentialRole" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-excluded-entitlements-potential-role +This method returns excluded entitlements for a potential role in a role mining session. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**RoleMiningEntitlement[]**](../models/role-mining-entitlement) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of excluded entitlements for a potential roles. | RoleMiningEntitlement[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Sorters = "populariity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** (optional) +$Filters = 'applicationName sw "AD"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Retrieves excluded entitlements for a potential role in a role mining session + +try { + Get-V2024ExcludedEntitlementsPotentialRole-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ExcludedEntitlementsPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ExcludedEntitlementsPotentialRole" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identities-potential-role +This method returns identities for a potential role in a role mining session. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**RoleMiningIdentity[]**](../models/role-mining-identity) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of identities for a potential role. | RoleMiningIdentity[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) +$Filters = 'MyFilters' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Retrieves identities for a potential role in a role mining session + +try { + Get-V2024IdentitiesPotentialRole-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentitiesPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitiesPotentialRole" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-potential-role +This method returns a specific potential role for a role mining session. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**RoleMiningPotentialRole**](../models/role-mining-potential-role) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of potential roles for a role mining session. | RoleMiningPotentialRole +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Retrieves a specific potential role + +try { + Get-V2024PotentialRole-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRole" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-potential-role-applications +This method returns the applications of a potential role for a role mining session. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**RoleMiningPotentialRoleApplication[]**](../models/role-mining-potential-role-application) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of potential roles for a role mining session. | RoleMiningPotentialRoleApplication[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Filters = 'applicationName sw "test"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* (optional) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Retrieves the applications of a potential role for a role mining session + +try { + Get-V2024PotentialRoleApplications-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PotentialRoleApplications -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleApplications" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-potential-role-entitlements +This method returns the entitlements of a potential role for a role mining session. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**RoleMiningPotentialRoleEntitlements[]**](../models/role-mining-potential-role-entitlements) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns the entitlements of a potential role for a role mining session. session. | RoleMiningPotentialRoleEntitlements[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Filters = 'entitlementRef.name sw "test"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* (optional) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Retrieves the entitlements of a potential role for a role mining session + +try { + Get-V2024PotentialRoleEntitlements-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PotentialRoleEntitlements -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleEntitlements" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-potential-role-source-identity-usage +This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | PotentialRoleId | **String** | True | A potential role id +Path | SourceId | **String** | True | A source id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**RoleMiningPotentialRoleSourceUsage[]**](../models/role-mining-potential-role-source-usage) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of source usage for the identities in a potential role. | RoleMiningPotentialRoleSourceUsage[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$PotentialRoleId = "e0cc5d7d-bf7f-4f81-b2af-8885b09d9923" # String | A potential role id +$SourceId = "2c9180877620c1460176267f336a106f" # String | A source id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Sorters = "-usageCount" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (optional) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Retrieves potential role source usage + +try { + Get-V2024PotentialRoleSourceIdentityUsage-V2024PotentialRoleId $PotentialRoleId -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PotentialRoleSourceIdentityUsage -V2024PotentialRoleId $PotentialRoleId -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleSourceIdentityUsage" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-potential-role-summaries +This method returns the potential role summaries for a role mining session. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**RoleMiningPotentialRoleSummary[]**](../models/role-mining-potential-role-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of potential role summaries for a role mining session. | RoleMiningPotentialRoleSummary[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** (optional) +$Filters = '(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true))' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Retrieves all potential role summaries + +try { + Get-V2024PotentialRoleSummaries-V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PotentialRoleSummaries -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleSummaries" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-mining-potential-role +This method returns a specific potential role. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | PotentialRoleId | **String** | True | A potential role id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**RoleMiningPotentialRole**](../models/role-mining-potential-role) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of potential roles for a role mining session. | RoleMiningPotentialRole +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Retrieves a specific potential role + +try { + Get-V2024RoleMiningPotentialRole-V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleMiningPotentialRole -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningPotentialRole" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-mining-session +The method retrieves a role mining session. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id to be retrieved. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**RoleMiningSessionResponse**](../models/role-mining-session-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns a role mining session | RoleMiningSessionResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be retrieved. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get a role mining session + +try { + Get-V2024RoleMiningSession-V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleMiningSession -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSession" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-mining-session-status +This method returns a role mining session status for a customer. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**RoleMiningSessionStatus**](../models/role-mining-session-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns session status | RoleMiningSessionStatus +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get role mining session status state + +try { + Get-V2024RoleMiningSessionStatus-V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleMiningSessionStatus -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSessionStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-mining-sessions +Returns all role mining sessions that match the query parameters + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**RoleMiningSessionDto[]**](../models/role-mining-session-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns all role mining sessions that match the query parameters. | RoleMiningSessionDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Filters = 'saved eq "true" and name sw "RM Session"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* (optional) +$Sorters = "createdBy,createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** (optional) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Retrieves all role mining sessions + +try { + Get-V2024RoleMiningSessions-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleMiningSessions -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters -V2024Sorters $Sorters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSessions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-saved-potential-roles +This method returns all saved potential roles (draft roles). + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**RoleMiningSessionDraftRoleDto[]**](../models/role-mining-session-draft-role-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of draft roles for a role mining session. | RoleMiningSessionDraftRoleDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Retrieves all saved potential roles + +try { + Get-V2024SavedPotentialRoles-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SavedPotentialRoles -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedPotentialRoles" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-potential-role +The method updates an existing potential role using. + +The following fields can be modified: + +* `description` + +* `name` + +* `saved` + + +>**NOTE: All other fields cannot be modified.** + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | The potential role summary id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | PatchPotentialRoleRequestInner | [**[]PatchPotentialRoleRequestInner**](../models/patch-potential-role-request-inner) | True | + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns the potential role summary based on the potentialRoleId provided. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ # PatchPotentialRoleRequestInner[] | + + +# Update a potential role + +try { + $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner + Update-V2024PotentialRole-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-V2024PotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $PatchPotentialRoleRequestInner +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PotentialRole" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-potential-role-0 +The method updates an existing potential role using. + +The following fields can be modified: + +* `description` + +* `name` + +* `saved` + + +>**NOTE: All other fields cannot be modified.** + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | The potential role summary id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | PatchPotentialRoleRequestInner | [**[]PatchPotentialRoleRequestInner**](../models/patch-potential-role-request-inner) | True | + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns the potential role summary based on the potentialRoleId provided. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ # PatchPotentialRoleRequestInner[] | + + +# Update a potential role + +try { + $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner + Update-V2024PotentialRole0-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-V2024PotentialRole0 -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $PatchPotentialRoleRequestInner +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PotentialRole0" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-role-mining-session +The method updates an existing role mining session using PATCH. Supports op in {"replace"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id to be patched + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be patched +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. + + +# Patch a role mining session + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024RoleMiningSession-V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024RoleMiningSession -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RoleMiningSession" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-entitlements-potential-role +This endpoint adds or removes entitlements from an exclusion list for a potential role. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SessionId | **String** | True | The role mining session id +Path | PotentialRoleId | **String** | True | A potential role id in a role mining session + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | RoleMiningPotentialRoleEditEntitlements | [**RoleMiningPotentialRoleEditEntitlements**](../models/role-mining-potential-role-edit-entitlements) | True | Role mining session parameters + +### Return type +[**RoleMiningPotentialRole**](../models/role-mining-potential-role) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Adds or removes entitlements from a potential role's entitlement exclusion list. | RoleMiningPotentialRole +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id +$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$RoleMiningPotentialRoleEditEntitlements = @"{ + "ids" : [ "entId1", "entId2" ], + "exclude" : true +}"@ + +# Edit entitlements for a potential role to exclude some entitlements + +try { + $Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements + Update-V2024EntitlementsPotentialRole-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleEditEntitlements $Result + + # Below is a request that includes all optional parameters + # Update-V2024EntitlementsPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleEditEntitlements $RoleMiningPotentialRoleEditEntitlements +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsPotentialRole" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IconsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IconsApi.md new file mode 100644 index 000000000..b6d506715 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IconsApi.md @@ -0,0 +1,121 @@ + +--- +id: v2024-icons +title: Icons +pagination_label: Icons +sidebar_label: Icons +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Icons', 'V2024Icons'] +slug: /tools/sdk/powershell/v2024/methods/icons +tags: ['SDK', 'Software Development Kit', 'Icons', 'V2024Icons'] +--- + +# Icons + Use this API to implement functionality related to object icons (application icons for example). +With this functionality in place, administrators can set or remove an icon for specific object type for use throughout Identity Security Cloud. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Remove-V2024Icon**](#delete-icon) | **DELETE** `/icons/{objectType}/{objectId}` | Delete an icon +[**Set-V2024Icon**](#set-icon) | **PUT** `/icons/{objectType}/{objectId}` | Update an icon + +## delete-icon +This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ObjectType | **String** | True | Object type. Available options ['application'] +Path | ObjectId | **String** | True | Object id. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$ObjectType = "application" # String | Object type. Available options ['application'] +$ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Delete an icon + +try { + Remove-V2024Icon-V2024ObjectType $ObjectType -V2024ObjectId $ObjectId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024Icon -V2024ObjectType $ObjectType -V2024ObjectId $ObjectId -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Icon" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-icon +This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ObjectType | **String** | True | Object type. Available options ['application'] +Path | ObjectId | **String** | True | Object id. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + | Image | **System.IO.FileInfo** | True | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] + +### Return type +[**SetIcon200Response**](../models/set-icon200-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Icon updated | SetIcon200Response +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$ObjectType = "application" # String | Object type. Available options ['application'] +$ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] + +# Update an icon + +try { + Set-V2024Icon-V2024ObjectType $ObjectType -V2024ObjectId $ObjectId -V2024XSailPointExperimental $XSailPointExperimental -V2024Image $Image + + # Below is a request that includes all optional parameters + # Set-V2024Icon -V2024ObjectType $ObjectType -V2024ObjectId $ObjectId -V2024XSailPointExperimental $XSailPointExperimental -V2024Image $Image +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024Icon" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IdentitiesApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IdentitiesApi.md new file mode 100644 index 000000000..d840025d8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IdentitiesApi.md @@ -0,0 +1,585 @@ + +--- +id: v2024-identities +title: Identities +pagination_label: Identities +sidebar_label: Identities +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Identities', 'V2024Identities'] +slug: /tools/sdk/powershell/v2024/methods/identities +tags: ['SDK', 'Software Development Kit', 'Identities', 'V2024Identities'] +--- + +# Identities + Use this API to implement identity functionality. +With this functionality in place, administrators can synchronize an identity's attributes with its various source attributes. + +Identity Security Cloud uses identities as users' authoritative accounts. Identities can own other accounts, entitlements, and attributes. + +An identity has a variety of attributes, such as an account name, an email address, a job title, and more. +These identity attributes can be correlated with different attributes on different sources. +For example, the identity John.Smith can own an account in the GitHub source with the account name John-Smith-Org, and Identity Security Cloud knows they are the same person with the same access and attributes. + +In Identity Security Cloud, administrators often set up these synchronizations to get triggered automatically with a change or to run on a schedule. +To manually synchronize attributes for an identity, administrators can use the Identities drop-down menu and select Identity List to view the list of identities. +They can then select the identity they want to manually synchronize and use the hamburger menu to select 'Synchronize Attributes.' +Doing so immediately begins the attribute synchronization and analyzes all accounts for the selected identity. + +Refer to [Synchronizing Attributes](https://documentation.sailpoint.com/saas/help/provisioning/attr_sync.html) for more information about synchronizing attributes. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Remove-V2024Identity**](#delete-identity) | **DELETE** `/identities/{id}` | Delete identity +[**Get-V2024Identity**](#get-identity) | **GET** `/identities/{id}` | Identity Details +[**Get-V2024IdentityOwnershipDetails**](#get-identity-ownership-details) | **GET** `/identities/{identityId}/ownership` | Get ownership details +[**Get-V2024RoleAssignment**](#get-role-assignment) | **GET** `/identities/{identityId}/role-assignments/{assignmentId}` | Role assignment details +[**Get-V2024RoleAssignments**](#get-role-assignments) | **GET** `/identities/{identityId}/role-assignments` | List role assignments +[**Get-V2024Identities**](#list-identities) | **GET** `/identities` | List Identities +[**Reset-V2024Identity**](#reset-identity) | **POST** `/identities/{id}/reset` | Reset an identity +[**Send-V2024IdentityVerificationAccountToken**](#send-identity-verification-account-token) | **POST** `/identities/{id}/verification/account/send` | Send password reset email +[**Start-V2024IdentitiesInvite**](#start-identities-invite) | **POST** `/identities/invite` | Invite identities to register +[**Start-V2024IdentityProcessing**](#start-identity-processing) | **POST** `/identities/process` | Process a list of identityIds +[**Sync-V2024hronizeAttributesForIdentity**](#synchronize-attributes-for-identity) | **POST** `/identities/{identityId}/synchronize-attributes` | Attribute synchronization for single identity. + +## delete-identity +The API returns successful response if the requested identity was deleted. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Identity Id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request is invalid. It may indicate that the specified identity is marked as protected and cannot be deleted. | IdentityAssociationDetails +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Delete identity + +try { + Remove-V2024Identity-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024Identity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Identity" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity +This API returns a single identity using the Identity ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Identity Id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**Identity**](../models/identity) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An identity object | Identity +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Identity Details + +try { + Get-V2024Identity-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Identity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Identity" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-ownership-details +Use this API to return an identity's owned objects that will cause problems for deleting the identity. +Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. +For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity's owned objects. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityId | **String** | True | Identity ID. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**IdentityOwnershipAssociationDetails**](../models/identity-ownership-association-details) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Identity's ownership association details. | IdentityOwnershipAssociationDetails +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "ff8081814d2a8036014d701f3fbf53fa" # String | Identity ID. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get ownership details + +try { + Get-V2024IdentityOwnershipDetails-V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityOwnershipDetails -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOwnershipDetails" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-assignment + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityId | **String** | True | Identity Id +Path | AssignmentId | **String** | True | Assignment Id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**RoleAssignmentDto**](../models/role-assignment-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A role assignment object | RoleAssignmentDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id +$AssignmentId = "1cbb0705b38c4226b1334eadd8874086" # String | Assignment Id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Role assignment details + +try { + Get-V2024RoleAssignment-V2024IdentityId $IdentityId -V2024AssignmentId $AssignmentId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleAssignment -V2024IdentityId $IdentityId -V2024AssignmentId $AssignmentId -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignment" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-assignments +This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityId | **String** | True | Identity Id to get the role assignments for + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | RoleId | **String** | (optional) | Role Id to filter the role assignments with + Query | RoleName | **String** | (optional) | Role name to filter the role assignments with + +### Return type +[**GetRoleAssignments200ResponseInner[]**](../models/get-role-assignments200-response-inner) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A role assignment object | GetRoleAssignments200ResponseInner[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id to get the role assignments for +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$RoleId = "e7697a1e96d04db1ac7b0f4544915d2c" # String | Role Id to filter the role assignments with (optional) +$RoleName = "Engineer" # String | Role name to filter the role assignments with (optional) + +# List role assignments + +try { + Get-V2024RoleAssignments-V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleAssignments -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleId $RoleId -V2024RoleName $RoleName +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignments" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-identities +This API returns a list of identities. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** + Query | DefaultFilter | **String** | (optional) (default to "CORRELATED_ONLY") | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**Identity[]**](../models/identity) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of identities. | Identity[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Filters = 'id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) +$Sorters = "name,-cloudStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) +$DefaultFilter = "CORRELATED_ONLY" # String | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to "CORRELATED_ONLY") +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + +# List Identities + +try { + Get-V2024Identities-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Identities -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters -V2024Sorters $Sorters -V2024DefaultFilter $DefaultFilter -V2024Count $Count -V2024Limit $Limit -V2024Offset $Offset +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Identities" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## reset-identity +Use this endpoint to reset a user's identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityId | **String** | True | Identity Id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted. The reset request accepted and is in progress. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Reset an identity + +try { + Reset-V2024Identity-V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Reset-V2024Identity -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024Identity" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## send-identity-verification-account-token +This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. +Path | Id | **String** | True | Identity ID + Body | SendAccountVerificationRequest | [**SendAccountVerificationRequest**](../models/send-account-verification-request) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The email was successfully sent | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID +$SendAccountVerificationRequest = @"{ + "sourceName" : "Active Directory Source", + "via" : "EMAIL_WORK" +}"@ + +# Send password reset email + +try { + $Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest + Send-V2024IdentityVerificationAccountToken-V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id -V2024SendAccountVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2024IdentityVerificationAccountToken -V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id -V2024SendAccountVerificationRequest $SendAccountVerificationRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityVerificationAccountToken" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-identities-invite +This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. + +This task will send an invitation email only for unregistered identities. + +The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | InviteIdentitiesRequest | [**InviteIdentitiesRequest**](../models/invite-identities-request) | True | + +### Return type +[**TaskStatus**](../models/task-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Responds with an initial TaskStatus for the executed task | TaskStatus +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$InviteIdentitiesRequest = @"{ + "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], + "uninvited" : false +}"@ + +# Invite identities to register + +try { + $Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest + Start-V2024IdentitiesInvite-V2024XSailPointExperimental $XSailPointExperimental -V2024InviteIdentitiesRequest $Result + + # Below is a request that includes all optional parameters + # Start-V2024IdentitiesInvite -V2024XSailPointExperimental $XSailPointExperimental -V2024InviteIdentitiesRequest $InviteIdentitiesRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentitiesInvite" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-identity-processing +This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. + +This endpoint will perform the following tasks: +1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it's expected to change). +2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. +3. Enforce provisioning for any assigned accesses that haven't been fulfilled (e.g. failure due to source health). +4. Recalculate manager relationships. +5. Potentially clean-up identity processing errors, assuming the error has been resolved. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | ProcessIdentitiesRequest | [**ProcessIdentitiesRequest**](../models/process-identities-request) | True | + +### Return type +[**TaskResultResponse**](../models/task-result-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Object containing the DTO type TASK_RESULT and the job id for the task | TaskResultResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$ProcessIdentitiesRequest = @"{ + "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] +}"@ + +# Process a list of identityIds + +try { + $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest + Start-V2024IdentityProcessing-V2024XSailPointExperimental $XSailPointExperimental -V2024ProcessIdentitiesRequest $Result + + # Below is a request that includes all optional parameters + # Start-V2024IdentityProcessing -V2024XSailPointExperimental $XSailPointExperimental -V2024ProcessIdentitiesRequest $ProcessIdentitiesRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentityProcessing" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## synchronize-attributes-for-identity +This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityId | **String** | True | The Identity id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**IdentitySyncJob**](../models/identity-sync-job) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | An Identity Sync job | IdentitySyncJob +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "MyIdentityId" # String | The Identity id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Attribute synchronization for single identity. + +try { + Sync-V2024hronizeAttributesForIdentity-V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Sync-V2024hronizeAttributesForIdentity -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024hronizeAttributesForIdentity" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IdentityAttributesApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IdentityAttributesApi.md new file mode 100644 index 000000000..b2c77f53d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IdentityAttributesApi.md @@ -0,0 +1,351 @@ + +--- +id: v2024-identity-attributes +title: IdentityAttributes +pagination_label: IdentityAttributes +sidebar_label: IdentityAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributes', 'V2024IdentityAttributes'] +slug: /tools/sdk/powershell/v2024/methods/identity-attributes +tags: ['SDK', 'Software Development Kit', 'IdentityAttributes', 'V2024IdentityAttributes'] +--- + +# IdentityAttributes + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024IdentityAttribute**](#create-identity-attribute) | **POST** `/identity-attributes` | Create Identity Attribute +[**Remove-V2024IdentityAttribute**](#delete-identity-attribute) | **DELETE** `/identity-attributes/{name}` | Delete Identity Attribute +[**Remove-V2024IdentityAttributesInBulk**](#delete-identity-attributes-in-bulk) | **DELETE** `/identity-attributes/bulk-delete` | Bulk delete Identity Attributes +[**Get-V2024IdentityAttribute**](#get-identity-attribute) | **GET** `/identity-attributes/{name}` | Get Identity Attribute +[**Get-V2024IdentityAttributes**](#list-identity-attributes) | **GET** `/identity-attributes` | List Identity Attributes +[**Send-V2024IdentityAttribute**](#put-identity-attribute) | **PUT** `/identity-attributes/{name}` | Update Identity Attribute + +## create-identity-attribute +Use this API to create a new identity attribute. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | IdentityAttribute | [**IdentityAttribute**](../models/identity-attribute) | True | + +### Return type +[**IdentityAttribute**](../models/identity-attribute) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | The identity attribute was created successfully. | IdentityAttribute +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$IdentityAttribute = @"{ + "standard" : false, + "system" : false, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false +}"@ + +# Create Identity Attribute + +try { + $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute + New-V2024IdentityAttribute-V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result + + # Below is a request that includes all optional parameters + # New-V2024IdentityAttribute -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $IdentityAttribute +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityAttribute" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-identity-attribute +This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Name | **String** | True | The attribute's technical name. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Name = "displayName" # String | The attribute's technical name. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Delete Identity Attribute + +try { + Remove-V2024IdentityAttribute-V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttribute" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-identity-attributes-in-bulk +Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to 'false' before you can delete an identity attribute. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | IdentityAttributeNames | [**IdentityAttributeNames**](../models/identity-attribute-names) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$IdentityAttributeNames = @"{ + "ids" : [ "name", "displayName" ] +}"@ + +# Bulk delete Identity Attributes + +try { + $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames + Remove-V2024IdentityAttributesInBulk-V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttributeNames $Result + + # Below is a request that includes all optional parameters + # Remove-V2024IdentityAttributesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttributeNames $IdentityAttributeNames +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttributesInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-attribute +This gets an identity attribute for a given technical name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Name | **String** | True | The attribute's technical name. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**IdentityAttribute**](../models/identity-attribute) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The identity attribute with the given name | IdentityAttribute +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Name = "displayName" # String | The attribute's technical name. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get Identity Attribute + +try { + Get-V2024IdentityAttribute-V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAttribute" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-identity-attributes +Use this API to get a collection of identity attributes. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | IncludeSystem | **Boolean** | (optional) (default to $false) | Include 'system' attributes in the response. + Query | IncludeSilent | **Boolean** | (optional) (default to $false) | Include 'silent' attributes in the response. + Query | SearchableOnly | **Boolean** | (optional) (default to $false) | Include only 'searchable' attributes in the response. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**IdentityAttribute[]**](../models/identity-attribute) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of identity attributes. | IdentityAttribute[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$IncludeSystem = $false # Boolean | Include 'system' attributes in the response. (optional) (default to $false) +$IncludeSilent = $false # Boolean | Include 'silent' attributes in the response. (optional) (default to $false) +$SearchableOnly = $false # Boolean | Include only 'searchable' attributes in the response. (optional) (default to $false) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# List Identity Attributes + +try { + Get-V2024IdentityAttributes-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAttributes -V2024XSailPointExperimental $XSailPointExperimental -V2024IncludeSystem $IncludeSystem -V2024IncludeSilent $IncludeSilent -V2024SearchableOnly $SearchableOnly -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAttributes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-identity-attribute +This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Name | **String** | True | The attribute's technical name. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | IdentityAttribute | [**IdentityAttribute**](../models/identity-attribute) | True | + +### Return type +[**IdentityAttribute**](../models/identity-attribute) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The identity attribute was updated successfully | IdentityAttribute +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Name = "displayName" # String | The attribute's technical name. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$IdentityAttribute = @"{ + "standard" : false, + "system" : false, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false +}"@ + +# Update Identity Attribute + +try { + $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute + Send-V2024IdentityAttribute-V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result + + # Below is a request that includes all optional parameters + # Send-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $IdentityAttribute +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityAttribute" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IdentityHistoryApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IdentityHistoryApi.md new file mode 100644 index 000000000..ea54cd4f8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IdentityHistoryApi.md @@ -0,0 +1,607 @@ + +--- +id: v2024-identity-history +title: IdentityHistory +pagination_label: IdentityHistory +sidebar_label: IdentityHistory +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityHistory', 'V2024IdentityHistory'] +slug: /tools/sdk/powershell/v2024/methods/identity-history +tags: ['SDK', 'Software Development Kit', 'IdentityHistory', 'V2024IdentityHistory'] +--- + +# IdentityHistory + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Compare-V2024IdentitySnapshots**](#compare-identity-snapshots) | **GET** `/historical-identities/{id}/compare` | Gets a difference of count for each access item types for the given identity between 2 snapshots +[**Compare-V2024IdentitySnapshotsAccessType**](#compare-identity-snapshots-access-type) | **GET** `/historical-identities/{id}/compare/{access-type}` | Gets a list of differences of specific accessType for the given identity between 2 snapshots +[**Get-V2024HistoricalIdentity**](#get-historical-identity) | **GET** `/historical-identities/{id}` | Get latest snapshot of identity +[**Get-V2024HistoricalIdentityEvents**](#get-historical-identity-events) | **GET** `/historical-identities/{id}/events` | Lists all events for the given identity +[**Get-V2024IdentitySnapshot**](#get-identity-snapshot) | **GET** `/historical-identities/{id}/snapshots/{date}` | Gets an identity snapshot at a given date +[**Get-V2024IdentitySnapshotSummary**](#get-identity-snapshot-summary) | **GET** `/historical-identities/{id}/snapshot-summary` | Gets the summary for the event count for a specific identity +[**Get-V2024IdentityStartDate**](#get-identity-start-date) | **GET** `/historical-identities/{id}/start-date` | Gets the start date of the identity +[**Get-V2024HistoricalIdentities**](#list-historical-identities) | **GET** `/historical-identities` | Lists all the identities +[**Get-V2024IdentityAccessItems**](#list-identity-access-items) | **GET** `/historical-identities/{id}/access-items` | List Access Items by Identity +[**Get-V2024IdentitySnapshotAccessItems**](#list-identity-snapshot-access-items) | **GET** `/historical-identities/{id}/snapshots/{date}/access-items` | Gets the list of identity access items at a given date filterd by item type +[**Get-V2024IdentitySnapshots**](#list-identity-snapshots) | **GET** `/historical-identities/{id}/snapshots` | Lists all the snapshots for the identity + +## compare-identity-snapshots +This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Snapshot1 | **String** | (optional) | The snapshot 1 of identity + Query | Snapshot2 | **String** | (optional) | The snapshot 2 of identity + Query | AccessItemTypes | **[]String** | (optional) | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**IdentityCompareResponse[]**](../models/identity-compare-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A IdentityCompare object with difference details for each access item type | IdentityCompareResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Snapshot1 = "2007-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) +$Snapshot2 = "2008-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) +$AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) + + +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Gets a difference of count for each access item types for the given identity between 2 snapshots + +try { + Compare-V2024IdentitySnapshots-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Compare-V2024IdentitySnapshots -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Snapshot1 $Snapshot1 -V2024Snapshot2 $Snapshot2 -V2024AccessItemTypes $AccessItemTypes -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2024IdentitySnapshots" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## compare-identity-snapshots-access-type +This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity id +Path | AccessType | **String** | True | The specific type which needs to be compared + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | AccessAssociated | **Boolean** | (optional) | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed + Query | Snapshot1 | **String** | (optional) | The snapshot 1 of identity + Query | Snapshot2 | **String** | (optional) | The snapshot 2 of identity + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**AccessItemDiff[]**](../models/access-item-diff) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of events for the identity | AccessItemDiff[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id +$AccessType = "accessProfile" # String | The specific type which needs to be compared +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$AccessAssociated = $false # Boolean | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) +$Snapshot1 = "2008-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) +$Snapshot2 = "2009-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Gets a list of differences of specific accessType for the given identity between 2 snapshots + +try { + Compare-V2024IdentitySnapshotsAccessType-V2024Id $Id -V2024AccessType $AccessType -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Compare-V2024IdentitySnapshotsAccessType -V2024Id $Id -V2024AccessType $AccessType -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessAssociated $AccessAssociated -V2024Snapshot1 $Snapshot1 -V2024Snapshot2 $Snapshot2 -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2024IdentitySnapshotsAccessType" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-historical-identity +This method retrieves a specified identity Requires authorization scope of 'idn:identity-history:read' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**IdentityHistoryResponse**](../models/identity-history-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The identity object. | IdentityHistoryResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get latest snapshot of identity + +try { + Get-V2024HistoricalIdentity-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024HistoricalIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentity" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-historical-identity-events +This method retrieves all access events for the identity Requires authorization scope of 'idn:identity-history:read' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | From | **String** | (optional) | The optional instant until which access events are returned + Query | EventTypes | **[]String** | (optional) | An optional list of event types to return. If null or empty, all events are returned + Query | AccessItemTypes | **[]String** | (optional) | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**GetHistoricalIdentityEvents200ResponseInner[]**](../models/get-historical-identity-events200-response-inner) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The list of events for the identity | GetHistoricalIdentityEvents200ResponseInner[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$From = "2024-03-01T13:00:00Z" # String | The optional instant until which access events are returned (optional) +$EventTypes = "MyEventTypes" # String[] | An optional list of event types to return. If null or empty, all events are returned (optional) + +$EventTypes = @"[AccessAddedEvent, AccessRemovedEvent]"@ # String[] | An optional list of event types to return. If null or empty, all events are returned (optional) +$AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) + +$AccessItemTypes = @"[entitlement, account]"@ # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Lists all events for the given identity + +try { + Get-V2024HistoricalIdentityEvents-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024HistoricalIdentityEvents -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024From $From -V2024EventTypes $EventTypes -V2024AccessItemTypes $AccessItemTypes -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentityEvents" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-snapshot +This method retrieves a specified identity snapshot at a given date Requires authorization scope of 'idn:identity-history:read' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity id +Path | Date | **String** | True | The specified date + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**IdentityHistoryResponse**](../models/identity-history-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The identity object. | IdentityHistoryResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id +$Date = "2007-03-01T13:00:00Z" # String | The specified date +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Gets an identity snapshot at a given date + +try { + Get-V2024IdentitySnapshot-V2024Id $Id -V2024Date $Date -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySnapshot -V2024Id $Id -V2024Date $Date -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshot" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-snapshot-summary +This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of 'idn:identity-history:read' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Before | **String** | (optional) | The date before which snapshot summary is required + Query | Interval | **String** | (optional) | The interval indicating day or month. Defaults to month if not specified + Query | TimeZone | **String** | (optional) | The time zone. Defaults to UTC if not provided + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**MetricResponse[]**](../models/metric-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A summary list of identity changes in date histogram format. | MetricResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Before = "2007-03-01T13:00:00Z" # String | The date before which snapshot summary is required (optional) +$Interval = "day" # String | The interval indicating day or month. Defaults to month if not specified (optional) +$TimeZone = "UTC" # String | The time zone. Defaults to UTC if not provided (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Gets the summary for the event count for a specific identity + +try { + Get-V2024IdentitySnapshotSummary-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySnapshotSummary -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Before $Before -V2024Interval $Interval -V2024TimeZone $TimeZone -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshotSummary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-start-date +This method retrieves start date of the identity Requires authorization scope of 'idn:identity-history:read' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +**String** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The start date of the identity | String +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Gets the start date of the identity + +try { + Get-V2024IdentityStartDate-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityStartDate -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityStartDate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-historical-identities +This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of 'idn:identity-history:read' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | StartsWithQuery | **String** | (optional) | This param is used for starts-with search for first, last and display name of the identity + Query | IsDeleted | **Boolean** | (optional) | Indicates if we want to only list down deleted identities or not. + Query | IsActive | **Boolean** | (optional) | Indicates if we want to only list active or inactive identities. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**IdentityListItem[]**](../models/identity-list-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of identities for the customer. | IdentityListItem[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$StartsWithQuery = "Ada" # String | This param is used for starts-with search for first, last and display name of the identity (optional) +$IsDeleted = $true # Boolean | Indicates if we want to only list down deleted identities or not. (optional) +$IsActive = $true # Boolean | Indicates if we want to only list active or inactive identities. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + +# Lists all the identities + +try { + Get-V2024HistoricalIdentities-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024HistoricalIdentities -V2024XSailPointExperimental $XSailPointExperimental -V2024StartsWithQuery $StartsWithQuery -V2024IsDeleted $IsDeleted -V2024IsActive $IsActive -V2024Limit $Limit -V2024Offset $Offset +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentities" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-identity-access-items +This method retrieves a list of access item for the identity filtered by the access item type + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Type | **String** | (optional) | The type of access item for the identity. If not provided, it defaults to account + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**ListIdentityAccessItems200ResponseInner[]**](../models/list-identity-access-items200-response-inner) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The list of access items. | ListIdentityAccessItems200ResponseInner[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Type = "account" # String | The type of access item for the identity. If not provided, it defaults to account (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + +# List Access Items by Identity + +try { + Get-V2024IdentityAccessItems-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAccessItems -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Type $Type -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-identity-snapshot-access-items +This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of 'idn:identity-history:read' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity id +Path | Date | **String** | True | The specified date + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Type | **String** | (optional) | The access item type + +### Return type +[**ListIdentityAccessItems200ResponseInner[]**](../models/list-identity-access-items200-response-inner) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The identity object. | ListIdentityAccessItems200ResponseInner[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id +$Date = "2007-03-01T13:00:00Z" # String | The specified date +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Type = "account" # String | The access item type (optional) + +# Gets the list of identity access items at a given date filterd by item type + +try { + Get-V2024IdentitySnapshotAccessItems-V2024Id $Id -V2024Date $Date -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySnapshotAccessItems -V2024Id $Id -V2024Date $Date -V2024XSailPointExperimental $XSailPointExperimental -V2024Type $Type +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshotAccessItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-identity-snapshots +This method retrieves all the snapshots for the identity Requires authorization scope of 'idn:identity-history:read' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Start | **String** | (optional) | The specified start date + Query | Interval | **String** | (optional) | The interval indicating the range in day or month for the specified interval-name + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**IdentitySnapshotSummaryResponse[]**](../models/identity-snapshot-summary-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of identity summary for each snapshot. | IdentitySnapshotSummaryResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Start = "2007-03-01T13:00:00Z" # String | The specified start date (optional) +$Interval = "day" # String | The interval indicating the range in day or month for the specified interval-name (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Lists all the snapshots for the identity + +try { + Get-V2024IdentitySnapshots-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySnapshots -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Start $Start -V2024Interval $Interval -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshots" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IdentityProfilesApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IdentityProfilesApi.md new file mode 100644 index 000000000..0aa0db79a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024IdentityProfilesApi.md @@ -0,0 +1,699 @@ + +--- +id: v2024-identity-profiles +title: IdentityProfiles +pagination_label: IdentityProfiles +sidebar_label: IdentityProfiles +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfiles', 'V2024IdentityProfiles'] +slug: /tools/sdk/powershell/v2024/methods/identity-profiles +tags: ['SDK', 'Software Development Kit', 'IdentityProfiles', 'V2024IdentityProfiles'] +--- + +# IdentityProfiles + Use this API to implement identity profile functionality. +With this functionality in place, administrators can view identity profiles and their configurations. + +Identity profiles represent the configurations that can be applied to identities as a way of granting them a set of security and access, as well as defining the mappings between their identity attributes and their source attributes. + +In Identity Security Cloud, administrators can use the Identities drop-down menu and select Identity Profiles to view the list of identity profiles. +This list shows some details about each identity profile, along with its status. +They can select an identity profile to view its settings, its mappings between identity attributes and correlating source account attributes, and its provisioning settings. + +Refer to [Creating Identity Profiles](https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html) for more information about identity profiles. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024IdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create an Identity Profile +[**Remove-V2024IdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete an Identity Profile +[**Remove-V2024IdentityProfiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete Identity Profiles +[**Export-V2024IdentityProfiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export Identity Profiles +[**Get-V2024DefaultIdentityAttributeConfig**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default Identity Attribute Config +[**Get-V2024IdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get single Identity Profile +[**Import-V2024IdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles +[**Get-V2024IdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | Identity Profiles List +[**Show-V2024IdentityPreview**](#show-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview +[**Sync-V2024IdentityProfile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile +[**Update-V2024IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update the Identity Profile + +## create-identity-profile +This creates an Identity Profile. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | IdentityProfile | [**IdentityProfile**](../models/identity-profile) | True | + +### Return type +[**IdentityProfile**](../models/identity-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | The created Identity Profile | IdentityProfile +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$IdentityProfile = @"{ + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" +}"@ + +# Create an Identity Profile + +try { + $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile + New-V2024IdentityProfile-V2024IdentityProfile $Result + + # Below is a request that includes all optional parameters + # New-V2024IdentityProfile -V2024IdentityProfile $IdentityProfile +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-identity-profile +This deletes an Identity Profile based on ID. + +On success, this endpoint will return a reference to the bulk delete task result. + + +The following rights are required to access this endpoint: idn:identity-profile:delete + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | The Identity Profile ID. + +### Return type +[**TaskResultSimplified**](../models/task-result-simplified) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returns a TaskResult object referencing the bulk delete job created. | TaskResultSimplified +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. + +# Delete an Identity Profile + +try { + Remove-V2024IdentityProfile-V2024IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Remove-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-identity-profiles +This deletes multiple Identity Profiles via a list of supplied IDs. + +On success, this endpoint will return a reference to the bulk delete task result. + +The following rights are required to access this endpoint: idn:identity-profile:delete + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | RequestBody | **[]String** | True | Identity Profile bulk delete request body. + +### Return type +[**TaskResultSimplified**](../models/task-result-simplified) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returns a TaskResult object referencing the bulk delete job created. | TaskResultSimplified +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body. + $RequestBody = @""@ # String[] | Identity Profile bulk delete request body. + + +# Delete Identity Profiles + +try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-V2024IdentityProfiles-V2024RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-V2024IdentityProfiles -V2024RequestBody $RequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityProfiles" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## export-identity-profiles +This exports existing identity profiles in the format specified by the sp-config service. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** + +### Return type +[**IdentityProfileExportedObject[]**](../models/identity-profile-exported-object) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of export objects with identity profiles. | IdentityProfileExportedObject[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) +$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) + +# Export Identity Profiles + +try { + Export-V2024IdentityProfiles + + # Below is a request that includes all optional parameters + # Export-V2024IdentityProfiles -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024IdentityProfiles" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-default-identity-attribute-config +This returns the default identity attribute config. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | The Identity Profile ID. + +### Return type +[**IdentityAttributeConfig**](../models/identity-attribute-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An Identity Attribute Config object. | IdentityAttributeConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. + +# Get default Identity Attribute Config + +try { + Get-V2024DefaultIdentityAttributeConfig-V2024IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-V2024DefaultIdentityAttributeConfig -V2024IdentityProfileId $IdentityProfileId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultIdentityAttributeConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-profile +This returns a single Identity Profile based on ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | The Identity Profile ID. + +### Return type +[**IdentityProfile**](../models/identity-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An Identity Profile object. | IdentityProfile +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. + +# Get single Identity Profile + +try { + Get-V2024IdentityProfile-V2024IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-identity-profiles +This imports previously exported identity profiles. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | IdentityProfileExportedObject | [**[]IdentityProfileExportedObject**](../models/identity-profile-exported-object) | True | Previously exported Identity Profiles. + +### Return type +[**ObjectImportResult**](../models/object-import-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The result of importing Identity Profiles. | ObjectImportResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell + + + + + + $IdentityProfileExportedObject = @"{ + "self" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "version" : 1, + "object" : { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + } +}"@ # IdentityProfileExportedObject[] | Previously exported Identity Profiles. + + +# Import Identity Profiles + +try { + $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject + Import-V2024IdentityProfiles-V2024IdentityProfileExportedObject $Result + + # Below is a request that includes all optional parameters + # Import-V2024IdentityProfiles -V2024IdentityProfileExportedObject $IdentityProfileExportedObject +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024IdentityProfiles" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-identity-profiles +This returns a list of Identity Profiles based on the specified query parameters. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** + +### Return type +[**IdentityProfile[]**](../models/identity-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of identityProfiles. | IdentityProfile[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional) +$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) + +# Identity Profiles List + +try { + Get-V2024IdentityProfiles + + # Below is a request that includes all optional parameters + # Get-V2024IdentityProfiles -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityProfiles" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## show-identity-preview +Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body. +This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | IdentityPreviewRequest | [**IdentityPreviewRequest**](../models/identity-preview-request) | True | Identity Preview request body. + +### Return type +[**IdentityPreviewResponse**](../models/identity-preview-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A preview of the identity attributes after applying identity attributes config sent in request body. | IdentityPreviewResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$IdentityPreviewRequest = @"{ + "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + } +}"@ + +# Generate Identity Profile Preview + +try { + $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest + Show-V2024IdentityPreview-V2024IdentityPreviewRequest $Result + + # Below is a request that includes all optional parameters + # Show-V2024IdentityPreview -V2024IdentityPreviewRequest $IdentityPreviewRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024IdentityPreview" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## sync-identity-profile +Process identities under the profile +This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. +This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. +This operation will perform the following activities on all identities under the identity profile. +1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity's correct manager through manager correlation. 3. Updates the identity's access according to their assigned lifecycle state. 4. Updates the identity's access based on role assignment criteria. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | The Identity Profile ID to be processed + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed + +# Process identities under profile + +try { + Sync-V2024IdentityProfile-V2024IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Sync-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024IdentityProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-identity-profile +This updates the specified Identity Profile. + + +Some fields of the Schema cannot be updated. These fields are listed below: +* id +* name +* created +* modified +* identityCount +* identityRefreshRequired +* Authoritative Source and Identity Attribute Configuration cannot be modified at once. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | The Identity Profile ID + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**IdentityProfile**](../models/identity-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The updated Identity Profile. | IdentityProfile +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +# Update the Identity Profile + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024IdentityProfile-V2024IdentityProfileId $IdentityProfileId -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024IdentityProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024LifecycleStatesApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024LifecycleStatesApi.md new file mode 100644 index 000000000..e4c4e8f59 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024LifecycleStatesApi.md @@ -0,0 +1,373 @@ + +--- +id: v2024-lifecycle-states +title: LifecycleStates +pagination_label: LifecycleStates +sidebar_label: LifecycleStates +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LifecycleStates', 'V2024LifecycleStates'] +slug: /tools/sdk/powershell/v2024/methods/lifecycle-states +tags: ['SDK', 'Software Development Kit', 'LifecycleStates', 'V2024LifecycleStates'] +--- + +# LifecycleStates + Use this API to implement and customize lifecycle state functionality. +With this functionality in place, administrators can create and configure custom lifecycle states for use across their organizations, which is key to controlling which users have access, when they have access, and the access they have. + +A lifecycle state describes a user's status in a company. For example, two lifecycle states come by default with Identity Security Cloud: 'Active' and 'Inactive.' +When an active employee takes an extended leave of absence from a company, his or her lifecycle state may change to 'Inactive,' for security purposes. +The inactive employee would lose access to all the applications, sources, and sensitive data during the leave of absence, but when the employee returns and becomes active again, all that access would be restored. +This saves administrators the time that would otherwise be spent provisioning the employee's access to each individual tool, reviewing the employee's certification history, etc. + +Administrators can create a variety of custom lifecycle states. Refer to [Planning New Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#planning-new-lifecycle-states) for some custom lifecycle state ideas. + +Administrators must define the criteria for being in each lifecycle state, and they must define how Identity Security Cloud manages users' access to apps and sources for each lifecycle state. + +In Identity Security Cloud, administrators can manage lifecycle states by going to Admin > Identities > Identity Profile, selecting the identity profile whose lifecycle states they want to manage, selecting the 'Provisioning' tab, and using the left panel to either select the lifecycle state they want to modify or create a new lifecycle state. + +In the 'Provisioning' tab, administrators can make the following access changes to an identity profile's lifecycle state: + +- Enable/disable the lifecycle state for the identity profile. + +- Enable/disable source accounts for the identity profile's lifecycle state. + +- Add existing access profiles to grant to the identity profiles in that lifecycle state. + +- Create a new access profile to grant to the identity profile in that lifecycle state. + +Access profiles granted in a previous lifecycle state are automatically revoked when the identity moves to a new lifecycle state. +To maintain access across multiple lifecycle states, administrators must grant the access profiles in each lifecycle state. +For example, if an administrator wants users with the 'HR Employee' identity profile to maintain their building access in both the 'Active' and 'Leave of Absence' lifecycle states, the administrator must grant the access profile for that building access to both lifecycle states. + +During scheduled refreshes, Identity Security Cloud evaluates lifecycle states to determine whether their assigned identities have the access defined in the lifecycle states' access profiles. +If the identities are missing access, Identity Security Cloud provisions that access. + +Administrators can also use the 'Provisioning' tab to configure email notifications for Identity Security Cloud to send whenever an identity with that identity profile has a lifecycle state change. +Refer to [Configuring Lifecycle State Notifications](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#configuring-lifecycle-state-notifications) for more information on how to do so. + +An identity's lifecycle state can have four different statuses: the lifecycle state's status can be 'Active,' it can be 'Not Set,' it can be 'Not Valid,' or it 'Does Not Match Technical Name Case.' +Refer to [Moving Identities into Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#moving-identities-into-lifecycle-states) for more information about these different lifecycle state statuses. + +Refer to [Setting Up Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html) for more information about lifecycle states. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024LifecycleState**](#create-lifecycle-state) | **POST** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Create Lifecycle State +[**Remove-V2024LifecycleState**](#delete-lifecycle-state) | **DELETE** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Delete Lifecycle State +[**Get-V2024LifecycleState**](#get-lifecycle-state) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State +[**Get-V2024LifecycleStates**](#get-lifecycle-states) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Lists LifecycleStates +[**Set-V2024LifecycleState**](#set-lifecycle-state) | **POST** `/identities/{identity-id}/set-lifecycle-state` | Set Lifecycle State +[**Update-V2024LifecycleStates**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State + +## create-lifecycle-state +Use this endpoint to create a lifecycle state. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | Identity profile ID. + Body | LifecycleState | [**LifecycleState**](../models/lifecycle-state) | True | Lifecycle state to be created. + +### Return type +[**LifecycleState**](../models/lifecycle-state) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Created LifecycleState object. | LifecycleState +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. +$LifecycleState = @"{ + "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], + "emailNotificationOption" : { + "notifyManagers" : true, + "notifySpecificUsers" : true, + "emailAddressList" : [ "test@test.com", "test2@test.com" ], + "notifyAllAdmins" : true + }, + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Lifecycle description", + "accountActions" : [ { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }, { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } ], + "id" : "id12345", + "identityCount" : 42, + "technicalName" : "Technical Name", + "identityState" : "identityState", + "enabled" : true +}"@ + +# Create Lifecycle State + +try { + $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState + New-V2024LifecycleState-V2024IdentityProfileId $IdentityProfileId -V2024LifecycleState $Result + + # Below is a request that includes all optional parameters + # New-V2024LifecycleState -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleState $LifecycleState +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024LifecycleState" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-lifecycle-state +Use this endpoint to delete the lifecycle state by its ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | Identity profile ID. +Path | LifecycleStateId | **String** | True | Lifecycle state ID. + +### Return type +[**LifecyclestateDeleted**](../models/lifecyclestate-deleted) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | The request was successfully accepted into the system. | LifecyclestateDeleted +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. +$LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + +# Delete Lifecycle State + +try { + Remove-V2024LifecycleState-V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Remove-V2024LifecycleState -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024LifecycleState" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-lifecycle-state +Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | Identity profile ID. +Path | LifecycleStateId | **String** | True | Lifecycle state ID. + +### Return type +[**LifecycleState**](../models/lifecycle-state) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The requested LifecycleState was successfully retrieved. | LifecycleState +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. +$LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + +# Get Lifecycle State + +try { + Get-V2024LifecycleState-V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Get-V2024LifecycleState -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LifecycleState" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-lifecycle-states +Use this endpoint to list all lifecycle states by their associated identity profiles. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | Identity profile ID. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** + +### Return type +[**LifecycleState[]**](../models/lifecycle-state) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of LifecycleState objects. | LifecycleState[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + +# Lists LifecycleStates + +try { + Get-V2024LifecycleStates-V2024IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-V2024LifecycleStates -V2024IdentityProfileId $IdentityProfileId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LifecycleStates" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-lifecycle-state +Use this API to set/update an identity's lifecycle state to the one provided and update the corresponding identity profile. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityId | **String** | True | ID of the identity to update. + Body | SetLifecycleStateRequest | [**SetLifecycleStateRequest**](../models/set-lifecycle-state-request) | True | + +### Return type +[**SetLifecycleState200Response**](../models/set-lifecycle-state200-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The request was successfully accepted into the system. | SetLifecycleState200Response +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "2c9180857893f1290178944561990364" # String | ID of the identity to update. +$SetLifecycleStateRequest = @""@ + +# Set Lifecycle State + +try { + $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest + Set-V2024LifecycleState-V2024IdentityId $IdentityId -V2024SetLifecycleStateRequest $Result + + # Below is a request that includes all optional parameters + # Set-V2024LifecycleState -V2024IdentityId $IdentityId -V2024SetLifecycleStateRequest $SetLifecycleStateRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024LifecycleState" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-lifecycle-states +Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | Identity profile ID. +Path | LifecycleStateId | **String** | True | Lifecycle state ID. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption + +### Return type +[**LifecycleState**](../models/lifecycle-state) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The LifecycleState was successfully updated. | LifecycleState +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. +$LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption + + +# Update Lifecycle State + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024LifecycleStates-V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024LifecycleStates -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024LifecycleStates" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024MFAConfigurationApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024MFAConfigurationApi.md new file mode 100644 index 000000000..a5584c34a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024MFAConfigurationApi.md @@ -0,0 +1,341 @@ + +--- +id: v2024-mfa-configuration +title: MFAConfiguration +pagination_label: MFAConfiguration +sidebar_label: MFAConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MFAConfiguration', 'V2024MFAConfiguration'] +slug: /tools/sdk/powershell/v2024/methods/mfa-configuration +tags: ['SDK', 'Software Development Kit', 'MFAConfiguration', 'V2024MFAConfiguration'] +--- + +# MFAConfiguration + Configure and test multifactor authentication (MFA) methods + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024MFADuoConfig**](#get-mfa-duo-config) | **GET** `/mfa/duo-web/config` | Configuration of Duo MFA method +[**Get-V2024MFAKbaConfig**](#get-mfa-kba-config) | **GET** `/mfa/kba/config` | Configuration of KBA MFA method +[**Get-V2024MFAOktaConfig**](#get-mfa-okta-config) | **GET** `/mfa/okta-verify/config` | Configuration of Okta MFA method +[**Set-V2024MFADuoConfig**](#set-mfa-duo-config) | **PUT** `/mfa/duo-web/config` | Set Duo MFA configuration +[**Set-V2024MFAKBAConfig**](#set-mfakba-config) | **POST** `/mfa/kba/config/answers` | Set MFA KBA configuration +[**Set-V2024MFAOktaConfig**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set Okta MFA configuration +[**Test-V2024MFAConfig**](#test-mfa-config) | **GET** `/mfa/{method}/test` | MFA method's test configuration + +## get-mfa-duo-config +This API returns the configuration of an Duo MFA method. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**MfaDuoConfig**](../models/mfa-duo-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The configuration of an Duo MFA method. | MfaDuoConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Configuration of Duo MFA method + +try { + Get-V2024MFADuoConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFADuoConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFADuoConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-mfa-kba-config +This API returns the KBA configuration for MFA. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | AllLanguages | **Boolean** | (optional) | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false + +### Return type +[**KbaQuestion[]**](../models/kba-question) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The configuration for KBA MFA method. | KbaQuestion[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + +# Configuration of KBA MFA method + +try { + Get-V2024MFAKbaConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFAKbaConfig -V2024AllLanguages $AllLanguages +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAKbaConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-mfa-okta-config +This API returns the configuration of an Okta MFA method. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**MfaOktaConfig**](../models/mfa-okta-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The configuration of an Okta MFA method. | MfaOktaConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Configuration of Okta MFA method + +try { + Get-V2024MFAOktaConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFAOktaConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAOktaConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-mfa-duo-config +This API sets the configuration of an Duo MFA method. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | MfaDuoConfig | [**MfaDuoConfig**](../models/mfa-duo-config) | True | + +### Return type +[**MfaDuoConfig**](../models/mfa-duo-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | MFA configuration of an Duo MFA method. | MfaDuoConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$MfaDuoConfig = @"{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" +}"@ + +# Set Duo MFA configuration + +try { + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-V2024MFADuoConfig-V2024MfaDuoConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFADuoConfig -V2024MfaDuoConfig $MfaDuoConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFADuoConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-mfakba-config +This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | KbaAnswerRequestItem | [**[]KbaAnswerRequestItem**](../models/kba-answer-request-item) | True | + +### Return type +[**KbaAnswerResponseItem[]**](../models/kba-answer-response-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The new KBA configuration for the user. | KbaAnswerResponseItem[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" +}"@ # KbaAnswerRequestItem[] | + + +# Set MFA KBA configuration + +try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-V2024MFAKBAConfig-V2024KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $KbaAnswerRequestItem +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAKBAConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-mfa-okta-config +This API sets the configuration of an Okta MFA method. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | MfaOktaConfig | [**MfaOktaConfig**](../models/mfa-okta-config) | True | + +### Return type +[**MfaOktaConfig**](../models/mfa-okta-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | MFA configuration of an Okta MFA method. | MfaOktaConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$MfaOktaConfig = @"{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" +}"@ + +# Set Okta MFA configuration + +try { + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-V2024MFAOktaConfig-V2024MfaOktaConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFAOktaConfig -V2024MfaOktaConfig $MfaOktaConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAOktaConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## test-mfa-config +This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Method | **String** | True | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + +### Return type +[**MfaConfigTestResponse**](../models/mfa-config-test-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The result of configuration test for the MFA provider. | MfaConfigTestResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + +# MFA method's test configuration + +try { + Test-V2024MFAConfig-V2024Method $Method + + # Below is a request that includes all optional parameters + # Test-V2024MFAConfig -V2024Method $Method +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024MFAConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ManagedClientsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ManagedClientsApi.md new file mode 100644 index 000000000..9e0e38495 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ManagedClientsApi.md @@ -0,0 +1,307 @@ + +--- +id: v2024-managed-clients +title: ManagedClients +pagination_label: ManagedClients +sidebar_label: ManagedClients +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClients', 'V2024ManagedClients'] +slug: /tools/sdk/powershell/v2024/methods/managed-clients +tags: ['SDK', 'Software Development Kit', 'ManagedClients', 'V2024ManagedClients'] +--- + +# ManagedClients + Use this API to implement managed client functionality. +With this functionality in place, administrators can modify and delete existing managed clients, create new ones, and view and make changes to their log configurations. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024ManagedClient**](#create-managed-client) | **POST** `/managed-clients` | Create Managed Client +[**Remove-V2024ManagedClient**](#delete-managed-client) | **DELETE** `/managed-clients/{id}` | Delete Managed Client +[**Get-V2024ManagedClient**](#get-managed-client) | **GET** `/managed-clients/{id}` | Get Managed Client +[**Get-V2024ManagedClientStatus**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Get Managed Client Status +[**Get-V2024ManagedClients**](#get-managed-clients) | **GET** `/managed-clients` | Get Managed Clients +[**Update-V2024ManagedClient**](#update-managed-client) | **PATCH** `/managed-clients/{id}` | Update Managed Client + +## create-managed-client +Create a new managed client. +The API returns a result that includes the managed client ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | ManagedClientRequest | [**ManagedClientRequest**](../models/managed-client-request) | True | + +### Return type +[**ManagedClient**](../models/managed-client) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Created managed client. | ManagedClient +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$ManagedClientRequest = @"{ + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" +}"@ + +# Create Managed Client + +try { + $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest + New-V2024ManagedClient-V2024ManagedClientRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ManagedClient -V2024ManagedClientRequest $ManagedClientRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClient" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-managed-client +Delete an existing managed client. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Managed client ID. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + +# Delete Managed Client + +try { + Remove-V2024ManagedClient-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ManagedClient -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClient" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-managed-client +Get managed client by ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Managed client ID. + +### Return type +[**ManagedClient**](../models/managed-client) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Managed client response. | ManagedClient +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + +# Get Managed Client + +try { + Get-V2024ManagedClient-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClient -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClient" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-managed-client-status +Get a managed client's status, using its ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Managed client ID to get status for. + Query | Type | [**ManagedClientType**](../models/managed-client-type) | True | Managed client type to get status for. + +### Return type +[**ManagedClientStatus**](../models/managed-client-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Response with the managed client status, with the given ID and type. | ManagedClientStatus +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "aClientId" # String | Managed client ID to get status for. +$Type = "CCG" # ManagedClientType | Managed client type to get status for. + +# Get Managed Client Status + +try { + Get-V2024ManagedClientStatus-V2024Id $Id -V2024Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClientStatus -V2024Id $Id -V2024Type $Type +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClientStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-managed-clients +List managed clients. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* + +### Return type +[**ManagedClient[]**](../models/managed-client) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Response with a list of managed clients, based on the specified query parameters. | ManagedClient[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'name eq "client name"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + +# Get Managed Clients + +try { + Get-V2024ManagedClients + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClients -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClients" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-managed-client +Update an existing managed client. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Managed client ID. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | JSONPatch payload used to update the object. + +### Return type +[**ManagedClient**](../models/managed-client) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated managed client. | ManagedClient +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | JSONPatch payload used to update the object. + + +# Update Managed Client + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ManagedClient-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ManagedClient -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClient" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ManagedClustersApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ManagedClustersApi.md new file mode 100644 index 000000000..b8d648d3e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ManagedClustersApi.md @@ -0,0 +1,358 @@ + +--- +id: v2024-managed-clusters +title: ManagedClusters +pagination_label: ManagedClusters +sidebar_label: ManagedClusters +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusters', 'V2024ManagedClusters'] +slug: /tools/sdk/powershell/v2024/methods/managed-clusters +tags: ['SDK', 'Software Development Kit', 'ManagedClusters', 'V2024ManagedClusters'] +--- + +# ManagedClusters + Use this API to implement managed cluster functionality. +With this functionality in place, administrators can modify and delete existing managed clients, get their statuses, and create new ones. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024ManagedCluster**](#create-managed-cluster) | **POST** `/managed-clusters` | Create Create Managed Cluster +[**Remove-V2024ManagedCluster**](#delete-managed-cluster) | **DELETE** `/managed-clusters/{id}` | Delete Managed Cluster +[**Get-V2024ClientLogConfiguration**](#get-client-log-configuration) | **GET** `/managed-clusters/{id}/log-config` | Get Managed Cluster Log Configuration +[**Get-V2024ManagedCluster**](#get-managed-cluster) | **GET** `/managed-clusters/{id}` | Get Managed Cluster +[**Get-V2024ManagedClusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Get Managed Clusters +[**Send-V2024ClientLogConfiguration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update Managed Cluster Log Configuration +[**Update-V2024ManagedCluster**](#update-managed-cluster) | **PATCH** `/managed-clusters/{id}` | Update Managed Cluster + +## create-managed-cluster +Create a new Managed Cluster. +The API returns a result that includes the managed cluster ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | ManagedClusterRequest | [**ManagedClusterRequest**](../models/managed-cluster-request) | True | + +### Return type +[**ManagedCluster**](../models/managed-cluster) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Created managed cluster. | ManagedCluster +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$ManagedClusterRequest = @"{ + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" +}"@ + +# Create Create Managed Cluster + +try { + $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest + New-V2024ManagedCluster-V2024ManagedClusterRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ManagedCluster -V2024ManagedClusterRequest $ManagedClusterRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedCluster" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-managed-cluster +Delete an existing managed cluster. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Managed cluster ID. + Query | RemoveClients | **Boolean** | (optional) (default to $false) | Flag to determine the need to delete a cluster with clients. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. +$RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) + +# Delete Managed Cluster + +try { + Remove-V2024ManagedCluster-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ManagedCluster -V2024Id $Id -V2024RemoveClients $RemoveClients +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedCluster" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-client-log-configuration +Get a managed cluster's log configuration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of managed cluster to get log configuration for. + +### Return type +[**ClientLogConfiguration**](../models/client-log-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Log configuration of managed cluster for given cluster ID. | ClientLogConfiguration +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. + +# Get Managed Cluster Log Configuration + +try { + Get-V2024ClientLogConfiguration-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ClientLogConfiguration -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ClientLogConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-managed-cluster +Get a managed cluster by ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Managed cluster ID. + +### Return type +[**ManagedCluster**](../models/managed-cluster) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Response with managed cluster for the given ID. | ManagedCluster +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + +# Get Managed Cluster + +try { + Get-V2024ManagedCluster-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ManagedCluster -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedCluster" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-managed-clusters +List current organization's managed clusters, based on request context. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* + +### Return type +[**ManagedCluster[]**](../models/managed-cluster) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Response with a list of managed clusters. | ManagedCluster[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'operational eq "operation"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + +# Get Managed Clusters + +try { + Get-V2024ManagedClusters + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClusters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusters" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-client-log-configuration +Update a managed cluster's log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the managed cluster to update the log configuration for. + Body | PutClientLogConfigurationRequest | [**PutClientLogConfigurationRequest**](../models/put-client-log-configuration-request) | True | Client log configuration for the given managed cluster. + +### Return type +[**ClientLogConfiguration**](../models/client-log-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Response with updated client log configuration for the given managed cluster. | ClientLogConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. +$PutClientLogConfigurationRequest = @""@ + +# Update Managed Cluster Log Configuration + +try { + $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest + Send-V2024ClientLogConfiguration-V2024Id $Id -V2024PutClientLogConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2024ClientLogConfiguration -V2024Id $Id -V2024PutClientLogConfigurationRequest $PutClientLogConfigurationRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ClientLogConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-managed-cluster +Update an existing managed cluster. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Managed cluster ID. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | JSONPatch payload used to update the object. + +### Return type +[**ManagedCluster**](../models/managed-cluster) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated managed cluster. | ManagedCluster +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | JSONPatch payload used to update the object. + + +# Update Managed Cluster + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ManagedCluster-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ManagedCluster -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedCluster" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024NonEmployeeLifecycleManagementApi.md new file mode 100644 index 000000000..be2e241d9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024NonEmployeeLifecycleManagementApi.md @@ -0,0 +1,1653 @@ + +--- +id: v2024-non-employee-lifecycle-management +title: NonEmployeeLifecycleManagement +pagination_label: NonEmployeeLifecycleManagement +sidebar_label: NonEmployeeLifecycleManagement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeLifecycleManagement', 'V2024NonEmployeeLifecycleManagement'] +slug: /tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management +tags: ['SDK', 'Software Development Kit', 'NonEmployeeLifecycleManagement', 'V2024NonEmployeeLifecycleManagement'] +--- + +# NonEmployeeLifecycleManagement + Use this API to implement non-employee lifecycle management functionality. +With this functionality in place, administrators can create non-employee records and configure them for use in their organizations. +This allows organizations to provide secure access to non-employees and control that access. + +The 'non-employee' term refers to any consultant, contractor, intern, or other user in an organization who is not a full-time permanent employee. +Organizations can track non-employees' access and activity in Identity Security Cloud by creating and maintaining non-employee sources. +Organizations can have a maximum of 50 non-employee sources. + +By using SailPoint's Non-Employee Lifecycle Management functionality, you agree to the following: + +- SailPoint is not responsible for storing sensitive data. +You may only add account attributes to non-employee identities that are necessary for business operations and are consistent with your contractual limitations on data that may be sent or stored in Identity Security Cloud. + +- You are responsible for regularly downloading your list of non-employee accounts for all the sources you create and storing this list of accounts in a managed location to maintain an authoritative system of record and backup data for these accounts. + +To manage non-employees in Identity Security Cloud, administrators must create a non-employee source and add accounts to the source. + +To create a non-employee source in Identity Security Cloud, administrators must use the Admin panel to go to Connections > Sources. +They must then specify 'Non-Employee' in the 'Source Type' field. +Refer to [Creating a Non-Employee Source](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#creating-a-non-employee-source) for more details about how to create non-employee sources. + +To add accounts to a non-employee source in Identity Security Cloud, administrators can select the non-employee source and add the accounts. +They can also use the 'Manage Non-Employees' widget on their user dashboards to reach the list of sources and then select the non-employee source they want to add the accounts to. + +Administrators can either add accounts individually or in bulk. Each non-employee source can have a maximum of 20,000 accounts. +To add accounts in bulk, they must select the 'Bulk Upload' option and upload a CSV file. +Refer to [Adding Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#adding-accounts) for more details about how to add accounts to non-employee sources. + +Once administrators have created the non-employee source and added accounts to it, they can create identity profiles to generate identities for the non-employee accounts and manage the non-employee identities the same way they would any other identities. + +Refer to [Managing Non-Employee Sources and Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html) for more information about non-employee lifecycle management. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Approve-V2024NonEmployeeRequest**](#approve-non-employee-request) | **POST** `/non-employee-approvals/{id}/approve` | Approve a Non-Employee Request +[**New-V2024NonEmployeeRecord**](#create-non-employee-record) | **POST** `/non-employee-records` | Create Non-Employee Record +[**New-V2024NonEmployeeRequest**](#create-non-employee-request) | **POST** `/non-employee-requests` | Create Non-Employee Request +[**New-V2024NonEmployeeSource**](#create-non-employee-source) | **POST** `/non-employee-sources` | Create Non-Employee Source +[**New-V2024NonEmployeeSourceSchemaAttributes**](#create-non-employee-source-schema-attributes) | **POST** `/non-employee-sources/{sourceId}/schema-attributes` | Create a new Schema Attribute for Non-Employee Source +[**Remove-V2024NonEmployeeRecord**](#delete-non-employee-record) | **DELETE** `/non-employee-records/{id}` | Delete Non-Employee Record +[**Remove-V2024NonEmployeeRecordsInBulk**](#delete-non-employee-records-in-bulk) | **POST** `/non-employee-records/bulk-delete` | Delete Multiple Non-Employee Records +[**Remove-V2024NonEmployeeRequest**](#delete-non-employee-request) | **DELETE** `/non-employee-requests/{id}` | Delete Non-Employee Request +[**Remove-V2024NonEmployeeSchemaAttribute**](#delete-non-employee-schema-attribute) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete a Schema Attribute for Non-Employee Source +[**Remove-V2024NonEmployeeSource**](#delete-non-employee-source) | **DELETE** `/non-employee-sources/{sourceId}` | Delete Non-Employee Source +[**Remove-V2024NonEmployeeSourceSchemaAttributes**](#delete-non-employee-source-schema-attributes) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes for Non-Employee Source +[**Export-V2024NonEmployeeRecords**](#export-non-employee-records) | **GET** `/non-employee-sources/{id}/non-employees/download` | Exports Non-Employee Records to CSV +[**Export-V2024NonEmployeeSourceSchemaTemplate**](#export-non-employee-source-schema-template) | **GET** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports Source Schema Template +[**Get-V2024NonEmployeeApproval**](#get-non-employee-approval) | **GET** `/non-employee-approvals/{id}` | Get a non-employee approval item detail +[**Get-V2024NonEmployeeApprovalSummary**](#get-non-employee-approval-summary) | **GET** `/non-employee-approvals/summary/{requested-for}` | Get Summary of Non-Employee Approval Requests +[**Get-V2024NonEmployeeBulkUploadStatus**](#get-non-employee-bulk-upload-status) | **GET** `/non-employee-sources/{id}/non-employee-bulk-upload/status` | Obtain the status of bulk upload on the source +[**Get-V2024NonEmployeeRecord**](#get-non-employee-record) | **GET** `/non-employee-records/{id}` | Get a Non-Employee Record +[**Get-V2024NonEmployeeRequest**](#get-non-employee-request) | **GET** `/non-employee-requests/{id}` | Get a Non-Employee Request +[**Get-V2024NonEmployeeRequestSummary**](#get-non-employee-request-summary) | **GET** `/non-employee-requests/summary/{requested-for}` | Get Summary of Non-Employee Requests +[**Get-V2024NonEmployeeSchemaAttribute**](#get-non-employee-schema-attribute) | **GET** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get Schema Attribute Non-Employee Source +[**Get-V2024NonEmployeeSource**](#get-non-employee-source) | **GET** `/non-employee-sources/{sourceId}` | Get a Non-Employee Source +[**Get-V2024NonEmployeeSourceSchemaAttributes**](#get-non-employee-source-schema-attributes) | **GET** `/non-employee-sources/{sourceId}/schema-attributes` | List Schema Attributes Non-Employee Source +[**Import-V2024NonEmployeeRecordsInBulk**](#import-non-employee-records-in-bulk) | **POST** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or Updates, Non-Employee Records +[**Get-V2024NonEmployeeApprovals**](#list-non-employee-approvals) | **GET** `/non-employee-approvals` | Get List of Non-Employee Approval Requests +[**Get-V2024NonEmployeeRecords**](#list-non-employee-records) | **GET** `/non-employee-records` | List Non-Employee Records +[**Get-V2024NonEmployeeRequests**](#list-non-employee-requests) | **GET** `/non-employee-requests` | List Non-Employee Requests +[**Get-V2024NonEmployeeSources**](#list-non-employee-sources) | **GET** `/non-employee-sources` | List Non-Employee Sources +[**Update-V2024NonEmployeeRecord**](#patch-non-employee-record) | **PATCH** `/non-employee-records/{id}` | Patch Non-Employee Record +[**Update-V2024NonEmployeeSchemaAttribute**](#patch-non-employee-schema-attribute) | **PATCH** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch a Schema Attribute for Non-Employee Source +[**Update-V2024NonEmployeeSource**](#patch-non-employee-source) | **PATCH** `/non-employee-sources/{sourceId}` | Patch a Non-Employee Source +[**Deny-V2024NonEmployeeRequest**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request +[**Update-V2024NonEmployeeRecord**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update Non-Employee Record + +## approve-non-employee-request +Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-Employee approval item id (UUID) + Body | NonEmployeeApprovalDecision | [**NonEmployeeApprovalDecision**](../models/non-employee-approval-decision) | True | + +### Return type +[**NonEmployeeApprovalItem**](../models/non-employee-approval-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee approval item object. | NonEmployeeApprovalItem +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) +$NonEmployeeApprovalDecision = @"{ + "comment" : "Approved by manager" +}"@ + +# Approve a Non-Employee Request + +try { + $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision + Approve-V2024NonEmployeeRequest-V2024Id $Id -V2024NonEmployeeApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Approve-V2024NonEmployeeRequest -V2024Id $Id -V2024NonEmployeeApprovalDecision $NonEmployeeApprovalDecision +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-non-employee-record +This request will create a non-employee record. +Requires role context of `idn:nesr:create` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | NonEmployeeRequestBody | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | True | Non-Employee record creation request body. + +### Return type +[**NonEmployeeRecord**](../models/non-employee-record) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Created non-employee record. | NonEmployeeRecord +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$NonEmployeeRequestBody = @"{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" +}"@ + +# Create Non-Employee Record + +try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-V2024NonEmployeeRecord-V2024NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-V2024NonEmployeeRecord -V2024NonEmployeeRequestBody $NonEmployeeRequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-non-employee-request +This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | NonEmployeeRequestBody | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | True | Non-Employee creation request body + +### Return type +[**NonEmployeeRequest**](../models/non-employee-request) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee request creation object | NonEmployeeRequest +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$NonEmployeeRequestBody = @"{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" +}"@ + +# Create Non-Employee Request + +try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-V2024NonEmployeeRequest-V2024NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-V2024NonEmployeeRequest -V2024NonEmployeeRequestBody $NonEmployeeRequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-non-employee-source +This request will create a non-employee source. Requires role context of `idn:nesr:create` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | NonEmployeeSourceRequestBody | [**NonEmployeeSourceRequestBody**](../models/non-employee-source-request-body) | True | Non-Employee source creation request body. + +### Return type +[**NonEmployeeSourceWithCloudExternalId**](../models/non-employee-source-with-cloud-external-id) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Created non-employee source. | NonEmployeeSourceWithCloudExternalId +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$NonEmployeeSourceRequestBody = @"{ + "owner" : { + "id" : "2c91808570313110017040b06f344ec9" + }, + "managementWorkgroup" : "123299", + "accountManagers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ], + "name" : "Retail", + "description" : "Source description", + "approvers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ] +}"@ + +# Create Non-Employee Source + +try { + $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody + New-V2024NonEmployeeSource-V2024NonEmployeeSourceRequestBody $Result + + # Below is a request that includes all optional parameters + # New-V2024NonEmployeeSource -V2024NonEmployeeSourceRequestBody $NonEmployeeSourceRequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSource" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-non-employee-source-schema-attributes +This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response. +Requires role context of `idn:nesr:create` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id + Body | NonEmployeeSchemaAttributeBody | [**NonEmployeeSchemaAttributeBody**](../models/non-employee-schema-attribute-body) | True | + +### Return type +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Schema Attribute created. | NonEmployeeSchemaAttribute +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id +$NonEmployeeSchemaAttributeBody = @"{ + "helpText" : "The unique identifier for the account", + "label" : "Account Name", + "placeholder" : "Enter a unique user name for this account.", + "type" : "TEXT", + "technicalName" : "account.name", + "required" : true +}"@ + +# Create a new Schema Attribute for Non-Employee Source + +try { + $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody + New-V2024NonEmployeeSourceSchemaAttributes-V2024SourceId $SourceId -V2024NonEmployeeSchemaAttributeBody $Result + + # Below is a request that includes all optional parameters + # New-V2024NonEmployeeSourceSchemaAttributes -V2024SourceId $SourceId -V2024NonEmployeeSchemaAttributeBody $NonEmployeeSchemaAttributeBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-non-employee-record +This request will delete a non-employee record. +Requires role context of `idn:nesr:delete` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-Employee record id (UUID) + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) + +# Delete Non-Employee Record + +try { + Remove-V2024NonEmployeeRecord-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeRecord -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-non-employee-records-in-bulk +This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | DeleteNonEmployeeRecordsInBulkRequest | [**DeleteNonEmployeeRecordsInBulkRequest**](../models/delete-non-employee-records-in-bulk-request) | True | Non-Employee bulk delete request body. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$DeleteNonEmployeeRecordsInBulkRequest = @""@ + +# Delete Multiple Non-Employee Records + +try { + $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest + Remove-V2024NonEmployeeRecordsInBulk-V2024DeleteNonEmployeeRecordsInBulkRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeRecordsInBulk -V2024DeleteNonEmployeeRecordsInBulkRequest $DeleteNonEmployeeRecordsInBulkRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-non-employee-request +This request will delete a non-employee request. +Requires role context of `idn:nesr:delete` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-Employee request id in the UUID format + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format + +# Delete Non-Employee Request + +try { + Remove-V2024NonEmployeeRequest-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeRequest -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-non-employee-schema-attribute +This end-point deletes a specific schema attribute for a non-employee source. +Requires role context of `idn:nesr:delete` + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | AttributeId | **String** | True | The Schema Attribute Id (UUID) +Path | SourceId | **String** | True | The Source id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) +$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + +# Delete a Schema Attribute for Non-Employee Source + +try { + Remove-V2024NonEmployeeSchemaAttribute-V2024AttributeId $AttributeId -V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeSchemaAttribute -V2024AttributeId $AttributeId -V2024SourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-non-employee-source +This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | Source Id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id + +# Delete Non-Employee Source + +try { + Remove-V2024NonEmployeeSource-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeSource -V2024SourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSource" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-non-employee-source-schema-attributes +This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + +# Delete all custom schema attributes for Non-Employee Source + +try { + Remove-V2024NonEmployeeSourceSchemaAttributes-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeSourceSchemaAttributes -V2024SourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## export-non-employee-records +This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source Id (UUID) + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Exported CSV | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: text/csv, application/json + +### Example +```powershell +$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) + +# Exports Non-Employee Records to CSV + +try { + Export-V2024NonEmployeeRecords-V2024Id $Id + + # Below is a request that includes all optional parameters + # Export-V2024NonEmployeeRecords -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024NonEmployeeRecords" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## export-non-employee-source-schema-template +This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source Id (UUID) + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Exported Source Schema Template | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: text/csv, application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID) + +# Exports Source Schema Template + +try { + Export-V2024NonEmployeeSourceSchemaTemplate-V2024Id $Id + + # Below is a request that includes all optional parameters + # Export-V2024NonEmployeeSourceSchemaTemplate -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024NonEmployeeSourceSchemaTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-approval +Gets a non-employee approval item detail. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in which case they +can get any approval. + 2. The user owns the requested approval. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-Employee approval item id (UUID) + Query | IncludeDetail | **Boolean** | (optional) | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* + +### Return type +[**NonEmployeeApprovalItemDetail**](../models/non-employee-approval-item-detail) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee approval item object. | NonEmployeeApprovalItemDetail +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) +$IncludeDetail = $true # Boolean | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) + +# Get a non-employee approval item detail + +try { + Get-V2024NonEmployeeApproval-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeApproval -V2024Id $Id -V2024IncludeDetail $IncludeDetail +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApproval" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-approval-summary +This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id. + 2. The current user is an approver, in which case "me" should be provided +as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | RequestedFor | **String** | True | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + +### Return type +[**NonEmployeeApprovalSummary**](../models/non-employee-approval-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | summary of non-employee approval requests | NonEmployeeApprovalSummary +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + +# Get Summary of Non-Employee Approval Requests + +try { + Get-V2024NonEmployeeApprovalSummary-V2024RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeApprovalSummary -V2024RequestedFor $RequestedFor +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApprovalSummary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-bulk-upload-status +The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. +Requires role context of `idn:nesr:read` + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source ID (UUID) + +### Return type +[**NonEmployeeBulkUploadStatus**](../models/non-employee-bulk-upload-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Status of the newest bulk-upload job, if any. | NonEmployeeBulkUploadStatus +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source ID (UUID) + +# Obtain the status of bulk upload on the source + +try { + Get-V2024NonEmployeeBulkUploadStatus-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeBulkUploadStatus -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeBulkUploadStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-record +This gets a non-employee record. +Requires role context of `idn:nesr:read` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-Employee record id (UUID) + +### Return type +[**NonEmployeeRecord**](../models/non-employee-record) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee record object | NonEmployeeRecord +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) + +# Get a Non-Employee Record + +try { + Get-V2024NonEmployeeRecord-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRecord -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-request +This gets a non-employee request. +There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in this case the user +can get the non-employee request for any user. + 2. The user must be the owner of the non-employee request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-Employee request id (UUID) + +### Return type +[**NonEmployeeRequest**](../models/non-employee-request) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee request object. | NonEmployeeRequest +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID) + +# Get a Non-Employee Request + +try { + Get-V2024NonEmployeeRequest-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRequest -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-request-summary +This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id. + 2. The current user is an account manager, in which case "me" should be +provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | RequestedFor | **String** | True | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + +### Return type +[**NonEmployeeRequestSummary**](../models/non-employee-request-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee request summary object. | NonEmployeeRequestSummary +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + +# Get Summary of Non-Employee Requests + +try { + Get-V2024NonEmployeeRequestSummary-V2024RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRequestSummary -V2024RequestedFor $RequestedFor +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequestSummary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-schema-attribute +This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | AttributeId | **String** | True | The Schema Attribute Id (UUID) +Path | SourceId | **String** | True | The Source id + +### Return type +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Schema Attribute | NonEmployeeSchemaAttribute +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) +$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + +# Get Schema Attribute Non-Employee Source + +try { + Get-V2024NonEmployeeSchemaAttribute-V2024AttributeId $AttributeId -V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeSchemaAttribute -V2024AttributeId $AttributeId -V2024SourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-source +This gets a non-employee source. There are two contextual uses for the requested-for path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request any source. + 2. The current user is an account manager, in which case the user can only +request sources that they own. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | Source Id + +### Return type +[**NonEmployeeSource**](../models/non-employee-source) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee source object. | NonEmployeeSource +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id + +# Get a Non-Employee Source + +try { + Get-V2024NonEmployeeSource-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeSource -V2024SourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSource" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-source-schema-attributes +This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. +Requires role context of `idn:nesr:read` or the user must be an account manager of the source. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id + +### Return type +[**NonEmployeeSchemaAttribute[]**](../models/non-employee-schema-attribute) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of Schema Attributes | NonEmployeeSchemaAttribute[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + +# List Schema Attributes Non-Employee Source + +try { + Get-V2024NonEmployeeSourceSchemaAttributes-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeSourceSchemaAttributes -V2024SourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-non-employee-records-in-bulk +This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source Id (UUID) + | Data | **System.IO.FileInfo** | True | + +### Return type +[**NonEmployeeBulkUploadJob**](../models/non-employee-bulk-upload-job) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | The CSV was accepted to be bulk inserted now or at a later time. | NonEmployeeBulkUploadJob +400 | Client Error - Returned if the request body is invalid. The response body will contain the list of specific errors with one on each line. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) +$Data = # System.IO.FileInfo | + +# Imports, or Updates, Non-Employee Records + +try { + Import-V2024NonEmployeeRecordsInBulk-V2024Id $Id -V2024Data $Data + + # Below is a request that includes all optional parameters + # Import-V2024NonEmployeeRecordsInBulk -V2024Id $Id -V2024Data $Data +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024NonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-non-employee-approvals +This gets a list of non-employee approval requests. +There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in which case they +can list the approvals for any approver. + 2. The user owns the requested approval. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | RequestedFor | **String** | (optional) | The identity for whom the request was made. *me* indicates the current user. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** + +### Return type +[**NonEmployeeApprovalItem[]**](../models/non-employee-approval-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of approval items. | NonEmployeeApprovalItem[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity for whom the request was made. *me* indicates the current user. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'approvalStatus eq "Pending"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) +$Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + +# Get List of Non-Employee Approval Requests + +try { + Get-V2024NonEmployeeApprovals + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeApprovals -V2024RequestedFor $RequestedFor -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApprovals" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-non-employee-records +This gets a list of non-employee records. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. + 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* + +### Return type +[**NonEmployeeRecord[]**](../models/non-employee-record) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee record objects | NonEmployeeRecord[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "accountName,sourceId" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) +$Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + +# List Non-Employee Records + +try { + Get-V2024NonEmployeeRecords + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRecords -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRecords" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-non-employee-requests +This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request a list non-employee requests assigned to a particular account manager by passing in that manager's id. + 2. The current user is an account manager, in which case "me" should be +provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | RequestedFor | **String** | True | The identity for whom the request was made. *me* indicates the current user. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* + +### Return type +[**NonEmployeeRequest[]**](../models/non-employee-request) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of non-employee request objects. | NonEmployeeRequest[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RequestedFor = "e136567de87e4d029e60b3c3c55db56d" # String | The identity for whom the request was made. *me* indicates the current user. +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "created,approvalStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) +$Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + +# List Non-Employee Requests + +try { + Get-V2024NonEmployeeRequests-V2024RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRequests -V2024RequestedFor $RequestedFor -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequests" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-non-employee-sources +This gets a list of non-employee sources. There are two contextual uses for the requested-for path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request a list sources assigned to a particular account manager by passing in that manager's id. + 2. The current user is an account manager, in which case "me" should be +provided as the `requested-for` value. This will provide the user with a list of the sources that he or she owns. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | RequestedFor | **String** | True | The identity for whom the request was made. *me* indicates the current user. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | NonEmployeeCount | **Boolean** | (optional) | The flag to determine whether return a non-employee count associate with source. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** + +### Return type +[**NonEmployeeSourceWithNECount[]**](../models/non-employee-source-with-ne-count) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of non-employee sources objects. | NonEmployeeSourceWithNECount[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$NonEmployeeCount = $true # Boolean | The flag to determine whether return a non-employee count associate with source. (optional) +$Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) + +# List Non-Employee Sources + +try { + Get-V2024NonEmployeeSources-V2024RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeSources -V2024RequestedFor $RequestedFor -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024NonEmployeeCount $NonEmployeeCount -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSources" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-non-employee-record +This request will patch a non-employee record. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:update`, in which case they +update all available fields. + 2. The user is owner of the source, in this case they can only update the +end date. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-employee record id (UUID) + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + +### Return type +[**NonEmployeeRecord**](../models/non-employee-record) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A patched non-employee record. | NonEmployeeRecord +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + + +# Patch Non-Employee Record + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024NonEmployeeRecord-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024NonEmployeeRecord -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-non-employee-schema-attribute +This end-point patches a specific schema attribute for a non-employee SourceId. +Requires role context of `idn:nesr:update` + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | AttributeId | **String** | True | The Schema Attribute Id (UUID) +Path | SourceId | **String** | True | The Source id + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. + +### Return type +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Schema Attribute was successfully patched. | NonEmployeeSchemaAttribute +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) +$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. + + +# Patch a Schema Attribute for Non-Employee Source + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024NonEmployeeSchemaAttribute-V2024AttributeId $AttributeId -V2024SourceId $SourceId -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024NonEmployeeSchemaAttribute -V2024AttributeId $AttributeId -V2024SourceId $SourceId -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-non-employee-source +patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | Source Id + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**NonEmployeeSource**](../models/non-employee-source) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A patched non-employee source object. | NonEmployeeSource +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +# Patch a Non-Employee Source + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024NonEmployeeSource-V2024SourceId $SourceId -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024NonEmployeeSource -V2024SourceId $SourceId -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeSource" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## reject-non-employee-request +This endpoint will reject an approval item request and notify user. The current user must be the requested approver. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-Employee approval item id (UUID) + Body | NonEmployeeRejectApprovalDecision | [**NonEmployeeRejectApprovalDecision**](../models/non-employee-reject-approval-decision) | True | + +### Return type +[**NonEmployeeApprovalItem**](../models/non-employee-approval-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee approval item object. | NonEmployeeApprovalItem +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) +$NonEmployeeRejectApprovalDecision = @"{ + "comment" : "approved" +}"@ + +# Reject a Non-Employee Request + +try { + $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision + Deny-V2024NonEmployeeRequest-V2024Id $Id -V2024NonEmployeeRejectApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Deny-V2024NonEmployeeRequest -V2024Id $Id -V2024NonEmployeeRejectApprovalDecision $NonEmployeeRejectApprovalDecision +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-non-employee-record +This request will update a non-employee record. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:update`, in which case they +update all available fields. + 2. The user is owner of the source, in this case they can only update the +end date. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-employee record id (UUID) + Body | NonEmployeeRequestBody | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | True | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + +### Return type +[**NonEmployeeRecord**](../models/non-employee-record) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An updated non-employee record. | NonEmployeeRecord +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) +$NonEmployeeRequestBody = @"{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" +}"@ + +# Update Non-Employee Record + +try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + Update-V2024NonEmployeeRecord-V2024Id $Id -V2024NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024NonEmployeeRecord -V2024Id $Id -V2024NonEmployeeRequestBody $NonEmployeeRequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024NotificationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024NotificationsApi.md new file mode 100644 index 000000000..5c0de451c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024NotificationsApi.md @@ -0,0 +1,754 @@ + +--- +id: v2024-notifications +title: Notifications +pagination_label: Notifications +sidebar_label: Notifications +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Notifications', 'V2024Notifications'] +slug: /tools/sdk/powershell/v2024/methods/notifications +tags: ['SDK', 'Software Development Kit', 'Notifications', 'V2024Notifications'] +--- + +# Notifications + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024DomainDkim**](#create-domain-dkim) | **POST** `/verified-domains` | Verify domain address via DKIM +[**New-V2024NotificationTemplate**](#create-notification-template) | **POST** `/notification-templates` | Create Notification Template +[**New-V2024VerifiedFromAddress**](#create-verified-from-address) | **POST** `/verified-from-addresses` | Create Verified From Address +[**Remove-V2024NotificationTemplatesInBulk**](#delete-notification-templates-in-bulk) | **POST** `/notification-templates/bulk-delete` | Bulk Delete Notification Templates +[**Remove-V2024VerifiedFromAddress**](#delete-verified-from-address) | **DELETE** `/verified-from-addresses/{id}` | Delete Verified From Address +[**Get-V2024DkimAttributes**](#get-dkim-attributes) | **GET** `/verified-domains` | Get DKIM Attributes +[**Get-V2024MailFromAttributes**](#get-mail-from-attributes) | **GET** `/mail-from-attributes/{identity}` | Get MAIL FROM Attributes +[**Get-V2024NotificationTemplate**](#get-notification-template) | **GET** `/notification-templates/{id}` | Get Notification Template By Id +[**Get-V2024NotificationsTemplateContext**](#get-notifications-template-context) | **GET** `/notification-template-context` | Get Notification Template Context +[**Get-V2024FromAddresses**](#list-from-addresses) | **GET** `/verified-from-addresses` | List From Addresses +[**Get-V2024NotificationPreferences**](#list-notification-preferences) | **GET** `/notification-preferences/{key}` | List Notification Preferences for tenant. +[**Get-V2024NotificationTemplateDefaults**](#list-notification-template-defaults) | **GET** `/notification-template-defaults` | List Notification Template Defaults +[**Get-V2024NotificationTemplates**](#list-notification-templates) | **GET** `/notification-templates` | List Notification Templates +[**Send-V2024MailFromAttributes**](#put-mail-from-attributes) | **PUT** `/mail-from-attributes` | Change MAIL FROM domain +[**Send-V2024TestNotification**](#send-test-notification) | **POST** `/send-test-notification` | Send Test Notification + +## create-domain-dkim +Create a domain to be verified via DKIM (DomainKeys Identified Mail) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | DomainAddress | [**DomainAddress**](../models/domain-address) | True | + +### Return type +[**DomainStatusDto**](../models/domain-status-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of DKIM tokens required for the verification process. | DomainStatusDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +405 | Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method. | CreateDomainDkim405Response +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$DomainAddress = @"{ + "domain" : "sailpoint.com" +}"@ + +# Verify domain address via DKIM + +try { + $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress + New-V2024DomainDkim-V2024XSailPointExperimental $XSailPointExperimental -V2024DomainAddress $Result + + # Below is a request that includes all optional parameters + # New-V2024DomainDkim -V2024XSailPointExperimental $XSailPointExperimental -V2024DomainAddress $DomainAddress +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DomainDkim" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-notification-template +This creates a template for your site. + +You can also use this endpoint to update a template. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | TemplateDto | [**TemplateDto**](../models/template-dto) | True | + +### Return type +[**TemplateDto**](../models/template-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A template object for your site | TemplateDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$TemplateDto = @"{ + "slackTemplate" : "slackTemplate", + "footer" : "footer", + "teamsTemplate" : "teamsTemplate", + "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", + "created" : "2020-01-01T00:00:00Z", + "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", + "medium" : "EMAIL", + "locale" : "en", + "body" : "Please go to the task manager", + "name" : "Task Manager Subscription", + "replyTo" : "$__global.emailFromAddress", + "header" : "header", + "modified" : "2020-01-01T00:00:00Z", + "from" : "$__global.emailFromAddress", + "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", + "key" : "cloud_manual_work_item_summary" +}"@ + +# Create Notification Template + +try { + $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto + New-V2024NotificationTemplate-V2024XSailPointExperimental $XSailPointExperimental -V2024TemplateDto $Result + + # Below is a request that includes all optional parameters + # New-V2024NotificationTemplate -V2024XSailPointExperimental $XSailPointExperimental -V2024TemplateDto $TemplateDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NotificationTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-verified-from-address +Create a new sender email address and initiate verification process. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | EmailStatusDto | [**EmailStatusDto**](../models/email-status-dto) | True | + +### Return type +[**EmailStatusDto**](../models/email-status-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | New Verified Email Status | EmailStatusDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$EmailStatusDto = @"{ + "isVerifiedByDomain" : false, + "verificationStatus" : "PENDING", + "id" : "id", + "email" : "sender@example.com" +}"@ + +# Create Verified From Address + +try { + $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto + New-V2024VerifiedFromAddress-V2024XSailPointExperimental $XSailPointExperimental -V2024EmailStatusDto $Result + + # Below is a request that includes all optional parameters + # New-V2024VerifiedFromAddress -V2024XSailPointExperimental $XSailPointExperimental -V2024EmailStatusDto $EmailStatusDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VerifiedFromAddress" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-notification-templates-in-bulk +This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, please contact support to enable usage. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | TemplateBulkDeleteDto | [**[]TemplateBulkDeleteDto**](../models/template-bulk-delete-dto) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TemplateBulkDeleteDto = @"{ + "medium" : "EMAIL", + "locale" : "en", + "key" : "cloud_manual_work_item_summary" +}"@ # TemplateBulkDeleteDto[] | + + +# Bulk Delete Notification Templates + +try { + $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto + Remove-V2024NotificationTemplatesInBulk-V2024XSailPointExperimental $XSailPointExperimental -V2024TemplateBulkDeleteDto $Result + + # Below is a request that includes all optional parameters + # Remove-V2024NotificationTemplatesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024TemplateBulkDeleteDto $TemplateBulkDeleteDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NotificationTemplatesInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-verified-from-address +Delete a verified sender email address + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "MyId" # String | +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Delete Verified From Address + +try { + Remove-V2024VerifiedFromAddress-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024VerifiedFromAddress -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024VerifiedFromAddress" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-dkim-attributes +Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants' AWS SES identities. Limits retrieval to 100 identities per call. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**DkimAttributes[]**](../models/dkim-attributes) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of DKIM Attributes | DkimAttributes[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get DKIM Attributes + +try { + Get-V2024DkimAttributes-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024DkimAttributes -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DkimAttributes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-mail-from-attributes +Retrieve MAIL FROM attributes for a given AWS SES identity. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Id | **String** | True | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**MailFromAttributes**](../models/mail-from-attributes) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | MAIL FROM Attributes object | MailFromAttributes +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get MAIL FROM Attributes + +try { + Get-V2024MailFromAttributes-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024MailFromAttributes -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MailFromAttributes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-notification-template +This gets a template that you have modified for your site by Id. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the Notification Template + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**TemplateDto[]**](../models/template-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A template object for your site | TemplateDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get Notification Template By Id + +try { + Get-V2024NotificationTemplate-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NotificationTemplate -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-notifications-template-context +The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called "Global Context" (a.k.a. notification template context). It defines a set of attributes + that will be available per tenant (organization). + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**NotificationTemplateContext**](../models/notification-template-context) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Notification template context attributes for a specific tenant. | NotificationTemplateContext +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get Notification Template Context + +try { + Get-V2024NotificationsTemplateContext-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NotificationsTemplateContext -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationsTemplateContext" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-from-addresses +Retrieve a list of sender email addresses and their verification statuses + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** + +### Return type +[**EmailStatusDto[]**](../models/email-status-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Email Status | EmailStatusDto[] +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'email eq "john.doe@company.com"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* (optional) +$Sorters = "email" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) + +# List From Addresses + +try { + Get-V2024FromAddresses-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024FromAddresses -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FromAddresses" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-notification-preferences +Returns a list of notification preferences for tenant. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**PreferencesDto[]**](../models/preferences-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Return preference for the given notification key. | PreferencesDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# List Notification Preferences for tenant. + +try { + Get-V2024NotificationPreferences-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NotificationPreferences -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationPreferences" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-notification-template-defaults +This lists the default templates used for notifications, such as emails from IdentityNow. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* + +### Return type +[**TemplateDtoDefault[]**](../models/template-dto-default) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of the default template objects | TemplateDtoDefault[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Filters = 'key eq "cloud_manual_work_item_summary"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + +# List Notification Template Defaults + +try { + Get-V2024NotificationTemplateDefaults-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NotificationTemplateDefaults -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplateDefaults" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-notification-templates +This lists the templates that you have modified for your site. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* + +### Return type +[**TemplateDto[]**](../models/template-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of template objects for your site | TemplateDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Filters = 'medium eq "EMAIL"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + +# List Notification Templates + +try { + Get-V2024NotificationTemplates-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NotificationTemplates -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplates" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-mail-from-attributes +Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller's DNS + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | MailFromAttributesDto | [**MailFromAttributesDto**](../models/mail-from-attributes-dto) | True | + +### Return type +[**MailFromAttributes**](../models/mail-from-attributes) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | MAIL FROM Attributes required to verify the change | MailFromAttributes +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$MailFromAttributesDto = @"{ + "identity" : "BobSmith@sailpoint.com", + "mailFromDomain" : "example.sailpoint.com" +}"@ + +# Change MAIL FROM domain + +try { + $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto + Send-V2024MailFromAttributes-V2024XSailPointExperimental $XSailPointExperimental -V2024MailFromAttributesDto $Result + + # Below is a request that includes all optional parameters + # Send-V2024MailFromAttributes -V2024XSailPointExperimental $XSailPointExperimental -V2024MailFromAttributesDto $MailFromAttributesDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024MailFromAttributes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## send-test-notification +Send a Test Notification + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | SendTestNotificationRequestDto | [**SendTestNotificationRequestDto**](../models/send-test-notification-request-dto) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$SendTestNotificationRequestDto = @"{ + "context" : "{}", + "medium" : "EMAIL", + "key" : "cloud_manual_work_item_summary" +}"@ + +# Send Test Notification + +try { + $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto + Send-V2024TestNotification-V2024XSailPointExperimental $XSailPointExperimental -V2024SendTestNotificationRequestDto $Result + + # Below is a request that includes all optional parameters + # Send-V2024TestNotification -V2024XSailPointExperimental $XSailPointExperimental -V2024SendTestNotificationRequestDto $SendTestNotificationRequestDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TestNotification" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024OAuthClientsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024OAuthClientsApi.md new file mode 100644 index 000000000..a47a4848d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024OAuthClientsApi.md @@ -0,0 +1,267 @@ + +--- +id: v2024-o-auth-clients +title: OAuthClients +pagination_label: OAuthClients +sidebar_label: OAuthClients +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OAuthClients', 'V2024OAuthClients'] +slug: /tools/sdk/powershell/v2024/methods/o-auth-clients +tags: ['SDK', 'Software Development Kit', 'OAuthClients', 'V2024OAuthClients'] +--- + +# OAuthClients + Use this API to implement OAuth client functionality. +With this functionality in place, users with the appropriate security scopes can create and configure OAuth clients to use as a way to obtain authorization to use the Identity Security Cloud REST API. +Refer to [Authentication](https://developer.sailpoint.com/docs/api/authentication/) for more information about OAuth and how it works with the Identity Security Cloud REST API. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024OauthClient**](#create-oauth-client) | **POST** `/oauth-clients` | Create OAuth Client +[**Remove-V2024OauthClient**](#delete-oauth-client) | **DELETE** `/oauth-clients/{id}` | Delete OAuth Client +[**Get-V2024OauthClient**](#get-oauth-client) | **GET** `/oauth-clients/{id}` | Get OAuth Client +[**Get-V2024OauthClients**](#list-oauth-clients) | **GET** `/oauth-clients` | List OAuth Clients +[**Update-V2024OauthClient**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch OAuth Client + +## create-oauth-client +This creates an OAuth client. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CreateOAuthClientRequest | [**CreateOAuthClientRequest**](../models/create-o-auth-client-request) | True | + +### Return type +[**CreateOAuthClientResponse**](../models/create-o-auth-client-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Request succeeded. | CreateOAuthClientResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CreateOAuthClientRequest = @"{ + "internal" : false, + "businessName" : "Acme-Solar", + "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", + "refreshTokenValiditySeconds" : 86400, + "type" : "CONFIDENTIAL", + "redirectUris" : [ "http://localhost:12345" ], + "enabled" : true, + "accessType" : "OFFLINE", + "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], + "strongAuthSupported" : false, + "homepageUrl" : "http://localhost:12345", + "accessTokenValiditySeconds" : 750, + "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], + "name" : "Demo API Client", + "claimsSupported" : false +}"@ + +# Create OAuth Client + +try { + $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest + New-V2024OauthClient-V2024CreateOAuthClientRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024OauthClient -V2024CreateOAuthClientRequest $CreateOAuthClientRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024OauthClient" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-oauth-client +This deletes an OAuth client. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The OAuth client id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + +# Delete OAuth Client + +try { + Remove-V2024OauthClient-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024OauthClient -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024OauthClient" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-oauth-client +This gets details of an OAuth client. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The OAuth client id + +### Return type +[**GetOAuthClientResponse**](../models/get-o-auth-client-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Request succeeded. | GetOAuthClientResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + +# Get OAuth Client + +try { + Get-V2024OauthClient-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024OauthClient -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OauthClient" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-oauth-clients +This gets a list of OAuth clients. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* + +### Return type +[**GetOAuthClientResponse[]**](../models/get-o-auth-client-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of OAuth clients. | GetOAuthClientResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + +# List OAuth Clients + +try { + Get-V2024OauthClients + + # Below is a request that includes all optional parameters + # Get-V2024OauthClients -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OauthClients" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-oauth-client +This performs a targeted update to the field(s) of an OAuth client. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The OAuth client id + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported + +### Return type +[**GetOAuthClientResponse**](../models/get-o-auth-client-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Indicates the PATCH operation succeeded, and returns the OAuth client's new representation. | GetOAuthClientResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported + + +# Patch OAuth Client + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024OauthClient-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024OauthClient -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024OauthClient" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024OrgConfigApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024OrgConfigApi.md new file mode 100644 index 000000000..566764cbe --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024OrgConfigApi.md @@ -0,0 +1,168 @@ + +--- +id: v2024-org-config +title: OrgConfig +pagination_label: OrgConfig +sidebar_label: OrgConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OrgConfig', 'V2024OrgConfig'] +slug: /tools/sdk/powershell/v2024/methods/org-config +tags: ['SDK', 'Software Development Kit', 'OrgConfig', 'V2024OrgConfig'] +--- + +# OrgConfig + Use this API to implement organization configuration functionality. +Administrators can use this functionality to manage organization settings, such as time zones. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024OrgConfig**](#get-org-config) | **GET** `/org-config` | Get Org Config Settings +[**Get-V2024ValidTimeZones**](#get-valid-time-zones) | **GET** `/org-config/valid-time-zones` | Get Valid Time Zones +[**Update-V2024OrgConfig**](#patch-org-config) | **PATCH** `/org-config` | Patch Org Config + +## get-org-config +Get the current organization's configuration settings, only external accessible properties. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**OrgConfig**](../models/org-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Request succeeded. | OrgConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get Org Config Settings + +try { + Get-V2024OrgConfig-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024OrgConfig -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OrgConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-valid-time-zones +List the valid time zones that can be set in organization configurations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +**String[]** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Request successful. | String[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Get Valid Time Zones + +try { + Get-V2024ValidTimeZones-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ValidTimeZones -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ValidTimeZones" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-org-config +Patch the current organization's configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization's time zone. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**OrgConfig**](../models/org-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully patched org config. | OrgConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +# Patch Org Config + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024OrgConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024OrgConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024OrgConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024PasswordConfigurationApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024PasswordConfigurationApi.md new file mode 100644 index 000000000..c6ae7c492 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024PasswordConfigurationApi.md @@ -0,0 +1,170 @@ + +--- +id: v2024-password-configuration +title: PasswordConfiguration +pagination_label: PasswordConfiguration +sidebar_label: PasswordConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordConfiguration', 'V2024PasswordConfiguration'] +slug: /tools/sdk/powershell/v2024/methods/password-configuration +tags: ['SDK', 'Software Development Kit', 'PasswordConfiguration', 'V2024PasswordConfiguration'] +--- + +# PasswordConfiguration + Use this API to implement organization password configuration functionality. +With this functionality in place, organization administrators can create organization-specific password configurations. + +These configurations include details like custom password instructions, as well as digit token length and duration. + +Refer to [Configuring User Authentication for Password Resets](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html) for more information about organization password configuration functionality. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024PasswordOrgConfig**](#create-password-org-config) | **POST** `/password-org-config` | Create Password Org Config +[**Get-V2024PasswordOrgConfig**](#get-password-org-config) | **GET** `/password-org-config` | Get Password Org Config +[**Send-V2024PasswordOrgConfig**](#put-password-org-config) | **PUT** `/password-org-config` | Update Password Org Config + +## create-password-org-config +This API creates the password org config. Unspecified fields will use default value. +To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true". +Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | PasswordOrgConfig | [**PasswordOrgConfig**](../models/password-org-config) | True | + +### Return type +[**PasswordOrgConfig**](../models/password-org-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password org config. | PasswordOrgConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$PasswordOrgConfig = @"{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true +}"@ + +# Create Password Org Config + +try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + New-V2024PasswordOrgConfig-V2024PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # New-V2024PasswordOrgConfig -V2024PasswordOrgConfig $PasswordOrgConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordOrgConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-password-org-config +This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**PasswordOrgConfig**](../models/password-org-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password org config. | PasswordOrgConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Password Org Config + +try { + Get-V2024PasswordOrgConfig + + # Below is a request that includes all optional parameters + # Get-V2024PasswordOrgConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordOrgConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-password-org-config +This API updates the password org config for specified fields. Other fields will keep original value. +You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions. +Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | PasswordOrgConfig | [**PasswordOrgConfig**](../models/password-org-config) | True | + +### Return type +[**PasswordOrgConfig**](../models/password-org-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password org config. | PasswordOrgConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$PasswordOrgConfig = @"{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true +}"@ + +# Update Password Org Config + +try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + Send-V2024PasswordOrgConfig-V2024PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024PasswordOrgConfig -V2024PasswordOrgConfig $PasswordOrgConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PasswordOrgConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024PasswordDictionaryApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024PasswordDictionaryApi.md new file mode 100644 index 000000000..f204e2cc9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024PasswordDictionaryApi.md @@ -0,0 +1,211 @@ + +--- +id: v2024-password-dictionary +title: PasswordDictionary +pagination_label: PasswordDictionary +sidebar_label: PasswordDictionary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordDictionary', 'V2024PasswordDictionary'] +slug: /tools/sdk/powershell/v2024/methods/password-dictionary +tags: ['SDK', 'Software Development Kit', 'PasswordDictionary', 'V2024PasswordDictionary'] +--- + +# PasswordDictionary + Use this API to implement password dictionary functionality. +With this functionality in place, administrators can create password dictionaries to prevent users from using certain words or characters in their passwords. + +A password dictionary is a list of words or characters that users are prevented from including in their passwords. +This can help protect users from themselves and force them to create passwords that are not easy to break. + +A password dictionary must meet the following requirements to for the API to handle them correctly: + +- It must be in .txt format. + +- All characters must be UTF-8 characters. + +- Each line must contain a single word or character with no spaces or whitespace characters. + +- It must contain at least one line other than the locale string. + +- Each line must not exceed 128 characters. + +- The file must not exceed 2500 lines. + +Administrators should also consider the following when they create their dictionaries: + +- Lines starting with a # represent comments. + +- All words in the password dictionary are case-insensitive. +For example, adding the word "password" to the dictionary also disallows the following: PASSWORD, Password, and PassWord. + +- The dictionary uses substring matching. +For example, adding the word "spring" to the dictionary also disallows the following: Spring124, 345SprinG, and 8spring. +Users can then select 'Change Password' to update their passwords. + +Administrators must do the following to create a password dictionary: + +- Create the text file that will contain the prohibited password values. + +- If the dictionary is not in English, they must add a locale string to the top line: locale:`languageCode`_`countryCode` + +The languageCode value refers to the language's 2-letter ISO 639-1 code. +The countryCode value refers to the country's 2-letter ISO 3166-1 code. + +Refer to this list https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html to see all the available ISO 639-1 language codes and ISO 3166-1 country codes. + +- Upload the .txt file to Identity Security Cloud with [Update Password Dictionary](https://developer.sailpoint.com/docs/api/v3/put-password-dictionary). Uploading a new file always overwrites the previous dictionary file. + +Administrators can then specify which password policies check new passwords against the password dictionary by doing the following: In the Admin panel, they can use the Password Mgmt dropdown menu to select Policies, select the policy, and select the 'Prevent use of words in this site's password dictionary' checkbox beside it. + +Refer to [Configuring Advanced Password Management Options](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html) for more information about password dictionaries. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024PasswordDictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get Password Dictionary +[**Send-V2024PasswordDictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update Password Dictionary + +## get-password-dictionary +This gets password dictionary for the organization. +The password dictionary file can contain lines that are: +1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing +2. empty lines +3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines +4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + +Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + +# Sample password text file + +``` + +# Password dictionary small test file + +locale=en_US + +# Password dictionary prohibited words + +qwerty +abcd +aaaaa +password +qazxsws + +``` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +**String** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A password dictionary response | String +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: text/plain, application/json + +### Example +```powershell + +# Get Password Dictionary + +try { + Get-V2024PasswordDictionary + + # Below is a request that includes all optional parameters + # Get-V2024PasswordDictionary +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordDictionary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-password-dictionary +This updates password dictionary for the organization. +The password dictionary file can contain lines that are: +1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing +2. empty lines +3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines +4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + +Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + +# Sample password text file + +``` + +# Password dictionary small test file + +locale=en_US + +# Password dictionary prohibited words + +qwerty +abcd +aaaaa +password +qazxsws + +``` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | File | **System.IO.FileInfo** | (optional) | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully updated. | +201 | Created. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$File = # System.IO.FileInfo | (optional) + +# Update Password Dictionary + +try { + Send-V2024PasswordDictionary + + # Below is a request that includes all optional parameters + # Send-V2024PasswordDictionary -V2024File $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PasswordDictionary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024PasswordManagementApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024PasswordManagementApi.md new file mode 100644 index 000000000..d0a3011f1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024PasswordManagementApi.md @@ -0,0 +1,256 @@ + +--- +id: v2024-password-management +title: PasswordManagement +pagination_label: PasswordManagement +sidebar_label: PasswordManagement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordManagement', 'V2024PasswordManagement'] +slug: /tools/sdk/powershell/v2024/methods/password-management +tags: ['SDK', 'Software Development Kit', 'PasswordManagement', 'V2024PasswordManagement'] +--- + +# PasswordManagement + Use this API to implement password management functionality. +With this functionality in place, users can manage their identity passwords for all their applications. + +In Identity Security Cloud, users can select their names in the upper right corner of the page and use the drop-down menu to select Password Manager. +Password Manager lists the user's identity's applications, possibly grouped to share passwords. +Users can then select 'Change Password' to update their passwords. + +Grouping passwords allows users to update their passwords more broadly, rather than requiring them to update each password individually. +Password Manager may list the applications and sources in the following groups: + +- Password Group: This refers to a group of applications that share a password. +For example, a user can use the same password for Google Drive, Google Mail, and YouTube. +Updating the password for the password group updates the password for all its included applications. + +- Multi-Application Source: This refers to a source with multiple applications that share a password. +For example, a user can have a source, G Suite, that includes the Google Calendar, Google Drive, and Google Mail applications. +Updating the password for the multi-application source updates the password for all its included applications. + +- Applications: These are applications that do not share passwords with other applications. + +An organization may require some authentication for users to update their passwords. +Users may be required to answer security questions or use a third-party authenticator before they can confirm their updates. + +Refer to [Managing Passwords](https://documentation.sailpoint.com/saas/user-help/accounts/passwords.html) for more information about password management. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024DigitToken**](#create-digit-token) | **POST** `/generate-password-reset-token/digit` | Generate a digit token +[**Get-V2024PasswordChangeStatus**](#get-password-change-status) | **GET** `/password-change-status/{id}` | Get Password Change Request Status +[**Search-V2024PasswordInfo**](#query-password-info) | **POST** `/query-password-info` | Query Password Info +[**Set-V2024Password**](#set-password) | **POST** `/set-password` | Set Identity's Password + +## create-digit-token +This API is used to generate a digit token for password management. Requires authorization scope of "idn:password-digit-token:create". + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | PasswordDigitTokenReset | [**PasswordDigitTokenReset**](../models/password-digit-token-reset) | True | + +### Return type +[**PasswordDigitToken**](../models/password-digit-token) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The digit token for password management. | PasswordDigitToken +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$PasswordDigitTokenReset = @"{ + "durationMinutes" : 5, + "length" : 8, + "userId" : "Abby.Smith" +}"@ + +# Generate a digit token + +try { + $Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset + New-V2024DigitToken-V2024XSailPointExperimental $XSailPointExperimental -V2024PasswordDigitTokenReset $Result + + # Below is a request that includes all optional parameters + # New-V2024DigitToken -V2024XSailPointExperimental $XSailPointExperimental -V2024PasswordDigitTokenReset $PasswordDigitTokenReset +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DigitToken" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-password-change-status +This API returns the status of a password change request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Password change request ID + +### Return type +[**PasswordStatus**](../models/password-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Status of the password change request | PasswordStatus +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID + +# Get Password Change Request Status + +try { + Get-V2024PasswordChangeStatus-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024PasswordChangeStatus -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordChangeStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## query-password-info +This API is used to query password related information. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | PasswordInfoQueryDTO | [**PasswordInfoQueryDTO**](../models/password-info-query-dto) | True | + +### Return type +[**PasswordInfo**](../models/password-info) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password info. | PasswordInfo +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$PasswordInfoQueryDTO = @"{ + "sourceName" : "My-AD", + "userName" : "Abby.Smith" +}"@ + +# Query Password Info + +try { + $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO + Search-V2024PasswordInfo-V2024PasswordInfoQueryDTO $Result + + # Below is a request that includes all optional parameters + # Search-V2024PasswordInfo -V2024PasswordInfoQueryDTO $PasswordInfoQueryDTO +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PasswordInfo" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-password +This API is used to set a password for an identity. + +An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). + +>**Note: If you want to set an identity's source account password, you must enable `PASSWORD` as one of the source's features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** + +To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: + +```bash +echo -n "myPassword" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 +``` + +In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. + +To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. + +If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. + +You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | PasswordChangeRequest | [**PasswordChangeRequest**](../models/password-change-request) | True | + +### Return type +[**PasswordChangeResponse**](../models/password-change-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Reference to the password change. | PasswordChangeResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$PasswordChangeRequest = @"{ + "sourceId" : "8a807d4c73c545510173c545d4b60246", + "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "identityId" : "8a807d4c73c545510173c545f0a002ff", + "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" +}"@ + +# Set Identity's Password + +try { + $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest + Set-V2024Password-V2024PasswordChangeRequest $Result + + # Below is a request that includes all optional parameters + # Set-V2024Password -V2024PasswordChangeRequest $PasswordChangeRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024Password" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024PasswordPoliciesApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024PasswordPoliciesApi.md new file mode 100644 index 000000000..07b70efbd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024PasswordPoliciesApi.md @@ -0,0 +1,321 @@ + +--- +id: v2024-password-policies +title: PasswordPolicies +pagination_label: PasswordPolicies +sidebar_label: PasswordPolicies +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordPolicies', 'V2024PasswordPolicies'] +slug: /tools/sdk/powershell/v2024/methods/password-policies +tags: ['SDK', 'Software Development Kit', 'PasswordPolicies', 'V2024PasswordPolicies'] +--- + +# PasswordPolicies + Use these APIs to implement password policies functionality. +These APIs allow you to define the policy parameters for choosing passwords. + +IdentityNow comes with a default policy that you can modify to define the password requirements your users must meet to log in to IdentityNow, such as requiring a minimum password length, including special characters, and disallowing certain patterns. +If you have licensed Password Management, you can create additional password policies beyond the default one to manage passwords for supported sources in your org. + +In the Identity Security Cloud Admin panel, administrators can use the Password Mgmt dropdown menu to select Sync Groups. +Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/pwd_policies/pwd_policies.html) for more information about password policies. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024PasswordPolicy**](#create-password-policy) | **POST** `/password-policies` | Create Password Policy +[**Remove-V2024PasswordPolicy**](#delete-password-policy) | **DELETE** `/password-policies/{id}` | Delete Password Policy by ID +[**Get-V2024PasswordPolicyById**](#get-password-policy-by-id) | **GET** `/password-policies/{id}` | Get Password Policy by ID +[**Get-V2024PasswordPolicies**](#list-password-policies) | **GET** `/password-policies` | List Password Policies +[**Set-V2024PasswordPolicy**](#set-password-policy) | **PUT** `/password-policies/{id}` | Update Password Policy by ID + +## create-password-policy +This API creates the specified password policy. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | PasswordPolicyV3Dto | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | True | + +### Return type +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password policy. | PasswordPolicyV3Dto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$PasswordPolicyV3Dto = @"{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 +}"@ + +# Create Password Policy + +try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + New-V2024PasswordPolicy-V2024PasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # New-V2024PasswordPolicy -V2024PasswordPolicyV3Dto $PasswordPolicyV3Dto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-password-policy +This API deletes the specified password policy. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of password policy to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. + +# Delete Password Policy by ID + +try { + Remove-V2024PasswordPolicy-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024PasswordPolicy -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PasswordPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-password-policy-by-id +This API returns the password policy for the specified ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of password policy to retrieve. + +### Return type +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password policy. | PasswordPolicyV3Dto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. + +# Get Password Policy by ID + +try { + Get-V2024PasswordPolicyById-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024PasswordPolicyById -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordPolicyById" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-password-policies +This gets list of all Password Policies. +Requires role of ORG_ADMIN + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**PasswordPolicyV3Dto[]**](../models/password-policy-v3-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of all Password Policies. | PasswordPolicyV3Dto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# List Password Policies + +try { + Get-V2024PasswordPolicies + + # Below is a request that includes all optional parameters + # Get-V2024PasswordPolicies -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordPolicies" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-password-policy +This API updates the specified password policy. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of password policy to update. + Body | PasswordPolicyV3Dto | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | True | + +### Return type +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password policy. | PasswordPolicyV3Dto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update. +$PasswordPolicyV3Dto = @"{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 +}"@ + +# Update Password Policy by ID + +try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + Set-V2024PasswordPolicy-V2024Id $Id -V2024PasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # Set-V2024PasswordPolicy -V2024Id $Id -V2024PasswordPolicyV3Dto $PasswordPolicyV3Dto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024PasswordPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024PasswordSyncGroupsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024PasswordSyncGroupsApi.md new file mode 100644 index 000000000..314567ee3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024PasswordSyncGroupsApi.md @@ -0,0 +1,292 @@ + +--- +id: v2024-password-sync-groups +title: PasswordSyncGroups +pagination_label: PasswordSyncGroups +sidebar_label: PasswordSyncGroups +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordSyncGroups', 'V2024PasswordSyncGroups'] +slug: /tools/sdk/powershell/v2024/methods/password-sync-groups +tags: ['SDK', 'Software Development Kit', 'PasswordSyncGroups', 'V2024PasswordSyncGroups'] +--- + +# PasswordSyncGroups + Use this API to implement password sync group functionality. +With this functionality in place, administrators can group sources into password sync groups so that all their applications share the same password. +This allows users to update the password for all the applications in a sync group if they want, rather than updating each password individually. + +A password sync group is a group of applications that shares a password. +Administrators create these groups by grouping the applications' sources. +For example, an administrator can group the ActiveDirectory, GitHub, and G Suite sources together so that all those sources' applications can also be grouped to share a password. +A user can then update his or her password for ActiveDirectory, GitHub, Gmail, Google Drive, and Google Calendar all at once, rather then updating each one individually. + +The following are required for administrators to create a password sync group in Identity Security Cloud: + +- At least two direct connect sources connected to Identity Security Cloud and configured for Password Management. + +- Each authentication source in a sync group must have at least one application. Refer to [Adding and Resetting Application Passwords](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html#adding-and-resetting-application-passwords) for more information about adding applications to sources. + +- At least one password policy. Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/policies.html) for more information about password policies. + +In the Admin panel in Identity Security Cloud, administrators can use the Password Mgmt dropdown menu to select Sync Groups. +To create a sync group, administrators must provide a name, choose a password policy to be enforced across the sources in the sync group, and select the sources to include in the sync group. + +Administrators can also delete sync groups in Identity Security Cloud, but they should know the following before they do: + +- Passwords related to the associated sources will become independent, so changing one will not change the others anymore. + +- Passwords for the sources' connected applications will also become independent. + +- Password policies assigned to the sync group are then assigned directly to the associated sources. +To change the password policy for a source, administrators must edit it directly. + +Once the password sync group has been created, users can update the password for the group in Password Manager. + +Refer to [Managing Password Sync Groups](https://documentation.sailpoint.com/saas/help/pwd/sync_grps.html) for more information about password sync groups. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024PasswordSyncGroup**](#create-password-sync-group) | **POST** `/password-sync-groups` | Create Password Sync Group +[**Remove-V2024PasswordSyncGroup**](#delete-password-sync-group) | **DELETE** `/password-sync-groups/{id}` | Delete Password Sync Group by ID +[**Get-V2024PasswordSyncGroup**](#get-password-sync-group) | **GET** `/password-sync-groups/{id}` | Get Password Sync Group by ID +[**Get-V2024PasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get Password Sync Group List +[**Update-V2024PasswordSyncGroup**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update Password Sync Group by ID + +## create-password-sync-group +This API creates a password sync group based on the specifications provided. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | PasswordSyncGroup | [**PasswordSyncGroup**](../models/password-sync-group) | True | + +### Return type +[**PasswordSyncGroup**](../models/password-sync-group) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password sync group. | PasswordSyncGroup +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$PasswordSyncGroup = @"{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] +}"@ + +# Create Password Sync Group + +try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + New-V2024PasswordSyncGroup-V2024PasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # New-V2024PasswordSyncGroup -V2024PasswordSyncGroup $PasswordSyncGroup +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordSyncGroup" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-password-sync-group +This API deletes the specified password sync group. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of password sync group to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. + +# Delete Password Sync Group by ID + +try { + Remove-V2024PasswordSyncGroup-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024PasswordSyncGroup -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PasswordSyncGroup" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-password-sync-group +This API returns the sync group for the specified ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of password sync group to retrieve. + +### Return type +[**PasswordSyncGroup**](../models/password-sync-group) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password sync group. | PasswordSyncGroup +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. + +# Get Password Sync Group by ID + +try { + Get-V2024PasswordSyncGroup-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024PasswordSyncGroup -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordSyncGroup" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-password-sync-groups +This API returns a list of password sync groups. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**PasswordSyncGroup[]**](../models/password-sync-group) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of password sync groups. | PasswordSyncGroup[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Get Password Sync Group List + +try { + Get-V2024PasswordSyncGroups + + # Below is a request that includes all optional parameters + # Get-V2024PasswordSyncGroups -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordSyncGroups" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-password-sync-group +This API updates the specified password sync group. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of password sync group to update. + Body | PasswordSyncGroup | [**PasswordSyncGroup**](../models/password-sync-group) | True | + +### Return type +[**PasswordSyncGroup**](../models/password-sync-group) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password sync group. | PasswordSyncGroup +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to update. +$PasswordSyncGroup = @"{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] +}"@ + +# Update Password Sync Group by ID + +try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + Update-V2024PasswordSyncGroup-V2024Id $Id -V2024PasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # Update-V2024PasswordSyncGroup -V2024Id $Id -V2024PasswordSyncGroup $PasswordSyncGroup +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PasswordSyncGroup" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024PersonalAccessTokensApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024PersonalAccessTokensApi.md new file mode 100644 index 000000000..53c6761a9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024PersonalAccessTokensApi.md @@ -0,0 +1,222 @@ + +--- +id: v2024-personal-access-tokens +title: PersonalAccessTokens +pagination_label: PersonalAccessTokens +sidebar_label: PersonalAccessTokens +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PersonalAccessTokens', 'V2024PersonalAccessTokens'] +slug: /tools/sdk/powershell/v2024/methods/personal-access-tokens +tags: ['SDK', 'Software Development Kit', 'PersonalAccessTokens', 'V2024PersonalAccessTokens'] +--- + +# PersonalAccessTokens + Use this API to implement personal access token (PAT) functionality. +With this functionality in place, users can use PATs as an alternative to passwords for authentication in Identity Security Cloud. + +PATs embed user information into the client ID and secret. +This replaces the API clients' need to store and provide a username and password to establish a connection, improving Identity Security Cloud organizations' integration security. + +In Identity Security Cloud, users can do the following to create and manage their PATs: Select the dropdown menu under their names, select Preferences, and then select Personal Access Tokens. +They must then provide a description about the token's purpose. +They can then select 'Create Token' at the bottom of the page to generate and view the Secret and Client ID. + +Refer to [Managing Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/generate_tokens.html) for more information about PATs. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024PersonalAccessToken**](#create-personal-access-token) | **POST** `/personal-access-tokens` | Create Personal Access Token +[**Remove-V2024PersonalAccessToken**](#delete-personal-access-token) | **DELETE** `/personal-access-tokens/{id}` | Delete Personal Access Token +[**Get-V2024PersonalAccessTokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List Personal Access Tokens +[**Update-V2024PersonalAccessToken**](#patch-personal-access-token) | **PATCH** `/personal-access-tokens/{id}` | Patch Personal Access Token + +## create-personal-access-token +This creates a personal access token. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CreatePersonalAccessTokenRequest | [**CreatePersonalAccessTokenRequest**](../models/create-personal-access-token-request) | True | Name and scope of personal access token. + +### Return type +[**CreatePersonalAccessTokenResponse**](../models/create-personal-access-token-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Created. Note - this is the only time Personal Access Tokens' secret attribute will be displayed. | CreatePersonalAccessTokenResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CreatePersonalAccessTokenRequest = @"{ + "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], + "accessTokenValiditySeconds" : 36900, + "name" : "NodeJS Integration" +}"@ + +# Create Personal Access Token + +try { + $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest + New-V2024PersonalAccessToken-V2024CreatePersonalAccessTokenRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024PersonalAccessToken -V2024CreatePersonalAccessTokenRequest $CreatePersonalAccessTokenRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PersonalAccessToken" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-personal-access-token +This deletes a personal access token. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The personal access token id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id + +# Delete Personal Access Token + +try { + Remove-V2024PersonalAccessToken-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024PersonalAccessToken -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PersonalAccessToken" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-personal-access-tokens +This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | OwnerId | **String** | (optional) | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* + +### Return type +[**GetPersonalAccessTokenResponse[]**](../models/get-personal-access-token-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of personal access tokens. | GetPersonalAccessTokenResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OwnerId = "2c9180867b50d088017b554662fb281e" # String | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) +$Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + +# List Personal Access Tokens + +try { + Get-V2024PersonalAccessTokens + + # Below is a request that includes all optional parameters + # Get-V2024PersonalAccessTokens -V2024OwnerId $OwnerId -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PersonalAccessTokens" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-personal-access-token +This performs a targeted update to the field(s) of a Personal Access Token. +Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The Personal Access Token id + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope + +### Return type +[**GetPersonalAccessTokenResponse**](../models/get-personal-access-token-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Indicates the PATCH operation succeeded, and returns the PAT's new representation. | GetPersonalAccessTokenResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope + + +# Patch Personal Access Token + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024PersonalAccessToken-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024PersonalAccessToken -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PersonalAccessToken" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024PublicIdentitiesApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024PublicIdentitiesApi.md new file mode 100644 index 000000000..916917ea9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024PublicIdentitiesApi.md @@ -0,0 +1,77 @@ + +--- +id: v2024-public-identities +title: PublicIdentities +pagination_label: PublicIdentities +sidebar_label: PublicIdentities +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PublicIdentities', 'V2024PublicIdentities'] +slug: /tools/sdk/powershell/v2024/methods/public-identities +tags: ['SDK', 'Software Development Kit', 'PublicIdentities', 'V2024PublicIdentities'] +--- + +# PublicIdentities + Use this API in conjunction with [Public Identites Config](https://developer.sailpoint.com/docs/api/v3/public-identities-config/) to enable non-administrators to view identities' publicly visible attributes. +With this functionality in place, non-administrators can view identity attributes other than the default attributes (email, lifecycle state, and manager), depending on which identity attributes their organization administrators have made public. +This can be helpful for access approvers, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024PublicIdentities**](#get-public-identities) | **GET** `/public-identities` | Get list of public identities + +## get-public-identities +Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* + Query | AddCoreFilters | **Boolean** | (optional) (default to $false) | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be ""spadmin"" or ""cloudadmin"". - uid should not be null. - lastname should not be null. - email should not be null. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** + +### Return type +[**PublicIdentity[]**](../models/public-identity) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of public identity objects. | PublicIdentity[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'firstname eq "John"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) +$AddCoreFilters = $false # Boolean | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be ""spadmin"" or ""cloudadmin"". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to $false) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + +# Get list of public identities + +try { + Get-V2024PublicIdentities + + # Below is a request that includes all optional parameters + # Get-V2024PublicIdentities -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024AddCoreFilters $AddCoreFilters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PublicIdentities" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024PublicIdentitiesConfigApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024PublicIdentitiesConfigApi.md new file mode 100644 index 000000000..16834be19 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024PublicIdentitiesConfigApi.md @@ -0,0 +1,130 @@ + +--- +id: v2024-public-identities-config +title: PublicIdentitiesConfig +pagination_label: PublicIdentitiesConfig +sidebar_label: PublicIdentitiesConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PublicIdentitiesConfig', 'V2024PublicIdentitiesConfig'] +slug: /tools/sdk/powershell/v2024/methods/public-identities-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentitiesConfig', 'V2024PublicIdentitiesConfig'] +--- + +# PublicIdentitiesConfig + Use this API to implement public identity configuration functionality. +With this functionality in place, administrators can make up to 5 identity attributes publicly visible so other non-administrator users can see the relevant information they need to make decisions. +This can be helpful for approvers making approvals, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. + +By default, non-administrators can select an identity and view the following attributes: email, lifecycle state, and manager. +However, it may be helpful for a non-administrator reviewer to see other identity attributes like department, region, title, etc. +Administrators can use this API to make those necessary identity attributes public to non-administrators. + +For example, a non-administrator deciding whether to approve another identity's request for access to the Workday application, whose access may be restricted to members of the HR department, would want to know whether the identity is a member of the HR department. +If an administrator has used [Update Public Identity Config](https://developer.sailpoint.com/docs/api/v3/update-public-identity-config/) to make the "department" attribute public, the approver can see the department and make a decision without requesting any more information. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024PublicIdentityConfig**](#get-public-identity-config) | **GET** `/public-identities-config` | Get the Public Identities Configuration +[**Update-V2024PublicIdentityConfig**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update the Public Identities Configuration + +## get-public-identity-config +Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**PublicIdentityConfig**](../models/public-identity-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Request succeeded. | PublicIdentityConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get the Public Identities Configuration + +try { + Get-V2024PublicIdentityConfig + + # Below is a request that includes all optional parameters + # Get-V2024PublicIdentityConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PublicIdentityConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-public-identity-config +Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | PublicIdentityConfig | [**PublicIdentityConfig**](../models/public-identity-config) | True | + +### Return type +[**PublicIdentityConfig**](../models/public-identity-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Request succeeded. | PublicIdentityConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$PublicIdentityConfig = @"{ + "modified" : "2018-06-25T20:22:28.104Z", + "attributes" : [ { + "name" : "Country", + "key" : "country" + }, { + "name" : "Country", + "key" : "country" + } ], + "modifiedBy" : { + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } +}"@ + +# Update the Public Identities Configuration + +try { + $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig + Update-V2024PublicIdentityConfig-V2024PublicIdentityConfig $Result + + # Below is a request that includes all optional parameters + # Update-V2024PublicIdentityConfig -V2024PublicIdentityConfig $PublicIdentityConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PublicIdentityConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ReportsDataExtractionApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ReportsDataExtractionApi.md new file mode 100644 index 000000000..3e5df79d3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ReportsDataExtractionApi.md @@ -0,0 +1,212 @@ + +--- +id: v2024-reports-data-extraction +title: ReportsDataExtraction +pagination_label: ReportsDataExtraction +sidebar_label: ReportsDataExtraction +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReportsDataExtraction', 'V2024ReportsDataExtraction'] +slug: /tools/sdk/powershell/v2024/methods/reports-data-extraction +tags: ['SDK', 'Software Development Kit', 'ReportsDataExtraction', 'V2024ReportsDataExtraction'] +--- + +# ReportsDataExtraction + Use this API to implement reports lifecycle managing and monitoring. +With this functionality in place, users can run reports, view their results, and cancel reports in progress. +This can be potentially helpful for auditing purposes. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Suspend-V2024Report**](#cancel-report) | **POST** `/reports/{id}/cancel` | Cancel Report +[**Get-V2024Report**](#get-report) | **GET** `/reports/{taskResultId}` | Get Report File +[**Get-V2024ReportResult**](#get-report-result) | **GET** `/reports/{taskResultId}/result` | Get Report Result +[**Start-V2024Report**](#start-report) | **POST** `/reports/run` | Run Report + +## cancel-report +Cancels a running report. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the running Report to cancel + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel + +# Cancel Report + +try { + Suspend-V2024Report-V2024Id $Id + + # Below is a request that includes all optional parameters + # Suspend-V2024Report -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024Report" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-report +Gets a report in file format. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | TaskResultId | **String** | True | Unique identifier of the task result which handled report + Query | FileFormat | **String** | True | Output format of the requested report file + Query | Name | **String** | (optional) | preferred Report file name, by default will be used report name from task result. + Query | Auditable | **Boolean** | (optional) (default to $false) | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. + +### Return type +**System.IO.FileInfo** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Report file in selected format. CSV by default. | System.IO.FileInfo +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/csv, application/pdf, application/json + +### Example +```powershell +$TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report +$FileFormat = "csv" # String | Output format of the requested report file +$Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional) +$Auditable = $true # Boolean | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to $false) + +# Get Report File + +try { + Get-V2024Report-V2024TaskResultId $TaskResultId -V2024FileFormat $FileFormat + + # Below is a request that includes all optional parameters + # Get-V2024Report -V2024TaskResultId $TaskResultId -V2024FileFormat $FileFormat -V2024Name $Name -V2024Auditable $Auditable +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Report" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-report-result +Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | TaskResultId | **String** | True | Unique identifier of the task result which handled report + Query | Completed | **Boolean** | (optional) (default to $false) | state of task result to apply ordering when results are fetching from the DB + +### Return type +[**ReportResults**](../models/report-results) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Details about report that was run or is running. | ReportResults +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report +$Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false) + +# Get Report Result + +try { + Get-V2024ReportResult-V2024TaskResultId $TaskResultId + + # Below is a request that includes all optional parameters + # Get-V2024ReportResult -V2024TaskResultId $TaskResultId -V2024Completed $Completed +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReportResult" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-report +Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | ReportDetails | [**ReportDetails**](../models/report-details) | True | + +### Return type +[**TaskResultDetails**](../models/task-result-details) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Details about running report task. | TaskResultDetails +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$ReportDetails = @"{ + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } +}"@ + +# Run Report + +try { + $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails + Start-V2024Report-V2024ReportDetails $Result + + # Below is a request that includes all optional parameters + # Start-V2024Report -V2024ReportDetails $ReportDetails +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024Report" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024RequestableObjectsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024RequestableObjectsApi.md new file mode 100644 index 000000000..3efe9601b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024RequestableObjectsApi.md @@ -0,0 +1,88 @@ + +--- +id: v2024-requestable-objects +title: RequestableObjects +pagination_label: RequestableObjects +sidebar_label: RequestableObjects +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestableObjects', 'V2024RequestableObjects'] +slug: /tools/sdk/powershell/v2024/methods/requestable-objects +tags: ['SDK', 'Software Development Kit', 'RequestableObjects', 'V2024RequestableObjects'] +--- + +# RequestableObjects + Use this API to implement requestable object functionality. +With this functionality in place, administrators can determine which access items can be requested with the [Access Request APIs](https://developer.sailpoint.com/docs/api/v3/access-requests/), along with their statuses. +This can be helpful for administrators who are implementing and customizing access request functionality as a way of checking which items are requestable as they are created, assigned, and made available. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024RequestableObjects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable Objects List + +## list-requestable-objects +This endpoint returns a list of acccess items that that can be requested through the Access Request endpoints. Access items are marked with AVAILABLE, PENDING or ASSIGNED with respect to the identity provided using *identity-id* query param. +Any authenticated token can call this endpoint to see their requestable access items. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | IdentityId | **String** | (optional) | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. + Query | Types | [**[]RequestableObjectType**](../models/requestable-object-type) | (optional) | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. + Query | Term | **String** | (optional) | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. + Query | Statuses | [**[]RequestableObjectRequestStatus**](../models/requestable-object-request-status) | (optional) | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** + +### Return type +[**RequestableObject[]**](../models/requestable-object) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of requestable objects | RequestableObject[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) +$Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. (optional) + +$Types = @"ROLE,ACCESS_PROFILE"@ # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. (optional) +$Term = "Finance Role" # String | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) +$Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional) + +$Statuses = @"[ASSIGNED, PENDING]"@ # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'name sw "bob"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + +# Requestable Objects List + +try { + Get-V2024RequestableObjects + + # Below is a request that includes all optional parameters + # Get-V2024RequestableObjects -V2024IdentityId $IdentityId -V2024Types $Types -V2024Term $Term -V2024Statuses $Statuses -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RequestableObjects" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024RoleInsightsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024RoleInsightsApi.md new file mode 100644 index 000000000..5e115a6ee --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024RoleInsightsApi.md @@ -0,0 +1,447 @@ + +--- +id: v2024-role-insights +title: RoleInsights +pagination_label: RoleInsights +sidebar_label: RoleInsights +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsights', 'V2024RoleInsights'] +slug: /tools/sdk/powershell/v2024/methods/role-insights +tags: ['SDK', 'Software Development Kit', 'RoleInsights', 'V2024RoleInsights'] +--- + +# RoleInsights + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024RoleInsightRequests**](#create-role-insight-requests) | **POST** `/role-insights/requests` | Generate insights for roles +[**Invoke-V2024DownloadRoleInsightsEntitlementsChanges**](#download-role-insights-entitlements-changes) | **GET** `/role-insights/{insightId}/entitlement-changes/download` | Download entitlement insights for a role +[**Get-V2024EntitlementChangesIdentities**](#get-entitlement-changes-identities) | **GET** `/role-insights/{insightId}/entitlement-changes/{entitlementId}/identities` | Get identities for a suggested entitlement (for a role) +[**Get-V2024RoleInsight**](#get-role-insight) | **GET** `/role-insights/{insightId}` | Get a single role insight +[**Get-V2024RoleInsights**](#get-role-insights) | **GET** `/role-insights` | Get role insights +[**Get-V2024RoleInsightsCurrentEntitlements**](#get-role-insights-current-entitlements) | **GET** `/role-insights/{insightId}/current-entitlements` | Get current entitlement for a role +[**Get-V2024RoleInsightsEntitlementsChanges**](#get-role-insights-entitlements-changes) | **GET** `/role-insights/{insightId}/entitlement-changes` | Get entitlement insights for a role +[**Get-V2024RoleInsightsRequests**](#get-role-insights-requests) | **GET** `/role-insights/requests/{id}` | Returns metadata from prior request. +[**Get-V2024RoleInsightsSummary**](#get-role-insights-summary) | **GET** `/role-insights/summary` | Get role insights summary information + +## create-role-insight-requests +Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**RoleInsightsResponse**](../models/role-insights-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Submitted a role insights generation request | RoleInsightsResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Generate insights for roles + +try { + New-V2024RoleInsightRequests-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2024RoleInsightRequests -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024RoleInsightRequests" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## download-role-insights-entitlements-changes +This endpoint returns the entitlement insights for a role. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | InsightId | **String** | True | The role insight id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* + +### Return type +**String** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a csv file containing a list of entitlements to be added for a role. | String +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: text/csv, application/json + +### Example +```powershell +$InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Sorters = "identitiesWithAccess" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) +$Filters = 'name sw "r"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + +# Download entitlement insights for a role + +try { + Invoke-V2024DownloadRoleInsightsEntitlementsChanges-V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Invoke-V2024DownloadRoleInsightsEntitlementsChanges -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024DownloadRoleInsightsEntitlementsChanges" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-entitlement-changes-identities +Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | InsightId | **String** | True | The role insight id +Path | EntitlementId | **String** | True | The entitlement id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | HasEntitlement | **Boolean** | (optional) (default to $false) | Identity has this entitlement or not + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* + +### Return type +[**RoleInsightsIdentities[]**](../models/role-insights-identities) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of identities with or without the entitlement. | RoleInsightsIdentities[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id +$EntitlementId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The entitlement id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$HasEntitlement = $true # Boolean | Identity has this entitlement or not (optional) (default to $false) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) +$Filters = 'name sw "Jan"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) + +# Get identities for a suggested entitlement (for a role) + +try { + Get-V2024EntitlementChangesIdentities-V2024InsightId $InsightId -V2024EntitlementId $EntitlementId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementChangesIdentities -V2024InsightId $InsightId -V2024EntitlementId $EntitlementId -V2024XSailPointExperimental $XSailPointExperimental -V2024HasEntitlement $HasEntitlement -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChangesIdentities" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-insight +This endpoint gets role insights information for a role. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | InsightId | **String** | True | The role insight id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**RoleInsight**](../models/role-insight) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns information about insights for a single role. | RoleInsight +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get a single role insight + +try { + Get-V2024RoleInsight-V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsight -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsight" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-insights +This method returns detailed role insights for each role. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* + +### Return type +[**RoleInsight[]**](../models/role-insight) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of roles with information about insights for each role. | RoleInsight[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "numberOfUpdates" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) +$Filters = 'name sw "John"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) + +# Get role insights + +try { + Get-V2024RoleInsights-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsights -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsights" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-insights-current-entitlements +This endpoint gets the entitlements for a role. The term "current" is to distinguish from the entitlement(s) an insight might recommend adding. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | InsightId | **String** | True | The role insight id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* + +### Return type +[**RoleInsightsEntitlement[]**](../models/role-insights-entitlement) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of current or pre-existing entitlements for a role. | RoleInsightsEntitlement[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Filters = 'name sw "r"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + +# Get current entitlement for a role + +try { + Get-V2024RoleInsightsCurrentEntitlements-V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsightsCurrentEntitlements -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsCurrentEntitlements" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-insights-entitlements-changes +This endpoint returns entitlement insights for a role. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | InsightId | **String** | True | The role insight id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* + +### Return type +[**RoleInsightsEntitlementChanges[]**](../models/role-insights-entitlement-changes) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns a list of entitlements to be added for a role. | RoleInsightsEntitlementChanges[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) +$Filters = 'name sw "Admin"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + +# Get entitlement insights for a role + +try { + Get-V2024RoleInsightsEntitlementsChanges-V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsightsEntitlementsChanges -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsEntitlementsChanges" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-insights-requests +This endpoint returns details of a prior role insights request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The role insights request id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**RoleInsightsResponse**](../models/role-insights-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns details of an earlier role insights request. | RoleInsightsResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insights request id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Returns metadata from prior request. + +try { + Get-V2024RoleInsightsRequests-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsightsRequests -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsRequests" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-insights-summary +This method returns high level summary information for role insights for a customer. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**RoleInsightsSummary**](../models/role-insights-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Succeeded. Returns high level counts. | RoleInsightsSummary +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get role insights summary information + +try { + Get-V2024RoleInsightsSummary-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsightsSummary -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsSummary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024RolesApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024RolesApi.md new file mode 100644 index 000000000..e2d388688 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024RolesApi.md @@ -0,0 +1,1059 @@ + +--- +id: v2024-roles +title: Roles +pagination_label: Roles +sidebar_label: Roles +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Roles', 'V2024Roles'] +slug: /tools/sdk/powershell/v2024/methods/roles +tags: ['SDK', 'Software Development Kit', 'Roles', 'V2024Roles'] +--- + +# Roles + Use this API to implement and customize role functionality. +With this functionality in place, administrators can create roles and configure them for use throughout Identity Security Cloud. +Identity Security Cloud can use established criteria to automatically assign the roles to qualified users. This enables users to get all the access they need quickly and securely and administrators to spend their time on other tasks. + +Entitlements represent the most granular level of access in Identity Security Cloud. +Access profiles represent the next level and often group entitlements. +Roles represent the broadest level of access and often group access profiles. + +For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +An administrator can then create an even broader set of access in the form of a role grouping the 'AD Developers' access profile with another profile, 'GitHub Developers,' grouping entitlements for the GitHub source. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +When users need both the 'AD Developers' access profile and the 'GitHub Developers' access profile, they can request access to the role grouping both. + +Roles often represent positions within organizations. +For example, an organization's accountant can access all the tools the organization's accountants need with the 'Accountant' role. +If the accountant switches to engineering, a qualified member of the organization can quickly revoke the accountant's 'Accountant' access and grant access to the 'Engineer' role instead, granting access to all the tools the organization's engineers need. + +In Identity Security Cloud, adminstrators can use the Access drop-down menu and select Roles to view, configure, and delete existing roles, as well as create new ones. +Administrators can enable and disable the role, and they can also make the following configurations: + +- Manage Access: Manage the role's access by adding or removing access profiles. + +- Define Assignment: Define the criteria Identity Security Cloud uses to assign the role to identities. +Use the first option, 'Standard Criteria,' to provide specific criteria for assignment like specific account attributes, entitlements, or identity attributes. +Use the second, 'Identity List,' to specify the identities for assignment. + +- Access Requests: Configure roles to be requestable and establish an approval process for any requests that the role be granted or revoked. +Do not configure a role to be requestable without establishing a secure access request approval process for that role first. + +Refer to [Working with Roles](https://documentation.sailpoint.com/saas/help/access/roles.html) for more information about roles. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024Role**](#create-role) | **POST** `/roles` | Create a Role +[**Remove-V2024BulkRoles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete Role(s) +[**Remove-V2024MetadataFromRoleByKeyAndValue**](#delete-metadata-from-role-by-key-and-value) | **DELETE** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove a Metadata From Role. +[**Remove-V2024Role**](#delete-role) | **DELETE** `/roles/{id}` | Delete a Role +[**Get-V2024BulkUpdateStatus**](#get-bulk-update-status) | **GET** `/roles/access-model-metadata/bulk-update` | Get Bulk-Update Statuses +[**Get-V2024BulkUpdateStatusById**](#get-bulk-update-status-by-id) | **GET** `/roles/access-model-metadata/bulk-update/id` | Get Bulk-Update Status by ID +[**Get-V2024Role**](#get-role) | **GET** `/roles/{id}` | Get a Role +[**Get-V2024RoleAssignedIdentities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | List Identities assigned a Role +[**Get-V2024RoleEntitlements**](#get-role-entitlements) | **GET** `/roles/{id}/entitlements` | List role's Entitlements +[**Get-V2024Roles**](#list-roles) | **GET** `/roles` | List Roles +[**Update-V2024Role**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified Role +[**Search-V2024RolesByFilter**](#search-roles-by-filter) | **POST** `/roles/filter` | Filter Roles by Metadata +[**Update-V2024AttributeKeyAndValueToRole**](#update-attribute-key-and-value-to-role) | **POST** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add a Metadata to Role. +[**Update-V2024RolesMetadataByFilter**](#update-roles-metadata-by-filter) | **POST** `/roles/access-model-metadata/bulk-update/filter` | Bulk-Update Roles' Metadata by Filters +[**Update-V2024RolesMetadataByIds**](#update-roles-metadata-by-ids) | **POST** `/roles/access-model-metadata/bulk-update/ids` | Bulk-Update Roles' Metadata by ID +[**Update-V2024RolesMetadataByQuery**](#update-roles-metadata-by-query) | **POST** `/roles/access-model-metadata/bulk-update/query` | Bulk-Update Roles' Metadata by Query + +## create-role +This API creates a role. +In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. + +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Role | [**Role**](../models/role) | True | + +### Return type +[**Role**](../models/role) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Role created | Role +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Role = @"{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "dimensional" : false, + "created" : "2021-03-01T22:32:58.104Z", + "dimensionRefs" : [ { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + }, { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + } ], + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "membership" : { + "identities" : [ { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } ], + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, + "type" : "IDENTITY_LIST" + }, + "enabled" : true, + "revocationRequestConfig" : { + "commentsRequired" : false, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : false + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "legacyMembershipInfo" : { + "type" : "IDENTITY_LIST" + }, + "accessRequestConfig" : { + "commentsRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "name" : "Role 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "accessModelMetadata" : { + "attributes" : [ { + "key" : "iscPrivacy", + "name" : "Privacy", + "multiselect" : false, + "status" : "active", + "type" : "governance", + "objectTypes" : [ "all" ], + "description" : "Specifies the level of privacy associated with an access item.", + "values" : [ { + "value" : "public", + "name" : "Public", + "status" : "active" + } ] + } ] + }, + "id" : "2c918086749d78830174a1a40e121518", + "requestable" : true +}"@ + +# Create a Role + +try { + $Result = ConvertFrom-JsonToRole -Json $Role + New-V2024Role-V2024Role $Result + + # Below is a request that includes all optional parameters + # New-V2024Role -V2024Role $Role +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Role" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-bulk-roles +This endpoint initiates a bulk deletion of one or more roles. +When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. +This endpoint can only bulk delete up to a limit of 50 roles per request. +A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | RoleBulkDeleteRequest | [**RoleBulkDeleteRequest**](../models/role-bulk-delete-request) | True | + +### Return type +[**TaskResultDto**](../models/task-result-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Returns an object with the id of the task performing the delete operation. | TaskResultDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$RoleBulkDeleteRequest = @"{ + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] +}"@ + +# Delete Role(s) + +try { + $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest + Remove-V2024BulkRoles-V2024RoleBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024BulkRoles -V2024RoleBulkDeleteRequest $RoleBulkDeleteRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024BulkRoles" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-metadata-from-role-by-key-and-value +This API initialize a request to remove a single Access Model Metadata from a role by attribute key and value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The role's id. +Path | AttributeKey | **String** | True | Technical name of the Attribute. +Path | AttributeValue | **String** | True | Technical name of the Attribute Value. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Request accepted | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808c74ff913f0175097daa9d59cd" # String | The role's id. +$AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. +$AttributeValue = "public" # String | Technical name of the Attribute Value. + +# Remove a Metadata From Role. + +try { + Remove-V2024MetadataFromRoleByKeyAndValue-V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue + + # Below is a request that includes all optional parameters + # Remove-V2024MetadataFromRoleByKeyAndValue -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MetadataFromRoleByKeyAndValue" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-role +This API deletes a Role by its ID. + +A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Role + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + +# Delete a Role + +try { + Remove-V2024Role-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Role -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Role" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-bulk-update-status +This API returns a list of all unfinished bulk update process status of the tenant. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**RoleGetAllBulkUpdateResponse[]**](../models/role-get-all-bulk-update-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | successfully get the status of all unfinished bulk updates request. | RoleGetAllBulkUpdateResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Bulk-Update Statuses + +try { + Get-V2024BulkUpdateStatus + + # Below is a request that includes all optional parameters + # Get-V2024BulkUpdateStatus +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BulkUpdateStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-bulk-update-status-by-id + +This API initial a request for one bulk update's status by bulk update Id returns the status of the bulk update process. +A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The Id of the bulk update task. + +### Return type +[**RoleBulkUpdateResponse**](../models/role-bulk-update-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | return if bulk update status could be found. | RoleBulkUpdateResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of the bulk update task. + +# Get Bulk-Update Status by ID + +try { + Get-V2024BulkUpdateStatusById-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024BulkUpdateStatusById -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BulkUpdateStatusById" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role +This API returns a Role by its ID. +A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Role + +### Return type +[**Role**](../models/role) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of all Roles | Role +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + +# Get a Role + +try { + Get-V2024Role-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Role -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Role" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-assigned-identities + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Role for which the assigned Identities are to be listed + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** + +### Return type +[**RoleIdentity[]**](../models/role-identity) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Identities assigned the Role | RoleIdentity[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role for which the assigned Identities are to be listed +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'name sw Joe' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) +$Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) + +# List Identities assigned a Role + +try { + Get-V2024RoleAssignedIdentities-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024RoleAssignedIdentities -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignedIdentities" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-entitlements +This API lists the Entitlements associated with a given role. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the containing role + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** + +### Return type +[**Entitlement1[]**](../models/entitlement1) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Entitlements | Entitlement1[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121919ecca" # String | ID of the containing role +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'attribute eq "memberOf"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + +# List role's Entitlements + +try { + Get-V2024RoleEntitlements-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleEntitlements -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleEntitlements" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-roles +This API returns a list of Roles. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | ForSubadmin | **String** | (optional) | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. + Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** + Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. + Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. + +### Return type +[**Role[]**](../models/role) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Roles | Role[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) +$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'requestable eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) +$ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) +$IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + +# List Roles + +try { + Get-V2024Roles + + # Below is a request that includes all optional parameters + # Get-V2024Roles -V2024ForSubadmin $ForSubadmin -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters -V2024ForSegmentIds $ForSegmentIds -V2024IncludeUnsegmented $IncludeUnsegmented +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Roles" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-role +This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: +* name +* description +* enabled +* owner +* accessProfiles +* entitlements +* membership +* requestable +* accessRequestConfig +* revokeRequestConfig +* segments +* accessModelMetadata + +A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Role to patch + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**Role**](../models/role) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the Role as updated. | Role +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | + + +# Patch a specified Role + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Role-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Role -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Role" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## search-roles-by-filter +This API returns a list of Role that filter by metadata and filter, it support filter by both path parameter and attribute key and values. +A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, HELPDESK, CERT_ADMIN, REPORT_ADMIN or SOURCE_ADMIN authority is required to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | ForSubadmin | **String** | (optional) | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. + Query | Limit | **Int32** | (optional) (default to 50) | Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** + Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. + Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. + Body | RoleListFilterDTO | [**RoleListFilterDTO**](../models/role-list-filter-dto) | (optional) | + +### Return type +**Role** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with A list of Roles | String[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) +$Limit = 50 # Int32 | Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) +$ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) +$IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) +$RoleListFilterDTO = @"{ + "ammKeyValues" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "secret" ] + } ], + "filters" : "dimensional eq false" +}"@ + +# Filter Roles by Metadata + +try { + Search-V2024RolesByFilter + + # Below is a request that includes all optional parameters + # Search-V2024RolesByFilter -V2024ForSubadmin $ForSubadmin -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024ForSegmentIds $ForSegmentIds -V2024IncludeUnsegmented $IncludeUnsegmented -V2024RoleListFilterDTO $RoleListFilterDTO +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024RolesByFilter" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-attribute-key-and-value-to-role +This API initialize a request to add a single Access Model Metadata to a role by attribute key and attribute value. A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. The maximum number of attributes in one role is 25. Custom metadata update, including ADD and REPLACE need suit licensed. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The Id of a role +Path | AttributeKey | **String** | True | Technical name of the Attribute. +Path | AttributeValue | **String** | True | Technical name of the Attribute Value. + +### Return type +[**Role**](../models/role) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the Role as updated. | Role +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of a role +$AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. +$AttributeValue = "public" # String | Technical name of the Attribute Value. + +# Add a Metadata to Role. + +try { + Update-V2024AttributeKeyAndValueToRole-V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue + + # Below is a request that includes all optional parameters + # Update-V2024AttributeKeyAndValueToRole -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AttributeKeyAndValueToRole" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-roles-metadata-by-filter +This API initiates a bulk update of metadata for one or more Roles by filter. +A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. +The maximum metadata value count for a single role is 25. +Custom metadata update, including add, replace need suit licensed. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | RoleMetadataBulkUpdateByFilterRequest | [**RoleMetadataBulkUpdateByFilterRequest**](../models/role-metadata-bulk-update-by-filter-request) | True | + +### Return type +[**RoleBulkUpdateResponse**](../models/role-bulk-update-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Returned if bulk update request created | RoleBulkUpdateResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$RoleMetadataBulkUpdateByFilterRequest = @"{ + "values" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "topSecret" ] + } ], + "filters" : " requestable eq false", + "replaceScope" : "ALL", + "operation" : "REPLACE" +}"@ + +# Bulk-Update Roles' Metadata by Filters + +try { + $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByFilterRequest -Json $RoleMetadataBulkUpdateByFilterRequest + Update-V2024RolesMetadataByFilter-V2024RoleMetadataBulkUpdateByFilterRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024RolesMetadataByFilter -V2024RoleMetadataBulkUpdateByFilterRequest $RoleMetadataBulkUpdateByFilterRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByFilter" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-roles-metadata-by-ids +This API initiates a bulk update of metadata for one or more Roles by a list of Role Ids. +A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. +The maximum role count in a single update request is 3000. The maximum metadata value count for a single role is 25. +Custom metadata update, including add, replace need suit licensed. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | RoleMetadataBulkUpdateByIdRequest | [**RoleMetadataBulkUpdateByIdRequest**](../models/role-metadata-bulk-update-by-id-request) | True | + +### Return type +[**RoleBulkUpdateResponse**](../models/role-bulk-update-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Returned if bulk update request created | RoleBulkUpdateResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$RoleMetadataBulkUpdateByIdRequest = @"{ + "roles" : [ "b1db89554cfa431cb8b9921ea38d9367" ], + "values" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "topSecret" ] + } ], + "replaceScope" : "ALL", + "operation" : "REPLACE" +}"@ + +# Bulk-Update Roles' Metadata by ID + +try { + $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByIdRequest -Json $RoleMetadataBulkUpdateByIdRequest + Update-V2024RolesMetadataByIds-V2024RoleMetadataBulkUpdateByIdRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024RolesMetadataByIds -V2024RoleMetadataBulkUpdateByIdRequest $RoleMetadataBulkUpdateByIdRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByIds" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-roles-metadata-by-query +This API initiates a bulk update of metadata for one or more Roles by query. +A token with ORG_ADMIN, ROLE_ADMIN ROLE_SUBADMIN authority is required to call this API. +The maximum metadata value count for a single role is 25. +Custom metadata update, including add, replace need suit licensed. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | RoleMetadataBulkUpdateByQueryRequest | [**RoleMetadataBulkUpdateByQueryRequest**](../models/role-metadata-bulk-update-by-query-request) | True | + +### Return type +[**RoleBulkUpdateResponse**](../models/role-bulk-update-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Returned if bulk update request created | RoleBulkUpdateResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$RoleMetadataBulkUpdateByQueryRequest = @"{ + "query" : { + "query\"" : { + "indices" : [ "roles" ], + "queryType" : "TEXT", + "textQuery" : { + "terms" : [ "test123" ], + "fields" : [ "id" ], + "matchAny" : false, + "contains" : true + }, + "includeNested" : false + } + }, + "values" : [ { + "attributeValue" : [ "topSecret" ], + "attributeKey" : "iscFederalClassifications" + }, { + "attributeValue" : [ "topSecret" ], + "attributeKey" : "iscFederalClassifications" + } ], + "replaceScope" : "ALL", + "operation" : "REPLACE" +}"@ + +# Bulk-Update Roles' Metadata by Query + +try { + $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByQueryRequest -Json $RoleMetadataBulkUpdateByQueryRequest + Update-V2024RolesMetadataByQuery-V2024RoleMetadataBulkUpdateByQueryRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024RolesMetadataByQuery -V2024RoleMetadataBulkUpdateByQueryRequest $RoleMetadataBulkUpdateByQueryRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByQuery" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SIMIntegrationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SIMIntegrationsApi.md new file mode 100644 index 000000000..d643006b6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SIMIntegrationsApi.md @@ -0,0 +1,392 @@ + +--- +id: v2024-sim-integrations +title: SIMIntegrations +pagination_label: SIMIntegrations +sidebar_label: SIMIntegrations +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SIMIntegrations', 'V2024SIMIntegrations'] +slug: /tools/sdk/powershell/v2024/methods/sim-integrations +tags: ['SDK', 'Software Development Kit', 'SIMIntegrations', 'V2024SIMIntegrations'] +--- + +# SIMIntegrations + Use this API to administer IdentityNow's Service Integration Module, or SIM integration with ServiceNow, so that it converts IdentityNow provisioning actions into tickets in ServiceNow. + +ServiceNow is a software platform that supports IT service management and automates common business processes for requesting and fulfilling service requests across a business enterprise. + +You must have an IdentityNow ServiceNow ServiceDesk license to use this integration. Contact your Customer Success Manager for more information. + +Service Desk integration for IdentityNow and in deprecation - not available for new implementation, as of July 21st, 2021. As per SailPoint’s [support policy](https://community.sailpoint.com/t5/Connector-Directory/SailPoint-Support-Policy-for-Connectivity/ta-p/79422), all existing SailPoint IdentityNow customers using this legacy integration will be supported until July 2022. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024SIMIntegration**](#create-sim-integration) | **POST** `/sim-integrations` | Create new SIM integration +[**Remove-V2024SIMIntegration**](#delete-sim-integration) | **DELETE** `/sim-integrations/{id}` | Delete a SIM integration +[**Get-V2024SIMIntegration**](#get-sim-integration) | **GET** `/sim-integrations/{id}` | Get a SIM integration details. +[**Get-V2024SIMIntegrations**](#get-sim-integrations) | **GET** `/sim-integrations` | List the existing SIM integrations. +[**Update-V2024BeforeProvisioningRule**](#patch-before-provisioning-rule) | **PATCH** `/sim-integrations/{id}/beforeProvisioningRule` | Patch a SIM beforeProvisioningRule attribute. +[**Update-V2024SIMAttributes**](#patch-sim-attributes) | **PATCH** `/sim-integrations/{id}` | Patch a SIM attribute. +[**Send-V2024SIMIntegration**](#put-sim-integration) | **PUT** `/sim-integrations/{id}` | Update an existing SIM integration + +## create-sim-integration +Create a new SIM Integrations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | SimIntegrationDetails | [**SimIntegrationDetails**](../models/sim-integration-details) | True | DTO containing the details of the SIM integration + +### Return type +[**ServiceDeskIntegrationDto1**](../models/service-desk-integration-dto1) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | details of the created integration | ServiceDeskIntegrationDto1 +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$SimIntegrationDetails = @"{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } +}"@ + +# Create new SIM integration + +try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-V2024SIMIntegration-V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # New-V2024SIMIntegration -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $SimIntegrationDetails +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-sim-integration +Get the details of a SIM integration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The id of the integration to delete. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | No content response | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "12345" # String | The id of the integration to delete. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Delete a SIM integration + +try { + Remove-V2024SIMIntegration-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SIMIntegration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sim-integration +Get the details of a SIM integration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The id of the integration. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**ServiceDeskIntegrationDto1**](../models/service-desk-integration-dto1) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The DTO containing the details of the SIM integration | ServiceDeskIntegrationDto1 +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "12345" # String | The id of the integration. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get a SIM integration details. + +try { + Get-V2024SIMIntegration-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sim-integrations +List the existing SIM integrations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**ServiceDeskIntegrationDto1**](../models/service-desk-integration-dto1) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The DTO containing the details of the SIM integration | ServiceDeskIntegrationDto1 +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# List the existing SIM integrations. + +try { + Get-V2024SIMIntegrations-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SIMIntegrations -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegrations" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-before-provisioning-rule +Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | SIM integration id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | JsonPatch | [**JsonPatch**](../models/json-patch) | True | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. + +### Return type +[**ServiceDeskIntegrationDto1**](../models/service-desk-integration-dto1) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The updated DTO containing the details of the SIM integration. | ServiceDeskIntegrationDto1 +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "12345" # String | SIM integration id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]""@ + +# Patch a SIM beforeProvisioningRule attribute. + +try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024BeforeProvisioningRule-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024BeforeProvisioningRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $JsonPatch +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-sim-attributes +Patch a SIM attribute given a JsonPatch object. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | SIM integration id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | JsonPatch | [**JsonPatch**](../models/json-patch) | True | The JsonPatch object that describes the changes of SIM + +### Return type +[**ServiceDeskIntegrationDto1**](../models/service-desk-integration-dto1) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The updated DTO containing the details of the SIM integration. | ServiceDeskIntegrationDto1 +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "12345" # String | SIM integration id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]""@ + +# Patch a SIM attribute. + +try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024SIMAttributes-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024SIMAttributes -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $JsonPatch +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-sim-integration +Update an existing SIM integration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The id of the integration. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | SimIntegrationDetails | [**SimIntegrationDetails**](../models/sim-integration-details) | True | The full DTO of the integration containing the updated model + +### Return type +[**ServiceDeskIntegrationDto1**](../models/service-desk-integration-dto1) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | details of the updated integration | ServiceDeskIntegrationDto1 +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "12345" # String | The id of the integration. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$SimIntegrationDetails = @"{ + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } +}"@ + +# Update an existing SIM integration + +try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + Send-V2024SIMIntegration-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # Send-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $SimIntegrationDetails +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SODPoliciesApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SODPoliciesApi.md new file mode 100644 index 000000000..92f395517 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SODPoliciesApi.md @@ -0,0 +1,1017 @@ + +--- +id: v2024-sod-policies +title: SODPolicies +pagination_label: SODPolicies +sidebar_label: SODPolicies +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SODPolicies', 'V2024SODPolicies'] +slug: /tools/sdk/powershell/v2024/methods/sod-policies +tags: ['SDK', 'Software Development Kit', 'SODPolicies', 'V2024SODPolicies'] +--- + +# SODPolicies + Use this API to implement and manage "separation of duties" (SOD) policies. +With SOD policy functionality in place, administrators can organize the access in their tenants to prevent individuals from gaining conflicting or excessive access. + +"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. +For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. +Any changes to major system configurations should be approved by someone other than the person requesting the change. + +Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. +These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + +To create SOD policies in Identity Security Cloud, administrators use 'Search' and then access 'Policies'. +To create a policy, they must configure two lists of access items. Each access item can only be added to one of the two lists. +They can search for the entitlements they want to add to these access lists. + +>Note: You can have a maximum of 500 policies of any type (including general policies) in your organization. In each access-based SOD policy, you can have a maximum of 50 entitlements in each access list. + +Once a SOD policy is in place, if an identity has access items on both lists, a SOD violation will trigger. +These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. +The other users can then better help to enforce these SOD policies. + +To create a subscription to a SOD policy in Identity Security Cloud, administrators use 'Search' and then access 'Layers'. +They can create a subscription to the policy and schedule it to run at a regular interval. + +Refer to [Managing Policies](https://documentation.sailpoint.com/saas/help/sod/manage-policies.html) for more information about SOD policies. + +Refer to [Subscribe to a SOD Policy](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html#subscribe-to-an-sod-policy) for more information about SOD policy subscriptions. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024SodPolicy**](#create-sod-policy) | **POST** `/sod-policies` | Create SOD policy +[**Remove-V2024SodPolicy**](#delete-sod-policy) | **DELETE** `/sod-policies/{id}` | Delete SOD policy by ID +[**Remove-V2024SodPolicySchedule**](#delete-sod-policy-schedule) | **DELETE** `/sod-policies/{id}/schedule` | Delete SOD policy schedule +[**Get-V2024CustomViolationReport**](#get-custom-violation-report) | **GET** `/sod-violation-report/{reportResultId}/download/{fileName}` | Download custom violation report +[**Get-V2024DefaultViolationReport**](#get-default-violation-report) | **GET** `/sod-violation-report/{reportResultId}/download` | Download violation report +[**Get-V2024SodAllReportRunStatus**](#get-sod-all-report-run-status) | **GET** `/sod-violation-report` | Get multi-report run task status +[**Get-V2024SodPolicy**](#get-sod-policy) | **GET** `/sod-policies/{id}` | Get SOD policy by ID +[**Get-V2024SodPolicySchedule**](#get-sod-policy-schedule) | **GET** `/sod-policies/{id}/schedule` | Get SOD policy schedule +[**Get-V2024SodViolationReportRunStatus**](#get-sod-violation-report-run-status) | **GET** `/sod-policies/sod-violation-report-status/{reportResultId}` | Get violation report run status +[**Get-V2024SodViolationReportStatus**](#get-sod-violation-report-status) | **GET** `/sod-policies/{id}/violation-report` | Get SOD violation report status +[**Get-V2024SodPolicies**](#list-sod-policies) | **GET** `/sod-policies` | List SOD policies +[**Update-V2024SodPolicy**](#patch-sod-policy) | **PATCH** `/sod-policies/{id}` | Patch SOD policy by ID +[**Send-V2024PolicySchedule**](#put-policy-schedule) | **PUT** `/sod-policies/{id}/schedule` | Update SOD Policy schedule +[**Send-V2024SodPolicy**](#put-sod-policy) | **PUT** `/sod-policies/{id}` | Update SOD policy by ID +[**Start-V2024EvaluateSodPolicy**](#start-evaluate-sod-policy) | **POST** `/sod-policies/{id}/evaluate` | Evaluate one policy by ID +[**Start-V2024SodAllPoliciesForOrg**](#start-sod-all-policies-for-org) | **POST** `/sod-violation-report/run` | Runs all policies for org +[**Start-V2024SodPolicy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report + +## create-sod-policy +This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. +Requires role of ORG_ADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | SodPolicy | [**SodPolicy**](../models/sod-policy) | True | + +### Return type +[**SodPolicy**](../models/sod-policy) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | SOD policy created | SodPolicy +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SodPolicy = @"{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" +}"@ + +# Create SOD policy + +try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-V2024SodPolicy-V2024SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-V2024SodPolicy -V2024SodPolicy $SodPolicy +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-sod-policy +This deletes a specified SOD policy. +Requires role of ORG_ADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the SOD Policy to delete. + Query | Logical | **Boolean** | (optional) (default to $true) | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. +$Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) + +# Delete SOD policy by ID + +try { + Remove-V2024SodPolicy-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SodPolicy -V2024Id $Id -V2024Logical $Logical +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-sod-policy-schedule +This deletes schedule for a specified SOD policy by ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the SOD policy the schedule must be deleted for. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + +# Delete SOD policy schedule + +try { + Remove-V2024SodPolicySchedule-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SodPolicySchedule -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicySchedule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-custom-violation-report +This allows to download a specified named violation report for a given report reference. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ReportResultId | **String** | True | The ID of the report reference to download. +Path | FileName | **String** | True | Custom Name for the file. + +### Return type +**System.IO.FileInfo** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns the zip file with given custom name that contains the violation report file. | System.IO.FileInfo +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example +```powershell +$ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. +$FileName = "custom-name" # String | Custom Name for the file. + +# Download custom violation report + +try { + Get-V2024CustomViolationReport-V2024ReportResultId $ReportResultId -V2024FileName $FileName + + # Below is a request that includes all optional parameters + # Get-V2024CustomViolationReport -V2024ReportResultId $ReportResultId -V2024FileName $FileName +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomViolationReport" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-default-violation-report +This allows to download a violation report for a given report reference. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ReportResultId | **String** | True | The ID of the report reference to download. + +### Return type +**System.IO.FileInfo** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns the PolicyReport.zip that contains the violation report file. | System.IO.FileInfo +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example +```powershell +$ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + +# Download violation report + +try { + Get-V2024DefaultViolationReport-V2024ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2024DefaultViolationReport -V2024ReportResultId $ReportResultId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultViolationReport" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sod-all-report-run-status +This endpoint gets the status for a violation report for all policy run. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Status of the violation report run task for all policy run. | ReportResultReference +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get multi-report run task status + +try { + Get-V2024SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-V2024SodAllReportRunStatus +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodAllReportRunStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sod-policy +This gets specified SOD policy. +Requires role of ORG_ADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the SOD Policy to retrieve. + +### Return type +[**SodPolicy**](../models/sod-policy) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | SOD policy ID. | SodPolicy +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + +# Get SOD policy by ID + +try { + Get-V2024SodPolicy-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicy -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sod-policy-schedule +This endpoint gets a specified SOD policy's schedule. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the SOD policy schedule to retrieve. + +### Return type +[**SodPolicySchedule**](../models/sod-policy-schedule) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | SOD policy schedule. | SodPolicySchedule +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + +# Get SOD policy schedule + +try { + Get-V2024SodPolicySchedule-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicySchedule -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicySchedule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sod-violation-report-run-status +This gets the status for a violation report run task that has already been invoked. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ReportResultId | **String** | True | The ID of the report reference to retrieve. + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Status of the violation report run task. | ReportResultReference +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + +# Get violation report run status + +try { + Get-V2024SodViolationReportRunStatus-V2024ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2024SodViolationReportRunStatus -V2024ReportResultId $ReportResultId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportRunStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sod-violation-report-status +This gets the status for a violation report run task that has already been invoked. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the violation report to retrieve status for. + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Status of the violation report run task. | ReportResultReference +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + +# Get SOD violation report status + +try { + Get-V2024SodViolationReportStatus-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodViolationReportStatus -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-sod-policies +This gets list of all SOD policies. +Requires role of ORG_ADMIN + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** + +### Return type +[**SodPolicy[]**](../models/sod-policy) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of all SOD policies. | SodPolicy[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq "bc693f07e7b645539626c25954c58554"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) +$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + +# List SOD policies + +try { + Get-V2024SodPolicies + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicies -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicies" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-sod-policy +Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +Requires role of ORG_ADMIN. +This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the SOD policy being modified. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + +### Return type +[**SodPolicy**](../models/sod-policy) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Indicates the PATCH operation succeeded, and returns the SOD policy's new representation. | SodPolicy +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + + +# Patch SOD policy by ID + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SodPolicy-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SodPolicy -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SodPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-policy-schedule +This updates schedule for a specified SOD policy. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the SOD policy to update its schedule. + Body | SodPolicySchedule | [**SodPolicySchedule**](../models/sod-policy-schedule) | True | + +### Return type +[**SodPolicySchedule**](../models/sod-policy-schedule) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Created or updated SOD policy schedule. | SodPolicySchedule +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. +$SodPolicySchedule = @"{ + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false +}"@ + +# Update SOD Policy schedule + +try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-V2024PolicySchedule-V2024Id $Id -V2024SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-V2024PolicySchedule -V2024Id $Id -V2024SodPolicySchedule $SodPolicySchedule +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-sod-policy +This updates a specified SOD policy. +Requires role of ORG_ADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the SOD policy to update. + Body | SodPolicy | [**SodPolicy**](../models/sod-policy) | True | + +### Return type +[**SodPolicy**](../models/sod-policy) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | SOD Policy by ID | SodPolicy +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. +$SodPolicy = @"{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" +}"@ + +# Update SOD policy by ID + +try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-V2024SodPolicy-V2024Id $Id -V2024SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-V2024SodPolicy -V2024Id $Id -V2024SodPolicy $SodPolicy +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-evaluate-sod-policy +Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The SOD policy ID to run. + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the violation report run task. | ReportResultReference +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + +# Evaluate one policy by ID + +try { + Start-V2024EvaluateSodPolicy-V2024Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024EvaluateSodPolicy -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024EvaluateSodPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-sod-all-policies-for-org +Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | MultiPolicyRequest | [**MultiPolicyRequest**](../models/multi-policy-request) | (optional) | + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the violation report run task. | ReportResultReference +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$MultiPolicyRequest = @"{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] +}"@ + +# Runs all policies for org + +try { + Start-V2024SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-V2024SodAllPoliciesForOrg -V2024MultiPolicyRequest $MultiPolicyRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-sod-policy +This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The SOD policy ID to run. + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the violation report run task. | ReportResultReference +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + +# Runs SOD policy violation report + +try { + Start-V2024SodPolicy-V2024Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024SodPolicy -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SODViolationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SODViolationsApi.md new file mode 100644 index 000000000..18c4fd39a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SODViolationsApi.md @@ -0,0 +1,140 @@ + +--- +id: v2024-sod-violations +title: SODViolations +pagination_label: SODViolations +sidebar_label: SODViolations +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SODViolations', 'V2024SODViolations'] +slug: /tools/sdk/powershell/v2024/methods/sod-violations +tags: ['SDK', 'Software Development Kit', 'SODViolations', 'V2024SODViolations'] +--- + +# SODViolations + Use this API to check for current "separation of duties" (SOD) policy violations as well as potential future SOD policy violations. +With SOD violation functionality in place, administrators can get information about current SOD policy violations and predict whether an access change will trigger new violations, which helps to prevent them from occurring at all. + +"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. +For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. +Any changes to major system configurations should be approved by someone other than the person requesting the change. + +Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. +These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + +Once a SOD policy is in place, if an identity has conflicting access items, a SOD violation will trigger. +These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. +The other users can then better help to enforce these SOD policies. + +Administrators can use the SOD violations APIs to check a set of identities for any current SOD violations, and they can use them to check whether adding an access item would potentially trigger a SOD violation. +This second option is a good way to prevent SOD violations from triggering at all. + +Refer to [Handling Policy Violations](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html) for more information about SOD policy violations. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Start-V2024PredictSodViolations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict SOD violations for identity. +[**Start-V2024ViolationCheck**](#start-violation-check) | **POST** `/sod-violations/check` | Check SOD violations + +## start-predict-sod-violations +This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | IdentityWithNewAccess | [**IdentityWithNewAccess**](../models/identity-with-new-access) | True | + +### Return type +[**ViolationPrediction**](../models/violation-prediction) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Violation Contexts | ViolationPrediction +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$IdentityWithNewAccess = @"{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] +}"@ + +# Predict SOD violations for identity. + +try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-V2024PredictSodViolations-V2024IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-V2024PredictSodViolations -V2024IdentityWithNewAccess $IdentityWithNewAccess +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-violation-check +This API initiates a SOD policy verification asynchronously. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | IdentityWithNewAccess1 | [**IdentityWithNewAccess1**](../models/identity-with-new-access1) | True | + +### Return type +[**SodViolationCheck**](../models/sod-violation-check) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Request ID with a timestamp. | SodViolationCheck +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$IdentityWithNewAccess1 = @"{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}"@ + +# Check SOD violations + +try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-V2024ViolationCheck-V2024IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-V2024ViolationCheck -V2024IdentityWithNewAccess1 $IdentityWithNewAccess1 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SPConfigApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SPConfigApi.md new file mode 100644 index 000000000..19fccbfaf --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SPConfigApi.md @@ -0,0 +1,371 @@ + +--- +id: v2024-sp-config +title: SPConfig +pagination_label: SPConfig +sidebar_label: SPConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SPConfig', 'V2024SPConfig'] +slug: /tools/sdk/powershell/v2024/methods/sp-config +tags: ['SDK', 'Software Development Kit', 'SPConfig', 'V2024SPConfig'] +--- + +# SPConfig + Import and export configuration for some objects between tenants. + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Export-V2024SpConfig**](#export-sp-config) | **POST** `/sp-config/export` | Initiates configuration objects export job +[**Get-V2024SpConfigExport**](#get-sp-config-export) | **GET** `/sp-config/export/{id}/download` | Download export job result. +[**Get-V2024SpConfigExportStatus**](#get-sp-config-export-status) | **GET** `/sp-config/export/{id}` | Get export job status +[**Get-V2024SpConfigImport**](#get-sp-config-import) | **GET** `/sp-config/import/{id}/download` | Download import job result +[**Get-V2024SpConfigImportStatus**](#get-sp-config-import-status) | **GET** `/sp-config/import/{id}` | Get import job status +[**Import-V2024SpConfig**](#import-sp-config) | **POST** `/sp-config/import` | Initiates configuration objects import job +[**Get-V2024SpConfigObjects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | Get config object details + +## export-sp-config +This post will export objects from the tenant to a JSON configuration file. +For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects). + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | ExportPayload | [**ExportPayload**](../models/export-payload) | True | Export options control what will be included in the export. + +### Return type +[**SpConfigExportJob**](../models/sp-config-export-job) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Export job accepted and queued for processing. | SpConfigExportJob +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$ExportPayload = @"{ + "description" : "Export Job 1 Test" +}"@ + +# Initiates configuration objects export job + +try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-V2024SpConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024ExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-V2024SpConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024ExportPayload $ExportPayload +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sp-config-export +This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. +The request will need one of the following security scopes: +- sp:config:read - sp:config:manage + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the export job whose results will be downloaded. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**SpConfigExportResults**](../models/sp-config-export-results) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Exported JSON objects. | SpConfigExportResults +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Download export job result. + +try { + Get-V2024SpConfigExport-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigExport -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sp-config-export-status +This gets the status of the export job identified by the `id` parameter. +The request will need one of the following security scopes: +- sp:config:read - sp:config:manage + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the export job whose status will be returned. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**SpConfigExportJobStatus**](../models/sp-config-export-job-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Export job status successfully returned. | SpConfigExportJobStatus +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get export job status + +try { + Get-V2024SpConfigExportStatus-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigExportStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sp-config-import +This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. +The request will need the following security scope: +- sp:config:manage + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the import job whose results will be downloaded. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**SpConfigImportResults**](../models/sp-config-import-results) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Import results JSON object, containing detailed results of the import operation. | SpConfigImportResults +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Download import job result + +try { + Get-V2024SpConfigImport-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigImport -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sp-config-import-status +'This gets the status of the import job identified by the `id` parameter. + + For more information about the object types that currently support import functionality, + refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).' + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the import job whose status will be returned. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**SpConfigImportJobStatus**](../models/sp-config-import-job-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Import job status successfully returned. | SpConfigImportJobStatus +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get import job status + +try { + Get-V2024SpConfigImportStatus-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigImportStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-sp-config +"This post will import objects from a JSON configuration file into\ + \ a tenant. By default, every import will first export all existing objects supported\ + \ by sp-config as a backup before the import is attempted. The backup is provided\ + \ so that the state of the configuration prior to the import is available for\ + \ inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\"\ + \ to true in the import options. If a backup is performed, the id of the backup\ + \ will be provided in the ImportResult as the \"exportJobId\". This can be downloaded\ + \ using the `/sp-config/export/{exportJobId}/download` endpoint.\nYou cannot currently\ + \ import from the Non-Employee Lifecycle Management (NELM) source. You cannot\ + \ use this endpoint to back up or store NELM data. \nFor more information about\ + \ the object types that currently support import functionality, refer to [SaaS\ + \ Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects)." + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + | Data | **System.IO.FileInfo** | True | JSON file containing the objects to be imported. + Query | Preview | **Boolean** | (optional) (default to $false) | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. + | Options | [**ImportOptions**](../models/import-options) | (optional) | + +### Return type +[**SpConfigJob**](../models/sp-config-job) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Import job accepted and queued for processing. | SpConfigJob +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Data = # System.IO.FileInfo | JSON file containing the objects to be imported. +$Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) +$Options = @""@ + +# Initiates configuration objects import job + +try { + Import-V2024SpConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024Data $Data + + # Below is a request that includes all optional parameters + # Import-V2024SpConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024Data $Data -V2024Preview $Preview -V2024Options $Options +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-sp-config-objects +This gets the list of object configurations which are known to the tenant export/import service. Object configurations that contain "importUrl" and "exportUrl" are available for export/import. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**SpConfigObject[]**](../models/sp-config-object) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Object configurations returned successfully. | SpConfigObject[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get config object details + +try { + Get-V2024SpConfigObjects-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigObjects -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SavedSearchApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SavedSearchApi.md new file mode 100644 index 000000000..f62e70101 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SavedSearchApi.md @@ -0,0 +1,367 @@ + +--- +id: v2024-saved-search +title: SavedSearch +pagination_label: SavedSearch +sidebar_label: SavedSearch +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearch', 'V2024SavedSearch'] +slug: /tools/sdk/powershell/v2024/methods/saved-search +tags: ['SDK', 'Software Development Kit', 'SavedSearch', 'V2024SavedSearch'] +--- + +# SavedSearch + Use this API to implement saved search functionality. +With saved search functionality in place, users can save search queries and then view those saved searches, as well as rerun them. + +Search queries in Identity Security Cloud can grow very long and specific, which can make reconstructing them difficult or tedious, so it can be especially helpful to save search queries. +It also opens the possibility to configure Identity Security Cloud to run the saved queries on a schedule, which is essential to detecting user information and access changes throughout an organization's tenant and across all its sources. +Refer to [Scheduled Search](https://developer.sailpoint.com/docs/api/v3/scheduled-search/) for more information about running saved searches on a schedule. + +In Identity Security Cloud, users can save searches under a name, and then they can access that saved search and run it again when they want. + +Refer to [Managing Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html) for more information about saving searches and using them. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024SavedSearch**](#create-saved-search) | **POST** `/saved-searches` | Create a saved search +[**Remove-V2024SavedSearch**](#delete-saved-search) | **DELETE** `/saved-searches/{id}` | Delete document by ID +[**Invoke-V2024ExecuteSavedSearch**](#execute-saved-search) | **POST** `/saved-searches/{id}/execute` | Execute a saved search by ID +[**Get-V2024SavedSearch**](#get-saved-search) | **GET** `/saved-searches/{id}` | Return saved search by ID +[**Get-V2024SavedSearches**](#list-saved-searches) | **GET** `/saved-searches` | A list of Saved Searches +[**Send-V2024SavedSearch**](#put-saved-search) | **PUT** `/saved-searches/{id}` | Updates an existing saved search + +## create-saved-search +Creates a new saved search. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CreateSavedSearchRequest | [**CreateSavedSearchRequest**](../models/create-saved-search-request) | True | The saved search to persist. + +### Return type +[**SavedSearch**](../models/saved-search) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | The persisted saved search. | SavedSearch +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CreateSavedSearchRequest = @""@ + +# Create a saved search + +try { + $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest + New-V2024SavedSearch-V2024CreateSavedSearchRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024SavedSearch -V2024CreateSavedSearchRequest $CreateSavedSearchRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SavedSearch" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-saved-search +Deletes the specified saved search. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the requested document. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No Content - Indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + +# Delete document by ID + +try { + Remove-V2024SavedSearch-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SavedSearch -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SavedSearch" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## execute-saved-search +Executes the specified saved search. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the requested document. + Body | SearchArguments | [**SearchArguments**](../models/search-arguments) | True | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. +$SearchArguments = @"{ + "owner" : "", + "recipients" : [ { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" +}"@ + +# Execute a saved search by ID + +try { + $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments + Invoke-V2024ExecuteSavedSearch-V2024Id $Id -V2024SearchArguments $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024ExecuteSavedSearch -V2024Id $Id -V2024SearchArguments $SearchArguments +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ExecuteSavedSearch" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-saved-search +Returns the specified saved search. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the requested document. + +### Return type +[**SavedSearch**](../models/saved-search) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The requested saved search. | SavedSearch +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + +# Return saved search by ID + +try { + Get-V2024SavedSearch-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SavedSearch -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearch" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-saved-searches +Returns a list of saved searches. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* + +### Return type +[**SavedSearch[]**](../models/saved-search) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The list of requested saved searches. | SavedSearch[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) + +# A list of Saved Searches + +try { + Get-V2024SavedSearches + + # Below is a request that includes all optional parameters + # Get-V2024SavedSearches -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearches" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-saved-search +Updates an existing saved search. + +>**NOTE: You cannot update the `owner` of the saved search.** + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the requested document. + Body | SavedSearch | [**SavedSearch**](../models/saved-search) | True | The saved search to persist. + +### Return type +[**SavedSearch**](../models/saved-search) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The persisted saved search. | SavedSearch +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. +$SavedSearch = @"{ + "owner" : { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2018-06-25T20:22:28.104Z", + "columns" : { + "identity" : [ { + "field" : "displayName", + "header" : "Display Name" + }, { + "field" : "e-mail", + "header" : "Work Email" + } ] + }, + "query" : "@accounts(disabled:true)", + "description" : "Disabled accounts", + "orderBy" : { + "identity" : [ "lastName", "firstName" ], + "role" : [ "name" ] + }, + "sort" : [ "displayName" ], + "filters" : { + "terms" : [ "account_count", "account_count" ], + "range" : { + "lower" : { + "inclusive" : false, + "value" : "1" + }, + "upper" : { + "inclusive" : false, + "value" : "1" + } + }, + "exclude" : false, + "type" : "RANGE" + }, + "ownerId" : "2c91808568c529c60168cca6f90c1313", + "indices" : [ "identities" ], + "public" : false, + "name" : "Disabled accounts", + "modified" : "2018-06-25T20:22:28.104Z", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "fields" : [ "disabled" ] +}"@ + +# Updates an existing saved search + +try { + $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch + Send-V2024SavedSearch-V2024Id $Id -V2024SavedSearch $Result + + # Below is a request that includes all optional parameters + # Send-V2024SavedSearch -V2024Id $Id -V2024SavedSearch $SavedSearch +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SavedSearch" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ScheduledSearchApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ScheduledSearchApi.md new file mode 100644 index 000000000..b4d4b47e6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ScheduledSearchApi.md @@ -0,0 +1,419 @@ + +--- +id: v2024-scheduled-search +title: ScheduledSearch +pagination_label: ScheduledSearch +sidebar_label: ScheduledSearch +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledSearch', 'V2024ScheduledSearch'] +slug: /tools/sdk/powershell/v2024/methods/scheduled-search +tags: ['SDK', 'Software Development Kit', 'ScheduledSearch', 'V2024ScheduledSearch'] +--- + +# ScheduledSearch + Use this API to implement scheduled search functionality. +With scheduled search functionality in place, users can run saved search queries on their tenants on a schedule, and Identity Security Cloud emails them the search results. +Users can also share these search results with other users by email by adding those users as subscribers, or those users can subscribe themselves. + +One of the greatest benefits of saving searches is the ability to run those searches on a schedule. +This is essential for organizations to constantly detect any changes to user information or access throughout their tenants and across all their sources. +For example, the manager Amanda Ross can schedule a saved search "manager.name:amanda.ross AND attributes.location:austin" on a schedule to regularly stay aware of changes with the Austin employees reporting to her. +Identity Security Cloud emails her the search results when the search runs, so she can work on other tasks instead of actively running this search. + +In Identity Security Cloud, scheduling a search involves a subscription. +Users can create a subscription for a saved search and schedule it to run daily, weekly, or monthly (you can only use one schedule option at a time). +The user can add other identities as subscribers so when the scheduled search runs, the subscribers and the user all receive emails. + +By default, subscriptions exclude detailed results from the emails, for security purposes. +Including detailed results about user access in an email may expose sensitive information. +However, the subscription creator can choose to include the information in the emails. + +By default, Identity Security Cloud sends emails to the subscribers even when the searches do not return new results. +However, the subscription creator can choose to suppress these empty emails. + +Users can also subscribe to saved searches that already have existing subscriptions so they receive emails when the searches run. +A saved search can have up to 10 subscriptions configured at a time. + +The subscription creator can enable, disable, or delete the subscription. + +Refer to [Subscribing to Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html#subscribing-to-saved-searches) for more information about scheduling searches and subscribing to them. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024ScheduledSearch**](#create-scheduled-search) | **POST** `/scheduled-searches` | Create a new scheduled search +[**Remove-V2024ScheduledSearch**](#delete-scheduled-search) | **DELETE** `/scheduled-searches/{id}` | Delete a Scheduled Search +[**Get-V2024ScheduledSearch**](#get-scheduled-search) | **GET** `/scheduled-searches/{id}` | Get a Scheduled Search +[**Get-V2024ScheduledSearch**](#list-scheduled-search) | **GET** `/scheduled-searches` | List scheduled searches +[**Invoke-V2024UnsubscribeScheduledSearch**](#unsubscribe-scheduled-search) | **POST** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from Scheduled Search +[**Update-V2024ScheduledSearch**](#update-scheduled-search) | **PUT** `/scheduled-searches/{id}` | Update an existing Scheduled Search + +## create-scheduled-search +Creates a new scheduled search. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CreateScheduledSearchRequest | [**CreateScheduledSearchRequest**](../models/create-scheduled-search-request) | True | The scheduled search to persist. + +### Return type +[**ScheduledSearch**](../models/scheduled-search) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | The persisted scheduled search. | ScheduledSearch +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CreateScheduledSearchRequest = @"{savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]}"@ + +# Create a new scheduled search + +try { + $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest + New-V2024ScheduledSearch-V2024CreateScheduledSearchRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ScheduledSearch -V2024CreateScheduledSearchRequest $CreateScheduledSearchRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ScheduledSearch" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-scheduled-search +Deletes the specified scheduled search. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the requested document. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No Content - Indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + +# Delete a Scheduled Search + +try { + Remove-V2024ScheduledSearch-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ScheduledSearch -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ScheduledSearch" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-scheduled-search +Returns the specified scheduled search. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the requested document. + +### Return type +[**ScheduledSearch**](../models/scheduled-search) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The requested scheduled search. | ScheduledSearch +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + +# Get a Scheduled Search + +try { + Get-V2024ScheduledSearch-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ScheduledSearch -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-scheduled-search +Returns a list of scheduled searches. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* + +### Return type +[**ScheduledSearch[]**](../models/scheduled-search) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The list of requested scheduled searches. | ScheduledSearch[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional) + +# List scheduled searches + +try { + Get-V2024ScheduledSearch + + # Below is a request that includes all optional parameters + # Get-V2024ScheduledSearch -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## unsubscribe-scheduled-search +Unsubscribes a recipient from the specified scheduled search. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the requested document. + Body | TypedReference | [**TypedReference**](../models/typed-reference) | True | The recipient to be removed from the scheduled search. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No Content - Indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. +$TypedReference = @"{ + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" +}"@ + +# Unsubscribe a recipient from Scheduled Search + +try { + $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference + Invoke-V2024UnsubscribeScheduledSearch-V2024Id $Id -V2024TypedReference $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024UnsubscribeScheduledSearch -V2024Id $Id -V2024TypedReference $TypedReference +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnsubscribeScheduledSearch" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-scheduled-search +Updates an existing scheduled search. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the requested document. + Body | ScheduledSearch | [**ScheduledSearch**](../models/scheduled-search) | True | The scheduled search to persist. + +### Return type +[**ScheduledSearch**](../models/scheduled-search) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The persisted scheduled search. | ScheduledSearch +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. +$ScheduledSearch = @"{ + "owner" : { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "displayQueryDetails" : false, + "created" : "", + "description" : "Daily disabled accounts", + "ownerId" : "2c9180867624cbd7017642d8c8c81f67", + "enabled" : false, + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "recipients" : [ { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + } ], + "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", + "name" : "Daily disabled accounts", + "modified" : "", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "emailEmptyResults" : false +}"@ + +# Update an existing Scheduled Search + +try { + $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch + Update-V2024ScheduledSearch-V2024Id $Id -V2024ScheduledSearch $Result + + # Below is a request that includes all optional parameters + # Update-V2024ScheduledSearch -V2024Id $Id -V2024ScheduledSearch $ScheduledSearch +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ScheduledSearch" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SearchApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SearchApi.md new file mode 100644 index 000000000..84521c19e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SearchApi.md @@ -0,0 +1,582 @@ + +--- +id: v2024-search +title: Search +pagination_label: Search +sidebar_label: Search +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Search', 'V2024Search'] +slug: /tools/sdk/powershell/v2024/methods/search +tags: ['SDK', 'Software Development Kit', 'Search', 'V2024Search'] +--- + +# Search + Use this API to implement search functionality. +With search functionality in place, users can search their tenants for nearly any information from throughout their organizations. + +Identity Security Cloud enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential. +Its search goes through all those sources and finds the results quickly and specifically. + +The search query is flexible - it can be very broad or very narrow. +The search only returns results for searchable objects it is filtering for. +The following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities. +By default, no filter is applied, so a search for "Ad" returns both the identity "Adam.Archer" as well as the role "Administrator." + +Users can further narrow their results by using Identity Security Cloud's specific syntax and punctuation to structure their queries. +For example, the query "attributes.location:austin AND NOT manager.name:amanda.ross" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross. +Refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries. + +Refer to [Using Search](https://documentation.sailpoint.com/saas/help/search/index.html) for more information about Identity Security Cloud's search and its different possibilities. + +The search feature uses Elasticsearch as a datastore and query engine. +The power of Elasticsearch makes this feature suitable for ad-hoc reporting. +However, data from the operational databases (ex. identities, roles, events, etc) has to be ingested into Elasticsearch. +This ingestion process introduces a latency from when the operational data is created to when it is available in search. +Depending on the system load, this can take a few seconds to a few minutes. +Please keep this latency in mind when you use search. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Search-V2024Aggregate**](#search-aggregate) | **POST** `/search/aggregate` | Perform a Search Query Aggregation +[**Search-V2024Count**](#search-count) | **POST** `/search/count` | Count Documents Satisfying a Query +[**Search-V2024Get**](#search-get) | **GET** `/search/{index}/{id}` | Get a Document by ID +[**Search-V2024Post**](#search-post) | **POST** `/search` | Perform Search + +## search-aggregate +Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Search | [**Search**](../models/search) | True | + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**AggregationResult**](../models/aggregation-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Aggregation results. | AggregationResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json, text/csv + +### Example +```powershell +$Search = @"{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } +}"@ +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Perform a Search Query Aggregation + +try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-V2024Aggregate-V2024Search $Result + + # Below is a request that includes all optional parameters + # Search-V2024Aggregate -V2024Search $Search -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Aggregate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## search-count +Performs a search with a provided query and returns the count of results in the X-Total-Count header. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Search | [**Search**](../models/search) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Search = @"{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } +}"@ + +# Count Documents Satisfying a Query + +try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-V2024Count-V2024Search $Result + + # Below is a request that includes all optional parameters + # Search-V2024Count -V2024Search $Search +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Count" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## search-get +Fetches a single document from the specified index, using the specified document ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Index | **String** | True | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. +Path | Id | **String** | True | ID of the requested document. + +### Return type +[**SearchDocument**](../models/search-document) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The requested document. | SearchDocument +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. +$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + +# Get a Document by ID + +try { + Search-V2024Get-V2024Index $Index -V2024Id $Id + + # Below is a request that includes all optional parameters + # Search-V2024Get -V2024Index $Index -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Get" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## search-post +Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Search | [**Search**](../models/search) | True | + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**SearchDocument[]**](../models/search-document) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of matching documents. | SearchDocument[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Search = @"{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } +}"@ +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Perform Search + +try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-V2024Post-V2024Search $Result + + # Below is a request that includes all optional parameters + # Search-V2024Post -V2024Search $Search -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Post" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SearchAttributeConfigurationApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SearchAttributeConfigurationApi.md new file mode 100644 index 000000000..d3cf9c6ee --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SearchAttributeConfigurationApi.md @@ -0,0 +1,275 @@ + +--- +id: v2024-search-attribute-configuration +title: SearchAttributeConfiguration +pagination_label: SearchAttributeConfiguration +sidebar_label: SearchAttributeConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchAttributeConfiguration', 'V2024SearchAttributeConfiguration'] +slug: /tools/sdk/powershell/v2024/methods/search-attribute-configuration +tags: ['SDK', 'Software Development Kit', 'SearchAttributeConfiguration', 'V2024SearchAttributeConfiguration'] +--- + +# SearchAttributeConfiguration + Use this API to implement search attribute configuration functionality, along with [Search](https://developer.sailpoint.com/docs/api/v3/search). +With this functionality in place, administrators can create custom search attributes that and run extended searches based on those attributes to further narrow down their searches and get the information and insights they want. + +Identity Security Cloud (ISC) enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential. +Its search goes through all those sources and finds the results quickly and specifically. + +The search query is flexible - it can be very broad or very narrow. +The search only returns results for searchable objects it is filtering for. +The following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities. +By default, no filter is applied, so a search for "Ad" returns both the identity "Adam.Archer" as well as the role "Administrator." + +Users can further narrow their results by using ISC's specific syntax and punctuation to structure their queries. +For example, the query "attributes.location:austin AND NOT manager.name:amanda.ross" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross. +Refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries. + +Refer to [Using Search](https://documentation.sailpoint.com/saas/help/search/index.html) for more information about ISC's search and its different possibilities. + +With Search Attribute Configuration, administrators can create, manage, and run searches based on the attributes they want to search. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024SearchAttributeConfig**](#create-search-attribute-config) | **POST** `/accounts/search-attribute-config` | Create Extended Search Attributes +[**Remove-V2024SearchAttributeConfig**](#delete-search-attribute-config) | **DELETE** `/accounts/search-attribute-config/{name}` | Delete Extended Search Attribute +[**Get-V2024SearchAttributeConfig**](#get-search-attribute-config) | **GET** `/accounts/search-attribute-config` | List Extended Search Attributes +[**Get-V2024SingleSearchAttributeConfig**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute +[**Update-V2024SearchAttributeConfig**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute + +## create-search-attribute-config +Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create and attribute promotion configuration in the Link ObjectConfig. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | SearchAttributeConfig | [**SearchAttributeConfig**](../models/search-attribute-config) | True | + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SearchAttributeConfig = @"{ + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } +}"@ + +# Create Extended Search Attributes + +try { + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-V2024SearchAttributeConfig-V2024SearchAttributeConfig $Result + + # Below is a request that includes all optional parameters + # New-V2024SearchAttributeConfig -V2024SearchAttributeConfig $SearchAttributeConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SearchAttributeConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-search-attribute-config +Delete an extended attribute configuration by name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Name | **String** | True | Name of the extended search attribute configuration to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. + +# Delete Extended Search Attribute + +try { + Remove-V2024SearchAttributeConfig-V2024Name $Name + + # Below is a request that includes all optional parameters + # Remove-V2024SearchAttributeConfig -V2024Name $Name +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SearchAttributeConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-search-attribute-config +Get a list of attribute/application associates currently configured in Identity Security Cloud (ISC). + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**SearchAttributeConfig[]**](../models/search-attribute-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of attribute configurations in IdentityNow. | SearchAttributeConfig[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List Extended Search Attributes + +try { + Get-V2024SearchAttributeConfig + + # Below is a request that includes all optional parameters + # Get-V2024SearchAttributeConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SearchAttributeConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-single-search-attribute-config +Get an extended attribute configuration by name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Name | **String** | True | Name of the extended search attribute configuration to retrieve. + +### Return type +[**SearchAttributeConfig[]**](../models/search-attribute-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Specific attribute configuration in ISC. | SearchAttributeConfig[] +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to retrieve. + +# Get Extended Search Attribute + +try { + Get-V2024SingleSearchAttributeConfig-V2024Name $Name + + # Below is a request that includes all optional parameters + # Get-V2024SingleSearchAttributeConfig -V2024Name $Name +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SingleSearchAttributeConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-search-attribute-config +Update an existing search attribute configuration. +You can patch these fields: +* name * displayName * applicationAttributes + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Name | **String** | True | Name of the search attribute configuration to patch. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**SearchAttributeConfig**](../models/search-attribute-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The updated search attribute configuration. | SearchAttributeConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | + + +# Update Extended Search Attribute + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SearchAttributeConfig-V2024Name $Name -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SearchAttributeConfig -V2024Name $Name -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SearchAttributeConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SegmentsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SegmentsApi.md new file mode 100644 index 000000000..530fb6805 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SegmentsApi.md @@ -0,0 +1,292 @@ + +--- +id: v2024-segments +title: Segments +pagination_label: Segments +sidebar_label: Segments +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Segments', 'V2024Segments'] +slug: /tools/sdk/powershell/v2024/methods/segments +tags: ['SDK', 'Software Development Kit', 'Segments', 'V2024Segments'] +--- + +# Segments + Use this API to implement and customize access request segment functionality. +With this functionality in place, administrators can create and manage access request segments. +Segments provide organizations with a way to make the access their users have even more granular - this can simply the access request process for the organization's users and improves security by reducing the risk of overprovisoning access. + +Segments represent sets of identities, all grouped by specified identity attributes, who are only able to see and access the access items associated with their segments. +For example, administrators could group all their organization's London office employees into one segment, "London Office Employees," by their shared location. +The administrators could then define the access items the London employees would need, and the identities in the "London Office Employees" would then only be able to see and access those items. + +In Identity Security Cloud, administrators can use the 'Access' drop-down menu and select 'Segments' to reach the 'Access Requests Segments' page. +This page lists all the existing access request segments, along with their statuses, enabled or disabled. +Administrators can use this page to create, edit, enable, disable, and delete segments. +To create a segment, an administrator must provide a name, define the identities grouped in the segment, and define the items the identities in the segment can access. +These items can be access profiles, roles, or entitlements. + +When administrators use the API to create and manage segments, they use a JSON expression in the `visibilityCriteria` object to define the segment's identities and access items. + +Refer to [Managing Access Request Segments](https://documentation.sailpoint.com/saas/help/requests/segments.html) for more information about segments in Identity Security Cloud. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024Segment**](#create-segment) | **POST** `/segments` | Create Segment +[**Remove-V2024Segment**](#delete-segment) | **DELETE** `/segments/{id}` | Delete Segment by ID +[**Get-V2024Segment**](#get-segment) | **GET** `/segments/{id}` | Get Segment by ID +[**Get-V2024Segments**](#list-segments) | **GET** `/segments` | List Segments +[**Update-V2024Segment**](#patch-segment) | **PATCH** `/segments/{id}` | Update Segment + +## create-segment +This API creates a segment. +>**Note:** Segment definitions may take time to propagate to all identities. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Segment | [**Segment**](../models/segment) | True | + +### Return type +[**Segment**](../models/segment) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Segment created | Segment +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Segment = @"{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" +}"@ + +# Create Segment + +try { + $Result = ConvertFrom-JsonToSegment -Json $Segment + New-V2024Segment-V2024Segment $Result + + # Below is a request that includes all optional parameters + # New-V2024Segment -V2024Segment $Segment +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Segment" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-segment +This API deletes the segment specified by the given ID. +>**Note:** that segment deletion may take some time to become effective. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The segment ID to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + +# Delete Segment by ID + +try { + Remove-V2024Segment-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Segment -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Segment" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-segment +This API returns the segment specified by the given ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The segment ID to retrieve. + +### Return type +[**Segment**](../models/segment) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Segment | Segment +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + +# Get Segment by ID + +try { + Get-V2024Segment-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Segment -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segment" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-segments +This API returns a list of all segments. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**Segment[]**](../models/segment) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of all segments | Segment[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# List Segments + +try { + Get-V2024Segments + + # Below is a request that includes all optional parameters + # Get-V2024Segments -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segments" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-segment +Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +>**Note:** Changes to a segment may take some time to propagate to all identities. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The segment ID to modify. + Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | True | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + +### Return type +[**Segment**](../models/segment) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Indicates the PATCH operation succeeded, and returns the segment's new representation. | Segment +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. +$RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + + +# Update Segment + +try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2024Segment-V2024Id $Id -V2024RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024Segment -V2024Id $Id -V2024RequestBody $RequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Segment" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ServiceDeskIntegrationApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ServiceDeskIntegrationApi.md new file mode 100644 index 000000000..66b315bdf --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024ServiceDeskIntegrationApi.md @@ -0,0 +1,566 @@ + +--- +id: v2024-service-desk-integration +title: ServiceDeskIntegration +pagination_label: ServiceDeskIntegration +sidebar_label: ServiceDeskIntegration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskIntegration', 'V2024ServiceDeskIntegration'] +slug: /tools/sdk/powershell/v2024/methods/service-desk-integration +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegration', 'V2024ServiceDeskIntegration'] +--- + +# ServiceDeskIntegration + Use this API to build an integration between Identity Security Cloud and a service desk ITSM (IT service management) solution. +Once an administrator builds this integration between Identity Security Cloud and a service desk, users can use Identity Security Cloud to raise and track tickets that are synchronized between Identity Security Cloud and the service desk. + +In Identity Security Cloud, administrators can create a service desk integration (sometimes also called an SDIM, or Service Desk Integration Module) by going to Admin > Connections > Service Desk and selecting 'Create.' + +To create a Generic Service Desk integration, for example, administrators must provide the required information on the General Settings page, the Connectivity and Authentication information, Ticket Creation information, Status Mapping information, and Requester Source information on the Configure page. +Refer to [Integrating SailPoint with Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) for more information about the process of setting up a Generic Service Desk in Identity Security Cloud. + +Administrators can create various service desk integrations, all with their own nuances. +The following service desk integrations are available: + +- [Atlassian Cloud Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_cloud/help/integrating_jira_cloud_sd/introduction.html) + +- [Atlassian Server Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_server/help/integrating_jira_server_sd/introduction.html) + +- [BMC Helix ITSM Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_ITSM_sd/help/integrating_bmc_helix_itsm_sd/intro.html) + +- [BMC Helix Remedyforce Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_remedyforce_sd/help/integrating_bmc_helix_remedyforce_sd/intro.html) + +- [Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) + +- [ServiceNow Service Desk](https://documentation.sailpoint.com/connectors/servicenow/sdim/help/integrating_servicenow_sdim/intro.html) + +- [Zendesk Service Desk](https://documentation.sailpoint.com/connectors/zendesk/help/integrating_zendesk_sd/introduction.html) + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024ServiceDeskIntegration**](#create-service-desk-integration) | **POST** `/service-desk-integrations` | Create new Service Desk integration +[**Remove-V2024ServiceDeskIntegration**](#delete-service-desk-integration) | **DELETE** `/service-desk-integrations/{id}` | Delete a Service Desk integration +[**Get-V2024ServiceDeskIntegration**](#get-service-desk-integration) | **GET** `/service-desk-integrations/{id}` | Get a Service Desk integration +[**Get-V2024ServiceDeskIntegrationTemplate**](#get-service-desk-integration-template) | **GET** `/service-desk-integrations/templates/{scriptName}` | Service Desk integration template by scriptName +[**Get-V2024ServiceDeskIntegrationTypes**](#get-service-desk-integration-types) | **GET** `/service-desk-integrations/types` | List Service Desk integration types +[**Get-V2024ServiceDeskIntegrations**](#get-service-desk-integrations) | **GET** `/service-desk-integrations` | List existing Service Desk integrations +[**Get-V2024StatusCheckDetails**](#get-status-check-details) | **GET** `/service-desk-integrations/status-check-configuration` | Get the time check configuration +[**Update-V2024ServiceDeskIntegration**](#patch-service-desk-integration) | **PATCH** `/service-desk-integrations/{id}` | Patch a Service Desk Integration +[**Send-V2024ServiceDeskIntegration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a Service Desk integration +[**Update-V2024StatusCheckDetails**](#update-status-check-details) | **PUT** `/service-desk-integrations/status-check-configuration` | Update the time check configuration + +## create-service-desk-integration +Create a new Service Desk integration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | ServiceDeskIntegrationDto | [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) | True | The specifics of a new integration to create + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Details of the created integration | ServiceDeskIntegrationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$ServiceDeskIntegrationDto = @"{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" +}"@ + +# Create new Service Desk integration + +try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-V2024ServiceDeskIntegration-V2024ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # New-V2024ServiceDeskIntegration -V2024ServiceDeskIntegrationDto $ServiceDeskIntegrationDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-service-desk-integration +Delete an existing Service Desk integration by ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of Service Desk integration to delete + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | Service Desk integration with the given ID successfully deleted | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "anId" # String | ID of Service Desk integration to delete + +# Delete a Service Desk integration + +try { + Remove-V2024ServiceDeskIntegration-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ServiceDeskIntegration -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-service-desk-integration +Get an existing Service Desk integration by ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Service Desk integration to get + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | ServiceDeskIntegrationDto with the given ID | ServiceDeskIntegrationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "anId" # String | ID of the Service Desk integration to get + +# Get a Service Desk integration + +try { + Get-V2024ServiceDeskIntegration-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ServiceDeskIntegration -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-service-desk-integration-template +This API endpoint returns an existing Service Desk integration template by scriptName. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ScriptName | **String** | True | The scriptName value of the Service Desk integration template to get + +### Return type +[**ServiceDeskIntegrationTemplateDto**](../models/service-desk-integration-template-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName. | ServiceDeskIntegrationTemplateDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + +# Service Desk integration template by scriptName + +try { + Get-V2024ServiceDeskIntegrationTemplate-V2024ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024ServiceDeskIntegrationTemplate -V2024ScriptName $ScriptName +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrationTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-service-desk-integration-types +This API endpoint returns the current list of supported Service Desk integration types. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**ServiceDeskIntegrationTemplateType[]**](../models/service-desk-integration-template-type) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with an array of the currently supported Service Desk integration types. | ServiceDeskIntegrationTemplateType[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List Service Desk integration types + +try { + Get-V2024ServiceDeskIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-V2024ServiceDeskIntegrationTypes +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrationTypes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-service-desk-integrations +Get a list of Service Desk integration objects. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**ServiceDeskIntegrationDto[]**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of ServiceDeskIntegrationDto | ServiceDeskIntegrationDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) +$Filters = 'name eq "John Doe"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# List existing Service Desk integrations + +try { + Get-V2024ServiceDeskIntegrations + + # Below is a request that includes all optional parameters + # Get-V2024ServiceDeskIntegrations -V2024Offset $Offset -V2024Limit $Limit -V2024Sorters $Sorters -V2024Filters $Filters -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrations" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-status-check-details +Get the time check configuration of queued SDIM tickets. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**QueuedCheckConfigDetails**](../models/queued-check-config-details) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | QueuedCheckConfigDetails containing the configured values | QueuedCheckConfigDetails +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get the time check configuration + +try { + Get-V2024StatusCheckDetails + + # Below is a request that includes all optional parameters + # Get-V2024StatusCheckDetails +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusCheckDetails" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-service-desk-integration +Update an existing Service Desk integration by ID with a PATCH request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Service Desk integration to update + Body | PatchServiceDeskIntegrationRequest | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | ServiceDeskIntegrationDto as updated | ServiceDeskIntegrationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "anId" # String | ID of the Service Desk integration to update +$PatchServiceDeskIntegrationRequest = @""@ + +# Patch a Service Desk Integration + +try { + $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest + Update-V2024ServiceDeskIntegration-V2024Id $Id -V2024PatchServiceDeskIntegrationRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024ServiceDeskIntegration -V2024Id $Id -V2024PatchServiceDeskIntegrationRequest $PatchServiceDeskIntegrationRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-service-desk-integration +Update an existing Service Desk integration by ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Service Desk integration to update + Body | ServiceDeskIntegrationDto | [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) | True | The specifics of the integration to update + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | ServiceDeskIntegrationDto as updated | ServiceDeskIntegrationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "anId" # String | ID of the Service Desk integration to update +$ServiceDeskIntegrationDto = @"{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" +}"@ + +# Update a Service Desk integration + +try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-V2024ServiceDeskIntegration-V2024Id $Id -V2024ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # Send-V2024ServiceDeskIntegration -V2024Id $Id -V2024ServiceDeskIntegrationDto $ServiceDeskIntegrationDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-status-check-details +Update the time check configuration of queued SDIM tickets. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | QueuedCheckConfigDetails | [**QueuedCheckConfigDetails**](../models/queued-check-config-details) | True | The modified time check configuration + +### Return type +[**QueuedCheckConfigDetails**](../models/queued-check-config-details) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | QueuedCheckConfigDetails as updated | QueuedCheckConfigDetails +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$QueuedCheckConfigDetails = @"{ + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" +}"@ + +# Update the time check configuration + +try { + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-V2024StatusCheckDetails-V2024QueuedCheckConfigDetails $Result + + # Below is a request that includes all optional parameters + # Update-V2024StatusCheckDetails -V2024QueuedCheckConfigDetails $QueuedCheckConfigDetails +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024StatusCheckDetails" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SourceUsagesApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SourceUsagesApi.md new file mode 100644 index 000000000..eaf82d9c2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SourceUsagesApi.md @@ -0,0 +1,118 @@ + +--- +id: v2024-source-usages +title: SourceUsages +pagination_label: SourceUsages +sidebar_label: SourceUsages +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceUsages', 'V2024SourceUsages'] +slug: /tools/sdk/powershell/v2024/methods/source-usages +tags: ['SDK', 'Software Development Kit', 'SourceUsages', 'V2024SourceUsages'] +--- + +# SourceUsages + Use this API to implement source usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' sources are being used. +This allows organizations to get the information they need to start optimizing and securing source usage. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024StatusBySourceId**](#get-status-by-source-id) | **GET** `/source-usages/{sourceId}/status` | Finds status of source usage +[**Get-V2024UsagesBySourceId**](#get-usages-by-source-id) | **GET** `/source-usages/{sourceId}/summaries` | Returns source usage insights + +## get-status-by-source-id +This API returns the status of the source usage insights setup by IDN source ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | ID of IDN source + +### Return type +[**SourceUsageStatus**](../models/source-usage-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Status of the source usage insights setup by IDN source ID. | SourceUsageStatus +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + +# Finds status of source usage + +try { + Get-V2024StatusBySourceId-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024StatusBySourceId -V2024SourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusBySourceId" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-usages-by-source-id +This API returns a summary of source usage insights for past 12 months. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | ID of IDN source + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** + +### Return type +[**SourceUsage[]**](../models/source-usage) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Summary of source usage insights for past 12 months. | SourceUsage[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + +# Returns source usage insights + +try { + Get-V2024UsagesBySourceId-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024UsagesBySourceId -V2024SourceId $SourceId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesBySourceId" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SourcesApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SourcesApi.md new file mode 100644 index 000000000..95b61358f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SourcesApi.md @@ -0,0 +1,2904 @@ + +--- +id: v2024-sources +title: Sources +pagination_label: Sources +sidebar_label: Sources +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Sources', 'V2024Sources'] +slug: /tools/sdk/powershell/v2024/methods/sources +tags: ['SDK', 'Software Development Kit', 'Sources', 'V2024Sources'] +--- + +# Sources + Use this API to implement and customize source functionality. +With source functionality in place, organizations can use Identity Security Cloud to connect their various sources and user data sets and manage access across all those different sources in a secure, scalable way. + +[Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) refer to the Identity Security Cloud representations for external applications, databases, and directory management systems that maintain their own sets of users, like Dropbox, GitHub, and Workday, for example. +Organizations may use hundreds, if not thousands, of different source systems, and any one employee within an organization likely has a different user record on each source, often with different permissions on many of those records. +Connecting these sources to Identity Security Cloud makes it possible to manage user access across them all. +Then, if a new hire starts at an organization, Identity Security Cloud can grant the new hire access to all the sources they need. +If an employee moves to a new department and needs access to new sources but no longer needs access to others, Identity Security Cloud can grant the necessary access and revoke the unnecessary access for all the employee's various sources. +If an employee leaves the company, Identity Security Cloud can revoke access to all the employee's various source accounts immediately. +These are just a few examples of the many ways that source functionality makes identity governance easier, more efficient, and more secure. + +In Identity Security Cloud, administrators can create configure, manage, and edit sources, and they can designate other users as source admins to be able to do so. +They can also designate users as source sub-admins, who can perform the same source actions but only on sources associated with their governance groups. +Admins go to Connections > Sources to see a list of the existing source representations in their organizations. +They can create new sources or select existing ones. + +To create a new source, the following must be specified: Source Name, Description, Source Owner, and Connection Type. +Refer to [Configuring a Source](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html#configuring-a-source) for more information about the source configuration process. + +Identity Security Cloud connects with its sources either by a direct communication with the source server (connection information specific to the source must be provided) or a flat file feed, a CSV file containing all the relevant information about the accounts to be loaded in. +Different sources use different connectors to share data with Identity Security Cloud, and each connector's setup process is specific to that connector. +SailPoint has built a number of connectors to come out of the box and connect to the most common sources, and SailPoint actively maintains these connectors. +Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about these SailPoint supported connectors. +Refer to the following links for more information about two useful connectors: + +- [JDBC Connector](https://documentation.sailpoint.com/connectors/jdbc/help/integrating_jdbc/introduction.html): This customizable connector an directly connect to databases that support JDBC (Java Database Connectivity). + +- [Web Services Connector](https://documentation.sailpoint.com/connectors/webservices/help/integrating_webservices/introduction.html): This connector can directly connect to databases that support Web Services. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/) for more information about SailPoint's new connectivity framework that makes it easy to build and manage custom connectors to SaaS sources. + +When admins select existing sources, they can view the following information about the source: + +- Associated connections (any associated identity profiles, apps, or references to the source in a transform). + +- Associated user accounts. These accounts are linked to their identities - this provides a more complete picture of each user's access across sources. + +- Associated entitlements (sets of access rights on sources). + +- Associated access profiles (groupings of entitlements). + +The user account data and the entitlements update with each data aggregation from the source. +Organizations generally run scheduled, automated data aggregations to ensure that their data is always in sync between their sources and their Identity Security Cloud tenants so an access change on a source is detected quickly in Identity Security Cloud. +Admins can view a history of these aggregations, and they can also run manual imports. +Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about manual and scheduled aggregations. + +Admins can also make changes to determine which user account data Identity Security Cloud collects from the source and how it correlates that account data with identity data. +To define which account attributes the source shares with Identity Security Cloud, admins can edit the account schema on the source. +Refer to [Managing Source Account Schemas](https://documentation.sailpoint.com/saas/help/accounts/schema.html) for more information about source account schemas and how to edit them. +To define the mapping between the source account attributes and their correlating identity attributes, admins can edit the correlation configuration on the source. +Refer to [Assigning Source Accounts to Identities](https://documentation.sailpoint.com/saas/help/accounts/correlation.html) for more information about this correlation process between source accounts and identities. + +Admins can also delete sources, but they must first ensure that the sources no longer have any active connections: the source must not be associated with any identity profile or any app, and it must not be referenced by any transform. +Refer to [Deleting Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html#deleting-sources) for more information about deleting sources. + +Well organized, mapped out connections between sources and Identity Security Cloud are essential to achieving comprehensive identity access governance across all the source systems organizations need. +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about all the different things admins can do with sources once they are connected. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024ProvisioningPolicy**](#create-provisioning-policy) | **POST** `/sources/{sourceId}/provisioning-policies` | Create Provisioning Policy +[**New-V2024Source**](#create-source) | **POST** `/sources` | Creates a source in IdentityNow. +[**New-V2024SourceSchedule**](#create-source-schedule) | **POST** `/sources/{sourceId}/schedules` | Create Schedule on Source +[**New-V2024SourceSchema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create Schema on Source +[**Remove-V2024AccountsAsync**](#delete-accounts-async) | **POST** `/sources/{id}/remove-accounts` | Remove All Accounts in a Source +[**Remove-V2024NativeChangeDetectionConfig**](#delete-native-change-detection-config) | **DELETE** `/sources/{sourceId}/native-change-detection-config` | Delete Native Change Detection Configuration +[**Remove-V2024ProvisioningPolicy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete Provisioning Policy by UsageType +[**Remove-V2024Source**](#delete-source) | **DELETE** `/sources/{id}` | Delete Source by ID +[**Remove-V2024SourceSchedule**](#delete-source-schedule) | **DELETE** `/sources/{sourceId}/schedules/{scheduleType}` | Delete Source Schedule by type. +[**Remove-V2024SourceSchema**](#delete-source-schema) | **DELETE** `/sources/{sourceId}/schemas/{schemaId}` | Delete Source Schema by ID +[**Get-V2024AccountsSchema**](#get-accounts-schema) | **GET** `/sources/{id}/schemas/accounts` | Downloads source accounts schema template +[**Get-V2024CorrelationConfig**](#get-correlation-config) | **GET** `/sources/{id}/correlation-config` | Get Source Correlation Configuration +[**Get-V2024EntitlementsSchema**](#get-entitlements-schema) | **GET** `/sources/{id}/schemas/entitlements` | Downloads source entitlements schema template +[**Get-V2024NativeChangeDetectionConfig**](#get-native-change-detection-config) | **GET** `/sources/{sourceId}/native-change-detection-config` | Native Change Detection Configuration +[**Get-V2024ProvisioningPolicy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType +[**Get-V2024Source**](#get-source) | **GET** `/sources/{id}` | Get Source by ID +[**Get-V2024SourceAttrSyncConfig**](#get-source-attr-sync-config) | **GET** `/sources/{id}/attribute-sync-config` | Attribute Sync Config +[**Get-V2024SourceConfig**](#get-source-config) | **GET** `/sources/{id}/connectors/source-config` | Gets source config with language translations +[**Get-V2024SourceEntitlementRequestConfig**](#get-source-entitlement-request-config) | **GET** `/sources/{id}/entitlement-request-config` | Get Source Entitlement Request Configuration +[**Get-V2024SourceHealth**](#get-source-health) | **GET** `/sources/{sourceId}/source-health` | Fetches source health by id +[**Get-V2024SourceSchedule**](#get-source-schedule) | **GET** `/sources/{sourceId}/schedules/{scheduleType}` | Get Source Schedule by Type +[**Get-V2024SourceSchedules**](#get-source-schedules) | **GET** `/sources/{sourceId}/schedules` | List Schedules on Source +[**Get-V2024SourceSchema**](#get-source-schema) | **GET** `/sources/{sourceId}/schemas/{schemaId}` | Get Source Schema by ID +[**Get-V2024SourceSchemas**](#get-source-schemas) | **GET** `/sources/{sourceId}/schemas` | List Schemas on Source +[**Import-V2024Accounts**](#import-accounts) | **POST** `/sources/{id}/load-accounts` | Account Aggregation +[**Import-V2024AccountsSchema**](#import-accounts-schema) | **POST** `/sources/{id}/schemas/accounts` | Uploads source accounts schema template +[**Import-V2024ConnectorFile**](#import-connector-file) | **POST** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source +[**Import-V2024EntitlementsSchema**](#import-entitlements-schema) | **POST** `/sources/{id}/schemas/entitlements` | Uploads source entitlements schema template +[**Import-V2024UncorrelatedAccounts**](#import-uncorrelated-accounts) | **POST** `/sources/{id}/load-uncorrelated-accounts` | Process Uncorrelated Accounts +[**Get-V2024ProvisioningPolicies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies +[**Get-V2024Sources**](#list-sources) | **GET** `/sources` | Lists all sources in IdentityNow. +[**Receive-V2024ResourceObjects**](#peek-resource-objects) | **POST** `/sources/{sourceId}/connector/peek-resource-objects` | Peek source connector's resource objects +[**Ping-V2024Cluster**](#ping-cluster) | **POST** `/sources/{sourceId}/connector/ping-cluster` | Ping cluster for source connector +[**Send-V2024CorrelationConfig**](#put-correlation-config) | **PUT** `/sources/{id}/correlation-config` | Update Source Correlation Configuration +[**Send-V2024NativeChangeDetectionConfig**](#put-native-change-detection-config) | **PUT** `/sources/{sourceId}/native-change-detection-config` | Update Native Change Detection Configuration +[**Send-V2024ProvisioningPolicy**](#put-provisioning-policy) | **PUT** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update Provisioning Policy by UsageType +[**Send-V2024Source**](#put-source) | **PUT** `/sources/{id}` | Update Source (Full) +[**Send-V2024SourceAttrSyncConfig**](#put-source-attr-sync-config) | **PUT** `/sources/{id}/attribute-sync-config` | Update Attribute Sync Config +[**Send-V2024SourceSchema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full) +[**Sync-V2024AttributesForSource**](#sync-attributes-for-source) | **POST** `/sources/{id}/synchronize-attributes` | Synchronize single source attributes. +[**Test-V2024SourceConfiguration**](#test-source-configuration) | **POST** `/sources/{sourceId}/connector/test-configuration` | Test configuration for source connector +[**Test-V2024SourceConnection**](#test-source-connection) | **POST** `/sources/{sourceId}/connector/check-connection` | Check connection for source connector. +[**Update-V2024PasswordPolicyHolders**](#update-password-policy-holders) | **PATCH** `/sources/{sourceId}/password-policies` | Update Password Policy +[**Update-V2024ProvisioningPoliciesInBulk**](#update-provisioning-policies-in-bulk) | **POST** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk Update Provisioning Policies +[**Update-V2024ProvisioningPolicy**](#update-provisioning-policy) | **PATCH** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of Provisioning Policy +[**Update-V2024Source**](#update-source) | **PATCH** `/sources/{id}` | Update Source (Partial) +[**Update-V2024SourceEntitlementRequestConfig**](#update-source-entitlement-request-config) | **PUT** `/sources/{id}/entitlement-request-config` | Update Source Entitlement Request Configuration +[**Update-V2024SourceSchedule**](#update-source-schedule) | **PATCH** `/sources/{sourceId}/schedules/{scheduleType}` | Update Source Schedule (Partial) +[**Update-V2024SourceSchema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial) + +## create-provisioning-policy +This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id + Body | ProvisioningPolicyDto | [**ProvisioningPolicyDto**](../models/provisioning-policy-dto) | True | + +### Return type +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Created ProvisioningPolicyDto object | ProvisioningPolicyDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id +$ProvisioningPolicyDto = @"{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" +}"@ + +# Create Provisioning Policy + +try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + New-V2024ProvisioningPolicy-V2024SourceId $SourceId -V2024ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # New-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024ProvisioningPolicyDto $ProvisioningPolicyDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-source +This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Source | [**Source**](../models/source) | True | + Query | ProvisionAsCsv | **Boolean** | (optional) | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Created Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design. | Source +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Source = @"{ + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" +}"@ +$ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) + +# Creates a source in IdentityNow. + +try { + $Result = ConvertFrom-JsonToSource -Json $Source + New-V2024Source-V2024Source $Result + + # Below is a request that includes all optional parameters + # New-V2024Source -V2024Source $Source -V2024ProvisionAsCsv $ProvisionAsCsv +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Source" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-source-schedule +Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC). + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | Source ID. + Body | Schedule1 | [**Schedule1**](../models/schedule1) | True | + +### Return type +[**Schedule1**](../models/schedule1) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | The schedule was successfully created on the specified source. | Schedule1 +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. +$Schedule1 = @""@ + +# Create Schedule on Source + +try { + $Result = ConvertFrom-JsonToSchedule1 -Json $Schedule1 + New-V2024SourceSchedule-V2024SourceId $SourceId -V2024Schedule1 $Result + + # Below is a request that includes all optional parameters + # New-V2024SourceSchedule -V2024SourceId $SourceId -V2024Schedule1 $Schedule1 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceSchedule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-source-schema +Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | Source ID. + Body | Schema | [**Schema**](../models/schema) | True | + +### Return type +[**Schema**](../models/schema) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | The schema was successfully created on the specified source. | Schema +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. +$Schema = @"{ + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" +}"@ + +# Create Schema on Source + +try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + New-V2024SourceSchema-V2024SourceId $SourceId -V2024Schema $Result + + # Below is a request that includes all optional parameters + # New-V2024SourceSchema -V2024SourceId $SourceId -V2024Schema $Schema +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-accounts-async +Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. + +This endpoint is good for: +* Removing accounts that no longer exist on the source. +* Removing accounts that won't be aggregated following updates to the source configuration. +* Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The source id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**TaskResultDto**](../models/task-result-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted. Returns task result details of removal request. | TaskResultDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ebbf35756e1140699ce52b233121384a" # String | The source id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Remove All Accounts in a Source + +try { + Remove-V2024AccountsAsync-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024AccountsAsync -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountsAsync" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-native-change-detection-config +Deletes the native change detection configuration for the source specified by the given ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The source id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Delete Native Change Detection Configuration + +try { + Remove-V2024NativeChangeDetectionConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024NativeChangeDetectionConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NativeChangeDetectionConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-provisioning-policy +Deletes the provisioning policy with the specified usage on an application. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source ID. +Path | UsageType | [**UsageType**](../models/usage-type) | True | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. +$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + +# Delete Provisioning Policy by UsageType + +try { + Remove-V2024ProvisioningPolicy-V2024SourceId $SourceId -V2024UsageType $UsageType + + # Below is a request that includes all optional parameters + # Remove-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024UsageType $UsageType +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-source +Use this API to delete a specific source in Identity Security Cloud (ISC). +The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source ID. + +### Return type +[**DeleteSource202Response**](../models/delete-source202-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | DeleteSource202Response +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + +# Delete Source by ID + +try { + Remove-V2024Source-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Source -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Source" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-source-schedule + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id. +Path | ScheduleType | **String** | True | The Schedule type. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. +$ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. + +# Delete Source Schedule by type. + +try { + Remove-V2024SourceSchedule-V2024SourceId $SourceId -V2024ScheduleType $ScheduleType + + # Below is a request that includes all optional parameters + # Remove-V2024SourceSchedule -V2024SourceId $SourceId -V2024ScheduleType $ScheduleType +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceSchedule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-source-schema + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id. +Path | SchemaId | **String** | True | The Schema id. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. +$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + +# Delete Source Schema by ID + +try { + Remove-V2024SourceSchema-V2024SourceId $SourceId -V2024SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Remove-V2024SourceSchema -V2024SourceId $SourceId -V2024SchemaId $SchemaId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-accounts-schema +This API downloads the CSV schema that defines the account attributes on a source. +>**NOTE: This API is designated only for Delimited File sources.** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The Source id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully downloaded the file | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: text/csv, application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + +# Downloads source accounts schema template + +try { + Get-V2024AccountsSchema-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccountsSchema -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountsSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-correlation-config +This API returns the existing correlation configuration for a source specified by the given ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The source id + +### Return type +[**CorrelationConfig**](../models/correlation-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Correlation configuration for a source | CorrelationConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + +# Get Source Correlation Configuration + +try { + Get-V2024CorrelationConfig-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CorrelationConfig -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CorrelationConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-entitlements-schema +This API downloads the CSV schema that defines the entitlement attributes on a source. + +>**NOTE: This API is designated only for Delimited File sources.** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The Source id + Query | SchemaName | **String** | (optional) | Name of entitlement schema + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully downloaded the file | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: text/csv, application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id +$SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + +# Downloads source entitlements schema template + +try { + Get-V2024EntitlementsSchema-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementsSchema -V2024Id $Id -V2024SchemaName $SchemaName +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementsSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-native-change-detection-config +This API returns the existing native change detection configuration for a source specified by the given ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The source id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**NativeChangeDetectionConfig**](../models/native-change-detection-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Native change detection configuration for a source | NativeChangeDetectionConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Native Change Detection Configuration + +try { + Get-V2024NativeChangeDetectionConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NativeChangeDetectionConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NativeChangeDetectionConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-provisioning-policy +This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source ID. +Path | UsageType | [**UsageType**](../models/usage-type) | True | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + +### Return type +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The requested ProvisioningPolicyDto was successfully retrieved. | ProvisioningPolicyDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. +$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + +# Get Provisioning Policy by UsageType + +try { + Get-V2024ProvisioningPolicy-V2024SourceId $SourceId -V2024UsageType $UsageType + + # Below is a request that includes all optional parameters + # Get-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024UsageType $UsageType +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-source +Use this API to get a source by a specified ID in Identity Security Cloud (ISC). + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source ID. + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Source object. | Source +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + +# Get Source by ID + +try { + Get-V2024Source-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Source -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Source" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-source-attr-sync-config +This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The source id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**AttrSyncSourceConfig**](../models/attr-sync-source-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Attribute synchronization configuration for a source | AttrSyncSourceConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Attribute Sync Config + +try { + Get-V2024SourceAttrSyncConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SourceAttrSyncConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceAttrSyncConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-source-config +Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The Source id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Locale | **String** | (optional) | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + +### Return type +[**ConnectorDetail1**](../models/connector-detail1) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A Connector Detail object | ConnectorDetail1 +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "MyId" # String | The Source id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + +# Gets source config with language translations + +try { + Get-V2024SourceConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SourceConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Locale $Locale +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-source-entitlement-request-config +This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. + +Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. +- During access request, this source-level entitlement request configuration overrides the global organization-level configuration. +- However, the entitlement-level configuration (if defined) overrides this source-level configuration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**SourceEntitlementRequestConfig**](../models/source-entitlement-request-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Source Entitlement Request Configuration Details. | SourceEntitlementRequestConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get Source Entitlement Request Configuration + +try { + Get-V2024SourceEntitlementRequestConfig-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SourceEntitlementRequestConfig -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceEntitlementRequestConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-source-health +This endpoint fetches source health by source's id + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id. + +### Return type +[**SourceHealthDto**](../models/source-health-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Fetched source health successfully | SourceHealthDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + +# Fetches source health by id + +try { + Get-V2024SourceHealth-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024SourceHealth -V2024SourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceHealth" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-source-schedule +Get the source schedule by type in Identity Security Cloud (ISC). + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id. +Path | ScheduleType | **String** | True | The Schedule type. + +### Return type +[**Schedule1**](../models/schedule1) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The requested Schedule was successfully retrieved. | Schedule1 +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. +$ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. + +# Get Source Schedule by Type + +try { + Get-V2024SourceSchedule-V2024SourceId $SourceId -V2024ScheduleType $ScheduleType + + # Below is a request that includes all optional parameters + # Get-V2024SourceSchedule -V2024SourceId $SourceId -V2024ScheduleType $ScheduleType +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchedule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-source-schedules +Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC). + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | Source ID. + +### Return type +[**Schedule1[]**](../models/schedule1) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The schedules were successfully retrieved. | Schedule1[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + +# List Schedules on Source + +try { + Get-V2024SourceSchedules-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024SourceSchedules -V2024SourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchedules" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-source-schema +Get the Source Schema by ID in IdentityNow. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id. +Path | SchemaId | **String** | True | The Schema id. + +### Return type +[**Schema**](../models/schema) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The requested Schema was successfully retrieved. | Schema +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. +$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + +# Get Source Schema by ID + +try { + Get-V2024SourceSchema-V2024SourceId $SourceId -V2024SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Get-V2024SourceSchema -V2024SourceId $SourceId -V2024SchemaId $SchemaId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-source-schemas +Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | Source ID. + Query | IncludeTypes | **String** | (optional) | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. + Query | IncludeNames | **String** | (optional) | A comma-separated list of schema names to filter result. + +### Return type +[**Schema[]**](../models/schema) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The schemas were successfully retrieved. | Schema[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. +$IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) +$IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional) + +# List Schemas on Source + +try { + Get-V2024SourceSchemas-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024SourceSchemas -V2024SourceId $SourceId -V2024IncludeTypes $IncludeTypes -V2024IncludeNames $IncludeNames +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchemas" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-accounts +Starts an account aggregation on the specified source. +If the target source is a delimited file source, then the CSV file needs to be included in the request body. +You will also need to set the Content-Type header to `multipart/form-data`. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source Id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + | File | **System.IO.FileInfo** | (optional) | The CSV file containing the source accounts to aggregate. + | DisableOptimization | **String** | (optional) | Use this flag to reprocess every account whether or not the data has changed. + +### Return type +[**LoadAccountsTask**](../models/load-accounts-task) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Aggregate Accounts Task | LoadAccountsTask +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) +$DisableOptimization = "MyDisableOptimization" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) + +# Account Aggregation + +try { + Import-V2024Accounts-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Import-V2024Accounts -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024File $File -V2024DisableOptimization $DisableOptimization +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024Accounts" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-accounts-schema +This API uploads a source schema template file to configure a source's account attributes. + +To retrieve the file to modify and upload, log into Identity Now. + +Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** + +>**NOTE: This API is designated only for Delimited File sources.** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The Source id + | File | **System.IO.FileInfo** | (optional) | + +### Return type +[**Schema**](../models/schema) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully uploaded the file | Schema +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id +$File = # System.IO.FileInfo | (optional) + +# Uploads source accounts schema template + +try { + Import-V2024AccountsSchema-V2024Id $Id + + # Below is a request that includes all optional parameters + # Import-V2024AccountsSchema -V2024Id $Id -V2024File $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024AccountsSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-connector-file +This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id. + | File | **System.IO.FileInfo** | (optional) | + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Uploaded the file successfully and sent all post-upload events | Source +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. +$File = # System.IO.FileInfo | (optional) + +# Upload connector file to source + +try { + Import-V2024ConnectorFile-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-V2024ConnectorFile -V2024SourceId $SourceId -V2024File $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024ConnectorFile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-entitlements-schema +This API uploads a source schema template file to configure a source's entitlement attributes. + +To retrieve the file to modify and upload, log into Identity Now. + +Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** + +>**NOTE: This API is designated only for Delimited File sources.** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The Source id + Query | SchemaName | **String** | (optional) | Name of entitlement schema + | File | **System.IO.FileInfo** | (optional) | + +### Return type +[**Schema**](../models/schema) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully uploaded the file | Schema +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id +$SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) +$File = # System.IO.FileInfo | (optional) + +# Uploads source entitlements schema template + +try { + Import-V2024EntitlementsSchema-V2024Id $Id + + # Below is a request that includes all optional parameters + # Import-V2024EntitlementsSchema -V2024Id $Id -V2024SchemaName $SchemaName -V2024File $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024EntitlementsSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-uncorrelated-accounts +File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source Id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + | File | **System.IO.FileInfo** | (optional) | + +### Return type +[**LoadUncorrelatedAccountsTask**](../models/load-uncorrelated-accounts-task) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Uncorrelated Accounts Task | LoadUncorrelatedAccountsTask +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$Id = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$File = # System.IO.FileInfo | (optional) + +# Process Uncorrelated Accounts + +try { + Import-V2024UncorrelatedAccounts-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Import-V2024UncorrelatedAccounts -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024File $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024UncorrelatedAccounts" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-provisioning-policies +This end-point lists all the ProvisioningPolicies in IdentityNow. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id + +### Return type +[**ProvisioningPolicyDto[]**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of ProvisioningPolicyDto objects | ProvisioningPolicyDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + +# Lists ProvisioningPolicies + +try { + Get-V2024ProvisioningPolicies-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024ProvisioningPolicies -V2024SourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProvisioningPolicies" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-sources +This end-point lists all the sources in IdentityNow. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** + Query | ForSubadmin | **String** | (optional) | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. + Query | IncludeIDNSource | **Boolean** | (optional) (default to $false) | Include the IdentityNow source in the response. + +### Return type +[**Source[]**](../models/source) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Source objects | Source[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'name eq "Employees"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) +$ForSubadmin = "name" # String | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) +$IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false) + +# Lists all sources in IdentityNow. + +try { + Get-V2024Sources + + # Below is a request that includes all optional parameters + # Get-V2024Sources -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters -V2024ForSubadmin $ForSubadmin -V2024IncludeIDNSource $IncludeIDNSource +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Sources" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## peek-resource-objects +Retrieves a sample of data returned from account and group aggregation requests. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The ID of the Source + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | ResourceObjectsRequest | [**ResourceObjectsRequest**](../models/resource-objects-request) | True | + +### Return type +[**ResourceObjectsResponse**](../models/resource-objects-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of resource objects that was fetched from the source connector. | ResourceObjectsResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$ResourceObjectsRequest = @"{ + "maxCount" : 100, + "objectType" : "group" +}"@ + +# Peek source connector's resource objects + +try { + $Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest + Receive-V2024ResourceObjects-V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental -V2024ResourceObjectsRequest $Result + + # Below is a request that includes all optional parameters + # Receive-V2024ResourceObjects -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental -V2024ResourceObjectsRequest $ResourceObjectsRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Receive-V2024ResourceObjects" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## ping-cluster +This endpoint validates that the cluster being used by the source is reachable from IdentityNow. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The ID of the Source + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**StatusResponse**](../models/status-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The result of pinging connection with the source connector. | StatusResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Ping cluster for source connector + +try { + Ping-V2024Cluster-V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Ping-V2024Cluster -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-V2024Cluster" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-correlation-config +Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The source id + Body | CorrelationConfig | [**CorrelationConfig**](../models/correlation-config) | True | + +### Return type +[**CorrelationConfig**](../models/correlation-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated correlation configuration for a source | CorrelationConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id +$CorrelationConfig = @"{ + "attributeAssignments" : [ { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + }, { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + } ], + "name" : "Source [source] Account Correlation", + "id" : "2c9180835d191a86015d28455b4a2329" +}"@ + +# Update Source Correlation Configuration + +try { + $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig + Send-V2024CorrelationConfig-V2024Id $Id -V2024CorrelationConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024CorrelationConfig -V2024Id $Id -V2024CorrelationConfig $CorrelationConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024CorrelationConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-native-change-detection-config +Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The source id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | NativeChangeDetectionConfig | [**NativeChangeDetectionConfig**](../models/native-change-detection-config) | True | + +### Return type +[**NativeChangeDetectionConfig**](../models/native-change-detection-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated native change detection configuration for a source | NativeChangeDetectionConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$NativeChangeDetectionConfig = @"{ + "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], + "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], + "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], + "allNonEntitlementAttributes" : false, + "allEntitlements" : false, + "enabled" : true +}"@ + +# Update Native Change Detection Configuration + +try { + $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig + Send-V2024NativeChangeDetectionConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024NativeChangeDetectionConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024NativeChangeDetectionConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024NativeChangeDetectionConfig $NativeChangeDetectionConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024NativeChangeDetectionConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-provisioning-policy +This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source ID. +Path | UsageType | [**UsageType**](../models/usage-type) | True | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + Body | ProvisioningPolicyDto | [**ProvisioningPolicyDto**](../models/provisioning-policy-dto) | True | + +### Return type +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The ProvisioningPolicyDto was successfully replaced. | ProvisioningPolicyDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. +$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. +$ProvisioningPolicyDto = @"{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" +}"@ + +# Update Provisioning Policy by UsageType + +try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Send-V2024ProvisioningPolicy-V2024SourceId $SourceId -V2024UsageType $UsageType -V2024ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Send-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024UsageType $UsageType -V2024ProvisioningPolicyDto $ProvisioningPolicyDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-source +Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. + +These fields are immutable, so they cannot be changed: + +* id +* type +* authoritative +* connector +* connectorClass +* passwordPolicies + +Attempts to modify these fields will result in a 400 error. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source ID. + Body | Source | [**Source**](../models/source) | True | + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated Source object. Any passwords will only show the the encrypted cipher-text so that they aren't decryptable in Identity Security Cloud (ISC) cloud-based services, per ISC security design. | Source +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. +$Source = @"{ + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" +}"@ + +# Update Source (Full) + +try { + $Result = ConvertFrom-JsonToSource -Json $Source + Send-V2024Source-V2024Id $Id -V2024Source $Result + + # Below is a request that includes all optional parameters + # Send-V2024Source -V2024Id $Id -V2024Source $Source +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Source" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-source-attr-sync-config +Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the "enabled" field of the values in the "attributes" array is mutable. Attempting to change other attributes or add new values to the "attributes" array will result in an error. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The source id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | AttrSyncSourceConfig | [**AttrSyncSourceConfig**](../models/attr-sync-source-config) | True | + +### Return type +[**AttrSyncSourceConfig**](../models/attr-sync-source-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated attribute synchronization configuration for a source | AttrSyncSourceConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$AttrSyncSourceConfig = @"{ + "attributes" : [ { + "name" : "email", + "displayName" : "Email", + "enabled" : true, + "target" : "mail" + }, { + "name" : "firstname", + "displayName" : "First Name", + "enabled" : false, + "target" : "givenName" + } ], + "source" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + } +}"@ + +# Update Attribute Sync Config + +try { + $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig + Send-V2024SourceAttrSyncConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024AttrSyncSourceConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024SourceAttrSyncConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024AttrSyncSourceConfig $AttrSyncSourceConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SourceAttrSyncConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-source-schema +This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. + +* id +* name +* created +* modified + +Any attempt to modify these fields will result in an error response with a status code of 400. + +> `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id. +Path | SchemaId | **String** | True | The Schema id. + Body | Schema | [**Schema**](../models/schema) | True | + +### Return type +[**Schema**](../models/schema) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Schema was successfully replaced. | Schema +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. +$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. +$Schema = @"{ + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" +}"@ + +# Update Source Schema (Full) + +try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + Send-V2024SourceSchema-V2024SourceId $SourceId -V2024SchemaId $SchemaId -V2024Schema $Result + + # Below is a request that includes all optional parameters + # Send-V2024SourceSchema -V2024SourceId $SourceId -V2024SchemaId $SchemaId -V2024Schema $Schema +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SourceSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## sync-attributes-for-source +This end-point performs attribute synchronization for a selected source. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The Source id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**SourceSyncJob**](../models/source-sync-job) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | A Source Sync job | SourceSyncJob +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "MyId" # String | The Source id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Synchronize single source attributes. + +try { + Sync-V2024AttributesForSource-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Sync-V2024AttributesForSource -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024AttributesForSource" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## test-source-configuration +This endpoint performs a more detailed validation of the source''s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The ID of the Source + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**StatusResponse**](../models/status-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The result of testing source connector configuration with response from it. | StatusResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Test configuration for source connector + +try { + Test-V2024SourceConfiguration-V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Test-V2024SourceConfiguration -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SourceConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## test-source-connection +This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The ID of the Source. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**StatusResponse**](../models/status-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The result of checking connection to the source connector with response from it. | StatusResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Check connection for source connector. + +try { + Test-V2024SourceConnection-V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Test-V2024SourceConnection -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SourceConnection" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-password-policy-holders +This API can be used to set up or update Password Policy in IdentityNow for the specified Source. +Source must support PASSWORD feature. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id + Body | PasswordPolicyHoldersDtoInner | [**[]PasswordPolicyHoldersDtoInner**](../models/password-policy-holders-dto-inner) | True | + +### Return type +[**PasswordPolicyHoldersDtoInner[]**](../models/password-policy-holders-dto-inner) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated Password Policies | PasswordPolicyHoldersDtoInner[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $PasswordPolicyHoldersDtoInner = @""@ # PasswordPolicyHoldersDtoInner[] | + + +# Update Password Policy + +try { + $Result = ConvertFrom-JsonToPasswordPolicyHoldersDtoInner -Json $PasswordPolicyHoldersDtoInner + Update-V2024PasswordPolicyHolders-V2024SourceId $SourceId -V2024PasswordPolicyHoldersDtoInner $Result + + # Below is a request that includes all optional parameters + # Update-V2024PasswordPolicyHolders -V2024SourceId $SourceId -V2024PasswordPolicyHoldersDtoInner $PasswordPolicyHoldersDtoInner +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PasswordPolicyHolders" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-provisioning-policies-in-bulk +This end-point updates a list of provisioning policies on the specified source in IdentityNow. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id. + Body | ProvisioningPolicyDto | [**[]ProvisioningPolicyDto**](../models/provisioning-policy-dto) | True | + +### Return type +[**ProvisioningPolicyDto[]**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of the ProvisioningPolicyDto was successfully replaced. | ProvisioningPolicyDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ProvisioningPolicyDto = @"{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" +}"@ # ProvisioningPolicyDto[] | + + +# Bulk Update Provisioning Policies + +try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Update-V2024ProvisioningPoliciesInBulk-V2024SourceId $SourceId -V2024ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Update-V2024ProvisioningPoliciesInBulk -V2024SourceId $SourceId -V2024ProvisioningPolicyDto $ProvisioningPolicyDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPoliciesInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-provisioning-policy +This API selectively updates an existing Provisioning Policy using a JSONPatch payload. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id. +Path | UsageType | [**UsageType**](../models/usage-type) | True | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the schema. + +### Return type +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The ProvisioningPolicyDto was successfully updated. | ProvisioningPolicyDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. +$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | The JSONPatch payload used to update the schema. + + +# Partial update of Provisioning Policy + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ProvisioningPolicy-V2024SourceId $SourceId -V2024UsageType $UsageType -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024UsageType $UsageType -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-source +Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the +[JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +These fields are immutable, so they cannot be changed: + +* id +* type +* authoritative +* created +* modified +* connector +* connectorClass +* passwordPolicies + +Attempts to modify these fields will result in a 400 error. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source ID. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated Source object. Any passwords will only show the the encrypted cipher-text so that they aren't decryptable in Identity Security Cloud (ISC) cloud-based services, per ISC security design. | Source +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). + + +# Update Source (Partial) + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Source-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Source -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Source" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-source-entitlement-request-config +This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. + +Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. +- During access request, this source-level entitlement request configuration overrides the global organization-level configuration. +- However, the entitlement-level configuration (if defined) overrides this source-level configuration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | SourceEntitlementRequestConfig | [**SourceEntitlementRequestConfig**](../models/source-entitlement-request-config) | True | + +### Return type +[**SourceEntitlementRequestConfig**](../models/source-entitlement-request-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Source Entitlement Request Configuration Details. | SourceEntitlementRequestConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$SourceEntitlementRequestConfig = @"{ + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } +}"@ + +# Update Source Entitlement Request Configuration + +try { + $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig + Update-V2024SourceEntitlementRequestConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024SourceEntitlementRequestConfig $Result + + # Below is a request that includes all optional parameters + # Update-V2024SourceEntitlementRequestConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024SourceEntitlementRequestConfig $SourceEntitlementRequestConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceEntitlementRequestConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-source-schedule +Use this API to selectively update an existing Schedule using a JSONPatch payload. + +The following schedule fields are immutable and cannot be updated: + +- type + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id. +Path | ScheduleType | **String** | True | The Schedule type. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the schedule. + +### Return type +[**Schedule1**](../models/schedule1) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Schedule was successfully updated. | Schedule1 +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. +$ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | The JSONPatch payload used to update the schedule. + + +# Update Source Schedule (Partial) + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SourceSchedule-V2024SourceId $SourceId -V2024ScheduleType $ScheduleType -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SourceSchedule -V2024SourceId $SourceId -V2024ScheduleType $ScheduleType -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchedule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-source-schema +Use this API to selectively update an existing Schema using a JSONPatch payload. + +The following schema fields are immutable and cannot be updated: + +- id +- name +- created +- modified + + +To switch an account attribute to a group entitlement, you need to have the following in place: + +- `isEntitlement: true` +- Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: +```json +{ + "name": "groups", + "type": "STRING", + "schema": { + "type": "CONNECTOR_SCHEMA", + "id": "2c9180887671ff8c01767b4671fc7d60", + "name": "group" + }, + "description": "The groups, roles etc. that reference account group objects", + "isMulti": true, + "isEntitlement": true, + "isGroup": true +} +``` + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id. +Path | SchemaId | **String** | True | The Schema id. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the schema. + +### Return type +[**Schema**](../models/schema) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Schema was successfully updated. | Schema +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. +$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | The JSONPatch payload used to update the schema. + + +# Update Source Schema (Partial) + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SourceSchema-V2024SourceId $SourceId -V2024SchemaId $SchemaId -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SourceSchema -V2024SourceId $SourceId -V2024SchemaId $SchemaId -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SuggestedEntitlementDescriptionApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SuggestedEntitlementDescriptionApi.md new file mode 100644 index 000000000..b8b429fb2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024SuggestedEntitlementDescriptionApi.md @@ -0,0 +1,400 @@ + +--- +id: v2024-suggested-entitlement-description +title: SuggestedEntitlementDescription +pagination_label: SuggestedEntitlementDescription +sidebar_label: SuggestedEntitlementDescription +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SuggestedEntitlementDescription', 'V2024SuggestedEntitlementDescription'] +slug: /tools/sdk/powershell/v2024/methods/suggested-entitlement-description +tags: ['SDK', 'Software Development Kit', 'SuggestedEntitlementDescription', 'V2024SuggestedEntitlementDescription'] +--- + +# SuggestedEntitlementDescription + Use this API to implement Suggested Entitlement Description (SED) functionality. +SED functionality leverages the power of LLM to generate suggested entitlement descriptions. +Refer to [GenAI Entitlement Descriptions](https://documentation.sailpoint.com/saas/help/access/entitlements.html#genai-entitlement-descriptions) to learn more about SED in Identity Security Cloud (ISC). + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024SedBatchStats**](#get-sed-batch-stats) | **GET** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit Sed Batch Stats Request +[**Get-V2024SedBatches**](#get-sed-batches) | **GET** `/suggested-entitlement-description-batches` | List Sed Batch Request +[**Get-V2024Seds**](#list-seds) | **GET** `/suggested-entitlement-descriptions` | List Suggested Entitlement Descriptions +[**Update-V2024Sed**](#patch-sed) | **PATCH** `/suggested-entitlement-descriptions` | Patch Suggested Entitlement Description +[**Submit-V2024SedApproval**](#submit-sed-approval) | **POST** `/suggested-entitlement-description-approvals` | Submit Bulk Approval Request +[**Submit-V2024SedAssignment**](#submit-sed-assignment) | **POST** `/suggested-entitlement-description-assignments` | Submit Sed Assignment Request +[**Submit-V2024SedBatchRequest**](#submit-sed-batch-request) | **POST** `/suggested-entitlement-description-batches` | Submit Sed Batch Request + +## get-sed-batch-stats +'Submit Sed Batch Stats Request. + + Submits batchId in the path param `(e.g. {batchId}/stats)`. API responses with stats + of the batchId.' + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | BatchId | **String** | True | Batch Id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**SedBatchStats**](../models/sed-batch-stats) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Stats of Sed batch. | SedBatchStats +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Submit Sed Batch Stats Request + +try { + Get-V2024SedBatchStats-V2024BatchId $BatchId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SedBatchStats -V2024BatchId $BatchId -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatchStats" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sed-batches +List Sed Batches. +API responses with Sed Batch Status + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**SedBatchStatus**](../models/sed-batch-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Status of batch | SedBatchStatus +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# List Sed Batch Request + +try { + Get-V2024SedBatches-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SedBatches -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatches" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-seds +List of Suggested Entitlement Descriptions (SED) + +SED field descriptions: + +**batchId**: the ID of the batch of entitlements that are submitted for description generation + +**displayName**: the display name of the entitlement that we are generating a description for + +**sourceName**: the name of the source associated with the entitlement that we are generating the description for + +**sourceId**: the ID of the source associated with the entitlement that we are generating the description for + +**status**: the status of the suggested entitlement description, valid status options: "requested", "suggested", "not_suggested", "failed", "assigned", "approved", "denied" + +**fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int64** | (optional) | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** + Query | Count | **Boolean** | (optional) | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. + Query | CountOnly | **Boolean** | (optional) | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. + Query | RequestedByAnyone | **Boolean** | (optional) | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested + Query | ShowPendingStatusOnly | **Boolean** | (optional) | Will limit records to items that are in ""suggested"" or ""approved"" status + +### Return type +[**Sed[]**](../models/sed) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Suggested Entitlement Details | Sed[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = limit=25 # Int64 | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) +$Filters = 'displayName co "Read and Write"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) +$Sorters = "sorters=displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) +$Count = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) +$CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) +$RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) +$ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) + +# List Suggested Entitlement Descriptions + +try { + Get-V2024Seds-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Seds -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Filters $Filters -V2024Sorters $Sorters -V2024Count $Count -V2024CountOnly $CountOnly -V2024RequestedByAnyone $RequestedByAnyone -V2024ShowPendingStatusOnly $ShowPendingStatusOnly +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Seds" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-sed +Patch Suggested Entitlement Description + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | id is sed id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | SedPatch | [**[]SedPatch**](../models/sed-patch) | True | Sed Patch Request + +### Return type +[**Sed**](../models/sed) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | detail of patched sed | Sed +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SedPatch = @"{ + "op" : "replace", + "path" : "status", + "value" : "approved" +}"@ # SedPatch[] | Sed Patch Request + + +# Patch Suggested Entitlement Description + +try { + $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch + Update-V2024Sed-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SedPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024Sed -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SedPatch $SedPatch +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Sed" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## submit-sed-approval +Submit Bulk Approval Request for SED. +Request body takes list of SED Ids. API responses with list of SED Approval Status + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | SedApproval | [**[]SedApproval**](../models/sed-approval) | True | Sed Approval + +### Return type +[**SedApprovalStatus[]**](../models/sed-approval-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of SED Approval Status | SedApprovalStatus[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SedApproval = @"{ + "items" : "016629d1-1d25-463f-97f3-c6686846650" +}"@ # SedApproval[] | Sed Approval + + +# Submit Bulk Approval Request + +try { + $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval + Submit-V2024SedApproval-V2024XSailPointExperimental $XSailPointExperimental -V2024SedApproval $Result + + # Below is a request that includes all optional parameters + # Submit-V2024SedApproval -V2024XSailPointExperimental $XSailPointExperimental -V2024SedApproval $SedApproval +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedApproval" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## submit-sed-assignment +Submit Assignment Request. +Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | SedAssignment | [**SedAssignment**](../models/sed-assignment) | True | Sed Assignment Request + +### Return type +[**SedAssignmentResponse**](../models/sed-assignment-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Sed Assignment Response | SedAssignmentResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$SedAssignment = @"{ + "assignee" : { + "type" : "SOURCE_OWNER", + "value" : "016629d1-1d25-463f-97f3-c6686846650" + }, + "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] +}"@ + +# Submit Sed Assignment Request + +try { + $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment + Submit-V2024SedAssignment-V2024XSailPointExperimental $XSailPointExperimental -V2024SedAssignment $Result + + # Below is a request that includes all optional parameters + # Submit-V2024SedAssignment -V2024XSailPointExperimental $XSailPointExperimental -V2024SedAssignment $SedAssignment +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedAssignment" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## submit-sed-batch-request +Submit Sed Batch Request. +Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | SedBatchRequest | [**SedBatchRequest**](../models/sed-batch-request) | (optional) | Sed Batch Request + +### Return type +[**SedBatchResponse**](../models/sed-batch-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Sed Batch Response | SedBatchResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$SedBatchRequest = @"{ + "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] +}"@ + +# Submit Sed Batch Request + +try { + Submit-V2024SedBatchRequest-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Submit-V2024SedBatchRequest -V2024XSailPointExperimental $XSailPointExperimental -V2024SedBatchRequest $SedBatchRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedBatchRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024TaggedObjectsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024TaggedObjectsApi.md new file mode 100644 index 000000000..d451ed255 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024TaggedObjectsApi.md @@ -0,0 +1,487 @@ + +--- +id: v2024-tagged-objects +title: TaggedObjects +pagination_label: TaggedObjects +sidebar_label: TaggedObjects +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaggedObjects', 'V2024TaggedObjects'] +slug: /tools/sdk/powershell/v2024/methods/tagged-objects +tags: ['SDK', 'Software Development Kit', 'TaggedObjects', 'V2024TaggedObjects'] +--- + +# TaggedObjects + Use this API to implement object tagging functionality. +With object tagging functionality in place, any user in an organization can use tags as a way to group objects together and find them more quickly when the user searches Identity Security Cloud. + +In Identity Security Cloud, users can search their tenants for information and add tags objects they find. +Tagging an object provides users with a way of grouping objects together and makes it easier to find these objects in the future. + +For example, if a user is searching for an entitlement that grants a risky level of access to Active Directory, it's possible that the user may have to search through hundreds of entitlements to find the correct one. +Once the user finds that entitlement, the user can add a tag to the entitlement, "AD_RISKY" to make it easier to find the entitlement again. +The user can add the same tag to multiple objects the user wants to group together for an easy future search, and the user can also do so in bulk. +When the user wants to find that tagged entitlement again, the user can search for "tags:AD_RISKY" to find all objects with that tag. + +With the API, you can tag even more different object types than you can in Identity Security Cloud (access profiles, entitlements, identities, and roles). +You can use the API to tag all these objects: + +- Access profiles + +- Applications + +- Certification campaigns + +- Entitlements + +- Identities + +- Roles + +- SOD (separation of duties) policies + +- Sources + +You can also use the API to directly find, create, and manage tagged objects without using search queries. + +There are limits to tags: + +- You can have up to 500 different tags in your tenant. + +- You can apply up to 30 tags to one object. + +- You can have up to 10,000 tag associations, pairings of 1 tag to 1 object, in your tenant. + +Because of these limits, it is recommended that you work with your governance experts and security teams to establish a list of tags that are most expressive of governance objects and access managed by Identity Security Cloud. + +These are the types of information often expressed in tags: + +- Affected departments + +- Compliance and regulatory categories + +- Remediation urgency levels + +- Risk levels + +Refer to [Tagging Items in Search](https://documentation.sailpoint.com/saas/help/search/index.html?h=tags#tagging-items-in-search) for more information about tagging objects in Identity Security Cloud. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Remove-V2024TaggedObject**](#delete-tagged-object) | **DELETE** `/tagged-objects/{type}/{id}` | Delete Object Tags +[**Remove-V2024TagsToManyObject**](#delete-tags-to-many-object) | **POST** `/tagged-objects/bulk-remove` | Remove Tags from Multiple Objects +[**Get-V2024TaggedObject**](#get-tagged-object) | **GET** `/tagged-objects/{type}/{id}` | Get Tagged Object +[**Get-V2024TaggedObjects**](#list-tagged-objects) | **GET** `/tagged-objects` | List Tagged Objects +[**Get-V2024TaggedObjectsByType**](#list-tagged-objects-by-type) | **GET** `/tagged-objects/{type}` | List Tagged Objects by Type +[**Send-V2024TaggedObject**](#put-tagged-object) | **PUT** `/tagged-objects/{type}/{id}` | Update Tagged Object +[**Set-V2024TagToObject**](#set-tag-to-object) | **POST** `/tagged-objects` | Add Tag to Object +[**Set-V2024TagsToManyObjects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag Multiple Objects + +## delete-tagged-object +Delete all tags from a tagged object. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Type | **String** | True | The type of object to delete tags from. +Path | Id | **String** | True | The ID of the object to delete tags from. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Type = "ACCESS_PROFILE" # String | The type of object to delete tags from. +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from. + +# Delete Object Tags + +try { + Remove-V2024TaggedObject-V2024Type $Type -V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024TaggedObject -V2024Type $Type -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TaggedObject" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-tags-to-many-object +This API removes tags from multiple objects. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | BulkRemoveTaggedObject | [**BulkRemoveTaggedObject**](../models/bulk-remove-tagged-object) | True | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$BulkRemoveTaggedObject = @"{ + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "tags" : [ "BU_FINANCE", "PCI" ] +}"@ + +# Remove Tags from Multiple Objects + +try { + $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject + Remove-V2024TagsToManyObject-V2024BulkRemoveTaggedObject $Result + + # Below is a request that includes all optional parameters + # Remove-V2024TagsToManyObject -V2024BulkRemoveTaggedObject $BulkRemoveTaggedObject +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TagsToManyObject" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-tagged-object +This gets a tagged object for the specified type. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Type | **String** | True | The type of tagged object to retrieve. +Path | Id | **String** | True | The ID of the object reference to retrieve. + +### Return type +[**TaggedObject**](../models/tagged-object) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Tagged object by type and ID. | TaggedObject +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + +# Get Tagged Object + +try { + Get-V2024TaggedObject-V2024Type $Type -V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024TaggedObject -V2024Type $Type -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObject" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-tagged-objects +This API returns a list of all tagged objects. + +Any authenticated token may be used to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* + +### Return type +[**TaggedObject[]**](../models/tagged-object) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of all tagged objects. | TaggedObject[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'tagName eq "BU_FINANCE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + +# List Tagged Objects + +try { + Get-V2024TaggedObjects + + # Below is a request that includes all optional parameters + # Get-V2024TaggedObjects -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObjects" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-tagged-objects-by-type +This API returns a list of all tagged objects by type. + +Any authenticated token may be used to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Type | **String** | True | The type of tagged object to retrieve. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* + +### Return type +[**TaggedObject[]**](../models/tagged-object) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of all tagged objects for specified type. | TaggedObject[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'objectRef.id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + +# List Tagged Objects by Type + +try { + Get-V2024TaggedObjectsByType-V2024Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024TaggedObjectsByType -V2024Type $Type -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObjectsByType" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-tagged-object +This updates a tagged object for the specified type. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Type | **String** | True | The type of tagged object to update. +Path | Id | **String** | True | The ID of the object reference to update. + Body | TaggedObject | [**TaggedObject**](../models/tagged-object) | True | + +### Return type +[**TaggedObject**](../models/tagged-object) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Tagged object by type and ID. | TaggedObject +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Type = "ACCESS_PROFILE" # String | The type of tagged object to update. +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to update. +$TaggedObject = @"{ + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] +}"@ + +# Update Tagged Object + +try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Send-V2024TaggedObject-V2024Type $Type -V2024Id $Id -V2024TaggedObject $Result + + # Below is a request that includes all optional parameters + # Send-V2024TaggedObject -V2024Type $Type -V2024Id $Id -V2024TaggedObject $TaggedObject +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TaggedObject" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-tag-to-object +This adds a tag to an object. + +Any authenticated token may be used to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | TaggedObject | [**TaggedObject**](../models/tagged-object) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Created. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$TaggedObject = @"{ + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] +}"@ + +# Add Tag to Object + +try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Set-V2024TagToObject-V2024TaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-V2024TagToObject -V2024TaggedObject $TaggedObject +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagToObject" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-tags-to-many-objects +This API adds tags to multiple objects. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | BulkAddTaggedObject | [**BulkAddTaggedObject**](../models/bulk-add-tagged-object) | True | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + +### Return type +[**BulkTaggedObjectResponse[]**](../models/bulk-tagged-object-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Request succeeded. | BulkTaggedObjectResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$BulkAddTaggedObject = @"{ + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] +}"@ + +# Tag Multiple Objects + +try { + $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject + Set-V2024TagsToManyObjects-V2024BulkAddTaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-V2024TagsToManyObjects -V2024BulkAddTaggedObject $BulkAddTaggedObject +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagsToManyObjects" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024TaskManagementApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024TaskManagementApi.md new file mode 100644 index 000000000..3bf5b2f55 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024TaskManagementApi.md @@ -0,0 +1,276 @@ + +--- +id: v2024-task-management +title: TaskManagement +pagination_label: TaskManagement +sidebar_label: TaskManagement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskManagement', 'V2024TaskManagement'] +slug: /tools/sdk/powershell/v2024/methods/task-management +tags: ['SDK', 'Software Development Kit', 'TaskManagement', 'V2024TaskManagement'] +--- + +# TaskManagement + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024PendingTaskHeaders**](#get-pending-task-headers) | **HEAD** `/task-status/pending-tasks` | Retrieve Pending Task List Headers +[**Get-V2024PendingTasks**](#get-pending-tasks) | **GET** `/task-status/pending-tasks` | Retrieve Pending Task Status List +[**Get-V2024TaskStatus**](#get-task-status) | **GET** `/task-status/{id}` | Get Task Status by ID +[**Get-V2024TaskStatusList**](#get-task-status-list) | **GET** `/task-status` | Retrieve Task Status List +[**Update-V2024TaskStatus**](#update-task-status) | **PATCH** `/task-status/{id}` | Update Task Status by ID + +## get-pending-task-headers +Responds with headers only for list of task statuses for pending tasks. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Retrieve headers for a list of TaskStatus for pending tasks. | +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Retrieve Pending Task List Headers + +try { + Get-V2024PendingTaskHeaders-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PendingTaskHeaders -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingTaskHeaders" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-pending-tasks +Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**TaskStatus[]**](../models/task-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with a list of TaskStatus for pending tasks. | TaskStatus[] +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Retrieve Pending Task Status List + +try { + Get-V2024PendingTasks-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PendingTasks -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingTasks" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-task-status +Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Task ID. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**TaskStatus**](../models/task-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with a TaskStatus for the task with the given task ID. | TaskStatus +403 | Forbidden, generally due to a lack of security rights | +404 | TaskStatus with the given id was not found. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get Task Status by ID + +try { + Get-V2024TaskStatus-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024TaskStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaskStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-task-status-list +Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/v2024/get-pending-tasks) endpoint. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** + +### Return type +[**TaskStatus[]**](../models/task-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with a TaskStatus for the task with the given task ID. | TaskStatus[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'completionStatus eq "Success"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) +$Sorters = "-created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) + +# Retrieve Task Status List + +try { + Get-V2024TaskStatusList-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024TaskStatusList -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaskStatusList" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-task-status +Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Task ID. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the object. + +### Return type +[**TaskStatus**](../models/task-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | This response indicates the PATCH operation succeeded, and the API returns the updated task object. | TaskStatus +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | The JSONPatch payload used to update the object. + + +# Update Task Status by ID + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024TaskStatus-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024TaskStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024TaskStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024TenantApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024TenantApi.md new file mode 100644 index 000000000..becd0c0a4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024TenantApi.md @@ -0,0 +1,65 @@ + +--- +id: v2024-tenant +title: Tenant +pagination_label: Tenant +sidebar_label: Tenant +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Tenant', 'V2024Tenant'] +slug: /tools/sdk/powershell/v2024/methods/tenant +tags: ['SDK', 'Software Development Kit', 'Tenant', 'V2024Tenant'] +--- + +# Tenant + API for reading tenant details. + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024Tenant**](#get-tenant) | **GET** `/tenant` | Get Tenant Information. + +## get-tenant +This rest endpoint can be used to retrieve tenant details. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**Tenant**](../models/tenant) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Tenant Info | Tenant +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get Tenant Information. + +try { + Get-V2024Tenant-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Tenant -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Tenant" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024TransformsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024TransformsApi.md new file mode 100644 index 000000000..52367f361 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024TransformsApi.md @@ -0,0 +1,298 @@ + +--- +id: v2024-transforms +title: Transforms +pagination_label: Transforms +sidebar_label: Transforms +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Transforms', 'V2024Transforms'] +slug: /tools/sdk/powershell/v2024/methods/transforms +tags: ['SDK', 'Software Development Kit', 'Transforms', 'V2024Transforms'] +--- + +# Transforms + The purpose of this API is to expose functionality for the manipulation of Transform objects. +Transforms are a form of configurable objects which define an easy way to manipulate attribute data without having +to write code. These endpoints don't require API calls to other resources, audit service is used for keeping track +of which users have made changes to the Transforms. + +Refer to [Transforms](https://developer.sailpoint.com/docs/extensibility/transforms/) for more information about transforms. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024Transform**](#create-transform) | **POST** `/transforms` | Create transform +[**Remove-V2024Transform**](#delete-transform) | **DELETE** `/transforms/{id}` | Delete a transform +[**Get-V2024Transform**](#get-transform) | **GET** `/transforms/{id}` | Transform by ID +[**Get-V2024Transforms**](#list-transforms) | **GET** `/transforms` | List transforms +[**Update-V2024Transform**](#update-transform) | **PUT** `/transforms/{id}` | Update a transform + +## create-transform +Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Transform | [**Transform**](../models/transform) | True | The transform to be created. + +### Return type +[**TransformRead**](../models/transform-read) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Indicates the transform was successfully created and returns its representation. | TransformRead +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Transform = @"{ + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" +}"@ + +# Create transform + +try { + $Result = ConvertFrom-JsonToTransform -Json $Transform + New-V2024Transform-V2024Transform $Result + + # Below is a request that includes all optional parameters + # New-V2024Transform -V2024Transform $Transform +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Transform" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-transform +Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the transform to delete + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete + +# Delete a transform + +try { + Remove-V2024Transform-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Transform -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Transform" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-transform +This API returns the transform specified by the given ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the transform to retrieve + +### Return type +[**TransformRead**](../models/transform-read) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Transform with the given ID | TransformRead +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve + +# Transform by ID + +try { + Get-V2024Transform-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Transform -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Transform" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-transforms +Gets a list of all saved transform objects. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Name | **String** | (optional) | Name of the transform to retrieve from the list. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* + +### Return type +[**TransformRead[]**](../models/transform-read) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of transforms matching the given criteria. | TransformRead[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional) +$Filters = 'name eq "Uppercase"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) + +# List transforms + +try { + Get-V2024Transforms + + # Below is a request that includes all optional parameters + # Get-V2024Transforms -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Name $Name -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Transforms" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-transform +Replaces the transform specified by the given ID with the transform provided in the request body. Only the "attributes" field is mutable. Attempting to change other properties (ex. "name" and "type") will result in an error. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the transform to update + Body | Transform | [**Transform**](../models/transform) | (optional) | The updated transform object. Must include ""name"", ""type"", and ""attributes"" fields, but ""name"" and ""type"" must not be modified. + +### Return type +[**TransformRead**](../models/transform-read) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Indicates the transform was successfully updated and returns its new representation. | TransformRead +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update +$Transform = @"{ + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" +}"@ + +# Update a transform + +try { + Update-V2024Transform-V2024Id $Id + + # Below is a request that includes all optional parameters + # Update-V2024Transform -V2024Id $Id -V2024Transform $Transform +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Transform" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024TriggersApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024TriggersApi.md new file mode 100644 index 000000000..3c4da8a33 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024TriggersApi.md @@ -0,0 +1,636 @@ + +--- +id: v2024-triggers +title: Triggers +pagination_label: Triggers +sidebar_label: Triggers +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Triggers', 'V2024Triggers'] +slug: /tools/sdk/powershell/v2024/methods/triggers +tags: ['SDK', 'Software Development Kit', 'Triggers', 'V2024Triggers'] +--- + +# Triggers + Event Triggers provide real-time updates to changes in Identity Security Cloud so you can take action as soon as an event occurs, rather than poll an API endpoint for updates. Identity Security Cloud provides a user interface within the admin console to create and manage trigger subscriptions. These endpoints allow for programatically creating and managing trigger subscriptions. + +There are two types of event triggers: + * `FIRE_AND_FORGET`: This trigger type will send a payload to each subscriber without needing a response. Each trigger of this type has a limit of **50 subscriptions**. + * `REQUEST_RESPONSE`: This trigger type will send a payload to a subscriber and expect a response back. Each trigger of this type may only have **one subscription**. + +## Available Event Triggers +Production ready event triggers that are available in all tenants. + +| Name | ID | Type | Trigger condition | +|-|-|-|-| +| [Access Request Dynamic Approval](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-dynamic-approval/) | idn:access-request-dynamic-approver | REQUEST_RESPONSE |After an access request is submitted. Expects the subscriber to respond with the ID of an identity or workgroup to add to the approval workflow. | +| [Access Request Decision](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-decision/) | idn:access-request-post-approval | FIRE_AND_FORGET | After an access request is approved. | +| [Access Request Submitted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/access-request-submitted/) | idn:access-request-pre-approval | REQUEST_RESPONSE | After an access request is submitted. Expects the subscriber to respond with an approval decision. | +| [Account Aggregation Completed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/account-aggregation-completed/) | idn:account-aggregation-completed | FIRE_AND_FORGET | After an account aggregation completed, terminated, failed. | +| Account Attributes Changed | idn:account-attributes-changed | FIRE_AND_FORGET | After an account aggregation, and one or more account attributes have changed. | +| Account Correlated | idn:account-correlated | FIRE_AND_FORGET | After an account is added to an identity. | +| Accounts Collected for Aggregation | idn:aggregation-accounts-collected | FIRE_AND_FORGET | New, changed, and deleted accounts have been gathered during an aggregation and are being processed. | +| Account Uncorrelated | idn:account-uncorrelated | FIRE_AND_FORGET | After an account is removed from an identity. | +| Campaign Activated | idn:campaign-activated | FIRE_AND_FORGET | After a campaign is activated. | +| Campaign Ended | idn:campaign-ended | FIRE_AND_FORGET | After a campaign ends. | +| Campaign Generated | idn:campaign-generated | FIRE_AND_FORGET | After a campaign finishes generating. | +| Certification Signed Off | idn:certification-signed-off | FIRE_AND_FORGET | After a certification is signed off by its reviewer. | +| [Identity Attributes Changed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/account-aggregation-completed/) | idn:identity-attributes-changed | FIRE_AND_FORGET | After One or more identity attributes changed. | +| [Identity Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/identity-created/) | idn:identity-created | FIRE_AND_FORGET | After an identity is created. | +| [Provisioning Action Completed](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/provisioning-completed/) | idn:post-provisioning | FIRE_AND_FORGET | After a provisioning action completed on a source. | +| [Scheduled Search](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/scheduled-search/) | idn:saved-search-complete | FIRE_AND_FORGET | After a scheduled search completed. | +| [Source Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-created/) | idn:source-created | FIRE_AND_FORGET | After a source is created. | +| [Source Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-deleted/) | idn:source-deleted | FIRE_AND_FORGET | After a source is deleted. | +| [Source Updated](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-updated/) | idn:source-updated | FIRE_AND_FORGET | After configuration changes have been made to a source. | +| [VA Cluster Status Change](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/va-cluster-status-change/) | idn:va-cluster-status-change | FIRE_AND_FORGET | After the status of a VA cluster has changed. | + +## Early Access Event Triggers +Triggers that are in-development and not ready for production use. Please contact support to enable these triggers in your tenant. + +| Name | ID | Type | Trigger condition | +|-|-|-|-| +| [Identity Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/identity-deleted/) | idn:identity-deleted | FIRE_AND_FORGET | After an identity is deleted. | +| [Source Account Created](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-created/) | idn:source-account-created | FIRE_AND_FORGET | After a source account is created. | +| [Source Account Deleted](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-deleted/) | idn:source-account-deleted | FIRE_AND_FORGET | After a source account is deleted. | +| [Source Account Updated](https://developer.sailpoint.com/docs/extensibility/event-triggers/triggers/source-account-updated/) | idn:source-account-updated | FIRE_AND_FORGET | After a source account is changed. | + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Complete-V2024TriggerInvocation**](#complete-trigger-invocation) | **POST** `/trigger-invocations/{id}/complete` | Complete Trigger Invocation +[**New-V2024Subscription**](#create-subscription) | **POST** `/trigger-subscriptions` | Create a Subscription +[**Remove-V2024Subscription**](#delete-subscription) | **DELETE** `/trigger-subscriptions/{id}` | Delete a Subscription +[**Get-V2024Subscriptions**](#list-subscriptions) | **GET** `/trigger-subscriptions` | List Subscriptions +[**Get-V2024TriggerInvocationStatus**](#list-trigger-invocation-status) | **GET** `/trigger-invocations/status` | List Latest Invocation Statuses +[**Get-V2024Triggers**](#list-triggers) | **GET** `/triggers` | List Triggers +[**Update-V2024Subscription**](#patch-subscription) | **PATCH** `/trigger-subscriptions/{id}` | Patch a Subscription +[**Start-V2024TestTriggerInvocation**](#start-test-trigger-invocation) | **POST** `/trigger-invocations/test` | Start a Test Invocation +[**Test-V2024SubscriptionFilter**](#test-subscription-filter) | **POST** `/trigger-subscriptions/validate-filter` | Validate a Subscription Filter +[**Update-V2024Subscription**](#update-subscription) | **PUT** `/trigger-subscriptions/{id}` | Update a Subscription + +## complete-trigger-invocation +Completes an invocation to a REQUEST_RESPONSE type trigger. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the invocation to complete. + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | CompleteInvocation | [**CompleteInvocation**](../models/complete-invocation) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the invocation to complete. +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$CompleteInvocation = @"{ + "output" : { + "approved" : false + }, + "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "error" : "Access request is denied." +}"@ + +# Complete Trigger Invocation + +try { + $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation + Complete-V2024TriggerInvocation-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024CompleteInvocation $Result + + # Below is a request that includes all optional parameters + # Complete-V2024TriggerInvocation -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024CompleteInvocation $CompleteInvocation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024TriggerInvocation" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-subscription +This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: +* HTTP subscriptions require httpConfig +* EventBridge subscriptions require eventBridgeConfig + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | SubscriptionPostRequest | [**SubscriptionPostRequest**](../models/subscription-post-request) | True | + +### Return type +[**Subscription**](../models/subscription) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | New subscription to a trigger. The trigger can now be invoked by the method defined in the subscription. | Subscription +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$SubscriptionPostRequest = @"{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "triggerId" : "idn:access-requested", + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true +}"@ + +# Create a Subscription + +try { + $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest + New-V2024Subscription-V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPostRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024Subscription -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPostRequest $SubscriptionPostRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Subscription" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-subscription +Deletes an existing subscription to a trigger. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Subscription ID + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Delete a Subscription + +try { + Remove-V2024Subscription-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024Subscription -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Subscription" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-subscriptions +Gets a list of all trigger subscriptions. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** + +### Return type +[**Subscription[]**](../models/subscription) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of subscriptions. | Subscription[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional) +$Sorters = "triggerName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) + +# List Subscriptions + +try { + Get-V2024Subscriptions-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Subscriptions -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Subscriptions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-trigger-invocation-status +Gets a list of latest invocation statuses. +Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. +This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** + +### Return type +[**InvocationStatus[]**](../models/invocation-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of latest invocation statuses. | InvocationStatus[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'triggerId eq "idn:access-request-dynamic-approver"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* (optional) +$Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) + +# List Latest Invocation Statuses + +try { + Get-V2024TriggerInvocationStatus-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024TriggerInvocationStatus -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TriggerInvocationStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-triggers +Gets a list of triggers that are available in the tenant. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** + +### Return type +[**Trigger[]**](../models/trigger) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of triggers. | Trigger[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq "idn:access-request-post-approval"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* (optional) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** (optional) + +# List Triggers + +try { + Get-V2024Triggers-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Triggers -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Triggers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-subscription +This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: + +**name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Subscription to patch + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | SubscriptionPatchRequestInner | [**[]SubscriptionPatchRequestInner**](../models/subscription-patch-request-inner) | True | + +### Return type +[**Subscription**](../models/subscription) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated subscription. | Subscription +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription to patch +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SubscriptionPatchRequestInner = @""@ # SubscriptionPatchRequestInner[] | + + +# Patch a Subscription + +try { + $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner + Update-V2024Subscription-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPatchRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-V2024Subscription -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPatchRequestInner $SubscriptionPatchRequestInner +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-test-trigger-invocation +Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | TestInvocation | [**TestInvocation**](../models/test-invocation) | True | + +### Return type +[**Invocation[]**](../models/invocation) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Test trigger invocations that have been started for specified subscription(s). | Invocation[] +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$TestInvocation = @"{ + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + }, + "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], + "triggerId" : "idn:access-request-post-approval", + "contentJson" : { + "workflowId" : 1234 + } +}"@ + +# Start a Test Invocation + +try { + $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation + Start-V2024TestTriggerInvocation-V2024XSailPointExperimental $XSailPointExperimental -V2024TestInvocation $Result + + # Below is a request that includes all optional parameters + # Start-V2024TestTriggerInvocation -V2024XSailPointExperimental $XSailPointExperimental -V2024TestInvocation $TestInvocation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024TestTriggerInvocation" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## test-subscription-filter +Validates a JSONPath filter expression against a provided mock input. +Request requires a security scope of: + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | ValidateFilterInputDto | [**ValidateFilterInputDto**](../models/validate-filter-input-dto) | True | + +### Return type +[**ValidateFilterOutputDto**](../models/validate-filter-output-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Boolean whether specified filter expression is valid against the input. | ValidateFilterOutputDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$ValidateFilterInputDto = @"{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + } +}"@ + +# Validate a Subscription Filter + +try { + $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto + Test-V2024SubscriptionFilter-V2024XSailPointExperimental $XSailPointExperimental -V2024ValidateFilterInputDto $Result + + # Below is a request that includes all optional parameters + # Test-V2024SubscriptionFilter -V2024XSailPointExperimental $XSailPointExperimental -V2024ValidateFilterInputDto $ValidateFilterInputDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SubscriptionFilter" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-subscription +This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing + Subscription is completely replaced. The following fields are immutable: + + + * id + + * triggerId + + + Attempts to modify these fields result in 400. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Subscription ID + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | SubscriptionPutRequest | [**SubscriptionPutRequest**](../models/subscription-put-request) | True | + +### Return type +[**Subscription**](../models/subscription) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated subscription. | Subscription +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$SubscriptionPutRequest = @"{ + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true +}"@ + +# Update a Subscription + +try { + $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest + Update-V2024Subscription-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPutRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024Subscription -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPutRequest $SubscriptionPutRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024UIMetadataApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024UIMetadataApi.md new file mode 100644 index 000000000..9ecf49239 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024UIMetadataApi.md @@ -0,0 +1,117 @@ + +--- +id: v2024-ui-metadata +title: UIMetadata +pagination_label: UIMetadata +sidebar_label: UIMetadata +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UIMetadata', 'V2024UIMetadata'] +slug: /tools/sdk/powershell/v2024/methods/ui-metadata +tags: ['SDK', 'Software Development Kit', 'UIMetadata', 'V2024UIMetadata'] +--- + +# UIMetadata + API for managing UI Metadata. Use this API to manage metadata about your User Interface. +For example you can set the iFrameWhitelist parameter to permit another domain to encapsulate IDN within an iframe or set the usernameEmptyText to change the placeholder text for Username on your tenant's login screen. + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-V2024TenantUiMetadata**](#get-tenant-ui-metadata) | **GET** `/ui-metadata/tenant` | Get a tenant UI metadata +[**Set-V2024TenantUiMetadata**](#set-tenant-ui-metadata) | **PUT** `/ui-metadata/tenant` | Update tenant UI metadata + +## get-tenant-ui-metadata +This API endpoint retrieves UI metadata configured for your tenant. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**TenantUiMetadataItemResponse**](../models/tenant-ui-metadata-item-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A tenant UI metadata object | TenantUiMetadataItemResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get a tenant UI metadata + +try { + Get-V2024TenantUiMetadata-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024TenantUiMetadata -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantUiMetadata" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-tenant-ui-metadata +This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | TenantUiMetadataItemUpdateRequest | [**TenantUiMetadataItemUpdateRequest**](../models/tenant-ui-metadata-item-update-request) | True | + +### Return type +[**TenantUiMetadataItemResponse**](../models/tenant-ui-metadata-item-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A tenant UI metadata object | TenantUiMetadataItemResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$TenantUiMetadataItemUpdateRequest = @"{ + "usernameEmptyText" : "Please provide your work email address...", + "usernameLabel" : "Email", + "iframeWhiteList" : "http://example.com http://example2.com" +}"@ + +# Update tenant UI metadata + +try { + $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest + Set-V2024TenantUiMetadata-V2024XSailPointExperimental $XSailPointExperimental -V2024TenantUiMetadataItemUpdateRequest $Result + + # Below is a request that includes all optional parameters + # Set-V2024TenantUiMetadata -V2024XSailPointExperimental $XSailPointExperimental -V2024TenantUiMetadataItemUpdateRequest $TenantUiMetadataItemUpdateRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TenantUiMetadata" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024VendorConnectorMappingsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024VendorConnectorMappingsApi.md new file mode 100644 index 000000000..3a47603cb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024VendorConnectorMappingsApi.md @@ -0,0 +1,204 @@ + +--- +id: v2024-vendor-connector-mappings +title: VendorConnectorMappings +pagination_label: VendorConnectorMappings +sidebar_label: VendorConnectorMappings +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMappings', 'V2024VendorConnectorMappings'] +slug: /tools/sdk/powershell/v2024/methods/vendor-connector-mappings +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappings', 'V2024VendorConnectorMappings'] +--- + +# VendorConnectorMappings + Vendors use ISC connectors to connect their source data to ISC, but the data in their source and the data in ISC may be stored in different formats. +Connector mappings allow vendors to match their data on both sides of the connection. +The vendors can then track and manage access across their sources from ISC. +This API allows you to create and manage these vendor connector mappings. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024VendorConnectorMapping**](#create-vendor-connector-mapping) | **POST** `/vendor-connector-mappings` | Create Vendor Connector Mapping +[**Remove-V2024VendorConnectorMapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete Vendor Connector Mapping +[**Get-V2024VendorConnectorMappings**](#get-vendor-connector-mappings) | **GET** `/vendor-connector-mappings` | List Vendor Connector Mappings + +## create-vendor-connector-mapping +Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | VendorConnectorMapping | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | True | + +### Return type +[**VendorConnectorMapping**](../models/vendor-connector-mapping) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully created a new vendor connector mapping. | VendorConnectorMapping +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +405 | Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method. | CreateDomainDkim405Response +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$VendorConnectorMapping = @"{ + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } +}"@ + +# Create Vendor Connector Mapping + +try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + New-V2024VendorConnectorMapping-V2024VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # New-V2024VendorConnectorMapping -V2024VendorConnectorMapping $VendorConnectorMapping +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VendorConnectorMapping" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-vendor-connector-mapping +Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | VendorConnectorMapping | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | True | + +### Return type +[**DeleteVendorConnectorMapping200Response**](../models/delete-vendor-connector-mapping200-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully deleted the specified vendor connector mapping. | DeleteVendorConnectorMapping200Response +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$VendorConnectorMapping = @"{ + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } +}"@ + +# Delete Vendor Connector Mapping + +try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + Remove-V2024VendorConnectorMapping-V2024VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # Remove-V2024VendorConnectorMapping -V2024VendorConnectorMapping $VendorConnectorMapping +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024VendorConnectorMapping" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-vendor-connector-mappings +Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**VendorConnectorMapping[]**](../models/vendor-connector-mapping) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully retrieved list. | VendorConnectorMapping[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +405 | Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method. | CreateDomainDkim405Response +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List Vendor Connector Mappings + +try { + Get-V2024VendorConnectorMappings + + # Below is a request that includes all optional parameters + # Get-V2024VendorConnectorMappings +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024VendorConnectorMappings" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024WorkItemsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024WorkItemsApi.md new file mode 100644 index 000000000..936af7f1f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024WorkItemsApi.md @@ -0,0 +1,626 @@ + +--- +id: v2024-work-items +title: WorkItems +pagination_label: WorkItems +sidebar_label: WorkItems +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItems', 'V2024WorkItems'] +slug: /tools/sdk/powershell/v2024/methods/work-items +tags: ['SDK', 'Software Development Kit', 'WorkItems', 'V2024WorkItems'] +--- + +# WorkItems + Use this API to implement work item functionality. +With this functionality in place, users can manage their work items (tasks). + +Work items refer to the tasks users see in Identity Security Cloud's Task Manager. +They can see the pending work items they need to complete, as well as the work items they have already completed. +Task Manager lists the work items along with the involved sources, identities, accounts, and the timestamp when the work item was created. +For example, a user may see a pending 'Create an Account' work item for the identity Fred.Astaire in GitHub for Fred's GitHub account, fred-astaire-sp. +Once the user completes the work item, the work item will be listed with his or her other completed work items. + +To complete work items, users can use their dashboards and select the 'My Tasks' widget. +The widget will list any work items they need to complete, and they can select the work item from the list to review its details. +When they complete the work item, they can select 'Mark Complete' to add it to their list of completed work items. + +Refer to [Task Manager](https://documentation.sailpoint.com/saas/user-help/task_manager.html) for more information about work items, including the different types of work items users may need to complete. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Approve-V2024ApprovalItem**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item +[**Approve-V2024ApprovalItemsInBulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items +[**Complete-V2024WorkItem**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a Work Item +[**Get-V2024CompletedWorkItems**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed Work Items +[**Get-V2024CountCompletedWorkItems**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count Completed Work Items +[**Get-V2024CountWorkItems**](#get-count-work-items) | **GET** `/work-items/count` | Count Work Items +[**Get-V2024WorkItem**](#get-work-item) | **GET** `/work-items/{id}` | Get a Work Item +[**Get-V2024WorkItemsSummary**](#get-work-items-summary) | **GET** `/work-items/summary` | Work Items Summary +[**Get-V2024WorkItems**](#list-work-items) | **GET** `/work-items` | List Work Items +[**Deny-V2024ApprovalItem**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item +[**Deny-V2024ApprovalItemsInBulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items +[**Send-V2024WorkItemForward**](#send-work-item-forward) | **POST** `/work-items/{id}/forward` | Forward a Work Item +[**Submit-V2024AccountSelection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections + +## approve-approval-item +This API approves an Approval Item. Either an admin, or the owning/current user must make this request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the work item +Path | ApprovalItemId | **String** | True | The ID of the approval item. + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A work items details object. | WorkItems +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item +$ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + +# Approve an Approval Item + +try { + Approve-V2024ApprovalItem-V2024Id $Id -V2024ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Approve-V2024ApprovalItem -V2024Id $Id -V2024ApprovalItemId $ApprovalItemId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItem" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## approve-approval-items-in-bulk +This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the work item + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A work items details object. | WorkItems +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + +# Bulk approve Approval Items + +try { + Approve-V2024ApprovalItemsInBulk-V2024Id $Id + + # Below is a request that includes all optional parameters + # Approve-V2024ApprovalItemsInBulk -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItemsInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## complete-work-item +This API completes a work item. Either an admin, or the owning/current user must make this request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the work item + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A WorkItems object | WorkItems +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + +# Complete a Work Item + +try { + Complete-V2024WorkItem-V2024Id $Id + + # Below is a request that includes all optional parameters + # Complete-V2024WorkItem -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024WorkItem" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-completed-work-items +This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | OwnerId | **String** | (optional) | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**WorkItems[]**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of completed work items. | WorkItems[] +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Completed Work Items + +try { + Get-V2024CompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-V2024CompletedWorkItems -V2024OwnerId $OwnerId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompletedWorkItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-count-completed-work-items +This gets a count of completed work items belonging to either the specified user(admin required), or the current user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | OwnerId | **String** | (optional) | ID of the work item owner. + +### Return type +[**WorkItemsCount**](../models/work-items-count) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of work items | WorkItemsCount +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + +# Count Completed Work Items + +try { + Get-V2024CountCompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-V2024CountCompletedWorkItems -V2024OwnerId $OwnerId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountCompletedWorkItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-count-work-items +This gets a count of work items belonging to either the specified user(admin required), or the current user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | OwnerId | **String** | (optional) | ID of the work item owner. + +### Return type +[**WorkItemsCount**](../models/work-items-count) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of work items | WorkItemsCount +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) + +# Count Work Items + +try { + Get-V2024CountWorkItems + + # Below is a request that includes all optional parameters + # Get-V2024CountWorkItems -V2024OwnerId $OwnerId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountWorkItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-work-item +This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the work item. + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The work item with the given ID. | WorkItems +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. + +# Get a Work Item + +try { + Get-V2024WorkItem-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkItem -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItem" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-work-items-summary +This gets a summary of work items belonging to either the specified user(admin required), or the current user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | OwnerId | **String** | (optional) | ID of the work item owner. + +### Return type +[**WorkItemsSummary**](../models/work-items-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of work items | WorkItemsSummary +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + +# Work Items Summary + +try { + Get-V2024WorkItemsSummary + + # Below is a request that includes all optional parameters + # Get-V2024WorkItemsSummary -V2024OwnerId $OwnerId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItemsSummary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-work-items +This gets a collection of work items belonging to either the specified user(admin required), or the current user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | OwnerId | **String** | (optional) | ID of the work item owner. + +### Return type +[**WorkItems[]**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of work items | WorkItems[] +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + +# List Work Items + +try { + Get-V2024WorkItems + + # Below is a request that includes all optional parameters + # Get-V2024WorkItems -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024OwnerId $OwnerId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## reject-approval-item +This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the work item +Path | ApprovalItemId | **String** | True | The ID of the approval item. + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A work items details object. | WorkItems +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item +$ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + +# Reject an Approval Item + +try { + Deny-V2024ApprovalItem-V2024Id $Id -V2024ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Deny-V2024ApprovalItem -V2024Id $Id -V2024ApprovalItemId $ApprovalItemId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItem" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## reject-approval-items-in-bulk +This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the work item + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A work items details object. | WorkItems +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + +# Bulk reject Approval Items + +try { + Deny-V2024ApprovalItemsInBulk-V2024Id $Id + + # Below is a request that includes all optional parameters + # Deny-V2024ApprovalItemsInBulk -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItemsInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## send-work-item-forward +This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. Accessible to work-item Owner, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the work item + Body | WorkItemForward | [**WorkItemForward**](../models/work-item-forward) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Success, but no data is returned. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item +$WorkItemForward = @"{ + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true +}"@ + +# Forward a Work Item + +try { + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Send-V2024WorkItemForward-V2024Id $Id -V2024WorkItemForward $Result + + # Below is a request that includes all optional parameters + # Send-V2024WorkItemForward -V2024Id $Id -V2024WorkItemForward $WorkItemForward +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024WorkItemForward" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## submit-account-selection +This API submits account selections. Either an admin, or the owning/current user must make this request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the work item + Body | RequestBody | [**map[string]AnyType**](https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4) | True | Account Selection Data map, keyed on fieldName + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A work items details object. | WorkItems +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item +$RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName + +# Submit Account Selections + +try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-V2024AccountSelection-V2024Id $Id -V2024RequestBody $Result + + # Below is a request that includes all optional parameters + # Submit-V2024AccountSelection -V2024Id $Id -V2024RequestBody $RequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024AccountSelection" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024WorkReassignmentApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024WorkReassignmentApi.md new file mode 100644 index 000000000..2a4bcd728 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024WorkReassignmentApi.md @@ -0,0 +1,462 @@ + +--- +id: v2024-work-reassignment +title: WorkReassignment +pagination_label: WorkReassignment +sidebar_label: WorkReassignment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkReassignment', 'V2024WorkReassignment'] +slug: /tools/sdk/powershell/v2024/methods/work-reassignment +tags: ['SDK', 'Software Development Kit', 'WorkReassignment', 'V2024WorkReassignment'] +--- + +# WorkReassignment + Use this API to implement work reassignment functionality. + +Work Reassignment allows access request reviews, certifications, and manual provisioning tasks assigned to a user to be reassigned to a different user. This is primarily used for: + +- Temporarily redirecting work for users who are out of office, such as on vacation or sick leave +- Permanently redirecting work for users who should not be assigned these tasks at all, such as senior executives or service identities + +Users can define reassignments for themselves, managers can add them for their team members, and administrators can configure them on any user’s behalf. Work assigned during the specified reassignment timeframes will be automatically reassigned to the designated user as it is created. + +Refer to [Work Reassignment](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html) for more information about this topic. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-V2024ReassignmentConfiguration**](#create-reassignment-configuration) | **POST** `/reassignment-configurations` | Create a Reassignment Configuration +[**Remove-V2024ReassignmentConfiguration**](#delete-reassignment-configuration) | **DELETE** `/reassignment-configurations/{identityId}/{configType}` | Delete Reassignment Configuration +[**Get-V2024EvaluateReassignmentConfiguration**](#get-evaluate-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}/evaluate/{configType}` | Evaluate Reassignment Configuration +[**Get-V2024ReassignmentConfigTypes**](#get-reassignment-config-types) | **GET** `/reassignment-configurations/types` | List Reassignment Config Types +[**Get-V2024ReassignmentConfiguration**](#get-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}` | Get Reassignment Configuration +[**Get-V2024TenantConfigConfiguration**](#get-tenant-config-configuration) | **GET** `/reassignment-configurations/tenant-config` | Get Tenant-wide Reassignment Configuration settings +[**Get-V2024ReassignmentConfigurations**](#list-reassignment-configurations) | **GET** `/reassignment-configurations` | List Reassignment Configurations +[**Send-V2024ReassignmentConfig**](#put-reassignment-config) | **PUT** `/reassignment-configurations/{identityId}` | Update Reassignment Configuration +[**Send-V2024TenantConfiguration**](#put-tenant-configuration) | **PUT** `/reassignment-configurations/tenant-config` | Update Tenant-wide Reassignment Configuration settings + +## create-reassignment-configuration +Creates a new Reassignment Configuration for the specified identity. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | ConfigurationItemRequest | [**ConfigurationItemRequest**](../models/configuration-item-request) | True | + +### Return type +[**ConfigurationItemResponse**](../models/configuration-item-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | The newly created Reassignment Configuration object | ConfigurationItemResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$ConfigurationItemRequest = @"{ + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" +}"@ + +# Create a Reassignment Configuration + +try { + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + New-V2024ReassignmentConfiguration-V2024XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ReassignmentConfiguration -V2024XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $ConfigurationItemRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ReassignmentConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-reassignment-configuration +Deletes a single reassignment configuration for the specified identity + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityId | **String** | True | unique identity id +Path | ConfigType | [**ConfigTypeEnum**](../models/config-type-enum) | True | + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | Reassignment Configuration deleted | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id +$ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Delete Reassignment Configuration + +try { + Remove-V2024ReassignmentConfiguration-V2024IdentityId $IdentityId -V2024ConfigType $ConfigType -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024ReassignmentConfiguration -V2024IdentityId $IdentityId -V2024ConfigType $ConfigType -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ReassignmentConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-evaluate-reassignment-configuration +Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityId | **String** | True | unique identity id +Path | ConfigType | [**ConfigTypeEnum**](../models/config-type-enum) | True | Reassignment work type + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Query | ExclusionFilters | **[]String** | (optional) | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments + +### Return type +[**EvaluateResponse[]**](../models/evaluate-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Evaluated Reassignment Configuration | EvaluateResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id +$ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) + +$ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) + +# Evaluate Reassignment Configuration + +try { + Get-V2024EvaluateReassignmentConfiguration-V2024IdentityId $IdentityId -V2024ConfigType $ConfigType -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EvaluateReassignmentConfiguration -V2024IdentityId $IdentityId -V2024ConfigType $ConfigType -V2024XSailPointExperimental $XSailPointExperimental -V2024ExclusionFilters $ExclusionFilters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EvaluateReassignmentConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-reassignment-config-types +Gets a collection of types which are available in the Reassignment Configuration UI. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**ConfigType[]**](../models/config-type) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Reassignment Configuration Types | ConfigType[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# List Reassignment Config Types + +try { + Get-V2024ReassignmentConfigTypes-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ReassignmentConfigTypes -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigTypes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-reassignment-configuration +Gets the Reassignment Configuration for an identity. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityId | **String** | True | unique identity id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**ConfigurationResponse**](../models/configuration-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reassignment Configuration for an identity | ConfigurationResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get Reassignment Configuration + +try { + Get-V2024ReassignmentConfiguration-V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ReassignmentConfiguration -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-tenant-config-configuration +Gets the global Reassignment Configuration settings for the requestor's tenant. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**TenantConfigurationResponse**](../models/tenant-configuration-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Tenant-wide Reassignment Configuration settings | TenantConfigurationResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# Get Tenant-wide Reassignment Configuration settings + +try { + Get-V2024TenantConfigConfiguration-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024TenantConfigConfiguration -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantConfigConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-reassignment-configurations +Gets all Reassignment configuration for the current org. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + +### Return type +[**ConfigurationResponse[]**](../models/configuration-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of Reassignment Configurations for an org | ConfigurationResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + +# List Reassignment Configurations + +try { + Get-V2024ReassignmentConfigurations-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ReassignmentConfigurations -V2024XSailPointExperimental $XSailPointExperimental +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigurations" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-reassignment-config +Replaces existing Reassignment configuration for an identity with the newly provided configuration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityId | **String** | True | unique identity id + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | ConfigurationItemRequest | [**ConfigurationItemRequest**](../models/configuration-item-request) | True | + +### Return type +[**ConfigurationItemResponse**](../models/configuration-item-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reassignment Configuration updated | ConfigurationItemResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$ConfigurationItemRequest = @"{ + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" +}"@ + +# Update Reassignment Configuration + +try { + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + Send-V2024ReassignmentConfig-V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2024ReassignmentConfig -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $ConfigurationItemRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ReassignmentConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-tenant-configuration +Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. + Body | TenantConfigurationRequest | [**TenantConfigurationRequest**](../models/tenant-configuration-request) | True | + +### Return type +[**TenantConfigurationResponse**](../models/tenant-configuration-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Tenant-wide Reassignment Configuration settings | TenantConfigurationResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$TenantConfigurationRequest = @"{ + "configDetails" : { + "disabled" : true + } +}"@ + +# Update Tenant-wide Reassignment Configuration settings + +try { + $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest + Send-V2024TenantConfiguration-V2024XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2024TenantConfiguration -V2024XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $TenantConfigurationRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TenantConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024WorkflowsApi.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024WorkflowsApi.md new file mode 100644 index 000000000..d50f10de2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Methods/V2024WorkflowsApi.md @@ -0,0 +1,883 @@ + +--- +id: v2024-workflows +title: Workflows +pagination_label: Workflows +sidebar_label: Workflows +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Workflows', 'V2024Workflows'] +slug: /tools/sdk/powershell/v2024/methods/workflows +tags: ['SDK', 'Software Development Kit', 'Workflows', 'V2024Workflows'] +--- + +# Workflows + Workflows allow administrators to create custom automation scripts directly within Identity Security Cloud. These automation scripts respond to [event triggers](https://developer.sailpoint.com/docs/extensibility/event-triggers/#how-to-get-started-with-event-triggers) and perform a series of actions to perform tasks that are either too cumbersome or not available in the Identity Security Cloud UI. Workflows can be configured via a graphical user interface within Identity Security Cloud, or by creating and uploading a JSON formatted script to the Workflow service. The Workflows API collection provides the necessary functionality to create, manage, and test your workflows via REST. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Suspend-V2024WorkflowExecution**](#cancel-workflow-execution) | **POST** `/workflow-executions/{id}/cancel` | Cancel Workflow Execution by ID +[**New-V2024ExternalExecuteWorkflow**](#create-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger +[**New-V2024Workflow**](#create-workflow) | **POST** `/workflows` | Create Workflow +[**New-V2024WorkflowExternalTrigger**](#create-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client +[**Remove-V2024Workflow**](#delete-workflow) | **DELETE** `/workflows/{id}` | Delete Workflow By Id +[**Get-V2024Workflow**](#get-workflow) | **GET** `/workflows/{id}` | Get Workflow By Id +[**Get-V2024WorkflowExecution**](#get-workflow-execution) | **GET** `/workflow-executions/{id}` | Get Workflow Execution +[**Get-V2024WorkflowExecutionHistory**](#get-workflow-execution-history) | **GET** `/workflow-executions/{id}/history` | Get Workflow Execution History +[**Get-V2024WorkflowExecutions**](#get-workflow-executions) | **GET** `/workflows/{id}/executions` | List Workflow Executions +[**Get-V2024CompleteWorkflowLibrary**](#list-complete-workflow-library) | **GET** `/workflow-library` | List Complete Workflow Library +[**Get-V2024WorkflowLibraryActions**](#list-workflow-library-actions) | **GET** `/workflow-library/actions` | List Workflow Library Actions +[**Get-V2024WorkflowLibraryOperators**](#list-workflow-library-operators) | **GET** `/workflow-library/operators` | List Workflow Library Operators +[**Get-V2024WorkflowLibraryTriggers**](#list-workflow-library-triggers) | **GET** `/workflow-library/triggers` | List Workflow Library Triggers +[**Get-V2024Workflows**](#list-workflows) | **GET** `/workflows` | List Workflows +[**Update-V2024Workflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch Workflow +[**Send-V2024Workflow**](#put-workflow) | **PUT** `/workflows/{id}` | Update Workflow +[**Test-V2024ExternalExecuteWorkflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger +[**Test-V2024Workflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id + +## cancel-workflow-execution +Use this API to cancel a running workflow execution. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The workflow execution ID + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + +# Cancel Workflow Execution by ID + +try { + Suspend-V2024WorkflowExecution-V2024Id $Id + + # Below is a request that includes all optional parameters + # Suspend-V2024WorkflowExecution -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024WorkflowExecution" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-external-execute-workflow +This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the workflow + Body | CreateExternalExecuteWorkflowRequest | [**CreateExternalExecuteWorkflowRequest**](../models/create-external-execute-workflow-request) | (optional) | + +### Return type +[**CreateExternalExecuteWorkflow200Response**](../models/create-external-execute-workflow200-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Workflow object | CreateExternalExecuteWorkflow200Response +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow +$CreateExternalExecuteWorkflowRequest = @""@ + +# Execute Workflow via External Trigger + +try { + New-V2024ExternalExecuteWorkflow-V2024Id $Id + + # Below is a request that includes all optional parameters + # New-V2024ExternalExecuteWorkflow -V2024Id $Id -V2024CreateExternalExecuteWorkflowRequest $CreateExternalExecuteWorkflowRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-workflow +Create a new workflow with the desired trigger and steps specified in the request body. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CreateWorkflowRequest | [**CreateWorkflowRequest**](../models/create-workflow-request) | True | + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Workflow object | Workflow +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CreateWorkflowRequest = @"{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}"@ + +# Create Workflow + +try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-V2024Workflow-V2024CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024Workflow -V2024CreateWorkflowRequest $CreateWorkflowRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-workflow-external-trigger +Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the workflow + +### Return type +[**WorkflowOAuthClient**](../models/workflow-o-auth-client) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The OAuth Client object | WorkflowOAuthClient +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + +# Generate External Trigger OAuth Client + +try { + New-V2024WorkflowExternalTrigger-V2024Id $Id + + # Below is a request that includes all optional parameters + # New-V2024WorkflowExternalTrigger -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024WorkflowExternalTrigger" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-workflow +Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the Workflow + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + +# Delete Workflow By Id + +try { + Remove-V2024Workflow-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Workflow -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-workflow +Get a single workflow by id. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the workflow + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The workflow object | Workflow +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + +# Get Workflow By Id + +try { + Get-V2024Workflow-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Workflow -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-workflow-execution +Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Workflow execution ID. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Workflow execution. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + +# Get Workflow Execution + +try { + Get-V2024WorkflowExecution-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecution -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecution" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-workflow-execution-history +Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the workflow execution + +### Return type +[**WorkflowExecutionEvent[]**](../models/workflow-execution-event) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of workflow execution events for the given workflow execution | WorkflowExecutionEvent[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + +# Get Workflow Execution History + +try { + Get-V2024WorkflowExecutionHistory-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecutionHistory -V2024Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutionHistory" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-workflow-executions +Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: +1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. +2. Get your workflow ID from the response. +3. You can then do either of the following: + + - Filter to find relevant workflow executions. + For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq "Failed"` + + - Paginate through results with the `offset` parameter. + For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. + Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Workflow ID. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* + +### Return type +[**WorkflowExecution[]**](../models/workflow-execution) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of workflow executions for the specified workflow. | WorkflowExecution[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'status eq "Failed"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + +# List Workflow Executions + +try { + Get-V2024WorkflowExecutions-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecutions -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-complete-workflow-library +This lists all triggers, actions, and operators in the library + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**ListCompleteWorkflowLibrary200ResponseInner[]**](../models/list-complete-workflow-library200-response-inner) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of workflow steps | ListCompleteWorkflowLibrary200ResponseInner[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + +# List Complete Workflow Library + +try { + Get-V2024CompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-V2024CompleteWorkflowLibrary -V2024Limit $Limit -V2024Offset $Offset +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompleteWorkflowLibrary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-workflow-library-actions +This lists the workflow actions available to you. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* + +### Return type +[**WorkflowLibraryAction[]**](../models/workflow-library-action) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of workflow actions | WorkflowLibraryAction[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Filters = 'id eq "sp:create-campaign"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + +# List Workflow Library Actions + +try { + Get-V2024WorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryActions -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryActions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-workflow-library-operators +This lists the workflow operators available to you + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**WorkflowLibraryOperator[]**](../models/workflow-library-operator) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of workflow operators | WorkflowLibraryOperator[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List Workflow Library Operators + +try { + Get-V2024WorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryOperators +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryOperators" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-workflow-library-triggers +This lists the workflow triggers available to you + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* + +### Return type +[**WorkflowLibraryTrigger[]**](../models/workflow-library-trigger) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of workflow triggers | WorkflowLibraryTrigger[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Filters = 'id eq "idn:identity-attributes-changed"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + +# List Workflow Library Triggers + +try { + Get-V2024WorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryTriggers -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryTriggers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-workflows +List all workflows in the tenant. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**Workflow[]**](../models/workflow) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of workflows | Workflow[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List Workflows + +try { + Get-V2024Workflows + + # Below is a request that includes all optional parameters + # Get-V2024Workflows +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflows" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-workflow +Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the Workflow + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Workflow object | Workflow +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | + + +# Patch Workflow + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Workflow-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Workflow -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-workflow +Perform a full update of a workflow. The updated workflow object is returned in the response. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the Workflow + Body | WorkflowBody | [**WorkflowBody**](../models/workflow-body) | True | + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Workflow object | Workflow +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow +$WorkflowBody = @"{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false +}"@ + +# Update Workflow + +try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-V2024Workflow-V2024Id $Id -V2024WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-V2024Workflow -V2024Id $Id -V2024WorkflowBody $WorkflowBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## test-external-execute-workflow +Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the workflow + Body | TestExternalExecuteWorkflowRequest | [**TestExternalExecuteWorkflowRequest**](../models/test-external-execute-workflow-request) | (optional) | + +### Return type +[**TestExternalExecuteWorkflow200Response**](../models/test-external-execute-workflow200-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the test input | TestExternalExecuteWorkflow200Response +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow +$TestExternalExecuteWorkflowRequest = @""@ + +# Test Workflow via External Trigger + +try { + Test-V2024ExternalExecuteWorkflow-V2024Id $Id + + # Below is a request that includes all optional parameters + # Test-V2024ExternalExecuteWorkflow -V2024Id $Id -V2024TestExternalExecuteWorkflowRequest $TestExternalExecuteWorkflowRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## test-workflow +Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow. +This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. +**This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the workflow + Body | TestWorkflowRequest | [**TestWorkflowRequest**](../models/test-workflow-request) | True | + +### Return type +[**TestWorkflow200Response**](../models/test-workflow200-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Workflow object | TestWorkflow200Response +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow +$TestWorkflowRequest = @"{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}"@ + +# Test Workflow By Id + +try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-V2024Workflow-V2024Id $Id -V2024TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-V2024Workflow -V2024Id $Id -V2024TestWorkflowRequest $TestWorkflowRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Access.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Access.md new file mode 100644 index 000000000..131af93fa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Access.md @@ -0,0 +1,43 @@ +--- +id: v2024-access +title: Access +pagination_label: Access +sidebar_label: Access +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Access', 'V2024Access'] +slug: /tools/sdk/powershell/v2024/models/access +tags: ['SDK', 'Software Development Kit', 'Access', 'V2024Access'] +--- + + +# Access + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$Access = Initialize-PSSailpoint.V2024Access -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -DisplayName John Q. Doe ` + -Type null ` + -Description null +``` + +- Convert the resource to JSON +```powershell +$Access | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessConstraint.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessConstraint.md new file mode 100644 index 000000000..778bc3e3e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessConstraint.md @@ -0,0 +1,39 @@ +--- +id: v2024-access-constraint +title: AccessConstraint +pagination_label: AccessConstraint +sidebar_label: AccessConstraint +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessConstraint', 'V2024AccessConstraint'] +slug: /tools/sdk/powershell/v2024/models/access-constraint +tags: ['SDK', 'Software Development Kit', 'AccessConstraint', 'V2024AccessConstraint'] +--- + + +# AccessConstraint + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessConstraint = Initialize-PSSailpoint.V2024AccessConstraint -Type ENTITLEMENT ` + -Ids [2c90ad2a70ace7d50170acf22ca90010] ` + -Operator SELECTED +``` + +- Convert the resource to JSON +```powershell +$AccessConstraint | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessCriteria.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessCriteria.md new file mode 100644 index 000000000..c6a08c47c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessCriteria.md @@ -0,0 +1,37 @@ +--- +id: v2024-access-criteria +title: AccessCriteria +pagination_label: AccessCriteria +sidebar_label: AccessCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessCriteria', 'V2024AccessCriteria'] +slug: /tools/sdk/powershell/v2024/models/access-criteria +tags: ['SDK', 'Software Development Kit', 'AccessCriteria', 'V2024AccessCriteria'] +--- + + +# AccessCriteria + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessCriteria = Initialize-PSSailpoint.V2024AccessCriteria -Name money-in ` + -CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}] +``` + +- Convert the resource to JSON +```powershell +$AccessCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessCriteriaCriteriaListInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessCriteriaCriteriaListInner.md new file mode 100644 index 000000000..d68211468 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessCriteriaCriteriaListInner.md @@ -0,0 +1,39 @@ +--- +id: v2024-access-criteria-criteria-list-inner +title: AccessCriteriaCriteriaListInner +pagination_label: AccessCriteriaCriteriaListInner +sidebar_label: AccessCriteriaCriteriaListInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessCriteriaCriteriaListInner', 'V2024AccessCriteriaCriteriaListInner'] +slug: /tools/sdk/powershell/v2024/models/access-criteria-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'AccessCriteriaCriteriaListInner', 'V2024AccessCriteriaCriteriaListInner'] +--- + + +# AccessCriteriaCriteriaListInner + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessCriteriaCriteriaListInner = Initialize-PSSailpoint.V2024AccessCriteriaCriteriaListInner -Type ENTITLEMENT ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name Administrator +``` + +- Convert the resource to JSON +```powershell +$AccessCriteriaCriteriaListInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemAccessProfileResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemAccessProfileResponse.md new file mode 100644 index 000000000..c06bc2775 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemAccessProfileResponse.md @@ -0,0 +1,57 @@ +--- +id: v2024-access-item-access-profile-response +title: AccessItemAccessProfileResponse +pagination_label: AccessItemAccessProfileResponse +sidebar_label: AccessItemAccessProfileResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemAccessProfileResponse', 'V2024AccessItemAccessProfileResponse'] +slug: /tools/sdk/powershell/v2024/models/access-item-access-profile-response +tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponse', 'V2024AccessItemAccessProfileResponse'] +--- + + +# AccessItemAccessProfileResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **String** | the access item type. accessProfile in this case | [optional] +**Id** | Pointer to **String** | the access item id | [optional] +**Name** | Pointer to **String** | the access profile name | [optional] +**SourceName** | Pointer to **String** | the name of the source | [optional] +**SourceId** | Pointer to **String** | the id of the source | [optional] +**Description** | Pointer to **String** | the description for the access profile | [optional] +**DisplayName** | Pointer to **String** | the display name of the identity | [optional] +**EntitlementCount** | Pointer to **String** | the number of entitlements the access profile will create | [optional] +**AppDisplayName** | Pointer to **String** | the name of | [optional] +**RemoveDate** | Pointer to **String** | the date the access profile is no longer assigned to the specified identity | [optional] +**Standalone** | **Boolean** | indicates whether the access profile is standalone | [required] +**Revocable** | **Boolean** | indicates whether the access profile is | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessItemAccessProfileResponse = Initialize-PSSailpoint.V2024AccessItemAccessProfileResponse -AccessType accessProfile ` + -Id 2c918087763e69d901763e72e97f006f ` + -Name sample ` + -SourceName DataScienceDataset ` + -SourceId 2793o32dwd ` + -Description AccessProfile - Workday/Citizenship access ` + -DisplayName Dr. Arden Rogahn MD ` + -EntitlementCount 12 ` + -AppDisplayName AppName ` + -RemoveDate 2024-07-01T06:00:00.00Z ` + -Standalone false ` + -Revocable true +``` + +- Convert the resource to JSON +```powershell +$AccessItemAccessProfileResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemAccountResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemAccountResponse.md new file mode 100644 index 000000000..a6326a6ad --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemAccountResponse.md @@ -0,0 +1,47 @@ +--- +id: v2024-access-item-account-response +title: AccessItemAccountResponse +pagination_label: AccessItemAccountResponse +sidebar_label: AccessItemAccountResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemAccountResponse', 'V2024AccessItemAccountResponse'] +slug: /tools/sdk/powershell/v2024/models/access-item-account-response +tags: ['SDK', 'Software Development Kit', 'AccessItemAccountResponse', 'V2024AccessItemAccountResponse'] +--- + + +# AccessItemAccountResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **String** | the access item type. account in this case | [optional] +**Id** | Pointer to **String** | the access item id | [optional] +**NativeIdentity** | Pointer to **String** | the native identifier used to uniquely identify an acccount | [optional] +**SourceName** | Pointer to **String** | the name of the source | [optional] +**SourceId** | Pointer to **String** | the id of the source | [optional] +**EntitlementCount** | Pointer to **String** | the number of entitlements the account will create | [optional] +**DisplayName** | Pointer to **String** | the display name of the identity | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessItemAccountResponse = Initialize-PSSailpoint.V2024AccessItemAccountResponse -AccessType account ` + -Id 2c918087763e69d901763e72e97f006f ` + -NativeIdentity dr.arden.ogahn.d ` + -SourceName DataScienceDataset ` + -SourceId 2793o32dwd ` + -EntitlementCount 12 ` + -DisplayName Dr. Arden Rogahn MD +``` + +- Convert the resource to JSON +```powershell +$AccessItemAccountResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemAppResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemAppResponse.md new file mode 100644 index 000000000..b60377672 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemAppResponse.md @@ -0,0 +1,43 @@ +--- +id: v2024-access-item-app-response +title: AccessItemAppResponse +pagination_label: AccessItemAppResponse +sidebar_label: AccessItemAppResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemAppResponse', 'V2024AccessItemAppResponse'] +slug: /tools/sdk/powershell/v2024/models/access-item-app-response +tags: ['SDK', 'Software Development Kit', 'AccessItemAppResponse', 'V2024AccessItemAppResponse'] +--- + + +# AccessItemAppResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **String** | the access item type. entitlement in this case | [optional] +**Id** | Pointer to **String** | the access item id | [optional] +**DisplayName** | Pointer to **String** | the access item display name | [optional] +**SourceName** | Pointer to **String** | the associated source name if it exists | [optional] +**AppRoleId** | Pointer to **String** | the app role id | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessItemAppResponse = Initialize-PSSailpoint.V2024AccessItemAppResponse -AccessType app ` + -Id 2c918087763e69d901763e72e97f006f ` + -DisplayName Display Name ` + -SourceName appName ` + -AppRoleId 2c918087763e69d901763e72e97f006f +``` + +- Convert the resource to JSON +```powershell +$AccessItemAppResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemApproverDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemApproverDto.md new file mode 100644 index 000000000..a5aa2e5f1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemApproverDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-access-item-approver-dto +title: AccessItemApproverDto +pagination_label: AccessItemApproverDto +sidebar_label: AccessItemApproverDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemApproverDto', 'V2024AccessItemApproverDto'] +slug: /tools/sdk/powershell/v2024/models/access-item-approver-dto +tags: ['SDK', 'Software Development Kit', 'AccessItemApproverDto', 'V2024AccessItemApproverDto'] +--- + + +# AccessItemApproverDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | DTO type of identity who approved the access item request. | [optional] +**Id** | Pointer to **String** | ID of identity who approved the access item request. | [optional] +**Name** | Pointer to **String** | Human-readable display name of identity who approved the access item request. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessItemApproverDto = Initialize-PSSailpoint.V2024AccessItemApproverDto -Type IDENTITY ` + -Id 2c3780a46faadee4016fb4e018c20652 ` + -Name Allen Albertson +``` + +- Convert the resource to JSON +```powershell +$AccessItemApproverDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemAssociated.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemAssociated.md new file mode 100644 index 000000000..5022bc4ab --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemAssociated.md @@ -0,0 +1,43 @@ +--- +id: v2024-access-item-associated +title: AccessItemAssociated +pagination_label: AccessItemAssociated +sidebar_label: AccessItemAssociated +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemAssociated', 'V2024AccessItemAssociated'] +slug: /tools/sdk/powershell/v2024/models/access-item-associated +tags: ['SDK', 'Software Development Kit', 'AccessItemAssociated', 'V2024AccessItemAssociated'] +--- + + +# AccessItemAssociated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessItem** | Pointer to [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional] +**IdentityId** | Pointer to **String** | the identity id | [optional] +**EventType** | Pointer to **String** | the event type | [optional] +**Dt** | Pointer to **String** | the date of event | [optional] +**GovernanceEvent** | Pointer to [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessItemAssociated = Initialize-PSSailpoint.V2024AccessItemAssociated -AccessItem null ` + -IdentityId 8c190e6787aa4ed9a90bd9d5344523fb ` + -EventType AccessItemAssociated ` + -Dt 2019-03-08T22:37:33.901Z ` + -GovernanceEvent null +``` + +- Convert the resource to JSON +```powershell +$AccessItemAssociated | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemAssociatedAccessItem.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemAssociatedAccessItem.md new file mode 100644 index 000000000..f35d27c79 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemAssociatedAccessItem.md @@ -0,0 +1,71 @@ +--- +id: v2024-access-item-associated-access-item +title: AccessItemAssociatedAccessItem +pagination_label: AccessItemAssociatedAccessItem +sidebar_label: AccessItemAssociatedAccessItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemAssociatedAccessItem', 'V2024AccessItemAssociatedAccessItem'] +slug: /tools/sdk/powershell/v2024/models/access-item-associated-access-item +tags: ['SDK', 'Software Development Kit', 'AccessItemAssociatedAccessItem', 'V2024AccessItemAssociatedAccessItem'] +--- + + +# AccessItemAssociatedAccessItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **String** | the access item type. role in this case | [optional] +**Id** | Pointer to **String** | the access item id | [optional] +**Name** | Pointer to **String** | the access profile name | [optional] +**SourceName** | Pointer to **String** | the associated source name if it exists | [optional] +**SourceId** | Pointer to **String** | the id of the source | [optional] +**Description** | Pointer to **String** | the description for the role | [optional] +**DisplayName** | Pointer to **String** | the role display name | [optional] +**EntitlementCount** | Pointer to **String** | the number of entitlements the account will create | [optional] +**AppDisplayName** | Pointer to **String** | the name of | [optional] +**RemoveDate** | Pointer to **String** | the date the role is no longer assigned to the specified identity | [optional] +**Standalone** | **Boolean** | indicates whether the entitlement is standalone | [required] +**Revocable** | **Boolean** | indicates whether the role is revocable | [required] +**NativeIdentity** | Pointer to **String** | the native identifier used to uniquely identify an acccount | [optional] +**AppRoleId** | Pointer to **String** | the app role id | [optional] +**Attribute** | Pointer to **String** | the entitlement attribute | [optional] +**Value** | Pointer to **String** | the associated value | [optional] +**EntitlementType** | Pointer to **String** | the type of entitlement | [optional] +**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required] +**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessItemAssociatedAccessItem = Initialize-PSSailpoint.V2024AccessItemAssociatedAccessItem -AccessType role ` + -Id 2c918087763e69d901763e72e97f006f ` + -Name sample ` + -SourceName Source Name ` + -SourceId 2793o32dwd ` + -Description Role - Workday/Citizenship access ` + -DisplayName sample ` + -EntitlementCount 12 ` + -AppDisplayName AppName ` + -RemoveDate 2024-07-01T06:00:00.00Z ` + -Standalone true ` + -Revocable true ` + -NativeIdentity dr.arden.ogahn.d ` + -AppRoleId 2c918087763e69d901763e72e97f006f ` + -Attribute groups ` + -Value Upward mobility access ` + -EntitlementType entitlement ` + -Privileged false ` + -CloudGoverned true +``` + +- Convert the resource to JSON +```powershell +$AccessItemAssociatedAccessItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemDiff.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemDiff.md new file mode 100644 index 000000000..d6b3906be --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemDiff.md @@ -0,0 +1,41 @@ +--- +id: v2024-access-item-diff +title: AccessItemDiff +pagination_label: AccessItemDiff +sidebar_label: AccessItemDiff +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemDiff', 'V2024AccessItemDiff'] +slug: /tools/sdk/powershell/v2024/models/access-item-diff +tags: ['SDK', 'Software Development Kit', 'AccessItemDiff', 'V2024AccessItemDiff'] +--- + + +# AccessItemDiff + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | the id of the access item | [optional] +**EventType** | Pointer to **Enum** [ "ADD", "REMOVE" ] | | [optional] +**DisplayName** | Pointer to **String** | the display name of the access item | [optional] +**SourceName** | Pointer to **String** | the source name of the access item | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessItemDiff = Initialize-PSSailpoint.V2024AccessItemDiff -Id null ` + -EventType null ` + -DisplayName null ` + -SourceName null +``` + +- Convert the resource to JSON +```powershell +$AccessItemDiff | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemEntitlementResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemEntitlementResponse.md new file mode 100644 index 000000000..ca5363792 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemEntitlementResponse.md @@ -0,0 +1,57 @@ +--- +id: v2024-access-item-entitlement-response +title: AccessItemEntitlementResponse +pagination_label: AccessItemEntitlementResponse +sidebar_label: AccessItemEntitlementResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemEntitlementResponse', 'V2024AccessItemEntitlementResponse'] +slug: /tools/sdk/powershell/v2024/models/access-item-entitlement-response +tags: ['SDK', 'Software Development Kit', 'AccessItemEntitlementResponse', 'V2024AccessItemEntitlementResponse'] +--- + + +# AccessItemEntitlementResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **String** | the access item type. entitlement in this case | [optional] +**Id** | Pointer to **String** | the access item id | [optional] +**Attribute** | Pointer to **String** | the entitlement attribute | [optional] +**Value** | Pointer to **String** | the associated value | [optional] +**EntitlementType** | Pointer to **String** | the type of entitlement | [optional] +**SourceName** | Pointer to **String** | the name of the source | [optional] +**SourceId** | Pointer to **String** | the id of the source | [optional] +**Description** | Pointer to **String** | the description for the entitlment | [optional] +**DisplayName** | Pointer to **String** | the display name of the identity | [optional] +**Standalone** | **Boolean** | indicates whether the entitlement is standalone | [required] +**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required] +**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessItemEntitlementResponse = Initialize-PSSailpoint.V2024AccessItemEntitlementResponse -AccessType entitlement ` + -Id 2c918087763e69d901763e72e97f006f ` + -Attribute groups ` + -Value Upward mobility access ` + -EntitlementType entitlement ` + -SourceName DataScienceDataset ` + -SourceId 2793o32dwd ` + -Description Entitlement - Workday/Citizenship access ` + -DisplayName Dr. Arden Rogahn MD ` + -Standalone true ` + -Privileged false ` + -CloudGoverned true +``` + +- Convert the resource to JSON +```powershell +$AccessItemEntitlementResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemRef.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemRef.md new file mode 100644 index 000000000..0d0a4f29d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemRef.md @@ -0,0 +1,37 @@ +--- +id: v2024-access-item-ref +title: AccessItemRef +pagination_label: AccessItemRef +sidebar_label: AccessItemRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRef', 'V2024AccessItemRef'] +slug: /tools/sdk/powershell/v2024/models/access-item-ref +tags: ['SDK', 'Software Development Kit', 'AccessItemRef', 'V2024AccessItemRef'] +--- + + +# AccessItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the access item to retrieve the recommendation for. | [optional] +**Type** | Pointer to **Enum** [ "ENTITLEMENT", "ACCESS_PROFILE", "ROLE" ] | Access item's type. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessItemRef = Initialize-PSSailpoint.V2024AccessItemRef -Id 2c938083633d259901633d2623ec0375 ` + -Type ENTITLEMENT +``` + +- Convert the resource to JSON +```powershell +$AccessItemRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemRemoved.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemRemoved.md new file mode 100644 index 000000000..609e05553 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemRemoved.md @@ -0,0 +1,43 @@ +--- +id: v2024-access-item-removed +title: AccessItemRemoved +pagination_label: AccessItemRemoved +sidebar_label: AccessItemRemoved +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRemoved', 'V2024AccessItemRemoved'] +slug: /tools/sdk/powershell/v2024/models/access-item-removed +tags: ['SDK', 'Software Development Kit', 'AccessItemRemoved', 'V2024AccessItemRemoved'] +--- + + +# AccessItemRemoved + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessItem** | Pointer to [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional] +**IdentityId** | Pointer to **String** | the identity id | [optional] +**EventType** | Pointer to **String** | the event type | [optional] +**Dt** | Pointer to **String** | the date of event | [optional] +**GovernanceEvent** | Pointer to [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessItemRemoved = Initialize-PSSailpoint.V2024AccessItemRemoved -AccessItem null ` + -IdentityId 8c190e6787aa4ed9a90bd9d5344523fb ` + -EventType AccessItemRemoved ` + -Dt 2019-03-08T22:37:33.901Z ` + -GovernanceEvent null +``` + +- Convert the resource to JSON +```powershell +$AccessItemRemoved | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemRequestedFor.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemRequestedFor.md new file mode 100644 index 000000000..7ea9a37c1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemRequestedFor.md @@ -0,0 +1,39 @@ +--- +id: v2024-access-item-requested-for +title: AccessItemRequestedFor +pagination_label: AccessItemRequestedFor +sidebar_label: AccessItemRequestedFor +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRequestedFor', 'V2024AccessItemRequestedFor'] +slug: /tools/sdk/powershell/v2024/models/access-item-requested-for +tags: ['SDK', 'Software Development Kit', 'AccessItemRequestedFor', 'V2024AccessItemRequestedFor'] +--- + + +# AccessItemRequestedFor + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessItemRequestedFor = Initialize-PSSailpoint.V2024AccessItemRequestedFor -Type IDENTITY ` + -Id 2c4180a46faadee4016fb4e018c20626 ` + -Name Robert Robinson +``` + +- Convert the resource to JSON +```powershell +$AccessItemRequestedFor | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemRequestedForDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemRequestedForDto.md new file mode 100644 index 000000000..3f4b84988 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemRequestedForDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-access-item-requested-for-dto +title: AccessItemRequestedForDto +pagination_label: AccessItemRequestedForDto +sidebar_label: AccessItemRequestedForDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRequestedForDto', 'V2024AccessItemRequestedForDto'] +slug: /tools/sdk/powershell/v2024/models/access-item-requested-for-dto +tags: ['SDK', 'Software Development Kit', 'AccessItemRequestedForDto', 'V2024AccessItemRequestedForDto'] +--- + + +# AccessItemRequestedForDto + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessItemRequestedForDto = Initialize-PSSailpoint.V2024AccessItemRequestedForDto -Type IDENTITY ` + -Id 2c4180a46faadee4016fb4e018c20626 ` + -Name Robert Robinson +``` + +- Convert the resource to JSON +```powershell +$AccessItemRequestedForDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemRequester.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemRequester.md new file mode 100644 index 000000000..0af97ad7a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemRequester.md @@ -0,0 +1,39 @@ +--- +id: v2024-access-item-requester +title: AccessItemRequester +pagination_label: AccessItemRequester +sidebar_label: AccessItemRequester +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRequester', 'V2024AccessItemRequester'] +slug: /tools/sdk/powershell/v2024/models/access-item-requester +tags: ['SDK', 'Software Development Kit', 'AccessItemRequester', 'V2024AccessItemRequester'] +--- + + +# AccessItemRequester + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessItemRequester = Initialize-PSSailpoint.V2024AccessItemRequester -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20648 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$AccessItemRequester | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemRequesterDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemRequesterDto.md new file mode 100644 index 000000000..b27a591bb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemRequesterDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-access-item-requester-dto +title: AccessItemRequesterDto +pagination_label: AccessItemRequesterDto +sidebar_label: AccessItemRequesterDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRequesterDto', 'V2024AccessItemRequesterDto'] +slug: /tools/sdk/powershell/v2024/models/access-item-requester-dto +tags: ['SDK', 'Software Development Kit', 'AccessItemRequesterDto', 'V2024AccessItemRequesterDto'] +--- + + +# AccessItemRequesterDto + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessItemRequesterDto = Initialize-PSSailpoint.V2024AccessItemRequesterDto -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20648 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$AccessItemRequesterDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemReviewedBy.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemReviewedBy.md new file mode 100644 index 000000000..0acf81986 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemReviewedBy.md @@ -0,0 +1,39 @@ +--- +id: v2024-access-item-reviewed-by +title: AccessItemReviewedBy +pagination_label: AccessItemReviewedBy +sidebar_label: AccessItemReviewedBy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemReviewedBy', 'V2024AccessItemReviewedBy'] +slug: /tools/sdk/powershell/v2024/models/access-item-reviewed-by +tags: ['SDK', 'Software Development Kit', 'AccessItemReviewedBy', 'V2024AccessItemReviewedBy'] +--- + + +# AccessItemReviewedBy + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessItemReviewedBy = Initialize-PSSailpoint.V2024AccessItemReviewedBy -Type IDENTITY ` + -Id 2c3780a46faadee4016fb4e018c20652 ` + -Name Allen Albertson +``` + +- Convert the resource to JSON +```powershell +$AccessItemReviewedBy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemRoleResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemRoleResponse.md new file mode 100644 index 000000000..707705fea --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessItemRoleResponse.md @@ -0,0 +1,47 @@ +--- +id: v2024-access-item-role-response +title: AccessItemRoleResponse +pagination_label: AccessItemRoleResponse +sidebar_label: AccessItemRoleResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRoleResponse', 'V2024AccessItemRoleResponse'] +slug: /tools/sdk/powershell/v2024/models/access-item-role-response +tags: ['SDK', 'Software Development Kit', 'AccessItemRoleResponse', 'V2024AccessItemRoleResponse'] +--- + + +# AccessItemRoleResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **String** | the access item type. role in this case | [optional] +**Id** | Pointer to **String** | the access item id | [optional] +**DisplayName** | Pointer to **String** | the role display name | [optional] +**Description** | Pointer to **String** | the description for the role | [optional] +**SourceName** | Pointer to **String** | the associated source name if it exists | [optional] +**RemoveDate** | Pointer to **String** | the date the role is no longer assigned to the specified identity | [optional] +**Revocable** | **Boolean** | indicates whether the role is revocable | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessItemRoleResponse = Initialize-PSSailpoint.V2024AccessItemRoleResponse -AccessType role ` + -Id 2c918087763e69d901763e72e97f006f ` + -DisplayName sample ` + -Description Role - Workday/Citizenship access ` + -SourceName Source Name ` + -RemoveDate 2024-07-01T06:00:00.00Z ` + -Revocable true +``` + +- Convert the resource to JSON +```powershell +$AccessItemRoleResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfile.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfile.md new file mode 100644 index 000000000..5c4d188c7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfile.md @@ -0,0 +1,61 @@ +--- +id: v2024-access-profile +title: AccessProfile +pagination_label: AccessProfile +sidebar_label: AccessProfile +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfile', 'V2024AccessProfile'] +slug: /tools/sdk/powershell/v2024/models/access-profile +tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'V2024AccessProfile'] +--- + + +# AccessProfile + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfile = Initialize-PSSailpoint.V2024AccessProfile -Id 2c91808a7190d06e01719938fcd20792 ` + -Name Employee-database-read-write ` + -Description Collection of entitlements to read/write the employee database ` + -Created 2021-03-01T22:32:58.104Z ` + -Modified 2021-03-02T20:22:28.104Z ` + -Enabled true ` + -Owner null ` + -Source null ` + -Entitlements null ` + -Requestable true ` + -AccessRequestConfig null ` + -RevocationRequestConfig null ` + -Segments [f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a] ` + -ProvisioningCriteria null +``` + +- Convert the resource to JSON +```powershell +$AccessProfile | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileApprovalScheme.md new file mode 100644 index 000000000..ffddd7379 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileApprovalScheme.md @@ -0,0 +1,37 @@ +--- +id: v2024-access-profile-approval-scheme +title: AccessProfileApprovalScheme +pagination_label: AccessProfileApprovalScheme +sidebar_label: AccessProfileApprovalScheme +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileApprovalScheme', 'V2024AccessProfileApprovalScheme'] +slug: /tools/sdk/powershell/v2024/models/access-profile-approval-scheme +tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'V2024AccessProfileApprovalScheme'] +--- + + +# AccessProfileApprovalScheme + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileApprovalScheme = Initialize-PSSailpoint.V2024AccessProfileApprovalScheme -ApproverType GOVERNANCE_GROUP ` + -ApproverId 46c79819-a69f-49a2-becb-12c971ae66c6 +``` + +- Convert the resource to JSON +```powershell +$AccessProfileApprovalScheme | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileBulkDeleteRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileBulkDeleteRequest.md new file mode 100644 index 000000000..876f085a2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileBulkDeleteRequest.md @@ -0,0 +1,37 @@ +--- +id: v2024-access-profile-bulk-delete-request +title: AccessProfileBulkDeleteRequest +pagination_label: AccessProfileBulkDeleteRequest +sidebar_label: AccessProfileBulkDeleteRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileBulkDeleteRequest', 'V2024AccessProfileBulkDeleteRequest'] +slug: /tools/sdk/powershell/v2024/models/access-profile-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteRequest', 'V2024AccessProfileBulkDeleteRequest'] +--- + + +# AccessProfileBulkDeleteRequest + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileBulkDeleteRequest = Initialize-PSSailpoint.V2024AccessProfileBulkDeleteRequest -AccessProfileIds [2c9180847812e0b1017817051919ecca, 2c9180887812e0b201781e129f151816] ` + -BestEffortOnly true +``` + +- Convert the resource to JSON +```powershell +$AccessProfileBulkDeleteRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileBulkDeleteResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileBulkDeleteResponse.md new file mode 100644 index 000000000..52302356c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileBulkDeleteResponse.md @@ -0,0 +1,39 @@ +--- +id: v2024-access-profile-bulk-delete-response +title: AccessProfileBulkDeleteResponse +pagination_label: AccessProfileBulkDeleteResponse +sidebar_label: AccessProfileBulkDeleteResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileBulkDeleteResponse', 'V2024AccessProfileBulkDeleteResponse'] +slug: /tools/sdk/powershell/v2024/models/access-profile-bulk-delete-response +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteResponse', 'V2024AccessProfileBulkDeleteResponse'] +--- + + +# AccessProfileBulkDeleteResponse + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileBulkDeleteResponse = Initialize-PSSailpoint.V2024AccessProfileBulkDeleteResponse -TaskId 2c9180867817ac4d017817c491119a20 ` + -Pending [2c91808876438bbb017668c21919ecca, 2c91808876438bb201766e129f151816] ` + -InUse null +``` + +- Convert the resource to JSON +```powershell +$AccessProfileBulkDeleteResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileBulkUpdateRequestInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileBulkUpdateRequestInner.md new file mode 100644 index 000000000..0da3b8e77 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileBulkUpdateRequestInner.md @@ -0,0 +1,37 @@ +--- +id: v2024-access-profile-bulk-update-request-inner +title: AccessProfileBulkUpdateRequestInner +pagination_label: AccessProfileBulkUpdateRequestInner +sidebar_label: AccessProfileBulkUpdateRequestInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileBulkUpdateRequestInner', 'V2024AccessProfileBulkUpdateRequestInner'] +slug: /tools/sdk/powershell/v2024/models/access-profile-bulk-update-request-inner +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkUpdateRequestInner', 'V2024AccessProfileBulkUpdateRequestInner'] +--- + + +# AccessProfileBulkUpdateRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Access Profile ID. | [optional] +**Requestable** | Pointer to **Boolean** | Access Profile is requestable or not. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileBulkUpdateRequestInner = Initialize-PSSailpoint.V2024AccessProfileBulkUpdateRequestInner -Id 464ae7bf-791e-49fd-b746-06a2e4a8 ` + -Requestable false +``` + +- Convert the resource to JSON +```powershell +$AccessProfileBulkUpdateRequestInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileDetails.md new file mode 100644 index 000000000..1f77381bf --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileDetails.md @@ -0,0 +1,79 @@ +--- +id: v2024-access-profile-details +title: AccessProfileDetails +pagination_label: AccessProfileDetails +sidebar_label: AccessProfileDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileDetails', 'V2024AccessProfileDetails'] +slug: /tools/sdk/powershell/v2024/models/access-profile-details +tags: ['SDK', 'Software Development Kit', 'AccessProfileDetails', 'V2024AccessProfileDetails'] +--- + + +# AccessProfileDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of the Access Profile | [optional] +**Name** | Pointer to **String** | Name of the Access Profile | [optional] +**Description** | Pointer to **String** | Information about the Access Profile | [optional] +**Created** | Pointer to **System.DateTime** | Date the Access Profile was created | [optional] +**Modified** | Pointer to **System.DateTime** | Date the Access Profile was last modified. | [optional] +**Disabled** | Pointer to **Boolean** | Whether the Access Profile is enabled. | [optional] [default to $true] +**Requestable** | Pointer to **Boolean** | Whether the Access Profile is requestable via access request. | [optional] [default to $false] +**Protected** | Pointer to **Boolean** | Whether the Access Profile is protected. | [optional] [default to $false] +**OwnerId** | Pointer to **String** | The owner ID of the Access Profile | [optional] +**SourceId** | Pointer to **Int64** | The source ID of the Access Profile | [optional] +**SourceName** | Pointer to **String** | The source name of the Access Profile | [optional] +**AppId** | Pointer to **Int64** | The source app ID of the Access Profile | [optional] +**AppName** | Pointer to **String** | The source app name of the Access Profile | [optional] +**ApplicationId** | Pointer to **String** | The id of the application | [optional] +**Type** | Pointer to **String** | The type of the access profile | [optional] +**Entitlements** | Pointer to **[]String** | List of IDs of entitlements | [optional] +**EntitlementCount** | Pointer to **Int32** | The number of entitlements in the access profile | [optional] +**Segments** | Pointer to **[]String** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**ApprovalSchemes** | Pointer to **String** | Comma-separated list of approval schemes. Each approval scheme is one of - manager - appOwner - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [optional] +**RevokeRequestApprovalSchemes** | Pointer to **String** | Comma-separated list of revoke request approval schemes. Each approval scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [optional] +**RequestCommentsRequired** | Pointer to **Boolean** | Whether the access profile require request comment for access request. | [optional] [default to $false] +**DeniedCommentsRequired** | Pointer to **Boolean** | Whether denied comment is required when access request is denied. | [optional] [default to $false] +**AccountSelector** | Pointer to [**AccessProfileDetailsAccountSelector**](access-profile-details-account-selector) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileDetails = Initialize-PSSailpoint.V2024AccessProfileDetails -Id 2c91808a7190d06e01719938fcd20792 ` + -Name Employee-database-read-write ` + -Description Collection of entitlements to read/write the employee database ` + -Created 2021-03-01T22:32:58.104Z ` + -Modified 2021-03-02T20:22:28.104Z ` + -Disabled true ` + -Requestable true ` + -Protected false ` + -OwnerId 9870808a7190d06e01719938fcd20792 ` + -SourceId 10360661 ` + -SourceName AD Source ` + -AppId 10360661 ` + -AppName mail app ` + -ApplicationId edcb0951812949d085b60cd8bf35bc78 ` + -Type source ` + -Entitlements [2c9180857725c14301772a93bb77242d, c9dc28e148a24d65b3ccb5fb8ca5ddd9] ` + -EntitlementCount 12 ` + -Segments [f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a] ` + -ApprovalSchemes accessProfileOwner ` + -RevokeRequestApprovalSchemes accessProfileOwner ` + -RequestCommentsRequired true ` + -DeniedCommentsRequired true ` + -AccountSelector null +``` + +- Convert the resource to JSON +```powershell +$AccessProfileDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileDetailsAccountSelector.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileDetailsAccountSelector.md new file mode 100644 index 000000000..bcdacab0d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileDetailsAccountSelector.md @@ -0,0 +1,35 @@ +--- +id: v2024-access-profile-details-account-selector +title: AccessProfileDetailsAccountSelector +pagination_label: AccessProfileDetailsAccountSelector +sidebar_label: AccessProfileDetailsAccountSelector +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileDetailsAccountSelector', 'V2024AccessProfileDetailsAccountSelector'] +slug: /tools/sdk/powershell/v2024/models/access-profile-details-account-selector +tags: ['SDK', 'Software Development Kit', 'AccessProfileDetailsAccountSelector', 'V2024AccessProfileDetailsAccountSelector'] +--- + + +# AccessProfileDetailsAccountSelector + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Selectors** | Pointer to [**[]Selector**](selector) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileDetailsAccountSelector = Initialize-PSSailpoint.V2024AccessProfileDetailsAccountSelector -Selectors null +``` + +- Convert the resource to JSON +```powershell +$AccessProfileDetailsAccountSelector | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileDocument.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileDocument.md new file mode 100644 index 000000000..8246a26eb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileDocument.md @@ -0,0 +1,63 @@ +--- +id: v2024-access-profile-document +title: AccessProfileDocument +pagination_label: AccessProfileDocument +sidebar_label: AccessProfileDocument +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileDocument', 'V2024AccessProfileDocument'] +slug: /tools/sdk/powershell/v2024/models/access-profile-document +tags: ['SDK', 'Software Development Kit', 'AccessProfileDocument', 'V2024AccessProfileDocument'] +--- + + +# AccessProfileDocument + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileDocument = Initialize-PSSailpoint.V2024AccessProfileDocument -Id 2c9180825a6c1adc015a71c9023f0818 ` + -Name Cloud Eng ` + -Description The admin role ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Synced 2018-06-25T20:22:33.104Z ` + -Enabled true ` + -Requestable true ` + -RequestCommentsRequired false ` + -Owner null ` + -Type accessprofile ` + -Source null ` + -Entitlements null ` + -EntitlementCount 5 ` + -Tags [TAG_1, TAG_2] +``` + +- Convert the resource to JSON +```powershell +$AccessProfileDocument | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileDocumentAllOfSource.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileDocumentAllOfSource.md new file mode 100644 index 000000000..89ccf2ab9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileDocumentAllOfSource.md @@ -0,0 +1,37 @@ +--- +id: v2024-access-profile-document-all-of-source +title: AccessProfileDocumentAllOfSource +pagination_label: AccessProfileDocumentAllOfSource +sidebar_label: AccessProfileDocumentAllOfSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileDocumentAllOfSource', 'V2024AccessProfileDocumentAllOfSource'] +slug: /tools/sdk/powershell/v2024/models/access-profile-document-all-of-source +tags: ['SDK', 'Software Development Kit', 'AccessProfileDocumentAllOfSource', 'V2024AccessProfileDocumentAllOfSource'] +--- + + +# AccessProfileDocumentAllOfSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Source's ID. | [optional] +**Name** | Pointer to **String** | Source's name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileDocumentAllOfSource = Initialize-PSSailpoint.V2024AccessProfileDocumentAllOfSource -Id ff8081815757d4fb0157588f3d9d008f ` + -Name Employees +``` + +- Convert the resource to JSON +```powershell +$AccessProfileDocumentAllOfSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileEntitlement.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileEntitlement.md new file mode 100644 index 000000000..71d9fd4e8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileEntitlement.md @@ -0,0 +1,53 @@ +--- +id: v2024-access-profile-entitlement +title: AccessProfileEntitlement +pagination_label: AccessProfileEntitlement +sidebar_label: AccessProfileEntitlement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileEntitlement', 'V2024AccessProfileEntitlement'] +slug: /tools/sdk/powershell/v2024/models/access-profile-entitlement +tags: ['SDK', 'Software Development Kit', 'AccessProfileEntitlement', 'V2024AccessProfileEntitlement'] +--- + + +# AccessProfileEntitlement + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileEntitlement = Initialize-PSSailpoint.V2024AccessProfileEntitlement -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -DisplayName John Q. Doe ` + -Type null ` + -Description null ` + -Source null ` + -Privileged false ` + -Attribute memberOf ` + -Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com ` + -Standalone false +``` + +- Convert the resource to JSON +```powershell +$AccessProfileEntitlement | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileRef.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileRef.md new file mode 100644 index 000000000..429e9092a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileRef.md @@ -0,0 +1,39 @@ +--- +id: v2024-access-profile-ref +title: AccessProfileRef +pagination_label: AccessProfileRef +sidebar_label: AccessProfileRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileRef', 'V2024AccessProfileRef'] +slug: /tools/sdk/powershell/v2024/models/access-profile-ref +tags: ['SDK', 'Software Development Kit', 'AccessProfileRef', 'V2024AccessProfileRef'] +--- + + +# AccessProfileRef + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileRef = Initialize-PSSailpoint.V2024AccessProfileRef -Id ff808081751e6e129f1518161919ecca ` + -Type ACCESS_PROFILE ` + -Name Access Profile 2567 +``` + +- Convert the resource to JSON +```powershell +$AccessProfileRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileRole.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileRole.md new file mode 100644 index 000000000..af58212ea --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileRole.md @@ -0,0 +1,49 @@ +--- +id: v2024-access-profile-role +title: AccessProfileRole +pagination_label: AccessProfileRole +sidebar_label: AccessProfileRole +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileRole', 'V2024AccessProfileRole'] +slug: /tools/sdk/powershell/v2024/models/access-profile-role +tags: ['SDK', 'Software Development Kit', 'AccessProfileRole', 'V2024AccessProfileRole'] +--- + + +# AccessProfileRole + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileRole = Initialize-PSSailpoint.V2024AccessProfileRole -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -DisplayName John Q. Doe ` + -Type null ` + -Description null ` + -Owner null ` + -Disabled null ` + -Revocable null +``` + +- Convert the resource to JSON +```powershell +$AccessProfileRole | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileSourceRef.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileSourceRef.md new file mode 100644 index 000000000..1527a0eb3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileSourceRef.md @@ -0,0 +1,39 @@ +--- +id: v2024-access-profile-source-ref +title: AccessProfileSourceRef +pagination_label: AccessProfileSourceRef +sidebar_label: AccessProfileSourceRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileSourceRef', 'V2024AccessProfileSourceRef'] +slug: /tools/sdk/powershell/v2024/models/access-profile-source-ref +tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'V2024AccessProfileSourceRef'] +--- + + +# AccessProfileSourceRef + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileSourceRef = Initialize-PSSailpoint.V2024AccessProfileSourceRef -Id 2c91809773dee3610173fdb0b6061ef4 ` + -Type SOURCE ` + -Name ODS-AD-SOURCE +``` + +- Convert the resource to JSON +```powershell +$AccessProfileSourceRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileSummary.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileSummary.md new file mode 100644 index 000000000..bf6f6ccef --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileSummary.md @@ -0,0 +1,49 @@ +--- +id: v2024-access-profile-summary +title: AccessProfileSummary +pagination_label: AccessProfileSummary +sidebar_label: AccessProfileSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileSummary', 'V2024AccessProfileSummary'] +slug: /tools/sdk/powershell/v2024/models/access-profile-summary +tags: ['SDK', 'Software Development Kit', 'AccessProfileSummary', 'V2024AccessProfileSummary'] +--- + + +# AccessProfileSummary + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileSummary = Initialize-PSSailpoint.V2024AccessProfileSummary -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -DisplayName John Q. Doe ` + -Type null ` + -Description null ` + -Source null ` + -Owner null ` + -Revocable true +``` + +- Convert the resource to JSON +```powershell +$AccessProfileSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileUpdateItem.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileUpdateItem.md new file mode 100644 index 000000000..25fcd1aef --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileUpdateItem.md @@ -0,0 +1,45 @@ +--- +id: v2024-access-profile-update-item +title: AccessProfileUpdateItem +pagination_label: AccessProfileUpdateItem +sidebar_label: AccessProfileUpdateItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileUpdateItem', 'V2024AccessProfileUpdateItem'] +slug: /tools/sdk/powershell/v2024/models/access-profile-update-item +tags: ['SDK', 'Software Development Kit', 'AccessProfileUpdateItem', 'V2024AccessProfileUpdateItem'] +--- + + +# AccessProfileUpdateItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Identifier of Access Profile in bulk update request. | [required] +**Requestable** | **Boolean** | Access Profile requestable or not. | [required] +**Status** | **String** | The HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation. > 201 - Access profile is updated successfully. > 404 - Access profile not found. | [required] +**Description** | Pointer to **String** | Human readable status description and containing additional context information about success or failures etc. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileUpdateItem = Initialize-PSSailpoint.V2024AccessProfileUpdateItem -Id 2c7180a46faadee4016fb4e018c20642 ` + -Requestable false ` + -Status 201 ` + -Description +> Access profile is updated successfully. + +> Referenced Access profile with Id "2c7180a46faadee4016fb4e018c20642" was not found. + +``` + +- Convert the resource to JSON +```powershell +$AccessProfileUpdateItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileUsage.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileUsage.md new file mode 100644 index 000000000..c93c1f921 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileUsage.md @@ -0,0 +1,37 @@ +--- +id: v2024-access-profile-usage +title: AccessProfileUsage +pagination_label: AccessProfileUsage +sidebar_label: AccessProfileUsage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileUsage', 'V2024AccessProfileUsage'] +slug: /tools/sdk/powershell/v2024/models/access-profile-usage +tags: ['SDK', 'Software Development Kit', 'AccessProfileUsage', 'V2024AccessProfileUsage'] +--- + + +# AccessProfileUsage + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileUsage = Initialize-PSSailpoint.V2024AccessProfileUsage -AccessProfileId 2c91808876438bbb017668c21919ecca ` + -UsedBy null +``` + +- Convert the resource to JSON +```powershell +$AccessProfileUsage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileUsageUsedByInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileUsageUsedByInner.md new file mode 100644 index 000000000..03636603c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessProfileUsageUsedByInner.md @@ -0,0 +1,39 @@ +--- +id: v2024-access-profile-usage-used-by-inner +title: AccessProfileUsageUsedByInner +pagination_label: AccessProfileUsageUsedByInner +sidebar_label: AccessProfileUsageUsedByInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileUsageUsedByInner', 'V2024AccessProfileUsageUsedByInner'] +slug: /tools/sdk/powershell/v2024/models/access-profile-usage-used-by-inner +tags: ['SDK', 'Software Development Kit', 'AccessProfileUsageUsedByInner', 'V2024AccessProfileUsageUsedByInner'] +--- + + +# AccessProfileUsageUsedByInner + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileUsageUsedByInner = Initialize-PSSailpoint.V2024AccessProfileUsageUsedByInner -Type ROLE ` + -Id 2c8180857a9b3da0017aa03418480f9d ` + -Name Manager Role +``` + +- Convert the resource to JSON +```powershell +$AccessProfileUsageUsedByInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRecommendationMessage.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRecommendationMessage.md new file mode 100644 index 000000000..039bea9ee --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRecommendationMessage.md @@ -0,0 +1,35 @@ +--- +id: v2024-access-recommendation-message +title: AccessRecommendationMessage +pagination_label: AccessRecommendationMessage +sidebar_label: AccessRecommendationMessage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRecommendationMessage', 'V2024AccessRecommendationMessage'] +slug: /tools/sdk/powershell/v2024/models/access-recommendation-message +tags: ['SDK', 'Software Development Kit', 'AccessRecommendationMessage', 'V2024AccessRecommendationMessage'] +--- + + +# AccessRecommendationMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Interpretation** | Pointer to **String** | Information about why the access item was recommended. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRecommendationMessage = Initialize-PSSailpoint.V2024AccessRecommendationMessage -Interpretation 95% of your peers have this access. +``` + +- Convert the resource to JSON +```powershell +$AccessRecommendationMessage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequest.md new file mode 100644 index 000000000..e9417b6e4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequest.md @@ -0,0 +1,41 @@ +--- +id: v2024-access-request +title: AccessRequest +pagination_label: AccessRequest +sidebar_label: AccessRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequest', 'V2024AccessRequest'] +slug: /tools/sdk/powershell/v2024/models/access-request +tags: ['SDK', 'Software Development Kit', 'AccessRequest', 'V2024AccessRequest'] +--- + + +# AccessRequest + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessRequest = Initialize-PSSailpoint.V2024AccessRequest -RequestedFor null ` + -RequestType null ` + -RequestedItems null ` + -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} +``` + +- Convert the resource to JSON +```powershell +$AccessRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestAdminItemStatus.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestAdminItemStatus.md new file mode 100644 index 000000000..4fb238d1f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestAdminItemStatus.md @@ -0,0 +1,81 @@ +--- +id: v2024-access-request-admin-item-status +title: AccessRequestAdminItemStatus +pagination_label: AccessRequestAdminItemStatus +sidebar_label: AccessRequestAdminItemStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestAdminItemStatus', 'V2024AccessRequestAdminItemStatus'] +slug: /tools/sdk/powershell/v2024/models/access-request-admin-item-status +tags: ['SDK', 'Software Development Kit', 'AccessRequestAdminItemStatus', 'V2024AccessRequestAdminItemStatus'] +--- + + +# AccessRequestAdminItemStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Human-readable display name of the item being requested. | [optional] +**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | Type of requested object. | [optional] +**CancelledRequestDetails** | Pointer to [**AccessRequestAdminItemStatusCancelledRequestDetails**](access-request-admin-item-status-cancelled-request-details) | | [optional] +**ErrorMessages** | Pointer to [**[]ErrorMessageDto1[]**](error-message-dto1) | List of localized error messages, if any, encountered during the approval/provisioning process. | [optional] +**State** | Pointer to [**RequestedItemStatusRequestState**](requested-item-status-request-state) | | [optional] +**ApprovalDetails** | Pointer to [**[]ApprovalStatusDto1**](approval-status-dto1) | Approval details for each item. | [optional] +**ManualWorkItemDetails** | Pointer to [**[]ManualWorkItemDetails1**](manual-work-item-details1) | Manual work items created for provisioning the item. | [optional] +**AccountActivityItemId** | Pointer to **String** | Id of associated account activity item. | [optional] +**RequestType** | Pointer to [**AccessRequestType**](access-request-type) | | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] +**Requester** | Pointer to [**AccessItemRequester**](access-item-requester) | | [optional] +**RequestedFor** | Pointer to [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] +**RequesterComment** | Pointer to [**RequestedItemStatusRequesterComment**](requested-item-status-requester-comment) | | [optional] +**SodViolationContext** | Pointer to [**AccessRequestAdminItemStatusSodViolationContext**](access-request-admin-item-status-sod-violation-context) | | [optional] +**ProvisioningDetails** | Pointer to [**RequestedItemStatusProvisioningDetails**](requested-item-status-provisioning-details) | | [optional] +**PreApprovalTriggerDetails** | Pointer to [**RequestedItemStatusPreApprovalTriggerDetails**](requested-item-status-pre-approval-trigger-details) | | [optional] +**AccessRequestPhases** | Pointer to [**[]AccessRequestPhases**](access-request-phases) | A list of Phases that the Access Request has gone through in order, to help determine the status of the request. | [optional] +**Description** | Pointer to **String** | Description associated to the requested object. | [optional] +**RemoveDate** | Pointer to **System.DateTime** | When the role access is scheduled for removal. | [optional] +**Cancelable** | Pointer to **Boolean** | True if the request can be canceled. | [optional] [default to $false] +**ReauthorizationRequired** | Pointer to **Boolean** | True if re-auth is required. | [optional] [default to $false] +**AccessRequestId** | Pointer to **String** | This is the account activity id. | [optional] +**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestAdminItemStatus = Initialize-PSSailpoint.V2024AccessRequestAdminItemStatus -Name AccessProfile1 ` + -Type ACCESS_PROFILE ` + -CancelledRequestDetails null ` + -ErrorMessages null ` + -State null ` + -ApprovalDetails null ` + -ManualWorkItemDetails null ` + -AccountActivityItemId 2c9180926cbfbddd016cbfc7c3b10010 ` + -RequestType null ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z ` + -Requester null ` + -RequestedFor null ` + -RequesterComment null ` + -SodViolationContext null ` + -ProvisioningDetails null ` + -PreApprovalTriggerDetails null ` + -AccessRequestPhases null ` + -Description This is the Engineering role that engineers are granted. ` + -RemoveDate 2019-10-23T00:00Z ` + -Cancelable true ` + -ReauthorizationRequired true ` + -AccessRequestId 2b838de9-db9b-abcf-e646-d4f274ad4238 ` + -ClientMetadata {key1=value1, key2=value2} +``` + +- Convert the resource to JSON +```powershell +$AccessRequestAdminItemStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestAdminItemStatusCancelledRequestDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestAdminItemStatusCancelledRequestDetails.md new file mode 100644 index 000000000..7784c335e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestAdminItemStatusCancelledRequestDetails.md @@ -0,0 +1,39 @@ +--- +id: v2024-access-request-admin-item-status-cancelled-request-details +title: AccessRequestAdminItemStatusCancelledRequestDetails +pagination_label: AccessRequestAdminItemStatusCancelledRequestDetails +sidebar_label: AccessRequestAdminItemStatusCancelledRequestDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestAdminItemStatusCancelledRequestDetails', 'V2024AccessRequestAdminItemStatusCancelledRequestDetails'] +slug: /tools/sdk/powershell/v2024/models/access-request-admin-item-status-cancelled-request-details +tags: ['SDK', 'Software Development Kit', 'AccessRequestAdminItemStatusCancelledRequestDetails', 'V2024AccessRequestAdminItemStatusCancelledRequestDetails'] +--- + + +# AccessRequestAdminItemStatusCancelledRequestDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment made by the owner when cancelling the associated request. | [optional] +**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**Modified** | Pointer to **System.DateTime** | Date comment was added by the owner when cancelling the associated request. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestAdminItemStatusCancelledRequestDetails = Initialize-PSSailpoint.V2024AccessRequestAdminItemStatusCancelledRequestDetails -Comment This request must be cancelled. ` + -Owner null ` + -Modified 2019-12-20T09:17:12.192Z +``` + +- Convert the resource to JSON +```powershell +$AccessRequestAdminItemStatusCancelledRequestDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestAdminItemStatusSodViolationContext.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestAdminItemStatusSodViolationContext.md new file mode 100644 index 000000000..21f6af519 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestAdminItemStatusSodViolationContext.md @@ -0,0 +1,39 @@ +--- +id: v2024-access-request-admin-item-status-sod-violation-context +title: AccessRequestAdminItemStatusSodViolationContext +pagination_label: AccessRequestAdminItemStatusSodViolationContext +sidebar_label: AccessRequestAdminItemStatusSodViolationContext +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestAdminItemStatusSodViolationContext', 'V2024AccessRequestAdminItemStatusSodViolationContext'] +slug: /tools/sdk/powershell/v2024/models/access-request-admin-item-status-sod-violation-context +tags: ['SDK', 'Software Development Kit', 'AccessRequestAdminItemStatusSodViolationContext', 'V2024AccessRequestAdminItemStatusSodViolationContext'] +--- + + +# AccessRequestAdminItemStatusSodViolationContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **Enum** [ "SUCCESS", "ERROR" ] | The status of SOD violation check | [optional] +**Uuid** | Pointer to **String** | The id of the Violation check event | [optional] +**ViolationCheckResult** | Pointer to [**SodViolationCheckResult1**](sod-violation-check-result1) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestAdminItemStatusSodViolationContext = Initialize-PSSailpoint.V2024AccessRequestAdminItemStatusSodViolationContext -State SUCCESS ` + -Uuid f73d16e9-a038-46c5-b217-1246e15fdbdd ` + -ViolationCheckResult null +``` + +- Convert the resource to JSON +```powershell +$AccessRequestAdminItemStatusSodViolationContext | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestApproversListResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestApproversListResponse.md new file mode 100644 index 000000000..1807690d8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestApproversListResponse.md @@ -0,0 +1,43 @@ +--- +id: v2024-access-request-approvers-list-response +title: AccessRequestApproversListResponse +pagination_label: AccessRequestApproversListResponse +sidebar_label: AccessRequestApproversListResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestApproversListResponse', 'V2024AccessRequestApproversListResponse'] +slug: /tools/sdk/powershell/v2024/models/access-request-approvers-list-response +tags: ['SDK', 'Software Development Kit', 'AccessRequestApproversListResponse', 'V2024AccessRequestApproversListResponse'] +--- + + +# AccessRequestApproversListResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Approver id. | [optional] +**Email** | Pointer to **String** | Email of the approver. | [optional] +**Name** | Pointer to **String** | Name of the approver. | [optional] +**ApprovalId** | Pointer to **String** | Id of the approval item. | [optional] +**Type** | Pointer to **String** | Type of the object returned. In this case, the value for this field will always Identity. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestApproversListResponse = Initialize-PSSailpoint.V2024AccessRequestApproversListResponse -Id id12345 ` + -Email jdoe@sailpoint.com ` + -Name John Doe ` + -ApprovalId ap12345 ` + -Type Identity +``` + +- Convert the resource to JSON +```powershell +$AccessRequestApproversListResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestConfig.md new file mode 100644 index 000000000..697f0f7ac --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestConfig.md @@ -0,0 +1,45 @@ +--- +id: v2024-access-request-config +title: AccessRequestConfig +pagination_label: AccessRequestConfig +sidebar_label: AccessRequestConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestConfig', 'V2024AccessRequestConfig'] +slug: /tools/sdk/powershell/v2024/models/access-request-config +tags: ['SDK', 'Software Development Kit', 'AccessRequestConfig', 'V2024AccessRequestConfig'] +--- + + +# AccessRequestConfig + +## Properties + +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 [**EntitlementRequestConfig1**](entitlement-request-config1) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestConfig = Initialize-PSSailpoint.V2024AccessRequestConfig -ApprovalsMustBeExternal true ` + -AutoApprovalEnabled true ` + -ReauthorizationEnabled true ` + -RequestOnBehalfOfConfig null ` + -ApprovalReminderAndEscalationConfig null ` + -EntitlementRequestConfig null +``` + +- Convert the resource to JSON +```powershell +$AccessRequestConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestContext.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestContext.md new file mode 100644 index 000000000..3c07a3d9d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestContext.md @@ -0,0 +1,35 @@ +--- +id: v2024-access-request-context +title: AccessRequestContext +pagination_label: AccessRequestContext +sidebar_label: AccessRequestContext +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestContext', 'V2024AccessRequestContext'] +slug: /tools/sdk/powershell/v2024/models/access-request-context +tags: ['SDK', 'Software Development Kit', 'AccessRequestContext', 'V2024AccessRequestContext'] +--- + + +# AccessRequestContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ContextAttributes** | Pointer to [**[]ContextAttributeDto**](context-attribute-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestContext = Initialize-PSSailpoint.V2024AccessRequestContext -ContextAttributes null +``` + +- Convert the resource to JSON +```powershell +$AccessRequestContext | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestDynamicApprover.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestDynamicApprover.md new file mode 100644 index 000000000..419993cd5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestDynamicApprover.md @@ -0,0 +1,41 @@ +--- +id: v2024-access-request-dynamic-approver +title: AccessRequestDynamicApprover +pagination_label: AccessRequestDynamicApprover +sidebar_label: AccessRequestDynamicApprover +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestDynamicApprover', 'V2024AccessRequestDynamicApprover'] +slug: /tools/sdk/powershell/v2024/models/access-request-dynamic-approver +tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover', 'V2024AccessRequestDynamicApprover'] +--- + + +# AccessRequestDynamicApprover + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestId** | **String** | The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-request-status) to get the status of the request. | [required] +**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required] +**RequestedItems** | [**[]AccessRequestDynamicApproverRequestedItemsInner**](access-request-dynamic-approver-requested-items-inner) | The access items that are being requested. | [required] +**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestDynamicApprover = Initialize-PSSailpoint.V2024AccessRequestDynamicApprover -AccessRequestId 4b4d982dddff4267ab12f0f1e72b5a6d ` + -RequestedFor null ` + -RequestedItems null ` + -RequestedBy null +``` + +- Convert the resource to JSON +```powershell +$AccessRequestDynamicApprover | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestDynamicApprover1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestDynamicApprover1.md new file mode 100644 index 000000000..d316aa07e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestDynamicApprover1.md @@ -0,0 +1,39 @@ +--- +id: v2024-access-request-dynamic-approver1 +title: AccessRequestDynamicApprover1 +pagination_label: AccessRequestDynamicApprover1 +sidebar_label: AccessRequestDynamicApprover1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestDynamicApprover1', 'V2024AccessRequestDynamicApprover1'] +slug: /tools/sdk/powershell/v2024/models/access-request-dynamic-approver1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover1', 'V2024AccessRequestDynamicApprover1'] +--- + + +# AccessRequestDynamicApprover1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the identity to add to the approver list for the access request. | [required] +**Name** | **String** | The name of the identity to add to the approver list for the access request. | [required] +**Type** | **Enum** [ "IDENTITY", "GOVERNANCE_GROUP" ] | The type of object being referenced. | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestDynamicApprover1 = Initialize-PSSailpoint.V2024AccessRequestDynamicApprover1 -Id 2c91808b6ef1d43e016efba0ce470906 ` + -Name Adam Adams ` + -Type IDENTITY +``` + +- Convert the resource to JSON +```powershell +$AccessRequestDynamicApprover1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestDynamicApproverRequestedItemsInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestDynamicApproverRequestedItemsInner.md new file mode 100644 index 000000000..372aae78f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestDynamicApproverRequestedItemsInner.md @@ -0,0 +1,45 @@ +--- +id: v2024-access-request-dynamic-approver-requested-items-inner +title: AccessRequestDynamicApproverRequestedItemsInner +pagination_label: AccessRequestDynamicApproverRequestedItemsInner +sidebar_label: AccessRequestDynamicApproverRequestedItemsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestDynamicApproverRequestedItemsInner', 'V2024AccessRequestDynamicApproverRequestedItemsInner'] +slug: /tools/sdk/powershell/v2024/models/access-request-dynamic-approver-requested-items-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApproverRequestedItemsInner', 'V2024AccessRequestDynamicApproverRequestedItemsInner'] +--- + + +# AccessRequestDynamicApproverRequestedItemsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the access item. | [required] +**Name** | **String** | Human friendly name of the access item. | [required] +**Description** | Pointer to **String** | Extended description of the access item. | [optional] +**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of access item being requested. | [required] +**Operation** | **Enum** [ "Add", "Remove" ] | Grant or revoke the access item | [required] +**Comment** | Pointer to **String** | A comment from the requestor on why the access is needed. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestDynamicApproverRequestedItemsInner = Initialize-PSSailpoint.V2024AccessRequestDynamicApproverRequestedItemsInner -Id 2c91808b6ef1d43e016efba0ce470904 ` + -Name Engineering Access ` + -Description Engineering Access ` + -Type ACCESS_PROFILE ` + -Operation Add ` + -Comment William needs this access for his day to day job activities. +``` + +- Convert the resource to JSON +```powershell +$AccessRequestDynamicApproverRequestedItemsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestItem.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestItem.md new file mode 100644 index 000000000..e7107de92 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestItem.md @@ -0,0 +1,43 @@ +--- +id: v2024-access-request-item +title: AccessRequestItem +pagination_label: AccessRequestItem +sidebar_label: AccessRequestItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestItem', 'V2024AccessRequestItem'] +slug: /tools/sdk/powershell/v2024/models/access-request-item +tags: ['SDK', 'Software Development Kit', 'AccessRequestItem', 'V2024AccessRequestItem'] +--- + + +# AccessRequestItem + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestItem = Initialize-PSSailpoint.V2024AccessRequestItem -Type ACCESS_PROFILE ` + -Id 2c9180835d2e5168015d32f890ca1581 ` + -Comment Requesting access profile for John Doe ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -RemoveDate 2020-07-11T21:23:15Z +``` + +- Convert the resource to JSON +```powershell +$AccessRequestItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestItemResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestItemResponse.md new file mode 100644 index 000000000..f08f6c780 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestItemResponse.md @@ -0,0 +1,49 @@ +--- +id: v2024-access-request-item-response +title: AccessRequestItemResponse +pagination_label: AccessRequestItemResponse +sidebar_label: AccessRequestItemResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestItemResponse', 'V2024AccessRequestItemResponse'] +slug: /tools/sdk/powershell/v2024/models/access-request-item-response +tags: ['SDK', 'Software Development Kit', 'AccessRequestItemResponse', 'V2024AccessRequestItemResponse'] +--- + + +# AccessRequestItemResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to **String** | the access request item operation | [optional] +**AccessItemType** | Pointer to **String** | the access item type | [optional] +**Name** | Pointer to **String** | the name of access request item | [optional] +**Decision** | Pointer to **Enum** [ "APPROVED", "REJECTED" ] | the final decision for the access request | [optional] +**Description** | Pointer to **String** | the description of access request item | [optional] +**SourceId** | Pointer to **String** | the source id | [optional] +**SourceName** | Pointer to **String** | the source Name | [optional] +**ApprovalInfos** | Pointer to [**[]ApprovalInfoResponse**](approval-info-response) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestItemResponse = Initialize-PSSailpoint.V2024AccessRequestItemResponse -Operation Add ` + -AccessItemType role ` + -Name Role-1 ` + -Decision APPROVED ` + -Description The role descrition ` + -SourceId 8a80828f643d484f01643e14202e206f ` + -SourceName Source1 ` + -ApprovalInfos [{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}] +``` + +- Convert the resource to JSON +```powershell +$AccessRequestItemResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestPhases.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestPhases.md new file mode 100644 index 000000000..62303daf6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestPhases.md @@ -0,0 +1,45 @@ +--- +id: v2024-access-request-phases +title: AccessRequestPhases +pagination_label: AccessRequestPhases +sidebar_label: AccessRequestPhases +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPhases', 'V2024AccessRequestPhases'] +slug: /tools/sdk/powershell/v2024/models/access-request-phases +tags: ['SDK', 'Software Development Kit', 'AccessRequestPhases', 'V2024AccessRequestPhases'] +--- + + +# AccessRequestPhases + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestPhases = Initialize-PSSailpoint.V2024AccessRequestPhases -Started 2020-07-11T00:00Z ` + -Finished 2020-07-12T00:00Z ` + -Name APPROVAL_PHASE ` + -State COMPLETED ` + -Result SUCCESSFUL ` + -PhaseReference approvalDetails +``` + +- Convert the resource to JSON +```powershell +$AccessRequestPhases | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestPostApproval.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestPostApproval.md new file mode 100644 index 000000000..9612235db --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestPostApproval.md @@ -0,0 +1,41 @@ +--- +id: v2024-access-request-post-approval +title: AccessRequestPostApproval +pagination_label: AccessRequestPostApproval +sidebar_label: AccessRequestPostApproval +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPostApproval', 'V2024AccessRequestPostApproval'] +slug: /tools/sdk/powershell/v2024/models/access-request-post-approval +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApproval', 'V2024AccessRequestPostApproval'] +--- + + +# AccessRequestPostApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestId** | **String** | The unique ID of the access request. | [required] +**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required] +**RequestedItemsStatus** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details on the outcome of each access item. | [required] +**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestPostApproval = Initialize-PSSailpoint.V2024AccessRequestPostApproval -AccessRequestId 2c91808b6ef1d43e016efba0ce470904 ` + -RequestedFor null ` + -RequestedItemsStatus null ` + -RequestedBy null +``` + +- Convert the resource to JSON +```powershell +$AccessRequestPostApproval | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md new file mode 100644 index 000000000..85638dfae --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md @@ -0,0 +1,49 @@ +--- +id: v2024-access-request-post-approval-requested-items-status-inner +title: AccessRequestPostApprovalRequestedItemsStatusInner +pagination_label: AccessRequestPostApprovalRequestedItemsStatusInner +sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInner', 'V2024AccessRequestPostApprovalRequestedItemsStatusInner'] +slug: /tools/sdk/powershell/v2024/models/access-request-post-approval-requested-items-status-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInner', 'V2024AccessRequestPostApprovalRequestedItemsStatusInner'] +--- + + +# AccessRequestPostApprovalRequestedItemsStatusInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the access item being requested. | [required] +**Name** | **String** | The human friendly name of the access item. | [required] +**Description** | Pointer to **String** | Detailed description of the access item. | [optional] +**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of access item. | [required] +**Operation** | **Enum** [ "Add", "Remove" ] | The action to perform on the access item. | [required] +**Comment** | Pointer to **String** | A comment from the identity requesting the access. | [optional] +**ClientMetadata** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Additional customer defined metadata about the access item. | [optional] +**ApprovalInfo** | [**[]AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner**](access-request-post-approval-requested-items-status-inner-approval-info-inner) | A list of one or more approvers for the access request. | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestPostApprovalRequestedItemsStatusInner = Initialize-PSSailpoint.V2024AccessRequestPostApprovalRequestedItemsStatusInner -Id 2c91808b6ef1d43e016efba0ce470904 ` + -Name Engineering Access ` + -Description Access to engineering database ` + -Type ACCESS_PROFILE ` + -Operation Add ` + -Comment William needs this access to do his job. ` + -ClientMetadata {applicationName=My application} ` + -ApprovalInfo null +``` + +- Convert the resource to JSON +```powershell +$AccessRequestPostApprovalRequestedItemsStatusInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md new file mode 100644 index 000000000..00d41427c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md @@ -0,0 +1,41 @@ +--- +id: v2024-access-request-post-approval-requested-items-status-inner-approval-info-inner +title: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner +pagination_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner +sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner', 'V2024AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner'] +slug: /tools/sdk/powershell/v2024/models/access-request-post-approval-requested-items-status-inner-approval-info-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner', 'V2024AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner'] +--- + + +# AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalComment** | Pointer to **String** | A comment left by the approver. | [optional] +**ApprovalDecision** | **Enum** [ "APPROVED", "DENIED" ] | The final decision of the approver. | [required] +**ApproverName** | **String** | The name of the approver | [required] +**Approver** | [**AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover**](access-request-post-approval-requested-items-status-inner-approval-info-inner-approver) | | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner = Initialize-PSSailpoint.V2024AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner -ApprovalComment This access looks good. Approved. ` + -ApprovalDecision APPROVED ` + -ApproverName Stephen.Austin ` + -Approver null +``` + +- Convert the resource to JSON +```powershell +$AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md new file mode 100644 index 000000000..c0895a840 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md @@ -0,0 +1,39 @@ +--- +id: v2024-access-request-post-approval-requested-items-status-inner-approval-info-inner-approver +title: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover +pagination_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover +sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover', 'V2024AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover'] +slug: /tools/sdk/powershell/v2024/models/access-request-post-approval-requested-items-status-inner-approval-info-inner-approver +tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover', 'V2024AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover'] +--- + + +# AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | The type of object that is referenced | [required] +**Id** | **String** | ID of identity who approved the access item request. | [required] +**Name** | **String** | Human-readable display name of identity who approved the access item request. | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover = Initialize-PSSailpoint.V2024AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover -Type IDENTITY ` + -Id 2c3780a46faadee4016fb4e018c20652 ` + -Name Allen Albertson +``` + +- Convert the resource to JSON +```powershell +$AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestPreApproval.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestPreApproval.md new file mode 100644 index 000000000..a97efd8fb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestPreApproval.md @@ -0,0 +1,41 @@ +--- +id: v2024-access-request-pre-approval +title: AccessRequestPreApproval +pagination_label: AccessRequestPreApproval +sidebar_label: AccessRequestPreApproval +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPreApproval', 'V2024AccessRequestPreApproval'] +slug: /tools/sdk/powershell/v2024/models/access-request-pre-approval +tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApproval', 'V2024AccessRequestPreApproval'] +--- + + +# AccessRequestPreApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestId** | **String** | The unique ID of the access request. | [required] +**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required] +**RequestedItems** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details of the access items being requested. | [required] +**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestPreApproval = Initialize-PSSailpoint.V2024AccessRequestPreApproval -AccessRequestId 2c91808b6ef1d43e016efba0ce470904 ` + -RequestedFor null ` + -RequestedItems null ` + -RequestedBy null +``` + +- Convert the resource to JSON +```powershell +$AccessRequestPreApproval | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestPreApproval1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestPreApproval1.md new file mode 100644 index 000000000..fdc4a282c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestPreApproval1.md @@ -0,0 +1,39 @@ +--- +id: v2024-access-request-pre-approval1 +title: AccessRequestPreApproval1 +pagination_label: AccessRequestPreApproval1 +sidebar_label: AccessRequestPreApproval1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPreApproval1', 'V2024AccessRequestPreApproval1'] +slug: /tools/sdk/powershell/v2024/models/access-request-pre-approval1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApproval1', 'V2024AccessRequestPreApproval1'] +--- + + +# AccessRequestPreApproval1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Approved** | **Boolean** | Whether or not to approve the access request. | [required] +**Comment** | **String** | A comment about the decision to approve or deny the request. | [required] +**Approver** | **String** | The name of the entity that approved or denied the request. | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestPreApproval1 = Initialize-PSSailpoint.V2024AccessRequestPreApproval1 -Approved false ` + -Comment This access should be denied, because this will cause an SOD violation. ` + -Approver AcmeCorpExternalIntegration +``` + +- Convert the resource to JSON +```powershell +$AccessRequestPreApproval1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestPreApprovalRequestedItemsInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestPreApprovalRequestedItemsInner.md new file mode 100644 index 000000000..dbd8cfc88 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestPreApprovalRequestedItemsInner.md @@ -0,0 +1,45 @@ +--- +id: v2024-access-request-pre-approval-requested-items-inner +title: AccessRequestPreApprovalRequestedItemsInner +pagination_label: AccessRequestPreApprovalRequestedItemsInner +sidebar_label: AccessRequestPreApprovalRequestedItemsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPreApprovalRequestedItemsInner', 'V2024AccessRequestPreApprovalRequestedItemsInner'] +slug: /tools/sdk/powershell/v2024/models/access-request-pre-approval-requested-items-inner +tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApprovalRequestedItemsInner', 'V2024AccessRequestPreApprovalRequestedItemsInner'] +--- + + +# AccessRequestPreApprovalRequestedItemsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the access item being requested. | [required] +**Name** | **String** | The human friendly name of the access item. | [required] +**Description** | Pointer to **String** | Detailed description of the access item. | [optional] +**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of access item. | [required] +**Operation** | **Enum** [ "Add", "Remove" ] | The action to perform on the access item. | [required] +**Comment** | Pointer to **String** | A comment from the identity requesting the access. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestPreApprovalRequestedItemsInner = Initialize-PSSailpoint.V2024AccessRequestPreApprovalRequestedItemsInner -Id 2c91808b6ef1d43e016efba0ce470904 ` + -Name Engineering Access ` + -Description Access to engineering database ` + -Type ACCESS_PROFILE ` + -Operation Add ` + -Comment William needs this access to do his job. +``` + +- Convert the resource to JSON +```powershell +$AccessRequestPreApprovalRequestedItemsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestRecommendationActionItemDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestRecommendationActionItemDto.md new file mode 100644 index 000000000..81dac8522 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestRecommendationActionItemDto.md @@ -0,0 +1,37 @@ +--- +id: v2024-access-request-recommendation-action-item-dto +title: AccessRequestRecommendationActionItemDto +pagination_label: AccessRequestRecommendationActionItemDto +sidebar_label: AccessRequestRecommendationActionItemDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationActionItemDto', 'V2024AccessRequestRecommendationActionItemDto'] +slug: /tools/sdk/powershell/v2024/models/access-request-recommendation-action-item-dto +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationActionItemDto', 'V2024AccessRequestRecommendationActionItemDto'] +--- + + +# AccessRequestRecommendationActionItemDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **String** | The identity ID taking the action. | [required] +**Access** | [**AccessRequestRecommendationItem**](access-request-recommendation-item) | | [required] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestRecommendationActionItemDto = Initialize-PSSailpoint.V2024AccessRequestRecommendationActionItemDto -IdentityId 2c91808570313110017040b06f344ec9 ` + -Access null +``` + +- Convert the resource to JSON +```powershell +$AccessRequestRecommendationActionItemDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestRecommendationActionItemResponseDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestRecommendationActionItemResponseDto.md new file mode 100644 index 000000000..d029d3b59 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestRecommendationActionItemResponseDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-access-request-recommendation-action-item-response-dto +title: AccessRequestRecommendationActionItemResponseDto +pagination_label: AccessRequestRecommendationActionItemResponseDto +sidebar_label: AccessRequestRecommendationActionItemResponseDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationActionItemResponseDto', 'V2024AccessRequestRecommendationActionItemResponseDto'] +slug: /tools/sdk/powershell/v2024/models/access-request-recommendation-action-item-response-dto +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationActionItemResponseDto', 'V2024AccessRequestRecommendationActionItemResponseDto'] +--- + + +# AccessRequestRecommendationActionItemResponseDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **String** | The identity ID taking the action. | [optional] +**Access** | Pointer to [**AccessRequestRecommendationItem**](access-request-recommendation-item) | | [optional] +**Timestamp** | Pointer to **System.DateTime** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestRecommendationActionItemResponseDto = Initialize-PSSailpoint.V2024AccessRequestRecommendationActionItemResponseDto -IdentityId 2c91808570313110017040b06f344ec9 ` + -Access null ` + -Timestamp 2017-07-11T18:45:37.098Z +``` + +- Convert the resource to JSON +```powershell +$AccessRequestRecommendationActionItemResponseDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestRecommendationItem.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestRecommendationItem.md new file mode 100644 index 000000000..05b149fe4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestRecommendationItem.md @@ -0,0 +1,37 @@ +--- +id: v2024-access-request-recommendation-item +title: AccessRequestRecommendationItem +pagination_label: AccessRequestRecommendationItem +sidebar_label: AccessRequestRecommendationItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationItem', 'V2024AccessRequestRecommendationItem'] +slug: /tools/sdk/powershell/v2024/models/access-request-recommendation-item +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItem', 'V2024AccessRequestRecommendationItem'] +--- + + +# AccessRequestRecommendationItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of access item being recommended. | [optional] +**Type** | Pointer to [**AccessRequestRecommendationItemType**](access-request-recommendation-item-type) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestRecommendationItem = Initialize-PSSailpoint.V2024AccessRequestRecommendationItem -Id 2c9180835d2e5168015d32f890ca1581 ` + -Type null +``` + +- Convert the resource to JSON +```powershell +$AccessRequestRecommendationItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestRecommendationItemDetail.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestRecommendationItemDetail.md new file mode 100644 index 000000000..0e8afc04d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestRecommendationItemDetail.md @@ -0,0 +1,47 @@ +--- +id: v2024-access-request-recommendation-item-detail +title: AccessRequestRecommendationItemDetail +pagination_label: AccessRequestRecommendationItemDetail +sidebar_label: AccessRequestRecommendationItemDetail +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationItemDetail', 'V2024AccessRequestRecommendationItemDetail'] +slug: /tools/sdk/powershell/v2024/models/access-request-recommendation-item-detail +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemDetail', 'V2024AccessRequestRecommendationItemDetail'] +--- + + +# AccessRequestRecommendationItemDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **String** | Identity ID for the recommendation | [optional] +**Access** | Pointer to [**AccessRequestRecommendationItemDetailAccess**](access-request-recommendation-item-detail-access) | | [optional] +**Ignored** | Pointer to **Boolean** | Whether or not the identity has already chosen to ignore this recommendation. | [optional] +**Requested** | Pointer to **Boolean** | Whether or not the identity has already chosen to request this recommendation. | [optional] +**Viewed** | Pointer to **Boolean** | Whether or not the identity reportedly viewed this recommendation. | [optional] +**Messages** | Pointer to [**[]AccessRecommendationMessage**](access-recommendation-message) | | [optional] +**TranslationMessages** | Pointer to [**[]TranslationMessage**](translation-message) | The list of translation messages | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestRecommendationItemDetail = Initialize-PSSailpoint.V2024AccessRequestRecommendationItemDetail -IdentityId 2c91808570313110017040b06f344ec9 ` + -Access null ` + -Ignored true ` + -Requested true ` + -Viewed true ` + -Messages null ` + -TranslationMessages [{key=recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values=[75, department]}] +``` + +- Convert the resource to JSON +```powershell +$AccessRequestRecommendationItemDetail | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestRecommendationItemDetailAccess.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestRecommendationItemDetailAccess.md new file mode 100644 index 000000000..745e988f9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestRecommendationItemDetailAccess.md @@ -0,0 +1,41 @@ +--- +id: v2024-access-request-recommendation-item-detail-access +title: AccessRequestRecommendationItemDetailAccess +pagination_label: AccessRequestRecommendationItemDetailAccess +sidebar_label: AccessRequestRecommendationItemDetailAccess +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationItemDetailAccess', 'V2024AccessRequestRecommendationItemDetailAccess'] +slug: /tools/sdk/powershell/v2024/models/access-request-recommendation-item-detail-access +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemDetailAccess', 'V2024AccessRequestRecommendationItemDetailAccess'] +--- + + +# AccessRequestRecommendationItemDetailAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of access item being recommended. | [optional] +**Type** | Pointer to [**AccessRequestRecommendationItemType**](access-request-recommendation-item-type) | | [optional] +**Name** | Pointer to **String** | Name of the access item | [optional] +**Description** | Pointer to **String** | Description of the access item | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestRecommendationItemDetailAccess = Initialize-PSSailpoint.V2024AccessRequestRecommendationItemDetailAccess -Id 2c9180835d2e5168015d32f890ca1581 ` + -Type null ` + -Name Employee-database-read-write ` + -Description This item grants an employee read and write access to the database +``` + +- Convert the resource to JSON +```powershell +$AccessRequestRecommendationItemDetailAccess | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestRecommendationItemType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestRecommendationItemType.md new file mode 100644 index 000000000..ae6af1589 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestRecommendationItemType.md @@ -0,0 +1,24 @@ +--- +id: v2024-access-request-recommendation-item-type +title: AccessRequestRecommendationItemType +pagination_label: AccessRequestRecommendationItemType +sidebar_label: AccessRequestRecommendationItemType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationItemType', 'V2024AccessRequestRecommendationItemType'] +slug: /tools/sdk/powershell/v2024/models/access-request-recommendation-item-type +tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemType', 'V2024AccessRequestRecommendationItemType'] +--- + + +# AccessRequestRecommendationItemType + +## Enum + + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ROLE` (value: `"ROLE"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestResponse.md new file mode 100644 index 000000000..ba1aa9141 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestResponse.md @@ -0,0 +1,37 @@ +--- +id: v2024-access-request-response +title: AccessRequestResponse +pagination_label: AccessRequestResponse +sidebar_label: AccessRequestResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestResponse', 'V2024AccessRequestResponse'] +slug: /tools/sdk/powershell/v2024/models/access-request-response +tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse', 'V2024AccessRequestResponse'] +--- + + +# AccessRequestResponse + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestResponse = Initialize-PSSailpoint.V2024AccessRequestResponse -NewRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ENTITLEMENT, id=779c6fd7171540bba1184e5946112c28}], attributesHash=-1928438224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdb]}] ` + -ExistingRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ROLE, id=779c6fd7171540bbc1184e5946112c28}], attributesHash=2843118224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdc]}] +``` + +- Convert the resource to JSON +```powershell +$AccessRequestResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestResponse1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestResponse1.md new file mode 100644 index 000000000..e62a1e79d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestResponse1.md @@ -0,0 +1,39 @@ +--- +id: v2024-access-request-response1 +title: AccessRequestResponse1 +pagination_label: AccessRequestResponse1 +sidebar_label: AccessRequestResponse1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestResponse1', 'V2024AccessRequestResponse1'] +slug: /tools/sdk/powershell/v2024/models/access-request-response1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse1', 'V2024AccessRequestResponse1'] +--- + + +# AccessRequestResponse1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequesterId** | Pointer to **String** | the requester Id | [optional] +**RequesterName** | Pointer to **String** | the requesterName | [optional] +**Items** | Pointer to [**[]AccessRequestItemResponse**](access-request-item-response) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestResponse1 = Initialize-PSSailpoint.V2024AccessRequestResponse1 -RequesterId 2c91808a77ff216301782327a50f09bf ` + -RequesterName Bing C ` + -Items [{operation=Add, accessItemType=role, name=Role-1, decision=APPROVED, description=The role descrition, sourceId=8a80828f643d484f01643e14202e206f, sourceName=Source1, approvalInfos=[{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}]}] +``` + +- Convert the resource to JSON +```powershell +$AccessRequestResponse1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestTracking.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestTracking.md new file mode 100644 index 000000000..1fc9f7a75 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestTracking.md @@ -0,0 +1,44 @@ +--- +id: v2024-access-request-tracking +title: AccessRequestTracking +pagination_label: AccessRequestTracking +sidebar_label: AccessRequestTracking +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestTracking', 'V2024AccessRequestTracking'] +slug: /tools/sdk/powershell/v2024/models/access-request-tracking +tags: ['SDK', 'Software Development Kit', 'AccessRequestTracking', 'V2024AccessRequestTracking'] +--- + + +# AccessRequestTracking + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestTracking = Initialize-PSSailpoint.V2024AccessRequestTracking -RequestedFor 2c918084660f45d6016617daa9210584 ` + -RequestedItemsDetails { +"type": "ENTITLEMENT", +"id": "779c6fd7171540bba1184e5946112c28" + } ` + -AttributesHash -1928438224 ` + -AccessRequestIds [5d3118c518a44ec7805450d53479ccdb] +``` + +- Convert the resource to JSON +```powershell +$AccessRequestTracking | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestType.md new file mode 100644 index 000000000..3306a7919 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequestType.md @@ -0,0 +1,24 @@ +--- +id: v2024-access-request-type +title: AccessRequestType +pagination_label: AccessRequestType +sidebar_label: AccessRequestType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestType', 'V2024AccessRequestType'] +slug: /tools/sdk/powershell/v2024/models/access-request-type +tags: ['SDK', 'Software Development Kit', 'AccessRequestType', 'V2024AccessRequestType'] +--- + + +# AccessRequestType + +## Enum + + +* `GRANT_ACCESS` (value: `"GRANT_ACCESS"`) + +* `REVOKE_ACCESS` (value: `"REVOKE_ACCESS"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequested.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequested.md new file mode 100644 index 000000000..70152198a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessRequested.md @@ -0,0 +1,41 @@ +--- +id: v2024-access-requested +title: AccessRequested +pagination_label: AccessRequested +sidebar_label: AccessRequested +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequested', 'V2024AccessRequested'] +slug: /tools/sdk/powershell/v2024/models/access-requested +tags: ['SDK', 'Software Development Kit', 'AccessRequested', 'V2024AccessRequested'] +--- + + +# AccessRequested + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequest** | Pointer to [**AccessRequestResponse1**](access-request-response1) | | [optional] +**IdentityId** | Pointer to **String** | the identity id | [optional] +**EventType** | Pointer to **String** | the event type | [optional] +**Dt** | Pointer to **String** | the date of event | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequested = Initialize-PSSailpoint.V2024AccessRequested -AccessRequest null ` + -IdentityId 8a80828f643d484f01643e14202e206f ` + -EventType AccessRequested ` + -Dt 2019-03-08T22:37:33.901Z +``` + +- Convert the resource to JSON +```powershell +$AccessRequested | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessReviewItem.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessReviewItem.md new file mode 100644 index 000000000..160c0035e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessReviewItem.md @@ -0,0 +1,47 @@ +--- +id: v2024-access-review-item +title: AccessReviewItem +pagination_label: AccessReviewItem +sidebar_label: AccessReviewItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessReviewItem', 'V2024AccessReviewItem'] +slug: /tools/sdk/powershell/v2024/models/access-review-item +tags: ['SDK', 'Software Development Kit', 'AccessReviewItem', 'V2024AccessReviewItem'] +--- + + +# AccessReviewItem + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessReviewItem = Initialize-PSSailpoint.V2024AccessReviewItem -AccessSummary null ` + -IdentitySummary null ` + -Id ef38f94347e94562b5bb8424a56397d8 ` + -Completed false ` + -NewAccess false ` + -Decision null ` + -Comments This user still needs access to this source +``` + +- Convert the resource to JSON +```powershell +$AccessReviewItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessReviewReassignment.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessReviewReassignment.md new file mode 100644 index 000000000..e276e15a4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessReviewReassignment.md @@ -0,0 +1,39 @@ +--- +id: v2024-access-review-reassignment +title: AccessReviewReassignment +pagination_label: AccessReviewReassignment +sidebar_label: AccessReviewReassignment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessReviewReassignment', 'V2024AccessReviewReassignment'] +slug: /tools/sdk/powershell/v2024/models/access-review-reassignment +tags: ['SDK', 'Software Development Kit', 'AccessReviewReassignment', 'V2024AccessReviewReassignment'] +--- + + +# AccessReviewReassignment + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessReviewReassignment = Initialize-PSSailpoint.V2024AccessReviewReassignment -Reassign null ` + -ReassignTo ef38f94347e94562b5bb8424a56397d8 ` + -Reason reassigned for some reason +``` + +- Convert the resource to JSON +```powershell +$AccessReviewReassignment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessSummary.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessSummary.md new file mode 100644 index 000000000..5594138da --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessSummary.md @@ -0,0 +1,41 @@ +--- +id: v2024-access-summary +title: AccessSummary +pagination_label: AccessSummary +sidebar_label: AccessSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessSummary', 'V2024AccessSummary'] +slug: /tools/sdk/powershell/v2024/models/access-summary +tags: ['SDK', 'Software Development Kit', 'AccessSummary', 'V2024AccessSummary'] +--- + + +# AccessSummary + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessSummary = Initialize-PSSailpoint.V2024AccessSummary -Access null ` + -Entitlement null ` + -AccessProfile null ` + -Role null +``` + +- Convert the resource to JSON +```powershell +$AccessSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessSummaryAccess.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessSummaryAccess.md new file mode 100644 index 000000000..2ef581653 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessSummaryAccess.md @@ -0,0 +1,39 @@ +--- +id: v2024-access-summary-access +title: AccessSummaryAccess +pagination_label: AccessSummaryAccess +sidebar_label: AccessSummaryAccess +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessSummaryAccess', 'V2024AccessSummaryAccess'] +slug: /tools/sdk/powershell/v2024/models/access-summary-access +tags: ['SDK', 'Software Development Kit', 'AccessSummaryAccess', 'V2024AccessSummaryAccess'] +--- + + +# AccessSummaryAccess + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessSummaryAccess = Initialize-PSSailpoint.V2024AccessSummaryAccess -Type null ` + -Id 2c9180867160846801719932c5153fb7 ` + -Name Entitlement for Company Database +``` + +- Convert the resource to JSON +```powershell +$AccessSummaryAccess | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessType.md new file mode 100644 index 000000000..b03bfe608 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccessType.md @@ -0,0 +1,24 @@ +--- +id: v2024-access-type +title: AccessType +pagination_label: AccessType +sidebar_label: AccessType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessType', 'V2024AccessType'] +slug: /tools/sdk/powershell/v2024/models/access-type +tags: ['SDK', 'Software Development Kit', 'AccessType', 'V2024AccessType'] +--- + + +# AccessType + +## Enum + + +* `ONLINE` (value: `"ONLINE"`) + +* `OFFLINE` (value: `"OFFLINE"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Account.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Account.md new file mode 100644 index 000000000..66fe18035 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Account.md @@ -0,0 +1,89 @@ +--- +id: v2024-account +title: Account +pagination_label: Account +sidebar_label: Account +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Account', 'V2024Account'] +slug: /tools/sdk/powershell/v2024/models/account +tags: ['SDK', 'Software Development Kit', 'Account', 'V2024Account'] +--- + + +# Account + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$Account = Initialize-PSSailpoint.V2024Account -Id id12345 ` + -Name aName ` + -Created 2015-05-28T14:07:17Z ` + -Modified 2015-05-28T14:07:17Z ` + -SourceId 2c9180835d2e5168015d32f890ca1581 ` + -SourceName Employees ` + -IdentityId 2c9180835d2e5168015d32f890ca1581 ` + -CloudLifecycleState active ` + -IdentityState ACTIVE ` + -ConnectionType direct ` + -IsMachine true ` + -Recommendation null ` + -Attributes {firstName=SailPoint, lastName=Support, displayName=SailPoint Support} ` + -Authoritative false ` + -Description null ` + -Disabled false ` + -Locked false ` + -NativeIdentity 552775 ` + -SystemAccount false ` + -Uncorrelated false ` + -Uuid {b0dce506-d6d4-44d2-8a32-d9a5b21fb175} ` + -ManuallyCorrelated false ` + -HasEntitlements true ` + -Identity null ` + -SourceOwner null ` + -Features ENABLE ` + -Origin AGGREGATED ` + -OwnerIdentity null +``` + +- Convert the resource to JSON +```powershell +$Account | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAction.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAction.md new file mode 100644 index 000000000..ee2b00099 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAction.md @@ -0,0 +1,37 @@ +--- +id: v2024-account-action +title: AccountAction +pagination_label: AccountAction +sidebar_label: AccountAction +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAction', 'V2024AccountAction'] +slug: /tools/sdk/powershell/v2024/models/account-action +tags: ['SDK', 'Software Development Kit', 'AccountAction', 'V2024AccountAction'] +--- + + +# AccountAction + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountAction = Initialize-PSSailpoint.V2024AccountAction -Action ENABLE ` + -SourceIds [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500] +``` + +- Convert the resource to JSON +```powershell +$AccountAction | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountActivity.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountActivity.md new file mode 100644 index 000000000..de37b2fd6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountActivity.md @@ -0,0 +1,61 @@ +--- +id: v2024-account-activity +title: AccountActivity +pagination_label: AccountActivity +sidebar_label: AccountActivity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivity', 'V2024AccountActivity'] +slug: /tools/sdk/powershell/v2024/models/account-activity +tags: ['SDK', 'Software Development Kit', 'AccountActivity', 'V2024AccountActivity'] +--- + + +# AccountActivity + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountActivity = Initialize-PSSailpoint.V2024AccountActivity -Id 2c9180835d2e5168015d32f890ca1581 ` + -Name 2c9180835d2e5168015d32f890ca1581 ` + -Created 2017-07-11T18:45:37.098Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Completed 2018-10-19T13:49:37.385Z ` + -CompletionStatus null ` + -Type appRequest ` + -RequesterIdentitySummary null ` + -TargetIdentitySummary null ` + -Errors [sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds.] ` + -Warnings [Some warning, another warning] ` + -Items null ` + -ExecutionStatus null ` + -ClientMetadata {customKey1=custom value 1, customKey2=custom value 2} +``` + +- Convert the resource to JSON +```powershell +$AccountActivity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountActivityApprovalStatus.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountActivityApprovalStatus.md new file mode 100644 index 000000000..1cd906aa4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountActivityApprovalStatus.md @@ -0,0 +1,32 @@ +--- +id: v2024-account-activity-approval-status +title: AccountActivityApprovalStatus +pagination_label: AccountActivityApprovalStatus +sidebar_label: AccountActivityApprovalStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivityApprovalStatus', 'V2024AccountActivityApprovalStatus'] +slug: /tools/sdk/powershell/v2024/models/account-activity-approval-status +tags: ['SDK', 'Software Development Kit', 'AccountActivityApprovalStatus', 'V2024AccountActivityApprovalStatus'] +--- + + +# AccountActivityApprovalStatus + +## Enum + + +* `FINISHED` (value: `"FINISHED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `RETURNED` (value: `"RETURNED"`) + +* `EXPIRED` (value: `"EXPIRED"`) + +* `PENDING` (value: `"PENDING"`) + +* `CANCELED` (value: `"CANCELED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountActivityDocument.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountActivityDocument.md new file mode 100644 index 000000000..94048b642 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountActivityDocument.md @@ -0,0 +1,71 @@ +--- +id: v2024-account-activity-document +title: AccountActivityDocument +pagination_label: AccountActivityDocument +sidebar_label: AccountActivityDocument +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivityDocument', 'V2024AccountActivityDocument'] +slug: /tools/sdk/powershell/v2024/models/account-activity-document +tags: ['SDK', 'Software Development Kit', 'AccountActivityDocument', 'V2024AccountActivityDocument'] +--- + + +# AccountActivityDocument + +## Properties + +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 [**[]Approval1**](approval1) | 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] + +## Examples + +- Prepare the resource +```powershell +$AccountActivityDocument = Initialize-PSSailpoint.V2024AccountActivityDocument -Id 2c91808375d8e80a0175e1f88a575222 ` + -Name john.doe ` + -Type null ` + -Action Identity Refresh. ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Stage Completed ` + -Origin null ` + -Status Complete ` + -Requester null ` + -Recipient null ` + -TrackingNumber 61aad0c9e8134eca89e76a35e0cabe3f ` + -Errors null ` + -Warnings null ` + -Approvals null ` + -OriginalRequests null ` + -ExpansionItems null ` + -AccountRequests null ` + -Sources smartsheet-test, airtable-v4, IdentityNow +``` + +- Convert the resource to JSON +```powershell +$AccountActivityDocument | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountActivityItem.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountActivityItem.md new file mode 100644 index 000000000..a943b35ce --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountActivityItem.md @@ -0,0 +1,65 @@ +--- +id: v2024-account-activity-item +title: AccountActivityItem +pagination_label: AccountActivityItem +sidebar_label: AccountActivityItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivityItem', 'V2024AccountActivityItem'] +slug: /tools/sdk/powershell/v2024/models/account-activity-item +tags: ['SDK', 'Software Development Kit', 'AccountActivityItem', 'V2024AccountActivityItem'] +--- + + +# AccountActivityItem + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountActivityItem = Initialize-PSSailpoint.V2024AccountActivityItem -Id 48c545831b264409a81befcabb0e3c5a ` + -Name 48c545831b264409a81befcabb0e3c5a ` + -Requested 2017-07-11T18:45:37.098Z ` + -ApprovalStatus null ` + -ProvisioningStatus null ` + -RequesterComment null ` + -ReviewerIdentitySummary null ` + -ReviewerComment null ` + -Operation null ` + -Attribute detectedRoles ` + -Value Treasury Analyst [AccessProfile-1529010191212] ` + -NativeIdentity Sandie.Camero ` + -SourceId 2c91808363ef85290164000587130c0c ` + -AccountRequestInfo null ` + -ClientMetadata {customKey1=custom value 1, customKey2=custom value 2} ` + -RemoveDate 2020-07-11T00:00Z +``` + +- Convert the resource to JSON +```powershell +$AccountActivityItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountActivityItemOperation.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountActivityItemOperation.md new file mode 100644 index 000000000..d78ad87b3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountActivityItemOperation.md @@ -0,0 +1,40 @@ +--- +id: v2024-account-activity-item-operation +title: AccountActivityItemOperation +pagination_label: AccountActivityItemOperation +sidebar_label: AccountActivityItemOperation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivityItemOperation', 'V2024AccountActivityItemOperation'] +slug: /tools/sdk/powershell/v2024/models/account-activity-item-operation +tags: ['SDK', 'Software Development Kit', 'AccountActivityItemOperation', 'V2024AccountActivityItemOperation'] +--- + + +# AccountActivityItemOperation + +## Enum + + +* `ADD` (value: `"ADD"`) + +* `CREATE` (value: `"CREATE"`) + +* `MODIFY` (value: `"MODIFY"`) + +* `DELETE` (value: `"DELETE"`) + +* `DISABLE` (value: `"DISABLE"`) + +* `ENABLE` (value: `"ENABLE"`) + +* `UNLOCK` (value: `"UNLOCK"`) + +* `LOCK` (value: `"LOCK"`) + +* `REMOVE` (value: `"REMOVE"`) + +* `SET` (value: `"SET"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountActivitySearchedItem.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountActivitySearchedItem.md new file mode 100644 index 000000000..aa29fb3a0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountActivitySearchedItem.md @@ -0,0 +1,71 @@ +--- +id: v2024-account-activity-searched-item +title: AccountActivitySearchedItem +pagination_label: AccountActivitySearchedItem +sidebar_label: AccountActivitySearchedItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivitySearchedItem', 'V2024AccountActivitySearchedItem'] +slug: /tools/sdk/powershell/v2024/models/account-activity-searched-item +tags: ['SDK', 'Software Development Kit', 'AccountActivitySearchedItem', 'V2024AccountActivitySearchedItem'] +--- + + +# AccountActivitySearchedItem + +## Properties + +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 [**[]Approval1**](approval1) | 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] + +## Examples + +- Prepare the resource +```powershell +$AccountActivitySearchedItem = Initialize-PSSailpoint.V2024AccountActivitySearchedItem -Id 2c91808375d8e80a0175e1f88a575222 ` + -Name john.doe ` + -Type null ` + -Action Identity Refresh. ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Stage Completed ` + -Origin null ` + -Status Complete ` + -Requester null ` + -Recipient null ` + -TrackingNumber 61aad0c9e8134eca89e76a35e0cabe3f ` + -Errors null ` + -Warnings null ` + -Approvals null ` + -OriginalRequests null ` + -ExpansionItems null ` + -AccountRequests null ` + -Sources smartsheet-test, airtable-v4, IdentityNow +``` + +- Convert the resource to JSON +```powershell +$AccountActivitySearchedItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAggregationCompleted.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAggregationCompleted.md new file mode 100644 index 000000000..79938e845 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAggregationCompleted.md @@ -0,0 +1,47 @@ +--- +id: v2024-account-aggregation-completed +title: AccountAggregationCompleted +pagination_label: AccountAggregationCompleted +sidebar_label: AccountAggregationCompleted +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAggregationCompleted', 'V2024AccountAggregationCompleted'] +slug: /tools/sdk/powershell/v2024/models/account-aggregation-completed +tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompleted', 'V2024AccountAggregationCompleted'] +--- + + +# AccountAggregationCompleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | [**AccountAggregationCompletedSource**](account-aggregation-completed-source) | | [required] +**Status** | **Enum** [ "Success", "Failed", "Terminated" ] | The overall status of the aggregation. | [required] +**Started** | **System.DateTime** | The date and time when the account aggregation started. | [required] +**Completed** | **System.DateTime** | The date and time when the account aggregation finished. | [required] +**Errors** | **[]String** | A list of errors that occurred during the aggregation. | [required] +**Warnings** | **[]String** | A list of warnings that occurred during the aggregation. | [required] +**Stats** | [**AccountAggregationCompletedStats**](account-aggregation-completed-stats) | | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountAggregationCompleted = Initialize-PSSailpoint.V2024AccountAggregationCompleted -Source null ` + -Status Success ` + -Started 2020-06-29T22:01:50.474Z ` + -Completed 2020-06-29T22:02:04.090Z ` + -Errors null ` + -Warnings null ` + -Stats null +``` + +- Convert the resource to JSON +```powershell +$AccountAggregationCompleted | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAggregationCompletedSource.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAggregationCompletedSource.md new file mode 100644 index 000000000..b51268251 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAggregationCompletedSource.md @@ -0,0 +1,39 @@ +--- +id: v2024-account-aggregation-completed-source +title: AccountAggregationCompletedSource +pagination_label: AccountAggregationCompletedSource +sidebar_label: AccountAggregationCompletedSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAggregationCompletedSource', 'V2024AccountAggregationCompletedSource'] +slug: /tools/sdk/powershell/v2024/models/account-aggregation-completed-source +tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedSource', 'V2024AccountAggregationCompletedSource'] +--- + + +# AccountAggregationCompletedSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "SOURCE" ] | The DTO type of the source the accounts are being aggregated from. | [required] +**Id** | **String** | The ID of the source the accounts are being aggregated from. | [required] +**Name** | **String** | Display name of the source the accounts are being aggregated from. | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountAggregationCompletedSource = Initialize-PSSailpoint.V2024AccountAggregationCompletedSource -Type SOURCE ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name HR Active Directory +``` + +- Convert the resource to JSON +```powershell +$AccountAggregationCompletedSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAggregationCompletedStats.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAggregationCompletedStats.md new file mode 100644 index 000000000..ead3e38f8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAggregationCompletedStats.md @@ -0,0 +1,43 @@ +--- +id: v2024-account-aggregation-completed-stats +title: AccountAggregationCompletedStats +pagination_label: AccountAggregationCompletedStats +sidebar_label: AccountAggregationCompletedStats +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAggregationCompletedStats', 'V2024AccountAggregationCompletedStats'] +slug: /tools/sdk/powershell/v2024/models/account-aggregation-completed-stats +tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedStats', 'V2024AccountAggregationCompletedStats'] +--- + + +# AccountAggregationCompletedStats + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Scanned** | **Int32** | The number of accounts which were scanned / iterated over. | [required] +**Unchanged** | **Int32** | The number of accounts which existed before, but had no changes. | [required] +**Changed** | **Int32** | The number of accounts which existed before, but had changes. | [required] +**Added** | **Int32** | The number of accounts which are new - have not existed before. | [required] +**Removed** | **Int32** | The number accounts which existed before, but no longer exist (thus getting removed). | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountAggregationCompletedStats = Initialize-PSSailpoint.V2024AccountAggregationCompletedStats -Scanned 200 ` + -Unchanged 190 ` + -Changed 6 ` + -Added 4 ` + -Removed 3 +``` + +- Convert the resource to JSON +```powershell +$AccountAggregationCompletedStats | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAggregationStatus.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAggregationStatus.md new file mode 100644 index 000000000..e98d3a3a8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAggregationStatus.md @@ -0,0 +1,41 @@ +--- +id: v2024-account-aggregation-status +title: AccountAggregationStatus +pagination_label: AccountAggregationStatus +sidebar_label: AccountAggregationStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAggregationStatus', 'V2024AccountAggregationStatus'] +slug: /tools/sdk/powershell/v2024/models/account-aggregation-status +tags: ['SDK', 'Software Development Kit', 'AccountAggregationStatus', 'V2024AccountAggregationStatus'] +--- + + +# AccountAggregationStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Start** | Pointer to **System.DateTime** | When the aggregation started. | [optional] +**Status** | Pointer to **Enum** [ "STARTED", "ACCOUNTS_COLLECTED", "COMPLETED", "CANCELLED", "RETRIED", "TERMINATED" ] | STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. | [optional] +**TotalAccounts** | Pointer to **Int32** | The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional] +**ProcessedAccounts** | Pointer to **Int32** | The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountAggregationStatus = Initialize-PSSailpoint.V2024AccountAggregationStatus -Start 2021-01-31T14:30:05.104Z ` + -Status ACCOUNTS_COLLECTED ` + -TotalAccounts 520 ` + -ProcessedAccounts 150 +``` + +- Convert the resource to JSON +```powershell +$AccountAggregationStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttribute.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttribute.md new file mode 100644 index 000000000..3b079420b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttribute.md @@ -0,0 +1,51 @@ +--- +id: v2024-account-attribute +title: AccountAttribute +pagination_label: AccountAttribute +sidebar_label: AccountAttribute +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttribute', 'V2024AccountAttribute'] +slug: /tools/sdk/powershell/v2024/models/account-attribute +tags: ['SDK', 'Software Development Kit', 'AccountAttribute', 'V2024AccountAttribute'] +--- + + +# AccountAttribute + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountAttribute = Initialize-PSSailpoint.V2024AccountAttribute -SourceName Workday ` + -AttributeName DEPARTMENT ` + -AccountSortAttribute created ` + -AccountSortDescending false ` + -AccountReturnFirstLink false ` + -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` + -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$AccountAttribute | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributes.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributes.md new file mode 100644 index 000000000..898c38c31 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributes.md @@ -0,0 +1,35 @@ +--- +id: v2024-account-attributes +title: AccountAttributes +pagination_label: AccountAttributes +sidebar_label: AccountAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributes', 'V2024AccountAttributes'] +slug: /tools/sdk/powershell/v2024/models/account-attributes +tags: ['SDK', 'Software Development Kit', 'AccountAttributes', 'V2024AccountAttributes'] +--- + + +# AccountAttributes + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountAttributes = Initialize-PSSailpoint.V2024AccountAttributes -Attributes {city=Austin, displayName=John Doe, userName=jdoe, sAMAccountName=jDoe, mail=john.doe@sailpoint.com} +``` + +- Convert the resource to JSON +```powershell +$AccountAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesChanged.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesChanged.md new file mode 100644 index 000000000..d43ae9e33 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesChanged.md @@ -0,0 +1,41 @@ +--- +id: v2024-account-attributes-changed +title: AccountAttributesChanged +pagination_label: AccountAttributesChanged +sidebar_label: AccountAttributesChanged +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChanged', 'V2024AccountAttributesChanged'] +slug: /tools/sdk/powershell/v2024/models/account-attributes-changed +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChanged', 'V2024AccountAttributesChanged'] +--- + + +# AccountAttributesChanged + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**AccountAttributesChangedIdentity**](account-attributes-changed-identity) | | [required] +**Source** | [**AccountAttributesChangedSource**](account-attributes-changed-source) | | [required] +**Account** | [**AccountAttributesChangedAccount**](account-attributes-changed-account) | | [required] +**Changes** | [**[]AccountAttributesChangedChangesInner**](account-attributes-changed-changes-inner) | A list of attributes that changed. | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountAttributesChanged = Initialize-PSSailpoint.V2024AccountAttributesChanged -Identity null ` + -Source null ` + -Account null ` + -Changes null +``` + +- Convert the resource to JSON +```powershell +$AccountAttributesChanged | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesChangedAccount.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesChangedAccount.md new file mode 100644 index 000000000..61490cb1a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesChangedAccount.md @@ -0,0 +1,43 @@ +--- +id: v2024-account-attributes-changed-account +title: AccountAttributesChangedAccount +pagination_label: AccountAttributesChangedAccount +sidebar_label: AccountAttributesChangedAccount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChangedAccount', 'V2024AccountAttributesChangedAccount'] +slug: /tools/sdk/powershell/v2024/models/account-attributes-changed-account +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedAccount', 'V2024AccountAttributesChangedAccount'] +--- + + +# AccountAttributesChangedAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | SailPoint generated unique identifier. | [required] +**Uuid** | **String** | The source's unique identifier for the account. UUID is generated by the source system. | [required] +**Name** | **String** | Name of the account. | [required] +**NativeIdentity** | **String** | Unique ID of the account on the source. | [required] +**Type** | **Enum** [ "ACCOUNT" ] | The type of the account | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountAttributesChangedAccount = Initialize-PSSailpoint.V2024AccountAttributesChangedAccount -Id 52170a74-ca89-11ea-87d0-0242ac130003 ` + -Uuid 1cb1f07d-3e5a-4431-becd-234fa4306108 ` + -Name john.doe ` + -NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com ` + -Type ACCOUNT +``` + +- Convert the resource to JSON +```powershell +$AccountAttributesChangedAccount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesChangedChangesInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesChangedChangesInner.md new file mode 100644 index 000000000..008e62376 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesChangedChangesInner.md @@ -0,0 +1,39 @@ +--- +id: v2024-account-attributes-changed-changes-inner +title: AccountAttributesChangedChangesInner +pagination_label: AccountAttributesChangedChangesInner +sidebar_label: AccountAttributesChangedChangesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChangedChangesInner', 'V2024AccountAttributesChangedChangesInner'] +slug: /tools/sdk/powershell/v2024/models/account-attributes-changed-changes-inner +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInner', 'V2024AccountAttributesChangedChangesInner'] +--- + + +# AccountAttributesChangedChangesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attribute** | **String** | The name of the attribute. | [required] +**OldValue** | [**AccountAttributesChangedChangesInnerOldValue**](account-attributes-changed-changes-inner-old-value) | | [required] +**NewValue** | [**AccountAttributesChangedChangesInnerNewValue**](account-attributes-changed-changes-inner-new-value) | | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountAttributesChangedChangesInner = Initialize-PSSailpoint.V2024AccountAttributesChangedChangesInner -Attribute sn ` + -OldValue null ` + -NewValue null +``` + +- Convert the resource to JSON +```powershell +$AccountAttributesChangedChangesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesChangedChangesInnerNewValue.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesChangedChangesInnerNewValue.md new file mode 100644 index 000000000..a521c065c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesChangedChangesInnerNewValue.md @@ -0,0 +1,34 @@ +--- +id: v2024-account-attributes-changed-changes-inner-new-value +title: AccountAttributesChangedChangesInnerNewValue +pagination_label: AccountAttributesChangedChangesInnerNewValue +sidebar_label: AccountAttributesChangedChangesInnerNewValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChangedChangesInnerNewValue', 'V2024AccountAttributesChangedChangesInnerNewValue'] +slug: /tools/sdk/powershell/v2024/models/account-attributes-changed-changes-inner-new-value +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInnerNewValue', 'V2024AccountAttributesChangedChangesInnerNewValue'] +--- + + +# AccountAttributesChangedChangesInnerNewValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$AccountAttributesChangedChangesInnerNewValue = Initialize-PSSailpoint.V2024AccountAttributesChangedChangesInnerNewValue +``` + +- Convert the resource to JSON +```powershell +$AccountAttributesChangedChangesInnerNewValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesChangedChangesInnerOldValue.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesChangedChangesInnerOldValue.md new file mode 100644 index 000000000..2a63d6ded --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesChangedChangesInnerOldValue.md @@ -0,0 +1,34 @@ +--- +id: v2024-account-attributes-changed-changes-inner-old-value +title: AccountAttributesChangedChangesInnerOldValue +pagination_label: AccountAttributesChangedChangesInnerOldValue +sidebar_label: AccountAttributesChangedChangesInnerOldValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChangedChangesInnerOldValue', 'V2024AccountAttributesChangedChangesInnerOldValue'] +slug: /tools/sdk/powershell/v2024/models/account-attributes-changed-changes-inner-old-value +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInnerOldValue', 'V2024AccountAttributesChangedChangesInnerOldValue'] +--- + + +# AccountAttributesChangedChangesInnerOldValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$AccountAttributesChangedChangesInnerOldValue = Initialize-PSSailpoint.V2024AccountAttributesChangedChangesInnerOldValue +``` + +- Convert the resource to JSON +```powershell +$AccountAttributesChangedChangesInnerOldValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesChangedIdentity.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesChangedIdentity.md new file mode 100644 index 000000000..43f5fc989 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesChangedIdentity.md @@ -0,0 +1,39 @@ +--- +id: v2024-account-attributes-changed-identity +title: AccountAttributesChangedIdentity +pagination_label: AccountAttributesChangedIdentity +sidebar_label: AccountAttributesChangedIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChangedIdentity', 'V2024AccountAttributesChangedIdentity'] +slug: /tools/sdk/powershell/v2024/models/account-attributes-changed-identity +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedIdentity', 'V2024AccountAttributesChangedIdentity'] +--- + + +# AccountAttributesChangedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | DTO type of the identity whose account attributes were updated. | [required] +**Id** | **String** | ID of the identity whose account attributes were updated. | [required] +**Name** | **String** | Display name of the identity whose account attributes were updated. | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountAttributesChangedIdentity = Initialize-PSSailpoint.V2024AccountAttributesChangedIdentity -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$AccountAttributesChangedIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesChangedSource.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesChangedSource.md new file mode 100644 index 000000000..56742575f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesChangedSource.md @@ -0,0 +1,39 @@ +--- +id: v2024-account-attributes-changed-source +title: AccountAttributesChangedSource +pagination_label: AccountAttributesChangedSource +sidebar_label: AccountAttributesChangedSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChangedSource', 'V2024AccountAttributesChangedSource'] +slug: /tools/sdk/powershell/v2024/models/account-attributes-changed-source +tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedSource', 'V2024AccountAttributesChangedSource'] +--- + + +# AccountAttributesChangedSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | ID of the object to which this reference applies | [required] +**Type** | **Enum** [ "SOURCE" ] | The type of object that is referenced | [required] +**Name** | **String** | Human-readable display name of the object to which this reference applies | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountAttributesChangedSource = Initialize-PSSailpoint.V2024AccountAttributesChangedSource -Id 4e4d982dddff4267ab12f0f1e72b5a6d ` + -Type SOURCE ` + -Name Corporate Active Directory +``` + +- Convert the resource to JSON +```powershell +$AccountAttributesChangedSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesCreate.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesCreate.md new file mode 100644 index 000000000..68de7f199 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesCreate.md @@ -0,0 +1,35 @@ +--- +id: v2024-account-attributes-create +title: AccountAttributesCreate +pagination_label: AccountAttributesCreate +sidebar_label: AccountAttributesCreate +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesCreate', 'V2024AccountAttributesCreate'] +slug: /tools/sdk/powershell/v2024/models/account-attributes-create +tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreate', 'V2024AccountAttributesCreate'] +--- + + +# AccountAttributesCreate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | [**AccountAttributesCreateAttributes**](account-attributes-create-attributes) | | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountAttributesCreate = Initialize-PSSailpoint.V2024AccountAttributesCreate -Attributes null +``` + +- Convert the resource to JSON +```powershell +$AccountAttributesCreate | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesCreateAttributes.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesCreateAttributes.md new file mode 100644 index 000000000..215566653 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountAttributesCreateAttributes.md @@ -0,0 +1,35 @@ +--- +id: v2024-account-attributes-create-attributes +title: AccountAttributesCreateAttributes +pagination_label: AccountAttributesCreateAttributes +sidebar_label: AccountAttributesCreateAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesCreateAttributes', 'V2024AccountAttributesCreateAttributes'] +slug: /tools/sdk/powershell/v2024/models/account-attributes-create-attributes +tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreateAttributes', 'V2024AccountAttributesCreateAttributes'] +--- + + +# AccountAttributesCreateAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceId** | **String** | Target source to create an account | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountAttributesCreateAttributes = Initialize-PSSailpoint.V2024AccountAttributesCreateAttributes -SourceId 34bfcbe116c9407464af37acbaf7a4dc +``` + +- Convert the resource to JSON +```powershell +$AccountAttributesCreateAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountCorrelated.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountCorrelated.md new file mode 100644 index 000000000..caff81dc6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountCorrelated.md @@ -0,0 +1,43 @@ +--- +id: v2024-account-correlated +title: AccountCorrelated +pagination_label: AccountCorrelated +sidebar_label: AccountCorrelated +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountCorrelated', 'V2024AccountCorrelated'] +slug: /tools/sdk/powershell/v2024/models/account-correlated +tags: ['SDK', 'Software Development Kit', 'AccountCorrelated', 'V2024AccountCorrelated'] +--- + + +# AccountCorrelated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**AccountCorrelatedIdentity**](account-correlated-identity) | | [required] +**Source** | [**AccountCorrelatedSource**](account-correlated-source) | | [required] +**Account** | [**AccountCorrelatedAccount**](account-correlated-account) | | [required] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes associated with the account. Attributes are unique per source. | [required] +**EntitlementCount** | Pointer to **Int32** | The number of entitlements associated with this account. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountCorrelated = Initialize-PSSailpoint.V2024AccountCorrelated -Identity null ` + -Source null ` + -Account null ` + -Attributes {sn=doe, givenName=john, memberOf=[cn=g1,ou=groups,dc=acme,dc=com, cn=g2,ou=groups,dc=acme,dc=com, cn=g3,ou=groups,dc=acme,dc=com]} ` + -EntitlementCount 0 +``` + +- Convert the resource to JSON +```powershell +$AccountCorrelated | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountCorrelatedAccount.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountCorrelatedAccount.md new file mode 100644 index 000000000..c73568cd6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountCorrelatedAccount.md @@ -0,0 +1,43 @@ +--- +id: v2024-account-correlated-account +title: AccountCorrelatedAccount +pagination_label: AccountCorrelatedAccount +sidebar_label: AccountCorrelatedAccount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountCorrelatedAccount', 'V2024AccountCorrelatedAccount'] +slug: /tools/sdk/powershell/v2024/models/account-correlated-account +tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedAccount', 'V2024AccountCorrelatedAccount'] +--- + + +# AccountCorrelatedAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "ACCOUNT" ] | The correlated account's DTO type. | [required] +**Id** | **String** | The correlated account's ID. | [required] +**Name** | **String** | The correlated account's display name. | [required] +**NativeIdentity** | **String** | Unique ID of the account on the source. | [required] +**Uuid** | Pointer to **String** | The source's unique identifier for the account. UUID is generated by the source system. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountCorrelatedAccount = Initialize-PSSailpoint.V2024AccountCorrelatedAccount -Type ACCOUNT ` + -Id 98da47c31df444558c211f9b205184f6 ` + -Name Brian Mendoza ` + -NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com ` + -Uuid 1cb1f07d-3e5a-4431-becd-234fa4306108 +``` + +- Convert the resource to JSON +```powershell +$AccountCorrelatedAccount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountCorrelatedIdentity.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountCorrelatedIdentity.md new file mode 100644 index 000000000..c0a68bea1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountCorrelatedIdentity.md @@ -0,0 +1,39 @@ +--- +id: v2024-account-correlated-identity +title: AccountCorrelatedIdentity +pagination_label: AccountCorrelatedIdentity +sidebar_label: AccountCorrelatedIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountCorrelatedIdentity', 'V2024AccountCorrelatedIdentity'] +slug: /tools/sdk/powershell/v2024/models/account-correlated-identity +tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedIdentity', 'V2024AccountCorrelatedIdentity'] +--- + + +# AccountCorrelatedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | DTO type of the identity the account is correlated with. | [required] +**Id** | **String** | ID of the identity the account is correlated with. | [required] +**Name** | **String** | Display name of the identity the account is correlated with. | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountCorrelatedIdentity = Initialize-PSSailpoint.V2024AccountCorrelatedIdentity -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$AccountCorrelatedIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountCorrelatedSource.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountCorrelatedSource.md new file mode 100644 index 000000000..6d790a459 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountCorrelatedSource.md @@ -0,0 +1,39 @@ +--- +id: v2024-account-correlated-source +title: AccountCorrelatedSource +pagination_label: AccountCorrelatedSource +sidebar_label: AccountCorrelatedSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountCorrelatedSource', 'V2024AccountCorrelatedSource'] +slug: /tools/sdk/powershell/v2024/models/account-correlated-source +tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedSource', 'V2024AccountCorrelatedSource'] +--- + + +# AccountCorrelatedSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "SOURCE" ] | The DTO type of the source the accounts are being correlated from. | [required] +**Id** | **String** | The ID of the source the accounts are being correlated from. | [required] +**Name** | **String** | Display name of the source the accounts are being correlated from. | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountCorrelatedSource = Initialize-PSSailpoint.V2024AccountCorrelatedSource -Type SOURCE ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name HR Active Directory +``` + +- Convert the resource to JSON +```powershell +$AccountCorrelatedSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountInfoDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountInfoDto.md new file mode 100644 index 000000000..e7578562e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountInfoDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-account-info-dto +title: AccountInfoDto +pagination_label: AccountInfoDto +sidebar_label: AccountInfoDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountInfoDto', 'V2024AccountInfoDto'] +slug: /tools/sdk/powershell/v2024/models/account-info-dto +tags: ['SDK', 'Software Development Kit', 'AccountInfoDto', 'V2024AccountInfoDto'] +--- + + +# AccountInfoDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NativeIdentity** | Pointer to **String** | The unique ID of the account generated by the source system | [optional] +**DisplayName** | Pointer to **String** | Display name for this account | [optional] +**Uuid** | Pointer to **String** | UUID associated with this account | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountInfoDto = Initialize-PSSailpoint.V2024AccountInfoDto -NativeIdentity CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` + -DisplayName Abby.Smith ` + -Uuid {ad9fc391-246d-40af-b248-b6556a2b7c01} +``` + +- Convert the resource to JSON +```powershell +$AccountInfoDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountRequest.md new file mode 100644 index 000000000..3ef5c6ef3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountRequest.md @@ -0,0 +1,45 @@ +--- +id: v2024-account-request +title: AccountRequest +pagination_label: AccountRequest +sidebar_label: AccountRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountRequest', 'V2024AccountRequest'] +slug: /tools/sdk/powershell/v2024/models/account-request +tags: ['SDK', 'Software Development Kit', 'AccountRequest', 'V2024AccountRequest'] +--- + + +# AccountRequest + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountRequest = Initialize-PSSailpoint.V2024AccountRequest -AccountId John.Doe ` + -AttributeRequests null ` + -Op Modify ` + -ProvisioningTarget null ` + -Result null ` + -Source null +``` + +- Convert the resource to JSON +```powershell +$AccountRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountRequestInfo.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountRequestInfo.md new file mode 100644 index 000000000..0a9457f60 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountRequestInfo.md @@ -0,0 +1,39 @@ +--- +id: v2024-account-request-info +title: AccountRequestInfo +pagination_label: AccountRequestInfo +sidebar_label: AccountRequestInfo +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountRequestInfo', 'V2024AccountRequestInfo'] +slug: /tools/sdk/powershell/v2024/models/account-request-info +tags: ['SDK', 'Software Development Kit', 'AccountRequestInfo', 'V2024AccountRequestInfo'] +--- + + +# AccountRequestInfo + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountRequestInfo = Initialize-PSSailpoint.V2024AccountRequestInfo -RequestedObjectId 2c91808563ef85690164001c31140c0c ` + -RequestedObjectName Treasury Analyst ` + -RequestedObjectType null +``` + +- Convert the resource to JSON +```powershell +$AccountRequestInfo | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountRequestResult.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountRequestResult.md new file mode 100644 index 000000000..8989ed377 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountRequestResult.md @@ -0,0 +1,39 @@ +--- +id: v2024-account-request-result +title: AccountRequestResult +pagination_label: AccountRequestResult +sidebar_label: AccountRequestResult +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountRequestResult', 'V2024AccountRequestResult'] +slug: /tools/sdk/powershell/v2024/models/account-request-result +tags: ['SDK', 'Software Development Kit', 'AccountRequestResult', 'V2024AccountRequestResult'] +--- + + +# AccountRequestResult + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountRequestResult = Initialize-PSSailpoint.V2024AccountRequestResult -Errors null ` + -Status failed ` + -TicketId null +``` + +- Convert the resource to JSON +```powershell +$AccountRequestResult | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountSource.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountSource.md new file mode 100644 index 000000000..9cc9a15b4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountSource.md @@ -0,0 +1,39 @@ +--- +id: v2024-account-source +title: AccountSource +pagination_label: AccountSource +sidebar_label: AccountSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountSource', 'V2024AccountSource'] +slug: /tools/sdk/powershell/v2024/models/account-source +tags: ['SDK', 'Software Development Kit', 'AccountSource', 'V2024AccountSource'] +--- + + +# AccountSource + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountSource = Initialize-PSSailpoint.V2024AccountSource -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -Type Delimited File +``` + +- Convert the resource to JSON +```powershell +$AccountSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountStatusChanged.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountStatusChanged.md new file mode 100644 index 000000000..9276013d8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountStatusChanged.md @@ -0,0 +1,43 @@ +--- +id: v2024-account-status-changed +title: AccountStatusChanged +pagination_label: AccountStatusChanged +sidebar_label: AccountStatusChanged +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountStatusChanged', 'V2024AccountStatusChanged'] +slug: /tools/sdk/powershell/v2024/models/account-status-changed +tags: ['SDK', 'Software Development Kit', 'AccountStatusChanged', 'V2024AccountStatusChanged'] +--- + + +# AccountStatusChanged + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EventType** | Pointer to **String** | the event type | [optional] +**IdentityId** | Pointer to **String** | the identity id | [optional] +**Dt** | Pointer to **String** | the date of event | [optional] +**Account** | Pointer to [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional] +**StatusChange** | Pointer to [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountStatusChanged = Initialize-PSSailpoint.V2024AccountStatusChanged -EventType null ` + -IdentityId null ` + -Dt null ` + -Account null ` + -StatusChange null +``` + +- Convert the resource to JSON +```powershell +$AccountStatusChanged | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountStatusChangedAccount.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountStatusChangedAccount.md new file mode 100644 index 000000000..ecc36318b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountStatusChangedAccount.md @@ -0,0 +1,47 @@ +--- +id: v2024-account-status-changed-account +title: AccountStatusChangedAccount +pagination_label: AccountStatusChangedAccount +sidebar_label: AccountStatusChangedAccount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountStatusChangedAccount', 'V2024AccountStatusChangedAccount'] +slug: /tools/sdk/powershell/v2024/models/account-status-changed-account +tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedAccount', 'V2024AccountStatusChangedAccount'] +--- + + +# AccountStatusChangedAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | the ID of the account in the database | [optional] +**NativeIdentity** | Pointer to **String** | the native identifier of the account | [optional] +**DisplayName** | Pointer to **String** | the display name of the account | [optional] +**SourceId** | Pointer to **String** | the ID of the source for this account | [optional] +**SourceName** | Pointer to **String** | the name of the source for this account | [optional] +**EntitlementCount** | Pointer to **Int32** | the number of entitlements on this account | [optional] +**AccessType** | Pointer to **String** | this value is always ""account"" | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountStatusChangedAccount = Initialize-PSSailpoint.V2024AccountStatusChangedAccount -Id null ` + -NativeIdentity null ` + -DisplayName null ` + -SourceId null ` + -SourceName null ` + -EntitlementCount null ` + -AccessType null +``` + +- Convert the resource to JSON +```powershell +$AccountStatusChangedAccount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountStatusChangedStatusChange.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountStatusChangedStatusChange.md new file mode 100644 index 000000000..cb4a18074 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountStatusChangedStatusChange.md @@ -0,0 +1,37 @@ +--- +id: v2024-account-status-changed-status-change +title: AccountStatusChangedStatusChange +pagination_label: AccountStatusChangedStatusChange +sidebar_label: AccountStatusChangedStatusChange +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountStatusChangedStatusChange', 'V2024AccountStatusChangedStatusChange'] +slug: /tools/sdk/powershell/v2024/models/account-status-changed-status-change +tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedStatusChange', 'V2024AccountStatusChangedStatusChange'] +--- + + +# AccountStatusChangedStatusChange + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PreviousStatus** | Pointer to **Enum** [ "enabled", "disabled", "locked" ] | the previous status of the account | [optional] +**NewStatus** | Pointer to **Enum** [ "enabled", "disabled", "locked" ] | the new status of the account | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountStatusChangedStatusChange = Initialize-PSSailpoint.V2024AccountStatusChangedStatusChange -PreviousStatus null ` + -NewStatus null +``` + +- Convert the resource to JSON +```powershell +$AccountStatusChangedStatusChange | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountToggleRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountToggleRequest.md new file mode 100644 index 000000000..87bf9f59a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountToggleRequest.md @@ -0,0 +1,37 @@ +--- +id: v2024-account-toggle-request +title: AccountToggleRequest +pagination_label: AccountToggleRequest +sidebar_label: AccountToggleRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountToggleRequest', 'V2024AccountToggleRequest'] +slug: /tools/sdk/powershell/v2024/models/account-toggle-request +tags: ['SDK', 'Software Development Kit', 'AccountToggleRequest', 'V2024AccountToggleRequest'] +--- + + +# AccountToggleRequest + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountToggleRequest = Initialize-PSSailpoint.V2024AccountToggleRequest -ExternalVerificationId 3f9180835d2e5168015d32f890ca1581 ` + -ForceProvisioning false +``` + +- Convert the resource to JSON +```powershell +$AccountToggleRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountUncorrelated.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountUncorrelated.md new file mode 100644 index 000000000..02dfd2740 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountUncorrelated.md @@ -0,0 +1,41 @@ +--- +id: v2024-account-uncorrelated +title: AccountUncorrelated +pagination_label: AccountUncorrelated +sidebar_label: AccountUncorrelated +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUncorrelated', 'V2024AccountUncorrelated'] +slug: /tools/sdk/powershell/v2024/models/account-uncorrelated +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelated', 'V2024AccountUncorrelated'] +--- + + +# AccountUncorrelated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**AccountUncorrelatedIdentity**](account-uncorrelated-identity) | | [required] +**Source** | [**AccountUncorrelatedSource**](account-uncorrelated-source) | | [required] +**Account** | [**AccountUncorrelatedAccount**](account-uncorrelated-account) | | [required] +**EntitlementCount** | Pointer to **Int32** | The number of entitlements associated with this account. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountUncorrelated = Initialize-PSSailpoint.V2024AccountUncorrelated -Identity null ` + -Source null ` + -Account null ` + -EntitlementCount 0 +``` + +- Convert the resource to JSON +```powershell +$AccountUncorrelated | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountUncorrelatedAccount.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountUncorrelatedAccount.md new file mode 100644 index 000000000..7e71ec734 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountUncorrelatedAccount.md @@ -0,0 +1,43 @@ +--- +id: v2024-account-uncorrelated-account +title: AccountUncorrelatedAccount +pagination_label: AccountUncorrelatedAccount +sidebar_label: AccountUncorrelatedAccount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUncorrelatedAccount', 'V2024AccountUncorrelatedAccount'] +slug: /tools/sdk/powershell/v2024/models/account-uncorrelated-account +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedAccount', 'V2024AccountUncorrelatedAccount'] +--- + + +# AccountUncorrelatedAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "ACCOUNT" ] | Uncorrelated account's DTO type. | [required] +**Id** | **String** | Uncorrelated account's ID. | [required] +**Name** | **String** | Uncorrelated account's display name. | [required] +**NativeIdentity** | **String** | Unique ID of the account on the source. | [required] +**Uuid** | Pointer to **String** | The source's unique identifier for the account. UUID is generated by the source system. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountUncorrelatedAccount = Initialize-PSSailpoint.V2024AccountUncorrelatedAccount -Type ACCOUNT ` + -Id 4dd497e3723e439991cb6d0e478375dd ` + -Name Sadie Jensen ` + -NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com ` + -Uuid 1cb1f07d-3e5a-4431-becd-234fa4306108 +``` + +- Convert the resource to JSON +```powershell +$AccountUncorrelatedAccount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountUncorrelatedIdentity.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountUncorrelatedIdentity.md new file mode 100644 index 000000000..c08ddf21f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountUncorrelatedIdentity.md @@ -0,0 +1,39 @@ +--- +id: v2024-account-uncorrelated-identity +title: AccountUncorrelatedIdentity +pagination_label: AccountUncorrelatedIdentity +sidebar_label: AccountUncorrelatedIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUncorrelatedIdentity', 'V2024AccountUncorrelatedIdentity'] +slug: /tools/sdk/powershell/v2024/models/account-uncorrelated-identity +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedIdentity', 'V2024AccountUncorrelatedIdentity'] +--- + + +# AccountUncorrelatedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | DTO type of the identity the account is uncorrelated with. | [required] +**Id** | **String** | ID of the identity the account is uncorrelated with. | [required] +**Name** | **String** | Display name of the identity the account is uncorrelated with. | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountUncorrelatedIdentity = Initialize-PSSailpoint.V2024AccountUncorrelatedIdentity -Type IDENTITY ` + -Id 2c3780a46faadee4016fb4e018c20652 ` + -Name Allen Albertson +``` + +- Convert the resource to JSON +```powershell +$AccountUncorrelatedIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountUncorrelatedSource.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountUncorrelatedSource.md new file mode 100644 index 000000000..22f65bb24 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountUncorrelatedSource.md @@ -0,0 +1,39 @@ +--- +id: v2024-account-uncorrelated-source +title: AccountUncorrelatedSource +pagination_label: AccountUncorrelatedSource +sidebar_label: AccountUncorrelatedSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUncorrelatedSource', 'V2024AccountUncorrelatedSource'] +slug: /tools/sdk/powershell/v2024/models/account-uncorrelated-source +tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedSource', 'V2024AccountUncorrelatedSource'] +--- + + +# AccountUncorrelatedSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "SOURCE" ] | The DTO type of the source the accounts are uncorrelated from. | [required] +**Id** | **String** | The ID of the source the accounts are uncorrelated from. | [required] +**Name** | **String** | Display name of the source the accounts are uncorrelated from. | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountUncorrelatedSource = Initialize-PSSailpoint.V2024AccountUncorrelatedSource -Type SOURCE ` + -Id 2c6180835d191a86015d28455b4b231b ` + -Name Corporate Directory +``` + +- Convert the resource to JSON +```powershell +$AccountUncorrelatedSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountUnlockRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountUnlockRequest.md new file mode 100644 index 000000000..eacf111b9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountUnlockRequest.md @@ -0,0 +1,39 @@ +--- +id: v2024-account-unlock-request +title: AccountUnlockRequest +pagination_label: AccountUnlockRequest +sidebar_label: AccountUnlockRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUnlockRequest', 'V2024AccountUnlockRequest'] +slug: /tools/sdk/powershell/v2024/models/account-unlock-request +tags: ['SDK', 'Software Development Kit', 'AccountUnlockRequest', 'V2024AccountUnlockRequest'] +--- + + +# AccountUnlockRequest + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountUnlockRequest = Initialize-PSSailpoint.V2024AccountUnlockRequest -ExternalVerificationId 3f9180835d2e5168015d32f890ca1581 ` + -UnlockIDNAccount false ` + -ForceProvisioning false +``` + +- Convert the resource to JSON +```powershell +$AccountUnlockRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountUsage.md new file mode 100644 index 000000000..8c674b349 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountUsage.md @@ -0,0 +1,37 @@ +--- +id: v2024-account-usage +title: AccountUsage +pagination_label: AccountUsage +sidebar_label: AccountUsage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUsage', 'V2024AccountUsage'] +slug: /tools/sdk/powershell/v2024/models/account-usage +tags: ['SDK', 'Software Development Kit', 'AccountUsage', 'V2024AccountUsage'] +--- + + +# AccountUsage + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` + -Count 10 +``` + +- Convert the resource to JSON +```powershell +$AccountUsage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountsAsyncResult.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountsAsyncResult.md new file mode 100644 index 000000000..5acc1d98d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountsAsyncResult.md @@ -0,0 +1,35 @@ +--- +id: v2024-accounts-async-result +title: AccountsAsyncResult +pagination_label: AccountsAsyncResult +sidebar_label: AccountsAsyncResult +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsAsyncResult', 'V2024AccountsAsyncResult'] +slug: /tools/sdk/powershell/v2024/models/accounts-async-result +tags: ['SDK', 'Software Development Kit', 'AccountsAsyncResult', 'V2024AccountsAsyncResult'] +--- + + +# AccountsAsyncResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | id of the task | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountsAsyncResult = Initialize-PSSailpoint.V2024AccountsAsyncResult -Id 2c91808474683da6017468693c260195 +``` + +- Convert the resource to JSON +```powershell +$AccountsAsyncResult | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountsCollectedForAggregation.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountsCollectedForAggregation.md new file mode 100644 index 000000000..f291e9650 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountsCollectedForAggregation.md @@ -0,0 +1,47 @@ +--- +id: v2024-accounts-collected-for-aggregation +title: AccountsCollectedForAggregation +pagination_label: AccountsCollectedForAggregation +sidebar_label: AccountsCollectedForAggregation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsCollectedForAggregation', 'V2024AccountsCollectedForAggregation'] +slug: /tools/sdk/powershell/v2024/models/accounts-collected-for-aggregation +tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregation', 'V2024AccountsCollectedForAggregation'] +--- + + +# AccountsCollectedForAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | [**AccountsCollectedForAggregationSource**](accounts-collected-for-aggregation-source) | | [required] +**Status** | **Enum** [ "Success", "Failed", "Terminated" ] | The overall status of the collection. | [required] +**Started** | **System.DateTime** | The date and time when the account collection started. | [required] +**Completed** | **System.DateTime** | The date and time when the account collection finished. | [required] +**Errors** | **[]String** | A list of errors that occurred during the collection. | [required] +**Warnings** | **[]String** | A list of warnings that occurred during the collection. | [required] +**Stats** | [**AccountsCollectedForAggregationStats**](accounts-collected-for-aggregation-stats) | | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountsCollectedForAggregation = Initialize-PSSailpoint.V2024AccountsCollectedForAggregation -Source null ` + -Status Success ` + -Started 2020-06-29T22:01:50.474Z ` + -Completed 2020-06-29T22:02:04.090Z ` + -Errors null ` + -Warnings null ` + -Stats null +``` + +- Convert the resource to JSON +```powershell +$AccountsCollectedForAggregation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountsCollectedForAggregationSource.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountsCollectedForAggregationSource.md new file mode 100644 index 000000000..65e643877 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountsCollectedForAggregationSource.md @@ -0,0 +1,39 @@ +--- +id: v2024-accounts-collected-for-aggregation-source +title: AccountsCollectedForAggregationSource +pagination_label: AccountsCollectedForAggregationSource +sidebar_label: AccountsCollectedForAggregationSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsCollectedForAggregationSource', 'V2024AccountsCollectedForAggregationSource'] +slug: /tools/sdk/powershell/v2024/models/accounts-collected-for-aggregation-source +tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregationSource', 'V2024AccountsCollectedForAggregationSource'] +--- + + +# AccountsCollectedForAggregationSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | ID of the object to which this reference applies | [required] +**Type** | **Enum** [ "SOURCE" ] | The type of object that is referenced | [required] +**Name** | **String** | Human-readable display name of the object to which this reference applies | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountsCollectedForAggregationSource = Initialize-PSSailpoint.V2024AccountsCollectedForAggregationSource -Id 4e4d982dddff4267ab12f0f1e72b5a6d ` + -Type SOURCE ` + -Name Corporate Active Directory +``` + +- Convert the resource to JSON +```powershell +$AccountsCollectedForAggregationSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountsCollectedForAggregationStats.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountsCollectedForAggregationStats.md new file mode 100644 index 000000000..b624f5913 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountsCollectedForAggregationStats.md @@ -0,0 +1,43 @@ +--- +id: v2024-accounts-collected-for-aggregation-stats +title: AccountsCollectedForAggregationStats +pagination_label: AccountsCollectedForAggregationStats +sidebar_label: AccountsCollectedForAggregationStats +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsCollectedForAggregationStats', 'V2024AccountsCollectedForAggregationStats'] +slug: /tools/sdk/powershell/v2024/models/accounts-collected-for-aggregation-stats +tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregationStats', 'V2024AccountsCollectedForAggregationStats'] +--- + + +# AccountsCollectedForAggregationStats + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Scanned** | **Int32** | The number of accounts which were scanned / iterated over. | [required] +**Unchanged** | **Int32** | The number of accounts which existed before, but had no changes. | [required] +**Changed** | **Int32** | The number of accounts which existed before, but had changes. | [required] +**Added** | **Int32** | The number of accounts which are new - have not existed before. | [required] +**Removed** | **Int32** | The number accounts which existed before, but no longer exist (thus getting removed). | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountsCollectedForAggregationStats = Initialize-PSSailpoint.V2024AccountsCollectedForAggregationStats -Scanned 200 ` + -Unchanged 190 ` + -Changed 6 ` + -Added 4 ` + -Removed 3 +``` + +- Convert the resource to JSON +```powershell +$AccountsCollectedForAggregationStats | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountsExportReportArguments.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountsExportReportArguments.md new file mode 100644 index 000000000..0ec684dc3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AccountsExportReportArguments.md @@ -0,0 +1,37 @@ +--- +id: v2024-accounts-export-report-arguments +title: AccountsExportReportArguments +pagination_label: AccountsExportReportArguments +sidebar_label: AccountsExportReportArguments +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsExportReportArguments', 'V2024AccountsExportReportArguments'] +slug: /tools/sdk/powershell/v2024/models/accounts-export-report-arguments +tags: ['SDK', 'Software Development Kit', 'AccountsExportReportArguments', 'V2024AccountsExportReportArguments'] +--- + + +# AccountsExportReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Application** | **String** | Source ID. | [required] +**SourceName** | **String** | Source name. | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountsExportReportArguments = Initialize-PSSailpoint.V2024AccountsExportReportArguments -Application 2c9180897eSourceIde781782f705b9 ` + -SourceName Active Directory +``` + +- Convert the resource to JSON +```powershell +$AccountsExportReportArguments | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ActivateCampaignOptions.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ActivateCampaignOptions.md new file mode 100644 index 000000000..31a71ede4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ActivateCampaignOptions.md @@ -0,0 +1,35 @@ +--- +id: v2024-activate-campaign-options +title: ActivateCampaignOptions +pagination_label: ActivateCampaignOptions +sidebar_label: ActivateCampaignOptions +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ActivateCampaignOptions', 'V2024ActivateCampaignOptions'] +slug: /tools/sdk/powershell/v2024/models/activate-campaign-options +tags: ['SDK', 'Software Development Kit', 'ActivateCampaignOptions', 'V2024ActivateCampaignOptions'] +--- + + +# ActivateCampaignOptions + +## Properties + +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"] + +## Examples + +- Prepare the resource +```powershell +$ActivateCampaignOptions = Initialize-PSSailpoint.V2024ActivateCampaignOptions -TimeZone -05:00 +``` + +- Convert the resource to JSON +```powershell +$ActivateCampaignOptions | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ActivityInsights.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ActivityInsights.md new file mode 100644 index 000000000..794d4e378 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ActivityInsights.md @@ -0,0 +1,39 @@ +--- +id: v2024-activity-insights +title: ActivityInsights +pagination_label: ActivityInsights +sidebar_label: ActivityInsights +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ActivityInsights', 'V2024ActivityInsights'] +slug: /tools/sdk/powershell/v2024/models/activity-insights +tags: ['SDK', 'Software Development Kit', 'ActivityInsights', 'V2024ActivityInsights'] +--- + + +# ActivityInsights + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountID** | Pointer to **String** | UUID of the account | [optional] +**UsageDays** | Pointer to **Int32** | The number of days of activity | [optional] +**UsageDaysState** | Pointer to **Enum** [ "COMPLETE", "UNKNOWN" ] | Status indicating if the activity is complete or unknown | [optional] + +## Examples + +- Prepare the resource +```powershell +$ActivityInsights = Initialize-PSSailpoint.V2024ActivityInsights -AccountID c4ddd5421d8549f0abd309162cafd3b1 ` + -UsageDays 45 ` + -UsageDaysState COMPLETE +``` + +- Convert the resource to JSON +```powershell +$ActivityInsights | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AdminReviewReassign.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AdminReviewReassign.md new file mode 100644 index 000000000..bc1061b42 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AdminReviewReassign.md @@ -0,0 +1,39 @@ +--- +id: v2024-admin-review-reassign +title: AdminReviewReassign +pagination_label: AdminReviewReassign +sidebar_label: AdminReviewReassign +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AdminReviewReassign', 'V2024AdminReviewReassign'] +slug: /tools/sdk/powershell/v2024/models/admin-review-reassign +tags: ['SDK', 'Software Development Kit', 'AdminReviewReassign', 'V2024AdminReviewReassign'] +--- + + +# AdminReviewReassign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CertificationIds** | Pointer to **[]String** | List of certification IDs to reassign | [optional] +**ReassignTo** | Pointer to [**AdminReviewReassignReassignTo**](admin-review-reassign-reassign-to) | | [optional] +**Reason** | Pointer to **String** | Comment to explain why the certification was reassigned | [optional] + +## Examples + +- Prepare the resource +```powershell +$AdminReviewReassign = Initialize-PSSailpoint.V2024AdminReviewReassign -CertificationIds [af3859464779471211bb8424a563abc1, af3859464779471211bb8424a563abc2, af3859464779471211bb8424a563abc3] ` + -ReassignTo null ` + -Reason reassigned for some reason +``` + +- Convert the resource to JSON +```powershell +$AdminReviewReassign | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AdminReviewReassignReassignTo.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AdminReviewReassignReassignTo.md new file mode 100644 index 000000000..c733a4a7b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AdminReviewReassignReassignTo.md @@ -0,0 +1,37 @@ +--- +id: v2024-admin-review-reassign-reassign-to +title: AdminReviewReassignReassignTo +pagination_label: AdminReviewReassignReassignTo +sidebar_label: AdminReviewReassignReassignTo +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AdminReviewReassignReassignTo', 'V2024AdminReviewReassignReassignTo'] +slug: /tools/sdk/powershell/v2024/models/admin-review-reassign-reassign-to +tags: ['SDK', 'Software Development Kit', 'AdminReviewReassignReassignTo', 'V2024AdminReviewReassignReassignTo'] +--- + + +# AdminReviewReassignReassignTo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The identity ID to which the review is being assigned. | [optional] +**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of the ID provided. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AdminReviewReassignReassignTo = Initialize-PSSailpoint.V2024AdminReviewReassignReassignTo -Id ef38f94347e94562b5bb8424a56397d8 ` + -Type IDENTITY +``` + +- Convert the resource to JSON +```powershell +$AdminReviewReassignReassignTo | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AggregationResult.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AggregationResult.md new file mode 100644 index 000000000..cec9a02df --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AggregationResult.md @@ -0,0 +1,37 @@ +--- +id: v2024-aggregation-result +title: AggregationResult +pagination_label: AggregationResult +sidebar_label: AggregationResult +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AggregationResult', 'V2024AggregationResult'] +slug: /tools/sdk/powershell/v2024/models/aggregation-result +tags: ['SDK', 'Software Development Kit', 'AggregationResult', 'V2024AggregationResult'] +--- + + +# AggregationResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Aggregations** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run. See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information. | [optional] +**Hits** | Pointer to [**[]SearchDocument**](search-document) | The results of the aggregation search query. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AggregationResult = Initialize-PSSailpoint.V2024AggregationResult -Aggregations {Identity Locations={buckets=[{key=Austin, doc_count=109}, {key=London, doc_count=64}, {key=San Jose, doc_count=27}, {key=Brussels, doc_count=26}, {key=Sao Paulo, doc_count=24}, {key=Munich, doc_count=23}, {key=Singapore, doc_count=22}, {key=Tokyo, doc_count=20}, {key=Taipei, doc_count=16}]}} ` + -Hits null +``` + +- Convert the resource to JSON +```powershell +$AggregationResult | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AggregationType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AggregationType.md new file mode 100644 index 000000000..e2b895a5c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AggregationType.md @@ -0,0 +1,24 @@ +--- +id: v2024-aggregation-type +title: AggregationType +pagination_label: AggregationType +sidebar_label: AggregationType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AggregationType', 'V2024AggregationType'] +slug: /tools/sdk/powershell/v2024/models/aggregation-type +tags: ['SDK', 'Software Development Kit', 'AggregationType', 'V2024AggregationType'] +--- + + +# AggregationType + +## Enum + + +* `DSL` (value: `"DSL"`) + +* `SAILPOINT` (value: `"SAILPOINT"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Aggregations.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Aggregations.md new file mode 100644 index 000000000..732b60a99 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Aggregations.md @@ -0,0 +1,41 @@ +--- +id: v2024-aggregations +title: Aggregations +pagination_label: Aggregations +sidebar_label: Aggregations +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Aggregations', 'V2024Aggregations'] +slug: /tools/sdk/powershell/v2024/models/aggregations +tags: ['SDK', 'Software Development Kit', 'Aggregations', 'V2024Aggregations'] +--- + + +# Aggregations + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Nested** | Pointer to [**NestedAggregation**](nested-aggregation) | | [optional] +**Metric** | Pointer to [**MetricAggregation**](metric-aggregation) | | [optional] +**VarFilter** | Pointer to [**FilterAggregation**](filter-aggregation) | | [optional] +**Bucket** | Pointer to [**BucketAggregation**](bucket-aggregation) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Aggregations = Initialize-PSSailpoint.V2024Aggregations -Nested null ` + -Metric null ` + -VarFilter null ` + -Bucket null +``` + +- Convert the resource to JSON +```powershell +$Aggregations | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/App.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/App.md new file mode 100644 index 000000000..0e75ca98d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/App.md @@ -0,0 +1,41 @@ +--- +id: v2024-app +title: App +pagination_label: App +sidebar_label: App +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'App', 'V2024App'] +slug: /tools/sdk/powershell/v2024/models/app +tags: ['SDK', 'Software Development Kit', 'App', 'V2024App'] +--- + + +# App + +## Properties + +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] +**Source** | Pointer to [**Reference1**](reference1) | | [optional] +**Account** | Pointer to [**AppAllOfAccount**](app-all-of-account) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$App = Initialize-PSSailpoint.V2024App -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -Source null ` + -Account null +``` + +- Convert the resource to JSON +```powershell +$App | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AppAccountDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AppAccountDetails.md new file mode 100644 index 000000000..397a39549 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AppAccountDetails.md @@ -0,0 +1,39 @@ +--- +id: v2024-app-account-details +title: AppAccountDetails +pagination_label: AppAccountDetails +sidebar_label: AppAccountDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AppAccountDetails', 'V2024AppAccountDetails'] +slug: /tools/sdk/powershell/v2024/models/app-account-details +tags: ['SDK', 'Software Development Kit', 'AppAccountDetails', 'V2024AppAccountDetails'] +--- + + +# AppAccountDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AppId** | Pointer to **String** | The source app ID | [optional] +**AppDisplayName** | Pointer to **String** | The source app display name | [optional] +**SourceAccount** | Pointer to [**AppAccountDetailsSourceAccount**](app-account-details-source-account) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AppAccountDetails = Initialize-PSSailpoint.V2024AppAccountDetails -AppId fbf4f72280304f1a8bc808fc2a3bcf7b ` + -AppDisplayName AD source app ` + -SourceAccount null +``` + +- Convert the resource to JSON +```powershell +$AppAccountDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AppAccountDetailsSourceAccount.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AppAccountDetailsSourceAccount.md new file mode 100644 index 000000000..35aebc512 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AppAccountDetailsSourceAccount.md @@ -0,0 +1,43 @@ +--- +id: v2024-app-account-details-source-account +title: AppAccountDetailsSourceAccount +pagination_label: AppAccountDetailsSourceAccount +sidebar_label: AppAccountDetailsSourceAccount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AppAccountDetailsSourceAccount', 'V2024AppAccountDetailsSourceAccount'] +slug: /tools/sdk/powershell/v2024/models/app-account-details-source-account +tags: ['SDK', 'Software Development Kit', 'AppAccountDetailsSourceAccount', 'V2024AppAccountDetailsSourceAccount'] +--- + + +# AppAccountDetailsSourceAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The account ID | [optional] +**NativeIdentity** | Pointer to **String** | The native identity of account | [optional] +**DisplayName** | Pointer to **String** | The display name of account | [optional] +**SourceId** | Pointer to **String** | The source ID of account | [optional] +**SourceDisplayName** | Pointer to **String** | The source name of account | [optional] + +## Examples + +- Prepare the resource +```powershell +$AppAccountDetailsSourceAccount = Initialize-PSSailpoint.V2024AppAccountDetailsSourceAccount -Id fbf4f72280304f1a8bc808fc2a3bcf7b ` + -NativeIdentity CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` + -DisplayName Abby Smith ` + -SourceId 10efa58ea3954883b52bf74f489ce8f9 ` + -SourceDisplayName ODS-AD-SOURCE +``` + +- Convert the resource to JSON +```powershell +$AppAccountDetailsSourceAccount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AppAllOfAccount.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AppAllOfAccount.md new file mode 100644 index 000000000..cd63a8a7b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AppAllOfAccount.md @@ -0,0 +1,37 @@ +--- +id: v2024-app-all-of-account +title: AppAllOfAccount +pagination_label: AppAllOfAccount +sidebar_label: AppAllOfAccount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AppAllOfAccount', 'V2024AppAllOfAccount'] +slug: /tools/sdk/powershell/v2024/models/app-all-of-account +tags: ['SDK', 'Software Development Kit', 'AppAllOfAccount', 'V2024AppAllOfAccount'] +--- + + +# AppAllOfAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The SailPoint generated unique ID | [optional] +**AccountId** | Pointer to **String** | The account ID generated by the source | [optional] + +## Examples + +- Prepare the resource +```powershell +$AppAllOfAccount = Initialize-PSSailpoint.V2024AppAllOfAccount -Id 2c9180837dfe6949017e21f3d8cd6d49 ` + -AccountId CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com +``` + +- Convert the resource to JSON +```powershell +$AppAllOfAccount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Approval.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Approval.md new file mode 100644 index 000000000..d238b81e2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Approval.md @@ -0,0 +1,67 @@ +--- +id: v2024-approval +title: Approval +pagination_label: Approval +sidebar_label: Approval +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Approval', 'V2024Approval'] +slug: /tools/sdk/powershell/v2024/models/approval +tags: ['SDK', 'Software Development Kit', 'Approval', 'V2024Approval'] +--- + + +# Approval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalId** | Pointer to **String** | The Approval ID | [optional] +**Approvers** | Pointer to [**[]ApprovalIdentity**](approval-identity) | Object representation of an approver of an approval | [optional] +**CreatedDate** | Pointer to **String** | Date the approval was created | [optional] +**Type** | Pointer to **String** | Type of approval | [optional] +**Name** | Pointer to [**[]ApprovalName**](approval-name) | The name of the approval for a given locale | [optional] +**BatchRequest** | Pointer to [**ApprovalBatch**](approval-batch) | The name of the approval for a given locale | [optional] +**Description** | Pointer to [**[]ApprovalDescription**](approval-description) | The description of the approval for a given locale | [optional] +**Priority** | Pointer to **Enum** [ "HIGH", "MEDIUM", "LOW" ] | The priority of the approval | [optional] +**Requester** | Pointer to [**ApprovalIdentity**](approval-identity) | Object representation of the requester of the approval | [optional] +**Comments** | Pointer to [**[]ApprovalComment1**](approval-comment1) | Object representation of a comment on the approval | [optional] +**ApprovedBy** | Pointer to [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have approved the approval | [optional] +**RejectedBy** | Pointer to [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have rejected the approval | [optional] +**CompletedDate** | Pointer to **String** | Date the approval was completed | [optional] +**ApprovalCriteria** | Pointer to **Enum** [ "SINGLE", "DOUBLE", "TRIPLE", "QUARTER", "HALF", "ALL" ] | Criteria that needs to be met for an approval to be marked as approved | [optional] +**Status** | Pointer to **Enum** [ "PENDING", "APPROVED", "REJECTED" ] | The current status of the approval | [optional] +**AdditionalAttributes** | Pointer to **String** | Json string representing additional attributes known about the object to be approved. | [optional] +**ReferenceData** | Pointer to [**[]ApprovalReference**](approval-reference) | Reference data related to the approval | [optional] + +## Examples + +- Prepare the resource +```powershell +$Approval = Initialize-PSSailpoint.V2024Approval -ApprovalId 38453251-6be2-5f8f-df93-5ce19e295837 ` + -Approvers null ` + -CreatedDate 2023-04-12T23:20:50.52Z ` + -Type ENTITLEMENT_DESCRIPTIONS ` + -Name null ` + -BatchRequest {batchId=38453251-6be2-5f8f-df93-5ce19e295837, batchSize=100} ` + -Description null ` + -Priority HIGH ` + -Requester {id=85d173e7d57e496569df763231d6deb6a, type=IDENTITY, name=John Doe} ` + -Comments null ` + -ApprovedBy null ` + -RejectedBy null ` + -CompletedDate 2023-04-12T23:20:50.52Z ` + -ApprovalCriteria SINGLE ` + -Status PENDING ` + -AdditionalAttributes { "llm_description": "generated description" } ` + -ReferenceData null +``` + +- Convert the resource to JSON +```powershell +$Approval | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Approval1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Approval1.md new file mode 100644 index 000000000..a9042f091 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Approval1.md @@ -0,0 +1,45 @@ +--- +id: v2024-approval1 +title: Approval1 +pagination_label: Approval1 +sidebar_label: Approval1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Approval1', 'V2024Approval1'] +slug: /tools/sdk/powershell/v2024/models/approval1 +tags: ['SDK', 'Software Development Kit', 'Approval1', 'V2024Approval1'] +--- + + +# Approval1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comments** | Pointer to [**[]ApprovalComment2**](approval-comment2) | | [optional] +**Created** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] +**Modified** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] +**Owner** | Pointer to [**AccountSource**](account-source) | | [optional] +**Result** | Pointer to **String** | The result of the approval | [optional] +**Type** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Approval1 = Initialize-PSSailpoint.V2024Approval1 -Comments null ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Owner null ` + -Result Finished ` + -Type null +``` + +- Convert the resource to JSON +```powershell +$Approval1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalBatch.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalBatch.md new file mode 100644 index 000000000..1346cb712 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalBatch.md @@ -0,0 +1,37 @@ +--- +id: v2024-approval-batch +title: ApprovalBatch +pagination_label: ApprovalBatch +sidebar_label: ApprovalBatch +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalBatch', 'V2024ApprovalBatch'] +slug: /tools/sdk/powershell/v2024/models/approval-batch +tags: ['SDK', 'Software Development Kit', 'ApprovalBatch', 'V2024ApprovalBatch'] +--- + + +# ApprovalBatch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchId** | Pointer to **String** | ID of the batch | [optional] +**BatchSize** | Pointer to **Int64** | How many approvals are going to be in this batch. Defaults to 1 if not provided. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalBatch = Initialize-PSSailpoint.V2024ApprovalBatch -BatchId 38453251-6be2-5f8f-df93-5ce19e295837 ` + -BatchSize 100 +``` + +- Convert the resource to JSON +```powershell +$ApprovalBatch | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalComment.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalComment.md new file mode 100644 index 000000000..c6aa88412 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalComment.md @@ -0,0 +1,43 @@ +--- +id: v2024-approval-comment +title: ApprovalComment +pagination_label: ApprovalComment +sidebar_label: ApprovalComment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalComment', 'V2024ApprovalComment'] +slug: /tools/sdk/powershell/v2024/models/approval-comment +tags: ['SDK', 'Software Development Kit', 'ApprovalComment', 'V2024ApprovalComment'] +--- + + +# ApprovalComment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | **String** | Comment provided either by the approval requester or the approver. | [required] +**Timestamp** | **System.DateTime** | The time when this comment was provided. | [required] +**User** | **String** | Name of the user that provided this comment. | [required] +**Id** | **String** | Id of the user that provided this comment. | [required] +**ChangedToStatus** | **Enum** [ "PENDING_APPROVAL", "APPROVED", "REJECTED" ] | Status transition of the draft. | [required] + +## Examples + +- Prepare the resource +```powershell +$ApprovalComment = Initialize-PSSailpoint.V2024ApprovalComment -Comment Approval comment ` + -Timestamp 2021-05-11T22:23:16Z ` + -User user.name ` + -Id 549bf881-1ac4-4a64-9acf-6014e8a3a887 ` + -ChangedToStatus PENDING_APPROVAL +``` + +- Convert the resource to JSON +```powershell +$ApprovalComment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalComment1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalComment1.md new file mode 100644 index 000000000..ffa42caaf --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalComment1.md @@ -0,0 +1,39 @@ +--- +id: v2024-approval-comment1 +title: ApprovalComment1 +pagination_label: ApprovalComment1 +sidebar_label: ApprovalComment1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalComment1', 'V2024ApprovalComment1'] +slug: /tools/sdk/powershell/v2024/models/approval-comment1 +tags: ['SDK', 'Software Development Kit', 'ApprovalComment1', 'V2024ApprovalComment1'] +--- + + +# ApprovalComment1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Author** | Pointer to [**ApprovalIdentity**](approval-identity) | | [optional] +**Comment** | Pointer to **String** | Comment to be left on an approval | [optional] +**CreatedDate** | Pointer to **String** | Date the comment was created | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalComment1 = Initialize-PSSailpoint.V2024ApprovalComment1 -Author null ` + -Comment Looks good ` + -CreatedDate 2023-04-12T23:20:50.52Z +``` + +- Convert the resource to JSON +```powershell +$ApprovalComment1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalComment2.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalComment2.md new file mode 100644 index 000000000..5e23fa4b6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalComment2.md @@ -0,0 +1,39 @@ +--- +id: v2024-approval-comment2 +title: ApprovalComment2 +pagination_label: ApprovalComment2 +sidebar_label: ApprovalComment2 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalComment2', 'V2024ApprovalComment2'] +slug: /tools/sdk/powershell/v2024/models/approval-comment2 +tags: ['SDK', 'Software Development Kit', 'ApprovalComment2', 'V2024ApprovalComment2'] +--- + + +# ApprovalComment2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | The comment text | [optional] +**Commenter** | Pointer to **String** | The name of the commenter | [optional] +**Date** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalComment2 = Initialize-PSSailpoint.V2024ApprovalComment2 -Comment This request was autoapproved by our automated ETS subscriber. ` + -Commenter Automated AR Approval ` + -Date 2018-06-25T20:22:28.104Z +``` + +- Convert the resource to JSON +```powershell +$ApprovalComment2 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalDescription.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalDescription.md new file mode 100644 index 000000000..2d86b9a0c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalDescription.md @@ -0,0 +1,37 @@ +--- +id: v2024-approval-description +title: ApprovalDescription +pagination_label: ApprovalDescription +sidebar_label: ApprovalDescription +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalDescription', 'V2024ApprovalDescription'] +slug: /tools/sdk/powershell/v2024/models/approval-description +tags: ['SDK', 'Software Development Kit', 'ApprovalDescription', 'V2024ApprovalDescription'] +--- + + +# ApprovalDescription + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **String** | The description of what the approval is asking for | [optional] +**Locale** | Pointer to **String** | What locale the description of the approval is using | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalDescription = Initialize-PSSailpoint.V2024ApprovalDescription -Value This access allows viewing and editing of workflow resource ` + -Locale en_US +``` + +- Convert the resource to JSON +```powershell +$ApprovalDescription | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalForwardHistory.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalForwardHistory.md new file mode 100644 index 000000000..5ecb47274 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalForwardHistory.md @@ -0,0 +1,45 @@ +--- +id: v2024-approval-forward-history +title: ApprovalForwardHistory +pagination_label: ApprovalForwardHistory +sidebar_label: ApprovalForwardHistory +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalForwardHistory', 'V2024ApprovalForwardHistory'] +slug: /tools/sdk/powershell/v2024/models/approval-forward-history +tags: ['SDK', 'Software Development Kit', 'ApprovalForwardHistory', 'V2024ApprovalForwardHistory'] +--- + + +# ApprovalForwardHistory + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OldApproverName** | Pointer to **String** | Display name of approver from whom the approval was forwarded. | [optional] +**NewApproverName** | Pointer to **String** | Display name of approver to whom the approval was forwarded. | [optional] +**Comment** | Pointer to **String** | Comment made while forwarding. | [optional] +**Modified** | Pointer to **System.DateTime** | Time at which approval was forwarded. | [optional] +**ForwarderName** | Pointer to **String** | Display name of forwarder who forwarded the approval. | [optional] +**ReassignmentType** | Pointer to [**ReassignmentType**](reassignment-type) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalForwardHistory = Initialize-PSSailpoint.V2024ApprovalForwardHistory -OldApproverName Frank Mir ` + -NewApproverName Al Volta ` + -Comment Forwarding from Frank to Al ` + -Modified 2019-08-23T18:52:57.398Z ` + -ForwarderName William Wilson ` + -ReassignmentType null +``` + +- Convert the resource to JSON +```powershell +$ApprovalForwardHistory | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalForwardHistory1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalForwardHistory1.md new file mode 100644 index 000000000..e7f9c35c3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalForwardHistory1.md @@ -0,0 +1,45 @@ +--- +id: v2024-approval-forward-history1 +title: ApprovalForwardHistory1 +pagination_label: ApprovalForwardHistory1 +sidebar_label: ApprovalForwardHistory1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalForwardHistory1', 'V2024ApprovalForwardHistory1'] +slug: /tools/sdk/powershell/v2024/models/approval-forward-history1 +tags: ['SDK', 'Software Development Kit', 'ApprovalForwardHistory1', 'V2024ApprovalForwardHistory1'] +--- + + +# ApprovalForwardHistory1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OldApproverName** | Pointer to **String** | Display name of approver from whom the approval was forwarded. | [optional] +**NewApproverName** | Pointer to **String** | Display name of approver to whom the approval was forwarded. | [optional] +**Comment** | Pointer to **String** | Comment made while forwarding. | [optional] +**Modified** | Pointer to **System.DateTime** | Time at which approval was forwarded. | [optional] +**ForwarderName** | Pointer to **String** | Display name of forwarder who forwarded the approval. | [optional] +**ReassignmentType** | Pointer to [**ReassignmentType**](reassignment-type) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalForwardHistory1 = Initialize-PSSailpoint.V2024ApprovalForwardHistory1 -OldApproverName Frank Mir ` + -NewApproverName Al Volta ` + -Comment Forwarding from Frank to Al ` + -Modified 2019-08-23T18:52:57.398Z ` + -ForwarderName William Wilson ` + -ReassignmentType null +``` + +- Convert the resource to JSON +```powershell +$ApprovalForwardHistory1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalIdentity.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalIdentity.md new file mode 100644 index 000000000..f2cd200a6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalIdentity.md @@ -0,0 +1,39 @@ +--- +id: v2024-approval-identity +title: ApprovalIdentity +pagination_label: ApprovalIdentity +sidebar_label: ApprovalIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalIdentity', 'V2024ApprovalIdentity'] +slug: /tools/sdk/powershell/v2024/models/approval-identity +tags: ['SDK', 'Software Development Kit', 'ApprovalIdentity', 'V2024ApprovalIdentity'] +--- + + +# ApprovalIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The identity ID | [optional] +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Indication of what group the identity belongs to. Ie, IDENTITY, GOVERNANCE_GROUP, etc | [optional] +**Name** | Pointer to **String** | Name of the identity | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalIdentity = Initialize-PSSailpoint.V2024ApprovalIdentity -Id 85d173e7d57e496569df763231d6deb6a ` + -Type IDENTITY ` + -Name John Doe +``` + +- Convert the resource to JSON +```powershell +$ApprovalIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalInfoResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalInfoResponse.md new file mode 100644 index 000000000..9e4dfce96 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalInfoResponse.md @@ -0,0 +1,39 @@ +--- +id: v2024-approval-info-response +title: ApprovalInfoResponse +pagination_label: ApprovalInfoResponse +sidebar_label: ApprovalInfoResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalInfoResponse', 'V2024ApprovalInfoResponse'] +slug: /tools/sdk/powershell/v2024/models/approval-info-response +tags: ['SDK', 'Software Development Kit', 'ApprovalInfoResponse', 'V2024ApprovalInfoResponse'] +--- + + +# ApprovalInfoResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | the id of approver | [optional] +**Name** | Pointer to **String** | the name of approver | [optional] +**Status** | Pointer to **String** | the status of the approval request | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalInfoResponse = Initialize-PSSailpoint.V2024ApprovalInfoResponse -Id 8a80828f643d484f01643e14202e2000 ` + -Name John Snow ` + -Status Approved +``` + +- Convert the resource to JSON +```powershell +$ApprovalInfoResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalItemDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalItemDetails.md new file mode 100644 index 000000000..1f8c444d3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalItemDetails.md @@ -0,0 +1,47 @@ +--- +id: v2024-approval-item-details +title: ApprovalItemDetails +pagination_label: ApprovalItemDetails +sidebar_label: ApprovalItemDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalItemDetails', 'V2024ApprovalItemDetails'] +slug: /tools/sdk/powershell/v2024/models/approval-item-details +tags: ['SDK', 'Software Development Kit', 'ApprovalItemDetails', 'V2024ApprovalItemDetails'] +--- + + +# ApprovalItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The approval item's ID | [optional] +**Account** | Pointer to **String** | The account referenced by the approval item | [optional] +**Application** | Pointer to **String** | The name of the application/source | [optional] +**Name** | Pointer to **String** | The attribute's name | [optional] +**Operation** | Pointer to **String** | The attribute's operation | [optional] +**Value** | Pointer to **String** | The attribute's value | [optional] +**State** | Pointer to [**WorkItemState**](work-item-state) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalItemDetails = Initialize-PSSailpoint.V2024ApprovalItemDetails -Id 2c9180835d2e5168015d32f890ca1581 ` + -Account john.smith ` + -Application Active Directory ` + -Name emailAddress ` + -Operation update ` + -Value a@b.com ` + -State null +``` + +- Convert the resource to JSON +```powershell +$ApprovalItemDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalItems.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalItems.md new file mode 100644 index 000000000..58db78531 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalItems.md @@ -0,0 +1,47 @@ +--- +id: v2024-approval-items +title: ApprovalItems +pagination_label: ApprovalItems +sidebar_label: ApprovalItems +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalItems', 'V2024ApprovalItems'] +slug: /tools/sdk/powershell/v2024/models/approval-items +tags: ['SDK', 'Software Development Kit', 'ApprovalItems', 'V2024ApprovalItems'] +--- + + +# ApprovalItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The approval item's ID | [optional] +**Account** | Pointer to **String** | The account referenced by the approval item | [optional] +**Application** | Pointer to **String** | The name of the application/source | [optional] +**Name** | Pointer to **String** | The attribute's name | [optional] +**Operation** | Pointer to **String** | The attribute's operation | [optional] +**Value** | Pointer to **String** | The attribute's value | [optional] +**State** | Pointer to [**WorkItemState**](work-item-state) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalItems = Initialize-PSSailpoint.V2024ApprovalItems -Id 2c9180835d2e5168015d32f890ca1581 ` + -Account john.smith ` + -Application Active Directory ` + -Name emailAddress ` + -Operation update ` + -Value a@b.com ` + -State null +``` + +- Convert the resource to JSON +```powershell +$ApprovalItems | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalName.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalName.md new file mode 100644 index 000000000..4d9d05cf4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalName.md @@ -0,0 +1,37 @@ +--- +id: v2024-approval-name +title: ApprovalName +pagination_label: ApprovalName +sidebar_label: ApprovalName +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalName', 'V2024ApprovalName'] +slug: /tools/sdk/powershell/v2024/models/approval-name +tags: ['SDK', 'Software Development Kit', 'ApprovalName', 'V2024ApprovalName'] +--- + + +# ApprovalName + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **String** | Name of the approval | [optional] +**Locale** | Pointer to **String** | What locale the name of the approval is using | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalName = Initialize-PSSailpoint.V2024ApprovalName -Value Audit DB Access ` + -Locale en_US +``` + +- Convert the resource to JSON +```powershell +$ApprovalName | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalReference.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalReference.md new file mode 100644 index 000000000..70b03410b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalReference.md @@ -0,0 +1,37 @@ +--- +id: v2024-approval-reference +title: ApprovalReference +pagination_label: ApprovalReference +sidebar_label: ApprovalReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalReference', 'V2024ApprovalReference'] +slug: /tools/sdk/powershell/v2024/models/approval-reference +tags: ['SDK', 'Software Development Kit', 'ApprovalReference', 'V2024ApprovalReference'] +--- + + +# ApprovalReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the reference object | [optional] +**Type** | Pointer to **String** | What reference object does this ID correspond to | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalReference = Initialize-PSSailpoint.V2024ApprovalReference -Id 64012350-8fd9-4f6c-a170-1fe123683899 ` + -Type AccessRequestId +``` + +- Convert the resource to JSON +```powershell +$ApprovalReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalReminderAndEscalationConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalReminderAndEscalationConfig.md new file mode 100644 index 000000000..216e63ded --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalReminderAndEscalationConfig.md @@ -0,0 +1,41 @@ +--- +id: v2024-approval-reminder-and-escalation-config +title: ApprovalReminderAndEscalationConfig +pagination_label: ApprovalReminderAndEscalationConfig +sidebar_label: ApprovalReminderAndEscalationConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalReminderAndEscalationConfig', 'V2024ApprovalReminderAndEscalationConfig'] +slug: /tools/sdk/powershell/v2024/models/approval-reminder-and-escalation-config +tags: ['SDK', 'Software Development Kit', 'ApprovalReminderAndEscalationConfig', 'V2024ApprovalReminderAndEscalationConfig'] +--- + + +# ApprovalReminderAndEscalationConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DaysUntilEscalation** | Pointer to **Int32** | Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation. | [optional] +**DaysBetweenReminders** | Pointer to **Int32** | Number of days to wait between reminder notifications. | [optional] +**MaxReminders** | Pointer to **Int32** | Maximum number of reminder notification to send to the reviewer before approval escalation. | [optional] +**FallbackApproverRef** | Pointer to [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalReminderAndEscalationConfig = Initialize-PSSailpoint.V2024ApprovalReminderAndEscalationConfig -DaysUntilEscalation 0 ` + -DaysBetweenReminders 0 ` + -MaxReminders 1 ` + -FallbackApproverRef null +``` + +- Convert the resource to JSON +```powershell +$ApprovalReminderAndEscalationConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalScheme.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalScheme.md new file mode 100644 index 000000000..ba35e1514 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalScheme.md @@ -0,0 +1,34 @@ +--- +id: v2024-approval-scheme +title: ApprovalScheme +pagination_label: ApprovalScheme +sidebar_label: ApprovalScheme +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalScheme', 'V2024ApprovalScheme'] +slug: /tools/sdk/powershell/v2024/models/approval-scheme +tags: ['SDK', 'Software Development Kit', 'ApprovalScheme', 'V2024ApprovalScheme'] +--- + + +# ApprovalScheme + +## Enum + + +* `APP_OWNER` (value: `"APP_OWNER"`) + +* `SOURCE_OWNER` (value: `"SOURCE_OWNER"`) + +* `MANAGER` (value: `"MANAGER"`) + +* `ROLE_OWNER` (value: `"ROLE_OWNER"`) + +* `ACCESS_PROFILE_OWNER` (value: `"ACCESS_PROFILE_OWNER"`) + +* `ENTITLEMENT_OWNER` (value: `"ENTITLEMENT_OWNER"`) + +* `GOVERNANCE_GROUP` (value: `"GOVERNANCE_GROUP"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalSchemeForRole.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalSchemeForRole.md new file mode 100644 index 000000000..c089a63f2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalSchemeForRole.md @@ -0,0 +1,37 @@ +--- +id: v2024-approval-scheme-for-role +title: ApprovalSchemeForRole +pagination_label: ApprovalSchemeForRole +sidebar_label: ApprovalSchemeForRole +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalSchemeForRole', 'V2024ApprovalSchemeForRole'] +slug: /tools/sdk/powershell/v2024/models/approval-scheme-for-role +tags: ['SDK', 'Software Development Kit', 'ApprovalSchemeForRole', 'V2024ApprovalSchemeForRole'] +--- + + +# ApprovalSchemeForRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApproverType** | Pointer to **Enum** [ "OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **OWNER**: Owner of the associated Role **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] + +## Examples + +- Prepare the resource +```powershell +$ApprovalSchemeForRole = Initialize-PSSailpoint.V2024ApprovalSchemeForRole -ApproverType GOVERNANCE_GROUP ` + -ApproverId 46c79819-a69f-49a2-becb-12c971ae66c6 +``` + +- Convert the resource to JSON +```powershell +$ApprovalSchemeForRole | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalStatus.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalStatus.md new file mode 100644 index 000000000..545ee2531 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalStatus.md @@ -0,0 +1,30 @@ +--- +id: v2024-approval-status +title: ApprovalStatus +pagination_label: ApprovalStatus +sidebar_label: ApprovalStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalStatus', 'V2024ApprovalStatus'] +slug: /tools/sdk/powershell/v2024/models/approval-status +tags: ['SDK', 'Software Development Kit', 'ApprovalStatus', 'V2024ApprovalStatus'] +--- + + +# ApprovalStatus + +## Enum + + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `PENDING` (value: `"PENDING"`) + +* `NOT_READY` (value: `"NOT_READY"`) + +* `CANCELLED` (value: `"CANCELLED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalStatusDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalStatusDto.md new file mode 100644 index 000000000..0f26375dd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalStatusDto.md @@ -0,0 +1,53 @@ +--- +id: v2024-approval-status-dto +title: ApprovalStatusDto +pagination_label: ApprovalStatusDto +sidebar_label: ApprovalStatusDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalStatusDto', 'V2024ApprovalStatusDto'] +slug: /tools/sdk/powershell/v2024/models/approval-status-dto +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDto', 'V2024ApprovalStatusDto'] +--- + + +# ApprovalStatusDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalId** | Pointer to **String** | Unique identifier for the approval. | [optional] +**Forwarded** | Pointer to **Boolean** | True if the request for this item was forwarded from one owner to another. | [optional] [default to $false] +**OriginalOwner** | Pointer to [**ApprovalStatusDtoOriginalOwner**](approval-status-dto-original-owner) | | [optional] +**CurrentOwner** | Pointer to [**ApprovalStatusDtoCurrentOwner**](approval-status-dto-current-owner) | | [optional] +**Modified** | Pointer to **System.DateTime** | Time at which item was modified. | [optional] +**Status** | Pointer to [**ManualWorkItemState**](manual-work-item-state) | | [optional] +**Scheme** | Pointer to [**ApprovalScheme**](approval-scheme) | | [optional] +**ErrorMessages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | If the request failed, includes any error messages that were generated. | [optional] +**Comment** | Pointer to **String** | Comment, if any, provided by the approver. | [optional] +**RemoveDate** | Pointer to **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalStatusDto = Initialize-PSSailpoint.V2024ApprovalStatusDto -ApprovalId 2c9180877b2b6ea4017b2c545f971429 ` + -Forwarded false ` + -OriginalOwner null ` + -CurrentOwner null ` + -Modified 2019-08-23T18:52:57.398Z ` + -Status null ` + -Scheme null ` + -ErrorMessages null ` + -Comment I approve this request ` + -RemoveDate 2020-07-11T00:00Z +``` + +- Convert the resource to JSON +```powershell +$ApprovalStatusDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalStatusDto1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalStatusDto1.md new file mode 100644 index 000000000..aac8d8382 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalStatusDto1.md @@ -0,0 +1,51 @@ +--- +id: v2024-approval-status-dto1 +title: ApprovalStatusDto1 +pagination_label: ApprovalStatusDto1 +sidebar_label: ApprovalStatusDto1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalStatusDto1', 'V2024ApprovalStatusDto1'] +slug: /tools/sdk/powershell/v2024/models/approval-status-dto1 +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDto1', 'V2024ApprovalStatusDto1'] +--- + + +# ApprovalStatusDto1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Forwarded** | Pointer to **Boolean** | True if the request for this item was forwarded from one owner to another. | [optional] [default to $false] +**OriginalOwner** | Pointer to [**ApprovalStatusDtoOriginalOwner**](approval-status-dto-original-owner) | | [optional] +**CurrentOwner** | Pointer to [**ApprovalStatusDtoCurrentOwner**](approval-status-dto-current-owner) | | [optional] +**Modified** | Pointer to **System.DateTime** | Time at which item was modified. | [optional] +**Status** | Pointer to [**ManualWorkItemState**](manual-work-item-state) | | [optional] +**Scheme** | Pointer to [**ApprovalScheme**](approval-scheme) | | [optional] +**ErrorMessages** | Pointer to [**[]ErrorMessageDto1**](error-message-dto1) | If the request failed, includes any error messages that were generated. | [optional] +**Comment** | Pointer to **String** | Comment, if any, provided by the approver. | [optional] +**RemoveDate** | Pointer to **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalStatusDto1 = Initialize-PSSailpoint.V2024ApprovalStatusDto1 -Forwarded false ` + -OriginalOwner null ` + -CurrentOwner null ` + -Modified 2019-08-23T18:52:57.398Z ` + -Status null ` + -Scheme null ` + -ErrorMessages null ` + -Comment I approve this request ` + -RemoveDate 2020-07-11T00:00Z +``` + +- Convert the resource to JSON +```powershell +$ApprovalStatusDto1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalStatusDtoCurrentOwner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalStatusDtoCurrentOwner.md new file mode 100644 index 000000000..668ab2b35 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalStatusDtoCurrentOwner.md @@ -0,0 +1,39 @@ +--- +id: v2024-approval-status-dto-current-owner +title: ApprovalStatusDtoCurrentOwner +pagination_label: ApprovalStatusDtoCurrentOwner +sidebar_label: ApprovalStatusDtoCurrentOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalStatusDtoCurrentOwner', 'V2024ApprovalStatusDtoCurrentOwner'] +slug: /tools/sdk/powershell/v2024/models/approval-status-dto-current-owner +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoCurrentOwner', 'V2024ApprovalStatusDtoCurrentOwner'] +--- + + +# ApprovalStatusDtoCurrentOwner + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$ApprovalStatusDtoCurrentOwner = Initialize-PSSailpoint.V2024ApprovalStatusDtoCurrentOwner -Type IDENTITY ` + -Id 2c3780a46faadee4016fb4e018c20652 ` + -Name Allen Albertson +``` + +- Convert the resource to JSON +```powershell +$ApprovalStatusDtoCurrentOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalStatusDtoOriginalOwner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalStatusDtoOriginalOwner.md new file mode 100644 index 000000000..3980bb2c5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalStatusDtoOriginalOwner.md @@ -0,0 +1,39 @@ +--- +id: v2024-approval-status-dto-original-owner +title: ApprovalStatusDtoOriginalOwner +pagination_label: ApprovalStatusDtoOriginalOwner +sidebar_label: ApprovalStatusDtoOriginalOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalStatusDtoOriginalOwner', 'V2024ApprovalStatusDtoOriginalOwner'] +slug: /tools/sdk/powershell/v2024/models/approval-status-dto-original-owner +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoOriginalOwner', 'V2024ApprovalStatusDtoOriginalOwner'] +--- + + +# ApprovalStatusDtoOriginalOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP", "IDENTITY" ] | DTO type of original approval owner's identity. | [optional] +**Id** | Pointer to **String** | ID of original approval owner's identity. | [optional] +**Name** | Pointer to **String** | Display name of original approval owner. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalStatusDtoOriginalOwner = Initialize-PSSailpoint.V2024ApprovalStatusDtoOriginalOwner -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$ApprovalStatusDtoOriginalOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalSummary.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalSummary.md new file mode 100644 index 000000000..5b80dff8b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ApprovalSummary.md @@ -0,0 +1,39 @@ +--- +id: v2024-approval-summary +title: ApprovalSummary +pagination_label: ApprovalSummary +sidebar_label: ApprovalSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalSummary', 'V2024ApprovalSummary'] +slug: /tools/sdk/powershell/v2024/models/approval-summary +tags: ['SDK', 'Software Development Kit', 'ApprovalSummary', 'V2024ApprovalSummary'] +--- + + +# ApprovalSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Pending** | Pointer to **Int32** | The number of pending access requests approvals. | [optional] +**Approved** | Pointer to **Int32** | The number of approved access requests approvals. | [optional] +**Rejected** | Pointer to **Int32** | The number of rejected access requests approvals. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalSummary = Initialize-PSSailpoint.V2024ApprovalSummary -Pending 0 ` + -Approved 0 ` + -Rejected 0 +``` + +- Convert the resource to JSON +```powershell +$ApprovalSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Argument.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Argument.md new file mode 100644 index 000000000..ebef4cfde --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Argument.md @@ -0,0 +1,39 @@ +--- +id: v2024-argument +title: Argument +pagination_label: Argument +sidebar_label: Argument +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Argument', 'V2024Argument'] +slug: /tools/sdk/powershell/v2024/models/argument +tags: ['SDK', 'Software Development Kit', 'Argument', 'V2024Argument'] +--- + + +# Argument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | the name of the argument | [required] +**Description** | Pointer to **String** | the description of the argument | [optional] +**Type** | Pointer to **String** | the programmatic type of the argument | [optional] + +## Examples + +- Prepare the resource +```powershell +$Argument = Initialize-PSSailpoint.V2024Argument -Name firstName ` + -Description the first name of the identity ` + -Type String +``` + +- Convert the resource to JSON +```powershell +$Argument | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ArrayInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ArrayInner.md new file mode 100644 index 000000000..8b48fafe0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ArrayInner.md @@ -0,0 +1,34 @@ +--- +id: v2024-array-inner +title: ArrayInner +pagination_label: ArrayInner +sidebar_label: ArrayInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ArrayInner', 'V2024ArrayInner'] +slug: /tools/sdk/powershell/v2024/models/array-inner +tags: ['SDK', 'Software Development Kit', 'ArrayInner', 'V2024ArrayInner'] +--- + + +# ArrayInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$ArrayInner = Initialize-PSSailpoint.V2024ArrayInner +``` + +- Convert the resource to JSON +```powershell +$ArrayInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AssignmentContextDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AssignmentContextDto.md new file mode 100644 index 000000000..54e19e9af --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AssignmentContextDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-assignment-context-dto +title: AssignmentContextDto +pagination_label: AssignmentContextDto +sidebar_label: AssignmentContextDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AssignmentContextDto', 'V2024AssignmentContextDto'] +slug: /tools/sdk/powershell/v2024/models/assignment-context-dto +tags: ['SDK', 'Software Development Kit', 'AssignmentContextDto', 'V2024AssignmentContextDto'] +--- + + +# AssignmentContextDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Requested** | Pointer to [**AccessRequestContext**](access-request-context) | | [optional] +**Matched** | Pointer to [**[]RoleMatchDto**](role-match-dto) | | [optional] +**ComputedDate** | Pointer to **String** | Date that the assignment will was evaluated | [optional] + +## Examples + +- Prepare the resource +```powershell +$AssignmentContextDto = Initialize-PSSailpoint.V2024AssignmentContextDto -Requested null ` + -Matched null ` + -ComputedDate Wed Feb 14 10:58:42 +``` + +- Convert the resource to JSON +```powershell +$AssignmentContextDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttrSyncSource.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttrSyncSource.md new file mode 100644 index 000000000..4e70e4223 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttrSyncSource.md @@ -0,0 +1,39 @@ +--- +id: v2024-attr-sync-source +title: AttrSyncSource +pagination_label: AttrSyncSource +sidebar_label: AttrSyncSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttrSyncSource', 'V2024AttrSyncSource'] +slug: /tools/sdk/powershell/v2024/models/attr-sync-source +tags: ['SDK', 'Software Development Kit', 'AttrSyncSource', 'V2024AttrSyncSource'] +--- + + +# AttrSyncSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "SOURCE" ] | DTO type of target source for attribute synchronization. | [optional] +**Id** | Pointer to **String** | ID of target source for attribute synchronization. | [optional] +**Name** | Pointer to **String** | Human-readable name of target source for attribute synchronization. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AttrSyncSource = Initialize-PSSailpoint.V2024AttrSyncSource -Type SOURCE ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name HR Active Directory +``` + +- Convert the resource to JSON +```powershell +$AttrSyncSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttrSyncSourceAttributeConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttrSyncSourceAttributeConfig.md new file mode 100644 index 000000000..d9aa67edc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttrSyncSourceAttributeConfig.md @@ -0,0 +1,41 @@ +--- +id: v2024-attr-sync-source-attribute-config +title: AttrSyncSourceAttributeConfig +pagination_label: AttrSyncSourceAttributeConfig +sidebar_label: AttrSyncSourceAttributeConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttrSyncSourceAttributeConfig', 'V2024AttrSyncSourceAttributeConfig'] +slug: /tools/sdk/powershell/v2024/models/attr-sync-source-attribute-config +tags: ['SDK', 'Software Development Kit', 'AttrSyncSourceAttributeConfig', 'V2024AttrSyncSourceAttributeConfig'] +--- + + +# AttrSyncSourceAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Name of the identity attribute | [required] +**DisplayName** | **String** | Display name of the identity attribute | [required] +**Enabled** | **Boolean** | Determines whether or not the attribute is enabled for synchronization | [required] +**Target** | **String** | Name of the source account attribute to which the identity attribute value will be synchronized if enabled | [required] + +## Examples + +- Prepare the resource +```powershell +$AttrSyncSourceAttributeConfig = Initialize-PSSailpoint.V2024AttrSyncSourceAttributeConfig -Name email ` + -DisplayName Email ` + -Enabled true ` + -Target mail +``` + +- Convert the resource to JSON +```powershell +$AttrSyncSourceAttributeConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttrSyncSourceConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttrSyncSourceConfig.md new file mode 100644 index 000000000..7d5ff70d4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttrSyncSourceConfig.md @@ -0,0 +1,37 @@ +--- +id: v2024-attr-sync-source-config +title: AttrSyncSourceConfig +pagination_label: AttrSyncSourceConfig +sidebar_label: AttrSyncSourceConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttrSyncSourceConfig', 'V2024AttrSyncSourceConfig'] +slug: /tools/sdk/powershell/v2024/models/attr-sync-source-config +tags: ['SDK', 'Software Development Kit', 'AttrSyncSourceConfig', 'V2024AttrSyncSourceConfig'] +--- + + +# AttrSyncSourceConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | [**AttrSyncSource**](attr-sync-source) | | [required] +**Attributes** | [**[]AttrSyncSourceAttributeConfig**](attr-sync-source-attribute-config) | Attribute synchronization configuration for specific identity attributes in the context of a source | [required] + +## Examples + +- Prepare the resource +```powershell +$AttrSyncSourceConfig = Initialize-PSSailpoint.V2024AttrSyncSourceConfig -Source null ` + -Attributes [{name=email, displayName=Email, enabled=true, target=mail}, {name=firstname, displayName=First Name, enabled=false, target=givenName}] +``` + +- Convert the resource to JSON +```powershell +$AttrSyncSourceConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributeChange.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributeChange.md new file mode 100644 index 000000000..7d26ce5e8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributeChange.md @@ -0,0 +1,39 @@ +--- +id: v2024-attribute-change +title: AttributeChange +pagination_label: AttributeChange +sidebar_label: AttributeChange +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeChange', 'V2024AttributeChange'] +slug: /tools/sdk/powershell/v2024/models/attribute-change +tags: ['SDK', 'Software Development Kit', 'AttributeChange', 'V2024AttributeChange'] +--- + + +# AttributeChange + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | the attribute name | [optional] +**PreviousValue** | Pointer to **String** | the old value of attribute | [optional] +**NewValue** | Pointer to **String** | the new value of attribute | [optional] + +## Examples + +- Prepare the resource +```powershell +$AttributeChange = Initialize-PSSailpoint.V2024AttributeChange -Name null ` + -PreviousValue null ` + -NewValue null +``` + +- Convert the resource to JSON +```powershell +$AttributeChange | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributeDTO.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributeDTO.md new file mode 100644 index 000000000..8da8a7531 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributeDTO.md @@ -0,0 +1,49 @@ +--- +id: v2024-attribute-dto +title: AttributeDTO +pagination_label: AttributeDTO +sidebar_label: AttributeDTO +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDTO', 'V2024AttributeDTO'] +slug: /tools/sdk/powershell/v2024/models/attribute-dto +tags: ['SDK', 'Software Development Kit', 'AttributeDTO', 'V2024AttributeDTO'] +--- + + +# AttributeDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **String** | Technical name of the Attribute. This is unique and cannot be changed after creation. | [optional] +**Name** | Pointer to **String** | The display name of the key. | [optional] +**Multiselect** | Pointer to **Boolean** | Indicates whether the attribute can have multiple values. | [optional] [default to $false] +**Status** | Pointer to **String** | The status of the Attribute. | [optional] +**Type** | Pointer to **String** | The type of the Attribute. This can be either ""custom"" or ""governance"". | [optional] +**ObjectTypes** | Pointer to **[]String** | An array of object types this attributes values can be applied to. Possible values are ""all"" or ""entitlement"". Value ""all"" means this attribute can be used with all object types that are supported. | [optional] +**Description** | Pointer to **String** | The description of the Attribute. | [optional] +**Values** | Pointer to [**[]AttributeValueDTO**](attribute-value-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AttributeDTO = Initialize-PSSailpoint.V2024AttributeDTO -Key iscPrivacy ` + -Name Privacy ` + -Multiselect false ` + -Status active ` + -Type governance ` + -ObjectTypes [entitlement] ` + -Description Specifies the level of privacy associated with an access item. ` + -Values null +``` + +- Convert the resource to JSON +```powershell +$AttributeDTO | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributeDTOList.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributeDTOList.md new file mode 100644 index 000000000..7382dd791 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributeDTOList.md @@ -0,0 +1,35 @@ +--- +id: v2024-attribute-dto-list +title: AttributeDTOList +pagination_label: AttributeDTOList +sidebar_label: AttributeDTOList +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDTOList', 'V2024AttributeDTOList'] +slug: /tools/sdk/powershell/v2024/models/attribute-dto-list +tags: ['SDK', 'Software Development Kit', 'AttributeDTOList', 'V2024AttributeDTOList'] +--- + + +# AttributeDTOList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**[]AttributeDTO**](attribute-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AttributeDTOList = Initialize-PSSailpoint.V2024AttributeDTOList -Attributes [{key=iscPrivacy, name=Privacy, multiselect=false, status=active, type=governance, objectTypes=[all], description=Specifies the level of privacy associated with an access item., values=[{value=public, name=Public, status=active}]}] +``` + +- Convert the resource to JSON +```powershell +$AttributeDTOList | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributeDefinition.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributeDefinition.md new file mode 100644 index 000000000..f4ac39abc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributeDefinition.md @@ -0,0 +1,47 @@ +--- +id: v2024-attribute-definition +title: AttributeDefinition +pagination_label: AttributeDefinition +sidebar_label: AttributeDefinition +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDefinition', 'V2024AttributeDefinition'] +slug: /tools/sdk/powershell/v2024/models/attribute-definition +tags: ['SDK', 'Software Development Kit', 'AttributeDefinition', 'V2024AttributeDefinition'] +--- + + +# AttributeDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the attribute. | [optional] +**Type** | Pointer to [**AttributeDefinitionType**](attribute-definition-type) | | [optional] +**Schema** | Pointer to [**AttributeDefinitionSchema**](attribute-definition-schema) | | [optional] +**Description** | Pointer to **String** | A human-readable description of the attribute. | [optional] +**IsMulti** | Pointer to **Boolean** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to $false] +**IsEntitlement** | Pointer to **Boolean** | Flag indicating whether or not the attribute is an entitlement. | [optional] [default to $false] +**IsGroup** | Pointer to **Boolean** | Flag indicating whether or not the attribute represents a group. This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$AttributeDefinition = Initialize-PSSailpoint.V2024AttributeDefinition -Name sAMAccountName ` + -Type null ` + -Schema null ` + -Description SAM Account Name ` + -IsMulti false ` + -IsEntitlement false ` + -IsGroup false +``` + +- Convert the resource to JSON +```powershell +$AttributeDefinition | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributeDefinitionSchema.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributeDefinitionSchema.md new file mode 100644 index 000000000..a39d8f70f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributeDefinitionSchema.md @@ -0,0 +1,39 @@ +--- +id: v2024-attribute-definition-schema +title: AttributeDefinitionSchema +pagination_label: AttributeDefinitionSchema +sidebar_label: AttributeDefinitionSchema +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDefinitionSchema', 'V2024AttributeDefinitionSchema'] +slug: /tools/sdk/powershell/v2024/models/attribute-definition-schema +tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionSchema', 'V2024AttributeDefinitionSchema'] +--- + + +# AttributeDefinitionSchema + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "CONNECTOR_SCHEMA" ] | The type of object being referenced | [optional] +**Id** | Pointer to **String** | The object ID this reference applies to. | [optional] +**Name** | Pointer to **String** | The human-readable display name of the object. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AttributeDefinitionSchema = Initialize-PSSailpoint.V2024AttributeDefinitionSchema -Type CONNECTOR_SCHEMA ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name group +``` + +- Convert the resource to JSON +```powershell +$AttributeDefinitionSchema | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributeDefinitionType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributeDefinitionType.md new file mode 100644 index 000000000..534e15d0e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributeDefinitionType.md @@ -0,0 +1,28 @@ +--- +id: v2024-attribute-definition-type +title: AttributeDefinitionType +pagination_label: AttributeDefinitionType +sidebar_label: AttributeDefinitionType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDefinitionType', 'V2024AttributeDefinitionType'] +slug: /tools/sdk/powershell/v2024/models/attribute-definition-type +tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionType', 'V2024AttributeDefinitionType'] +--- + + +# AttributeDefinitionType + +## Enum + + +* `STRING` (value: `"STRING"`) + +* `LONG` (value: `"LONG"`) + +* `INT` (value: `"INT"`) + +* `BOOLEAN` (value: `"BOOLEAN"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributeRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributeRequest.md new file mode 100644 index 000000000..7fdbbe1c1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributeRequest.md @@ -0,0 +1,39 @@ +--- +id: v2024-attribute-request +title: AttributeRequest +pagination_label: AttributeRequest +sidebar_label: AttributeRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeRequest', 'V2024AttributeRequest'] +slug: /tools/sdk/powershell/v2024/models/attribute-request +tags: ['SDK', 'Software Development Kit', 'AttributeRequest', 'V2024AttributeRequest'] +--- + + +# AttributeRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Attribute name. | [optional] +**Op** | Pointer to **String** | Operation to perform on attribute. | [optional] +**Value** | Pointer to **String** | Value of attribute. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AttributeRequest = Initialize-PSSailpoint.V2024AttributeRequest -Name groups ` + -Op Add ` + -Value 3203537556531076 +``` + +- Convert the resource to JSON +```powershell +$AttributeRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributeValueDTO.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributeValueDTO.md new file mode 100644 index 000000000..d2713232a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributeValueDTO.md @@ -0,0 +1,39 @@ +--- +id: v2024-attribute-value-dto +title: AttributeValueDTO +pagination_label: AttributeValueDTO +sidebar_label: AttributeValueDTO +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeValueDTO', 'V2024AttributeValueDTO'] +slug: /tools/sdk/powershell/v2024/models/attribute-value-dto +tags: ['SDK', 'Software Development Kit', 'AttributeValueDTO', 'V2024AttributeValueDTO'] +--- + + +# AttributeValueDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **String** | Technical name of the Attribute value. This is unique and cannot be changed after creation. | [optional] +**Name** | Pointer to **String** | The display name of the Attribute value. | [optional] +**Status** | Pointer to **String** | The status of the Attribute value. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AttributeValueDTO = Initialize-PSSailpoint.V2024AttributeValueDTO -Value public ` + -Name Public ` + -Status active +``` + +- Convert the resource to JSON +```powershell +$AttributeValueDTO | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributesChanged.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributesChanged.md new file mode 100644 index 000000000..f53d3c509 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AttributesChanged.md @@ -0,0 +1,41 @@ +--- +id: v2024-attributes-changed +title: AttributesChanged +pagination_label: AttributesChanged +sidebar_label: AttributesChanged +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttributesChanged', 'V2024AttributesChanged'] +slug: /tools/sdk/powershell/v2024/models/attributes-changed +tags: ['SDK', 'Software Development Kit', 'AttributesChanged', 'V2024AttributesChanged'] +--- + + +# AttributesChanged + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Changes** | Pointer to [**[]AttributeChange**](attribute-change) | | [optional] +**EventType** | Pointer to **String** | the event type | [optional] +**IdentityId** | Pointer to **String** | the identity id | [optional] +**Dt** | Pointer to **String** | the date of event | [optional] + +## Examples + +- Prepare the resource +```powershell +$AttributesChanged = Initialize-PSSailpoint.V2024AttributesChanged -Changes null ` + -EventType null ` + -IdentityId null ` + -Dt null +``` + +- Convert the resource to JSON +```powershell +$AttributesChanged | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AuditDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AuditDetails.md new file mode 100644 index 000000000..5f54da739 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AuditDetails.md @@ -0,0 +1,41 @@ +--- +id: v2024-audit-details +title: AuditDetails +pagination_label: AuditDetails +sidebar_label: AuditDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AuditDetails', 'V2024AuditDetails'] +slug: /tools/sdk/powershell/v2024/models/audit-details +tags: ['SDK', 'Software Development Kit', 'AuditDetails', 'V2024AuditDetails'] +--- + + +# AuditDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **System.DateTime** | Initial date and time when the record was created | [optional] +**CreatedBy** | Pointer to [**Identity1**](identity1) | | [optional] +**Modified** | Pointer to **System.DateTime** | Last modified date and time for the record | [optional] +**ModifiedBy** | Pointer to [**Identity1**](identity1) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AuditDetails = Initialize-PSSailpoint.V2024AuditDetails -Created 2022-07-21T11:13:12.345Z ` + -CreatedBy null ` + -Modified 2022-07-21T11:13:12.345Z ` + -ModifiedBy null +``` + +- Convert the resource to JSON +```powershell +$AuditDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AuthProfile.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AuthProfile.md new file mode 100644 index 000000000..606236ee4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AuthProfile.md @@ -0,0 +1,47 @@ +--- +id: v2024-auth-profile +title: AuthProfile +pagination_label: AuthProfile +sidebar_label: AuthProfile +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AuthProfile', 'V2024AuthProfile'] +slug: /tools/sdk/powershell/v2024/models/auth-profile +tags: ['SDK', 'Software Development Kit', 'AuthProfile', 'V2024AuthProfile'] +--- + + +# AuthProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Authentication Profile name. | [optional] +**OffNetwork** | Pointer to **Boolean** | Use it to block access from off network. | [optional] [default to $false] +**UntrustedGeography** | Pointer to **Boolean** | Use it to block access from untrusted geoographies. | [optional] [default to $false] +**ApplicationId** | Pointer to **String** | Application ID. | [optional] +**ApplicationName** | Pointer to **String** | Application name. | [optional] +**Type** | Pointer to **Enum** [ "BLOCK", "MFA", "NON_PTA", "PTA" ] | Type of the Authentication Profile. | [optional] +**StrongAuthLogin** | Pointer to **Boolean** | Use it to enable strong authentication. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$AuthProfile = Initialize-PSSailpoint.V2024AuthProfile -Name EndToEnd-Profile ` + -OffNetwork true ` + -UntrustedGeography true ` + -ApplicationId 2c91808458ae7a4f0158b1bbf8af0628 ` + -ApplicationName EndToEnd-Source ` + -Type PTA ` + -StrongAuthLogin true +``` + +- Convert the resource to JSON +```powershell +$AuthProfile | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AuthProfileSummary.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AuthProfileSummary.md new file mode 100644 index 000000000..038b161cc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AuthProfileSummary.md @@ -0,0 +1,37 @@ +--- +id: v2024-auth-profile-summary +title: AuthProfileSummary +pagination_label: AuthProfileSummary +sidebar_label: AuthProfileSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AuthProfileSummary', 'V2024AuthProfileSummary'] +slug: /tools/sdk/powershell/v2024/models/auth-profile-summary +tags: ['SDK', 'Software Development Kit', 'AuthProfileSummary', 'V2024AuthProfileSummary'] +--- + + +# AuthProfileSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Tenant** | Pointer to **String** | Tenant name. | [optional] +**Id** | Pointer to **String** | Identity ID. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AuthProfileSummary = Initialize-PSSailpoint.V2024AuthProfileSummary -Tenant test-tenant ` + -Id 2c91808458ae7a4f0158b1bbf8af0628 +``` + +- Convert the resource to JSON +```powershell +$AuthProfileSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AuthUser.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AuthUser.md new file mode 100644 index 000000000..96aa8f402 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/AuthUser.md @@ -0,0 +1,67 @@ +--- +id: v2024-auth-user +title: AuthUser +pagination_label: AuthUser +sidebar_label: AuthUser +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AuthUser', 'V2024AuthUser'] +slug: /tools/sdk/powershell/v2024/models/auth-user +tags: ['SDK', 'Software Development Kit', 'AuthUser', 'V2024AuthUser'] +--- + + +# AuthUser + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Tenant** | Pointer to **String** | Tenant name. | [optional] +**Id** | Pointer to **String** | Identity ID. | [optional] +**Uid** | Pointer to **String** | Identity's unique identitifier. | [optional] +**VarProfile** | Pointer to **String** | ID of the auth profile associated with the auth user. | [optional] +**IdentificationNumber** | Pointer to **String** | Auth user's employee number. | [optional] +**Email** | Pointer to **String** | Auth user's email. | [optional] +**Phone** | Pointer to **String** | Auth user's phone number. | [optional] +**WorkPhone** | Pointer to **String** | Auth user's work phone number. | [optional] +**PersonalEmail** | Pointer to **String** | Auth user's personal email. | [optional] +**Firstname** | Pointer to **String** | Auth user's first name. | [optional] +**Lastname** | Pointer to **String** | Auth user's last name. | [optional] +**DisplayName** | Pointer to **String** | Auth user's name in displayed format. | [optional] +**Alias** | Pointer to **String** | Auth user's alias. | [optional] +**LastPasswordChangeDate** | Pointer to **String** | Date of last password change. | [optional] +**LastLoginTimestamp** | Pointer to **Int64** | Timestamp of the last login (long type value). | [optional] +**CurrentLoginTimestamp** | Pointer to **Int64** | Timestamp of the current login (long type value). | [optional] +**Capabilities** | Pointer to **[]String** | Array of the auth user's capabilities. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AuthUser = Initialize-PSSailpoint.V2024AuthUser -Tenant test-tenant ` + -Id 2c91808458ae7a4f0158b1bbf8af0628 ` + -Uid will.smith ` + -VarProfile 2c91808458ae7a4f0158b1bbf8af0756 ` + -IdentificationNumber 19-5588452 ` + -Email william.smith@example.com ` + -Phone 5555555555 ` + -WorkPhone 5555555555 ` + -PersonalEmail william.smith@example.com ` + -Firstname Will ` + -Lastname Smith ` + -DisplayName Will Smith ` + -Alias will.smith ` + -LastPasswordChangeDate 2021-03-08T22:37:33.901Z ` + -LastLoginTimestamp 1656327185832 ` + -CurrentLoginTimestamp 1656327185832 ` + -Capabilities null +``` + +- Convert the resource to JSON +```powershell +$AuthUser | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BackupOptions.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BackupOptions.md new file mode 100644 index 000000000..7b332c4fe --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BackupOptions.md @@ -0,0 +1,37 @@ +--- +id: v2024-backup-options +title: BackupOptions +pagination_label: BackupOptions +sidebar_label: BackupOptions +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BackupOptions', 'V2024BackupOptions'] +slug: /tools/sdk/powershell/v2024/models/backup-options +tags: ['SDK', 'Software Development Kit', 'BackupOptions', 'V2024BackupOptions'] +--- + + +# BackupOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IncludeTypes** | Pointer to **[]String** | Object type names to be included in a Configuration Hub backup command. | [optional] +**ObjectOptions** | Pointer to [**map[string]ObjectExportImportNames**](object-export-import-names) | Additional options targeting specific objects related to each item in the includeTypes field. | [optional] + +## Examples + +- Prepare the resource +```powershell +$BackupOptions = Initialize-PSSailpoint.V2024BackupOptions -IncludeTypes null ` + -ObjectOptions {TRIGGER_SUBSCRIPTION={includedNames=[Trigger Subscription name]}} +``` + +- Convert the resource to JSON +```powershell +$BackupOptions | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BackupResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BackupResponse.md new file mode 100644 index 000000000..973f8e67e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BackupResponse.md @@ -0,0 +1,67 @@ +--- +id: v2024-backup-response +title: BackupResponse +pagination_label: BackupResponse +sidebar_label: BackupResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BackupResponse', 'V2024BackupResponse'] +slug: /tools/sdk/powershell/v2024/models/backup-response +tags: ['SDK', 'Software Development Kit', 'BackupResponse', 'V2024BackupResponse'] +--- + + +# BackupResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | Pointer to **String** | Unique id assigned to this backup. | [optional] +**Status** | Pointer to **Enum** [ "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "CANCELLED", "FAILED" ] | Status of the backup. | [optional] +**Type** | Pointer to **Enum** [ "BACKUP" ] | Type of the job, will always be BACKUP for this type of job. | [optional] +**Tenant** | Pointer to **String** | The name of the tenant performing the upload | [optional] +**RequesterName** | Pointer to **String** | The name of the requester. | [optional] +**FileExists** | Pointer to **Boolean** | Whether or not a file was created and stored for this backup. | [optional] [default to $true] +**Created** | Pointer to **System.DateTime** | The time the job was started. | [optional] +**Modified** | Pointer to **System.DateTime** | The time of the last update to the job. | [optional] +**Completed** | Pointer to **System.DateTime** | The time the job was completed. | [optional] +**Name** | Pointer to **String** | The name assigned to the upload file in the request body. | [optional] +**UserCanDelete** | Pointer to **Boolean** | Whether this backup can be deleted by a regular user. | [optional] [default to $true] +**IsPartial** | Pointer to **Boolean** | Whether this backup contains all supported object types or only some of them. | [optional] [default to $false] +**BackupType** | Pointer to **Enum** [ "UPLOADED", "AUTOMATED", "MANUAL" ] | Denotes how this backup was created. - MANUAL - The backup was created by a user. - AUTOMATED - The backup was created by devops. - AUTOMATED_DRAFT - The backup was created during a draft process. - UPLOADED - The backup was created by uploading an existing configuration file. | [optional] +**Options** | Pointer to [**BackupOptions**](backup-options) | | [optional] +**HydrationStatus** | Pointer to **Enum** [ "HYDRATED", "NOT_HYDRATED" ] | Whether the object details of this backup are ready. | [optional] +**TotalObjectCount** | Pointer to **Int64** | Number of objects contained in this backup. | [optional] +**CloudStorageStatus** | Pointer to **Enum** [ "SYNCED", "NOT_SYNCED", "SYNC_FAILED" ] | Whether this backup has been transferred to a customer storage location. | [optional] + +## Examples + +- Prepare the resource +```powershell +$BackupResponse = Initialize-PSSailpoint.V2024BackupResponse -JobId 3469b87d-48ca-439a-868f-2160001da8c1 ` + -Status COMPLETE ` + -Type BACKUP ` + -Tenant tenant-name ` + -RequesterName Requester Name ` + -FileExists true ` + -Created 2021-05-11T22:23:16Z ` + -Modified 2021-05-11T22:23:16Z ` + -Completed 2021-05-11T22:23:16Z ` + -Name Backup Name ` + -UserCanDelete false ` + -IsPartial false ` + -BackupType MANUAL ` + -Options null ` + -HydrationStatus NOT_HYDRATED ` + -TotalObjectCount 10 ` + -CloudStorageStatus SYNCED +``` + +- Convert the resource to JSON +```powershell +$BackupResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Base64Decode.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Base64Decode.md new file mode 100644 index 000000000..9ea603dd5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Base64Decode.md @@ -0,0 +1,37 @@ +--- +id: v2024-base64-decode +title: Base64Decode +pagination_label: Base64Decode +sidebar_label: Base64Decode +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Base64Decode', 'V2024Base64Decode'] +slug: /tools/sdk/powershell/v2024/models/base64-decode +tags: ['SDK', 'Software Development Kit', 'Base64Decode', 'V2024Base64Decode'] +--- + + +# Base64Decode + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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] + +## Examples + +- Prepare the resource +```powershell +$Base64Decode = Initialize-PSSailpoint.V2024Base64Decode -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Base64Decode | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Base64Encode.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Base64Encode.md new file mode 100644 index 000000000..16451ffc3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Base64Encode.md @@ -0,0 +1,37 @@ +--- +id: v2024-base64-encode +title: Base64Encode +pagination_label: Base64Encode +sidebar_label: Base64Encode +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Base64Encode', 'V2024Base64Encode'] +slug: /tools/sdk/powershell/v2024/models/base64-encode +tags: ['SDK', 'Software Development Kit', 'Base64Encode', 'V2024Base64Encode'] +--- + + +# Base64Encode + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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] + +## Examples + +- Prepare the resource +```powershell +$Base64Encode = Initialize-PSSailpoint.V2024Base64Encode -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Base64Encode | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseAccess.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseAccess.md new file mode 100644 index 000000000..976127ee0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseAccess.md @@ -0,0 +1,53 @@ +--- +id: v2024-base-access +title: BaseAccess +pagination_label: BaseAccess +sidebar_label: BaseAccess +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BaseAccess', 'V2024BaseAccess'] +slug: /tools/sdk/powershell/v2024/models/base-access +tags: ['SDK', 'Software Development Kit', 'BaseAccess', 'V2024BaseAccess'] +--- + + +# BaseAccess + +## Properties + +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] +**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] + +## Examples + +- Prepare the resource +```powershell +$BaseAccess = Initialize-PSSailpoint.V2024BaseAccess -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -Description The admin role ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Synced 2018-06-25T20:22:33.104Z ` + -Enabled true ` + -Requestable true ` + -RequestCommentsRequired false ` + -Owner null +``` + +- Convert the resource to JSON +```powershell +$BaseAccess | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseAccessAllOfOwner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseAccessAllOfOwner.md new file mode 100644 index 000000000..cab61e568 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseAccessAllOfOwner.md @@ -0,0 +1,41 @@ +--- +id: v2024-base-access-all-of-owner +title: BaseAccessAllOfOwner +pagination_label: BaseAccessAllOfOwner +sidebar_label: BaseAccessAllOfOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BaseAccessAllOfOwner', 'V2024BaseAccessAllOfOwner'] +slug: /tools/sdk/powershell/v2024/models/base-access-all-of-owner +tags: ['SDK', 'Software Development Kit', 'BaseAccessAllOfOwner', 'V2024BaseAccessAllOfOwner'] +--- + + +# BaseAccessAllOfOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Owner's DTO type. | [optional] +**Id** | Pointer to **String** | Owner's identity ID. | [optional] +**Name** | Pointer to **String** | Owner's display name. | [optional] +**Email** | Pointer to **String** | Owner's email. | [optional] + +## Examples + +- Prepare the resource +```powershell +$BaseAccessAllOfOwner = Initialize-PSSailpoint.V2024BaseAccessAllOfOwner -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Support ` + -Email cloud-support@sailpoint.com +``` + +- Convert the resource to JSON +```powershell +$BaseAccessAllOfOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseAccessProfile.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseAccessProfile.md new file mode 100644 index 000000000..b30bf033f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseAccessProfile.md @@ -0,0 +1,37 @@ +--- +id: v2024-base-access-profile +title: BaseAccessProfile +pagination_label: BaseAccessProfile +sidebar_label: BaseAccessProfile +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BaseAccessProfile', 'V2024BaseAccessProfile'] +slug: /tools/sdk/powershell/v2024/models/base-access-profile +tags: ['SDK', 'Software Development Kit', 'BaseAccessProfile', 'V2024BaseAccessProfile'] +--- + + +# BaseAccessProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Access profile's unique ID. | [optional] +**Name** | Pointer to **String** | Access profile's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$BaseAccessProfile = Initialize-PSSailpoint.V2024BaseAccessProfile -Id 2c91809c6faade77016fb4f0b63407ae ` + -Name Admin Access +``` + +- Convert the resource to JSON +```powershell +$BaseAccessProfile | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseAccount.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseAccount.md new file mode 100644 index 000000000..bd0d43820 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseAccount.md @@ -0,0 +1,55 @@ +--- +id: v2024-base-account +title: BaseAccount +pagination_label: BaseAccount +sidebar_label: BaseAccount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BaseAccount', 'V2024BaseAccount'] +slug: /tools/sdk/powershell/v2024/models/base-account +tags: ['SDK', 'Software Development Kit', 'BaseAccount', 'V2024BaseAccount'] +--- + + +# BaseAccount + +## Properties + +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] +**AccountId** | Pointer to **String** | Account ID. | [optional] +**Source** | Pointer to [**AccountSource**](account-source) | | [optional] +**Disabled** | Pointer to **Boolean** | Indicates whether the account is disabled. | [optional] [default to $false] +**Locked** | Pointer to **Boolean** | Indicates whether the account is locked. | [optional] [default to $false] +**Privileged** | Pointer to **Boolean** | Indicates whether the account is privileged. | [optional] [default to $false] +**ManuallyCorrelated** | Pointer to **Boolean** | Indicates whether the account has been manually correlated to an identity. | [optional] [default to $false] +**PasswordLastSet** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] +**EntitlementAttributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Map or dictionary of key/value pairs. | [optional] +**Created** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] + +## Examples + +- Prepare the resource +```powershell +$BaseAccount = Initialize-PSSailpoint.V2024BaseAccount -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -AccountId John.Doe ` + -Source null ` + -Disabled false ` + -Locked false ` + -Privileged false ` + -ManuallyCorrelated false ` + -PasswordLastSet 2018-06-25T20:22:28.104Z ` + -EntitlementAttributes {moderator=true, admin=true, trust_level=4} ` + -Created 2018-06-25T20:22:28.104Z +``` + +- Convert the resource to JSON +```powershell +$BaseAccount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseCommonDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseCommonDto.md new file mode 100644 index 000000000..ecc1d5565 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseCommonDto.md @@ -0,0 +1,41 @@ +--- +id: v2024-base-common-dto +title: BaseCommonDto +pagination_label: BaseCommonDto +sidebar_label: BaseCommonDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BaseCommonDto', 'V2024BaseCommonDto'] +slug: /tools/sdk/powershell/v2024/models/base-common-dto +tags: ['SDK', 'Software Development Kit', 'BaseCommonDto', 'V2024BaseCommonDto'] +--- + + +# BaseCommonDto + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$BaseCommonDto = Initialize-PSSailpoint.V2024BaseCommonDto -Id id12345 ` + -Name aName ` + -Created 2015-05-28T14:07:17Z ` + -Modified 2015-05-28T14:07:17Z +``` + +- Convert the resource to JSON +```powershell +$BaseCommonDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseCommonDto1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseCommonDto1.md new file mode 100644 index 000000000..c0e0c088e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseCommonDto1.md @@ -0,0 +1,41 @@ +--- +id: v2024-base-common-dto1 +title: BaseCommonDto1 +pagination_label: BaseCommonDto1 +sidebar_label: BaseCommonDto1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BaseCommonDto1', 'V2024BaseCommonDto1'] +slug: /tools/sdk/powershell/v2024/models/base-common-dto1 +tags: ['SDK', 'Software Development Kit', 'BaseCommonDto1', 'V2024BaseCommonDto1'] +--- + + +# BaseCommonDto1 + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$BaseCommonDto1 = Initialize-PSSailpoint.V2024BaseCommonDto1 -Id id12345 ` + -Name aName ` + -Created 2023-01-03T21:16:22.432Z ` + -Modified 2023-01-03T21:16:22.432Z +``` + +- Convert the resource to JSON +```powershell +$BaseCommonDto1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseDocument.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseDocument.md new file mode 100644 index 000000000..d0ac1be04 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseDocument.md @@ -0,0 +1,39 @@ +--- +id: v2024-base-document +title: BaseDocument +pagination_label: BaseDocument +sidebar_label: BaseDocument +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BaseDocument', 'V2024BaseDocument'] +slug: /tools/sdk/powershell/v2024/models/base-document +tags: ['SDK', 'Software Development Kit', 'BaseDocument', 'V2024BaseDocument'] +--- + + +# BaseDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | [required] +**Name** | **String** | | [required] +**Type** | [**DocumentType**](document-type) | | [required] + +## Examples + +- Prepare the resource +```powershell +$BaseDocument = Initialize-PSSailpoint.V2024BaseDocument -Id 2c91808375d8e80a0175e1f88a575222 ` + -Name john.doe ` + -Type null +``` + +- Convert the resource to JSON +```powershell +$BaseDocument | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseEntitlement.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseEntitlement.md new file mode 100644 index 000000000..a4e843114 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseEntitlement.md @@ -0,0 +1,49 @@ +--- +id: v2024-base-entitlement +title: BaseEntitlement +pagination_label: BaseEntitlement +sidebar_label: BaseEntitlement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BaseEntitlement', 'V2024BaseEntitlement'] +slug: /tools/sdk/powershell/v2024/models/base-entitlement +tags: ['SDK', 'Software Development Kit', 'BaseEntitlement', 'V2024BaseEntitlement'] +--- + + +# BaseEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**HasPermissions** | Pointer to **Boolean** | Indicates whether the entitlement has permissions. | [optional] [default to $false] +**Description** | Pointer to **String** | Entitlement's description. | [optional] +**Attribute** | Pointer to **String** | Entitlement attribute's name. | [optional] +**Value** | Pointer to **String** | Entitlement's value. | [optional] +**Schema** | Pointer to **String** | Entitlement's schema. | [optional] +**Privileged** | Pointer to **Boolean** | Indicates whether the entitlement is privileged. | [optional] [default to $false] +**Id** | Pointer to **String** | Entitlement's ID. | [optional] +**Name** | Pointer to **String** | Entitlement's name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$BaseEntitlement = Initialize-PSSailpoint.V2024BaseEntitlement -HasPermissions false ` + -Description Cloud engineering ` + -Attribute memberOf ` + -Value CN=Cloud Engineering,DC=sailpoint,DC=COM ` + -Schema group ` + -Privileged false ` + -Id 2c918084575812550157589064f33b89 ` + -Name CN=Cloud Engineering,DC=sailpoint,DC=COM +``` + +- Convert the resource to JSON +```powershell +$BaseEntitlement | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseReferenceDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseReferenceDto.md new file mode 100644 index 000000000..f134c3ec7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseReferenceDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-base-reference-dto +title: BaseReferenceDto +pagination_label: BaseReferenceDto +sidebar_label: BaseReferenceDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BaseReferenceDto', 'V2024BaseReferenceDto'] +slug: /tools/sdk/powershell/v2024/models/base-reference-dto +tags: ['SDK', 'Software Development Kit', 'BaseReferenceDto', 'V2024BaseReferenceDto'] +--- + + +# BaseReferenceDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] + +## Examples + +- Prepare the resource +```powershell +$BaseReferenceDto = Initialize-PSSailpoint.V2024BaseReferenceDto -Type null ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$BaseReferenceDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseReferenceDto1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseReferenceDto1.md new file mode 100644 index 000000000..90d35614a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseReferenceDto1.md @@ -0,0 +1,37 @@ +--- +id: v2024-base-reference-dto1 +title: BaseReferenceDto1 +pagination_label: BaseReferenceDto1 +sidebar_label: BaseReferenceDto1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BaseReferenceDto1', 'V2024BaseReferenceDto1'] +slug: /tools/sdk/powershell/v2024/models/base-reference-dto1 +tags: ['SDK', 'Software Development Kit', 'BaseReferenceDto1', 'V2024BaseReferenceDto1'] +--- + + +# BaseReferenceDto1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | the application ID | [optional] +**Name** | Pointer to **String** | the application name | [optional] + +## Examples + +- Prepare the resource +```powershell +$BaseReferenceDto1 = Initialize-PSSailpoint.V2024BaseReferenceDto1 -Id ff8081814d977c21014da056804a0af3 ` + -Name Github +``` + +- Convert the resource to JSON +```powershell +$BaseReferenceDto1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseSegment.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseSegment.md new file mode 100644 index 000000000..d56bb3d27 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BaseSegment.md @@ -0,0 +1,37 @@ +--- +id: v2024-base-segment +title: BaseSegment +pagination_label: BaseSegment +sidebar_label: BaseSegment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BaseSegment', 'V2024BaseSegment'] +slug: /tools/sdk/powershell/v2024/models/base-segment +tags: ['SDK', 'Software Development Kit', 'BaseSegment', 'V2024BaseSegment'] +--- + + +# BaseSegment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Segment's unique ID. | [optional] +**Name** | Pointer to **String** | Segment's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$BaseSegment = Initialize-PSSailpoint.V2024BaseSegment -Id b009b6e3-b56d-41d9-8735-cb532ea0b017 ` + -Name Test Segment +``` + +- Convert the resource to JSON +```powershell +$BaseSegment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BasicAuthConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BasicAuthConfig.md new file mode 100644 index 000000000..fa136fb7d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BasicAuthConfig.md @@ -0,0 +1,37 @@ +--- +id: v2024-basic-auth-config +title: BasicAuthConfig +pagination_label: BasicAuthConfig +sidebar_label: BasicAuthConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BasicAuthConfig', 'V2024BasicAuthConfig'] +slug: /tools/sdk/powershell/v2024/models/basic-auth-config +tags: ['SDK', 'Software Development Kit', 'BasicAuthConfig', 'V2024BasicAuthConfig'] +--- + + +# BasicAuthConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserName** | Pointer to **String** | The username to authenticate. | [optional] +**Password** | Pointer to **String** | The password to authenticate. On response, this field is set to null as to not return secrets. | [optional] + +## Examples + +- Prepare the resource +```powershell +$BasicAuthConfig = Initialize-PSSailpoint.V2024BasicAuthConfig -UserName user@example.com ` + -Password null +``` + +- Convert the resource to JSON +```powershell +$BasicAuthConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BearerTokenAuthConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BearerTokenAuthConfig.md new file mode 100644 index 000000000..880f63588 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BearerTokenAuthConfig.md @@ -0,0 +1,35 @@ +--- +id: v2024-bearer-token-auth-config +title: BearerTokenAuthConfig +pagination_label: BearerTokenAuthConfig +sidebar_label: BearerTokenAuthConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BearerTokenAuthConfig', 'V2024BearerTokenAuthConfig'] +slug: /tools/sdk/powershell/v2024/models/bearer-token-auth-config +tags: ['SDK', 'Software Development Kit', 'BearerTokenAuthConfig', 'V2024BearerTokenAuthConfig'] +--- + + +# BearerTokenAuthConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BearerToken** | Pointer to **String** | Bearer token | [optional] + +## Examples + +- Prepare the resource +```powershell +$BearerTokenAuthConfig = Initialize-PSSailpoint.V2024BearerTokenAuthConfig -BearerToken null +``` + +- Convert the resource to JSON +```powershell +$BearerTokenAuthConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BeforeProvisioningRuleDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BeforeProvisioningRuleDto.md new file mode 100644 index 000000000..6718ac9aa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BeforeProvisioningRuleDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-before-provisioning-rule-dto +title: BeforeProvisioningRuleDto +pagination_label: BeforeProvisioningRuleDto +sidebar_label: BeforeProvisioningRuleDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BeforeProvisioningRuleDto', 'V2024BeforeProvisioningRuleDto'] +slug: /tools/sdk/powershell/v2024/models/before-provisioning-rule-dto +tags: ['SDK', 'Software Development Kit', 'BeforeProvisioningRuleDto', 'V2024BeforeProvisioningRuleDto'] +--- + + +# BeforeProvisioningRuleDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "RULE" ] | Before Provisioning Rule DTO type. | [optional] +**Id** | Pointer to **String** | Before Provisioning Rule ID. | [optional] +**Name** | Pointer to **String** | Rule display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$BeforeProvisioningRuleDto = Initialize-PSSailpoint.V2024BeforeProvisioningRuleDto -Type RULE ` + -Id 048eb3d55c5a4758bd07dccb87741c78 ` + -Name Before Provisioning Airtable Rule +``` + +- Convert the resource to JSON +```powershell +$BeforeProvisioningRuleDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Bound.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Bound.md new file mode 100644 index 000000000..f18ea98af --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Bound.md @@ -0,0 +1,37 @@ +--- +id: v2024-bound +title: Bound +pagination_label: Bound +sidebar_label: Bound +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Bound', 'V2024Bound'] +slug: /tools/sdk/powershell/v2024/models/bound +tags: ['SDK', 'Software Development Kit', 'Bound', 'V2024Bound'] +--- + + +# Bound + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | **String** | The value of the range's endpoint. | [required] +**Inclusive** | Pointer to **Boolean** | Indicates if the endpoint is included in the range. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$Bound = Initialize-PSSailpoint.V2024Bound -Value 1 ` + -Inclusive false +``` + +- Convert the resource to JSON +```powershell +$Bound | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BrandingItem.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BrandingItem.md new file mode 100644 index 000000000..5ca72be98 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BrandingItem.md @@ -0,0 +1,49 @@ +--- +id: v2024-branding-item +title: BrandingItem +pagination_label: BrandingItem +sidebar_label: BrandingItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BrandingItem', 'V2024BrandingItem'] +slug: /tools/sdk/powershell/v2024/models/branding-item +tags: ['SDK', 'Software Development Kit', 'BrandingItem', 'V2024BrandingItem'] +--- + + +# BrandingItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | name of branding item | [optional] +**ProductName** | Pointer to **String** | product name | [optional] +**ActionButtonColor** | Pointer to **String** | hex value of color for action button | [optional] +**ActiveLinkColor** | Pointer to **String** | hex value of color for link | [optional] +**NavigationColor** | Pointer to **String** | hex value of color for navigation bar | [optional] +**EmailFromAddress** | Pointer to **String** | email from address | [optional] +**StandardLogoURL** | Pointer to **String** | url to standard logo | [optional] +**LoginInformationalMessage** | Pointer to **String** | login information message | [optional] + +## Examples + +- Prepare the resource +```powershell +$BrandingItem = Initialize-PSSailpoint.V2024BrandingItem -Name default ` + -ProductName product name ` + -ActionButtonColor 0074D9 ` + -ActiveLinkColor 011E69 ` + -NavigationColor 011E69 ` + -EmailFromAddress no-reply@sailpoint.com ` + -StandardLogoURL ` + -LoginInformationalMessage +``` + +- Convert the resource to JSON +```powershell +$BrandingItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BrandingItemCreate.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BrandingItemCreate.md new file mode 100644 index 000000000..496e6c909 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BrandingItemCreate.md @@ -0,0 +1,49 @@ +--- +id: v2024-branding-item-create +title: BrandingItemCreate +pagination_label: BrandingItemCreate +sidebar_label: BrandingItemCreate +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BrandingItemCreate', 'V2024BrandingItemCreate'] +slug: /tools/sdk/powershell/v2024/models/branding-item-create +tags: ['SDK', 'Software Development Kit', 'BrandingItemCreate', 'V2024BrandingItemCreate'] +--- + + +# BrandingItemCreate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | name of branding item | [required] +**ProductName** | **String** | product name | [required] +**ActionButtonColor** | Pointer to **String** | hex value of color for action button | [optional] +**ActiveLinkColor** | Pointer to **String** | hex value of color for link | [optional] +**NavigationColor** | Pointer to **String** | hex value of color for navigation bar | [optional] +**EmailFromAddress** | Pointer to **String** | email from address | [optional] +**LoginInformationalMessage** | Pointer to **String** | login information message | [optional] +**FileStandard** | Pointer to **System.IO.FileInfo** | png file with logo | [optional] + +## Examples + +- Prepare the resource +```powershell +$BrandingItemCreate = Initialize-PSSailpoint.V2024BrandingItemCreate -Name custom-branding-item ` + -ProductName product name ` + -ActionButtonColor 0074D9 ` + -ActiveLinkColor 011E69 ` + -NavigationColor 011E69 ` + -EmailFromAddress no-reply@sailpoint.com ` + -LoginInformationalMessage ` + -FileStandard \x00\x00\x00\x02 +``` + +- Convert the resource to JSON +```powershell +$BrandingItemCreate | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BucketAggregation.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BucketAggregation.md new file mode 100644 index 000000000..310867941 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BucketAggregation.md @@ -0,0 +1,43 @@ +--- +id: v2024-bucket-aggregation +title: BucketAggregation +pagination_label: BucketAggregation +sidebar_label: BucketAggregation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BucketAggregation', 'V2024BucketAggregation'] +slug: /tools/sdk/powershell/v2024/models/bucket-aggregation +tags: ['SDK', 'Software Development Kit', 'BucketAggregation', 'V2024BucketAggregation'] +--- + + +# BucketAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | The name of the bucket aggregate to be included in the result. | [required] +**Type** | Pointer to [**BucketType**](bucket-type) | | [optional] +**Field** | **String** | The field to bucket on. Prefix the field name with '@' to reference a nested object. | [required] +**Size** | Pointer to **Int32** | Maximum number of buckets to include. | [optional] +**MinDocCount** | Pointer to **Int32** | Minimum number of documents a bucket should have. | [optional] + +## Examples + +- Prepare the resource +```powershell +$BucketAggregation = Initialize-PSSailpoint.V2024BucketAggregation -Name Identity Locations ` + -Type null ` + -Field attributes.city ` + -Size 100 ` + -MinDocCount 2 +``` + +- Convert the resource to JSON +```powershell +$BucketAggregation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BucketType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BucketType.md new file mode 100644 index 000000000..c107d713e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BucketType.md @@ -0,0 +1,22 @@ +--- +id: v2024-bucket-type +title: BucketType +pagination_label: BucketType +sidebar_label: BucketType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BucketType', 'V2024BucketType'] +slug: /tools/sdk/powershell/v2024/models/bucket-type +tags: ['SDK', 'Software Development Kit', 'BucketType', 'V2024BucketType'] +--- + + +# BucketType + +## Enum + + +* `TERMS` (value: `"TERMS"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BulkAddTaggedObject.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BulkAddTaggedObject.md new file mode 100644 index 000000000..e059ce029 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BulkAddTaggedObject.md @@ -0,0 +1,39 @@ +--- +id: v2024-bulk-add-tagged-object +title: BulkAddTaggedObject +pagination_label: BulkAddTaggedObject +sidebar_label: BulkAddTaggedObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BulkAddTaggedObject', 'V2024BulkAddTaggedObject'] +slug: /tools/sdk/powershell/v2024/models/bulk-add-tagged-object +tags: ['SDK', 'Software Development Kit', 'BulkAddTaggedObject', 'V2024BulkAddTaggedObject'] +--- + + +# BulkAddTaggedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectRefs** | Pointer to [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] +**Tags** | Pointer to **[]String** | Label to be applied to an Object | [optional] +**Operation** | Pointer to **Enum** [ "APPEND", "MERGE" ] | If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. | [optional] [default to "APPEND"] + +## Examples + +- Prepare the resource +```powershell +$BulkAddTaggedObject = Initialize-PSSailpoint.V2024BulkAddTaggedObject -ObjectRefs null ` + -Tags [BU_FINANCE, PCI] ` + -Operation MERGE +``` + +- Convert the resource to JSON +```powershell +$BulkAddTaggedObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BulkApproveAccessRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BulkApproveAccessRequest.md new file mode 100644 index 000000000..7019f927b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BulkApproveAccessRequest.md @@ -0,0 +1,37 @@ +--- +id: v2024-bulk-approve-access-request +title: BulkApproveAccessRequest +pagination_label: BulkApproveAccessRequest +sidebar_label: BulkApproveAccessRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BulkApproveAccessRequest', 'V2024BulkApproveAccessRequest'] +slug: /tools/sdk/powershell/v2024/models/bulk-approve-access-request +tags: ['SDK', 'Software Development Kit', 'BulkApproveAccessRequest', 'V2024BulkApproveAccessRequest'] +--- + + +# BulkApproveAccessRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalIds** | **[]String** | List of approval ids to approve the pending requests | [required] +**Comment** | **String** | Reason for approving the pending access request. | [required] + +## Examples + +- Prepare the resource +```powershell +$BulkApproveAccessRequest = Initialize-PSSailpoint.V2024BulkApproveAccessRequest -ApprovalIds [2c9180835d2e5168015d32f890ca1581, 2c9180835d2e5168015d32f890ca1582] ` + -Comment I approve these request items +``` + +- Convert the resource to JSON +```powershell +$BulkApproveAccessRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BulkCancelAccessRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BulkCancelAccessRequest.md new file mode 100644 index 000000000..cedad70ba --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BulkCancelAccessRequest.md @@ -0,0 +1,37 @@ +--- +id: v2024-bulk-cancel-access-request +title: BulkCancelAccessRequest +pagination_label: BulkCancelAccessRequest +sidebar_label: BulkCancelAccessRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BulkCancelAccessRequest', 'V2024BulkCancelAccessRequest'] +slug: /tools/sdk/powershell/v2024/models/bulk-cancel-access-request +tags: ['SDK', 'Software Development Kit', 'BulkCancelAccessRequest', 'V2024BulkCancelAccessRequest'] +--- + + +# BulkCancelAccessRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestIds** | **[]String** | List of access requests ids to cancel the pending requests | [required] +**Comment** | **String** | Reason for cancelling the pending access request. | [required] + +## Examples + +- Prepare the resource +```powershell +$BulkCancelAccessRequest = Initialize-PSSailpoint.V2024BulkCancelAccessRequest -AccessRequestIds [2c9180835d2e5168015d32f890ca1581, 2c9180835d2e5168015d32f890ca1582] ` + -Comment I requested this role by mistake. +``` + +- Convert the resource to JSON +```powershell +$BulkCancelAccessRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BulkIdentitiesAccountsResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BulkIdentitiesAccountsResponse.md new file mode 100644 index 000000000..d8ec0a8bd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BulkIdentitiesAccountsResponse.md @@ -0,0 +1,39 @@ +--- +id: v2024-bulk-identities-accounts-response +title: BulkIdentitiesAccountsResponse +pagination_label: BulkIdentitiesAccountsResponse +sidebar_label: BulkIdentitiesAccountsResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BulkIdentitiesAccountsResponse', 'V2024BulkIdentitiesAccountsResponse'] +slug: /tools/sdk/powershell/v2024/models/bulk-identities-accounts-response +tags: ['SDK', 'Software Development Kit', 'BulkIdentitiesAccountsResponse', 'V2024BulkIdentitiesAccountsResponse'] +--- + + +# BulkIdentitiesAccountsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Identifier of bulk request item. | [optional] +**StatusCode** | Pointer to **Int32** | Response status value. | [optional] +**Message** | Pointer to **String** | Status containing additional context information about failures. | [optional] + +## Examples + +- Prepare the resource +```powershell +$BulkIdentitiesAccountsResponse = Initialize-PSSailpoint.V2024BulkIdentitiesAccountsResponse -Id 2c9180858082150f0180893dbaf553fe ` + -StatusCode 404 ` + -Message Referenced identity "2c9180858082150f0180893dbaf553fe" was not found. +``` + +- Convert the resource to JSON +```powershell +$BulkIdentitiesAccountsResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BulkRemoveTaggedObject.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BulkRemoveTaggedObject.md new file mode 100644 index 000000000..3fcfb7c70 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BulkRemoveTaggedObject.md @@ -0,0 +1,37 @@ +--- +id: v2024-bulk-remove-tagged-object +title: BulkRemoveTaggedObject +pagination_label: BulkRemoveTaggedObject +sidebar_label: BulkRemoveTaggedObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BulkRemoveTaggedObject', 'V2024BulkRemoveTaggedObject'] +slug: /tools/sdk/powershell/v2024/models/bulk-remove-tagged-object +tags: ['SDK', 'Software Development Kit', 'BulkRemoveTaggedObject', 'V2024BulkRemoveTaggedObject'] +--- + + +# BulkRemoveTaggedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectRefs** | Pointer to [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] +**Tags** | Pointer to **[]String** | Label to be applied to an Object | [optional] + +## Examples + +- Prepare the resource +```powershell +$BulkRemoveTaggedObject = Initialize-PSSailpoint.V2024BulkRemoveTaggedObject -ObjectRefs null ` + -Tags [BU_FINANCE, PCI] +``` + +- Convert the resource to JSON +```powershell +$BulkRemoveTaggedObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BulkTaggedObjectResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BulkTaggedObjectResponse.md new file mode 100644 index 000000000..fe7ed0f1e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/BulkTaggedObjectResponse.md @@ -0,0 +1,37 @@ +--- +id: v2024-bulk-tagged-object-response +title: BulkTaggedObjectResponse +pagination_label: BulkTaggedObjectResponse +sidebar_label: BulkTaggedObjectResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BulkTaggedObjectResponse', 'V2024BulkTaggedObjectResponse'] +slug: /tools/sdk/powershell/v2024/models/bulk-tagged-object-response +tags: ['SDK', 'Software Development Kit', 'BulkTaggedObjectResponse', 'V2024BulkTaggedObjectResponse'] +--- + + +# BulkTaggedObjectResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectRefs** | Pointer to [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] +**Tags** | Pointer to **[]String** | Label to be applied to an Object | [optional] + +## Examples + +- Prepare the resource +```powershell +$BulkTaggedObjectResponse = Initialize-PSSailpoint.V2024BulkTaggedObjectResponse -ObjectRefs null ` + -Tags [BU_FINANCE, PCI] +``` + +- Convert the resource to JSON +```powershell +$BulkTaggedObjectResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Campaign.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Campaign.md new file mode 100644 index 000000000..06072f9e2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Campaign.md @@ -0,0 +1,79 @@ +--- +id: v2024-campaign +title: Campaign +pagination_label: Campaign +sidebar_label: Campaign +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Campaign', 'V2024Campaign'] +slug: /tools/sdk/powershell/v2024/models/campaign +tags: ['SDK', 'Software Development Kit', 'Campaign', 'V2024Campaign'] +--- + + +# Campaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the campaign | [optional] [readonly] +**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Deadline** | Pointer to **System.DateTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required] +**EmailNotificationEnabled** | Pointer to **Boolean** | Enables email notification for this campaign | [optional] [default to $false] +**AutoRevokeAllowed** | Pointer to **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] +**RecommendationsEnabled** | Pointer to **Boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to $false] +**Status** | Pointer to **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **System.DateTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **Int32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | Modified time of the campaign | [optional] [readonly] +**VarFilter** | Pointer to [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | Pointer to **Boolean** | Determines if comments on sunset date changes are required. | [optional] [default to $true] +**SourceOwnerCampaignInfo** | Pointer to [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | Pointer to [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | Pointer to [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | Pointer to [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | Pointer to [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \""orphan entitlements\"" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**MandatoryCommentRequirement** | Pointer to **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Campaign = Initialize-PSSailpoint.V2024Campaign -Id 2c9079b270a266a60170a2779fcb0007 ` + -Name Manager Campaign ` + -Description Everyone needs to be reviewed by their manager ` + -Deadline 2020-03-15T10:00:01.456Z ` + -Type MANAGER ` + -EmailNotificationEnabled false ` + -AutoRevokeAllowed false ` + -RecommendationsEnabled true ` + -Status ACTIVE ` + -CorrelatedStatus CORRELATED ` + -Created 2020-03-03T22:15:13.611Z ` + -TotalCertifications 100 ` + -CompletedCertifications 10 ` + -Alerts null ` + -Modified 2020-03-03T22:20:12.674Z ` + -VarFilter null ` + -SunsetCommentsRequired true ` + -SourceOwnerCampaignInfo null ` + -SearchCampaignInfo null ` + -RoleCompositionCampaignInfo null ` + -MachineAccountCampaignInfo null ` + -SourcesWithOrphanEntitlements null ` + -MandatoryCommentRequirement NO_DECISIONS +``` + +- Convert the resource to JSON +```powershell +$Campaign | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignActivated.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignActivated.md new file mode 100644 index 000000000..4ec9b792e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignActivated.md @@ -0,0 +1,35 @@ +--- +id: v2024-campaign-activated +title: CampaignActivated +pagination_label: CampaignActivated +sidebar_label: CampaignActivated +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignActivated', 'V2024CampaignActivated'] +slug: /tools/sdk/powershell/v2024/models/campaign-activated +tags: ['SDK', 'Software Development Kit', 'CampaignActivated', 'V2024CampaignActivated'] +--- + + +# CampaignActivated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Campaign** | [**CampaignActivatedCampaign**](campaign-activated-campaign) | | [required] + +## Examples + +- Prepare the resource +```powershell +$CampaignActivated = Initialize-PSSailpoint.V2024CampaignActivated -Campaign null +``` + +- Convert the resource to JSON +```powershell +$CampaignActivated | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignActivatedCampaign.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignActivatedCampaign.md new file mode 100644 index 000000000..5a92f604e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignActivatedCampaign.md @@ -0,0 +1,51 @@ +--- +id: v2024-campaign-activated-campaign +title: CampaignActivatedCampaign +pagination_label: CampaignActivatedCampaign +sidebar_label: CampaignActivatedCampaign +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignActivatedCampaign', 'V2024CampaignActivatedCampaign'] +slug: /tools/sdk/powershell/v2024/models/campaign-activated-campaign +tags: ['SDK', 'Software Development Kit', 'CampaignActivatedCampaign', 'V2024CampaignActivatedCampaign'] +--- + + +# CampaignActivatedCampaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Unique ID for the campaign. | [required] +**Name** | **String** | The human friendly name of the campaign. | [required] +**Description** | **String** | Extended description of the campaign. | [required] +**Created** | **System.DateTime** | The date and time the campaign was created. | [required] +**Modified** | Pointer to **System.DateTime** | The date and time the campaign was last modified. | [optional] +**Deadline** | **System.DateTime** | The date and time the campaign is due. | [required] +**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION" ] | The type of campaign. | [required] +**CampaignOwner** | [**CampaignActivatedCampaignCampaignOwner**](campaign-activated-campaign-campaign-owner) | | [required] +**Status** | **Enum** [ "ACTIVE" ] | The current status of the campaign. | [required] + +## Examples + +- Prepare the resource +```powershell +$CampaignActivatedCampaign = Initialize-PSSailpoint.V2024CampaignActivatedCampaign -Id 2c91808576f886190176f88cac5a0010 ` + -Name Manager Access Campaign ` + -Description Audit access for all employees. ` + -Created 2021-02-16T03:04:45.815Z ` + -Modified 2021-02-16T03:06:45.815Z ` + -Deadline 2021-03-16T03:04:45.815Z ` + -Type MANAGER ` + -CampaignOwner null ` + -Status ACTIVE +``` + +- Convert the resource to JSON +```powershell +$CampaignActivatedCampaign | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignActivatedCampaignCampaignOwner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignActivatedCampaignCampaignOwner.md new file mode 100644 index 000000000..f93f64b45 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignActivatedCampaignCampaignOwner.md @@ -0,0 +1,39 @@ +--- +id: v2024-campaign-activated-campaign-campaign-owner +title: CampaignActivatedCampaignCampaignOwner +pagination_label: CampaignActivatedCampaignCampaignOwner +sidebar_label: CampaignActivatedCampaignCampaignOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignActivatedCampaignCampaignOwner', 'V2024CampaignActivatedCampaignCampaignOwner'] +slug: /tools/sdk/powershell/v2024/models/campaign-activated-campaign-campaign-owner +tags: ['SDK', 'Software Development Kit', 'CampaignActivatedCampaignCampaignOwner', 'V2024CampaignActivatedCampaignCampaignOwner'] +--- + + +# CampaignActivatedCampaignCampaignOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the identity. | [required] +**DisplayName** | **String** | The human friendly name of the identity. | [required] +**Email** | **String** | The primary email address of the identity. | [required] + +## Examples + +- Prepare the resource +```powershell +$CampaignActivatedCampaignCampaignOwner = Initialize-PSSailpoint.V2024CampaignActivatedCampaignCampaignOwner -Id 37f080867702c1910177031320c40n27 ` + -DisplayName John Snow ` + -Email john.snow@example.com +``` + +- Convert the resource to JSON +```powershell +$CampaignActivatedCampaignCampaignOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAlert.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAlert.md new file mode 100644 index 000000000..052b31ea1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAlert.md @@ -0,0 +1,37 @@ +--- +id: v2024-campaign-alert +title: CampaignAlert +pagination_label: CampaignAlert +sidebar_label: CampaignAlert +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAlert', 'V2024CampaignAlert'] +slug: /tools/sdk/powershell/v2024/models/campaign-alert +tags: ['SDK', 'Software Development Kit', 'CampaignAlert', 'V2024CampaignAlert'] +--- + + +# CampaignAlert + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Level** | Pointer to **Enum** [ "ERROR", "WARN", "INFO" ] | Denotes the level of the message | [optional] +**Localizations** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignAlert = Initialize-PSSailpoint.V2024CampaignAlert -Level ERROR ` + -Localizations null +``` + +- Convert the resource to JSON +```powershell +$CampaignAlert | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAllOfFilter.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAllOfFilter.md new file mode 100644 index 000000000..4f83b8fb6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAllOfFilter.md @@ -0,0 +1,39 @@ +--- +id: v2024-campaign-all-of-filter +title: CampaignAllOfFilter +pagination_label: CampaignAllOfFilter +sidebar_label: CampaignAllOfFilter +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAllOfFilter', 'V2024CampaignAllOfFilter'] +slug: /tools/sdk/powershell/v2024/models/campaign-all-of-filter +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfFilter', 'V2024CampaignAllOfFilter'] +--- + + +# CampaignAllOfFilter + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of whatever type of filter is being used. | [optional] +**Type** | Pointer to **Enum** [ "CAMPAIGN_FILTER", "RULE" ] | Type of the filter | [optional] +**Name** | Pointer to **String** | Name of the filter | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignAllOfFilter = Initialize-PSSailpoint.V2024CampaignAllOfFilter -Id 0fbe863c063c4c88a35fd7f17e8a3df5 ` + -Type CAMPAIGN_FILTER ` + -Name Test Filter +``` + +- Convert the resource to JSON +```powershell +$CampaignAllOfFilter | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAllOfMachineAccountCampaignInfo.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAllOfMachineAccountCampaignInfo.md new file mode 100644 index 000000000..3a0437c5c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAllOfMachineAccountCampaignInfo.md @@ -0,0 +1,37 @@ +--- +id: v2024-campaign-all-of-machine-account-campaign-info +title: CampaignAllOfMachineAccountCampaignInfo +pagination_label: CampaignAllOfMachineAccountCampaignInfo +sidebar_label: CampaignAllOfMachineAccountCampaignInfo +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAllOfMachineAccountCampaignInfo', 'V2024CampaignAllOfMachineAccountCampaignInfo'] +slug: /tools/sdk/powershell/v2024/models/campaign-all-of-machine-account-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfMachineAccountCampaignInfo', 'V2024CampaignAllOfMachineAccountCampaignInfo'] +--- + + +# CampaignAllOfMachineAccountCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceIds** | Pointer to **[]String** | The list of sources to be included in the campaign. | [optional] +**ReviewerType** | Pointer to **Enum** [ "ACCOUNT_OWNER" ] | The reviewer's type. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignAllOfMachineAccountCampaignInfo = Initialize-PSSailpoint.V2024CampaignAllOfMachineAccountCampaignInfo -SourceIds [0fbe863c063c4c88a35fd7f17e8a3df5] ` + -ReviewerType ACCOUNT_OWNER +``` + +- Convert the resource to JSON +```powershell +$CampaignAllOfMachineAccountCampaignInfo | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAllOfRoleCompositionCampaignInfo.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAllOfRoleCompositionCampaignInfo.md new file mode 100644 index 000000000..72d06d557 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAllOfRoleCompositionCampaignInfo.md @@ -0,0 +1,43 @@ +--- +id: v2024-campaign-all-of-role-composition-campaign-info +title: CampaignAllOfRoleCompositionCampaignInfo +pagination_label: CampaignAllOfRoleCompositionCampaignInfo +sidebar_label: CampaignAllOfRoleCompositionCampaignInfo +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAllOfRoleCompositionCampaignInfo', 'V2024CampaignAllOfRoleCompositionCampaignInfo'] +slug: /tools/sdk/powershell/v2024/models/campaign-all-of-role-composition-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfRoleCompositionCampaignInfo', 'V2024CampaignAllOfRoleCompositionCampaignInfo'] +--- + + +# CampaignAllOfRoleCompositionCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Reviewer** | Pointer to [**CampaignAllOfSearchCampaignInfoReviewer**](campaign-all-of-search-campaign-info-reviewer) | | [optional] +**RoleIds** | Pointer to **[]String** | Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. | [optional] +**RemediatorRef** | [**CampaignAllOfRoleCompositionCampaignInfoRemediatorRef**](campaign-all-of-role-composition-campaign-info-remediator-ref) | | [required] +**Query** | Pointer to **String** | Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. | [optional] +**Description** | Pointer to **String** | Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignAllOfRoleCompositionCampaignInfo = Initialize-PSSailpoint.V2024CampaignAllOfRoleCompositionCampaignInfo -Reviewer null ` + -RoleIds [2c90ad2a70ace7d50170acf22ca90010] ` + -RemediatorRef null ` + -Query Search Query ` + -Description Role Composition Description +``` + +- Convert the resource to JSON +```powershell +$CampaignAllOfRoleCompositionCampaignInfo | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md new file mode 100644 index 000000000..0c89b8fb4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md @@ -0,0 +1,39 @@ +--- +id: v2024-campaign-all-of-role-composition-campaign-info-remediator-ref +title: CampaignAllOfRoleCompositionCampaignInfoRemediatorRef +pagination_label: CampaignAllOfRoleCompositionCampaignInfoRemediatorRef +sidebar_label: CampaignAllOfRoleCompositionCampaignInfoRemediatorRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAllOfRoleCompositionCampaignInfoRemediatorRef', 'V2024CampaignAllOfRoleCompositionCampaignInfoRemediatorRef'] +slug: /tools/sdk/powershell/v2024/models/campaign-all-of-role-composition-campaign-info-remediator-ref +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfRoleCompositionCampaignInfoRemediatorRef', 'V2024CampaignAllOfRoleCompositionCampaignInfoRemediatorRef'] +--- + + +# CampaignAllOfRoleCompositionCampaignInfoRemediatorRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | Legal Remediator Type | [required] +**Id** | **String** | The ID of the remediator. | [required] +**Name** | Pointer to **String** | The name of the remediator. | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$CampaignAllOfRoleCompositionCampaignInfoRemediatorRef = Initialize-PSSailpoint.V2024CampaignAllOfRoleCompositionCampaignInfoRemediatorRef -Type IDENTITY ` + -Id 2c90ad2a70ace7d50170acf22ca90010 ` + -Name Role Admin +``` + +- Convert the resource to JSON +```powershell +$CampaignAllOfRoleCompositionCampaignInfoRemediatorRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAllOfSearchCampaignInfo.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAllOfSearchCampaignInfo.md new file mode 100644 index 000000000..1ac319361 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAllOfSearchCampaignInfo.md @@ -0,0 +1,45 @@ +--- +id: v2024-campaign-all-of-search-campaign-info +title: CampaignAllOfSearchCampaignInfo +pagination_label: CampaignAllOfSearchCampaignInfo +sidebar_label: CampaignAllOfSearchCampaignInfo +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAllOfSearchCampaignInfo', 'V2024CampaignAllOfSearchCampaignInfo'] +slug: /tools/sdk/powershell/v2024/models/campaign-all-of-search-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSearchCampaignInfo', 'V2024CampaignAllOfSearchCampaignInfo'] +--- + + +# CampaignAllOfSearchCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY", "ACCESS" ] | The type of search campaign represented. | [required] +**Description** | Pointer to **String** | Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available. | [optional] +**Reviewer** | Pointer to [**CampaignAllOfSearchCampaignInfoReviewer**](campaign-all-of-search-campaign-info-reviewer) | | [optional] +**Query** | Pointer to **String** | The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set. | [optional] +**IdentityIds** | Pointer to **[]String** | A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set. | [optional] +**AccessConstraints** | Pointer to [**[]AccessConstraint**](access-constraint) | Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignAllOfSearchCampaignInfo = Initialize-PSSailpoint.V2024CampaignAllOfSearchCampaignInfo -Type ACCESS ` + -Description Search Campaign description ` + -Reviewer null ` + -Query Search Campaign query description ` + -IdentityIds [0fbe863c063c4c88a35fd7f17e8a3df5] ` + -AccessConstraints null +``` + +- Convert the resource to JSON +```powershell +$CampaignAllOfSearchCampaignInfo | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAllOfSearchCampaignInfoReviewer.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAllOfSearchCampaignInfoReviewer.md new file mode 100644 index 000000000..0b4df84bb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAllOfSearchCampaignInfoReviewer.md @@ -0,0 +1,39 @@ +--- +id: v2024-campaign-all-of-search-campaign-info-reviewer +title: CampaignAllOfSearchCampaignInfoReviewer +pagination_label: CampaignAllOfSearchCampaignInfoReviewer +sidebar_label: CampaignAllOfSearchCampaignInfoReviewer +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAllOfSearchCampaignInfoReviewer', 'V2024CampaignAllOfSearchCampaignInfoReviewer'] +slug: /tools/sdk/powershell/v2024/models/campaign-all-of-search-campaign-info-reviewer +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSearchCampaignInfoReviewer', 'V2024CampaignAllOfSearchCampaignInfoReviewer'] +--- + + +# CampaignAllOfSearchCampaignInfoReviewer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP", "IDENTITY" ] | The reviewer's DTO type. | [optional] +**Id** | Pointer to **String** | The reviewer's ID. | [optional] +**Name** | Pointer to **String** | The reviewer's name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignAllOfSearchCampaignInfoReviewer = Initialize-PSSailpoint.V2024CampaignAllOfSearchCampaignInfoReviewer -Type IDENTITY ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$CampaignAllOfSearchCampaignInfoReviewer | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAllOfSourceOwnerCampaignInfo.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAllOfSourceOwnerCampaignInfo.md new file mode 100644 index 000000000..1751353e7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAllOfSourceOwnerCampaignInfo.md @@ -0,0 +1,35 @@ +--- +id: v2024-campaign-all-of-source-owner-campaign-info +title: CampaignAllOfSourceOwnerCampaignInfo +pagination_label: CampaignAllOfSourceOwnerCampaignInfo +sidebar_label: CampaignAllOfSourceOwnerCampaignInfo +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAllOfSourceOwnerCampaignInfo', 'V2024CampaignAllOfSourceOwnerCampaignInfo'] +slug: /tools/sdk/powershell/v2024/models/campaign-all-of-source-owner-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSourceOwnerCampaignInfo', 'V2024CampaignAllOfSourceOwnerCampaignInfo'] +--- + + +# CampaignAllOfSourceOwnerCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceIds** | Pointer to **[]String** | The list of sources to be included in the campaign. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignAllOfSourceOwnerCampaignInfo = Initialize-PSSailpoint.V2024CampaignAllOfSourceOwnerCampaignInfo -SourceIds [0fbe863c063c4c88a35fd7f17e8a3df5] +``` + +- Convert the resource to JSON +```powershell +$CampaignAllOfSourceOwnerCampaignInfo | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAllOfSourcesWithOrphanEntitlements.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAllOfSourcesWithOrphanEntitlements.md new file mode 100644 index 000000000..55ed85c72 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignAllOfSourcesWithOrphanEntitlements.md @@ -0,0 +1,39 @@ +--- +id: v2024-campaign-all-of-sources-with-orphan-entitlements +title: CampaignAllOfSourcesWithOrphanEntitlements +pagination_label: CampaignAllOfSourcesWithOrphanEntitlements +sidebar_label: CampaignAllOfSourcesWithOrphanEntitlements +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAllOfSourcesWithOrphanEntitlements', 'V2024CampaignAllOfSourcesWithOrphanEntitlements'] +slug: /tools/sdk/powershell/v2024/models/campaign-all-of-sources-with-orphan-entitlements +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSourcesWithOrphanEntitlements', 'V2024CampaignAllOfSourcesWithOrphanEntitlements'] +--- + + +# CampaignAllOfSourcesWithOrphanEntitlements + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the source | [optional] +**Type** | Pointer to **Enum** [ "SOURCE" ] | Type | [optional] +**Name** | Pointer to **String** | Name of the source | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignAllOfSourcesWithOrphanEntitlements = Initialize-PSSailpoint.V2024CampaignAllOfSourcesWithOrphanEntitlements -Id 2c90ad2a70ace7d50170acf22ca90010 ` + -Type SOURCE ` + -Name Source with orphan entitlements +``` + +- Convert the resource to JSON +```powershell +$CampaignAllOfSourcesWithOrphanEntitlements | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignCompleteOptions.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignCompleteOptions.md new file mode 100644 index 000000000..0ed07107c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignCompleteOptions.md @@ -0,0 +1,35 @@ +--- +id: v2024-campaign-complete-options +title: CampaignCompleteOptions +pagination_label: CampaignCompleteOptions +sidebar_label: CampaignCompleteOptions +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignCompleteOptions', 'V2024CampaignCompleteOptions'] +slug: /tools/sdk/powershell/v2024/models/campaign-complete-options +tags: ['SDK', 'Software Development Kit', 'CampaignCompleteOptions', 'V2024CampaignCompleteOptions'] +--- + + +# CampaignCompleteOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AutoCompleteAction** | Pointer to **Enum** [ "APPROVE", "REVOKE" ] | Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion. | [optional] [default to "APPROVE"] + +## Examples + +- Prepare the resource +```powershell +$CampaignCompleteOptions = Initialize-PSSailpoint.V2024CampaignCompleteOptions -AutoCompleteAction REVOKE +``` + +- Convert the resource to JSON +```powershell +$CampaignCompleteOptions | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignEnded.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignEnded.md new file mode 100644 index 000000000..5eeba8225 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignEnded.md @@ -0,0 +1,35 @@ +--- +id: v2024-campaign-ended +title: CampaignEnded +pagination_label: CampaignEnded +sidebar_label: CampaignEnded +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignEnded', 'V2024CampaignEnded'] +slug: /tools/sdk/powershell/v2024/models/campaign-ended +tags: ['SDK', 'Software Development Kit', 'CampaignEnded', 'V2024CampaignEnded'] +--- + + +# CampaignEnded + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Campaign** | [**CampaignEndedCampaign**](campaign-ended-campaign) | | [required] + +## Examples + +- Prepare the resource +```powershell +$CampaignEnded = Initialize-PSSailpoint.V2024CampaignEnded -Campaign null +``` + +- Convert the resource to JSON +```powershell +$CampaignEnded | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignEndedCampaign.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignEndedCampaign.md new file mode 100644 index 000000000..189d5300f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignEndedCampaign.md @@ -0,0 +1,51 @@ +--- +id: v2024-campaign-ended-campaign +title: CampaignEndedCampaign +pagination_label: CampaignEndedCampaign +sidebar_label: CampaignEndedCampaign +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignEndedCampaign', 'V2024CampaignEndedCampaign'] +slug: /tools/sdk/powershell/v2024/models/campaign-ended-campaign +tags: ['SDK', 'Software Development Kit', 'CampaignEndedCampaign', 'V2024CampaignEndedCampaign'] +--- + + +# CampaignEndedCampaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Unique ID for the campaign. | [required] +**Name** | **String** | The human friendly name of the campaign. | [required] +**Description** | **String** | Extended description of the campaign. | [required] +**Created** | **System.DateTime** | The date and time the campaign was created. | [required] +**Modified** | Pointer to **System.DateTime** | The date and time the campaign was last modified. | [optional] +**Deadline** | **System.DateTime** | The date and time the campaign is due. | [required] +**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION" ] | The type of campaign. | [required] +**CampaignOwner** | [**CampaignActivatedCampaignCampaignOwner**](campaign-activated-campaign-campaign-owner) | | [required] +**Status** | **Enum** [ "COMPLETED" ] | The current status of the campaign. | [required] + +## Examples + +- Prepare the resource +```powershell +$CampaignEndedCampaign = Initialize-PSSailpoint.V2024CampaignEndedCampaign -Id 2c91808576f886190176f88cac5a0010 ` + -Name Manager Access Campaign ` + -Description Audit access for all employees. ` + -Created 2021-02-16T03:04:45.815Z ` + -Modified 2021-03-16T03:06:45.815Z ` + -Deadline 2021-03-16T03:04:45.815Z ` + -Type MANAGER ` + -CampaignOwner null ` + -Status COMPLETED +``` + +- Convert the resource to JSON +```powershell +$CampaignEndedCampaign | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignFilterDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignFilterDetails.md new file mode 100644 index 000000000..d1fb08924 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignFilterDetails.md @@ -0,0 +1,47 @@ +--- +id: v2024-campaign-filter-details +title: CampaignFilterDetails +pagination_label: CampaignFilterDetails +sidebar_label: CampaignFilterDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignFilterDetails', 'V2024CampaignFilterDetails'] +slug: /tools/sdk/powershell/v2024/models/campaign-filter-details +tags: ['SDK', 'Software Development Kit', 'CampaignFilterDetails', 'V2024CampaignFilterDetails'] +--- + + +# CampaignFilterDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the campaign filter | [required] +**Name** | **String** | Campaign filter name. | [required] +**Description** | Pointer to **String** | Campaign filter description. | [optional] +**Owner** | **String** | Owner of the filter. This field automatically populates at creation time with the current user. | [required] +**Mode** | **Enum** [ "INCLUSION", "EXCLUSION" ] | Mode/type of filter, either the INCLUSION or EXCLUSION type. The INCLUSION type includes the data in generated campaigns as per specified in the criteria, whereas the EXCLUSION type excludes the data in generated campaigns as per specified in criteria. | [required] +**CriteriaList** | Pointer to [**[]CampaignFilterDetailsCriteriaListInner**](campaign-filter-details-criteria-list-inner) | List of criteria. | [optional] +**IsSystemFilter** | **Boolean** | If true, the filter is created by the system. If false, the filter is created by a user. | [required][default to $false] + +## Examples + +- Prepare the resource +```powershell +$CampaignFilterDetails = Initialize-PSSailpoint.V2024CampaignFilterDetails -Id 5ec18cef39020d6fd7a60ad3970aba61 ` + -Name Identity Attribute Campaign Filter ` + -Description Campaign filter to certify data based on an identity attribute's specified property. ` + -Owner SailPoint Support ` + -Mode INCLUSION ` + -CriteriaList [{type=IDENTITY_ATTRIBUTE, property=displayName, value=support, operation=CONTAINS, negateResult=false, shortCircuit=false, recordChildMatches=false, id=null, suppressMatchedItems=false, children=null}] ` + -IsSystemFilter false +``` + +- Convert the resource to JSON +```powershell +$CampaignFilterDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignFilterDetailsCriteriaListInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignFilterDetailsCriteriaListInner.md new file mode 100644 index 000000000..60f652ab6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignFilterDetailsCriteriaListInner.md @@ -0,0 +1,41 @@ +--- +id: v2024-campaign-filter-details-criteria-list-inner +title: CampaignFilterDetailsCriteriaListInner +pagination_label: CampaignFilterDetailsCriteriaListInner +sidebar_label: CampaignFilterDetailsCriteriaListInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignFilterDetailsCriteriaListInner', 'V2024CampaignFilterDetailsCriteriaListInner'] +slug: /tools/sdk/powershell/v2024/models/campaign-filter-details-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'CampaignFilterDetailsCriteriaListInner', 'V2024CampaignFilterDetailsCriteriaListInner'] +--- + + +# CampaignFilterDetailsCriteriaListInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**CriteriaType**](criteria-type) | | [required] +**Operation** | [**Operation**](operation) | | [required] +**Property** | **String** | Specified key from the type of criteria. | [required] +**Value** | **String** | Value for the specified key from the type of criteria. | [required] + +## Examples + +- Prepare the resource +```powershell +$CampaignFilterDetailsCriteriaListInner = Initialize-PSSailpoint.V2024CampaignFilterDetailsCriteriaListInner -Type null ` + -Operation null ` + -Property displayName ` + -Value Allie +``` + +- Convert the resource to JSON +```powershell +$CampaignFilterDetailsCriteriaListInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignGenerated.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignGenerated.md new file mode 100644 index 000000000..6e356a4b5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignGenerated.md @@ -0,0 +1,35 @@ +--- +id: v2024-campaign-generated +title: CampaignGenerated +pagination_label: CampaignGenerated +sidebar_label: CampaignGenerated +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignGenerated', 'V2024CampaignGenerated'] +slug: /tools/sdk/powershell/v2024/models/campaign-generated +tags: ['SDK', 'Software Development Kit', 'CampaignGenerated', 'V2024CampaignGenerated'] +--- + + +# CampaignGenerated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Campaign** | [**CampaignGeneratedCampaign**](campaign-generated-campaign) | | [required] + +## Examples + +- Prepare the resource +```powershell +$CampaignGenerated = Initialize-PSSailpoint.V2024CampaignGenerated -Campaign null +``` + +- Convert the resource to JSON +```powershell +$CampaignGenerated | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignGeneratedCampaign.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignGeneratedCampaign.md new file mode 100644 index 000000000..f09844be1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignGeneratedCampaign.md @@ -0,0 +1,51 @@ +--- +id: v2024-campaign-generated-campaign +title: CampaignGeneratedCampaign +pagination_label: CampaignGeneratedCampaign +sidebar_label: CampaignGeneratedCampaign +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignGeneratedCampaign', 'V2024CampaignGeneratedCampaign'] +slug: /tools/sdk/powershell/v2024/models/campaign-generated-campaign +tags: ['SDK', 'Software Development Kit', 'CampaignGeneratedCampaign', 'V2024CampaignGeneratedCampaign'] +--- + + +# CampaignGeneratedCampaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the campaign. | [required] +**Name** | **String** | Human friendly name of the campaign. | [required] +**Description** | **String** | Extended description of the campaign. | [required] +**Created** | **System.DateTime** | The date and time the campaign was created. | [required] +**Modified** | Pointer to **String** | The date and time the campaign was last modified. | [optional] +**Deadline** | Pointer to **String** | The date and time when the campaign must be finished by. | [optional] +**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION" ] | The type of campaign that was generated. | [required] +**CampaignOwner** | [**CampaignGeneratedCampaignCampaignOwner**](campaign-generated-campaign-campaign-owner) | | [required] +**Status** | **Enum** [ "STAGED", "ACTIVATING", "ACTIVE" ] | The current status of the campaign. | [required] + +## Examples + +- Prepare the resource +```powershell +$CampaignGeneratedCampaign = Initialize-PSSailpoint.V2024CampaignGeneratedCampaign -Id 2c91808576f886190176f88cac5a0010 ` + -Name Manager Access Campaign ` + -Description Audit access for all employees. ` + -Created 2021-02-16T03:04:45.815Z ` + -Modified 2021-02-17T03:04:45.815Z ` + -Deadline 2021-02-18T03:04:45.815Z ` + -Type MANAGER ` + -CampaignOwner null ` + -Status STAGED +``` + +- Convert the resource to JSON +```powershell +$CampaignGeneratedCampaign | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignGeneratedCampaignCampaignOwner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignGeneratedCampaignCampaignOwner.md new file mode 100644 index 000000000..7087f30d2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignGeneratedCampaignCampaignOwner.md @@ -0,0 +1,39 @@ +--- +id: v2024-campaign-generated-campaign-campaign-owner +title: CampaignGeneratedCampaignCampaignOwner +pagination_label: CampaignGeneratedCampaignCampaignOwner +sidebar_label: CampaignGeneratedCampaignCampaignOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignGeneratedCampaignCampaignOwner', 'V2024CampaignGeneratedCampaignCampaignOwner'] +slug: /tools/sdk/powershell/v2024/models/campaign-generated-campaign-campaign-owner +tags: ['SDK', 'Software Development Kit', 'CampaignGeneratedCampaignCampaignOwner', 'V2024CampaignGeneratedCampaignCampaignOwner'] +--- + + +# CampaignGeneratedCampaignCampaignOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the identity. | [required] +**DisplayName** | **String** | The display name of the identity. | [required] +**Email** | **String** | The primary email address of the identity. | [required] + +## Examples + +- Prepare the resource +```powershell +$CampaignGeneratedCampaignCampaignOwner = Initialize-PSSailpoint.V2024CampaignGeneratedCampaignCampaignOwner -Id 37f080867702c1910177031320c40n27 ` + -DisplayName John Snow ` + -Email john.snow@example.com +``` + +- Convert the resource to JSON +```powershell +$CampaignGeneratedCampaignCampaignOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignReference.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignReference.md new file mode 100644 index 000000000..50ee07b3d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignReference.md @@ -0,0 +1,47 @@ +--- +id: v2024-campaign-reference +title: CampaignReference +pagination_label: CampaignReference +sidebar_label: CampaignReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignReference', 'V2024CampaignReference'] +slug: /tools/sdk/powershell/v2024/models/campaign-reference +tags: ['SDK', 'Software Development Kit', 'CampaignReference', 'V2024CampaignReference'] +--- + + +# CampaignReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the campaign. | [required] +**Name** | **String** | The name of the campaign. | [required] +**Type** | **Enum** [ "CAMPAIGN" ] | The type of object that is being referenced. | [required] +**CampaignType** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH" ] | The type of the campaign. | [required] +**Description** | **String** | The description of the campaign set by the admin who created it. | [required] +**CorrelatedStatus** | **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [required] +**MandatoryCommentRequirement** | **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [required] + +## Examples + +- Prepare the resource +```powershell +$CampaignReference = Initialize-PSSailpoint.V2024CampaignReference -Id ef38f94347e94562b5bb8424a56397d8 ` + -Name Campaign Name ` + -Type CAMPAIGN ` + -CampaignType MANAGER ` + -Description A description of the campaign ` + -CorrelatedStatus CORRELATED ` + -MandatoryCommentRequirement NO_DECISIONS +``` + +- Convert the resource to JSON +```powershell +$CampaignReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignReport.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignReport.md new file mode 100644 index 000000000..e3b6fc38b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignReport.md @@ -0,0 +1,45 @@ +--- +id: v2024-campaign-report +title: CampaignReport +pagination_label: CampaignReport +sidebar_label: CampaignReport +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignReport', 'V2024CampaignReport'] +slug: /tools/sdk/powershell/v2024/models/campaign-report +tags: ['SDK', 'Software Development Kit', 'CampaignReport', 'V2024CampaignReport'] +--- + + +# CampaignReport + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "REPORT_RESULT" ] | SOD policy violation report result DTO type. | [optional] +**Id** | Pointer to **String** | SOD policy violation report result ID. | [optional] +**Name** | Pointer to **String** | Human-readable name of the SOD policy violation report result. | [optional] +**Status** | Pointer to **Enum** [ "SUCCESS", "WARNING", "ERROR", "TERMINATED", "TEMP_ERROR", "PENDING" ] | Status of a SOD policy violation report. | [optional] +**ReportType** | [**ReportType**](report-type) | | [required] +**LastRunAt** | Pointer to **System.DateTime** | The most recent date and time this report was run | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$CampaignReport = Initialize-PSSailpoint.V2024CampaignReport -Type REPORT_RESULT ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name SOD Policy 1 Violation ` + -Status PENDING ` + -ReportType null ` + -LastRunAt null +``` + +- Convert the resource to JSON +```powershell +$CampaignReport | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignReportsConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignReportsConfig.md new file mode 100644 index 000000000..4a568f575 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignReportsConfig.md @@ -0,0 +1,35 @@ +--- +id: v2024-campaign-reports-config +title: CampaignReportsConfig +pagination_label: CampaignReportsConfig +sidebar_label: CampaignReportsConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignReportsConfig', 'V2024CampaignReportsConfig'] +slug: /tools/sdk/powershell/v2024/models/campaign-reports-config +tags: ['SDK', 'Software Development Kit', 'CampaignReportsConfig', 'V2024CampaignReportsConfig'] +--- + + +# CampaignReportsConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityAttributeColumns** | Pointer to **[]String** | list of identity attribute columns | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignReportsConfig = Initialize-PSSailpoint.V2024CampaignReportsConfig -IdentityAttributeColumns [firstname, lastname] +``` + +- Convert the resource to JSON +```powershell +$CampaignReportsConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignTemplate.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignTemplate.md new file mode 100644 index 000000000..d4d8cddd7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignTemplate.md @@ -0,0 +1,51 @@ +--- +id: v2024-campaign-template +title: CampaignTemplate +pagination_label: CampaignTemplate +sidebar_label: CampaignTemplate +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignTemplate', 'V2024CampaignTemplate'] +slug: /tools/sdk/powershell/v2024/models/campaign-template +tags: ['SDK', 'Software Development Kit', 'CampaignTemplate', 'V2024CampaignTemplate'] +--- + + +# CampaignTemplate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the campaign template | [optional] +**Name** | **String** | This template's name. Has no bearing on generated campaigns' names. | [required] +**Description** | **String** | This template's description. Has no bearing on generated campaigns' descriptions. | [required] +**Created** | **System.DateTime** | Creation date of Campaign Template | [required][readonly] +**Modified** | **System.DateTime** | Modification date of Campaign Template | [required][readonly] +**Scheduled** | Pointer to **Boolean** | Indicates if this campaign template has been scheduled. | [optional] [readonly] [default to $false] +**OwnerRef** | Pointer to [**CampaignTemplateOwnerRef**](campaign-template-owner-ref) | | [optional] +**DeadlineDuration** | Pointer to **String** | The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign's deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was ""P2W"" (two weeks), the resulting campaign's deadline would be 2020-01-15 (the current date plus 14 days). | [optional] +**Campaign** | [**Campaign**](campaign) | | [required] + +## Examples + +- Prepare the resource +```powershell +$CampaignTemplate = Initialize-PSSailpoint.V2024CampaignTemplate -Id 2c9079b270a266a60170a277bb960008 ` + -Name Manager Campaign Template ` + -Description Template for the annual manager campaign. ` + -Created 2020-03-05T22:44:00.364Z ` + -Modified 2020-03-05T22:52:09.969Z ` + -Scheduled false ` + -OwnerRef null ` + -DeadlineDuration P2W ` + -Campaign null +``` + +- Convert the resource to JSON +```powershell +$CampaignTemplate | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignTemplateOwnerRef.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignTemplateOwnerRef.md new file mode 100644 index 000000000..b33b1fe5d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignTemplateOwnerRef.md @@ -0,0 +1,41 @@ +--- +id: v2024-campaign-template-owner-ref +title: CampaignTemplateOwnerRef +pagination_label: CampaignTemplateOwnerRef +sidebar_label: CampaignTemplateOwnerRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignTemplateOwnerRef', 'V2024CampaignTemplateOwnerRef'] +slug: /tools/sdk/powershell/v2024/models/campaign-template-owner-ref +tags: ['SDK', 'Software Development Kit', 'CampaignTemplateOwnerRef', 'V2024CampaignTemplateOwnerRef'] +--- + + +# CampaignTemplateOwnerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the owner | [optional] +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Type of the owner | [optional] +**Name** | Pointer to **String** | Name of the owner | [optional] +**Email** | Pointer to **String** | Email of the owner | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignTemplateOwnerRef = Initialize-PSSailpoint.V2024CampaignTemplateOwnerRef -Id 2c918086676d3e0601677611dbde220f ` + -Type IDENTITY ` + -Name Mister Manager ` + -Email mr.manager@example.com +``` + +- Convert the resource to JSON +```powershell +$CampaignTemplateOwnerRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignsDeleteRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignsDeleteRequest.md new file mode 100644 index 000000000..282162a63 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CampaignsDeleteRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-campaigns-delete-request +title: CampaignsDeleteRequest +pagination_label: CampaignsDeleteRequest +sidebar_label: CampaignsDeleteRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignsDeleteRequest', 'V2024CampaignsDeleteRequest'] +slug: /tools/sdk/powershell/v2024/models/campaigns-delete-request +tags: ['SDK', 'Software Development Kit', 'CampaignsDeleteRequest', 'V2024CampaignsDeleteRequest'] +--- + + +# CampaignsDeleteRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]String** | The ids of the campaigns to delete | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignsDeleteRequest = Initialize-PSSailpoint.V2024CampaignsDeleteRequest -Ids [2c9180887335cee10173490db1776c26, 2c9180836a712436016a7125a90c0021] +``` + +- Convert the resource to JSON +```powershell +$CampaignsDeleteRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CancelAccessRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CancelAccessRequest.md new file mode 100644 index 000000000..41227e4d5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CancelAccessRequest.md @@ -0,0 +1,37 @@ +--- +id: v2024-cancel-access-request +title: CancelAccessRequest +pagination_label: CancelAccessRequest +sidebar_label: CancelAccessRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CancelAccessRequest', 'V2024CancelAccessRequest'] +slug: /tools/sdk/powershell/v2024/models/cancel-access-request +tags: ['SDK', 'Software Development Kit', 'CancelAccessRequest', 'V2024CancelAccessRequest'] +--- + + +# CancelAccessRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountActivityId** | **String** | This refers to the identityRequestId. To successfully cancel an access request, you must provide the identityRequestId. | [required] +**Comment** | **String** | Reason for cancelling the pending access request. | [required] + +## Examples + +- Prepare the resource +```powershell +$CancelAccessRequest = Initialize-PSSailpoint.V2024CancelAccessRequest -AccountActivityId 2c9180835d2e5168015d32f890ca1581 ` + -Comment I requested this role by mistake. +``` + +- Convert the resource to JSON +```powershell +$CancelAccessRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CancelledRequestDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CancelledRequestDetails.md new file mode 100644 index 000000000..faa66be6c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CancelledRequestDetails.md @@ -0,0 +1,39 @@ +--- +id: v2024-cancelled-request-details +title: CancelledRequestDetails +pagination_label: CancelledRequestDetails +sidebar_label: CancelledRequestDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CancelledRequestDetails', 'V2024CancelledRequestDetails'] +slug: /tools/sdk/powershell/v2024/models/cancelled-request-details +tags: ['SDK', 'Software Development Kit', 'CancelledRequestDetails', 'V2024CancelledRequestDetails'] +--- + + +# CancelledRequestDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment made by the owner when cancelling the associated request. | [optional] +**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**Modified** | Pointer to **System.DateTime** | Date comment was added by the owner when cancelling the associated request. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CancelledRequestDetails = Initialize-PSSailpoint.V2024CancelledRequestDetails -Comment This request must be cancelled. ` + -Owner null ` + -Modified 2019-12-20T09:17:12.192Z +``` + +- Convert the resource to JSON +```powershell +$CancelledRequestDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CancelledRequestDetails1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CancelledRequestDetails1.md new file mode 100644 index 000000000..8c314a801 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CancelledRequestDetails1.md @@ -0,0 +1,39 @@ +--- +id: v2024-cancelled-request-details1 +title: CancelledRequestDetails1 +pagination_label: CancelledRequestDetails1 +sidebar_label: CancelledRequestDetails1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CancelledRequestDetails1', 'V2024CancelledRequestDetails1'] +slug: /tools/sdk/powershell/v2024/models/cancelled-request-details1 +tags: ['SDK', 'Software Development Kit', 'CancelledRequestDetails1', 'V2024CancelledRequestDetails1'] +--- + + +# CancelledRequestDetails1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment made by the owner when cancelling the associated request. | [optional] +**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**Modified** | Pointer to **System.DateTime** | Date comment was added by the owner when cancelling the associated request. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CancelledRequestDetails1 = Initialize-PSSailpoint.V2024CancelledRequestDetails1 -Comment This request must be cancelled. ` + -Owner null ` + -Modified 2019-12-20T09:17:12.192Z +``` + +- Convert the resource to JSON +```powershell +$CancelledRequestDetails1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Certification.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Certification.md new file mode 100644 index 000000000..9163924bd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Certification.md @@ -0,0 +1,67 @@ +--- +id: v2024-certification +title: Certification +pagination_label: Certification +sidebar_label: Certification +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Certification', 'V2024Certification'] +slug: /tools/sdk/powershell/v2024/models/certification +tags: ['SDK', 'Software Development Kit', 'Certification', 'V2024Certification'] +--- + + +# Certification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | id of the certification | [optional] +**Name** | Pointer to **String** | name of the certification | [optional] +**Campaign** | Pointer to [**CampaignReference**](campaign-reference) | | [optional] +**Completed** | Pointer to **Boolean** | Have all decisions been made? | [optional] +**IdentitiesCompleted** | Pointer to **Int32** | The number of identities for whom all decisions have been made and are complete. | [optional] +**IdentitiesTotal** | Pointer to **Int32** | The total number of identities in the Certification, both complete and incomplete. | [optional] +**Created** | Pointer to **System.DateTime** | created date | [optional] +**Modified** | Pointer to **System.DateTime** | modified date | [optional] +**DecisionsMade** | Pointer to **Int32** | The number of approve/revoke/acknowledge decisions that have been made. | [optional] +**DecisionsTotal** | Pointer to **Int32** | The total number of approve/revoke/acknowledge decisions. | [optional] +**Due** | Pointer to **System.DateTime** | The due date of the certification. | [optional] +**Signed** | Pointer to **System.DateTime** | The date the reviewer signed off on the Certification. | [optional] +**Reviewer** | Pointer to [**Reviewer**](reviewer) | | [optional] +**Reassignment** | Pointer to [**Reassignment**](reassignment) | | [optional] +**HasErrors** | Pointer to **Boolean** | Identifies if the certification has an error | [optional] +**ErrorMessage** | Pointer to **String** | Description of the certification error | [optional] +**Phase** | Pointer to [**CertificationPhase**](certification-phase) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Certification = Initialize-PSSailpoint.V2024Certification -Id 2c9180835d2e5168015d32f890ca1581 ` + -Name Source Owner Access Review for Employees [source] ` + -Campaign null ` + -Completed true ` + -IdentitiesCompleted 5 ` + -IdentitiesTotal 10 ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -DecisionsMade 20 ` + -DecisionsTotal 40 ` + -Due 2018-10-19T13:49:37.385Z ` + -Signed 2018-10-19T13:49:37.385Z ` + -Reviewer null ` + -Reassignment null ` + -HasErrors false ` + -ErrorMessage The certification has an error ` + -Phase null +``` + +- Convert the resource to JSON +```powershell +$Certification | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationDecision.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationDecision.md new file mode 100644 index 000000000..7ea6d2892 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationDecision.md @@ -0,0 +1,24 @@ +--- +id: v2024-certification-decision +title: CertificationDecision +pagination_label: CertificationDecision +sidebar_label: CertificationDecision +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationDecision', 'V2024CertificationDecision'] +slug: /tools/sdk/powershell/v2024/models/certification-decision +tags: ['SDK', 'Software Development Kit', 'CertificationDecision', 'V2024CertificationDecision'] +--- + + +# CertificationDecision + +## Enum + + +* `APPROVE` (value: `"APPROVE"`) + +* `REVOKE` (value: `"REVOKE"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationDto.md new file mode 100644 index 000000000..1c6bbab99 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationDto.md @@ -0,0 +1,59 @@ +--- +id: v2024-certification-dto +title: CertificationDto +pagination_label: CertificationDto +sidebar_label: CertificationDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationDto', 'V2024CertificationDto'] +slug: /tools/sdk/powershell/v2024/models/certification-dto +tags: ['SDK', 'Software Development Kit', 'CertificationDto', 'V2024CertificationDto'] +--- + + +# CertificationDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CampaignRef** | [**CampaignReference**](campaign-reference) | | [required] +**Phase** | [**CertificationPhase**](certification-phase) | | [required] +**Due** | **System.DateTime** | The due date of the certification. | [required] +**Signed** | **System.DateTime** | The date the reviewer signed off on the certification. | [required] +**Reviewer** | [**Reviewer1**](reviewer1) | | [required] +**Reassignment** | Pointer to [**Reassignment1**](reassignment1) | | [optional] +**HasErrors** | **Boolean** | Indicates it the certification has any errors. | [required] +**ErrorMessage** | Pointer to **String** | A message indicating what the error is. | [optional] +**Completed** | **Boolean** | Indicates if all certification decisions have been made. | [required] +**DecisionsMade** | **Int32** | The number of approve/revoke/acknowledge decisions that have been made by the reviewer. | [required] +**DecisionsTotal** | **Int32** | The total number of approve/revoke/acknowledge decisions for the certification. | [required] +**EntitiesCompleted** | **Int32** | The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. | [required] +**EntitiesTotal** | **Int32** | The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | [required] + +## Examples + +- Prepare the resource +```powershell +$CertificationDto = Initialize-PSSailpoint.V2024CertificationDto -CampaignRef null ` + -Phase null ` + -Due 2018-10-19T13:49:37.385Z ` + -Signed 2018-10-19T13:49:37.385Z ` + -Reviewer null ` + -Reassignment null ` + -HasErrors false ` + -ErrorMessage The certification has an error ` + -Completed false ` + -DecisionsMade 20 ` + -DecisionsTotal 40 ` + -EntitiesCompleted 5 ` + -EntitiesTotal 10 +``` + +- Convert the resource to JSON +```powershell +$CertificationDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationIdentitySummary.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationIdentitySummary.md new file mode 100644 index 000000000..1a1f38962 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationIdentitySummary.md @@ -0,0 +1,41 @@ +--- +id: v2024-certification-identity-summary +title: CertificationIdentitySummary +pagination_label: CertificationIdentitySummary +sidebar_label: CertificationIdentitySummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationIdentitySummary', 'V2024CertificationIdentitySummary'] +slug: /tools/sdk/powershell/v2024/models/certification-identity-summary +tags: ['SDK', 'Software Development Kit', 'CertificationIdentitySummary', 'V2024CertificationIdentitySummary'] +--- + + +# CertificationIdentitySummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of the identity summary | [optional] +**Name** | Pointer to **String** | Name of the linked identity | [optional] +**IdentityId** | Pointer to **String** | The ID of the identity being certified | [optional] +**Completed** | Pointer to **Boolean** | Indicates whether the review items for the linked identity's certification have been completed | [optional] + +## Examples + +- Prepare the resource +```powershell +$CertificationIdentitySummary = Initialize-PSSailpoint.V2024CertificationIdentitySummary -Id 2c91808772a504f50172a9540e501ba7 ` + -Name Alison Ferguso ` + -IdentityId 2c9180857182306001719937377a33de ` + -Completed true +``` + +- Convert the resource to JSON +```powershell +$CertificationIdentitySummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationPhase.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationPhase.md new file mode 100644 index 000000000..09b4ec2ed --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationPhase.md @@ -0,0 +1,26 @@ +--- +id: v2024-certification-phase +title: CertificationPhase +pagination_label: CertificationPhase +sidebar_label: CertificationPhase +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationPhase', 'V2024CertificationPhase'] +slug: /tools/sdk/powershell/v2024/models/certification-phase +tags: ['SDK', 'Software Development Kit', 'CertificationPhase', 'V2024CertificationPhase'] +--- + + +# CertificationPhase + +## Enum + + +* `STAGED` (value: `"STAGED"`) + +* `ACTIVE` (value: `"ACTIVE"`) + +* `SIGNED` (value: `"SIGNED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationReference.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationReference.md new file mode 100644 index 000000000..f2e8075be --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationReference.md @@ -0,0 +1,41 @@ +--- +id: v2024-certification-reference +title: CertificationReference +pagination_label: CertificationReference +sidebar_label: CertificationReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationReference', 'V2024CertificationReference'] +slug: /tools/sdk/powershell/v2024/models/certification-reference +tags: ['SDK', 'Software Development Kit', 'CertificationReference', 'V2024CertificationReference'] +--- + + +# CertificationReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The id of the certification. | [optional] +**Name** | Pointer to **String** | The name of the certification. | [optional] +**Type** | Pointer to **Enum** [ "CERTIFICATION" ] | | [optional] +**Reviewer** | Pointer to [**Reviewer**](reviewer) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CertificationReference = Initialize-PSSailpoint.V2024CertificationReference -Id ef38f94347e94562b5bb8424a56397d8 ` + -Name Certification Name ` + -Type CERTIFICATION ` + -Reviewer null +``` + +- Convert the resource to JSON +```powershell +$CertificationReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationReference1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationReference1.md new file mode 100644 index 000000000..595808737 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationReference1.md @@ -0,0 +1,41 @@ +--- +id: v2024-certification-reference1 +title: CertificationReference1 +pagination_label: CertificationReference1 +sidebar_label: CertificationReference1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationReference1', 'V2024CertificationReference1'] +slug: /tools/sdk/powershell/v2024/models/certification-reference1 +tags: ['SDK', 'Software Development Kit', 'CertificationReference1', 'V2024CertificationReference1'] +--- + + +# CertificationReference1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "CERTIFICATION" ] | DTO type of certification for review. | [optional] +**Id** | Pointer to **String** | ID of certification for review. | [optional] +**Name** | Pointer to **String** | Display name of certification for review. | [optional] +**Reviewer** | Pointer to [**Reviewer1**](reviewer1) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CertificationReference1 = Initialize-PSSailpoint.V2024CertificationReference1 -Type IDENTITY ` + -Id 7589a83cec4b4f138ce56c1a5ef0756d ` + -Name Manager Access for Michael Michaels ` + -Reviewer null +``` + +- Convert the resource to JSON +```powershell +$CertificationReference1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationReferenceDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationReferenceDto.md new file mode 100644 index 000000000..9bbc8776c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationReferenceDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-certification-reference-dto +title: CertificationReferenceDto +pagination_label: CertificationReferenceDto +sidebar_label: CertificationReferenceDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationReferenceDto', 'V2024CertificationReferenceDto'] +slug: /tools/sdk/powershell/v2024/models/certification-reference-dto +tags: ['SDK', 'Software Development Kit', 'CertificationReferenceDto', 'V2024CertificationReferenceDto'] +--- + + +# CertificationReferenceDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "CERTIFICATION" ] | DTO type of certification for review. | [optional] +**Id** | Pointer to **String** | ID of certification for review. | [optional] +**Name** | Pointer to **String** | Display name of certification for review. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CertificationReferenceDto = Initialize-PSSailpoint.V2024CertificationReferenceDto -Type IDENTITY ` + -Id 7589a83cec4b4f138ce56c1a5ef0756d ` + -Name Manager Access for Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$CertificationReferenceDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationSignedOff.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationSignedOff.md new file mode 100644 index 000000000..093583d82 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationSignedOff.md @@ -0,0 +1,35 @@ +--- +id: v2024-certification-signed-off +title: CertificationSignedOff +pagination_label: CertificationSignedOff +sidebar_label: CertificationSignedOff +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationSignedOff', 'V2024CertificationSignedOff'] +slug: /tools/sdk/powershell/v2024/models/certification-signed-off +tags: ['SDK', 'Software Development Kit', 'CertificationSignedOff', 'V2024CertificationSignedOff'] +--- + + +# CertificationSignedOff + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Certification** | [**CertificationSignedOffCertification**](certification-signed-off-certification) | | [required] + +## Examples + +- Prepare the resource +```powershell +$CertificationSignedOff = Initialize-PSSailpoint.V2024CertificationSignedOff -Certification null +``` + +- Convert the resource to JSON +```powershell +$CertificationSignedOff | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationSignedOffCertification.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationSignedOffCertification.md new file mode 100644 index 000000000..f5825193e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationSignedOffCertification.md @@ -0,0 +1,67 @@ +--- +id: v2024-certification-signed-off-certification +title: CertificationSignedOffCertification +pagination_label: CertificationSignedOffCertification +sidebar_label: CertificationSignedOffCertification +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationSignedOffCertification', 'V2024CertificationSignedOffCertification'] +slug: /tools/sdk/powershell/v2024/models/certification-signed-off-certification +tags: ['SDK', 'Software Development Kit', 'CertificationSignedOffCertification', 'V2024CertificationSignedOffCertification'] +--- + + +# CertificationSignedOffCertification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Unique ID of the certification. | [required] +**Name** | **String** | The name of the certification. | [required] +**Created** | **System.DateTime** | The date and time the certification was created. | [required] +**Modified** | Pointer to **System.DateTime** | The date and time the certification was last modified. | [optional] +**CampaignRef** | [**CampaignReference**](campaign-reference) | | [required] +**Phase** | [**CertificationPhase**](certification-phase) | | [required] +**Due** | **System.DateTime** | The due date of the certification. | [required] +**Signed** | **System.DateTime** | The date the reviewer signed off on the certification. | [required] +**Reviewer** | [**Reviewer1**](reviewer1) | | [required] +**Reassignment** | Pointer to [**Reassignment1**](reassignment1) | | [optional] +**HasErrors** | **Boolean** | Indicates it the certification has any errors. | [required] +**ErrorMessage** | Pointer to **String** | A message indicating what the error is. | [optional] +**Completed** | **Boolean** | Indicates if all certification decisions have been made. | [required] +**DecisionsMade** | **Int32** | The number of approve/revoke/acknowledge decisions that have been made by the reviewer. | [required] +**DecisionsTotal** | **Int32** | The total number of approve/revoke/acknowledge decisions for the certification. | [required] +**EntitiesCompleted** | **Int32** | The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. | [required] +**EntitiesTotal** | **Int32** | The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | [required] + +## Examples + +- Prepare the resource +```powershell +$CertificationSignedOffCertification = Initialize-PSSailpoint.V2024CertificationSignedOffCertification -Id 2c91808576f886190176f88caf0d0067 ` + -Name Manager Access Review for Alice Baker ` + -Created 2020-02-16T03:04:45.815Z ` + -Modified 2020-02-16T03:06:45.815Z ` + -CampaignRef null ` + -Phase null ` + -Due 2018-10-19T13:49:37.385Z ` + -Signed 2018-10-19T13:49:37.385Z ` + -Reviewer null ` + -Reassignment null ` + -HasErrors false ` + -ErrorMessage The certification has an error ` + -Completed false ` + -DecisionsMade 20 ` + -DecisionsTotal 40 ` + -EntitiesCompleted 5 ` + -EntitiesTotal 10 +``` + +- Convert the resource to JSON +```powershell +$CertificationSignedOffCertification | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationTask.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationTask.md new file mode 100644 index 000000000..63527479b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertificationTask.md @@ -0,0 +1,49 @@ +--- +id: v2024-certification-task +title: CertificationTask +pagination_label: CertificationTask +sidebar_label: CertificationTask +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationTask', 'V2024CertificationTask'] +slug: /tools/sdk/powershell/v2024/models/certification-task +tags: ['SDK', 'Software Development Kit', 'CertificationTask', 'V2024CertificationTask'] +--- + + +# CertificationTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of the certification task. | [optional] +**Type** | Pointer to **Enum** [ "REASSIGN", "ADMIN_REASSIGN", "COMPLETE_CERTIFICATION", "FINISH_CERTIFICATION", "COMPLETE_CAMPAIGN", "ACTIVATE_CAMPAIGN", "CAMPAIGN_CREATE", "CAMPAIGN_DELETE" ] | The type of the certification task. More values may be added in the future. | [optional] +**TargetType** | Pointer to **Enum** [ "CERTIFICATION", "CAMPAIGN" ] | The type of item that is being operated on by this task whose ID is stored in the targetId field. | [optional] +**TargetId** | Pointer to **String** | The ID of the item being operated on by this task. | [optional] +**Status** | Pointer to **Enum** [ "QUEUED", "IN_PROGRESS", "SUCCESS", "ERROR" ] | The status of the task. | [optional] +**Errors** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | | [optional] +**ReassignmentTrailDTOs** | Pointer to [**[]ReassignmentTrailDTO**](reassignment-trail-dto) | Reassignment trails that lead to self certification identity | [optional] +**Created** | Pointer to **System.DateTime** | The date and time on which this task was created. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CertificationTask = Initialize-PSSailpoint.V2024CertificationTask -Id 2c918086719eec070171a7e3355a360a ` + -Type ADMIN_REASSIGN ` + -TargetType CAMPAIGN ` + -TargetId 2c918086719eec070171a7e3355a834c ` + -Status QUEUED ` + -Errors null ` + -ReassignmentTrailDTOs {previousOwner=ef38f94347e94562b5bb8424a56397d8, newOwner=ef38f94347e94562b5bb8424a56397a3, reassignmentType=AUTOMATIC_REASSIGNMENT} ` + -Created 2020-09-24T18:10:47.693Z +``` + +- Convert the resource to JSON +```powershell +$CertificationTask | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertifierResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertifierResponse.md new file mode 100644 index 000000000..129352ef9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CertifierResponse.md @@ -0,0 +1,37 @@ +--- +id: v2024-certifier-response +title: CertifierResponse +pagination_label: CertifierResponse +sidebar_label: CertifierResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertifierResponse', 'V2024CertifierResponse'] +slug: /tools/sdk/powershell/v2024/models/certifier-response +tags: ['SDK', 'Software Development Kit', 'CertifierResponse', 'V2024CertifierResponse'] +--- + + +# CertifierResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | the id of the certifier | [optional] +**DisplayName** | Pointer to **String** | the name of the certifier | [optional] + +## Examples + +- Prepare the resource +```powershell +$CertifierResponse = Initialize-PSSailpoint.V2024CertifierResponse -Id 8a80828f643d484f01643e14202e206f ` + -DisplayName John Snow +``` + +- Convert the resource to JSON +```powershell +$CertifierResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ClientLogConfiguration.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ClientLogConfiguration.md new file mode 100644 index 000000000..6979f0dda --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ClientLogConfiguration.md @@ -0,0 +1,43 @@ +--- +id: v2024-client-log-configuration +title: ClientLogConfiguration +pagination_label: ClientLogConfiguration +sidebar_label: ClientLogConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ClientLogConfiguration', 'V2024ClientLogConfiguration'] +slug: /tools/sdk/powershell/v2024/models/client-log-configuration +tags: ['SDK', 'Software Development Kit', 'ClientLogConfiguration', 'V2024ClientLogConfiguration'] +--- + + +# ClientLogConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClientId** | Pointer to **String** | Log configuration's client ID | [optional] +**DurationMinutes** | Pointer to **Int32** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [optional] [default to 240] +**Expiration** | Pointer to **System.DateTime** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [optional] +**RootLevel** | [**StandardLevel**](standard-level) | | [required] +**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] + +## Examples + +- Prepare the resource +```powershell +$ClientLogConfiguration = Initialize-PSSailpoint.V2024ClientLogConfiguration -ClientId 3a38a51992e8445ab51a549c0a70ee66 ` + -DurationMinutes 120 ` + -Expiration 2024-11-06T01:31:08.013164Z ` + -RootLevel null ` + -LogLevels INFO +``` + +- Convert the resource to JSON +```powershell +$ClientLogConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ClientLogConfigurationDurationMinutes.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ClientLogConfigurationDurationMinutes.md new file mode 100644 index 000000000..b04fa9a9f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ClientLogConfigurationDurationMinutes.md @@ -0,0 +1,41 @@ +--- +id: v2024-client-log-configuration-duration-minutes +title: ClientLogConfigurationDurationMinutes +pagination_label: ClientLogConfigurationDurationMinutes +sidebar_label: ClientLogConfigurationDurationMinutes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ClientLogConfigurationDurationMinutes', 'V2024ClientLogConfigurationDurationMinutes'] +slug: /tools/sdk/powershell/v2024/models/client-log-configuration-duration-minutes +tags: ['SDK', 'Software Development Kit', 'ClientLogConfigurationDurationMinutes', 'V2024ClientLogConfigurationDurationMinutes'] +--- + + +# ClientLogConfigurationDurationMinutes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClientId** | Pointer to **String** | Log configuration's client ID | [optional] +**DurationMinutes** | Pointer to **Int32** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [optional] [default to 240] +**RootLevel** | [**StandardLevel**](standard-level) | | [required] +**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] + +## Examples + +- Prepare the resource +```powershell +$ClientLogConfigurationDurationMinutes = Initialize-PSSailpoint.V2024ClientLogConfigurationDurationMinutes -ClientId 3a38a51992e8445ab51a549c0a70ee66 ` + -DurationMinutes 120 ` + -RootLevel null ` + -LogLevels INFO +``` + +- Convert the resource to JSON +```powershell +$ClientLogConfigurationDurationMinutes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ClientLogConfigurationExpiration.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ClientLogConfigurationExpiration.md new file mode 100644 index 000000000..958fad17e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ClientLogConfigurationExpiration.md @@ -0,0 +1,41 @@ +--- +id: v2024-client-log-configuration-expiration +title: ClientLogConfigurationExpiration +pagination_label: ClientLogConfigurationExpiration +sidebar_label: ClientLogConfigurationExpiration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ClientLogConfigurationExpiration', 'V2024ClientLogConfigurationExpiration'] +slug: /tools/sdk/powershell/v2024/models/client-log-configuration-expiration +tags: ['SDK', 'Software Development Kit', 'ClientLogConfigurationExpiration', 'V2024ClientLogConfigurationExpiration'] +--- + + +# ClientLogConfigurationExpiration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClientId** | Pointer to **String** | Log configuration's client ID | [optional] +**Expiration** | Pointer to **System.DateTime** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [optional] +**RootLevel** | [**StandardLevel**](standard-level) | | [required] +**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] + +## Examples + +- Prepare the resource +```powershell +$ClientLogConfigurationExpiration = Initialize-PSSailpoint.V2024ClientLogConfigurationExpiration -ClientId 3a38a51992e8445ab51a549c0a70ee66 ` + -Expiration 2024-11-06T01:31:08.013164Z ` + -RootLevel null ` + -LogLevels INFO +``` + +- Convert the resource to JSON +```powershell +$ClientLogConfigurationExpiration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ClientType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ClientType.md new file mode 100644 index 000000000..0c21a03ee --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ClientType.md @@ -0,0 +1,24 @@ +--- +id: v2024-client-type +title: ClientType +pagination_label: ClientType +sidebar_label: ClientType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ClientType', 'V2024ClientType'] +slug: /tools/sdk/powershell/v2024/models/client-type +tags: ['SDK', 'Software Development Kit', 'ClientType', 'V2024ClientType'] +--- + + +# ClientType + +## Enum + + +* `CONFIDENTIAL` (value: `"CONFIDENTIAL"`) + +* `PUBLIC` (value: `"PUBLIC"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CloseAccessRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CloseAccessRequest.md new file mode 100644 index 000000000..767cac6b6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CloseAccessRequest.md @@ -0,0 +1,41 @@ +--- +id: v2024-close-access-request +title: CloseAccessRequest +pagination_label: CloseAccessRequest +sidebar_label: CloseAccessRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CloseAccessRequest', 'V2024CloseAccessRequest'] +slug: /tools/sdk/powershell/v2024/models/close-access-request +tags: ['SDK', 'Software Development Kit', 'CloseAccessRequest', 'V2024CloseAccessRequest'] +--- + + +# CloseAccessRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestIds** | **[]String** | Access Request IDs for the requests to be closed. Accepts 1-500 Identity Request IDs per request. | [required] +**Message** | Pointer to **String** | Reason for closing the access request. Displayed under Warnings in IdentityNow. | [optional] [default to "The IdentityNow Administrator manually closed this request."] +**ExecutionStatus** | Pointer to **Enum** [ "Terminated", "Completed" ] | The request's provisioning status. Displayed as Stage in IdentityNow. | [optional] [default to "Terminated"] +**CompletionStatus** | Pointer to **Enum** [ "Success", "Incomplete", "Failure" ] | The request's overall status. Displayed as Status in IdentityNow. | [optional] [default to "Failure"] + +## Examples + +- Prepare the resource +```powershell +$CloseAccessRequest = Initialize-PSSailpoint.V2024CloseAccessRequest -AccessRequestIds [2c90ad2a70ace7d50170acf22ca90010] ` + -Message The IdentityNow Administrator manually closed this request. ` + -ExecutionStatus Terminated ` + -CompletionStatus Failure +``` + +- Convert the resource to JSON +```powershell +$CloseAccessRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Column.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Column.md new file mode 100644 index 000000000..6ef9c5b7b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Column.md @@ -0,0 +1,37 @@ +--- +id: v2024-column +title: Column +pagination_label: Column +sidebar_label: Column +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Column', 'V2024Column'] +slug: /tools/sdk/powershell/v2024/models/column +tags: ['SDK', 'Software Development Kit', 'Column', 'V2024Column'] +--- + + +# Column + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Field** | **String** | The name of the field. | [required] +**Header** | Pointer to **String** | The value of the header. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Column = Initialize-PSSailpoint.V2024Column -Field email ` + -Header Work Email +``` + +- Convert the resource to JSON +```powershell +$Column | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Comment.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Comment.md new file mode 100644 index 000000000..1d40d5fa0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Comment.md @@ -0,0 +1,41 @@ +--- +id: v2024-comment +title: Comment +pagination_label: Comment +sidebar_label: Comment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Comment', 'V2024Comment'] +slug: /tools/sdk/powershell/v2024/models/comment +tags: ['SDK', 'Software Development Kit', 'Comment', 'V2024Comment'] +--- + + +# Comment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommenterId** | Pointer to **String** | Id of the identity making the comment | [optional] +**CommenterName** | Pointer to **String** | Human-readable display name of the identity making the comment | [optional] +**Body** | Pointer to **String** | Content of the comment | [optional] +**Date** | Pointer to **System.DateTime** | Date and time comment was made | [optional] + +## Examples + +- Prepare the resource +```powershell +$Comment = Initialize-PSSailpoint.V2024Comment -CommenterId 2c918084660f45d6016617daa9210584 ` + -CommenterName Adam Kennedy ` + -Body Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat. ` + -Date 2017-07-11T18:45:37.098Z +``` + +- Convert the resource to JSON +```powershell +$Comment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommentDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommentDto.md new file mode 100644 index 000000000..f2f2cdfff --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommentDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-comment-dto +title: CommentDto +pagination_label: CommentDto +sidebar_label: CommentDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CommentDto', 'V2024CommentDto'] +slug: /tools/sdk/powershell/v2024/models/comment-dto +tags: ['SDK', 'Software Development Kit', 'CommentDto', 'V2024CommentDto'] +--- + + +# CommentDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment content. | [optional] +**Created** | Pointer to **System.DateTime** | Date and time comment was created. | [optional] +**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CommentDto = Initialize-PSSailpoint.V2024CommentDto -Comment This is a comment. ` + -Created 2017-07-11T18:45:37.098Z ` + -Author null +``` + +- Convert the resource to JSON +```powershell +$CommentDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommentDtoAuthor.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommentDtoAuthor.md new file mode 100644 index 000000000..c75bd00cf --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommentDtoAuthor.md @@ -0,0 +1,39 @@ +--- +id: v2024-comment-dto-author +title: CommentDtoAuthor +pagination_label: CommentDtoAuthor +sidebar_label: CommentDtoAuthor +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CommentDtoAuthor', 'V2024CommentDtoAuthor'] +slug: /tools/sdk/powershell/v2024/models/comment-dto-author +tags: ['SDK', 'Software Development Kit', 'CommentDtoAuthor', 'V2024CommentDtoAuthor'] +--- + + +# CommentDtoAuthor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of object | [optional] +**Id** | Pointer to **String** | The unique ID of the object | [optional] +**Name** | Pointer to **String** | The display name of the object | [optional] + +## Examples + +- Prepare the resource +```powershell +$CommentDtoAuthor = Initialize-PSSailpoint.V2024CommentDtoAuthor -Type IDENTITY ` + -Id 2c9180847e25f377017e2ae8cae4650b ` + -Name john.doe +``` + +- Convert the resource to JSON +```powershell +$CommentDtoAuthor | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommonAccessIDStatus.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommonAccessIDStatus.md new file mode 100644 index 000000000..e2b7cd15b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommonAccessIDStatus.md @@ -0,0 +1,37 @@ +--- +id: v2024-common-access-id-status +title: CommonAccessIDStatus +pagination_label: CommonAccessIDStatus +sidebar_label: CommonAccessIDStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CommonAccessIDStatus', 'V2024CommonAccessIDStatus'] +slug: /tools/sdk/powershell/v2024/models/common-access-id-status +tags: ['SDK', 'Software Development Kit', 'CommonAccessIDStatus', 'V2024CommonAccessIDStatus'] +--- + + +# CommonAccessIDStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConfirmedIds** | Pointer to **[]String** | List of confirmed common access ids. | [optional] +**DeniedIds** | Pointer to **[]String** | List of denied common access ids. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CommonAccessIDStatus = Initialize-PSSailpoint.V2024CommonAccessIDStatus -ConfirmedIds null ` + -DeniedIds null +``` + +- Convert the resource to JSON +```powershell +$CommonAccessIDStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommonAccessItemAccess.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommonAccessItemAccess.md new file mode 100644 index 000000000..b6486c4d8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommonAccessItemAccess.md @@ -0,0 +1,45 @@ +--- +id: v2024-common-access-item-access +title: CommonAccessItemAccess +pagination_label: CommonAccessItemAccess +sidebar_label: CommonAccessItemAccess +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CommonAccessItemAccess', 'V2024CommonAccessItemAccess'] +slug: /tools/sdk/powershell/v2024/models/common-access-item-access +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemAccess', 'V2024CommonAccessItemAccess'] +--- + + +# CommonAccessItemAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Common access ID | [optional] +**Type** | Pointer to [**CommonAccessType**](common-access-type) | | [optional] +**Name** | Pointer to **String** | Common access name | [optional] +**Description** | Pointer to **String** | Common access description | [optional] +**OwnerName** | Pointer to **String** | Common access owner name | [optional] +**OwnerId** | Pointer to **String** | Common access owner ID | [optional] + +## Examples + +- Prepare the resource +```powershell +$CommonAccessItemAccess = Initialize-PSSailpoint.V2024CommonAccessItemAccess -Id null ` + -Type null ` + -Name null ` + -Description null ` + -OwnerName null ` + -OwnerId null +``` + +- Convert the resource to JSON +```powershell +$CommonAccessItemAccess | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommonAccessItemRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommonAccessItemRequest.md new file mode 100644 index 000000000..ac80d97c1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommonAccessItemRequest.md @@ -0,0 +1,37 @@ +--- +id: v2024-common-access-item-request +title: CommonAccessItemRequest +pagination_label: CommonAccessItemRequest +sidebar_label: CommonAccessItemRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CommonAccessItemRequest', 'V2024CommonAccessItemRequest'] +slug: /tools/sdk/powershell/v2024/models/common-access-item-request +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemRequest', 'V2024CommonAccessItemRequest'] +--- + + +# CommonAccessItemRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Access** | Pointer to [**CommonAccessItemAccess**](common-access-item-access) | | [optional] +**Status** | Pointer to [**CommonAccessItemState**](common-access-item-state) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CommonAccessItemRequest = Initialize-PSSailpoint.V2024CommonAccessItemRequest -Access null ` + -Status null +``` + +- Convert the resource to JSON +```powershell +$CommonAccessItemRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommonAccessItemResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommonAccessItemResponse.md new file mode 100644 index 000000000..1d6eefcbf --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommonAccessItemResponse.md @@ -0,0 +1,47 @@ +--- +id: v2024-common-access-item-response +title: CommonAccessItemResponse +pagination_label: CommonAccessItemResponse +sidebar_label: CommonAccessItemResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CommonAccessItemResponse', 'V2024CommonAccessItemResponse'] +slug: /tools/sdk/powershell/v2024/models/common-access-item-response +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemResponse', 'V2024CommonAccessItemResponse'] +--- + + +# CommonAccessItemResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Common Access Item ID | [optional] +**Access** | Pointer to [**CommonAccessItemAccess**](common-access-item-access) | | [optional] +**Status** | Pointer to [**CommonAccessItemState**](common-access-item-state) | | [optional] +**LastUpdated** | Pointer to **String** | | [optional] +**ReviewedByUser** | Pointer to **Boolean** | | [optional] +**LastReviewed** | Pointer to **String** | | [optional] +**CreatedByUser** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CommonAccessItemResponse = Initialize-PSSailpoint.V2024CommonAccessItemResponse -Id null ` + -Access null ` + -Status null ` + -LastUpdated null ` + -ReviewedByUser null ` + -LastReviewed null ` + -CreatedByUser null +``` + +- Convert the resource to JSON +```powershell +$CommonAccessItemResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommonAccessItemState.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommonAccessItemState.md new file mode 100644 index 000000000..e5d8c44a3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommonAccessItemState.md @@ -0,0 +1,24 @@ +--- +id: v2024-common-access-item-state +title: CommonAccessItemState +pagination_label: CommonAccessItemState +sidebar_label: CommonAccessItemState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CommonAccessItemState', 'V2024CommonAccessItemState'] +slug: /tools/sdk/powershell/v2024/models/common-access-item-state +tags: ['SDK', 'Software Development Kit', 'CommonAccessItemState', 'V2024CommonAccessItemState'] +--- + + +# CommonAccessItemState + +## Enum + + +* `CONFIRMED` (value: `"CONFIRMED"`) + +* `DENIED` (value: `"DENIED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommonAccessResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommonAccessResponse.md new file mode 100644 index 000000000..15d233899 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommonAccessResponse.md @@ -0,0 +1,49 @@ +--- +id: v2024-common-access-response +title: CommonAccessResponse +pagination_label: CommonAccessResponse +sidebar_label: CommonAccessResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CommonAccessResponse', 'V2024CommonAccessResponse'] +slug: /tools/sdk/powershell/v2024/models/common-access-response +tags: ['SDK', 'Software Development Kit', 'CommonAccessResponse', 'V2024CommonAccessResponse'] +--- + + +# CommonAccessResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Unique ID of the common access item | [optional] +**Access** | Pointer to [**CommonAccessItemAccess**](common-access-item-access) | | [optional] +**Status** | Pointer to **String** | CONFIRMED or DENIED | [optional] +**CommonAccessType** | Pointer to **String** | | [optional] +**LastUpdated** | Pointer to **System.DateTime** | | [optional] [readonly] +**ReviewedByUser** | Pointer to **Boolean** | true if user has confirmed or denied status | [optional] +**LastReviewed** | Pointer to **System.DateTime** | | [optional] [readonly] +**CreatedByUser** | Pointer to **Boolean** | | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$CommonAccessResponse = Initialize-PSSailpoint.V2024CommonAccessResponse -Id 555ab47a-0d32-4813-906f-adf3567de6a4 ` + -Access null ` + -Status null ` + -CommonAccessType UNSET ` + -LastUpdated null ` + -ReviewedByUser null ` + -LastReviewed null ` + -CreatedByUser false +``` + +- Convert the resource to JSON +```powershell +$CommonAccessResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommonAccessType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommonAccessType.md new file mode 100644 index 000000000..b6561e705 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CommonAccessType.md @@ -0,0 +1,24 @@ +--- +id: v2024-common-access-type +title: CommonAccessType +pagination_label: CommonAccessType +sidebar_label: CommonAccessType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CommonAccessType', 'V2024CommonAccessType'] +slug: /tools/sdk/powershell/v2024/models/common-access-type +tags: ['SDK', 'Software Development Kit', 'CommonAccessType', 'V2024CommonAccessType'] +--- + + +# CommonAccessType + +## Enum + + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ROLE` (value: `"ROLE"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CompleteInvocation.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CompleteInvocation.md new file mode 100644 index 000000000..59cf43053 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CompleteInvocation.md @@ -0,0 +1,39 @@ +--- +id: v2024-complete-invocation +title: CompleteInvocation +pagination_label: CompleteInvocation +sidebar_label: CompleteInvocation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CompleteInvocation', 'V2024CompleteInvocation'] +slug: /tools/sdk/powershell/v2024/models/complete-invocation +tags: ['SDK', 'Software Development Kit', 'CompleteInvocation', 'V2024CompleteInvocation'] +--- + + +# CompleteInvocation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Secret** | **String** | Unique invocation secret that was generated when the invocation was created. Required to authenticate to the endpoint. | [required] +**VarError** | Pointer to **String** | The error message to indicate a failed invocation or error if any. | [optional] +**Output** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Trigger output to complete the invocation. Its schema is defined in the trigger definition. | [required] + +## Examples + +- Prepare the resource +```powershell +$CompleteInvocation = Initialize-PSSailpoint.V2024CompleteInvocation -Secret 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -VarError Access request is denied. ` + -Output {approved=false} +``` + +- Convert the resource to JSON +```powershell +$CompleteInvocation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CompleteInvocationInput.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CompleteInvocationInput.md new file mode 100644 index 000000000..c43bc9d01 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CompleteInvocationInput.md @@ -0,0 +1,37 @@ +--- +id: v2024-complete-invocation-input +title: CompleteInvocationInput +pagination_label: CompleteInvocationInput +sidebar_label: CompleteInvocationInput +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CompleteInvocationInput', 'V2024CompleteInvocationInput'] +slug: /tools/sdk/powershell/v2024/models/complete-invocation-input +tags: ['SDK', 'Software Development Kit', 'CompleteInvocationInput', 'V2024CompleteInvocationInput'] +--- + + +# CompleteInvocationInput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LocalizedError** | Pointer to [**LocalizedMessage**](localized-message) | | [optional] +**Output** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Trigger output that completed the invocation. Its schema is defined in the trigger definition. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CompleteInvocationInput = Initialize-PSSailpoint.V2024CompleteInvocationInput -LocalizedError null ` + -Output {approved=false} +``` + +- Convert the resource to JSON +```powershell +$CompleteInvocationInput | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CompletedApproval.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CompletedApproval.md new file mode 100644 index 000000000..d57fc57db --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CompletedApproval.md @@ -0,0 +1,79 @@ +--- +id: v2024-completed-approval +title: CompletedApproval +pagination_label: CompletedApproval +sidebar_label: CompletedApproval +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CompletedApproval', 'V2024CompletedApproval'] +slug: /tools/sdk/powershell/v2024/models/completed-approval +tags: ['SDK', 'Software Development Kit', 'CompletedApproval', 'V2024CompletedApproval'] +--- + + +# CompletedApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The approval id. | [optional] +**Name** | Pointer to **String** | The name of the approval. | [optional] +**Created** | Pointer to **System.DateTime** | When the approval was created. | [optional] +**Modified** | Pointer to **System.DateTime** | When the approval was modified last time. | [optional] +**RequestCreated** | Pointer to **System.DateTime** | When the access-request was created. | [optional] +**RequestType** | Pointer to [**AccessRequestType**](access-request-type) | | [optional] +**Requester** | Pointer to [**AccessItemRequester**](access-item-requester) | | [optional] +**RequestedFor** | Pointer to [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] +**ReviewedBy** | Pointer to [**AccessItemReviewedBy**](access-item-reviewed-by) | | [optional] +**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**RequestedObject** | Pointer to [**RequestableObjectReference**](requestable-object-reference) | | [optional] +**RequesterComment** | Pointer to [**CompletedApprovalRequesterComment**](completed-approval-requester-comment) | | [optional] +**ReviewerComment** | Pointer to [**CompletedApprovalReviewerComment**](completed-approval-reviewer-comment) | | [optional] +**PreviousReviewersComments** | Pointer to [**[]CommentDto**](comment-dto) | The history of the previous reviewers comments. | [optional] +**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] +**CommentRequiredWhenRejected** | Pointer to **Boolean** | When true the rejector has to provide comments when rejecting | [optional] [default to $false] +**State** | Pointer to [**CompletedApprovalState**](completed-approval-state) | | [optional] +**RemoveDate** | Pointer to **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +**RemoveDateUpdateRequested** | Pointer to **Boolean** | If true, then the request was to change the remove date or sunset date. | [optional] [default to $false] +**CurrentRemoveDate** | Pointer to **System.DateTime** | The remove date or sunset date that was assigned at the time of the request. | [optional] +**SodViolationContext** | Pointer to [**SodViolationContextCheckCompleted**](sod-violation-context-check-completed) | | [optional] +**PreApprovalTriggerResult** | Pointer to [**CompletedApprovalPreApprovalTriggerResult**](completed-approval-pre-approval-trigger-result) | | [optional] +**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs provided during the request. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CompletedApproval = Initialize-PSSailpoint.V2024CompletedApproval -Id id12345 ` + -Name aName ` + -Created 2017-07-11T18:45:37.098Z ` + -Modified 2018-07-25T20:22:28.104Z ` + -RequestCreated 2017-07-11T18:45:35.098Z ` + -RequestType null ` + -Requester null ` + -RequestedFor null ` + -ReviewedBy null ` + -Owner null ` + -RequestedObject null ` + -RequesterComment null ` + -ReviewerComment null ` + -PreviousReviewersComments null ` + -ForwardHistory null ` + -CommentRequiredWhenRejected true ` + -State null ` + -RemoveDate 2020-07-11T00:00Z ` + -RemoveDateUpdateRequested true ` + -CurrentRemoveDate 2020-07-11T00:00Z ` + -SodViolationContext null ` + -PreApprovalTriggerResult null ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} +``` + +- Convert the resource to JSON +```powershell +$CompletedApproval | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CompletedApprovalPreApprovalTriggerResult.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CompletedApprovalPreApprovalTriggerResult.md new file mode 100644 index 000000000..5d8b20c36 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CompletedApprovalPreApprovalTriggerResult.md @@ -0,0 +1,41 @@ +--- +id: v2024-completed-approval-pre-approval-trigger-result +title: CompletedApprovalPreApprovalTriggerResult +pagination_label: CompletedApprovalPreApprovalTriggerResult +sidebar_label: CompletedApprovalPreApprovalTriggerResult +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CompletedApprovalPreApprovalTriggerResult', 'V2024CompletedApprovalPreApprovalTriggerResult'] +slug: /tools/sdk/powershell/v2024/models/completed-approval-pre-approval-trigger-result +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalPreApprovalTriggerResult', 'V2024CompletedApprovalPreApprovalTriggerResult'] +--- + + +# CompletedApprovalPreApprovalTriggerResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | The comment from the trigger | [optional] +**Decision** | Pointer to [**CompletedApprovalState**](completed-approval-state) | | [optional] +**Reviewer** | Pointer to **String** | The name of the approver | [optional] +**Date** | Pointer to **System.DateTime** | The date and time the trigger decided on the request | [optional] + +## Examples + +- Prepare the resource +```powershell +$CompletedApprovalPreApprovalTriggerResult = Initialize-PSSailpoint.V2024CompletedApprovalPreApprovalTriggerResult -Comment This request was autoapproved by our automated ETS subscriber ` + -Decision null ` + -Reviewer Automated AR Approval ` + -Date 2022-06-07T19:18:40.748Z +``` + +- Convert the resource to JSON +```powershell +$CompletedApprovalPreApprovalTriggerResult | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CompletedApprovalRequesterComment.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CompletedApprovalRequesterComment.md new file mode 100644 index 000000000..e15a0f315 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CompletedApprovalRequesterComment.md @@ -0,0 +1,39 @@ +--- +id: v2024-completed-approval-requester-comment +title: CompletedApprovalRequesterComment +pagination_label: CompletedApprovalRequesterComment +sidebar_label: CompletedApprovalRequesterComment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CompletedApprovalRequesterComment', 'V2024CompletedApprovalRequesterComment'] +slug: /tools/sdk/powershell/v2024/models/completed-approval-requester-comment +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalRequesterComment', 'V2024CompletedApprovalRequesterComment'] +--- + + +# CompletedApprovalRequesterComment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment content. | [optional] +**Created** | Pointer to **System.DateTime** | Date and time comment was created. | [optional] +**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CompletedApprovalRequesterComment = Initialize-PSSailpoint.V2024CompletedApprovalRequesterComment -Comment This is a comment. ` + -Created 2017-07-11T18:45:37.098Z ` + -Author null +``` + +- Convert the resource to JSON +```powershell +$CompletedApprovalRequesterComment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CompletedApprovalReviewerComment.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CompletedApprovalReviewerComment.md new file mode 100644 index 000000000..8faaf2d9f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CompletedApprovalReviewerComment.md @@ -0,0 +1,39 @@ +--- +id: v2024-completed-approval-reviewer-comment +title: CompletedApprovalReviewerComment +pagination_label: CompletedApprovalReviewerComment +sidebar_label: CompletedApprovalReviewerComment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CompletedApprovalReviewerComment', 'V2024CompletedApprovalReviewerComment'] +slug: /tools/sdk/powershell/v2024/models/completed-approval-reviewer-comment +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalReviewerComment', 'V2024CompletedApprovalReviewerComment'] +--- + + +# CompletedApprovalReviewerComment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment content. | [optional] +**Created** | Pointer to **System.DateTime** | Date and time comment was created. | [optional] +**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CompletedApprovalReviewerComment = Initialize-PSSailpoint.V2024CompletedApprovalReviewerComment -Comment This is a comment. ` + -Created 2017-07-11T18:45:37.098Z ` + -Author null +``` + +- Convert the resource to JSON +```powershell +$CompletedApprovalReviewerComment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CompletedApprovalState.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CompletedApprovalState.md new file mode 100644 index 000000000..11efc8b21 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CompletedApprovalState.md @@ -0,0 +1,24 @@ +--- +id: v2024-completed-approval-state +title: CompletedApprovalState +pagination_label: CompletedApprovalState +sidebar_label: CompletedApprovalState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CompletedApprovalState', 'V2024CompletedApprovalState'] +slug: /tools/sdk/powershell/v2024/models/completed-approval-state +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalState', 'V2024CompletedApprovalState'] +--- + + +# CompletedApprovalState + +## Enum + + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CompletionStatus.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CompletionStatus.md new file mode 100644 index 000000000..a240b4ce2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CompletionStatus.md @@ -0,0 +1,28 @@ +--- +id: v2024-completion-status +title: CompletionStatus +pagination_label: CompletionStatus +sidebar_label: CompletionStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CompletionStatus', 'V2024CompletionStatus'] +slug: /tools/sdk/powershell/v2024/models/completion-status +tags: ['SDK', 'Software Development Kit', 'CompletionStatus', 'V2024CompletionStatus'] +--- + + +# CompletionStatus + +## Enum + + +* `SUCCESS` (value: `"SUCCESS"`) + +* `FAILURE` (value: `"FAILURE"`) + +* `INCOMPLETE` (value: `"INCOMPLETE"`) + +* `PENDING` (value: `"PENDING"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Concatenation.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Concatenation.md new file mode 100644 index 000000000..4ab3af48b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Concatenation.md @@ -0,0 +1,39 @@ +--- +id: v2024-concatenation +title: Concatenation +pagination_label: Concatenation +sidebar_label: Concatenation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Concatenation', 'V2024Concatenation'] +slug: /tools/sdk/powershell/v2024/models/concatenation +tags: ['SDK', 'Software Development Kit', 'Concatenation', 'V2024Concatenation'] +--- + + +# Concatenation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Values** | [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | An array of items to join together | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$Concatenation = Initialize-PSSailpoint.V2024Concatenation -Values [John, , Smith] ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Concatenation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConditionEffect.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConditionEffect.md new file mode 100644 index 000000000..78b87df42 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConditionEffect.md @@ -0,0 +1,37 @@ +--- +id: v2024-condition-effect +title: ConditionEffect +pagination_label: ConditionEffect +sidebar_label: ConditionEffect +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConditionEffect', 'V2024ConditionEffect'] +slug: /tools/sdk/powershell/v2024/models/condition-effect +tags: ['SDK', 'Software Development Kit', 'ConditionEffect', 'V2024ConditionEffect'] +--- + + +# ConditionEffect + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EffectType** | Pointer to **Enum** [ "HIDE", "SHOW", "DISABLE", "ENABLE", "REQUIRE", "OPTIONAL", "SUBMIT_MESSAGE", "SUBMIT_NOTIFICATION", "SET_DEFAULT_VALUE" ] | Type of effect to perform when the conditions are evaluated for this logic block. HIDE ConditionEffectTypeHide Disables validations. SHOW ConditionEffectTypeShow Enables validations. DISABLE ConditionEffectTypeDisable Disables validations. ENABLE ConditionEffectTypeEnable Enables validations. REQUIRE ConditionEffectTypeRequire OPTIONAL ConditionEffectTypeOptional SUBMIT_MESSAGE ConditionEffectTypeSubmitMessage SUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification SET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue This value is ignored on purpose. | [optional] +**Config** | Pointer to [**ConditionEffectConfig**](condition-effect-config) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConditionEffect = Initialize-PSSailpoint.V2024ConditionEffect -EffectType HIDE ` + -Config null +``` + +- Convert the resource to JSON +```powershell +$ConditionEffect | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConditionEffectConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConditionEffectConfig.md new file mode 100644 index 000000000..809e96916 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConditionEffectConfig.md @@ -0,0 +1,37 @@ +--- +id: v2024-condition-effect-config +title: ConditionEffectConfig +pagination_label: ConditionEffectConfig +sidebar_label: ConditionEffectConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConditionEffectConfig', 'V2024ConditionEffectConfig'] +slug: /tools/sdk/powershell/v2024/models/condition-effect-config +tags: ['SDK', 'Software Development Kit', 'ConditionEffectConfig', 'V2024ConditionEffectConfig'] +--- + + +# ConditionEffectConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DefaultValueLabel** | Pointer to **String** | Effect type's label. | [optional] +**Element** | Pointer to **String** | Element's identifier. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConditionEffectConfig = Initialize-PSSailpoint.V2024ConditionEffectConfig -DefaultValueLabel Access to Remove ` + -Element 8110662963316867 +``` + +- Convert the resource to JSON +```powershell +$ConditionEffectConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConditionRule.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConditionRule.md new file mode 100644 index 000000000..33fef274d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConditionRule.md @@ -0,0 +1,43 @@ +--- +id: v2024-condition-rule +title: ConditionRule +pagination_label: ConditionRule +sidebar_label: ConditionRule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConditionRule', 'V2024ConditionRule'] +slug: /tools/sdk/powershell/v2024/models/condition-rule +tags: ['SDK', 'Software Development Kit', 'ConditionRule', 'V2024ConditionRule'] +--- + + +# ConditionRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceType** | Pointer to **Enum** [ "INPUT", "ELEMENT" ] | Defines the type of object being selected. It will be either a reference to a form input (by input name) or a form element (by technical key). INPUT ConditionRuleSourceTypeInput ELEMENT ConditionRuleSourceTypeElement | [optional] +**Source** | Pointer to **String** | Source - if the sourceType is ConditionRuleSourceTypeInput, the source type is the name of the form input to accept. However, if the sourceType is ConditionRuleSourceTypeElement, the source is the name of a technical key of an element to retrieve its value. | [optional] +**Operator** | Pointer to **Enum** [ "EQ", "NE", "CO", "NOT_CO", "IN", "NOT_IN", "EM", "NOT_EM", "SW", "NOT_SW", "EW", "NOT_EW" ] | ConditionRuleComparisonOperatorType value. EQ ConditionRuleComparisonOperatorTypeEquals This comparison operator compares the source and target for equality. NE ConditionRuleComparisonOperatorTypeNotEquals This comparison operator compares the source and target for inequality. CO ConditionRuleComparisonOperatorTypeContains This comparison operator searches the source to see whether it contains the value. NOT_CO ConditionRuleComparisonOperatorTypeNotContains IN ConditionRuleComparisonOperatorTypeIncludes This comparison operator searches the source if it equals any of the values. NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes EM ConditionRuleComparisonOperatorTypeEmpty NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty SW ConditionRuleComparisonOperatorTypeStartsWith Checks whether a string starts with another substring of the same string. This operator is case-sensitive. NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith EW ConditionRuleComparisonOperatorTypeEndsWith Checks whether a string ends with another substring of the same string. This operator is case-sensitive. NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith | [optional] +**ValueType** | Pointer to **Enum** [ "STRING", "STRING_LIST", "INPUT", "ELEMENT", "LIST", "BOOLEAN" ] | ConditionRuleValueType type. STRING ConditionRuleValueTypeString This value is a static string. STRING_LIST ConditionRuleValueTypeStringList This value is an array of string values. INPUT ConditionRuleValueTypeInput This value is a reference to a form input. ELEMENT ConditionRuleValueTypeElement This value is a reference to a form element (by technical key). LIST ConditionRuleValueTypeList BOOLEAN ConditionRuleValueTypeBoolean | [optional] +**Value** | Pointer to **String** | Based on the ValueType. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConditionRule = Initialize-PSSailpoint.V2024ConditionRule -SourceType ELEMENT ` + -Source department ` + -Operator EQ ` + -ValueType STRING ` + -Value Engineering +``` + +- Convert the resource to JSON +```powershell +$ConditionRule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Conditional.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Conditional.md new file mode 100644 index 000000000..a31f7c482 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Conditional.md @@ -0,0 +1,43 @@ +--- +id: v2024-conditional +title: Conditional +pagination_label: Conditional +sidebar_label: Conditional +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Conditional', 'V2024Conditional'] +slug: /tools/sdk/powershell/v2024/models/conditional +tags: ['SDK', 'Software Development Kit', 'Conditional', 'V2024Conditional'] +--- + + +# Conditional + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Expression** | **String** | A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. The `eq` operator is the only valid comparison | [required] +**PositiveCondition** | **String** | The output of the transform if the expression evalutes to true | [required] +**NegativeCondition** | **String** | The output of the transform if the expression evalutes to false | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$Conditional = Initialize-PSSailpoint.V2024Conditional -Expression ValueA eq ValueB ` + -PositiveCondition true ` + -NegativeCondition false ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Conditional | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConfigObject.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConfigObject.md new file mode 100644 index 000000000..71edfea00 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConfigObject.md @@ -0,0 +1,39 @@ +--- +id: v2024-config-object +title: ConfigObject +pagination_label: ConfigObject +sidebar_label: ConfigObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigObject', 'V2024ConfigObject'] +slug: /tools/sdk/powershell/v2024/models/config-object +tags: ['SDK', 'Software Development Kit', 'ConfigObject', 'V2024ConfigObject'] +--- + + +# ConfigObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | Pointer to **Int32** | Current version of configuration object. | [optional] +**Self** | Pointer to [**SelfImportExportDto**](self-import-export-dto) | | [optional] +**Object** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Object details. Format dependant on the object type. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConfigObject = Initialize-PSSailpoint.V2024ConfigObject -Version 1 ` + -Self null ` + -Object null +``` + +- Convert the resource to JSON +```powershell +$ConfigObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConfigType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConfigType.md new file mode 100644 index 000000000..48555e001 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConfigType.md @@ -0,0 +1,43 @@ +--- +id: v2024-config-type +title: ConfigType +pagination_label: ConfigType +sidebar_label: ConfigType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigType', 'V2024ConfigType'] +slug: /tools/sdk/powershell/v2024/models/config-type +tags: ['SDK', 'Software Development Kit', 'ConfigType', 'V2024ConfigType'] +--- + + +# ConfigType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Priority** | Pointer to **Int32** | | [optional] +**InternalName** | Pointer to [**ConfigTypeEnumCamel**](config-type-enum-camel) | | [optional] +**InternalNameCamel** | Pointer to [**ConfigTypeEnum**](config-type-enum) | | [optional] +**DisplayName** | Pointer to **String** | Human readable display name of the type to be shown on UI | [optional] +**Description** | Pointer to **String** | Description of the type of work to be reassigned, displayed by the UI. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConfigType = Initialize-PSSailpoint.V2024ConfigType -Priority 1 ` + -InternalName null ` + -InternalNameCamel null ` + -DisplayName Access Requests ` + -Description Reassign Access Request Work Items for an identity +``` + +- Convert the resource to JSON +```powershell +$ConfigType | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConfigTypeEnum.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConfigTypeEnum.md new file mode 100644 index 000000000..321050813 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConfigTypeEnum.md @@ -0,0 +1,26 @@ +--- +id: v2024-config-type-enum +title: ConfigTypeEnum +pagination_label: ConfigTypeEnum +sidebar_label: ConfigTypeEnum +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigTypeEnum', 'V2024ConfigTypeEnum'] +slug: /tools/sdk/powershell/v2024/models/config-type-enum +tags: ['SDK', 'Software Development Kit', 'ConfigTypeEnum', 'V2024ConfigTypeEnum'] +--- + + +# ConfigTypeEnum + +## Enum + + +* `ACCESS_REQUESTS` (value: `"ACCESS_REQUESTS"`) + +* `CERTIFICATIONS` (value: `"CERTIFICATIONS"`) + +* `MANUAL_TASKS` (value: `"MANUAL_TASKS"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConfigTypeEnumCamel.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConfigTypeEnumCamel.md new file mode 100644 index 000000000..2f30c586e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConfigTypeEnumCamel.md @@ -0,0 +1,26 @@ +--- +id: v2024-config-type-enum-camel +title: ConfigTypeEnumCamel +pagination_label: ConfigTypeEnumCamel +sidebar_label: ConfigTypeEnumCamel +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigTypeEnumCamel', 'V2024ConfigTypeEnumCamel'] +slug: /tools/sdk/powershell/v2024/models/config-type-enum-camel +tags: ['SDK', 'Software Development Kit', 'ConfigTypeEnumCamel', 'V2024ConfigTypeEnumCamel'] +--- + + +# ConfigTypeEnumCamel + +## Enum + + +* `accessRequests` (value: `"accessRequests"`) + +* `certifications` (value: `"certifications"`) + +* `manualTasks` (value: `"manualTasks"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConfigurationDetailsResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConfigurationDetailsResponse.md new file mode 100644 index 000000000..b364da137 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConfigurationDetailsResponse.md @@ -0,0 +1,43 @@ +--- +id: v2024-configuration-details-response +title: ConfigurationDetailsResponse +pagination_label: ConfigurationDetailsResponse +sidebar_label: ConfigurationDetailsResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigurationDetailsResponse', 'V2024ConfigurationDetailsResponse'] +slug: /tools/sdk/powershell/v2024/models/configuration-details-response +tags: ['SDK', 'Software Development Kit', 'ConfigurationDetailsResponse', 'V2024ConfigurationDetailsResponse'] +--- + + +# ConfigurationDetailsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConfigType** | Pointer to [**ConfigTypeEnum**](config-type-enum) | | [optional] +**TargetIdentity** | Pointer to [**Identity1**](identity1) | | [optional] +**StartDate** | Pointer to **System.DateTime** | The date from which to start reassigning work items | [optional] +**EndDate** | Pointer to **System.DateTime** | The date from which to stop reassigning work items. If this is an empty string it indicates a permanent reassignment. | [optional] +**AuditDetails** | Pointer to [**AuditDetails**](audit-details) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConfigurationDetailsResponse = Initialize-PSSailpoint.V2024ConfigurationDetailsResponse -ConfigType null ` + -TargetIdentity null ` + -StartDate 2022-07-21T11:13:12.345Z ` + -EndDate 0001-01-01T00:00Z ` + -AuditDetails null +``` + +- Convert the resource to JSON +```powershell +$ConfigurationDetailsResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConfigurationItemRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConfigurationItemRequest.md new file mode 100644 index 000000000..16164be6b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConfigurationItemRequest.md @@ -0,0 +1,43 @@ +--- +id: v2024-configuration-item-request +title: ConfigurationItemRequest +pagination_label: ConfigurationItemRequest +sidebar_label: ConfigurationItemRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigurationItemRequest', 'V2024ConfigurationItemRequest'] +slug: /tools/sdk/powershell/v2024/models/configuration-item-request +tags: ['SDK', 'Software Development Kit', 'ConfigurationItemRequest', 'V2024ConfigurationItemRequest'] +--- + + +# ConfigurationItemRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReassignedFromId** | Pointer to **String** | The identity id to reassign an item from | [optional] +**ReassignedToId** | Pointer to **String** | The identity id to reassign an item to | [optional] +**ConfigType** | Pointer to [**ConfigTypeEnum**](config-type-enum) | | [optional] +**StartDate** | Pointer to **System.DateTime** | The date from which to start reassigning work items | [optional] +**EndDate** | Pointer to **System.DateTime** | The date from which to stop reassigning work items. If this is an null string it indicates a permanent reassignment. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConfigurationItemRequest = Initialize-PSSailpoint.V2024ConfigurationItemRequest -ReassignedFromId 2c91808781a71ddb0181b9090b5c504e ` + -ReassignedToId 2c91808781a71ddb0181b9090b53504a ` + -ConfigType null ` + -StartDate 2022-07-21T11:13:12.345Z ` + -EndDate 2022-07-30T17:00Z +``` + +- Convert the resource to JSON +```powershell +$ConfigurationItemRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConfigurationItemResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConfigurationItemResponse.md new file mode 100644 index 000000000..c5374109d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConfigurationItemResponse.md @@ -0,0 +1,37 @@ +--- +id: v2024-configuration-item-response +title: ConfigurationItemResponse +pagination_label: ConfigurationItemResponse +sidebar_label: ConfigurationItemResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigurationItemResponse', 'V2024ConfigurationItemResponse'] +slug: /tools/sdk/powershell/v2024/models/configuration-item-response +tags: ['SDK', 'Software Development Kit', 'ConfigurationItemResponse', 'V2024ConfigurationItemResponse'] +--- + + +# ConfigurationItemResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to [**Identity1**](identity1) | | [optional] +**ConfigDetails** | Pointer to [**[]ConfigurationDetailsResponse**](configuration-details-response) | Details of how work should be reassigned for an Identity | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConfigurationItemResponse = Initialize-PSSailpoint.V2024ConfigurationItemResponse -Identity null ` + -ConfigDetails null +``` + +- Convert the resource to JSON +```powershell +$ConfigurationItemResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConfigurationResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConfigurationResponse.md new file mode 100644 index 000000000..e62ee5b6b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConfigurationResponse.md @@ -0,0 +1,37 @@ +--- +id: v2024-configuration-response +title: ConfigurationResponse +pagination_label: ConfigurationResponse +sidebar_label: ConfigurationResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigurationResponse', 'V2024ConfigurationResponse'] +slug: /tools/sdk/powershell/v2024/models/configuration-response +tags: ['SDK', 'Software Development Kit', 'ConfigurationResponse', 'V2024ConfigurationResponse'] +--- + + +# ConfigurationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to [**Identity1**](identity1) | | [optional] +**ConfigDetails** | Pointer to [**[]ConfigurationDetailsResponse**](configuration-details-response) | Details of how work should be reassigned for an Identity | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConfigurationResponse = Initialize-PSSailpoint.V2024ConfigurationResponse -Identity null ` + -ConfigDetails null +``` + +- Convert the resource to JSON +```powershell +$ConfigurationResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConflictingAccessCriteria.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConflictingAccessCriteria.md new file mode 100644 index 000000000..e524910c8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConflictingAccessCriteria.md @@ -0,0 +1,37 @@ +--- +id: v2024-conflicting-access-criteria +title: ConflictingAccessCriteria +pagination_label: ConflictingAccessCriteria +sidebar_label: ConflictingAccessCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConflictingAccessCriteria', 'V2024ConflictingAccessCriteria'] +slug: /tools/sdk/powershell/v2024/models/conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'ConflictingAccessCriteria', 'V2024ConflictingAccessCriteria'] +--- + + +# ConflictingAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] +**RightCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConflictingAccessCriteria = Initialize-PSSailpoint.V2024ConflictingAccessCriteria -LeftCriteria null ` + -RightCriteria null +``` + +- Convert the resource to JSON +```powershell +$ConflictingAccessCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectedObject.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectedObject.md new file mode 100644 index 000000000..93103643a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectedObject.md @@ -0,0 +1,41 @@ +--- +id: v2024-connected-object +title: ConnectedObject +pagination_label: ConnectedObject +sidebar_label: ConnectedObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectedObject', 'V2024ConnectedObject'] +slug: /tools/sdk/powershell/v2024/models/connected-object +tags: ['SDK', 'Software Development Kit', 'ConnectedObject', 'V2024ConnectedObject'] +--- + + +# ConnectedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**ConnectedObjectType**](connected-object-type) | | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable name of Connected object | [optional] +**Description** | Pointer to **String** | Description of the Connected object. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConnectedObject = Initialize-PSSailpoint.V2024ConnectedObject -Type null ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name Employee-database-read-write ` + -Description Collection of entitlements to read/write the employee database. +``` + +- Convert the resource to JSON +```powershell +$ConnectedObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectedObjectType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectedObjectType.md new file mode 100644 index 000000000..bd45cdf5f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectedObjectType.md @@ -0,0 +1,28 @@ +--- +id: v2024-connected-object-type +title: ConnectedObjectType +pagination_label: ConnectedObjectType +sidebar_label: ConnectedObjectType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectedObjectType', 'V2024ConnectedObjectType'] +slug: /tools/sdk/powershell/v2024/models/connected-object-type +tags: ['SDK', 'Software Development Kit', 'ConnectedObjectType', 'V2024ConnectedObjectType'] +--- + + +# ConnectedObjectType + +## Enum + + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ROLE` (value: `"ROLE"`) + +* `SOD_POLICY` (value: `"SOD_POLICY"`) + +* `SOURCE` (value: `"SOURCE"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectorDetail.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectorDetail.md new file mode 100644 index 000000000..2ebfd2682 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectorDetail.md @@ -0,0 +1,116 @@ +--- +id: v2024-connector-detail +title: ConnectorDetail +pagination_label: ConnectorDetail +sidebar_label: ConnectorDetail +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorDetail', 'V2024ConnectorDetail'] +slug: /tools/sdk/powershell/v2024/models/connector-detail +tags: ['SDK', 'Software Development Kit', 'ConnectorDetail', 'V2024ConnectorDetail'] +--- + + +# ConnectorDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The connector name | [optional] +**Type** | Pointer to **String** | The connector type | [optional] +**ClassName** | Pointer to **String** | The connector class name | [optional] +**ScriptName** | Pointer to **String** | The connector script name | [optional] +**ApplicationXml** | Pointer to **String** | The connector application xml | [optional] +**CorrelationConfigXml** | Pointer to **String** | The connector correlation config xml | [optional] +**SourceConfigXml** | Pointer to **String** | The connector source config xml | [optional] +**SourceConfig** | Pointer to **String** | The connector source config | [optional] +**SourceConfigFrom** | Pointer to **String** | The connector source config origin | [optional] +**S3Location** | Pointer to **String** | storage path key for this connector | [optional] +**UploadedFiles** | Pointer to **[]String** | The list of uploaded files supported by the connector. If there was any executable files uploaded to thee connector. Typically this be empty as the executable be uploaded at source creation. | [optional] +**FileUpload** | Pointer to **Boolean** | true if the source is file upload | [optional] [default to $false] +**DirectConnect** | Pointer to **Boolean** | true if the source is a direct connect source | [optional] [default to $false] +**TranslationProperties** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map containing translation attributes by loacale key | [optional] +**ConnectorMetadata** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map containing metadata pertinent to the UI to be used | [optional] +**Status** | Pointer to **Enum** [ "DEPRECATED", "DEVELOPMENT", "DEMO", "RELEASED" ] | The connector status | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConnectorDetail = Initialize-PSSailpoint.V2024ConnectorDetail -Name name ` + -Type ServiceNow ` + -ClassName class name ` + -ScriptName servicenow ` + -ApplicationXml <?xml version='1.0' encoding='UTF-8'?> +<!DOCTYPE Application PUBLIC "sailpoint.dtd" "sailpoint.dtd"> +<Application connector="sailpoint.connector.OpenConnectorAdapter" name="custom Atlassian Suite - Cloud" type="custom Atlassian Suite - Cloud"/> + ` + -CorrelationConfigXml <?xml version='1.0' encoding='UTF-8'?> +<!-- Copyright (C) 2021 SailPoint Technologies, Inc. All rights reserved. --> + +<!DOCTYPE CorrelationConfig PUBLIC "sailpoint.dtd" "sailpoint.dtd"> + +<CorrelationConfig name="custom Atlassian Suite - Cloud Account Correlation Config"> + <AttributeAssignments> + <Filter operation="EQ" property="email" value="mail"/> + <Filter operation="EQ" property="empId" value="employeeNumber"/> + <Filter operation="EQ" property="displayName" value="cn"/> + </AttributeAssignments> +</CorrelationConfig> + ` + -SourceConfigXml <?xml version="1.0" encoding="UTF-8" standalone="no"?><!-- Copyright (C) 2023 SailPoint Technologies, Inc. All rights reserved. --><Form xmlns="http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd" connectorName="custom Atlassian Suite - Cloud" directConnect="true" fileUpload="true" name="Custom Atlassian Suite - Cloud" status="released" type="SourceConfig"> + <BaseConfig> + <Field maxFiles="10" maxSize="300" name="fileUpload" supportedExtensions="jar" type="fileupload" validateJSON="false"/> + </BaseConfig> + + + +</Form> ` + -SourceConfig <?xml version="1.0" encoding="UTF-8" standalone="no"?><!-- Copyright (C) 2023 SailPoint Technologies, Inc. All rights reserved. --><Form xmlns="http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd" connectorName="custom Atlassian Suite - Cloud" directConnect="true" fileUpload="true" name="Custom Atlassian Suite - Cloud" status="released" type="SourceConfig"> + <BaseConfig> + <Field maxFiles="10" maxSize="300" name="fileUpload" supportedExtensions="jar" type="fileupload" validateJSON="false"/> + </BaseConfig> + + + +</Form> ` + -SourceConfigFrom sp-connect ` + -S3Location custom-connector/scriptname ` + -UploadedFiles [pod/org/connectorFiles/testconnector/test1.jar] ` + -FileUpload true ` + -DirectConnect true ` + -TranslationProperties {de=# Copyright (C) 2024 SailPoint Technologies, Inc. All rights reserved. +# DO NOT EDIT. This file is generated by "sailpointTranslate" command. +menuLabel_ConnectionSettings=Verbindungseinstellungen +menuLabel_AggregationSettings=Aggregationseinstellungen +sectionLabel_AuthenticationSettings=Verbindungseinstellungen +sectionLabel_AggregationSettings=Aggregationseinstellungen +sectionInfo_AuthenticationSettings=Konfigurieren Sie eine direkte Verbindung zwischen der Quelle Delinea Secret Server On-Premise und IdentityNow.<br><br>Geben Sie bei <strong>Zeit\u00fcberschreitung bei Verbindung</strong> die maximal erlaubte Zeitdauer (in Minuten) f\u00fcr die Verbindung von IdentityNow mit der Quelle ein.<br><br>Geben Sie die <strong>Host-URL</strong> der Delinea-SCIM-Serverquelle ein.<br><br>Geben Sie den <strong>API-Token</strong> der Quelle zur Authentifizierung ein. +sectionInfo_AggregationSettings=Geben Sie die Einstellungen f\u00fcr Ihre Aggregation an.<br><br>Geben Sie in das Feld <strong>Seitengr\u00f6\u00dfe</strong> die Anzahl an Kontoeintr\u00e4gen ein, die auf einer einzelnen Seite aggregiert werden sollen, wenn gro\u00dfe Datens\u00e4tze durchlaufen werden.<br>\n<br>Geben Sie im <strong>Kontofilter</strong> die Bedingungen f\u00fcr den Kontofilter an. Beispiel: userName sw "S"<br><br>Geben Sie im <strong>Gruppenfilter</strong> die Gruppenfilterbedingungen an. Beispiel: displayName sw "S". +placeHolder_accAggregation=userName sw "S" +placeHolder_grpAggregation=displayName sw "S" +placeHolder_host=https://{Delinea_SCIM_Server_host}/v2 +docLinkLabel_AuthenticationSettings=Mehr \u00fcber Verbindungseinstellungen +docLinkLabel_Filters=Mehr \u00fcber Konto- und Gruppenfilter +HostURL=Host-URL +ConnectionTimeout=Zeit\u00fcberschreitung bei Verbindung +API_TOKEN=API-Token +JSONPathMapping=JSON-Path-Attribut-Mapping +FilterConditionForAccounts=Kontofilter +FilterConditionForGroups=Gruppenfilter +Page_Size=Seitengr\u00f6\u00dfe +SchemaAttribute=Schema-Attribut +JSONpath=JSON-Pfad +ShortDesc=Das Integrationsmodul IdentityNow f\u00fcr Delinea Secret Server On-Premise bietet die M\u00f6glichkeit einer tiefen Governance f\u00fcr Konten und Gruppen. Es unterst\u00fctzt au\u00dferdem das End-to-End-Lebenszyklus-Management.} ` + -ConnectorMetadata {supportedUI=EXTJS, platform=ccg, shortDesc=connector description} ` + -Status RELEASED +``` + +- Convert the resource to JSON +```powershell +$ConnectorDetail | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectorDetail1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectorDetail1.md new file mode 100644 index 000000000..68404f45c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectorDetail1.md @@ -0,0 +1,48 @@ +--- +id: v2024-connector-detail1 +title: ConnectorDetail1 +pagination_label: ConnectorDetail1 +sidebar_label: ConnectorDetail1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorDetail1', 'V2024ConnectorDetail1'] +slug: /tools/sdk/powershell/v2024/models/connector-detail1 +tags: ['SDK', 'Software Development Kit', 'ConnectorDetail1', 'V2024ConnectorDetail1'] +--- + + +# ConnectorDetail1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The connector name | [optional] +**SourceConfigXml** | Pointer to **String** | XML representation of the source config data | [optional] +**SourceConfig** | Pointer to **String** | JSON representation of the source config data | [optional] +**DirectConnect** | Pointer to **Boolean** | true if the source is a direct connect source | [optional] +**FileUpload** | Pointer to **Boolean** | Connector config's file upload attribute, false if not there | [optional] +**UploadedFiles** | Pointer to **String** | List of uploaded file strings for the connector | [optional] +**ConnectorMetadata** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Object containing metadata pertinent to the UI to be used | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConnectorDetail1 = Initialize-PSSailpoint.V2024ConnectorDetail1 -Name JDBC ` + -SourceConfigXml <Form connectorName='Active Directory - Direct' directConnect='true' name='Active Directory' status='released' type='SourceConfig' xmlns='http://www.sailpoint.com/xsd/sailpoint_form_1_0.xsd'> + <Field defaultValue='true' hidden='true' name='cloudAuthEnabled' type='boolean' value='true'> </Field> </Form> ` + -SourceConfig {Form={Field={_defaultValue=true, _hidden=true, _name=cloudAuthEnabled, _type=boolean, _value=true}, _xmlns=http://www.sailpoint.com/xsd/sailpoint_form_1_0.xsd, _connectorName=Active Directory - Direct, _directConnect=true, _name=Active Directory, _status=released, _type=SourceConfig, __text=\n\t}} ` + -DirectConnect true ` + -FileUpload false ` + -UploadedFiles [] ` + -ConnectorMetadata {supportedUI=EXTJS} +``` + +- Convert the resource to JSON +```powershell +$ConnectorDetail1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectorRuleCreateRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectorRuleCreateRequest.md new file mode 100644 index 000000000..ef3e3935d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectorRuleCreateRequest.md @@ -0,0 +1,45 @@ +--- +id: v2024-connector-rule-create-request +title: ConnectorRuleCreateRequest +pagination_label: ConnectorRuleCreateRequest +sidebar_label: ConnectorRuleCreateRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorRuleCreateRequest', 'V2024ConnectorRuleCreateRequest'] +slug: /tools/sdk/powershell/v2024/models/connector-rule-create-request +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleCreateRequest', 'V2024ConnectorRuleCreateRequest'] +--- + + +# ConnectorRuleCreateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | the name of the rule | [required] +**Description** | Pointer to **String** | a description of the rule's purpose | [optional] +**Type** | **Enum** [ "BuildMap", "ConnectorAfterCreate", "ConnectorAfterDelete", "ConnectorAfterModify", "ConnectorBeforeCreate", "ConnectorBeforeDelete", "ConnectorBeforeModify", "JDBCBuildMap", "JDBCOperationProvisioning", "JDBCProvision", "PeopleSoftHRMSBuildMap", "PeopleSoftHRMSOperationProvisioning", "PeopleSoftHRMSProvision", "RACFPermissionCustomization", "SAPBuildMap", "SapHrManagerRule", "SapHrOperationProvisioning", "SapHrProvision", "SuccessFactorsOperationProvisioning", "WebServiceAfterOperationRule", "WebServiceBeforeOperationRule" ] | the type of rule | [required] +**Signature** | Pointer to [**ConnectorRuleCreateRequestSignature**](connector-rule-create-request-signature) | | [optional] +**SourceCode** | [**SourceCode**](source-code) | | [required] +**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | a map of string to objects | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConnectorRuleCreateRequest = Initialize-PSSailpoint.V2024ConnectorRuleCreateRequest -Name WebServiceBeforeOperationRule ` + -Description This rule does that ` + -Type BuildMap ` + -Signature null ` + -SourceCode null ` + -Attributes {} +``` + +- Convert the resource to JSON +```powershell +$ConnectorRuleCreateRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectorRuleCreateRequestSignature.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectorRuleCreateRequestSignature.md new file mode 100644 index 000000000..8138faeba --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectorRuleCreateRequestSignature.md @@ -0,0 +1,37 @@ +--- +id: v2024-connector-rule-create-request-signature +title: ConnectorRuleCreateRequestSignature +pagination_label: ConnectorRuleCreateRequestSignature +sidebar_label: ConnectorRuleCreateRequestSignature +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorRuleCreateRequestSignature', 'V2024ConnectorRuleCreateRequestSignature'] +slug: /tools/sdk/powershell/v2024/models/connector-rule-create-request-signature +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleCreateRequestSignature', 'V2024ConnectorRuleCreateRequestSignature'] +--- + + +# ConnectorRuleCreateRequestSignature + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarInput** | [**[]Argument**](argument) | | [required] +**Output** | Pointer to [**Argument**](argument) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConnectorRuleCreateRequestSignature = Initialize-PSSailpoint.V2024ConnectorRuleCreateRequestSignature -VarInput null ` + -Output null +``` + +- Convert the resource to JSON +```powershell +$ConnectorRuleCreateRequestSignature | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectorRuleResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectorRuleResponse.md new file mode 100644 index 000000000..95c85e9ad --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectorRuleResponse.md @@ -0,0 +1,51 @@ +--- +id: v2024-connector-rule-response +title: ConnectorRuleResponse +pagination_label: ConnectorRuleResponse +sidebar_label: ConnectorRuleResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorRuleResponse', 'V2024ConnectorRuleResponse'] +slug: /tools/sdk/powershell/v2024/models/connector-rule-response +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleResponse', 'V2024ConnectorRuleResponse'] +--- + + +# ConnectorRuleResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | the name of the rule | [required] +**Description** | Pointer to **String** | a description of the rule's purpose | [optional] +**Type** | **Enum** [ "BuildMap", "ConnectorAfterCreate", "ConnectorAfterDelete", "ConnectorAfterModify", "ConnectorBeforeCreate", "ConnectorBeforeDelete", "ConnectorBeforeModify", "JDBCBuildMap", "JDBCOperationProvisioning", "JDBCProvision", "PeopleSoftHRMSBuildMap", "PeopleSoftHRMSOperationProvisioning", "PeopleSoftHRMSProvision", "RACFPermissionCustomization", "SAPBuildMap", "SapHrManagerRule", "SapHrOperationProvisioning", "SapHrProvision", "SuccessFactorsOperationProvisioning", "WebServiceAfterOperationRule", "WebServiceBeforeOperationRule" ] | the type of rule | [required] +**Signature** | Pointer to [**ConnectorRuleCreateRequestSignature**](connector-rule-create-request-signature) | | [optional] +**SourceCode** | [**SourceCode**](source-code) | | [required] +**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | a map of string to objects | [optional] +**Id** | **String** | the ID of the rule | [required] +**Created** | **String** | an ISO 8601 UTC timestamp when this rule was created | [required] +**Modified** | Pointer to **String** | an ISO 8601 UTC timestamp when this rule was last modified | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConnectorRuleResponse = Initialize-PSSailpoint.V2024ConnectorRuleResponse -Name WebServiceBeforeOperationRule ` + -Description This rule does that ` + -Type BuildMap ` + -Signature null ` + -SourceCode null ` + -Attributes {} ` + -Id 8113d48c0b914f17b4c6072d4dcb9dfe ` + -Created 021-07-22T15:59:23Z ` + -Modified 021-07-22T15:59:23Z +``` + +- Convert the resource to JSON +```powershell +$ConnectorRuleResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectorRuleUpdateRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectorRuleUpdateRequest.md new file mode 100644 index 000000000..6825a3e41 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectorRuleUpdateRequest.md @@ -0,0 +1,47 @@ +--- +id: v2024-connector-rule-update-request +title: ConnectorRuleUpdateRequest +pagination_label: ConnectorRuleUpdateRequest +sidebar_label: ConnectorRuleUpdateRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorRuleUpdateRequest', 'V2024ConnectorRuleUpdateRequest'] +slug: /tools/sdk/powershell/v2024/models/connector-rule-update-request +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleUpdateRequest', 'V2024ConnectorRuleUpdateRequest'] +--- + + +# ConnectorRuleUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | the name of the rule | [required] +**Description** | Pointer to **String** | a description of the rule's purpose | [optional] +**Type** | **Enum** [ "BuildMap", "ConnectorAfterCreate", "ConnectorAfterDelete", "ConnectorAfterModify", "ConnectorBeforeCreate", "ConnectorBeforeDelete", "ConnectorBeforeModify", "JDBCBuildMap", "JDBCOperationProvisioning", "JDBCProvision", "PeopleSoftHRMSBuildMap", "PeopleSoftHRMSOperationProvisioning", "PeopleSoftHRMSProvision", "RACFPermissionCustomization", "SAPBuildMap", "SapHrManagerRule", "SapHrOperationProvisioning", "SapHrProvision", "SuccessFactorsOperationProvisioning", "WebServiceAfterOperationRule", "WebServiceBeforeOperationRule" ] | the type of rule | [required] +**Signature** | Pointer to [**ConnectorRuleCreateRequestSignature**](connector-rule-create-request-signature) | | [optional] +**SourceCode** | [**SourceCode**](source-code) | | [required] +**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | a map of string to objects | [optional] +**Id** | **String** | the ID of the rule to update | [required] + +## Examples + +- Prepare the resource +```powershell +$ConnectorRuleUpdateRequest = Initialize-PSSailpoint.V2024ConnectorRuleUpdateRequest -Name WebServiceBeforeOperationRule ` + -Description This rule does that ` + -Type BuildMap ` + -Signature null ` + -SourceCode null ` + -Attributes {} ` + -Id 8113d48c0b914f17b4c6072d4dcb9dfe +``` + +- Convert the resource to JSON +```powershell +$ConnectorRuleUpdateRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectorRuleValidationResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectorRuleValidationResponse.md new file mode 100644 index 000000000..3b3c83fec --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectorRuleValidationResponse.md @@ -0,0 +1,37 @@ +--- +id: v2024-connector-rule-validation-response +title: ConnectorRuleValidationResponse +pagination_label: ConnectorRuleValidationResponse +sidebar_label: ConnectorRuleValidationResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorRuleValidationResponse', 'V2024ConnectorRuleValidationResponse'] +slug: /tools/sdk/powershell/v2024/models/connector-rule-validation-response +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleValidationResponse', 'V2024ConnectorRuleValidationResponse'] +--- + + +# ConnectorRuleValidationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | **Enum** [ "OK", "ERROR" ] | | [required] +**Details** | [**[]ConnectorRuleValidationResponseDetailsInner**](connector-rule-validation-response-details-inner) | | [required] + +## Examples + +- Prepare the resource +```powershell +$ConnectorRuleValidationResponse = Initialize-PSSailpoint.V2024ConnectorRuleValidationResponse -State ERROR ` + -Details null +``` + +- Convert the resource to JSON +```powershell +$ConnectorRuleValidationResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectorRuleValidationResponseDetailsInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectorRuleValidationResponseDetailsInner.md new file mode 100644 index 000000000..2c3cbf9c9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ConnectorRuleValidationResponseDetailsInner.md @@ -0,0 +1,39 @@ +--- +id: v2024-connector-rule-validation-response-details-inner +title: ConnectorRuleValidationResponseDetailsInner +pagination_label: ConnectorRuleValidationResponseDetailsInner +sidebar_label: ConnectorRuleValidationResponseDetailsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorRuleValidationResponseDetailsInner', 'V2024ConnectorRuleValidationResponseDetailsInner'] +slug: /tools/sdk/powershell/v2024/models/connector-rule-validation-response-details-inner +tags: ['SDK', 'Software Development Kit', 'ConnectorRuleValidationResponseDetailsInner', 'V2024ConnectorRuleValidationResponseDetailsInner'] +--- + + +# ConnectorRuleValidationResponseDetailsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Line** | **Int32** | The line number where the issue occurred | [required] +**Column** | **Int32** | the column number where the issue occurred | [required] +**Messsage** | Pointer to **String** | a description of the issue in the code | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConnectorRuleValidationResponseDetailsInner = Initialize-PSSailpoint.V2024ConnectorRuleValidationResponseDetailsInner -Line 2 ` + -Column 5 ` + -Messsage Remove reference to .decrypt( +``` + +- Convert the resource to JSON +```powershell +$ConnectorRuleValidationResponseDetailsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ContextAttributeDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ContextAttributeDto.md new file mode 100644 index 000000000..cb9aa0350 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ContextAttributeDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-context-attribute-dto +title: ContextAttributeDto +pagination_label: ContextAttributeDto +sidebar_label: ContextAttributeDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ContextAttributeDto', 'V2024ContextAttributeDto'] +slug: /tools/sdk/powershell/v2024/models/context-attribute-dto +tags: ['SDK', 'Software Development Kit', 'ContextAttributeDto', 'V2024ContextAttributeDto'] +--- + + +# ContextAttributeDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attribute** | Pointer to **String** | The name of the attribute | [optional] +**Value** | Pointer to [**ContextAttributeDtoValue**](context-attribute-dto-value) | | [optional] +**Derived** | Pointer to **Boolean** | True if the attribute was derived. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$ContextAttributeDto = Initialize-PSSailpoint.V2024ContextAttributeDto -Attribute location ` + -Value null ` + -Derived false +``` + +- Convert the resource to JSON +```powershell +$ContextAttributeDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ContextAttributeDtoValue.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ContextAttributeDtoValue.md new file mode 100644 index 000000000..57333a0d3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ContextAttributeDtoValue.md @@ -0,0 +1,34 @@ +--- +id: v2024-context-attribute-dto-value +title: ContextAttributeDtoValue +pagination_label: ContextAttributeDtoValue +sidebar_label: ContextAttributeDtoValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ContextAttributeDtoValue', 'V2024ContextAttributeDtoValue'] +slug: /tools/sdk/powershell/v2024/models/context-attribute-dto-value +tags: ['SDK', 'Software Development Kit', 'ContextAttributeDtoValue', 'V2024ContextAttributeDtoValue'] +--- + + +# ContextAttributeDtoValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$ContextAttributeDtoValue = Initialize-PSSailpoint.V2024ContextAttributeDtoValue +``` + +- Convert the resource to JSON +```powershell +$ContextAttributeDtoValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CorrelatedGovernanceEvent.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CorrelatedGovernanceEvent.md new file mode 100644 index 000000000..286d4bc5a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CorrelatedGovernanceEvent.md @@ -0,0 +1,47 @@ +--- +id: v2024-correlated-governance-event +title: CorrelatedGovernanceEvent +pagination_label: CorrelatedGovernanceEvent +sidebar_label: CorrelatedGovernanceEvent +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CorrelatedGovernanceEvent', 'V2024CorrelatedGovernanceEvent'] +slug: /tools/sdk/powershell/v2024/models/correlated-governance-event +tags: ['SDK', 'Software Development Kit', 'CorrelatedGovernanceEvent', 'V2024CorrelatedGovernanceEvent'] +--- + + +# CorrelatedGovernanceEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the governance event, such as the certification name or access request ID. | [optional] +**Dt** | Pointer to **String** | The date that the certification or access request was completed. | [optional] +**Type** | Pointer to **Enum** [ "certification", "accessRequest" ] | The type of governance event. | [optional] +**GovernanceId** | Pointer to **String** | The ID of the instance that caused the event - either the certification ID or access request ID. | [optional] +**Owners** | Pointer to [**[]CertifierResponse**](certifier-response) | The owners of the governance event (the certifiers or approvers) | [optional] +**Reviewers** | Pointer to [**[]CertifierResponse**](certifier-response) | The owners of the governance event (the certifiers or approvers), this field should be preferred over owners | [optional] +**DecisionMaker** | Pointer to [**CertifierResponse**](certifier-response) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CorrelatedGovernanceEvent = Initialize-PSSailpoint.V2024CorrelatedGovernanceEvent -Name Manager Certification for Jon Snow ` + -Dt 2019-03-08T22:37:33.901Z ` + -Type certification ` + -GovernanceId 2c91808a77ff216301782327a50f09bf ` + -Owners [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` + -Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` + -DecisionMaker null +``` + +- Convert the resource to JSON +```powershell +$CorrelatedGovernanceEvent | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CorrelationConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CorrelationConfig.md new file mode 100644 index 000000000..a79dd3eb4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CorrelationConfig.md @@ -0,0 +1,39 @@ +--- +id: v2024-correlation-config +title: CorrelationConfig +pagination_label: CorrelationConfig +sidebar_label: CorrelationConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CorrelationConfig', 'V2024CorrelationConfig'] +slug: /tools/sdk/powershell/v2024/models/correlation-config +tags: ['SDK', 'Software Development Kit', 'CorrelationConfig', 'V2024CorrelationConfig'] +--- + + +# CorrelationConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of the correlation configuration. | [optional] +**Name** | Pointer to **String** | The name of the correlation configuration. | [optional] +**AttributeAssignments** | Pointer to [**[]CorrelationConfigAttributeAssignmentsInner**](correlation-config-attribute-assignments-inner) | The list of attribute assignments of the correlation configuration. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CorrelationConfig = Initialize-PSSailpoint.V2024CorrelationConfig -Id 2c9180835d191a86015d28455b4a2329 ` + -Name Source [source] Account Correlation ` + -AttributeAssignments null +``` + +- Convert the resource to JSON +```powershell +$CorrelationConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CorrelationConfigAttributeAssignmentsInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CorrelationConfigAttributeAssignmentsInner.md new file mode 100644 index 000000000..7879df61a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CorrelationConfigAttributeAssignmentsInner.md @@ -0,0 +1,47 @@ +--- +id: v2024-correlation-config-attribute-assignments-inner +title: CorrelationConfigAttributeAssignmentsInner +pagination_label: CorrelationConfigAttributeAssignmentsInner +sidebar_label: CorrelationConfigAttributeAssignmentsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CorrelationConfigAttributeAssignmentsInner', 'V2024CorrelationConfigAttributeAssignmentsInner'] +slug: /tools/sdk/powershell/v2024/models/correlation-config-attribute-assignments-inner +tags: ['SDK', 'Software Development Kit', 'CorrelationConfigAttributeAssignmentsInner', 'V2024CorrelationConfigAttributeAssignmentsInner'] +--- + + +# CorrelationConfigAttributeAssignmentsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Property** | Pointer to **String** | The property of the attribute assignment. | [optional] +**Value** | Pointer to **String** | The value of the attribute assignment. | [optional] +**Operation** | Pointer to **Enum** [ "EQ" ] | The operation of the attribute assignment. | [optional] +**Complex** | Pointer to **Boolean** | Whether or not the it's a complex attribute assignment. | [optional] [default to $false] +**IgnoreCase** | Pointer to **Boolean** | Whether or not the attribute assignment should ignore case. | [optional] [default to $false] +**MatchMode** | Pointer to **Enum** [ "ANYWHERE", "START", "END" ] | The match mode of the attribute assignment. | [optional] +**FilterString** | Pointer to **String** | The filter string of the attribute assignment. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CorrelationConfigAttributeAssignmentsInner = Initialize-PSSailpoint.V2024CorrelationConfigAttributeAssignmentsInner -Property first_name ` + -Value firstName ` + -Operation EQ ` + -Complex false ` + -IgnoreCase false ` + -MatchMode ANYWHERE ` + -FilterString first_name == "John" +``` + +- Convert the resource to JSON +```powershell +$CorrelationConfigAttributeAssignmentsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateDomainDkim405Response.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateDomainDkim405Response.md new file mode 100644 index 000000000..11f136704 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateDomainDkim405Response.md @@ -0,0 +1,39 @@ +--- +id: v2024-create-domain-dkim405-response +title: CreateDomainDkim405Response +pagination_label: CreateDomainDkim405Response +sidebar_label: CreateDomainDkim405Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateDomainDkim405Response', 'V2024CreateDomainDkim405Response'] +slug: /tools/sdk/powershell/v2024/models/create-domain-dkim405-response +tags: ['SDK', 'Software Development Kit', 'CreateDomainDkim405Response', 'V2024CreateDomainDkim405Response'] +--- + + +# CreateDomainDkim405Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ErrorName** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A message describing the error | [optional] +**ErrorMessage** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Description of the error | [optional] +**TrackingId** | Pointer to **String** | Unique tracking id for the error. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateDomainDkim405Response = Initialize-PSSailpoint.V2024CreateDomainDkim405Response -ErrorName NotSupportedException ` + -ErrorMessage Cannot consume content type ` + -TrackingId e7eab60924f64aa284175b9fa3309599 +``` + +- Convert the resource to JSON +```powershell +$CreateDomainDkim405Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateExternalExecuteWorkflow200Response.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateExternalExecuteWorkflow200Response.md new file mode 100644 index 000000000..c97d03b4c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateExternalExecuteWorkflow200Response.md @@ -0,0 +1,37 @@ +--- +id: v2024-create-external-execute-workflow200-response +title: CreateExternalExecuteWorkflow200Response +pagination_label: CreateExternalExecuteWorkflow200Response +sidebar_label: CreateExternalExecuteWorkflow200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateExternalExecuteWorkflow200Response', 'V2024CreateExternalExecuteWorkflow200Response'] +slug: /tools/sdk/powershell/v2024/models/create-external-execute-workflow200-response +tags: ['SDK', 'Software Development Kit', 'CreateExternalExecuteWorkflow200Response', 'V2024CreateExternalExecuteWorkflow200Response'] +--- + + +# CreateExternalExecuteWorkflow200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**WorkflowExecutionId** | Pointer to **String** | The workflow execution id | [optional] +**Message** | Pointer to **String** | An error message if any errors occurred | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateExternalExecuteWorkflow200Response = Initialize-PSSailpoint.V2024CreateExternalExecuteWorkflow200Response -WorkflowExecutionId 0e11cefa-96e7-4b67-90d0-065bc1da5753 ` + -Message Workflow was not executed externally. Check enabled flag on workflow definition +``` + +- Convert the resource to JSON +```powershell +$CreateExternalExecuteWorkflow200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateExternalExecuteWorkflowRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateExternalExecuteWorkflowRequest.md new file mode 100644 index 000000000..3a4ff1bc7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateExternalExecuteWorkflowRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-create-external-execute-workflow-request +title: CreateExternalExecuteWorkflowRequest +pagination_label: CreateExternalExecuteWorkflowRequest +sidebar_label: CreateExternalExecuteWorkflowRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateExternalExecuteWorkflowRequest', 'V2024CreateExternalExecuteWorkflowRequest'] +slug: /tools/sdk/powershell/v2024/models/create-external-execute-workflow-request +tags: ['SDK', 'Software Development Kit', 'CreateExternalExecuteWorkflowRequest', 'V2024CreateExternalExecuteWorkflowRequest'] +--- + + +# CreateExternalExecuteWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarInput** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The input for the workflow | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateExternalExecuteWorkflowRequest = Initialize-PSSailpoint.V2024CreateExternalExecuteWorkflowRequest -VarInput {customAttribute1=value1, customAttribute2=value2} +``` + +- Convert the resource to JSON +```powershell +$CreateExternalExecuteWorkflowRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateFormDefinitionFileRequestRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateFormDefinitionFileRequestRequest.md new file mode 100644 index 000000000..39d33b71f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateFormDefinitionFileRequestRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-create-form-definition-file-request-request +title: CreateFormDefinitionFileRequestRequest +pagination_label: CreateFormDefinitionFileRequestRequest +sidebar_label: CreateFormDefinitionFileRequestRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateFormDefinitionFileRequestRequest', 'V2024CreateFormDefinitionFileRequestRequest'] +slug: /tools/sdk/powershell/v2024/models/create-form-definition-file-request-request +tags: ['SDK', 'Software Development Kit', 'CreateFormDefinitionFileRequestRequest', 'V2024CreateFormDefinitionFileRequestRequest'] +--- + + +# CreateFormDefinitionFileRequestRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | **System.IO.FileInfo** | File specifying the multipart | [required] + +## Examples + +- Prepare the resource +```powershell +$CreateFormDefinitionFileRequestRequest = Initialize-PSSailpoint.V2024CreateFormDefinitionFileRequestRequest -File null +``` + +- Convert the resource to JSON +```powershell +$CreateFormDefinitionFileRequestRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateFormDefinitionRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateFormDefinitionRequest.md new file mode 100644 index 000000000..3950ec077 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateFormDefinitionRequest.md @@ -0,0 +1,47 @@ +--- +id: v2024-create-form-definition-request +title: CreateFormDefinitionRequest +pagination_label: CreateFormDefinitionRequest +sidebar_label: CreateFormDefinitionRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateFormDefinitionRequest', 'V2024CreateFormDefinitionRequest'] +slug: /tools/sdk/powershell/v2024/models/create-form-definition-request +tags: ['SDK', 'Software Development Kit', 'CreateFormDefinitionRequest', 'V2024CreateFormDefinitionRequest'] +--- + + +# CreateFormDefinitionRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **String** | Description is the form definition description | [optional] +**FormConditions** | Pointer to [**[]FormCondition**](form-condition) | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [optional] +**FormElements** | Pointer to [**[]FormElement**](form-element) | FormElements is a list of nested form elements | [optional] +**FormInput** | Pointer to [**[]FormDefinitionInput**](form-definition-input) | FormInput is a list of form inputs that are required when creating a form-instance object | [optional] +**Name** | **String** | Name is the form definition name | [required] +**Owner** | [**FormOwner**](form-owner) | | [required] +**UsedBy** | Pointer to [**[]FormUsedBy**](form-used-by) | UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateFormDefinitionRequest = Initialize-PSSailpoint.V2024CreateFormDefinitionRequest -Description My form description ` + -FormConditions null ` + -FormElements null ` + -FormInput null ` + -Name My form ` + -Owner null ` + -UsedBy null +``` + +- Convert the resource to JSON +```powershell +$CreateFormDefinitionRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateFormInstanceRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateFormInstanceRequest.md new file mode 100644 index 000000000..6d2d6fd25 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateFormInstanceRequest.md @@ -0,0 +1,49 @@ +--- +id: v2024-create-form-instance-request +title: CreateFormInstanceRequest +pagination_label: CreateFormInstanceRequest +sidebar_label: CreateFormInstanceRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateFormInstanceRequest', 'V2024CreateFormInstanceRequest'] +slug: /tools/sdk/powershell/v2024/models/create-form-instance-request +tags: ['SDK', 'Software Development Kit', 'CreateFormInstanceRequest', 'V2024CreateFormInstanceRequest'] +--- + + +# CreateFormInstanceRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreatedBy** | [**FormInstanceCreatedBy**](form-instance-created-by) | | [required] +**Expire** | **String** | Expire is required | [required] +**FormDefinitionId** | **String** | FormDefinitionID is the id of the form definition that created this form | [required] +**FormInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | FormInput is an object of form input labels to value | [optional] +**Recipients** | [**[]FormInstanceRecipient**](form-instance-recipient) | Recipients is required | [required] +**StandAloneForm** | Pointer to **Boolean** | StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form | [optional] [default to $false] +**State** | Pointer to **Enum** [ "ASSIGNED", "IN_PROGRESS", "SUBMITTED", "COMPLETED", "CANCELLED" ] | State is required, if not present initial state is FormInstanceStateAssigned ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [optional] +**Ttl** | Pointer to **Int64** | TTL an epoch timestamp in seconds, it most be in seconds or dynamodb will ignore it SEE: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/time-to-live-ttl-before-you-start.html | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateFormInstanceRequest = Initialize-PSSailpoint.V2024CreateFormInstanceRequest -CreatedBy null ` + -Expire 2023-08-12T20:14:57.74486Z ` + -FormDefinitionId 00000000-0000-0000-0000-000000000000 ` + -FormInput {input1=Sales} ` + -Recipients null ` + -StandAloneForm false ` + -State ASSIGNED ` + -Ttl 1571827560 +``` + +- Convert the resource to JSON +```powershell +$CreateFormInstanceRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateOAuthClientRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateOAuthClientRequest.md new file mode 100644 index 000000000..0db91df23 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateOAuthClientRequest.md @@ -0,0 +1,63 @@ +--- +id: v2024-create-o-auth-client-request +title: CreateOAuthClientRequest +pagination_label: CreateOAuthClientRequest +sidebar_label: CreateOAuthClientRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateOAuthClientRequest', 'V2024CreateOAuthClientRequest'] +slug: /tools/sdk/powershell/v2024/models/create-o-auth-client-request +tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientRequest', 'V2024CreateOAuthClientRequest'] +--- + + +# CreateOAuthClientRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BusinessName** | Pointer to **String** | The name of the business the API Client should belong to | [optional] +**HomepageUrl** | Pointer to **String** | The homepage URL associated with the owner of the API Client | [optional] +**Name** | **String** | A human-readable name for the API Client | [required] +**Description** | **String** | A description of the API Client | [required] +**AccessTokenValiditySeconds** | **Int32** | The number of seconds an access token generated for this API Client is valid for | [required] +**RefreshTokenValiditySeconds** | Pointer to **Int32** | The number of seconds a refresh token generated for this API Client is valid for | [optional] +**RedirectUris** | Pointer to **[]String** | A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. | [optional] +**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | [required] +**AccessType** | [**AccessType**](access-type) | | [required] +**Type** | Pointer to [**ClientType**](client-type) | | [optional] +**Internal** | Pointer to **Boolean** | An indicator of whether the API Client can be used for requests internal within the product. | [optional] +**Enabled** | **Boolean** | An indicator of whether the API Client is enabled for use | [required] +**StrongAuthSupported** | Pointer to **Boolean** | An indicator of whether the API Client supports strong authentication | [optional] +**ClaimsSupported** | Pointer to **Boolean** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [optional] +**Scope** | Pointer to **[]String** | Scopes of the API Client. If no scope is specified, the client will be created with the default scope ""sp:scopes:all"". This means the API Client will have all the rights of the owner who created it. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateOAuthClientRequest = Initialize-PSSailpoint.V2024CreateOAuthClientRequest -BusinessName Acme-Solar ` + -HomepageUrl http://localhost:12345 ` + -Name Demo API Client ` + -Description An API client used for the authorization_code, refresh_token, and client_credentials flows ` + -AccessTokenValiditySeconds 750 ` + -RefreshTokenValiditySeconds 86400 ` + -RedirectUris [http://localhost:12345] ` + -GrantTypes [AUTHORIZATION_CODE, CLIENT_CREDENTIALS, REFRESH_TOKEN] ` + -AccessType null ` + -Type null ` + -Internal false ` + -Enabled true ` + -StrongAuthSupported false ` + -ClaimsSupported false ` + -Scope [demo:api-client-scope:first, demo:api-client-scope:second] +``` + +- Convert the resource to JSON +```powershell +$CreateOAuthClientRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateOAuthClientResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateOAuthClientResponse.md new file mode 100644 index 000000000..59bdbf66b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateOAuthClientResponse.md @@ -0,0 +1,71 @@ +--- +id: v2024-create-o-auth-client-response +title: CreateOAuthClientResponse +pagination_label: CreateOAuthClientResponse +sidebar_label: CreateOAuthClientResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateOAuthClientResponse', 'V2024CreateOAuthClientResponse'] +slug: /tools/sdk/powershell/v2024/models/create-o-auth-client-response +tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientResponse', 'V2024CreateOAuthClientResponse'] +--- + + +# CreateOAuthClientResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | ID of the OAuth client | [required] +**Secret** | **String** | Secret of the OAuth client (This field is only returned on the intial create call.) | [required] +**BusinessName** | **String** | The name of the business the API Client should belong to | [required] +**HomepageUrl** | **String** | The homepage URL associated with the owner of the API Client | [required] +**Name** | **String** | A human-readable name for the API Client | [required] +**Description** | **String** | A description of the API Client | [required] +**AccessTokenValiditySeconds** | **Int32** | The number of seconds an access token generated for this API Client is valid for | [required] +**RefreshTokenValiditySeconds** | **Int32** | The number of seconds a refresh token generated for this API Client is valid for | [required] +**RedirectUris** | **[]String** | A list of the approved redirect URIs used with the authorization_code flow | [required] +**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | [required] +**AccessType** | [**AccessType**](access-type) | | [required] +**Type** | [**ClientType**](client-type) | | [required] +**Internal** | **Boolean** | An indicator of whether the API Client can be used for requests internal to IDN | [required] +**Enabled** | **Boolean** | An indicator of whether the API Client is enabled for use | [required] +**StrongAuthSupported** | **Boolean** | An indicator of whether the API Client supports strong authentication | [required] +**ClaimsSupported** | **Boolean** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [required] +**Created** | **System.DateTime** | The date and time, down to the millisecond, when the API Client was created | [required] +**Modified** | **System.DateTime** | The date and time, down to the millisecond, when the API Client was last updated | [required] +**Scope** | **[]String** | Scopes of the API Client. | [required] + +## Examples + +- Prepare the resource +```powershell +$CreateOAuthClientResponse = Initialize-PSSailpoint.V2024CreateOAuthClientResponse -Id 2c9180835d2e5168015d32f890ca1581 ` + -Secret 5c32dd9b21adb51c77794d46e71de117a1d0ddb36a7ff941fa28014ab7de2cf3 ` + -BusinessName Acme-Solar ` + -HomepageUrl http://localhost:12345 ` + -Name Demo API Client ` + -Description An API client used for the authorization_code, refresh_token, and client_credentials flows ` + -AccessTokenValiditySeconds 750 ` + -RefreshTokenValiditySeconds 86400 ` + -RedirectUris [http://localhost:12345] ` + -GrantTypes [AUTHORIZATION_CODE, CLIENT_CREDENTIALS, REFRESH_TOKEN] ` + -AccessType null ` + -Type null ` + -Internal false ` + -Enabled true ` + -StrongAuthSupported false ` + -ClaimsSupported false ` + -Created 2017-07-11T18:45:37.098Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Scope [demo:api-client-scope:first, demo:api-client-scope:second] +``` + +- Convert the resource to JSON +```powershell +$CreateOAuthClientResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreatePersonalAccessTokenRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreatePersonalAccessTokenRequest.md new file mode 100644 index 000000000..51a059669 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreatePersonalAccessTokenRequest.md @@ -0,0 +1,39 @@ +--- +id: v2024-create-personal-access-token-request +title: CreatePersonalAccessTokenRequest +pagination_label: CreatePersonalAccessTokenRequest +sidebar_label: CreatePersonalAccessTokenRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreatePersonalAccessTokenRequest', 'V2024CreatePersonalAccessTokenRequest'] +slug: /tools/sdk/powershell/v2024/models/create-personal-access-token-request +tags: ['SDK', 'Software Development Kit', 'CreatePersonalAccessTokenRequest', 'V2024CreatePersonalAccessTokenRequest'] +--- + + +# CreatePersonalAccessTokenRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. | [required] +**Scope** | Pointer to **[]String** | Scopes of the personal access token. If no scope is specified, the token will be created with the default scope ""sp:scopes:all"". This means the personal access token will have all the rights of the owner who created it. | [optional] +**AccessTokenValiditySeconds** | Pointer to **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreatePersonalAccessTokenRequest = Initialize-PSSailpoint.V2024CreatePersonalAccessTokenRequest -Name NodeJS Integration ` + -Scope [demo:personal-access-token-scope:first, demo:personal-access-token-scope:second] ` + -AccessTokenValiditySeconds 36900 +``` + +- Convert the resource to JSON +```powershell +$CreatePersonalAccessTokenRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreatePersonalAccessTokenResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreatePersonalAccessTokenResponse.md new file mode 100644 index 000000000..d45fdf784 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreatePersonalAccessTokenResponse.md @@ -0,0 +1,47 @@ +--- +id: v2024-create-personal-access-token-response +title: CreatePersonalAccessTokenResponse +pagination_label: CreatePersonalAccessTokenResponse +sidebar_label: CreatePersonalAccessTokenResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreatePersonalAccessTokenResponse', 'V2024CreatePersonalAccessTokenResponse'] +slug: /tools/sdk/powershell/v2024/models/create-personal-access-token-response +tags: ['SDK', 'Software Development Kit', 'CreatePersonalAccessTokenResponse', 'V2024CreatePersonalAccessTokenResponse'] +--- + + +# CreatePersonalAccessTokenResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The ID of the personal access token (to be used as the username for Basic Auth). | [required] +**Secret** | **String** | The secret of the personal access token (to be used as the password for Basic Auth). | [required] +**Scope** | **[]String** | Scopes of the personal access token. | [required] +**Name** | **String** | The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. | [required] +**Owner** | [**PatOwner**](pat-owner) | | [required] +**Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required] +**AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [required] + +## Examples + +- Prepare the resource +```powershell +$CreatePersonalAccessTokenResponse = Initialize-PSSailpoint.V2024CreatePersonalAccessTokenResponse -Id 86f1dc6fe8f54414950454cbb11278fa ` + -Secret 1d1bef2b9f426383447f64f69349fc7cac176042578d205c256ba3f37c59adb9 ` + -Scope [demo:personal-access-token-scope:first, demo:personal-access-token-scope:second] ` + -Name NodeJS Integration ` + -Owner null ` + -Created 2017-07-11T18:45:37.098Z ` + -AccessTokenValiditySeconds 36900 +``` + +- Convert the resource to JSON +```powershell +$CreatePersonalAccessTokenResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateSavedSearchRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateSavedSearchRequest.md new file mode 100644 index 000000000..7d0143504 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateSavedSearchRequest.md @@ -0,0 +1,55 @@ +--- +id: v2024-create-saved-search-request +title: CreateSavedSearchRequest +pagination_label: CreateSavedSearchRequest +sidebar_label: CreateSavedSearchRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateSavedSearchRequest', 'V2024CreateSavedSearchRequest'] +slug: /tools/sdk/powershell/v2024/models/create-saved-search-request +tags: ['SDK', 'Software Development Kit', 'CreateSavedSearchRequest', 'V2024CreateSavedSearchRequest'] +--- + + +# CreateSavedSearchRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the saved search. | [optional] +**Description** | Pointer to **String** | The description of the saved search. | [optional] +**Created** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] +**Modified** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] +**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required] +**Columns** | Pointer to [**map[string]Column[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] +**Query** | **String** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required] +**Fields** | Pointer to **[]String** | The fields to be searched against in a multi-field query. | [optional] +**OrderBy** | Pointer to **map[string]String[]** | Sort by index. This takes precedence over the `sort` property. | [optional] +**Sort** | Pointer to **[]String** | The fields to be used to sort the search results. | [optional] +**Filters** | Pointer to [**SavedSearchDetailFilters**](saved-search-detail-filters) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateSavedSearchRequest = Initialize-PSSailpoint.V2024CreateSavedSearchRequest -Name Disabled accounts ` + -Description Disabled accounts ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Indices [identities] ` + -Columns {identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]} ` + -Query @accounts(disabled:true) ` + -Fields [disabled] ` + -OrderBy {identity=[lastName, firstName], role=[name]} ` + -Sort [displayName] ` + -Filters null +``` + +- Convert the resource to JSON +```powershell +$CreateSavedSearchRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateScheduledSearchRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateScheduledSearchRequest.md new file mode 100644 index 000000000..9c88d361d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateScheduledSearchRequest.md @@ -0,0 +1,53 @@ +--- +id: v2024-create-scheduled-search-request +title: CreateScheduledSearchRequest +pagination_label: CreateScheduledSearchRequest +sidebar_label: CreateScheduledSearchRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateScheduledSearchRequest', 'V2024CreateScheduledSearchRequest'] +slug: /tools/sdk/powershell/v2024/models/create-scheduled-search-request +tags: ['SDK', 'Software Development Kit', 'CreateScheduledSearchRequest', 'V2024CreateScheduledSearchRequest'] +--- + + +# CreateScheduledSearchRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the scheduled search. | [optional] +**Description** | Pointer to **String** | The description of the scheduled search. | [optional] +**SavedSearchId** | **String** | The ID of the saved search that will be executed. | [required] +**Created** | Pointer to **System.DateTime** | The date the scheduled search was initially created. | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | The last date the scheduled search was modified. | [optional] [readonly] +**Schedule** | [**Schedule2**](schedule2) | | [required] +**Recipients** | [**[]SearchScheduleRecipientsInner**](search-schedule-recipients-inner) | A list of identities that should receive the scheduled search report via email. | [required] +**Enabled** | Pointer to **Boolean** | Indicates if the scheduled search is enabled. | [optional] [default to $false] +**EmailEmptyResults** | Pointer to **Boolean** | Indicates if email generation should occur when search returns no results. | [optional] [default to $false] +**DisplayQueryDetails** | Pointer to **Boolean** | Indicates if the generated email should include the query and search results preview (which could include PII). | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$CreateScheduledSearchRequest = Initialize-PSSailpoint.V2024CreateScheduledSearchRequest -Name Daily disabled accounts ` + -Description Daily disabled accounts ` + -SavedSearchId 554f1511-f0a1-4744-ab14-599514d3e57c ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Schedule null ` + -Recipients null ` + -Enabled false ` + -EmailEmptyResults false ` + -DisplayQueryDetails false +``` + +- Convert the resource to JSON +```powershell +$CreateScheduledSearchRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateUploadedConfigurationRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateUploadedConfigurationRequest.md new file mode 100644 index 000000000..da85a9796 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateUploadedConfigurationRequest.md @@ -0,0 +1,37 @@ +--- +id: v2024-create-uploaded-configuration-request +title: CreateUploadedConfigurationRequest +pagination_label: CreateUploadedConfigurationRequest +sidebar_label: CreateUploadedConfigurationRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateUploadedConfigurationRequest', 'V2024CreateUploadedConfigurationRequest'] +slug: /tools/sdk/powershell/v2024/models/create-uploaded-configuration-request +tags: ['SDK', 'Software Development Kit', 'CreateUploadedConfigurationRequest', 'V2024CreateUploadedConfigurationRequest'] +--- + + +# CreateUploadedConfigurationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarData** | **System.IO.FileInfo** | JSON file containing the objects to be imported. | [required] +**Name** | **String** | Name that will be assigned to the uploaded configuration file. | [required] + +## Examples + +- Prepare the resource +```powershell +$CreateUploadedConfigurationRequest = Initialize-PSSailpoint.V2024CreateUploadedConfigurationRequest -VarData null ` + -Name null +``` + +- Convert the resource to JSON +```powershell +$CreateUploadedConfigurationRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateWorkflowRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateWorkflowRequest.md new file mode 100644 index 000000000..696b40bd4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CreateWorkflowRequest.md @@ -0,0 +1,45 @@ +--- +id: v2024-create-workflow-request +title: CreateWorkflowRequest +pagination_label: CreateWorkflowRequest +sidebar_label: CreateWorkflowRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateWorkflowRequest', 'V2024CreateWorkflowRequest'] +slug: /tools/sdk/powershell/v2024/models/create-workflow-request +tags: ['SDK', 'Software Development Kit', 'CreateWorkflowRequest', 'V2024CreateWorkflowRequest'] +--- + + +# CreateWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | The name of the workflow | [required] +**Owner** | Pointer to [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] +**Description** | Pointer to **String** | Description of what the workflow accomplishes | [optional] +**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] +**Enabled** | Pointer to **Boolean** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to $false] +**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateWorkflowRequest = Initialize-PSSailpoint.V2024CreateWorkflowRequest -Name Send Email ` + -Owner null ` + -Description Send an email to the identity who's attributes changed. ` + -Definition null ` + -Enabled false ` + -Trigger null +``` + +- Convert the resource to JSON +```powershell +$CreateWorkflowRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CriteriaType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CriteriaType.md new file mode 100644 index 000000000..6e4ebf8c5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CriteriaType.md @@ -0,0 +1,40 @@ +--- +id: v2024-criteria-type +title: CriteriaType +pagination_label: CriteriaType +sidebar_label: CriteriaType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CriteriaType', 'V2024CriteriaType'] +slug: /tools/sdk/powershell/v2024/models/criteria-type +tags: ['SDK', 'Software Development Kit', 'CriteriaType', 'V2024CriteriaType'] +--- + + +# CriteriaType + +## Enum + + +* `COMPOSITE` (value: `"COMPOSITE"`) + +* `ROLE` (value: `"ROLE"`) + +* `IDENTITY` (value: `"IDENTITY"`) + +* `IDENTITY_ATTRIBUTE` (value: `"IDENTITY_ATTRIBUTE"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `SOURCE` (value: `"SOURCE"`) + +* `ACCOUNT` (value: `"ACCOUNT"`) + +* `AGGREGATED_ENTITLEMENT` (value: `"AGGREGATED_ENTITLEMENT"`) + +* `INVALID_CERTIFIABLE_ENTITY` (value: `"INVALID_CERTIFIABLE_ENTITY"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CustomPasswordInstruction.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CustomPasswordInstruction.md new file mode 100644 index 000000000..ce7e7b8ab --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/CustomPasswordInstruction.md @@ -0,0 +1,39 @@ +--- +id: v2024-custom-password-instruction +title: CustomPasswordInstruction +pagination_label: CustomPasswordInstruction +sidebar_label: CustomPasswordInstruction +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CustomPasswordInstruction', 'V2024CustomPasswordInstruction'] +slug: /tools/sdk/powershell/v2024/models/custom-password-instruction +tags: ['SDK', 'Software Development Kit', 'CustomPasswordInstruction', 'V2024CustomPasswordInstruction'] +--- + + +# CustomPasswordInstruction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PageId** | Pointer to **Enum** [ "change-password:enter-password", "change-password:finish", "flow-selection:select", "forget-username:user-email", "mfa:enter-code", "mfa:enter-kba", "mfa:select", "reset-password:enter-password", "reset-password:enter-username", "reset-password:finish", "unlock-account:enter-username", "unlock-account:finish" ] | The page ID that represents the page for forget user name, reset password and unlock account flow. | [optional] +**PageContent** | Pointer to **String** | The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. If the customization text includes a link, like `...` clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to ""_blank"" like this: `link`. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target. | [optional] +**Locale** | Pointer to **String** | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". | [optional] + +## Examples + +- Prepare the resource +```powershell +$CustomPasswordInstruction = Initialize-PSSailpoint.V2024CustomPasswordInstruction -PageId change-password:enter-password ` + -PageContent Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter. ` + -Locale en +``` + +- Convert the resource to JSON +```powershell +$CustomPasswordInstruction | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DataAccess.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DataAccess.md new file mode 100644 index 000000000..1a66a684b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DataAccess.md @@ -0,0 +1,39 @@ +--- +id: v2024-data-access +title: DataAccess +pagination_label: DataAccess +sidebar_label: DataAccess +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DataAccess', 'V2024DataAccess'] +slug: /tools/sdk/powershell/v2024/models/data-access +tags: ['SDK', 'Software Development Kit', 'DataAccess', 'V2024DataAccess'] +--- + + +# DataAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policies** | Pointer to [**[]DataAccessPoliciesInner**](data-access-policies-inner) | List of classification policies that apply to resources the entitlement \ groups has access to | [optional] +**Categories** | Pointer to [**[]DataAccessCategoriesInner**](data-access-categories-inner) | List of classification categories that apply to resources the entitlement \ groups has access to | [optional] +**ImpactScore** | Pointer to [**DataAccessImpactScore**](data-access-impact-score) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$DataAccess = Initialize-PSSailpoint.V2024DataAccess -Policies null ` + -Categories null ` + -ImpactScore null +``` + +- Convert the resource to JSON +```powershell +$DataAccess | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DataAccessCategoriesInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DataAccessCategoriesInner.md new file mode 100644 index 000000000..cafd1015b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DataAccessCategoriesInner.md @@ -0,0 +1,37 @@ +--- +id: v2024-data-access-categories-inner +title: DataAccessCategoriesInner +pagination_label: DataAccessCategoriesInner +sidebar_label: DataAccessCategoriesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DataAccessCategoriesInner', 'V2024DataAccessCategoriesInner'] +slug: /tools/sdk/powershell/v2024/models/data-access-categories-inner +tags: ['SDK', 'Software Development Kit', 'DataAccessCategoriesInner', 'V2024DataAccessCategoriesInner'] +--- + + +# DataAccessCategoriesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **String** | Value of the category | [optional] +**MatchCount** | Pointer to **Int32** | Number of matched for each category | [optional] + +## Examples + +- Prepare the resource +```powershell +$DataAccessCategoriesInner = Initialize-PSSailpoint.V2024DataAccessCategoriesInner -Value email-7 ` + -MatchCount 10 +``` + +- Convert the resource to JSON +```powershell +$DataAccessCategoriesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DataAccessImpactScore.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DataAccessImpactScore.md new file mode 100644 index 000000000..8937006f2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DataAccessImpactScore.md @@ -0,0 +1,35 @@ +--- +id: v2024-data-access-impact-score +title: DataAccessImpactScore +pagination_label: DataAccessImpactScore +sidebar_label: DataAccessImpactScore +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DataAccessImpactScore', 'V2024DataAccessImpactScore'] +slug: /tools/sdk/powershell/v2024/models/data-access-impact-score +tags: ['SDK', 'Software Development Kit', 'DataAccessImpactScore', 'V2024DataAccessImpactScore'] +--- + + +# DataAccessImpactScore + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **String** | Impact Score for this data | [optional] + +## Examples + +- Prepare the resource +```powershell +$DataAccessImpactScore = Initialize-PSSailpoint.V2024DataAccessImpactScore -Value Medium +``` + +- Convert the resource to JSON +```powershell +$DataAccessImpactScore | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DataAccessPoliciesInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DataAccessPoliciesInner.md new file mode 100644 index 000000000..656729124 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DataAccessPoliciesInner.md @@ -0,0 +1,35 @@ +--- +id: v2024-data-access-policies-inner +title: DataAccessPoliciesInner +pagination_label: DataAccessPoliciesInner +sidebar_label: DataAccessPoliciesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DataAccessPoliciesInner', 'V2024DataAccessPoliciesInner'] +slug: /tools/sdk/powershell/v2024/models/data-access-policies-inner +tags: ['SDK', 'Software Development Kit', 'DataAccessPoliciesInner', 'V2024DataAccessPoliciesInner'] +--- + + +# DataAccessPoliciesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **String** | Value of the policy | [optional] + +## Examples + +- Prepare the resource +```powershell +$DataAccessPoliciesInner = Initialize-PSSailpoint.V2024DataAccessPoliciesInner -Value GDPR-20 +``` + +- Convert the resource to JSON +```powershell +$DataAccessPoliciesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DateCompare.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DateCompare.md new file mode 100644 index 000000000..1ac1bdc72 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DateCompare.md @@ -0,0 +1,47 @@ +--- +id: v2024-date-compare +title: DateCompare +pagination_label: DateCompare +sidebar_label: DateCompare +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DateCompare', 'V2024DateCompare'] +slug: /tools/sdk/powershell/v2024/models/date-compare +tags: ['SDK', 'Software Development Kit', 'DateCompare', 'V2024DateCompare'] +--- + + +# DateCompare + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FirstDate** | [**DateCompareFirstDate**](date-compare-first-date) | | [required] +**SecondDate** | [**DateCompareSecondDate**](date-compare-second-date) | | [required] +**Operator** | **Enum** [ "LT", "LTE", "GT", "GTE" ] | This is the comparison to perform. | Operation | Description | | --------- | ------- | | LT | Strictly less than: `firstDate < secondDate` | | LTE | Less than or equal to: `firstDate <= secondDate` | | GT | Strictly greater than: `firstDate > secondDate` | | GTE | Greater than or equal to: `firstDate >= secondDate` | | [required] +**PositiveCondition** | **String** | The output of the transform if the expression evalutes to true | [required] +**NegativeCondition** | **String** | The output of the transform if the expression evalutes to false | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$DateCompare = Initialize-PSSailpoint.V2024DateCompare -FirstDate null ` + -SecondDate null ` + -Operator LT ` + -PositiveCondition true ` + -NegativeCondition false ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$DateCompare | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DateCompareFirstDate.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DateCompareFirstDate.md new file mode 100644 index 000000000..663d2b7dd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DateCompareFirstDate.md @@ -0,0 +1,55 @@ +--- +id: v2024-date-compare-first-date +title: DateCompareFirstDate +pagination_label: DateCompareFirstDate +sidebar_label: DateCompareFirstDate +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DateCompareFirstDate', 'V2024DateCompareFirstDate'] +slug: /tools/sdk/powershell/v2024/models/date-compare-first-date +tags: ['SDK', 'Software Development Kit', 'DateCompareFirstDate', 'V2024DateCompareFirstDate'] +--- + + +# DateCompareFirstDate + +## Properties + +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] +**InputFormat** | Pointer to [**DateFormatInputFormat**](date-format-input-format) | | [optional] +**OutputFormat** | Pointer to [**DateFormatOutputFormat**](date-format-output-format) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$DateCompareFirstDate = Initialize-PSSailpoint.V2024DateCompareFirstDate -SourceName Workday ` + -AttributeName DEPARTMENT ` + -AccountSortAttribute created ` + -AccountSortDescending false ` + -AccountReturnFirstLink false ` + -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` + -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` + -InputFormat null ` + -OutputFormat null +``` + +- Convert the resource to JSON +```powershell +$DateCompareFirstDate | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DateCompareSecondDate.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DateCompareSecondDate.md new file mode 100644 index 000000000..11280e88e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DateCompareSecondDate.md @@ -0,0 +1,55 @@ +--- +id: v2024-date-compare-second-date +title: DateCompareSecondDate +pagination_label: DateCompareSecondDate +sidebar_label: DateCompareSecondDate +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DateCompareSecondDate', 'V2024DateCompareSecondDate'] +slug: /tools/sdk/powershell/v2024/models/date-compare-second-date +tags: ['SDK', 'Software Development Kit', 'DateCompareSecondDate', 'V2024DateCompareSecondDate'] +--- + + +# DateCompareSecondDate + +## Properties + +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] +**InputFormat** | Pointer to [**DateFormatInputFormat**](date-format-input-format) | | [optional] +**OutputFormat** | Pointer to [**DateFormatOutputFormat**](date-format-output-format) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$DateCompareSecondDate = Initialize-PSSailpoint.V2024DateCompareSecondDate -SourceName Workday ` + -AttributeName DEPARTMENT ` + -AccountSortAttribute created ` + -AccountSortDescending false ` + -AccountReturnFirstLink false ` + -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` + -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` + -InputFormat null ` + -OutputFormat null +``` + +- Convert the resource to JSON +```powershell +$DateCompareSecondDate | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DateFormat.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DateFormat.md new file mode 100644 index 000000000..5e80c384d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DateFormat.md @@ -0,0 +1,41 @@ +--- +id: v2024-date-format +title: DateFormat +pagination_label: DateFormat +sidebar_label: DateFormat +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DateFormat', 'V2024DateFormat'] +slug: /tools/sdk/powershell/v2024/models/date-format +tags: ['SDK', 'Software Development Kit', 'DateFormat', 'V2024DateFormat'] +--- + + +# DateFormat + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InputFormat** | Pointer to [**DateFormatInputFormat**](date-format-input-format) | | [optional] +**OutputFormat** | Pointer to [**DateFormatOutputFormat**](date-format-output-format) | | [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] + +## Examples + +- Prepare the resource +```powershell +$DateFormat = Initialize-PSSailpoint.V2024DateFormat -InputFormat null ` + -OutputFormat null ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$DateFormat | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DateFormatInputFormat.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DateFormatInputFormat.md new file mode 100644 index 000000000..8b968885b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DateFormatInputFormat.md @@ -0,0 +1,34 @@ +--- +id: v2024-date-format-input-format +title: DateFormatInputFormat +pagination_label: DateFormatInputFormat +sidebar_label: DateFormatInputFormat +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DateFormatInputFormat', 'V2024DateFormatInputFormat'] +slug: /tools/sdk/powershell/v2024/models/date-format-input-format +tags: ['SDK', 'Software Development Kit', 'DateFormatInputFormat', 'V2024DateFormatInputFormat'] +--- + + +# DateFormatInputFormat + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$DateFormatInputFormat = Initialize-PSSailpoint.V2024DateFormatInputFormat +``` + +- Convert the resource to JSON +```powershell +$DateFormatInputFormat | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DateFormatOutputFormat.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DateFormatOutputFormat.md new file mode 100644 index 000000000..7031c1764 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DateFormatOutputFormat.md @@ -0,0 +1,34 @@ +--- +id: v2024-date-format-output-format +title: DateFormatOutputFormat +pagination_label: DateFormatOutputFormat +sidebar_label: DateFormatOutputFormat +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DateFormatOutputFormat', 'V2024DateFormatOutputFormat'] +slug: /tools/sdk/powershell/v2024/models/date-format-output-format +tags: ['SDK', 'Software Development Kit', 'DateFormatOutputFormat', 'V2024DateFormatOutputFormat'] +--- + + +# DateFormatOutputFormat + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$DateFormatOutputFormat = Initialize-PSSailpoint.V2024DateFormatOutputFormat +``` + +- Convert the resource to JSON +```powershell +$DateFormatOutputFormat | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DateMath.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DateMath.md new file mode 100644 index 000000000..282808b1d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DateMath.md @@ -0,0 +1,41 @@ +--- +id: v2024-date-math +title: DateMath +pagination_label: DateMath +sidebar_label: DateMath +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DateMath', 'V2024DateMath'] +slug: /tools/sdk/powershell/v2024/models/date-math +tags: ['SDK', 'Software Development Kit', 'DateMath', 'V2024DateMath'] +--- + + +# DateMath + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Expression** | **String** | A string value of the date and time components to operation on, along with the math operations to execute. | [required] +**RoundUp** | Pointer to **Boolean** | A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. If not provided, the transform will default to `false` `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) | [optional] [default to $false] +**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] + +## Examples + +- Prepare the resource +```powershell +$DateMath = Initialize-PSSailpoint.V2024DateMath -Expression now+1w ` + -RoundUp false ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$DateMath | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DecomposeDiacriticalMarks.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DecomposeDiacriticalMarks.md new file mode 100644 index 000000000..5f173a2a2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DecomposeDiacriticalMarks.md @@ -0,0 +1,37 @@ +--- +id: v2024-decompose-diacritical-marks +title: DecomposeDiacriticalMarks +pagination_label: DecomposeDiacriticalMarks +sidebar_label: DecomposeDiacriticalMarks +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DecomposeDiacriticalMarks', 'V2024DecomposeDiacriticalMarks'] +slug: /tools/sdk/powershell/v2024/models/decompose-diacritical-marks +tags: ['SDK', 'Software Development Kit', 'DecomposeDiacriticalMarks', 'V2024DecomposeDiacriticalMarks'] +--- + + +# DecomposeDiacriticalMarks + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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] + +## Examples + +- Prepare the resource +```powershell +$DecomposeDiacriticalMarks = Initialize-PSSailpoint.V2024DecomposeDiacriticalMarks -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$DecomposeDiacriticalMarks | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DeleteNonEmployeeRecordsInBulkRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DeleteNonEmployeeRecordsInBulkRequest.md new file mode 100644 index 000000000..4a58a4a18 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DeleteNonEmployeeRecordsInBulkRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-delete-non-employee-records-in-bulk-request +title: DeleteNonEmployeeRecordsInBulkRequest +pagination_label: DeleteNonEmployeeRecordsInBulkRequest +sidebar_label: DeleteNonEmployeeRecordsInBulkRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DeleteNonEmployeeRecordsInBulkRequest', 'V2024DeleteNonEmployeeRecordsInBulkRequest'] +slug: /tools/sdk/powershell/v2024/models/delete-non-employee-records-in-bulk-request +tags: ['SDK', 'Software Development Kit', 'DeleteNonEmployeeRecordsInBulkRequest', 'V2024DeleteNonEmployeeRecordsInBulkRequest'] +--- + + +# DeleteNonEmployeeRecordsInBulkRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | **[]String** | List of non-employee ids. | [required] + +## Examples + +- Prepare the resource +```powershell +$DeleteNonEmployeeRecordsInBulkRequest = Initialize-PSSailpoint.V2024DeleteNonEmployeeRecordsInBulkRequest -Ids [2b838de9-db9b-abcf-e646-d4f274ad4238, 2d838de9-db9b-abcf-e646-d4f274ad4238] +``` + +- Convert the resource to JSON +```powershell +$DeleteNonEmployeeRecordsInBulkRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DeleteSource202Response.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DeleteSource202Response.md new file mode 100644 index 000000000..b89f5346f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DeleteSource202Response.md @@ -0,0 +1,39 @@ +--- +id: v2024-delete-source202-response +title: DeleteSource202Response +pagination_label: DeleteSource202Response +sidebar_label: DeleteSource202Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DeleteSource202Response', 'V2024DeleteSource202Response'] +slug: /tools/sdk/powershell/v2024/models/delete-source202-response +tags: ['SDK', 'Software Development Kit', 'DeleteSource202Response', 'V2024DeleteSource202Response'] +--- + + +# DeleteSource202Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "TASK_RESULT" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Task result ID. | [optional] +**Name** | Pointer to **String** | Task result's human-readable display name (this should be null/empty). | [optional] + +## Examples + +- Prepare the resource +```powershell +$DeleteSource202Response = Initialize-PSSailpoint.V2024DeleteSource202Response -Type TASK_RESULT ` + -Id 2c91808779ecf55b0179f720942f181a ` + -Name null +``` + +- Convert the resource to JSON +```powershell +$DeleteSource202Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DeleteVendorConnectorMapping200Response.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DeleteVendorConnectorMapping200Response.md new file mode 100644 index 000000000..8b1af3238 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DeleteVendorConnectorMapping200Response.md @@ -0,0 +1,35 @@ +--- +id: v2024-delete-vendor-connector-mapping200-response +title: DeleteVendorConnectorMapping200Response +pagination_label: DeleteVendorConnectorMapping200Response +sidebar_label: DeleteVendorConnectorMapping200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DeleteVendorConnectorMapping200Response', 'V2024DeleteVendorConnectorMapping200Response'] +slug: /tools/sdk/powershell/v2024/models/delete-vendor-connector-mapping200-response +tags: ['SDK', 'Software Development Kit', 'DeleteVendorConnectorMapping200Response', 'V2024DeleteVendorConnectorMapping200Response'] +--- + + +# DeleteVendorConnectorMapping200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | Pointer to **Int32** | The number of vendor connector mappings successfully deleted. | [optional] + +## Examples + +- Prepare the resource +```powershell +$DeleteVendorConnectorMapping200Response = Initialize-PSSailpoint.V2024DeleteVendorConnectorMapping200Response -Count 1 +``` + +- Convert the resource to JSON +```powershell +$DeleteVendorConnectorMapping200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DeployRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DeployRequest.md new file mode 100644 index 000000000..6ba3ff3c0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DeployRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-deploy-request +title: DeployRequest +pagination_label: DeployRequest +sidebar_label: DeployRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DeployRequest', 'V2024DeployRequest'] +slug: /tools/sdk/powershell/v2024/models/deploy-request +tags: ['SDK', 'Software Development Kit', 'DeployRequest', 'V2024DeployRequest'] +--- + + +# DeployRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DraftId** | **String** | The id of the draft to be used by this deploy. | [required] + +## Examples + +- Prepare the resource +```powershell +$DeployRequest = Initialize-PSSailpoint.V2024DeployRequest -DraftId 3d0fe04b-57df-4a46-a83b-8f04b0f9d10b +``` + +- Convert the resource to JSON +```powershell +$DeployRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DeployResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DeployResponse.md new file mode 100644 index 000000000..dc79b304e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DeployResponse.md @@ -0,0 +1,57 @@ +--- +id: v2024-deploy-response +title: DeployResponse +pagination_label: DeployResponse +sidebar_label: DeployResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DeployResponse', 'V2024DeployResponse'] +slug: /tools/sdk/powershell/v2024/models/deploy-response +tags: ['SDK', 'Software Development Kit', 'DeployResponse', 'V2024DeployResponse'] +--- + + +# DeployResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | Pointer to **String** | Unique id assigned to this job. | [optional] +**Status** | Pointer to **Enum** [ "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "CANCELLED", "FAILED" ] | Status of the job. | [optional] +**Type** | Pointer to **Enum** [ "CONFIG_DEPLOY_DRAFT" ] | Type of the job, will always be CONFIG_DEPLOY_DRAFT for this type of job. | [optional] +**Message** | Pointer to **String** | Message providing information about the outcome of the deploy process. | [optional] +**RequesterName** | Pointer to **String** | The name of the user that initiated the deploy process. | [optional] +**FileExists** | Pointer to **Boolean** | Whether or not a results file was created and stored for this deploy. | [optional] [default to $true] +**Created** | Pointer to **System.DateTime** | The time the job was started. | [optional] +**Modified** | Pointer to **System.DateTime** | The time of the last update to the job. | [optional] +**Completed** | Pointer to **System.DateTime** | The time the job was completed. | [optional] +**DraftId** | Pointer to **String** | The id of the draft that was used for this deploy. | [optional] +**DraftName** | Pointer to **String** | The name of the draft that was used for this deploy. | [optional] +**CloudStorageStatus** | Pointer to **Enum** [ "SYNCED", "NOT_SYNCED", "SYNC_FAILED" ] | Whether this deploy results file has been transferred to a customer storage location. | [optional] + +## Examples + +- Prepare the resource +```powershell +$DeployResponse = Initialize-PSSailpoint.V2024DeployResponse -JobId 07659d7d-2cce-47c0-9e49-185787ee565a ` + -Status COMPLETE ` + -Type CONFIG_DEPLOY_DRAFT ` + -Message Deploy creation message ` + -RequesterName requester.name ` + -FileExists true ` + -Created 2021-05-11T22:23:16Z ` + -Modified 2021-05-11T22:23:16Z ` + -Completed 2021-05-11T22:23:16Z ` + -DraftId 07659d7d-2cce-47c0-9e49-185787ee565a ` + -DraftName Draft Name ` + -CloudStorageStatus SYNCED +``` + +- Convert the resource to JSON +```powershell +$DeployResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Dimension.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Dimension.md new file mode 100644 index 000000000..0c4245621 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Dimension.md @@ -0,0 +1,53 @@ +--- +id: v2024-dimension +title: Dimension +pagination_label: Dimension +sidebar_label: Dimension +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Dimension', 'V2024Dimension'] +slug: /tools/sdk/powershell/v2024/models/dimension +tags: ['SDK', 'Software Development Kit', 'Dimension', 'V2024Dimension'] +--- + + +# Dimension + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The id of the Dimension. This field must be left null when creating a dimension, otherwise a 400 Bad Request error will result. | [optional] +**Name** | **String** | The human-readable display name of the Dimension | [required] +**Created** | Pointer to **System.DateTime** | Date the Dimension was created | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | Date the Dimension was last modified. | [optional] [readonly] +**Description** | Pointer to **String** | A human-readable description of the Dimension | [optional] +**Owner** | [**OwnerReference**](owner-reference) | | [required] +**AccessProfiles** | Pointer to [**[]AccessProfileRef**](access-profile-ref) | | [optional] +**Entitlements** | Pointer to [**[]EntitlementRef**](entitlement-ref) | | [optional] +**Membership** | Pointer to [**DimensionMembershipSelector**](dimension-membership-selector) | | [optional] +**ParentId** | Pointer to **String** | The ID of the parent role. This field can be left null when creating a dimension, but if provided, it must match the role ID specified in the path variable of the API call. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Dimension = Initialize-PSSailpoint.V2024Dimension -Id 2c918086749d78830174a1a40e121518 ` + -Name Dimension 2567 ` + -Created 2021-03-01T22:32:58.104Z ` + -Modified 2021-03-02T20:22:28.104Z ` + -Description Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor. ` + -Owner null ` + -AccessProfiles null ` + -Entitlements null ` + -Membership null ` + -ParentId 2c918086749d78830174a1a40e121518 +``` + +- Convert the resource to JSON +```powershell +$Dimension | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionBulkDeleteRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionBulkDeleteRequest.md new file mode 100644 index 000000000..a4917b614 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionBulkDeleteRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-dimension-bulk-delete-request +title: DimensionBulkDeleteRequest +pagination_label: DimensionBulkDeleteRequest +sidebar_label: DimensionBulkDeleteRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DimensionBulkDeleteRequest', 'V2024DimensionBulkDeleteRequest'] +slug: /tools/sdk/powershell/v2024/models/dimension-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'DimensionBulkDeleteRequest', 'V2024DimensionBulkDeleteRequest'] +--- + + +# DimensionBulkDeleteRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DimensionIds** | **[]String** | List of IDs of Dimensions to be deleted. | [required] + +## Examples + +- Prepare the resource +```powershell +$DimensionBulkDeleteRequest = Initialize-PSSailpoint.V2024DimensionBulkDeleteRequest -DimensionIds [2c9180847812e0b1017817051919ecca, 2c9180887812e0b201781e129f151816] +``` + +- Convert the resource to JSON +```powershell +$DimensionBulkDeleteRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionCriteriaKey.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionCriteriaKey.md new file mode 100644 index 000000000..4be3cfadb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionCriteriaKey.md @@ -0,0 +1,37 @@ +--- +id: v2024-dimension-criteria-key +title: DimensionCriteriaKey +pagination_label: DimensionCriteriaKey +sidebar_label: DimensionCriteriaKey +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DimensionCriteriaKey', 'V2024DimensionCriteriaKey'] +slug: /tools/sdk/powershell/v2024/models/dimension-criteria-key +tags: ['SDK', 'Software Development Kit', 'DimensionCriteriaKey', 'V2024DimensionCriteriaKey'] +--- + + +# DimensionCriteriaKey + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**DimensionCriteriaKeyType**](dimension-criteria-key-type) | | [required] +**Property** | **String** | The name of the identity attribute to which the associated criteria applies. | [required] + +## Examples + +- Prepare the resource +```powershell +$DimensionCriteriaKey = Initialize-PSSailpoint.V2024DimensionCriteriaKey -Type null ` + -Property attribute.email +``` + +- Convert the resource to JSON +```powershell +$DimensionCriteriaKey | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionCriteriaKeyType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionCriteriaKeyType.md new file mode 100644 index 000000000..cbbe03c1f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionCriteriaKeyType.md @@ -0,0 +1,22 @@ +--- +id: v2024-dimension-criteria-key-type +title: DimensionCriteriaKeyType +pagination_label: DimensionCriteriaKeyType +sidebar_label: DimensionCriteriaKeyType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DimensionCriteriaKeyType', 'V2024DimensionCriteriaKeyType'] +slug: /tools/sdk/powershell/v2024/models/dimension-criteria-key-type +tags: ['SDK', 'Software Development Kit', 'DimensionCriteriaKeyType', 'V2024DimensionCriteriaKeyType'] +--- + + +# DimensionCriteriaKeyType + +## Enum + + +* `IDENTITY` (value: `"IDENTITY"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionCriteriaLevel1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionCriteriaLevel1.md new file mode 100644 index 000000000..4120a8e8a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionCriteriaLevel1.md @@ -0,0 +1,41 @@ +--- +id: v2024-dimension-criteria-level1 +title: DimensionCriteriaLevel1 +pagination_label: DimensionCriteriaLevel1 +sidebar_label: DimensionCriteriaLevel1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DimensionCriteriaLevel1', 'V2024DimensionCriteriaLevel1'] +slug: /tools/sdk/powershell/v2024/models/dimension-criteria-level1 +tags: ['SDK', 'Software Development Kit', 'DimensionCriteriaLevel1', 'V2024DimensionCriteriaLevel1'] +--- + + +# DimensionCriteriaLevel1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**DimensionCriteriaOperation**](dimension-criteria-operation) | | [optional] +**Key** | Pointer to [**DimensionCriteriaKey**](dimension-criteria-key) | | [optional] +**StringValue** | Pointer to **String** | String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is EQUALS, this field is required. Otherwise, specifying it is an error. | [optional] +**Children** | Pointer to [**[]DimensionCriteriaLevel2**](dimension-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] + +## Examples + +- Prepare the resource +```powershell +$DimensionCriteriaLevel1 = Initialize-PSSailpoint.V2024DimensionCriteriaLevel1 -Operation null ` + -Key null ` + -StringValue carlee.cert1c9f9b6fd@mailinator.com ` + -Children null +``` + +- Convert the resource to JSON +```powershell +$DimensionCriteriaLevel1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionCriteriaLevel2.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionCriteriaLevel2.md new file mode 100644 index 000000000..d84d6705a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionCriteriaLevel2.md @@ -0,0 +1,41 @@ +--- +id: v2024-dimension-criteria-level2 +title: DimensionCriteriaLevel2 +pagination_label: DimensionCriteriaLevel2 +sidebar_label: DimensionCriteriaLevel2 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DimensionCriteriaLevel2', 'V2024DimensionCriteriaLevel2'] +slug: /tools/sdk/powershell/v2024/models/dimension-criteria-level2 +tags: ['SDK', 'Software Development Kit', 'DimensionCriteriaLevel2', 'V2024DimensionCriteriaLevel2'] +--- + + +# DimensionCriteriaLevel2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**DimensionCriteriaOperation**](dimension-criteria-operation) | | [optional] +**Key** | Pointer to [**DimensionCriteriaKey**](dimension-criteria-key) | | [optional] +**StringValue** | Pointer to **String** | String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, this field is required. Otherwise, specifying it is an error. | [optional] +**Children** | Pointer to [**[]DimensionCriteriaLevel3**](dimension-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] + +## Examples + +- Prepare the resource +```powershell +$DimensionCriteriaLevel2 = Initialize-PSSailpoint.V2024DimensionCriteriaLevel2 -Operation null ` + -Key null ` + -StringValue carlee.cert1c9f9b6fd@mailinator.com ` + -Children null +``` + +- Convert the resource to JSON +```powershell +$DimensionCriteriaLevel2 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionCriteriaLevel3.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionCriteriaLevel3.md new file mode 100644 index 000000000..ad989cf19 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionCriteriaLevel3.md @@ -0,0 +1,39 @@ +--- +id: v2024-dimension-criteria-level3 +title: DimensionCriteriaLevel3 +pagination_label: DimensionCriteriaLevel3 +sidebar_label: DimensionCriteriaLevel3 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DimensionCriteriaLevel3', 'V2024DimensionCriteriaLevel3'] +slug: /tools/sdk/powershell/v2024/models/dimension-criteria-level3 +tags: ['SDK', 'Software Development Kit', 'DimensionCriteriaLevel3', 'V2024DimensionCriteriaLevel3'] +--- + + +# DimensionCriteriaLevel3 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**DimensionCriteriaOperation**](dimension-criteria-operation) | | [optional] +**Key** | Pointer to [**DimensionCriteriaKey**](dimension-criteria-key) | | [optional] +**StringValue** | Pointer to **String** | String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, this field is required. Otherwise, specifying it is an error. | [optional] + +## Examples + +- Prepare the resource +```powershell +$DimensionCriteriaLevel3 = Initialize-PSSailpoint.V2024DimensionCriteriaLevel3 -Operation null ` + -Key null ` + -StringValue carlee.cert1c9f9b6fd@mailinator.com +``` + +- Convert the resource to JSON +```powershell +$DimensionCriteriaLevel3 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionCriteriaOperation.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionCriteriaOperation.md new file mode 100644 index 000000000..fcebcce90 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionCriteriaOperation.md @@ -0,0 +1,26 @@ +--- +id: v2024-dimension-criteria-operation +title: DimensionCriteriaOperation +pagination_label: DimensionCriteriaOperation +sidebar_label: DimensionCriteriaOperation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DimensionCriteriaOperation', 'V2024DimensionCriteriaOperation'] +slug: /tools/sdk/powershell/v2024/models/dimension-criteria-operation +tags: ['SDK', 'Software Development Kit', 'DimensionCriteriaOperation', 'V2024DimensionCriteriaOperation'] +--- + + +# DimensionCriteriaOperation + +## Enum + + +* `EQUALS` (value: `"EQUALS"`) + +* `AND` (value: `"AND"`) + +* `OR` (value: `"OR"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionMembershipSelector.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionMembershipSelector.md new file mode 100644 index 000000000..829d30bfe --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionMembershipSelector.md @@ -0,0 +1,37 @@ +--- +id: v2024-dimension-membership-selector +title: DimensionMembershipSelector +pagination_label: DimensionMembershipSelector +sidebar_label: DimensionMembershipSelector +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DimensionMembershipSelector', 'V2024DimensionMembershipSelector'] +slug: /tools/sdk/powershell/v2024/models/dimension-membership-selector +tags: ['SDK', 'Software Development Kit', 'DimensionMembershipSelector', 'V2024DimensionMembershipSelector'] +--- + + +# DimensionMembershipSelector + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DimensionMembershipSelectorType**](dimension-membership-selector-type) | | [optional] +**Criteria** | Pointer to [**DimensionCriteriaLevel1**](dimension-criteria-level1) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$DimensionMembershipSelector = Initialize-PSSailpoint.V2024DimensionMembershipSelector -Type null ` + -Criteria null +``` + +- Convert the resource to JSON +```powershell +$DimensionMembershipSelector | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionMembershipSelectorType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionMembershipSelectorType.md new file mode 100644 index 000000000..36e317ade --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionMembershipSelectorType.md @@ -0,0 +1,22 @@ +--- +id: v2024-dimension-membership-selector-type +title: DimensionMembershipSelectorType +pagination_label: DimensionMembershipSelectorType +sidebar_label: DimensionMembershipSelectorType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DimensionMembershipSelectorType', 'V2024DimensionMembershipSelectorType'] +slug: /tools/sdk/powershell/v2024/models/dimension-membership-selector-type +tags: ['SDK', 'Software Development Kit', 'DimensionMembershipSelectorType', 'V2024DimensionMembershipSelectorType'] +--- + + +# DimensionMembershipSelectorType + +## Enum + + +* `STANDARD` (value: `"STANDARD"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionRef.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionRef.md new file mode 100644 index 000000000..7cd045e12 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DimensionRef.md @@ -0,0 +1,39 @@ +--- +id: v2024-dimension-ref +title: DimensionRef +pagination_label: DimensionRef +sidebar_label: DimensionRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DimensionRef', 'V2024DimensionRef'] +slug: /tools/sdk/powershell/v2024/models/dimension-ref +tags: ['SDK', 'Software Development Kit', 'DimensionRef', 'V2024DimensionRef'] +--- + + +# DimensionRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "DIMENSION" ] | The type of the object to which this reference applies | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] + +## Examples + +- Prepare the resource +```powershell +$DimensionRef = Initialize-PSSailpoint.V2024DimensionRef -Type DIMENSION ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name Role 2 +``` + +- Convert the resource to JSON +```powershell +$DimensionRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DisplayReference.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DisplayReference.md new file mode 100644 index 000000000..29781a388 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DisplayReference.md @@ -0,0 +1,39 @@ +--- +id: v2024-display-reference +title: DisplayReference +pagination_label: DisplayReference +sidebar_label: DisplayReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DisplayReference', 'V2024DisplayReference'] +slug: /tools/sdk/powershell/v2024/models/display-reference +tags: ['SDK', 'Software Development Kit', 'DisplayReference', 'V2024DisplayReference'] +--- + + +# DisplayReference + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$DisplayReference = Initialize-PSSailpoint.V2024DisplayReference -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -DisplayName John Q. Doe +``` + +- Convert the resource to JSON +```powershell +$DisplayReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DkimAttributes.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DkimAttributes.md new file mode 100644 index 000000000..e59e62e8e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DkimAttributes.md @@ -0,0 +1,43 @@ +--- +id: v2024-dkim-attributes +title: DkimAttributes +pagination_label: DkimAttributes +sidebar_label: DkimAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DkimAttributes', 'V2024DkimAttributes'] +slug: /tools/sdk/powershell/v2024/models/dkim-attributes +tags: ['SDK', 'Software Development Kit', 'DkimAttributes', 'V2024DkimAttributes'] +--- + + +# DkimAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | UUID associated with domain to be verified | [optional] +**Address** | Pointer to **String** | The identity or domain address | [optional] +**DkimEnabled** | Pointer to **Boolean** | Whether or not DKIM has been enabled for this domain / identity | [optional] [default to $false] +**DkimTokens** | Pointer to **[]String** | The tokens to be added to a DNS for verification | [optional] +**DkimVerificationStatus** | Pointer to **String** | The current status if the domain /identity has been verified. Ie Success, Failed, Pending | [optional] + +## Examples + +- Prepare the resource +```powershell +$DkimAttributes = Initialize-PSSailpoint.V2024DkimAttributes -Id 123b45b0-aaaa-bbbb-a7db-123456a56abc ` + -Address BobSmith@sailpoint.com ` + -DkimEnabled true ` + -DkimTokens [uq1m3jjk25ckd3whl4n7y46c56r5l6aq, u7pm38jky9ckdawhlsn7y4dcj6f5lpgq, uhpm3jjkjjckdkwhlqn7yw6cjer5tpay] ` + -DkimVerificationStatus Success +``` + +- Convert the resource to JSON +```powershell +$DkimAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DocumentType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DocumentType.md new file mode 100644 index 000000000..6f54438c1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DocumentType.md @@ -0,0 +1,36 @@ +--- +id: v2024-document-type +title: DocumentType +pagination_label: DocumentType +sidebar_label: DocumentType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DocumentType', 'V2024DocumentType'] +slug: /tools/sdk/powershell/v2024/models/document-type +tags: ['SDK', 'Software Development Kit', 'DocumentType', 'V2024DocumentType'] +--- + + +# DocumentType + +## Enum + + +* `accessprofile` (value: `"accessprofile"`) + +* `accountactivity` (value: `"accountactivity"`) + +* `account` (value: `"account"`) + +* `aggregation` (value: `"aggregation"`) + +* `entitlement` (value: `"entitlement"`) + +* `event` (value: `"event"`) + +* `identity` (value: `"identity"`) + +* `role` (value: `"role"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DomainAddress.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DomainAddress.md new file mode 100644 index 000000000..18dc136df --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DomainAddress.md @@ -0,0 +1,35 @@ +--- +id: v2024-domain-address +title: DomainAddress +pagination_label: DomainAddress +sidebar_label: DomainAddress +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DomainAddress', 'V2024DomainAddress'] +slug: /tools/sdk/powershell/v2024/models/domain-address +tags: ['SDK', 'Software Development Kit', 'DomainAddress', 'V2024DomainAddress'] +--- + + +# DomainAddress + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Domain** | Pointer to **String** | A domain address | [optional] + +## Examples + +- Prepare the resource +```powershell +$DomainAddress = Initialize-PSSailpoint.V2024DomainAddress -Domain sailpoint.com +``` + +- Convert the resource to JSON +```powershell +$DomainAddress | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DomainStatusDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DomainStatusDto.md new file mode 100644 index 000000000..a8fedea80 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DomainStatusDto.md @@ -0,0 +1,43 @@ +--- +id: v2024-domain-status-dto +title: DomainStatusDto +pagination_label: DomainStatusDto +sidebar_label: DomainStatusDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DomainStatusDto', 'V2024DomainStatusDto'] +slug: /tools/sdk/powershell/v2024/models/domain-status-dto +tags: ['SDK', 'Software Development Kit', 'DomainStatusDto', 'V2024DomainStatusDto'] +--- + + +# DomainStatusDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | New UUID associated with domain to be verified | [optional] +**Domain** | Pointer to **String** | A domain address | [optional] +**DkimEnabled** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | DKIM is enabled for this domain | [optional] +**DkimTokens** | Pointer to **[]String** | DKIM tokens required for authentication | [optional] +**DkimVerificationStatus** | Pointer to **String** | Status of DKIM authentication | [optional] + +## Examples + +- Prepare the resource +```powershell +$DomainStatusDto = Initialize-PSSailpoint.V2024DomainStatusDto -Id 123b45b0-aaaa-bbbb-a7db-123456a56abc ` + -Domain sailpoint.com ` + -DkimEnabled true ` + -DkimTokens [token1, token2, token3] ` + -DkimVerificationStatus PENDING +``` + +- Convert the resource to JSON +```powershell +$DomainStatusDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DraftResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DraftResponse.md new file mode 100644 index 000000000..d5ea80db7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DraftResponse.md @@ -0,0 +1,65 @@ +--- +id: v2024-draft-response +title: DraftResponse +pagination_label: DraftResponse +sidebar_label: DraftResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DraftResponse', 'V2024DraftResponse'] +slug: /tools/sdk/powershell/v2024/models/draft-response +tags: ['SDK', 'Software Development Kit', 'DraftResponse', 'V2024DraftResponse'] +--- + + +# DraftResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | Pointer to **String** | Unique id assigned to this job. | [optional] +**Status** | Pointer to **Enum** [ "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "CANCELLED", "FAILED" ] | Status of the job. | [optional] +**Type** | Pointer to **Enum** [ "CREATE_DRAFT" ] | Type of the job, will always be CREATE_DRAFT for this type of job. | [optional] +**Message** | Pointer to **String** | Message providing information about the outcome of the draft process. | [optional] +**RequesterName** | Pointer to **String** | The name of user that that initiated the draft process. | [optional] +**FileExists** | Pointer to **Boolean** | Whether or not a file was generated for this draft. | [optional] [default to $true] +**Created** | Pointer to **System.DateTime** | The time the job was started. | [optional] +**Modified** | Pointer to **System.DateTime** | The time of the last update to the job. | [optional] +**Completed** | Pointer to **System.DateTime** | The time the job was completed. | [optional] +**Name** | Pointer to **String** | Name of the draft. | [optional] +**SourceTenant** | Pointer to **String** | Tenant owner of the backup from which the draft was generated. | [optional] +**SourceBackupId** | Pointer to **String** | Id of the backup from which the draft was generated. | [optional] +**SourceBackupName** | Pointer to **String** | Name of the backup from which the draft was generated. | [optional] +**Mode** | Pointer to **Enum** [ "RESTORE", "PROMOTE", "UPLOAD" ] | Denotes the origin of the source backup from which the draft was generated. - RESTORE - Same tenant. - PROMOTE - Different tenant. - UPLOAD - Uploaded configuration. | [optional] +**ApprovalStatus** | Pointer to **Enum** [ "DEFAULT", "PENDING_APPROVAL", "APPROVED", "DENIED" ] | Approval status of the draft used to determine whether or not the draft can be deployed. | [optional] +**ApprovalComment** | Pointer to [**[]ApprovalComment**](approval-comment) | List of comments that have been exchanged between an approval requester and an approver. | [optional] + +## Examples + +- Prepare the resource +```powershell +$DraftResponse = Initialize-PSSailpoint.V2024DraftResponse -JobId 07659d7d-2cce-47c0-9e49-185787ee565a ` + -Status COMPLETE ` + -Type CREATE_DRAFT ` + -Message Draft creation message ` + -RequesterName requester.name ` + -FileExists true ` + -Created 2021-05-11T22:23:16Z ` + -Modified 2021-05-11T22:23:16Z ` + -Completed 2021-05-11T22:23:16Z ` + -Name Draft name ` + -SourceTenant source-tenant ` + -SourceBackupId 549bf881-1ac4-4a64-9acf-6014e8a3a887 ` + -SourceBackupName Source backup name ` + -Mode RESTORE ` + -ApprovalStatus APPROVED ` + -ApprovalComment null +``` + +- Convert the resource to JSON +```powershell +$DraftResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DtoType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DtoType.md new file mode 100644 index 000000000..f41f6a652 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/DtoType.md @@ -0,0 +1,78 @@ +--- +id: v2024-dto-type +title: DtoType +pagination_label: DtoType +sidebar_label: DtoType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DtoType', 'V2024DtoType'] +slug: /tools/sdk/powershell/v2024/models/dto-type +tags: ['SDK', 'Software Development Kit', 'DtoType', 'V2024DtoType'] +--- + + +# DtoType + +## Enum + + +* `ACCOUNT_CORRELATION_CONFIG` (value: `"ACCOUNT_CORRELATION_CONFIG"`) + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ACCESS_REQUEST_APPROVAL` (value: `"ACCESS_REQUEST_APPROVAL"`) + +* `ACCOUNT` (value: `"ACCOUNT"`) + +* `APPLICATION` (value: `"APPLICATION"`) + +* `CAMPAIGN` (value: `"CAMPAIGN"`) + +* `CAMPAIGN_FILTER` (value: `"CAMPAIGN_FILTER"`) + +* `CERTIFICATION` (value: `"CERTIFICATION"`) + +* `CLUSTER` (value: `"CLUSTER"`) + +* `CONNECTOR_SCHEMA` (value: `"CONNECTOR_SCHEMA"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + +* `GOVERNANCE_GROUP` (value: `"GOVERNANCE_GROUP"`) + +* `IDENTITY` (value: `"IDENTITY"`) + +* `IDENTITY_PROFILE` (value: `"IDENTITY_PROFILE"`) + +* `IDENTITY_REQUEST` (value: `"IDENTITY_REQUEST"`) + +* `MACHINE_IDENTITY` (value: `"MACHINE_IDENTITY"`) + +* `LIFECYCLE_STATE` (value: `"LIFECYCLE_STATE"`) + +* `PASSWORD_POLICY` (value: `"PASSWORD_POLICY"`) + +* `ROLE` (value: `"ROLE"`) + +* `RULE` (value: `"RULE"`) + +* `SOD_POLICY` (value: `"SOD_POLICY"`) + +* `SOURCE` (value: `"SOURCE"`) + +* `TAG` (value: `"TAG"`) + +* `TAG_CATEGORY` (value: `"TAG_CATEGORY"`) + +* `TASK_RESULT` (value: `"TASK_RESULT"`) + +* `REPORT_RESULT` (value: `"REPORT_RESULT"`) + +* `SOD_VIOLATION` (value: `"SOD_VIOLATION"`) + +* `ACCOUNT_ACTIVITY` (value: `"ACCOUNT_ACTIVITY"`) + +* `WORKGROUP` (value: `"WORKGROUP"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/E164phone.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/E164phone.md new file mode 100644 index 000000000..2fc7fe7c5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/E164phone.md @@ -0,0 +1,39 @@ +--- +id: v2024-e164phone +title: E164phone +pagination_label: E164phone +sidebar_label: E164phone +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'E164phone', 'V2024E164phone'] +slug: /tools/sdk/powershell/v2024/models/e164phone +tags: ['SDK', 'Software Development Kit', 'E164phone', 'V2024E164phone'] +--- + + +# E164phone + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DefaultRegion** | Pointer to **String** | This is an optional attribute that can be used to define the region of the phone number to format into. If defaultRegion is not provided, it will take US as the default country. The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) | [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] + +## Examples + +- Prepare the resource +```powershell +$E164phone = Initialize-PSSailpoint.V2024E164phone -DefaultRegion US ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$E164phone | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EmailNotificationOption.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EmailNotificationOption.md new file mode 100644 index 000000000..f9faba0d8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EmailNotificationOption.md @@ -0,0 +1,41 @@ +--- +id: v2024-email-notification-option +title: EmailNotificationOption +pagination_label: EmailNotificationOption +sidebar_label: EmailNotificationOption +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EmailNotificationOption', 'V2024EmailNotificationOption'] +slug: /tools/sdk/powershell/v2024/models/email-notification-option +tags: ['SDK', 'Software Development Kit', 'EmailNotificationOption', 'V2024EmailNotificationOption'] +--- + + +# EmailNotificationOption + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NotifyManagers** | Pointer to **Boolean** | If true, then the manager is notified of the lifecycle state change. | [optional] [default to $false] +**NotifyAllAdmins** | Pointer to **Boolean** | If true, then all the admins are notified of the lifecycle state change. | [optional] [default to $false] +**NotifySpecificUsers** | Pointer to **Boolean** | If true, then the users specified in ""emailAddressList"" below are notified of lifecycle state change. | [optional] [default to $false] +**EmailAddressList** | Pointer to **[]String** | List of user email addresses. If ""notifySpecificUsers"" option is true, then these users are notified of lifecycle state change. | [optional] + +## Examples + +- Prepare the resource +```powershell +$EmailNotificationOption = Initialize-PSSailpoint.V2024EmailNotificationOption -NotifyManagers true ` + -NotifyAllAdmins true ` + -NotifySpecificUsers true ` + -EmailAddressList [test@test.com, test2@test.com] +``` + +- Convert the resource to JSON +```powershell +$EmailNotificationOption | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EmailStatusDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EmailStatusDto.md new file mode 100644 index 000000000..a52374254 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EmailStatusDto.md @@ -0,0 +1,41 @@ +--- +id: v2024-email-status-dto +title: EmailStatusDto +pagination_label: EmailStatusDto +sidebar_label: EmailStatusDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EmailStatusDto', 'V2024EmailStatusDto'] +slug: /tools/sdk/powershell/v2024/models/email-status-dto +tags: ['SDK', 'Software Development Kit', 'EmailStatusDto', 'V2024EmailStatusDto'] +--- + + +# EmailStatusDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | | [optional] +**Email** | Pointer to **String** | | [optional] +**IsVerifiedByDomain** | Pointer to **Boolean** | | [optional] +**VerificationStatus** | Pointer to **Enum** [ "PENDING", "SUCCESS", "FAILED" ] | | [optional] + +## Examples + +- Prepare the resource +```powershell +$EmailStatusDto = Initialize-PSSailpoint.V2024EmailStatusDto -Id null ` + -Email sender@example.com ` + -IsVerifiedByDomain false ` + -VerificationStatus null +``` + +- Convert the resource to JSON +```powershell +$EmailStatusDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Entitlement.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Entitlement.md new file mode 100644 index 000000000..28e15e58a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Entitlement.md @@ -0,0 +1,61 @@ +--- +id: v2024-entitlement +title: Entitlement +pagination_label: Entitlement +sidebar_label: Entitlement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Entitlement', 'V2024Entitlement'] +slug: /tools/sdk/powershell/v2024/models/entitlement +tags: ['SDK', 'Software Development Kit', 'Entitlement', 'V2024Entitlement'] +--- + + +# Entitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The entitlement id | [optional] +**Name** | Pointer to **String** | The entitlement name | [optional] +**Attribute** | Pointer to **String** | The entitlement attribute name | [optional] +**Value** | Pointer to **String** | The value of the entitlement | [optional] +**SourceSchemaObjectType** | Pointer to **String** | The object type of the entitlement from the source schema | [optional] +**Description** | Pointer to **String** | The description of the entitlement | [optional] +**Privileged** | Pointer to **Boolean** | True if the entitlement is privileged | [optional] +**CloudGoverned** | Pointer to **Boolean** | True if the entitlement is cloud governed | [optional] +**Created** | Pointer to **System.DateTime** | Time when the entitlement was created | [optional] +**Modified** | Pointer to **System.DateTime** | Time when the entitlement was last modified | [optional] +**Source** | Pointer to [**EntitlementSource**](entitlement-source) | | [optional] +**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map of free-form key-value pairs from the source system | [optional] +**Segments** | Pointer to **[]String** | List of IDs of segments, if any, to which this Entitlement is assigned. | [optional] +**DirectPermissions** | Pointer to [**[]PermissionDto**](permission-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Entitlement = Initialize-PSSailpoint.V2024Entitlement -Id 2c91808874ff91550175097daaec161c ` + -Name LauncherTest2 ` + -Attribute memberOf ` + -Value CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` + -SourceSchemaObjectType group ` + -Description CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` + -Privileged true ` + -CloudGoverned true ` + -Created 2020-10-08T18:33:52.029Z ` + -Modified 2020-10-08T18:33:52.029Z ` + -Source null ` + -Attributes {fieldName=fieldValue} ` + -Segments [f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a] ` + -DirectPermissions null +``` + +- Convert the resource to JSON +```powershell +$Entitlement | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Entitlement1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Entitlement1.md new file mode 100644 index 000000000..841e64e80 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Entitlement1.md @@ -0,0 +1,69 @@ +--- +id: v2024-entitlement1 +title: Entitlement1 +pagination_label: Entitlement1 +sidebar_label: Entitlement1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Entitlement1', 'V2024Entitlement1'] +slug: /tools/sdk/powershell/v2024/models/entitlement1 +tags: ['SDK', 'Software Development Kit', 'Entitlement1', 'V2024Entitlement1'] +--- + + +# Entitlement1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The entitlement id | [optional] +**Name** | Pointer to **String** | The entitlement name | [optional] +**Created** | Pointer to **System.DateTime** | Time when the entitlement was created | [optional] +**Modified** | Pointer to **System.DateTime** | Time when the entitlement was last modified | [optional] +**Attribute** | Pointer to **String** | The entitlement attribute name | [optional] +**Value** | Pointer to **String** | The value of the entitlement | [optional] +**SourceSchemaObjectType** | Pointer to **String** | The object type of the entitlement from the source schema | [optional] +**Privileged** | Pointer to **Boolean** | True if the entitlement is privileged | [optional] [default to $false] +**CloudGoverned** | Pointer to **Boolean** | True if the entitlement is cloud governed | [optional] [default to $false] +**Description** | Pointer to **String** | The description of the entitlement | [optional] +**Requestable** | Pointer to **Boolean** | True if the entitlement is requestable | [optional] [default to $false] +**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map of free-form key-value pairs from the source system | [optional] +**Source** | Pointer to [**Entitlement1Source**](entitlement1-source) | | [optional] +**Owner** | Pointer to [**Entitlement1Owner**](entitlement1-owner) | | [optional] +**DirectPermissions** | Pointer to [**[]PermissionDto**](permission-dto) | | [optional] +**Segments** | Pointer to **[]String** | List of IDs of segments, if any, to which this Entitlement is assigned. | [optional] +**ManuallyUpdatedFields** | Pointer to [**Entitlement1ManuallyUpdatedFields**](entitlement1-manually-updated-fields) | | [optional] +**AccessModelMetadata** | Pointer to [**Entitlement1AccessModelMetadata**](entitlement1-access-model-metadata) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Entitlement1 = Initialize-PSSailpoint.V2024Entitlement1 -Id 2c91808874ff91550175097daaec161c ` + -Name LauncherTest2 ` + -Created 2020-10-08T18:33:52.029Z ` + -Modified 2020-10-08T18:33:52.029Z ` + -Attribute memberOf ` + -Value CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` + -SourceSchemaObjectType group ` + -Privileged true ` + -CloudGoverned true ` + -Description CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` + -Requestable true ` + -Attributes {fieldName=fieldValue} ` + -Source null ` + -Owner null ` + -DirectPermissions null ` + -Segments [f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a] ` + -ManuallyUpdatedFields null ` + -AccessModelMetadata null +``` + +- Convert the resource to JSON +```powershell +$Entitlement1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Entitlement1AccessModelMetadata.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Entitlement1AccessModelMetadata.md new file mode 100644 index 000000000..e5255b3f0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Entitlement1AccessModelMetadata.md @@ -0,0 +1,35 @@ +--- +id: v2024-entitlement1-access-model-metadata +title: Entitlement1AccessModelMetadata +pagination_label: Entitlement1AccessModelMetadata +sidebar_label: Entitlement1AccessModelMetadata +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Entitlement1AccessModelMetadata', 'V2024Entitlement1AccessModelMetadata'] +slug: /tools/sdk/powershell/v2024/models/entitlement1-access-model-metadata +tags: ['SDK', 'Software Development Kit', 'Entitlement1AccessModelMetadata', 'V2024Entitlement1AccessModelMetadata'] +--- + + +# Entitlement1AccessModelMetadata + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**[]AttributeDTO**](attribute-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Entitlement1AccessModelMetadata = Initialize-PSSailpoint.V2024Entitlement1AccessModelMetadata -Attributes [{key=iscPrivacy, name=Privacy, multiselect=false, status=active, type=governance, objectTypes=[all], description=Specifies the level of privacy associated with an access item., values=[{value=public, name=Public, status=active}]}] +``` + +- Convert the resource to JSON +```powershell +$Entitlement1AccessModelMetadata | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Entitlement1ManuallyUpdatedFields.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Entitlement1ManuallyUpdatedFields.md new file mode 100644 index 000000000..5355f6395 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Entitlement1ManuallyUpdatedFields.md @@ -0,0 +1,37 @@ +--- +id: v2024-entitlement1-manually-updated-fields +title: Entitlement1ManuallyUpdatedFields +pagination_label: Entitlement1ManuallyUpdatedFields +sidebar_label: Entitlement1ManuallyUpdatedFields +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Entitlement1ManuallyUpdatedFields', 'V2024Entitlement1ManuallyUpdatedFields'] +slug: /tools/sdk/powershell/v2024/models/entitlement1-manually-updated-fields +tags: ['SDK', 'Software Development Kit', 'Entitlement1ManuallyUpdatedFields', 'V2024Entitlement1ManuallyUpdatedFields'] +--- + + +# Entitlement1ManuallyUpdatedFields + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DISPLAYNAME** | Pointer to **Boolean** | True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `name` property. | [optional] [default to $false] +**DESCRIPTION** | Pointer to **Boolean** | True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `description` property. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$Entitlement1ManuallyUpdatedFields = Initialize-PSSailpoint.V2024Entitlement1ManuallyUpdatedFields -DISPLAYNAME true ` + -DESCRIPTION true +``` + +- Convert the resource to JSON +```powershell +$Entitlement1ManuallyUpdatedFields | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Entitlement1Owner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Entitlement1Owner.md new file mode 100644 index 000000000..f2b40ba05 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Entitlement1Owner.md @@ -0,0 +1,39 @@ +--- +id: v2024-entitlement1-owner +title: Entitlement1Owner +pagination_label: Entitlement1Owner +sidebar_label: Entitlement1Owner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Entitlement1Owner', 'V2024Entitlement1Owner'] +slug: /tools/sdk/powershell/v2024/models/entitlement1-owner +tags: ['SDK', 'Software Development Kit', 'Entitlement1Owner', 'V2024Entitlement1Owner'] +--- + + +# Entitlement1Owner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The owner id for the entitlement | [optional] +**Name** | Pointer to **String** | The owner name for the entitlement | [optional] +**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of the owner. Initially only type IDENTITY is supported | [optional] + +## Examples + +- Prepare the resource +```powershell +$Entitlement1Owner = Initialize-PSSailpoint.V2024Entitlement1Owner -Id 2a2fdacca5e345f18bf7970cfbb8fec2 ` + -Name identity 1 ` + -Type IDENTITY +``` + +- Convert the resource to JSON +```powershell +$Entitlement1Owner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Entitlement1Source.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Entitlement1Source.md new file mode 100644 index 000000000..c669d46ab --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Entitlement1Source.md @@ -0,0 +1,39 @@ +--- +id: v2024-entitlement1-source +title: Entitlement1Source +pagination_label: Entitlement1Source +sidebar_label: Entitlement1Source +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Entitlement1Source', 'V2024Entitlement1Source'] +slug: /tools/sdk/powershell/v2024/models/entitlement1-source +tags: ['SDK', 'Software Development Kit', 'Entitlement1Source', 'V2024Entitlement1Source'] +--- + + +# Entitlement1Source + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The source ID | [optional] +**Type** | Pointer to **String** | The source type, will always be ""SOURCE"" | [optional] +**Name** | Pointer to **String** | The source name | [optional] + +## Examples + +- Prepare the resource +```powershell +$Entitlement1Source = Initialize-PSSailpoint.V2024Entitlement1Source -Id 2c9180827ca885d7017ca8ce28a000eb ` + -Type SOURCE ` + -Name ODS-AD-Source +``` + +- Convert the resource to JSON +```powershell +$Entitlement1Source | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementAccessRequestConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementAccessRequestConfig.md new file mode 100644 index 000000000..297784e06 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementAccessRequestConfig.md @@ -0,0 +1,39 @@ +--- +id: v2024-entitlement-access-request-config +title: EntitlementAccessRequestConfig +pagination_label: EntitlementAccessRequestConfig +sidebar_label: EntitlementAccessRequestConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementAccessRequestConfig', 'V2024EntitlementAccessRequestConfig'] +slug: /tools/sdk/powershell/v2024/models/entitlement-access-request-config +tags: ['SDK', 'Software Development Kit', 'EntitlementAccessRequestConfig', 'V2024EntitlementAccessRequestConfig'] +--- + + +# EntitlementAccessRequestConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalSchemes** | Pointer to [**[]EntitlementApprovalScheme**](entitlement-approval-scheme) | Ordered list of approval steps for the access request. Empty when no approval is required. | [optional] +**RequestCommentRequired** | Pointer to **Boolean** | If the requester must provide a comment during access request. | [optional] [default to $false] +**DenialCommentRequired** | Pointer to **Boolean** | If the reviewer must provide a comment when denying the access request. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$EntitlementAccessRequestConfig = Initialize-PSSailpoint.V2024EntitlementAccessRequestConfig -ApprovalSchemes null ` + -RequestCommentRequired true ` + -DenialCommentRequired false +``` + +- Convert the resource to JSON +```powershell +$EntitlementAccessRequestConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementApprovalScheme.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementApprovalScheme.md new file mode 100644 index 000000000..6b387649f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementApprovalScheme.md @@ -0,0 +1,37 @@ +--- +id: v2024-entitlement-approval-scheme +title: EntitlementApprovalScheme +pagination_label: EntitlementApprovalScheme +sidebar_label: EntitlementApprovalScheme +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementApprovalScheme', 'V2024EntitlementApprovalScheme'] +slug: /tools/sdk/powershell/v2024/models/entitlement-approval-scheme +tags: ['SDK', 'Software Development Kit', 'EntitlementApprovalScheme', 'V2024EntitlementApprovalScheme'] +--- + + +# EntitlementApprovalScheme + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApproverType** | Pointer to **Enum** [ "ENTITLEMENT_OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **ENTITLEMENT_OWNER**: Owner of the associated Entitlement **SOURCE_OWNER**: Owner of the associated Source **MANAGER**: Manager of the Identity for whom the request is being made **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] + +## Examples + +- Prepare the resource +```powershell +$EntitlementApprovalScheme = Initialize-PSSailpoint.V2024EntitlementApprovalScheme -ApproverType GOVERNANCE_GROUP ` + -ApproverId e3eab852-8315-467f-9de7-70eda97f63c8 +``` + +- Convert the resource to JSON +```powershell +$EntitlementApprovalScheme | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementBulkUpdateRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementBulkUpdateRequest.md new file mode 100644 index 000000000..e9978bc3f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementBulkUpdateRequest.md @@ -0,0 +1,37 @@ +--- +id: v2024-entitlement-bulk-update-request +title: EntitlementBulkUpdateRequest +pagination_label: EntitlementBulkUpdateRequest +sidebar_label: EntitlementBulkUpdateRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementBulkUpdateRequest', 'V2024EntitlementBulkUpdateRequest'] +slug: /tools/sdk/powershell/v2024/models/entitlement-bulk-update-request +tags: ['SDK', 'Software Development Kit', 'EntitlementBulkUpdateRequest', 'V2024EntitlementBulkUpdateRequest'] +--- + + +# EntitlementBulkUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EntitlementIds** | **[]String** | List of entitlement ids to update | [required] +**JsonPatch** | [**[]JsonPatchOperation**](json-patch-operation) | | [required] + +## Examples + +- Prepare the resource +```powershell +$EntitlementBulkUpdateRequest = Initialize-PSSailpoint.V2024EntitlementBulkUpdateRequest -EntitlementIds [2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e, 2c91808a7624751a01762f19d692220f] ` + -JsonPatch [{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}] +``` + +- Convert the resource to JSON +```powershell +$EntitlementBulkUpdateRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementDocument.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementDocument.md new file mode 100644 index 000000000..be1559868 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementDocument.md @@ -0,0 +1,63 @@ +--- +id: v2024-entitlement-document +title: EntitlementDocument +pagination_label: EntitlementDocument +sidebar_label: EntitlementDocument +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementDocument', 'V2024EntitlementDocument'] +slug: /tools/sdk/powershell/v2024/models/entitlement-document +tags: ['SDK', 'Software Development Kit', 'EntitlementDocument', 'V2024EntitlementDocument'] +--- + + +# EntitlementDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | [required] +**Name** | **String** | | [required] +**Type** | [**DocumentType**](document-type) | | [required] +**Modified** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Synced** | Pointer to **String** | 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] +**DisplayName** | Pointer to **String** | Entitlement's display name. | [optional] +**Source** | Pointer to [**EntitlementDocumentAllOfSource**](entitlement-document-all-of-source) | | [optional] +**Segments** | Pointer to [**[]BaseSegment**](base-segment) | Segments with the role. | [optional] +**SegmentCount** | Pointer to **Int32** | Number of segments with the role. | [optional] +**Requestable** | Pointer to **Boolean** | Indicates whether the entitlement is requestable. | [optional] [default to $false] +**CloudGoverned** | Pointer to **Boolean** | Indicates whether the entitlement is cloud governed. | [optional] [default to $false] +**Created** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Privileged** | Pointer to **Boolean** | Indicates whether the entitlement is privileged. | [optional] [default to $false] +**IdentityCount** | Pointer to **Int32** | Number of identities who have access to the entitlement. | [optional] +**Tags** | Pointer to **[]String** | Tags that have been applied to the object. | [optional] + +## Examples + +- Prepare the resource +```powershell +$EntitlementDocument = Initialize-PSSailpoint.V2024EntitlementDocument -Id 2c91808375d8e80a0175e1f88a575222 ` + -Name john.doe ` + -Type null ` + -Modified 2018-06-25T20:22:28.104Z ` + -Synced null ` + -DisplayName Admin ` + -Source null ` + -Segments null ` + -SegmentCount 1 ` + -Requestable false ` + -CloudGoverned false ` + -Created 2018-06-25T20:22:28.104Z ` + -Privileged false ` + -IdentityCount 3 ` + -Tags [TAG_1, TAG_2] +``` + +- Convert the resource to JSON +```powershell +$EntitlementDocument | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementDocumentAllOfSource.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementDocumentAllOfSource.md new file mode 100644 index 000000000..711ab1d94 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementDocumentAllOfSource.md @@ -0,0 +1,37 @@ +--- +id: v2024-entitlement-document-all-of-source +title: EntitlementDocumentAllOfSource +pagination_label: EntitlementDocumentAllOfSource +sidebar_label: EntitlementDocumentAllOfSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementDocumentAllOfSource', 'V2024EntitlementDocumentAllOfSource'] +slug: /tools/sdk/powershell/v2024/models/entitlement-document-all-of-source +tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfSource', 'V2024EntitlementDocumentAllOfSource'] +--- + + +# EntitlementDocumentAllOfSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of entitlement's source. | [optional] +**Name** | Pointer to **String** | Display name of entitlement's source. | [optional] + +## Examples + +- Prepare the resource +```powershell +$EntitlementDocumentAllOfSource = Initialize-PSSailpoint.V2024EntitlementDocumentAllOfSource -Id 2c91808b6e9e6fb8016eec1a2b6f7b5f ` + -Name ODS-HR-Employees +``` + +- Convert the resource to JSON +```powershell +$EntitlementDocumentAllOfSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementDto.md new file mode 100644 index 000000000..568d3ca0d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementDto.md @@ -0,0 +1,57 @@ +--- +id: v2024-entitlement-dto +title: EntitlementDto +pagination_label: EntitlementDto +sidebar_label: EntitlementDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementDto', 'V2024EntitlementDto'] +slug: /tools/sdk/powershell/v2024/models/entitlement-dto +tags: ['SDK', 'Software Development Kit', 'EntitlementDto', 'V2024EntitlementDto'] +--- + + +# EntitlementDto + +## Properties + +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] +**Attribute** | Pointer to **String** | Name of the entitlement attribute | [optional] +**Value** | Pointer to **String** | Raw value of the entitlement | [optional] +**Description** | Pointer to **String** | Entitlment description | [optional] +**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Entitlement attributes | [optional] +**SourceSchemaObjectType** | Pointer to **String** | Schema objectType on the given application that maps to an Account Group | [optional] +**Privileged** | Pointer to **Boolean** | Determines if this Entitlement is privileged. | [optional] +**CloudGoverned** | Pointer to **Boolean** | Determines if this Entitlement is goverened in the cloud. | [optional] +**Source** | Pointer to [**EntitlementSource**](entitlement-source) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$EntitlementDto = Initialize-PSSailpoint.V2024EntitlementDto -Id id12345 ` + -Name aName ` + -Created 2015-05-28T14:07:17Z ` + -Modified 2015-05-28T14:07:17Z ` + -Attribute authorizationType ` + -Value CN=Users,dc=sailpoint,dc=com ` + -Description Active Directory DC ` + -Attributes {GroupType=Security, sAMAccountName=Buyer} ` + -SourceSchemaObjectType group ` + -Privileged false ` + -CloudGoverned false ` + -Source null +``` + +- Convert the resource to JSON +```powershell +$EntitlementDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementRef.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementRef.md new file mode 100644 index 000000000..dcbbc5c6e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementRef.md @@ -0,0 +1,39 @@ +--- +id: v2024-entitlement-ref +title: EntitlementRef +pagination_label: EntitlementRef +sidebar_label: EntitlementRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementRef', 'V2024EntitlementRef'] +slug: /tools/sdk/powershell/v2024/models/entitlement-ref +tags: ['SDK', 'Software Development Kit', 'EntitlementRef', 'V2024EntitlementRef'] +--- + + +# EntitlementRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | Entitlement's DTO type. | [optional] +**Id** | Pointer to **String** | Entitlement's ID. | [optional] +**Name** | Pointer to **String** | Entitlement's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$EntitlementRef = Initialize-PSSailpoint.V2024EntitlementRef -Type ENTITLEMENT ` + -Id 2c91809773dee32014e13e122092014e ` + -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local +``` + +- Convert the resource to JSON +```powershell +$EntitlementRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementRef1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementRef1.md new file mode 100644 index 000000000..eb32e2ee6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementRef1.md @@ -0,0 +1,39 @@ +--- +id: v2024-entitlement-ref1 +title: EntitlementRef1 +pagination_label: EntitlementRef1 +sidebar_label: EntitlementRef1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementRef1', 'V2024EntitlementRef1'] +slug: /tools/sdk/powershell/v2024/models/entitlement-ref1 +tags: ['SDK', 'Software Development Kit', 'EntitlementRef1', 'V2024EntitlementRef1'] +--- + + +# EntitlementRef1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | Entitlement's DTO type. | [optional] +**Id** | Pointer to **String** | Entitlement's ID. | [optional] +**Name** | Pointer to **String** | Entitlement's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$EntitlementRef1 = Initialize-PSSailpoint.V2024EntitlementRef1 -Type ENTITLEMENT ` + -Id 2c91809773dee32014e13e122092014e ` + -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local +``` + +- Convert the resource to JSON +```powershell +$EntitlementRef1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementRequestConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementRequestConfig.md new file mode 100644 index 000000000..9b0fe721d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementRequestConfig.md @@ -0,0 +1,35 @@ +--- +id: v2024-entitlement-request-config +title: EntitlementRequestConfig +pagination_label: EntitlementRequestConfig +sidebar_label: EntitlementRequestConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementRequestConfig', 'V2024EntitlementRequestConfig'] +slug: /tools/sdk/powershell/v2024/models/entitlement-request-config +tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig', 'V2024EntitlementRequestConfig'] +--- + + +# EntitlementRequestConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestConfig** | Pointer to [**EntitlementAccessRequestConfig**](entitlement-access-request-config) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$EntitlementRequestConfig = Initialize-PSSailpoint.V2024EntitlementRequestConfig -AccessRequestConfig null +``` + +- Convert the resource to JSON +```powershell +$EntitlementRequestConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementRequestConfig1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementRequestConfig1.md new file mode 100644 index 000000000..373c82699 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementRequestConfig1.md @@ -0,0 +1,41 @@ +--- +id: v2024-entitlement-request-config1 +title: EntitlementRequestConfig1 +pagination_label: EntitlementRequestConfig1 +sidebar_label: EntitlementRequestConfig1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementRequestConfig1', 'V2024EntitlementRequestConfig1'] +slug: /tools/sdk/powershell/v2024/models/entitlement-request-config1 +tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig1', 'V2024EntitlementRequestConfig1'] +--- + + +# EntitlementRequestConfig1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AllowEntitlementRequest** | Pointer to **Boolean** | If this is true, entitlement requests are allowed. | [optional] [default to $false] +**RequestCommentsRequired** | Pointer to **Boolean** | If this is true, comments are required to submit entitlement requests. | [optional] [default to $false] +**DeniedCommentsRequired** | Pointer to **Boolean** | If this is true, comments are required to reject entitlement requests. | [optional] [default to $false] +**GrantRequestApprovalSchemes** | Pointer to **String** | Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are ""entitlementOwner"", ""sourceOwner"", ""manager"" and ""`workgroup:{id}`"". You can use multiple governance groups (workgroups). | [optional] [default to "sourceOwner"] + +## Examples + +- Prepare the resource +```powershell +$EntitlementRequestConfig1 = Initialize-PSSailpoint.V2024EntitlementRequestConfig1 -AllowEntitlementRequest true ` + -RequestCommentsRequired false ` + -DeniedCommentsRequired false ` + -GrantRequestApprovalSchemes entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584 +``` + +- Convert the resource to JSON +```powershell +$EntitlementRequestConfig1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementSource.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementSource.md new file mode 100644 index 000000000..06036737a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementSource.md @@ -0,0 +1,39 @@ +--- +id: v2024-entitlement-source +title: EntitlementSource +pagination_label: EntitlementSource +sidebar_label: EntitlementSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementSource', 'V2024EntitlementSource'] +slug: /tools/sdk/powershell/v2024/models/entitlement-source +tags: ['SDK', 'Software Development Kit', 'EntitlementSource', 'V2024EntitlementSource'] +--- + + +# EntitlementSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The source ID | [optional] +**Type** | Pointer to **String** | The source type, will always be ""SOURCE"" | [optional] +**Name** | Pointer to **String** | The source name | [optional] + +## Examples + +- Prepare the resource +```powershell +$EntitlementSource = Initialize-PSSailpoint.V2024EntitlementSource -Id 2c9180827ca885d7017ca8ce28a000eb ` + -Type SOURCE ` + -Name ODS-AD-Source +``` + +- Convert the resource to JSON +```powershell +$EntitlementSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementSourceResetBaseReferenceDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementSourceResetBaseReferenceDto.md new file mode 100644 index 000000000..8bf7cc16c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementSourceResetBaseReferenceDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-entitlement-source-reset-base-reference-dto +title: EntitlementSourceResetBaseReferenceDto +pagination_label: EntitlementSourceResetBaseReferenceDto +sidebar_label: EntitlementSourceResetBaseReferenceDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementSourceResetBaseReferenceDto', 'V2024EntitlementSourceResetBaseReferenceDto'] +slug: /tools/sdk/powershell/v2024/models/entitlement-source-reset-base-reference-dto +tags: ['SDK', 'Software Development Kit', 'EntitlementSourceResetBaseReferenceDto', 'V2024EntitlementSourceResetBaseReferenceDto'] +--- + + +# EntitlementSourceResetBaseReferenceDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **String** | The DTO type | [optional] +**Id** | Pointer to **String** | The task ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] + +## Examples + +- Prepare the resource +```powershell +$EntitlementSourceResetBaseReferenceDto = Initialize-PSSailpoint.V2024EntitlementSourceResetBaseReferenceDto -Type TASK_RESULT ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name Entitlement Source Reset +``` + +- Convert the resource to JSON +```powershell +$EntitlementSourceResetBaseReferenceDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementSummary.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementSummary.md new file mode 100644 index 000000000..4ac84690f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntitlementSummary.md @@ -0,0 +1,53 @@ +--- +id: v2024-entitlement-summary +title: EntitlementSummary +pagination_label: EntitlementSummary +sidebar_label: EntitlementSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementSummary', 'V2024EntitlementSummary'] +slug: /tools/sdk/powershell/v2024/models/entitlement-summary +tags: ['SDK', 'Software Development Kit', 'EntitlementSummary', 'V2024EntitlementSummary'] +--- + + +# EntitlementSummary + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$EntitlementSummary = Initialize-PSSailpoint.V2024EntitlementSummary -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -DisplayName John Q. Doe ` + -Type null ` + -Description null ` + -Source null ` + -Privileged false ` + -Attribute memberOf ` + -Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com ` + -Standalone false +``` + +- Convert the resource to JSON +```powershell +$EntitlementSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntityCreatedByDTO.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntityCreatedByDTO.md new file mode 100644 index 000000000..c89af2799 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EntityCreatedByDTO.md @@ -0,0 +1,37 @@ +--- +id: v2024-entity-created-by-dto +title: EntityCreatedByDTO +pagination_label: EntityCreatedByDTO +sidebar_label: EntityCreatedByDTO +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntityCreatedByDTO', 'V2024EntityCreatedByDTO'] +slug: /tools/sdk/powershell/v2024/models/entity-created-by-dto +tags: ['SDK', 'Software Development Kit', 'EntityCreatedByDTO', 'V2024EntityCreatedByDTO'] +--- + + +# EntityCreatedByDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the creator | [optional] +**DisplayName** | Pointer to **String** | The display name of the creator | [optional] + +## Examples + +- Prepare the resource +```powershell +$EntityCreatedByDTO = Initialize-PSSailpoint.V2024EntityCreatedByDTO -Id 2c918090761a5aac0176215c46a62d58 ` + -DisplayName Ashley.Pierce +``` + +- Convert the resource to JSON +```powershell +$EntityCreatedByDTO | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Error.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Error.md new file mode 100644 index 000000000..ea1ae54e1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Error.md @@ -0,0 +1,39 @@ +--- +id: v2024-model-error +title: ModelError +pagination_label: ModelError +sidebar_label: ModelError +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ModelError', 'V2024ModelError'] +slug: /tools/sdk/powershell/v2024/models/model-error +tags: ['SDK', 'Software Development Kit', 'ModelError', 'V2024ModelError'] +--- + + +# ModelError + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetailCode** | Pointer to **String** | DetailCode is the text of the status code returned | [optional] +**Messages** | Pointer to [**[]ErrorMessage**](error-message) | | [optional] +**TrackingId** | Pointer to **String** | TrackingID is the request tracking unique identifier | [optional] + +## Examples + +- Prepare the resource +```powershell +$ModelError = Initialize-PSSailpoint.V2024ModelError -DetailCode Internal Server Error ` + -Messages null ` + -TrackingId 9cd03ef80e6a425eb6b11bdbb057cdb4 +``` + +- Convert the resource to JSON +```powershell +$ModelError | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ErrorMessage.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ErrorMessage.md new file mode 100644 index 000000000..0d6e437e0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ErrorMessage.md @@ -0,0 +1,39 @@ +--- +id: v2024-error-message +title: ErrorMessage +pagination_label: ErrorMessage +sidebar_label: ErrorMessage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ErrorMessage', 'V2024ErrorMessage'] +slug: /tools/sdk/powershell/v2024/models/error-message +tags: ['SDK', 'Software Development Kit', 'ErrorMessage', 'V2024ErrorMessage'] +--- + + +# ErrorMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Locale** | Pointer to **String** | Locale is the current Locale | [optional] +**LocaleOrigin** | Pointer to **String** | LocaleOrigin holds possible values of how the locale was selected | [optional] +**Text** | Pointer to **String** | Text is the actual text of the error message | [optional] + +## Examples + +- Prepare the resource +```powershell +$ErrorMessage = Initialize-PSSailpoint.V2024ErrorMessage -Locale en-US ` + -LocaleOrigin DEFAULT ` + -Text This is an error +``` + +- Convert the resource to JSON +```powershell +$ErrorMessage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ErrorMessageDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ErrorMessageDto.md new file mode 100644 index 000000000..0130cf790 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ErrorMessageDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-error-message-dto +title: ErrorMessageDto +pagination_label: ErrorMessageDto +sidebar_label: ErrorMessageDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ErrorMessageDto', 'V2024ErrorMessageDto'] +slug: /tools/sdk/powershell/v2024/models/error-message-dto +tags: ['SDK', 'Software Development Kit', 'ErrorMessageDto', 'V2024ErrorMessageDto'] +--- + + +# ErrorMessageDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Locale** | Pointer to **String** | The locale for the message text, a BCP 47 language tag. | [optional] +**LocaleOrigin** | Pointer to [**LocaleOrigin**](locale-origin) | | [optional] +**Text** | Pointer to **String** | Actual text of the error message in the indicated locale. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ErrorMessageDto = Initialize-PSSailpoint.V2024ErrorMessageDto -Locale en-US ` + -LocaleOrigin null ` + -Text The request was syntactically correct but its content is semantically invalid. +``` + +- Convert the resource to JSON +```powershell +$ErrorMessageDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ErrorMessageDto1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ErrorMessageDto1.md new file mode 100644 index 000000000..b81d43d2d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ErrorMessageDto1.md @@ -0,0 +1,39 @@ +--- +id: v2024-error-message-dto1 +title: ErrorMessageDto1 +pagination_label: ErrorMessageDto1 +sidebar_label: ErrorMessageDto1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ErrorMessageDto1', 'V2024ErrorMessageDto1'] +slug: /tools/sdk/powershell/v2024/models/error-message-dto1 +tags: ['SDK', 'Software Development Kit', 'ErrorMessageDto1', 'V2024ErrorMessageDto1'] +--- + + +# ErrorMessageDto1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Locale** | Pointer to **String** | The locale for the message text, a BCP 47 language tag. | [optional] +**LocaleOrigin** | Pointer to [**LocaleOrigin**](locale-origin) | | [optional] +**Text** | Pointer to **String** | Actual text of the error message in the indicated locale. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ErrorMessageDto1 = Initialize-PSSailpoint.V2024ErrorMessageDto1 -Locale en-US ` + -LocaleOrigin null ` + -Text The request was syntactically correct but its content is semantically invalid. +``` + +- Convert the resource to JSON +```powershell +$ErrorMessageDto1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ErrorResponseDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ErrorResponseDto.md new file mode 100644 index 000000000..4b00e5df2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ErrorResponseDto.md @@ -0,0 +1,41 @@ +--- +id: v2024-error-response-dto +title: ErrorResponseDto +pagination_label: ErrorResponseDto +sidebar_label: ErrorResponseDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ErrorResponseDto', 'V2024ErrorResponseDto'] +slug: /tools/sdk/powershell/v2024/models/error-response-dto +tags: ['SDK', 'Software Development Kit', 'ErrorResponseDto', 'V2024ErrorResponseDto'] +--- + + +# ErrorResponseDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetailCode** | Pointer to **String** | Fine-grained error code providing more detail of the error. | [optional] +**TrackingId** | Pointer to **String** | Unique tracking id for the error. | [optional] +**Messages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | Generic localized reason for error | [optional] +**Causes** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [optional] + +## Examples + +- Prepare the resource +```powershell +$ErrorResponseDto = Initialize-PSSailpoint.V2024ErrorResponseDto -DetailCode 400.1 Bad Request Content ` + -TrackingId e7eab60924f64aa284175b9fa3309599 ` + -Messages null ` + -Causes null +``` + +- Convert the resource to JSON +```powershell +$ErrorResponseDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EvaluateResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EvaluateResponse.md new file mode 100644 index 000000000..e0b6fe494 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EvaluateResponse.md @@ -0,0 +1,37 @@ +--- +id: v2024-evaluate-response +title: EvaluateResponse +pagination_label: EvaluateResponse +sidebar_label: EvaluateResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EvaluateResponse', 'V2024EvaluateResponse'] +slug: /tools/sdk/powershell/v2024/models/evaluate-response +tags: ['SDK', 'Software Development Kit', 'EvaluateResponse', 'V2024EvaluateResponse'] +--- + + +# EvaluateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReassignToId** | Pointer to **String** | The Identity ID which should be the recipient of any work items sent to a specific identity & work type | [optional] +**LookupTrail** | Pointer to [**[]LookupStep**](lookup-step) | List of Reassignments found by looking up the next `TargetIdentity` in a ReassignmentConfiguration | [optional] + +## Examples + +- Prepare the resource +```powershell +$EvaluateResponse = Initialize-PSSailpoint.V2024EvaluateResponse -ReassignToId 869320b6b6f34a169b6178b1a865e66f ` + -LookupTrail null +``` + +- Convert the resource to JSON +```powershell +$EvaluateResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Event.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Event.md new file mode 100644 index 000000000..01dfe0ee3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Event.md @@ -0,0 +1,69 @@ +--- +id: v2024-model-event +title: ModelEvent +pagination_label: ModelEvent +sidebar_label: ModelEvent +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ModelEvent', 'V2024ModelEvent'] +slug: /tools/sdk/powershell/v2024/models/model-event +tags: ['SDK', 'Software Development Kit', 'ModelEvent', 'V2024ModelEvent'] +--- + + +# ModelEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | [required] +**Name** | **String** | | [required] +**Type** | [**DocumentType**](document-type) | | [required] +**Created** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Synced** | Pointer to **String** | 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] +**Action** | Pointer to **String** | Name of the event as it's displayed in audit reports. | [optional] +**Type** | Pointer to **String** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional] +**Actor** | Pointer to **String** | Name of the actor that generated the event. | [optional] +**Target** | Pointer to **String** | Name of the target, or recipient, of the event. | [optional] +**Stack** | Pointer to **String** | The event's stack. | [optional] +**TrackingNumber** | Pointer to **String** | ID of the group of events. | [optional] +**IpAddress** | Pointer to **String** | Target system's IP address. | [optional] +**Details** | Pointer to **String** | ID of event's details. | [optional] +**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Attributes involved in the event. | [optional] +**Objects** | Pointer to **[]String** | Objects the event is happening to. | [optional] +**Operation** | Pointer to **String** | Operation, or action, performed during the event. | [optional] +**Status** | Pointer to **String** | Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. | [optional] +**TechnicalName** | Pointer to **String** | Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ModelEvent = Initialize-PSSailpoint.V2024ModelEvent -Id 2c91808375d8e80a0175e1f88a575222 ` + -Name john.doe ` + -Type null ` + -Created 2018-06-25T20:22:28.104Z ` + -Synced null ` + -Action update ` + -Type SYSTEM_CONFIG ` + -Actor System ` + -Target Carol.Adams ` + -Stack tpe ` + -TrackingNumber 63f891e0735f4cc8bf1968144a1e7440 ` + -IpAddress 52.52.97.85 ` + -Details 73b65dfbed1842548c207432a18c84b0 ` + -Attributes {pod=stg03-useast1, org=acme, sourceName=SailPoint} ` + -Objects null ` + -Operation REQUEST ` + -Status PASSED ` + -TechnicalName AUTHENTICATION_REQUEST_PASSED +``` + +- Convert the resource to JSON +```powershell +$ModelEvent | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EventAttributes.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EventAttributes.md new file mode 100644 index 000000000..a47458863 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EventAttributes.md @@ -0,0 +1,41 @@ +--- +id: v2024-event-attributes +title: EventAttributes +pagination_label: EventAttributes +sidebar_label: EventAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EventAttributes', 'V2024EventAttributes'] +slug: /tools/sdk/powershell/v2024/models/event-attributes +tags: ['SDK', 'Software Development Kit', 'EventAttributes', 'V2024EventAttributes'] +--- + + +# EventAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the trigger | [required] +**VarFilter** | Pointer to **String** | JSON path expression that will limit which events the trigger will fire on | [optional] +**Description** | Pointer to **String** | Description of the event trigger | [optional] +**AttributeToFilter** | Pointer to **String** | The attribute to filter on | [optional] + +## Examples + +- Prepare the resource +```powershell +$EventAttributes = Initialize-PSSailpoint.V2024EventAttributes -Id idn:identity-attributes-changed ` + -VarFilter $.changes[?(@.attribute == 'manager')] ` + -Description Triggered when an identity's manager attribute changes ` + -AttributeToFilter LifecycleState +``` + +- Convert the resource to JSON +```powershell +$EventAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EventBridgeConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EventBridgeConfig.md new file mode 100644 index 000000000..5ebcbbab2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EventBridgeConfig.md @@ -0,0 +1,37 @@ +--- +id: v2024-event-bridge-config +title: EventBridgeConfig +pagination_label: EventBridgeConfig +sidebar_label: EventBridgeConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EventBridgeConfig', 'V2024EventBridgeConfig'] +slug: /tools/sdk/powershell/v2024/models/event-bridge-config +tags: ['SDK', 'Software Development Kit', 'EventBridgeConfig', 'V2024EventBridgeConfig'] +--- + + +# EventBridgeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AwsAccount** | **String** | AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource. | [required] +**AwsRegion** | **String** | AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values. | [required] + +## Examples + +- Prepare the resource +```powershell +$EventBridgeConfig = Initialize-PSSailpoint.V2024EventBridgeConfig -AwsAccount 123456789012 ` + -AwsRegion us-west-1 +``` + +- Convert the resource to JSON +```powershell +$EventBridgeConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EventDocument.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EventDocument.md new file mode 100644 index 000000000..7b345c653 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/EventDocument.md @@ -0,0 +1,69 @@ +--- +id: v2024-event-document +title: EventDocument +pagination_label: EventDocument +sidebar_label: EventDocument +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EventDocument', 'V2024EventDocument'] +slug: /tools/sdk/powershell/v2024/models/event-document +tags: ['SDK', 'Software Development Kit', 'EventDocument', 'V2024EventDocument'] +--- + + +# EventDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | [required] +**Name** | **String** | | [required] +**Type** | [**DocumentType**](document-type) | | [required] +**Created** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Synced** | Pointer to **String** | 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] +**Action** | Pointer to **String** | Name of the event as it's displayed in audit reports. | [optional] +**Type** | Pointer to **String** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional] +**Actor** | Pointer to **String** | Name of the actor that generated the event. | [optional] +**Target** | Pointer to **String** | Name of the target, or recipient, of the event. | [optional] +**Stack** | Pointer to **String** | The event's stack. | [optional] +**TrackingNumber** | Pointer to **String** | ID of the group of events. | [optional] +**IpAddress** | Pointer to **String** | Target system's IP address. | [optional] +**Details** | Pointer to **String** | ID of event's details. | [optional] +**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Attributes involved in the event. | [optional] +**Objects** | Pointer to **[]String** | Objects the event is happening to. | [optional] +**Operation** | Pointer to **String** | Operation, or action, performed during the event. | [optional] +**Status** | Pointer to **String** | Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. | [optional] +**TechnicalName** | Pointer to **String** | Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. | [optional] + +## Examples + +- Prepare the resource +```powershell +$EventDocument = Initialize-PSSailpoint.V2024EventDocument -Id 2c91808375d8e80a0175e1f88a575222 ` + -Name john.doe ` + -Type null ` + -Created 2018-06-25T20:22:28.104Z ` + -Synced null ` + -Action update ` + -Type SYSTEM_CONFIG ` + -Actor System ` + -Target Carol.Adams ` + -Stack tpe ` + -TrackingNumber 63f891e0735f4cc8bf1968144a1e7440 ` + -IpAddress 52.52.97.85 ` + -Details 73b65dfbed1842548c207432a18c84b0 ` + -Attributes {pod=stg03-useast1, org=acme, sourceName=SailPoint} ` + -Objects null ` + -Operation REQUEST ` + -Status PASSED ` + -TechnicalName AUTHENTICATION_REQUEST_PASSED +``` + +- Convert the resource to JSON +```powershell +$EventDocument | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExceptionAccessCriteria.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExceptionAccessCriteria.md new file mode 100644 index 000000000..c8b28b5f9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExceptionAccessCriteria.md @@ -0,0 +1,37 @@ +--- +id: v2024-exception-access-criteria +title: ExceptionAccessCriteria +pagination_label: ExceptionAccessCriteria +sidebar_label: ExceptionAccessCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExceptionAccessCriteria', 'V2024ExceptionAccessCriteria'] +slug: /tools/sdk/powershell/v2024/models/exception-access-criteria +tags: ['SDK', 'Software Development Kit', 'ExceptionAccessCriteria', 'V2024ExceptionAccessCriteria'] +--- + + +# ExceptionAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**ExceptionCriteria**](exception-criteria) | | [optional] +**RightCriteria** | Pointer to [**ExceptionCriteria**](exception-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ExceptionAccessCriteria = Initialize-PSSailpoint.V2024ExceptionAccessCriteria -LeftCriteria null ` + -RightCriteria null +``` + +- Convert the resource to JSON +```powershell +$ExceptionAccessCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExceptionCriteria.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExceptionCriteria.md new file mode 100644 index 000000000..a2d04d770 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExceptionCriteria.md @@ -0,0 +1,35 @@ +--- +id: v2024-exception-criteria +title: ExceptionCriteria +pagination_label: ExceptionCriteria +sidebar_label: ExceptionCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExceptionCriteria', 'V2024ExceptionCriteria'] +slug: /tools/sdk/powershell/v2024/models/exception-criteria +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteria', 'V2024ExceptionCriteria'] +--- + + +# ExceptionCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CriteriaList** | Pointer to [**[]ExceptionCriteriaCriteriaListInner**](exception-criteria-criteria-list-inner) | List of exception criteria. There is a min of 1 and max of 50 items in the list. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ExceptionCriteria = Initialize-PSSailpoint.V2024ExceptionCriteria -CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, existing=true}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, existing=false}] +``` + +- Convert the resource to JSON +```powershell +$ExceptionCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExceptionCriteriaAccess.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExceptionCriteriaAccess.md new file mode 100644 index 000000000..37e8250c9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExceptionCriteriaAccess.md @@ -0,0 +1,41 @@ +--- +id: v2024-exception-criteria-access +title: ExceptionCriteriaAccess +pagination_label: ExceptionCriteriaAccess +sidebar_label: ExceptionCriteriaAccess +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExceptionCriteriaAccess', 'V2024ExceptionCriteriaAccess'] +slug: /tools/sdk/powershell/v2024/models/exception-criteria-access +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteriaAccess', 'V2024ExceptionCriteriaAccess'] +--- + + +# ExceptionCriteriaAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] +**Existing** | Pointer to **Boolean** | Whether the subject identity already had that access or not | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$ExceptionCriteriaAccess = Initialize-PSSailpoint.V2024ExceptionCriteriaAccess -Type null ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local ` + -Existing true +``` + +- Convert the resource to JSON +```powershell +$ExceptionCriteriaAccess | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExceptionCriteriaCriteriaListInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExceptionCriteriaCriteriaListInner.md new file mode 100644 index 000000000..6884ddde1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExceptionCriteriaCriteriaListInner.md @@ -0,0 +1,41 @@ +--- +id: v2024-exception-criteria-criteria-list-inner +title: ExceptionCriteriaCriteriaListInner +pagination_label: ExceptionCriteriaCriteriaListInner +sidebar_label: ExceptionCriteriaCriteriaListInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExceptionCriteriaCriteriaListInner', 'V2024ExceptionCriteriaCriteriaListInner'] +slug: /tools/sdk/powershell/v2024/models/exception-criteria-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteriaCriteriaListInner', 'V2024ExceptionCriteriaCriteriaListInner'] +--- + + +# ExceptionCriteriaCriteriaListInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | The type of object that is referenced | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] +**Existing** | Pointer to **Boolean** | Whether the subject identity already had that access or not | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$ExceptionCriteriaCriteriaListInner = Initialize-PSSailpoint.V2024ExceptionCriteriaCriteriaListInner -Type ENTITLEMENT ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local ` + -Existing true +``` + +- Convert the resource to JSON +```powershell +$ExceptionCriteriaCriteriaListInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExecutionStatus.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExecutionStatus.md new file mode 100644 index 000000000..f4447a941 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExecutionStatus.md @@ -0,0 +1,28 @@ +--- +id: v2024-execution-status +title: ExecutionStatus +pagination_label: ExecutionStatus +sidebar_label: ExecutionStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExecutionStatus', 'V2024ExecutionStatus'] +slug: /tools/sdk/powershell/v2024/models/execution-status +tags: ['SDK', 'Software Development Kit', 'ExecutionStatus', 'V2024ExecutionStatus'] +--- + + +# ExecutionStatus + +## Enum + + +* `EXECUTING` (value: `"EXECUTING"`) + +* `VERIFYING` (value: `"VERIFYING"`) + +* `TERMINATED` (value: `"TERMINATED"`) + +* `COMPLETED` (value: `"COMPLETED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExpansionItem.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExpansionItem.md new file mode 100644 index 000000000..0d2687e08 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExpansionItem.md @@ -0,0 +1,43 @@ +--- +id: v2024-expansion-item +title: ExpansionItem +pagination_label: ExpansionItem +sidebar_label: ExpansionItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExpansionItem', 'V2024ExpansionItem'] +slug: /tools/sdk/powershell/v2024/models/expansion-item +tags: ['SDK', 'Software Development Kit', 'ExpansionItem', 'V2024ExpansionItem'] +--- + + +# ExpansionItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | Pointer to **String** | The ID of the account | [optional] +**Cause** | Pointer to **String** | | [optional] +**Name** | Pointer to **String** | The name of the item | [optional] +**AttributeRequests** | Pointer to [**[]AttributeRequest**](attribute-request) | | [optional] +**Source** | Pointer to [**AccountSource**](account-source) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ExpansionItem = Initialize-PSSailpoint.V2024ExpansionItem -AccountId 2c91808981f58ea601821c3e93482e6f ` + -Cause Role ` + -Name smartsheet-role ` + -AttributeRequests null ` + -Source null +``` + +- Convert the resource to JSON +```powershell +$ExpansionItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExportFormDefinitionsByTenant200ResponseInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExportFormDefinitionsByTenant200ResponseInner.md new file mode 100644 index 000000000..0aa1e3add --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExportFormDefinitionsByTenant200ResponseInner.md @@ -0,0 +1,39 @@ +--- +id: v2024-export-form-definitions-by-tenant200-response-inner +title: ExportFormDefinitionsByTenant200ResponseInner +pagination_label: ExportFormDefinitionsByTenant200ResponseInner +sidebar_label: ExportFormDefinitionsByTenant200ResponseInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExportFormDefinitionsByTenant200ResponseInner', 'V2024ExportFormDefinitionsByTenant200ResponseInner'] +slug: /tools/sdk/powershell/v2024/models/export-form-definitions-by-tenant200-response-inner +tags: ['SDK', 'Software Development Kit', 'ExportFormDefinitionsByTenant200ResponseInner', 'V2024ExportFormDefinitionsByTenant200ResponseInner'] +--- + + +# ExportFormDefinitionsByTenant200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Object** | Pointer to [**FormDefinitionResponse**](form-definition-response) | | [optional] +**Self** | Pointer to **String** | | [optional] +**Version** | Pointer to **Int32** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ExportFormDefinitionsByTenant200ResponseInner = Initialize-PSSailpoint.V2024ExportFormDefinitionsByTenant200ResponseInner -Object null ` + -Self null ` + -Version null +``` + +- Convert the resource to JSON +```powershell +$ExportFormDefinitionsByTenant200ResponseInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExportOptions.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExportOptions.md new file mode 100644 index 000000000..74d153efa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExportOptions.md @@ -0,0 +1,39 @@ +--- +id: v2024-export-options +title: ExportOptions +pagination_label: ExportOptions +sidebar_label: ExportOptions +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExportOptions', 'V2024ExportOptions'] +slug: /tools/sdk/powershell/v2024/models/export-options +tags: ['SDK', 'Software Development Kit', 'ExportOptions', 'V2024ExportOptions'] +--- + + +# ExportOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExcludeTypes** | Pointer to **[]String** | Object type names to be excluded from an sp-config export command. | [optional] +**IncludeTypes** | Pointer to **[]String** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional] +**ObjectOptions** | Pointer to [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional] + +## Examples + +- Prepare the resource +```powershell +$ExportOptions = Initialize-PSSailpoint.V2024ExportOptions -ExcludeTypes null ` + -IncludeTypes null ` + -ObjectOptions {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}} +``` + +- Convert the resource to JSON +```powershell +$ExportOptions | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExportPayload.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExportPayload.md new file mode 100644 index 000000000..a3675b6eb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExportPayload.md @@ -0,0 +1,41 @@ +--- +id: v2024-export-payload +title: ExportPayload +pagination_label: ExportPayload +sidebar_label: ExportPayload +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExportPayload', 'V2024ExportPayload'] +slug: /tools/sdk/powershell/v2024/models/export-payload +tags: ['SDK', 'Software Development Kit', 'ExportPayload', 'V2024ExportPayload'] +--- + + +# ExportPayload + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **String** | Optional user defined description/name for export job. | [optional] +**ExcludeTypes** | Pointer to **[]String** | Object type names to be excluded from an sp-config export command. | [optional] +**IncludeTypes** | Pointer to **[]String** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional] +**ObjectOptions** | Pointer to [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional] + +## Examples + +- Prepare the resource +```powershell +$ExportPayload = Initialize-PSSailpoint.V2024ExportPayload -Description Export Job 1 Test ` + -ExcludeTypes null ` + -IncludeTypes null ` + -ObjectOptions {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}} +``` + +- Convert the resource to JSON +```powershell +$ExportPayload | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Expression.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Expression.md new file mode 100644 index 000000000..a6a6ef0af --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Expression.md @@ -0,0 +1,41 @@ +--- +id: v2024-expression +title: Expression +pagination_label: Expression +sidebar_label: Expression +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Expression', 'V2024Expression'] +slug: /tools/sdk/powershell/v2024/models/expression +tags: ['SDK', 'Software Development Kit', 'Expression', 'V2024Expression'] +--- + + +# Expression + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operator** | Pointer to **Enum** [ "AND", "EQUALS" ] | Operator for the expression | [optional] +**Attribute** | Pointer to **String** | Name for the attribute | [optional] +**Value** | Pointer to [**Value**](value) | | [optional] +**Children** | Pointer to [**[]ExpressionChildrenInner**](expression-children-inner) | List of expressions | [optional] + +## Examples + +- Prepare the resource +```powershell +$Expression = Initialize-PSSailpoint.V2024Expression -Operator EQUALS ` + -Attribute location ` + -Value null ` + -Children [] +``` + +- Convert the resource to JSON +```powershell +$Expression | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExpressionChildrenInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExpressionChildrenInner.md new file mode 100644 index 000000000..d0a1ad57e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExpressionChildrenInner.md @@ -0,0 +1,41 @@ +--- +id: v2024-expression-children-inner +title: ExpressionChildrenInner +pagination_label: ExpressionChildrenInner +sidebar_label: ExpressionChildrenInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExpressionChildrenInner', 'V2024ExpressionChildrenInner'] +slug: /tools/sdk/powershell/v2024/models/expression-children-inner +tags: ['SDK', 'Software Development Kit', 'ExpressionChildrenInner', 'V2024ExpressionChildrenInner'] +--- + + +# ExpressionChildrenInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operator** | Pointer to **Enum** [ "AND", "EQUALS" ] | Operator for the expression | [optional] +**Attribute** | Pointer to **String** | Name for the attribute | [optional] +**Value** | Pointer to [**Value**](value) | | [optional] +**Children** | Pointer to **String** | There cannot be anymore nested children. This will always be null. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ExpressionChildrenInner = Initialize-PSSailpoint.V2024ExpressionChildrenInner -Operator EQUALS ` + -Attribute location ` + -Value null ` + -Children null +``` + +- Convert the resource to JSON +```powershell +$ExpressionChildrenInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExternalAttributes.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExternalAttributes.md new file mode 100644 index 000000000..480adc183 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ExternalAttributes.md @@ -0,0 +1,41 @@ +--- +id: v2024-external-attributes +title: ExternalAttributes +pagination_label: ExternalAttributes +sidebar_label: ExternalAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExternalAttributes', 'V2024ExternalAttributes'] +slug: /tools/sdk/powershell/v2024/models/external-attributes +tags: ['SDK', 'Software Development Kit', 'ExternalAttributes', 'V2024ExternalAttributes'] +--- + + +# ExternalAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | A unique name for the external trigger | [optional] +**Description** | Pointer to **String** | Additonal context about the external trigger | [optional] +**ClientId** | Pointer to **String** | OAuth Client ID to authenticate with this trigger | [optional] +**Url** | Pointer to **String** | URL to invoke this workflow | [optional] + +## Examples + +- Prepare the resource +```powershell +$ExternalAttributes = Initialize-PSSailpoint.V2024ExternalAttributes -Name search-and-notify ` + -Description Run a search and notify the results ` + -ClientId 87e239b2-b85b-4bde-b9a7-55bf304ddcdc ` + -Url https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d +``` + +- Convert the resource to JSON +```powershell +$ExternalAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FeatureValueDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FeatureValueDto.md new file mode 100644 index 000000000..56bcd6c01 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FeatureValueDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-feature-value-dto +title: FeatureValueDto +pagination_label: FeatureValueDto +sidebar_label: FeatureValueDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FeatureValueDto', 'V2024FeatureValueDto'] +slug: /tools/sdk/powershell/v2024/models/feature-value-dto +tags: ['SDK', 'Software Development Kit', 'FeatureValueDto', 'V2024FeatureValueDto'] +--- + + +# FeatureValueDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Feature** | Pointer to **String** | The type of feature | [optional] +**Numerator** | Pointer to **Int32** | The number of identities that have access to the feature | [optional] +**Denominator** | Pointer to **Int32** | The number of identities with the corresponding feature | [optional] + +## Examples + +- Prepare the resource +```powershell +$FeatureValueDto = Initialize-PSSailpoint.V2024FeatureValueDto -Feature department ` + -Numerator 14 ` + -Denominator 14 +``` + +- Convert the resource to JSON +```powershell +$FeatureValueDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FieldDetailsDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FieldDetailsDto.md new file mode 100644 index 000000000..e8e90ecf6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FieldDetailsDto.md @@ -0,0 +1,45 @@ +--- +id: v2024-field-details-dto +title: FieldDetailsDto +pagination_label: FieldDetailsDto +sidebar_label: FieldDetailsDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FieldDetailsDto', 'V2024FieldDetailsDto'] +slug: /tools/sdk/powershell/v2024/models/field-details-dto +tags: ['SDK', 'Software Development Kit', 'FieldDetailsDto', 'V2024FieldDetailsDto'] +--- + + +# FieldDetailsDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the attribute. | [optional] +**Transform** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The transform to apply to the field | [optional] +**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Attributes required for the transform | [optional] +**IsRequired** | Pointer to **Boolean** | Flag indicating whether or not the attribute is required. | [optional] [readonly] [default to $false] +**Type** | Pointer to **String** | The type of the attribute. | [optional] +**IsMultiValued** | Pointer to **Boolean** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$FieldDetailsDto = Initialize-PSSailpoint.V2024FieldDetailsDto -Name userName ` + -Transform {type=rule, attributes={name=Create Unique LDAP Attribute}} ` + -Attributes {template=${firstname}.${lastname}${uniqueCounter}, cloudMaxUniqueChecks=50, cloudMaxSize=20, cloudRequired=true} ` + -IsRequired false ` + -Type string ` + -IsMultiValued false +``` + +- Convert the resource to JSON +```powershell +$FieldDetailsDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Filter.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Filter.md new file mode 100644 index 000000000..3ce149230 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Filter.md @@ -0,0 +1,41 @@ +--- +id: v2024-model-filter +title: ModelFilter +pagination_label: ModelFilter +sidebar_label: ModelFilter +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ModelFilter', 'V2024ModelFilter'] +slug: /tools/sdk/powershell/v2024/models/model-filter +tags: ['SDK', 'Software Development Kit', 'ModelFilter', 'V2024ModelFilter'] +--- + + +# ModelFilter + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**FilterType**](filter-type) | | [optional] +**Range** | Pointer to [**Range**](range) | | [optional] +**Terms** | Pointer to **[]String** | The terms to be filtered. | [optional] +**Exclude** | Pointer to **Boolean** | Indicates if the filter excludes results. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$ModelFilter = Initialize-PSSailpoint.V2024ModelFilter -Type null ` + -Range null ` + -Terms null ` + -Exclude false +``` + +- Convert the resource to JSON +```powershell +$ModelFilter | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FilterAggregation.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FilterAggregation.md new file mode 100644 index 000000000..b4d8d0235 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FilterAggregation.md @@ -0,0 +1,41 @@ +--- +id: v2024-filter-aggregation +title: FilterAggregation +pagination_label: FilterAggregation +sidebar_label: FilterAggregation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FilterAggregation', 'V2024FilterAggregation'] +slug: /tools/sdk/powershell/v2024/models/filter-aggregation +tags: ['SDK', 'Software Development Kit', 'FilterAggregation', 'V2024FilterAggregation'] +--- + + +# FilterAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | The name of the filter aggregate to be included in the result. | [required] +**Type** | Pointer to [**SearchFilterType**](search-filter-type) | | [optional] +**Field** | **String** | The search field to apply the filter to. Prefix the field name with '@' to reference a nested object. | [required] +**Value** | **String** | The value to filter on. | [required] + +## Examples + +- Prepare the resource +```powershell +$FilterAggregation = Initialize-PSSailpoint.V2024FilterAggregation -Name Entitlements ` + -Type null ` + -Field access.type ` + -Value ENTITLEMENT +``` + +- Convert the resource to JSON +```powershell +$FilterAggregation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FilterType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FilterType.md new file mode 100644 index 000000000..2ef71d86e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FilterType.md @@ -0,0 +1,26 @@ +--- +id: v2024-filter-type +title: FilterType +pagination_label: FilterType +sidebar_label: FilterType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FilterType', 'V2024FilterType'] +slug: /tools/sdk/powershell/v2024/models/filter-type +tags: ['SDK', 'Software Development Kit', 'FilterType', 'V2024FilterType'] +--- + + +# FilterType + +## Enum + + +* `EXISTS` (value: `"EXISTS"`) + +* `RANGE` (value: `"RANGE"`) + +* `TERMS` (value: `"TERMS"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FirstValid.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FirstValid.md new file mode 100644 index 000000000..c80f9f79f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FirstValid.md @@ -0,0 +1,39 @@ +--- +id: v2024-first-valid +title: FirstValid +pagination_label: FirstValid +sidebar_label: FirstValid +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FirstValid', 'V2024FirstValid'] +slug: /tools/sdk/powershell/v2024/models/first-valid +tags: ['SDK', 'Software Development Kit', 'FirstValid', 'V2024FirstValid'] +--- + + +# FirstValid + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Values** | [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | An array of attributes to evaluate for existence. | [required] +**IgnoreErrors** | Pointer to **Boolean** | a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. | [optional] [default to $false] +**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] + +## Examples + +- Prepare the resource +```powershell +$FirstValid = Initialize-PSSailpoint.V2024FirstValid -Values [{attributes={sourceName=Active Directory, attributeName=sAMAccountName}, type=accountAttribute}, {attributes={sourceName=Okta, attributeName=login}, type=accountAttribute}, {attributes={sourceName=HR Source, attributeName=employeeID}, type=accountAttribute}] ` + -IgnoreErrors false ` + -RequiresPeriodicRefresh false +``` + +- Convert the resource to JSON +```powershell +$FirstValid | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormCondition.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormCondition.md new file mode 100644 index 000000000..12caac9bc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormCondition.md @@ -0,0 +1,39 @@ +--- +id: v2024-form-condition +title: FormCondition +pagination_label: FormCondition +sidebar_label: FormCondition +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormCondition', 'V2024FormCondition'] +slug: /tools/sdk/powershell/v2024/models/form-condition +tags: ['SDK', 'Software Development Kit', 'FormCondition', 'V2024FormCondition'] +--- + + +# FormCondition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RuleOperator** | Pointer to **Enum** [ "AND", "OR" ] | ConditionRuleLogicalOperatorType value. AND ConditionRuleLogicalOperatorTypeAnd OR ConditionRuleLogicalOperatorTypeOr | [optional] +**Rules** | Pointer to [**[]ConditionRule**](condition-rule) | List of rules. | [optional] +**Effects** | Pointer to [**[]ConditionEffect**](condition-effect) | List of effects. | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormCondition = Initialize-PSSailpoint.V2024FormCondition -RuleOperator AND ` + -Rules null ` + -Effects null +``` + +- Convert the resource to JSON +```powershell +$FormCondition | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormDefinitionDynamicSchemaRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormDefinitionDynamicSchemaRequest.md new file mode 100644 index 000000000..13519d16d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormDefinitionDynamicSchemaRequest.md @@ -0,0 +1,43 @@ +--- +id: v2024-form-definition-dynamic-schema-request +title: FormDefinitionDynamicSchemaRequest +pagination_label: FormDefinitionDynamicSchemaRequest +sidebar_label: FormDefinitionDynamicSchemaRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormDefinitionDynamicSchemaRequest', 'V2024FormDefinitionDynamicSchemaRequest'] +slug: /tools/sdk/powershell/v2024/models/form-definition-dynamic-schema-request +tags: ['SDK', 'Software Development Kit', 'FormDefinitionDynamicSchemaRequest', 'V2024FormDefinitionDynamicSchemaRequest'] +--- + + +# FormDefinitionDynamicSchemaRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**FormDefinitionDynamicSchemaRequestAttributes**](form-definition-dynamic-schema-request-attributes) | | [optional] +**Description** | Pointer to **String** | Description is the form definition dynamic schema description text | [optional] +**Id** | Pointer to **String** | ID is a unique identifier | [optional] +**Type** | Pointer to **String** | Type is the form definition dynamic schema type | [optional] +**VersionNumber** | Pointer to **Int64** | VersionNumber is the form definition dynamic schema version number | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormDefinitionDynamicSchemaRequest = Initialize-PSSailpoint.V2024FormDefinitionDynamicSchemaRequest -Attributes null ` + -Description A description ` + -Id 00000000-0000-0000-0000-000000000000 ` + -Type action ` + -VersionNumber 1 +``` + +- Convert the resource to JSON +```powershell +$FormDefinitionDynamicSchemaRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormDefinitionDynamicSchemaRequestAttributes.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormDefinitionDynamicSchemaRequestAttributes.md new file mode 100644 index 000000000..4abbf8e95 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormDefinitionDynamicSchemaRequestAttributes.md @@ -0,0 +1,35 @@ +--- +id: v2024-form-definition-dynamic-schema-request-attributes +title: FormDefinitionDynamicSchemaRequestAttributes +pagination_label: FormDefinitionDynamicSchemaRequestAttributes +sidebar_label: FormDefinitionDynamicSchemaRequestAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormDefinitionDynamicSchemaRequestAttributes', 'V2024FormDefinitionDynamicSchemaRequestAttributes'] +slug: /tools/sdk/powershell/v2024/models/form-definition-dynamic-schema-request-attributes +tags: ['SDK', 'Software Development Kit', 'FormDefinitionDynamicSchemaRequestAttributes', 'V2024FormDefinitionDynamicSchemaRequestAttributes'] +--- + + +# FormDefinitionDynamicSchemaRequestAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FormDefinitionId** | Pointer to **String** | FormDefinitionID is a unique guid identifying this form definition | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormDefinitionDynamicSchemaRequestAttributes = Initialize-PSSailpoint.V2024FormDefinitionDynamicSchemaRequestAttributes -FormDefinitionId 00000000-0000-0000-0000-000000000000 +``` + +- Convert the resource to JSON +```powershell +$FormDefinitionDynamicSchemaRequestAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormDefinitionDynamicSchemaResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormDefinitionDynamicSchemaResponse.md new file mode 100644 index 000000000..3586f76fe --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormDefinitionDynamicSchemaResponse.md @@ -0,0 +1,35 @@ +--- +id: v2024-form-definition-dynamic-schema-response +title: FormDefinitionDynamicSchemaResponse +pagination_label: FormDefinitionDynamicSchemaResponse +sidebar_label: FormDefinitionDynamicSchemaResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormDefinitionDynamicSchemaResponse', 'V2024FormDefinitionDynamicSchemaResponse'] +slug: /tools/sdk/powershell/v2024/models/form-definition-dynamic-schema-response +tags: ['SDK', 'Software Development Kit', 'FormDefinitionDynamicSchemaResponse', 'V2024FormDefinitionDynamicSchemaResponse'] +--- + + +# FormDefinitionDynamicSchemaResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OutputSchema** | Pointer to [**map[string]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | OutputSchema holds a JSON schema generated dynamically | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormDefinitionDynamicSchemaResponse = Initialize-PSSailpoint.V2024FormDefinitionDynamicSchemaResponse -OutputSchema {outputSchema={$schema=https://json-schema.org/draft/2020-12/schema, additionalProperties=false, properties={firstName={title=First Name, type=string}, fullName={title=Full Name, type=string}, lastName={title=Last Name, type=string}, startDate={format=date-time, title=Start Date, type=string}}, type=object}} +``` + +- Convert the resource to JSON +```powershell +$FormDefinitionDynamicSchemaResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormDefinitionFileUploadResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormDefinitionFileUploadResponse.md new file mode 100644 index 000000000..c990b3eec --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormDefinitionFileUploadResponse.md @@ -0,0 +1,39 @@ +--- +id: v2024-form-definition-file-upload-response +title: FormDefinitionFileUploadResponse +pagination_label: FormDefinitionFileUploadResponse +sidebar_label: FormDefinitionFileUploadResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormDefinitionFileUploadResponse', 'V2024FormDefinitionFileUploadResponse'] +slug: /tools/sdk/powershell/v2024/models/form-definition-file-upload-response +tags: ['SDK', 'Software Development Kit', 'FormDefinitionFileUploadResponse', 'V2024FormDefinitionFileUploadResponse'] +--- + + +# FormDefinitionFileUploadResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **String** | Created is the date the file was uploaded | [optional] +**FileId** | Pointer to **String** | fileId is a unique ULID that serves as an identifier for the form definition file | [optional] +**FormDefinitionId** | Pointer to **String** | FormDefinitionID is a unique guid identifying this form definition | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormDefinitionFileUploadResponse = Initialize-PSSailpoint.V2024FormDefinitionFileUploadResponse -Created 2023-07-12T20:14:57.74486Z ` + -FileId 01FHZXHK8PTP9FVK99Z66GXQTX.png ` + -FormDefinitionId 00000000-0000-0000-0000-000000000000 +``` + +- Convert the resource to JSON +```powershell +$FormDefinitionFileUploadResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormDefinitionInput.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormDefinitionInput.md new file mode 100644 index 000000000..687456893 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormDefinitionInput.md @@ -0,0 +1,41 @@ +--- +id: v2024-form-definition-input +title: FormDefinitionInput +pagination_label: FormDefinitionInput +sidebar_label: FormDefinitionInput +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormDefinitionInput', 'V2024FormDefinitionInput'] +slug: /tools/sdk/powershell/v2024/models/form-definition-input +tags: ['SDK', 'Software Development Kit', 'FormDefinitionInput', 'V2024FormDefinitionInput'] +--- + + +# FormDefinitionInput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Unique identifier for the form input. | [optional] +**Type** | Pointer to **Enum** [ "STRING" ] | FormDefinitionInputType value. STRING FormDefinitionInputTypeString | [optional] +**Label** | Pointer to **String** | Name for the form input. | [optional] +**Description** | Pointer to **String** | Form input's description. | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormDefinitionInput = Initialize-PSSailpoint.V2024FormDefinitionInput -Id 00000000-0000-0000-0000-000000000000 ` + -Type STRING ` + -Label input1 ` + -Description A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic +``` + +- Convert the resource to JSON +```powershell +$FormDefinitionInput | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormDefinitionResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormDefinitionResponse.md new file mode 100644 index 000000000..664c5faa5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormDefinitionResponse.md @@ -0,0 +1,53 @@ +--- +id: v2024-form-definition-response +title: FormDefinitionResponse +pagination_label: FormDefinitionResponse +sidebar_label: FormDefinitionResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormDefinitionResponse', 'V2024FormDefinitionResponse'] +slug: /tools/sdk/powershell/v2024/models/form-definition-response +tags: ['SDK', 'Software Development Kit', 'FormDefinitionResponse', 'V2024FormDefinitionResponse'] +--- + + +# FormDefinitionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Unique guid identifying the form definition. | [optional] +**Name** | Pointer to **String** | Name of the form definition. | [optional] +**Description** | Pointer to **String** | Form definition's description. | [optional] +**Owner** | Pointer to [**FormOwner**](form-owner) | | [optional] +**UsedBy** | Pointer to [**[]FormUsedBy**](form-used-by) | List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it. | [optional] +**FormInput** | Pointer to [**[]FormDefinitionInput**](form-definition-input) | List of form inputs required to create a form-instance object. | [optional] +**FormElements** | Pointer to [**[]FormElement**](form-element) | List of nested form elements. | [optional] +**FormConditions** | Pointer to [**[]FormCondition**](form-condition) | Conditional logic that can dynamically modify the form as the recipient is interacting with it. | [optional] +**Created** | Pointer to **System.DateTime** | Created is the date the form definition was created | [optional] +**Modified** | Pointer to **System.DateTime** | Modified is the last date the form definition was modified | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormDefinitionResponse = Initialize-PSSailpoint.V2024FormDefinitionResponse -Id 00000000-0000-0000-0000-000000000000 ` + -Name My form ` + -Description My form description ` + -Owner null ` + -UsedBy null ` + -FormInput null ` + -FormElements null ` + -FormConditions null ` + -Created 2023-07-12T20:14:57.744860Z ` + -Modified 2023-07-12T20:14:57.744860Z +``` + +- Convert the resource to JSON +```powershell +$FormDefinitionResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormDetails.md new file mode 100644 index 000000000..d7d68b04e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormDetails.md @@ -0,0 +1,45 @@ +--- +id: v2024-form-details +title: FormDetails +pagination_label: FormDetails +sidebar_label: FormDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormDetails', 'V2024FormDetails'] +slug: /tools/sdk/powershell/v2024/models/form-details +tags: ['SDK', 'Software Development Kit', 'FormDetails', 'V2024FormDetails'] +--- + + +# FormDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the form | [optional] +**Name** | Pointer to **String** | Name of the form | [optional] +**Title** | Pointer to **String** | The form title | [optional] +**Subtitle** | Pointer to **String** | The form subtitle. | [optional] +**TargetUser** | Pointer to **String** | The name of the user that should be shown this form | [optional] +**Sections** | Pointer to [**[]SectionDetails**](section-details) | Sections of the form | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormDetails = Initialize-PSSailpoint.V2024FormDetails -Id 2c9180835d2e5168015d32f890ca1581 ` + -Name AccountSelection Form ` + -Title Account Selection for John.Doe ` + -Subtitle Please select from the following ` + -TargetUser Jane.Doe ` + -Sections null +``` + +- Convert the resource to JSON +```powershell +$FormDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormElement.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormElement.md new file mode 100644 index 000000000..b29944cd9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormElement.md @@ -0,0 +1,43 @@ +--- +id: v2024-form-element +title: FormElement +pagination_label: FormElement +sidebar_label: FormElement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormElement', 'V2024FormElement'] +slug: /tools/sdk/powershell/v2024/models/form-element +tags: ['SDK', 'Software Development Kit', 'FormElement', 'V2024FormElement'] +--- + + +# FormElement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Form element identifier. | [optional] +**ElementType** | Pointer to **Enum** [ "TEXT", "TOGGLE", "TEXTAREA", "HIDDEN", "PHONE", "EMAIL", "SELECT", "DATE", "SECTION", "COLUMN_SET", "IMAGE", "DESCRIPTION" ] | FormElementType value. TEXT FormElementTypeText TOGGLE FormElementTypeToggle TEXTAREA FormElementTypeTextArea HIDDEN FormElementTypeHidden PHONE FormElementTypePhone EMAIL FormElementTypeEmail SELECT FormElementTypeSelect DATE FormElementTypeDate SECTION FormElementTypeSection COLUMN_SET FormElementTypeColumns IMAGE FormElementTypeImage DESCRIPTION FormElementTypeDescription | [optional] +**Config** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Config object. | [optional] +**Key** | Pointer to **String** | Technical key. | [optional] +**Validations** | Pointer to [**[]FormElementValidationsSet**](form-element-validations-set) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormElement = Initialize-PSSailpoint.V2024FormElement -Id 00000000-0000-0000-0000-000000000000 ` + -ElementType TEXT ` + -Config {label=Department} ` + -Key department ` + -Validations null +``` + +- Convert the resource to JSON +```powershell +$FormElement | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormElementDataSourceConfigOptions.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormElementDataSourceConfigOptions.md new file mode 100644 index 000000000..2bc6c50b3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormElementDataSourceConfigOptions.md @@ -0,0 +1,39 @@ +--- +id: v2024-form-element-data-source-config-options +title: FormElementDataSourceConfigOptions +pagination_label: FormElementDataSourceConfigOptions +sidebar_label: FormElementDataSourceConfigOptions +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormElementDataSourceConfigOptions', 'V2024FormElementDataSourceConfigOptions'] +slug: /tools/sdk/powershell/v2024/models/form-element-data-source-config-options +tags: ['SDK', 'Software Development Kit', 'FormElementDataSourceConfigOptions', 'V2024FormElementDataSourceConfigOptions'] +--- + + +# FormElementDataSourceConfigOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Label** | Pointer to **String** | Label is the main label to display to the user when selecting this option | [optional] +**SubLabel** | Pointer to **String** | SubLabel is the sub label to display below the label in diminutive styling to help describe or identify this option | [optional] +**Value** | Pointer to **String** | Value is the value to save as an entry when the user selects this option | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormElementDataSourceConfigOptions = Initialize-PSSailpoint.V2024FormElementDataSourceConfigOptions -Label regression-test-access-request-07c55dd6-3056-430a-86b5-fccc395bb6c5 ` + -SubLabel ` + -Value e96674448eba4ca1ba04eee999a8f3cd +``` + +- Convert the resource to JSON +```powershell +$FormElementDataSourceConfigOptions | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormElementDynamicDataSource.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormElementDynamicDataSource.md new file mode 100644 index 000000000..3528a92c4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormElementDynamicDataSource.md @@ -0,0 +1,37 @@ +--- +id: v2024-form-element-dynamic-data-source +title: FormElementDynamicDataSource +pagination_label: FormElementDynamicDataSource +sidebar_label: FormElementDynamicDataSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormElementDynamicDataSource', 'V2024FormElementDynamicDataSource'] +slug: /tools/sdk/powershell/v2024/models/form-element-dynamic-data-source +tags: ['SDK', 'Software Development Kit', 'FormElementDynamicDataSource', 'V2024FormElementDynamicDataSource'] +--- + + +# FormElementDynamicDataSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Config** | Pointer to [**FormElementDynamicDataSourceConfig**](form-element-dynamic-data-source-config) | | [optional] +**DataSourceType** | Pointer to **Enum** [ "STATIC", "INTERNAL", "SEARCH", "FORM_INPUT" ] | DataSourceType is a FormElementDataSourceType value STATIC FormElementDataSourceTypeStatic INTERNAL FormElementDataSourceTypeInternal SEARCH FormElementDataSourceTypeSearch FORM_INPUT FormElementDataSourceTypeFormInput | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormElementDynamicDataSource = Initialize-PSSailpoint.V2024FormElementDynamicDataSource -Config null ` + -DataSourceType STATIC +``` + +- Convert the resource to JSON +```powershell +$FormElementDynamicDataSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormElementDynamicDataSourceConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormElementDynamicDataSourceConfig.md new file mode 100644 index 000000000..e7b8a81a4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormElementDynamicDataSourceConfig.md @@ -0,0 +1,41 @@ +--- +id: v2024-form-element-dynamic-data-source-config +title: FormElementDynamicDataSourceConfig +pagination_label: FormElementDynamicDataSourceConfig +sidebar_label: FormElementDynamicDataSourceConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormElementDynamicDataSourceConfig', 'V2024FormElementDynamicDataSourceConfig'] +slug: /tools/sdk/powershell/v2024/models/form-element-dynamic-data-source-config +tags: ['SDK', 'Software Development Kit', 'FormElementDynamicDataSourceConfig', 'V2024FormElementDynamicDataSourceConfig'] +--- + + +# FormElementDynamicDataSourceConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AggregationBucketField** | Pointer to **String** | AggregationBucketField is the aggregation bucket field name | [optional] +**Indices** | Pointer to **[]String** | Indices is a list of indices to use | [optional] +**ObjectType** | Pointer to **Enum** [ "IDENTITY", "ACCESS_PROFILE", "SOURCES", "ROLE", "ENTITLEMENT" ] | ObjectType is a PreDefinedSelectOption value IDENTITY PreDefinedSelectOptionIdentity ACCESS_PROFILE PreDefinedSelectOptionAccessProfile SOURCES PreDefinedSelectOptionSources ROLE PreDefinedSelectOptionRole ENTITLEMENT PreDefinedSelectOptionEntitlement | [optional] +**Query** | Pointer to **String** | Query is a text | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormElementDynamicDataSourceConfig = Initialize-PSSailpoint.V2024FormElementDynamicDataSourceConfig -AggregationBucketField attributes.cloudStatus.exact ` + -Indices [identities] ` + -ObjectType IDENTITY ` + -Query * +``` + +- Convert the resource to JSON +```powershell +$FormElementDynamicDataSourceConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormElementPreviewRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormElementPreviewRequest.md new file mode 100644 index 000000000..0c97a016a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormElementPreviewRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-form-element-preview-request +title: FormElementPreviewRequest +pagination_label: FormElementPreviewRequest +sidebar_label: FormElementPreviewRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormElementPreviewRequest', 'V2024FormElementPreviewRequest'] +slug: /tools/sdk/powershell/v2024/models/form-element-preview-request +tags: ['SDK', 'Software Development Kit', 'FormElementPreviewRequest', 'V2024FormElementPreviewRequest'] +--- + + +# FormElementPreviewRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DataSource** | Pointer to [**FormElementDynamicDataSource**](form-element-dynamic-data-source) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormElementPreviewRequest = Initialize-PSSailpoint.V2024FormElementPreviewRequest -DataSource null +``` + +- Convert the resource to JSON +```powershell +$FormElementPreviewRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormElementValidationsSet.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormElementValidationsSet.md new file mode 100644 index 000000000..3bad4340b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormElementValidationsSet.md @@ -0,0 +1,35 @@ +--- +id: v2024-form-element-validations-set +title: FormElementValidationsSet +pagination_label: FormElementValidationsSet +sidebar_label: FormElementValidationsSet +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormElementValidationsSet', 'V2024FormElementValidationsSet'] +slug: /tools/sdk/powershell/v2024/models/form-element-validations-set +tags: ['SDK', 'Software Development Kit', 'FormElementValidationsSet', 'V2024FormElementValidationsSet'] +--- + + +# FormElementValidationsSet + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ValidationType** | Pointer to **Enum** [ "REQUIRED", "MIN_LENGTH", "MAX_LENGTH", "REGEX", "DATE", "MAX_DATE", "MIN_DATE", "LESS_THAN_DATE", "PHONE", "EMAIL", "DATA_SOURCE", "TEXTAREA" ] | The type of data validation that you wish to enforce, e.g., a required field, a minimum length, etc. | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormElementValidationsSet = Initialize-PSSailpoint.V2024FormElementValidationsSet -ValidationType REQUIRED +``` + +- Convert the resource to JSON +```powershell +$FormElementValidationsSet | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormError.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormError.md new file mode 100644 index 000000000..97c4d3ce1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormError.md @@ -0,0 +1,39 @@ +--- +id: v2024-form-error +title: FormError +pagination_label: FormError +sidebar_label: FormError +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormError', 'V2024FormError'] +slug: /tools/sdk/powershell/v2024/models/form-error +tags: ['SDK', 'Software Development Kit', 'FormError', 'V2024FormError'] +--- + + +# FormError + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **String** | Key is the technical key | [optional] +**Messages** | Pointer to [**[]ErrorMessage**](error-message) | Messages is a list of web.ErrorMessage items | [optional] +**Value** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Value is the value associated with a Key | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormError = Initialize-PSSailpoint.V2024FormError -Key department ` + -Messages null ` + -Value Engineering +``` + +- Convert the resource to JSON +```powershell +$FormError | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormInstanceCreatedBy.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormInstanceCreatedBy.md new file mode 100644 index 000000000..388b16b5e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormInstanceCreatedBy.md @@ -0,0 +1,37 @@ +--- +id: v2024-form-instance-created-by +title: FormInstanceCreatedBy +pagination_label: FormInstanceCreatedBy +sidebar_label: FormInstanceCreatedBy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormInstanceCreatedBy', 'V2024FormInstanceCreatedBy'] +slug: /tools/sdk/powershell/v2024/models/form-instance-created-by +tags: ['SDK', 'Software Development Kit', 'FormInstanceCreatedBy', 'V2024FormInstanceCreatedBy'] +--- + + +# FormInstanceCreatedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID is a unique identifier | [optional] +**Type** | Pointer to **Enum** [ "WORKFLOW_EXECUTION", "SOURCE" ] | Type is a form instance created by type enum value WORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution SOURCE FormInstanceCreatedByTypeSource | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormInstanceCreatedBy = Initialize-PSSailpoint.V2024FormInstanceCreatedBy -Id 00000000-0000-0000-0000-000000000000 ` + -Type WORKFLOW_EXECUTION +``` + +- Convert the resource to JSON +```powershell +$FormInstanceCreatedBy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormInstanceRecipient.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormInstanceRecipient.md new file mode 100644 index 000000000..8393b495e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormInstanceRecipient.md @@ -0,0 +1,37 @@ +--- +id: v2024-form-instance-recipient +title: FormInstanceRecipient +pagination_label: FormInstanceRecipient +sidebar_label: FormInstanceRecipient +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormInstanceRecipient', 'V2024FormInstanceRecipient'] +slug: /tools/sdk/powershell/v2024/models/form-instance-recipient +tags: ['SDK', 'Software Development Kit', 'FormInstanceRecipient', 'V2024FormInstanceRecipient'] +--- + + +# FormInstanceRecipient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID is a unique identifier | [optional] +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Type is a FormInstanceRecipientType value IDENTITY FormInstanceRecipientIdentity | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormInstanceRecipient = Initialize-PSSailpoint.V2024FormInstanceRecipient -Id 00000000-0000-0000-0000-000000000000 ` + -Type IDENTITY +``` + +- Convert the resource to JSON +```powershell +$FormInstanceRecipient | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormInstanceResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormInstanceResponse.md new file mode 100644 index 000000000..6843e973f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormInstanceResponse.md @@ -0,0 +1,63 @@ +--- +id: v2024-form-instance-response +title: FormInstanceResponse +pagination_label: FormInstanceResponse +sidebar_label: FormInstanceResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormInstanceResponse', 'V2024FormInstanceResponse'] +slug: /tools/sdk/powershell/v2024/models/form-instance-response +tags: ['SDK', 'Software Development Kit', 'FormInstanceResponse', 'V2024FormInstanceResponse'] +--- + + +# FormInstanceResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **System.DateTime** | Created is the date the form instance was assigned | [optional] +**CreatedBy** | Pointer to [**FormInstanceCreatedBy**](form-instance-created-by) | | [optional] +**Expire** | Pointer to **String** | Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record | [optional] +**FormConditions** | Pointer to [**[]FormCondition**](form-condition) | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [optional] +**FormData** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | FormData is the data provided by the form on submit. The data is in a key -> value map | [optional] +**FormDefinitionId** | Pointer to **String** | FormDefinitionID is the id of the form definition that created this form | [optional] +**FormElements** | Pointer to [**[]FormElement**](form-element) | FormElements is the configuration of the form, this would be a repeat of the fields from the form-config | [optional] +**FormErrors** | Pointer to [**[]FormError**](form-error) | FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors | [optional] +**FormInput** | Pointer to [**map[string]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | FormInput is an object of form input labels to value | [optional] +**Id** | Pointer to **String** | Unique guid identifying this form instance | [optional] +**Modified** | Pointer to **System.DateTime** | Modified is the last date the form instance was modified | [optional] +**Recipients** | Pointer to [**[]FormInstanceRecipient**](form-instance-recipient) | Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it | [optional] +**StandAloneForm** | Pointer to **Boolean** | StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form | [optional] [default to $false] +**StandAloneFormUrl** | Pointer to **String** | StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI | [optional] +**State** | Pointer to **Enum** [ "ASSIGNED", "IN_PROGRESS", "SUBMITTED", "COMPLETED", "CANCELLED" ] | State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormInstanceResponse = Initialize-PSSailpoint.V2024FormInstanceResponse -Created 2023-07-12T20:14:57.744860Z ` + -CreatedBy null ` + -Expire 2023-08-12T20:14:57.74486Z ` + -FormConditions null ` + -FormData {department=Engineering} ` + -FormDefinitionId 49841cb8-00a5-4fbd-9888-8bbb28d48331 ` + -FormElements null ` + -FormErrors null ` + -FormInput {input1=Sales} ` + -Id 06a2d961-07fa-44d1-8d0a-2f6470e30fd2 ` + -Modified 2023-07-12T20:14:57.744860Z ` + -Recipients null ` + -StandAloneForm false ` + -StandAloneFormUrl https://my-org.identitynow.com/ui/d/forms/00000000-0000-0000-0000-000000000000 ` + -State ASSIGNED +``` + +- Convert the resource to JSON +```powershell +$FormInstanceResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormItemDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormItemDetails.md new file mode 100644 index 000000000..b7a81962a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormItemDetails.md @@ -0,0 +1,35 @@ +--- +id: v2024-form-item-details +title: FormItemDetails +pagination_label: FormItemDetails +sidebar_label: FormItemDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormItemDetails', 'V2024FormItemDetails'] +slug: /tools/sdk/powershell/v2024/models/form-item-details +tags: ['SDK', 'Software Development Kit', 'FormItemDetails', 'V2024FormItemDetails'] +--- + + +# FormItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Name of the FormItem | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormItemDetails = Initialize-PSSailpoint.V2024FormItemDetails -Name Field1 +``` + +- Convert the resource to JSON +```powershell +$FormItemDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormOwner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormOwner.md new file mode 100644 index 000000000..53d3cd7c7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormOwner.md @@ -0,0 +1,39 @@ +--- +id: v2024-form-owner +title: FormOwner +pagination_label: FormOwner +sidebar_label: FormOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormOwner', 'V2024FormOwner'] +slug: /tools/sdk/powershell/v2024/models/form-owner +tags: ['SDK', 'Software Development Kit', 'FormOwner', 'V2024FormOwner'] +--- + + +# FormOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | FormOwnerType value. IDENTITY FormOwnerTypeIdentity | [optional] +**Id** | Pointer to **String** | Unique identifier of the form's owner. | [optional] +**Name** | Pointer to **String** | Name of the form's owner. | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormOwner = Initialize-PSSailpoint.V2024FormOwner -Type IDENTITY ` + -Id 2c9180867624cbd7017642d8c8c81f67 ` + -Name Grant Smith +``` + +- Convert the resource to JSON +```powershell +$FormOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormUsedBy.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormUsedBy.md new file mode 100644 index 000000000..48040d166 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FormUsedBy.md @@ -0,0 +1,39 @@ +--- +id: v2024-form-used-by +title: FormUsedBy +pagination_label: FormUsedBy +sidebar_label: FormUsedBy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormUsedBy', 'V2024FormUsedBy'] +slug: /tools/sdk/powershell/v2024/models/form-used-by +tags: ['SDK', 'Software Development Kit', 'FormUsedBy', 'V2024FormUsedBy'] +--- + + +# FormUsedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "WORKFLOW", "SOURCE", "MySailPoint" ] | FormUsedByType value. WORKFLOW FormUsedByTypeWorkflow SOURCE FormUsedByTypeSource MySailPoint FormUsedByType | [optional] +**Id** | Pointer to **String** | Unique identifier of the system using the form. | [optional] +**Name** | Pointer to **String** | Name of the system using the form. | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormUsedBy = Initialize-PSSailpoint.V2024FormUsedBy -Type WORKFLOW ` + -Id 61940a92-5484-42bc-bc10-b9982b218cdf ` + -Name Access Request Form +``` + +- Convert the resource to JSON +```powershell +$FormUsedBy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ForwardApprovalDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ForwardApprovalDto.md new file mode 100644 index 000000000..12e0ec884 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ForwardApprovalDto.md @@ -0,0 +1,37 @@ +--- +id: v2024-forward-approval-dto +title: ForwardApprovalDto +pagination_label: ForwardApprovalDto +sidebar_label: ForwardApprovalDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ForwardApprovalDto', 'V2024ForwardApprovalDto'] +slug: /tools/sdk/powershell/v2024/models/forward-approval-dto +tags: ['SDK', 'Software Development Kit', 'ForwardApprovalDto', 'V2024ForwardApprovalDto'] +--- + + +# ForwardApprovalDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NewOwnerId** | **String** | The Id of the new owner | [required] +**Comment** | **String** | The comment provided by the forwarder | [required] + +## Examples + +- Prepare the resource +```powershell +$ForwardApprovalDto = Initialize-PSSailpoint.V2024ForwardApprovalDto -NewOwnerId 2c91808568c529c60168cca6f90c1314 ` + -Comment 2c91808568c529c60168cca6f90c1313 +``` + +- Convert the resource to JSON +```powershell +$ForwardApprovalDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FullDiscoveredApplications.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FullDiscoveredApplications.md new file mode 100644 index 000000000..8deec6ecf --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/FullDiscoveredApplications.md @@ -0,0 +1,53 @@ +--- +id: v2024-full-discovered-applications +title: FullDiscoveredApplications +pagination_label: FullDiscoveredApplications +sidebar_label: FullDiscoveredApplications +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FullDiscoveredApplications', 'V2024FullDiscoveredApplications'] +slug: /tools/sdk/powershell/v2024/models/full-discovered-applications +tags: ['SDK', 'Software Development Kit', 'FullDiscoveredApplications', 'V2024FullDiscoveredApplications'] +--- + + +# FullDiscoveredApplications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Unique identifier for the discovered application. | [optional] +**Name** | Pointer to **String** | Name of the discovered application. | [optional] +**DiscoverySource** | Pointer to **String** | Source from which the application was discovered. | [optional] +**DiscoveredVendor** | Pointer to **String** | The vendor associated with the discovered application. | [optional] +**Description** | Pointer to **String** | A brief description of the discovered application. | [optional] +**RecommendedConnectors** | Pointer to **[]String** | List of recommended connectors for the application. | [optional] +**DiscoveredAt** | Pointer to **System.DateTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**CreatedAt** | Pointer to **System.DateTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**Status** | Pointer to **String** | The status of an application within the discovery source. By default this field is set to ""ACTIVE"" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to ""INACTIVE"". | [optional] +**AssociatedSources** | Pointer to **[]String** | List of associated sources related to this discovered application. | [optional] + +## Examples + +- Prepare the resource +```powershell +$FullDiscoveredApplications = Initialize-PSSailpoint.V2024FullDiscoveredApplications -Id null ` + -Name ExampleApp ` + -DiscoverySource csv ` + -DiscoveredVendor ExampleVendor ` + -Description An application for managing examples. ` + -RecommendedConnectors [ConnectorA, ConnectorB] ` + -DiscoveredAt 2023-01-01T12:00Z ` + -CreatedAt 2023-01-01T12:00Z ` + -Status ACTIVE ` + -AssociatedSources [e0cc5d7d-bf7f-4f81-b2af-8885b09d9923, a0303682-5e4a-44f7-bdc2-6ce6112549c1] +``` + +- Convert the resource to JSON +```powershell +$FullDiscoveredApplications | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GenerateRandomString.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GenerateRandomString.md new file mode 100644 index 000000000..3a632b20e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GenerateRandomString.md @@ -0,0 +1,45 @@ +--- +id: v2024-generate-random-string +title: GenerateRandomString +pagination_label: GenerateRandomString +sidebar_label: GenerateRandomString +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GenerateRandomString', 'V2024GenerateRandomString'] +slug: /tools/sdk/powershell/v2024/models/generate-random-string +tags: ['SDK', 'Software Development Kit', 'GenerateRandomString', 'V2024GenerateRandomString'] +--- + + +# GenerateRandomString + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | This must always be set to ""Cloud Services Deployment Utility"" | [required] +**Operation** | **String** | The operation to perform `generateRandomString` | [required] +**IncludeNumbers** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include numbers | [required] +**IncludeSpecialChars** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include special characters | [required] +**Length** | **String** | This specifies how long the randomly generated string needs to be >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$GenerateRandomString = Initialize-PSSailpoint.V2024GenerateRandomString -Name Cloud Services Deployment Utility ` + -Operation generateRandomString ` + -IncludeNumbers true ` + -IncludeSpecialChars true ` + -Length 10 ` + -RequiresPeriodicRefresh false +``` + +- Convert the resource to JSON +```powershell +$GenerateRandomString | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GetActiveCampaigns200ResponseInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GetActiveCampaigns200ResponseInner.md new file mode 100644 index 000000000..96dee2100 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GetActiveCampaigns200ResponseInner.md @@ -0,0 +1,79 @@ +--- +id: v2024-get-active-campaigns200-response-inner +title: GetActiveCampaigns200ResponseInner +pagination_label: GetActiveCampaigns200ResponseInner +sidebar_label: GetActiveCampaigns200ResponseInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetActiveCampaigns200ResponseInner', 'V2024GetActiveCampaigns200ResponseInner'] +slug: /tools/sdk/powershell/v2024/models/get-active-campaigns200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetActiveCampaigns200ResponseInner', 'V2024GetActiveCampaigns200ResponseInner'] +--- + + +# GetActiveCampaigns200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the campaign | [optional] [readonly] +**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Deadline** | Pointer to **System.DateTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required] +**EmailNotificationEnabled** | Pointer to **Boolean** | Enables email notification for this campaign | [optional] [default to $false] +**AutoRevokeAllowed** | Pointer to **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] +**RecommendationsEnabled** | Pointer to **Boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to $false] +**Status** | Pointer to **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **System.DateTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **Int32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | Modified time of the campaign | [optional] [readonly] +**VarFilter** | Pointer to [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | Pointer to **Boolean** | Determines if comments on sunset date changes are required. | [optional] [default to $true] +**SourceOwnerCampaignInfo** | Pointer to [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | Pointer to [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | Pointer to [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | Pointer to [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | Pointer to [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \""orphan entitlements\"" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**MandatoryCommentRequirement** | Pointer to **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] + +## Examples + +- Prepare the resource +```powershell +$GetActiveCampaigns200ResponseInner = Initialize-PSSailpoint.V2024GetActiveCampaigns200ResponseInner -Id 2c9079b270a266a60170a2779fcb0007 ` + -Name Manager Campaign ` + -Description Everyone needs to be reviewed by their manager ` + -Deadline 2020-03-15T10:00:01.456Z ` + -Type MANAGER ` + -EmailNotificationEnabled false ` + -AutoRevokeAllowed false ` + -RecommendationsEnabled true ` + -Status ACTIVE ` + -CorrelatedStatus CORRELATED ` + -Created 2020-03-03T22:15:13.611Z ` + -TotalCertifications 100 ` + -CompletedCertifications 10 ` + -Alerts null ` + -Modified 2020-03-03T22:20:12.674Z ` + -VarFilter null ` + -SunsetCommentsRequired true ` + -SourceOwnerCampaignInfo null ` + -SearchCampaignInfo null ` + -RoleCompositionCampaignInfo null ` + -MachineAccountCampaignInfo null ` + -SourcesWithOrphanEntitlements null ` + -MandatoryCommentRequirement NO_DECISIONS +``` + +- Convert the resource to JSON +```powershell +$GetActiveCampaigns200ResponseInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GetDiscoveredApplications200ResponseInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GetDiscoveredApplications200ResponseInner.md new file mode 100644 index 000000000..a8acce7b6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GetDiscoveredApplications200ResponseInner.md @@ -0,0 +1,53 @@ +--- +id: v2024-get-discovered-applications200-response-inner +title: GetDiscoveredApplications200ResponseInner +pagination_label: GetDiscoveredApplications200ResponseInner +sidebar_label: GetDiscoveredApplications200ResponseInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetDiscoveredApplications200ResponseInner', 'V2024GetDiscoveredApplications200ResponseInner'] +slug: /tools/sdk/powershell/v2024/models/get-discovered-applications200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetDiscoveredApplications200ResponseInner', 'V2024GetDiscoveredApplications200ResponseInner'] +--- + + +# GetDiscoveredApplications200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Unique identifier for the discovered application. | [optional] +**Name** | Pointer to **String** | Name of the discovered application. | [optional] +**DiscoverySource** | Pointer to **String** | Source from which the application was discovered. | [optional] +**DiscoveredVendor** | Pointer to **String** | The vendor associated with the discovered application. | [optional] +**Description** | Pointer to **String** | A brief description of the discovered application. | [optional] +**RecommendedConnectors** | Pointer to **[]String** | List of recommended connectors for the application. | [optional] +**DiscoveredAt** | Pointer to **System.DateTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**CreatedAt** | Pointer to **System.DateTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**Status** | Pointer to **String** | The status of an application within the discovery source. By default this field is set to ""ACTIVE"" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to ""INACTIVE"". | [optional] +**AssociatedSources** | Pointer to **[]String** | List of associated sources related to this discovered application. | [optional] + +## Examples + +- Prepare the resource +```powershell +$GetDiscoveredApplications200ResponseInner = Initialize-PSSailpoint.V2024GetDiscoveredApplications200ResponseInner -Id null ` + -Name ExampleApp ` + -DiscoverySource csv ` + -DiscoveredVendor ExampleVendor ` + -Description An application for managing examples. ` + -RecommendedConnectors [ConnectorA, ConnectorB] ` + -DiscoveredAt 2023-01-01T12:00Z ` + -CreatedAt 2023-01-01T12:00Z ` + -Status ACTIVE ` + -AssociatedSources [e0cc5d7d-bf7f-4f81-b2af-8885b09d9923, a0303682-5e4a-44f7-bdc2-6ce6112549c1] +``` + +- Convert the resource to JSON +```powershell +$GetDiscoveredApplications200ResponseInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GetHistoricalIdentityEvents200ResponseInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GetHistoricalIdentityEvents200ResponseInner.md new file mode 100644 index 000000000..3bb55b1a8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GetHistoricalIdentityEvents200ResponseInner.md @@ -0,0 +1,63 @@ +--- +id: v2024-get-historical-identity-events200-response-inner +title: GetHistoricalIdentityEvents200ResponseInner +pagination_label: GetHistoricalIdentityEvents200ResponseInner +sidebar_label: GetHistoricalIdentityEvents200ResponseInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetHistoricalIdentityEvents200ResponseInner', 'V2024GetHistoricalIdentityEvents200ResponseInner'] +slug: /tools/sdk/powershell/v2024/models/get-historical-identity-events200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetHistoricalIdentityEvents200ResponseInner', 'V2024GetHistoricalIdentityEvents200ResponseInner'] +--- + + +# GetHistoricalIdentityEvents200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessItem** | Pointer to [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional] +**IdentityId** | Pointer to **String** | the identity id | [optional] +**EventType** | Pointer to **String** | the event type | [optional] +**Dt** | Pointer to **String** | the date of event | [optional] +**GovernanceEvent** | Pointer to [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional] +**Changes** | Pointer to [**[]AttributeChange**](attribute-change) | | [optional] +**AccessRequest** | Pointer to [**AccessRequestResponse1**](access-request-response1) | | [optional] +**CertificationId** | Pointer to **String** | the id of the certification item | [optional] +**CertificationName** | Pointer to **String** | the certification item name | [optional] +**SignedDate** | Pointer to **String** | the date ceritification was signed | [optional] +**Certifiers** | Pointer to [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [optional] +**Reviewers** | Pointer to [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional] +**Signer** | Pointer to [**CertifierResponse**](certifier-response) | | [optional] +**Account** | Pointer to [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional] +**StatusChange** | Pointer to [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$GetHistoricalIdentityEvents200ResponseInner = Initialize-PSSailpoint.V2024GetHistoricalIdentityEvents200ResponseInner -AccessItem null ` + -IdentityId null ` + -EventType null ` + -Dt null ` + -GovernanceEvent null ` + -Changes null ` + -AccessRequest null ` + -CertificationId 2c91808a77ff216301782327a50f09bf ` + -CertificationName Cert name ` + -SignedDate 2019-03-08T22:37:33.901Z ` + -Certifiers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` + -Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` + -Signer null ` + -Account null ` + -StatusChange null +``` + +- Convert the resource to JSON +```powershell +$GetHistoricalIdentityEvents200ResponseInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GetOAuthClientResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GetOAuthClientResponse.md new file mode 100644 index 000000000..1180c019d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GetOAuthClientResponse.md @@ -0,0 +1,75 @@ +--- +id: v2024-get-o-auth-client-response +title: GetOAuthClientResponse +pagination_label: GetOAuthClientResponse +sidebar_label: GetOAuthClientResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetOAuthClientResponse', 'V2024GetOAuthClientResponse'] +slug: /tools/sdk/powershell/v2024/models/get-o-auth-client-response +tags: ['SDK', 'Software Development Kit', 'GetOAuthClientResponse', 'V2024GetOAuthClientResponse'] +--- + + +# GetOAuthClientResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | ID of the OAuth client | [required] +**BusinessName** | **String** | The name of the business the API Client should belong to | [required] +**HomepageUrl** | **String** | The homepage URL associated with the owner of the API Client | [required] +**Name** | **String** | A human-readable name for the API Client | [required] +**Description** | **String** | A description of the API Client | [required] +**AccessTokenValiditySeconds** | **Int32** | The number of seconds an access token generated for this API Client is valid for | [required] +**RefreshTokenValiditySeconds** | **Int32** | The number of seconds a refresh token generated for this API Client is valid for | [required] +**RedirectUris** | **[]String** | A list of the approved redirect URIs used with the authorization_code flow | [required] +**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | [required] +**AccessType** | [**AccessType**](access-type) | | [required] +**Type** | [**ClientType**](client-type) | | [required] +**Internal** | **Boolean** | An indicator of whether the API Client can be used for requests internal to IDN | [required] +**Enabled** | **Boolean** | An indicator of whether the API Client is enabled for use | [required] +**StrongAuthSupported** | **Boolean** | An indicator of whether the API Client supports strong authentication | [required] +**ClaimsSupported** | **Boolean** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [required] +**Created** | **System.DateTime** | The date and time, down to the millisecond, when the API Client was created | [required] +**Modified** | **System.DateTime** | The date and time, down to the millisecond, when the API Client was last updated | [required] +**Secret** | Pointer to **String** | | [optional] +**Metadata** | Pointer to **String** | | [optional] +**LastUsed** | Pointer to **System.DateTime** | The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed. | [optional] +**Scope** | **[]String** | Scopes of the API Client. | [required] + +## Examples + +- Prepare the resource +```powershell +$GetOAuthClientResponse = Initialize-PSSailpoint.V2024GetOAuthClientResponse -Id 2c9180835d2e5168015d32f890ca1581 ` + -BusinessName Acme-Solar ` + -HomepageUrl http://localhost:12345 ` + -Name Demo API Client ` + -Description An API client used for the authorization_code, refresh_token, and client_credentials flows ` + -AccessTokenValiditySeconds 750 ` + -RefreshTokenValiditySeconds 86400 ` + -RedirectUris [http://localhost:12345] ` + -GrantTypes [AUTHORIZATION_CODE, CLIENT_CREDENTIALS, REFRESH_TOKEN] ` + -AccessType null ` + -Type null ` + -Internal false ` + -Enabled true ` + -StrongAuthSupported false ` + -ClaimsSupported false ` + -Created 2017-07-11T18:45:37.098Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Secret null ` + -Metadata null ` + -LastUsed 2017-07-11T18:45:37.098Z ` + -Scope [demo:api-client-scope:first, demo:api-client-scope:second] +``` + +- Convert the resource to JSON +```powershell +$GetOAuthClientResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GetPersonalAccessTokenResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GetPersonalAccessTokenResponse.md new file mode 100644 index 000000000..b41943d48 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GetPersonalAccessTokenResponse.md @@ -0,0 +1,47 @@ +--- +id: v2024-get-personal-access-token-response +title: GetPersonalAccessTokenResponse +pagination_label: GetPersonalAccessTokenResponse +sidebar_label: GetPersonalAccessTokenResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetPersonalAccessTokenResponse', 'V2024GetPersonalAccessTokenResponse'] +slug: /tools/sdk/powershell/v2024/models/get-personal-access-token-response +tags: ['SDK', 'Software Development Kit', 'GetPersonalAccessTokenResponse', 'V2024GetPersonalAccessTokenResponse'] +--- + + +# GetPersonalAccessTokenResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The ID of the personal access token (to be used as the username for Basic Auth). | [required] +**Name** | **String** | The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. | [required] +**Scope** | **[]String** | Scopes of the personal access token. | [required] +**Owner** | [**PatOwner**](pat-owner) | | [required] +**Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required] +**LastUsed** | Pointer to **System.DateTime** | The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. | [optional] +**Managed** | Pointer to **Boolean** | If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$GetPersonalAccessTokenResponse = Initialize-PSSailpoint.V2024GetPersonalAccessTokenResponse -Id 86f1dc6fe8f54414950454cbb11278fa ` + -Name NodeJS Integration ` + -Scope [demo:personal-access-token-scope:first, demo:personal-access-token-scope:second] ` + -Owner null ` + -Created 2017-07-11T18:45:37.098Z ` + -LastUsed 2017-07-11T18:45:37.098Z ` + -Managed false +``` + +- Convert the resource to JSON +```powershell +$GetPersonalAccessTokenResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GetReferenceIdentityAttribute.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GetReferenceIdentityAttribute.md new file mode 100644 index 000000000..54f49bb10 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GetReferenceIdentityAttribute.md @@ -0,0 +1,41 @@ +--- +id: v2024-get-reference-identity-attribute +title: GetReferenceIdentityAttribute +pagination_label: GetReferenceIdentityAttribute +sidebar_label: GetReferenceIdentityAttribute +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetReferenceIdentityAttribute', 'V2024GetReferenceIdentityAttribute'] +slug: /tools/sdk/powershell/v2024/models/get-reference-identity-attribute +tags: ['SDK', 'Software Development Kit', 'GetReferenceIdentityAttribute', 'V2024GetReferenceIdentityAttribute'] +--- + + +# GetReferenceIdentityAttribute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | This must always be set to ""Cloud Services Deployment Utility"" | [required] +**Operation** | **String** | The operation to perform `getReferenceIdentityAttribute` | [required] +**Uid** | **String** | This is the SailPoint User Name (uid) value of the identity whose attribute is desired As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$GetReferenceIdentityAttribute = Initialize-PSSailpoint.V2024GetReferenceIdentityAttribute -Name Cloud Services Deployment Utility ` + -Operation getReferenceIdentityAttribute ` + -Uid 2c91808570313110017040b06f344ec9 ` + -RequiresPeriodicRefresh false +``` + +- Convert the resource to JSON +```powershell +$GetReferenceIdentityAttribute | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GetRoleAssignments200ResponseInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GetRoleAssignments200ResponseInner.md new file mode 100644 index 000000000..4c6437a5a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GetRoleAssignments200ResponseInner.md @@ -0,0 +1,51 @@ +--- +id: v2024-get-role-assignments200-response-inner +title: GetRoleAssignments200ResponseInner +pagination_label: GetRoleAssignments200ResponseInner +sidebar_label: GetRoleAssignments200ResponseInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetRoleAssignments200ResponseInner', 'V2024GetRoleAssignments200ResponseInner'] +slug: /tools/sdk/powershell/v2024/models/get-role-assignments200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetRoleAssignments200ResponseInner', 'V2024GetRoleAssignments200ResponseInner'] +--- + + +# GetRoleAssignments200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Assignment Id | [optional] +**Role** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] +**Comments** | Pointer to **String** | Comments added by the user when the assignment was made | [optional] +**AssignmentSource** | Pointer to **String** | Source describing how this assignment was made | [optional] +**Assigner** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] +**AssignedDimensions** | Pointer to [**[]BaseReferenceDto1**](base-reference-dto1) | Dimensions assigned related to this role | [optional] +**AssignmentContext** | Pointer to [**AssignmentContextDto**](assignment-context-dto) | | [optional] +**AccountTargets** | Pointer to [**[]RoleTargetDto**](role-target-dto) | | [optional] +**RemoveDate** | Pointer to **String** | Date that the assignment will be removed | [optional] + +## Examples + +- Prepare the resource +```powershell +$GetRoleAssignments200ResponseInner = Initialize-PSSailpoint.V2024GetRoleAssignments200ResponseInner -Id 1cbb0705b38c4226b1334eadd8874086 ` + -Role null ` + -Comments I'm a new Engineer and need this role to do my work ` + -AssignmentSource UI ` + -Assigner null ` + -AssignedDimensions [{id=1acc8ffe5fcf457090de28bee2af36ee, type=DIMENSION, name=Northeast region}] ` + -AssignmentContext null ` + -AccountTargets null ` + -RemoveDate Wed Feb 14 10:58:42 +``` + +- Convert the resource to JSON +```powershell +$GetRoleAssignments200ResponseInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GrantType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GrantType.md new file mode 100644 index 000000000..0f529f5a2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/GrantType.md @@ -0,0 +1,26 @@ +--- +id: v2024-grant-type +title: GrantType +pagination_label: GrantType +sidebar_label: GrantType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GrantType', 'V2024GrantType'] +slug: /tools/sdk/powershell/v2024/models/grant-type +tags: ['SDK', 'Software Development Kit', 'GrantType', 'V2024GrantType'] +--- + + +# GrantType + +## Enum + + +* `CLIENT_CREDENTIALS` (value: `"CLIENT_CREDENTIALS"`) + +* `AUTHORIZATION_CODE` (value: `"AUTHORIZATION_CODE"`) + +* `REFRESH_TOKEN` (value: `"REFRESH_TOKEN"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/HttpAuthenticationType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/HttpAuthenticationType.md new file mode 100644 index 000000000..372c7503f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/HttpAuthenticationType.md @@ -0,0 +1,26 @@ +--- +id: v2024-http-authentication-type +title: HttpAuthenticationType +pagination_label: HttpAuthenticationType +sidebar_label: HttpAuthenticationType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'HttpAuthenticationType', 'V2024HttpAuthenticationType'] +slug: /tools/sdk/powershell/v2024/models/http-authentication-type +tags: ['SDK', 'Software Development Kit', 'HttpAuthenticationType', 'V2024HttpAuthenticationType'] +--- + + +# HttpAuthenticationType + +## Enum + + +* `NO_AUTH` (value: `"NO_AUTH"`) + +* `BASIC_AUTH` (value: `"BASIC_AUTH"`) + +* `BEARER_TOKEN` (value: `"BEARER_TOKEN"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/HttpConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/HttpConfig.md new file mode 100644 index 000000000..717dc5afd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/HttpConfig.md @@ -0,0 +1,43 @@ +--- +id: v2024-http-config +title: HttpConfig +pagination_label: HttpConfig +sidebar_label: HttpConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'HttpConfig', 'V2024HttpConfig'] +slug: /tools/sdk/powershell/v2024/models/http-config +tags: ['SDK', 'Software Development Kit', 'HttpConfig', 'V2024HttpConfig'] +--- + + +# HttpConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Url** | **String** | URL of the external/custom integration. | [required] +**HttpDispatchMode** | [**HttpDispatchMode**](http-dispatch-mode) | | [required] +**HttpAuthenticationType** | Pointer to [**HttpAuthenticationType**](http-authentication-type) | | [optional] +**BasicAuthConfig** | Pointer to [**BasicAuthConfig**](basic-auth-config) | | [optional] +**BearerTokenAuthConfig** | Pointer to [**BearerTokenAuthConfig**](bearer-token-auth-config) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$HttpConfig = Initialize-PSSailpoint.V2024HttpConfig -Url https://www.example.com ` + -HttpDispatchMode null ` + -HttpAuthenticationType null ` + -BasicAuthConfig null ` + -BearerTokenAuthConfig null +``` + +- Convert the resource to JSON +```powershell +$HttpConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/HttpDispatchMode.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/HttpDispatchMode.md new file mode 100644 index 000000000..68ffee92e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/HttpDispatchMode.md @@ -0,0 +1,26 @@ +--- +id: v2024-http-dispatch-mode +title: HttpDispatchMode +pagination_label: HttpDispatchMode +sidebar_label: HttpDispatchMode +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'HttpDispatchMode', 'V2024HttpDispatchMode'] +slug: /tools/sdk/powershell/v2024/models/http-dispatch-mode +tags: ['SDK', 'Software Development Kit', 'HttpDispatchMode', 'V2024HttpDispatchMode'] +--- + + +# HttpDispatchMode + +## Enum + + +* `SYNC` (value: `"SYNC"`) + +* `ASYNC` (value: `"ASYNC"`) + +* `DYNAMIC` (value: `"DYNAMIC"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ISO3166.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ISO3166.md new file mode 100644 index 000000000..772843f9a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ISO3166.md @@ -0,0 +1,39 @@ +--- +id: v2024-iso3166 +title: ISO3166 +pagination_label: ISO3166 +sidebar_label: ISO3166 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ISO3166', 'V2024ISO3166'] +slug: /tools/sdk/powershell/v2024/models/iso3166 +tags: ['SDK', 'Software Development Kit', 'ISO3166', 'V2024ISO3166'] +--- + + +# ISO3166 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Format** | Pointer to **String** | An optional value to denote which ISO 3166 format to return. Valid values are: `alpha2` - Two-character country code (e.g., ""US""); this is the default value if no format is supplied `alpha3` - Three-character country code (e.g., ""USA"") `numeric` - The numeric country code (e.g., ""840"") | [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] + +## Examples + +- Prepare the resource +```powershell +$ISO3166 = Initialize-PSSailpoint.V2024ISO3166 -Format alpha2 ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$ISO3166 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentitiesAccountsBulkRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentitiesAccountsBulkRequest.md new file mode 100644 index 000000000..78beee89d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentitiesAccountsBulkRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-identities-accounts-bulk-request +title: IdentitiesAccountsBulkRequest +pagination_label: IdentitiesAccountsBulkRequest +sidebar_label: IdentitiesAccountsBulkRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentitiesAccountsBulkRequest', 'V2024IdentitiesAccountsBulkRequest'] +slug: /tools/sdk/powershell/v2024/models/identities-accounts-bulk-request +tags: ['SDK', 'Software Development Kit', 'IdentitiesAccountsBulkRequest', 'V2024IdentitiesAccountsBulkRequest'] +--- + + +# IdentitiesAccountsBulkRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityIds** | Pointer to **[]String** | The ids of the identities for which enable/disable accounts. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentitiesAccountsBulkRequest = Initialize-PSSailpoint.V2024IdentitiesAccountsBulkRequest -IdentityIds [2c91808384203c2d018437e631158308, 2c9180858082150f0180893dbaf553fe] +``` + +- Convert the resource to JSON +```powershell +$IdentitiesAccountsBulkRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentitiesDetailsReportArguments.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentitiesDetailsReportArguments.md new file mode 100644 index 000000000..5140234af --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentitiesDetailsReportArguments.md @@ -0,0 +1,35 @@ +--- +id: v2024-identities-details-report-arguments +title: IdentitiesDetailsReportArguments +pagination_label: IdentitiesDetailsReportArguments +sidebar_label: IdentitiesDetailsReportArguments +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentitiesDetailsReportArguments', 'V2024IdentitiesDetailsReportArguments'] +slug: /tools/sdk/powershell/v2024/models/identities-details-report-arguments +tags: ['SDK', 'Software Development Kit', 'IdentitiesDetailsReportArguments', 'V2024IdentitiesDetailsReportArguments'] +--- + + +# IdentitiesDetailsReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CorrelatedOnly** | **Boolean** | Flag to specify if only correlated identities are included in report. | [required][default to $false] + +## Examples + +- Prepare the resource +```powershell +$IdentitiesDetailsReportArguments = Initialize-PSSailpoint.V2024IdentitiesDetailsReportArguments -CorrelatedOnly true +``` + +- Convert the resource to JSON +```powershell +$IdentitiesDetailsReportArguments | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentitiesReportArguments.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentitiesReportArguments.md new file mode 100644 index 000000000..90bef60c6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentitiesReportArguments.md @@ -0,0 +1,35 @@ +--- +id: v2024-identities-report-arguments +title: IdentitiesReportArguments +pagination_label: IdentitiesReportArguments +sidebar_label: IdentitiesReportArguments +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentitiesReportArguments', 'V2024IdentitiesReportArguments'] +slug: /tools/sdk/powershell/v2024/models/identities-report-arguments +tags: ['SDK', 'Software Development Kit', 'IdentitiesReportArguments', 'V2024IdentitiesReportArguments'] +--- + + +# IdentitiesReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CorrelatedOnly** | Pointer to **Boolean** | Flag to specify if only correlated identities are included in report. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$IdentitiesReportArguments = Initialize-PSSailpoint.V2024IdentitiesReportArguments -CorrelatedOnly true +``` + +- Convert the resource to JSON +```powershell +$IdentitiesReportArguments | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Identity.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Identity.md new file mode 100644 index 000000000..44c101442 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Identity.md @@ -0,0 +1,59 @@ +--- +id: v2024-identity +title: Identity +pagination_label: Identity +sidebar_label: Identity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Identity', 'V2024Identity'] +slug: /tools/sdk/powershell/v2024/models/identity +tags: ['SDK', 'Software Development Kit', 'Identity', 'V2024Identity'] +--- + + +# Identity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | System-generated unique ID of the identity | [optional] [readonly] +**Name** | **String** | The identity's name is equivalent to its Display Name attribute. | [required] +**Created** | Pointer to **System.DateTime** | Creation date of the identity | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | Last modification date of the identity | [optional] [readonly] +**Alias** | Pointer to **String** | The identity's alternate unique identifier is equivalent to its Account Name on the authoritative source account schema. | [optional] +**EmailAddress** | Pointer to **String** | The email address of the identity | [optional] +**ProcessingState** | Pointer to **Enum** [ "ERROR", "OK" ] | The processing state of the identity | [optional] +**IdentityStatus** | Pointer to **Enum** [ "UNREGISTERED", "REGISTERED", "PENDING", "WARNING", "DISABLED", "ACTIVE", "DEACTIVATED", "TERMINATED", "ERROR", "LOCKED" ] | The identity's status in the system | [optional] +**ManagerRef** | Pointer to [**IdentityManagerRef**](identity-manager-ref) | | [optional] +**IsManager** | Pointer to **Boolean** | Whether this identity is a manager of another identity | [optional] [default to $false] +**LastRefresh** | Pointer to **System.DateTime** | The last time the identity was refreshed by the system | [optional] +**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A map with the identity attributes for the identity | [optional] +**LifecycleState** | Pointer to [**IdentityLifecycleState**](identity-lifecycle-state) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Identity = Initialize-PSSailpoint.V2024Identity -Id 01f04e428c484542a241dc89c303b178 ` + -Name Walter White ` + -Created 2023-01-03T21:16:22.432Z ` + -Modified 2023-01-03T21:16:22.432Z ` + -Alias walter.white ` + -EmailAddress walter.white@example.com ` + -ProcessingState ERROR ` + -IdentityStatus LOCKED ` + -ManagerRef null ` + -IsManager true ` + -LastRefresh 2020-11-22T15:42:31.123Z ` + -Attributes {uid=86754, firstname=Walter, cloudStatus=UNREGISTERED, displayName=Walter White, identificationNumber=86754, lastSyncDate=1470348809380, email=walter.white@example.com, lastname=White} ` + -LifecycleState null +``` + +- Convert the resource to JSON +```powershell +$Identity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Identity1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Identity1.md new file mode 100644 index 000000000..ec4d38c0a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Identity1.md @@ -0,0 +1,37 @@ +--- +id: v2024-identity1 +title: Identity1 +pagination_label: Identity1 +sidebar_label: Identity1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Identity1', 'V2024Identity1'] +slug: /tools/sdk/powershell/v2024/models/identity1 +tags: ['SDK', 'Software Development Kit', 'Identity1', 'V2024Identity1'] +--- + + +# Identity1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of the object | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object | [optional] + +## Examples + +- Prepare the resource +```powershell +$Identity1 = Initialize-PSSailpoint.V2024Identity1 -Id 2c91808380aa05580180aaaaf1940410 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$Identity1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAccess.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAccess.md new file mode 100644 index 000000000..87dc52d87 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAccess.md @@ -0,0 +1,59 @@ +--- +id: v2024-identity-access +title: IdentityAccess +pagination_label: IdentityAccess +sidebar_label: IdentityAccess +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAccess', 'V2024IdentityAccess'] +slug: /tools/sdk/powershell/v2024/models/identity-access +tags: ['SDK', 'Software Development Kit', 'IdentityAccess', 'V2024IdentityAccess'] +--- + + +# IdentityAccess + +## Properties + +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] +**Privileged** | Pointer to **Boolean** | | [optional] +**Attribute** | Pointer to **String** | | [optional] +**Value** | Pointer to **String** | | [optional] +**Standalone** | Pointer to **Boolean** | | [optional] +**Disabled** | Pointer to **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAccess = Initialize-PSSailpoint.V2024IdentityAccess -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -DisplayName John Q. Doe ` + -Type null ` + -Description null ` + -Source null ` + -Owner null ` + -Revocable null ` + -Privileged false ` + -Attribute memberOf ` + -Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com ` + -Standalone false ` + -Disabled null +``` + +- Convert the resource to JSON +```powershell +$IdentityAccess | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAssociationDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAssociationDetails.md new file mode 100644 index 000000000..b4beb2b21 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAssociationDetails.md @@ -0,0 +1,37 @@ +--- +id: v2024-identity-association-details +title: IdentityAssociationDetails +pagination_label: IdentityAssociationDetails +sidebar_label: IdentityAssociationDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAssociationDetails', 'V2024IdentityAssociationDetails'] +slug: /tools/sdk/powershell/v2024/models/identity-association-details +tags: ['SDK', 'Software Development Kit', 'IdentityAssociationDetails', 'V2024IdentityAssociationDetails'] +--- + + +# IdentityAssociationDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to **String** | any additional context information of the http call result | [optional] +**AssociationDetails** | Pointer to [**[]IdentityAssociationDetailsAssociationDetailsInner**](identity-association-details-association-details-inner) | list of all the resource associations for the identity | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAssociationDetails = Initialize-PSSailpoint.V2024IdentityAssociationDetails -Message Identity cannot be deleted as it is owner of following resources ` + -AssociationDetails null +``` + +- Convert the resource to JSON +```powershell +$IdentityAssociationDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAssociationDetailsAssociationDetailsInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAssociationDetailsAssociationDetailsInner.md new file mode 100644 index 000000000..f4a9527f3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAssociationDetailsAssociationDetailsInner.md @@ -0,0 +1,37 @@ +--- +id: v2024-identity-association-details-association-details-inner +title: IdentityAssociationDetailsAssociationDetailsInner +pagination_label: IdentityAssociationDetailsAssociationDetailsInner +sidebar_label: IdentityAssociationDetailsAssociationDetailsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAssociationDetailsAssociationDetailsInner', 'V2024IdentityAssociationDetailsAssociationDetailsInner'] +slug: /tools/sdk/powershell/v2024/models/identity-association-details-association-details-inner +tags: ['SDK', 'Software Development Kit', 'IdentityAssociationDetailsAssociationDetailsInner', 'V2024IdentityAssociationDetailsAssociationDetailsInner'] +--- + + +# IdentityAssociationDetailsAssociationDetailsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AssociationType** | Pointer to **String** | association type with the identity | [optional] +**Entities** | Pointer to [**[]IdentityEntities**](identity-entities) | the specific resource this identity has ownership on | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAssociationDetailsAssociationDetailsInner = Initialize-PSSailpoint.V2024IdentityAssociationDetailsAssociationDetailsInner -AssociationType CAMPAIGN_OWNER ` + -Entities {id=b660a232f05b4e04812ca974b3011e0f, name=Gaston.800ddf9640a, type=CAMPAIGN_CAMPAIGNER} +``` + +- Convert the resource to JSON +```powershell +$IdentityAssociationDetailsAssociationDetailsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttribute.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttribute.md new file mode 100644 index 000000000..dbad49ff1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttribute.md @@ -0,0 +1,49 @@ +--- +id: v2024-identity-attribute +title: IdentityAttribute +pagination_label: IdentityAttribute +sidebar_label: IdentityAttribute +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttribute', 'V2024IdentityAttribute'] +slug: /tools/sdk/powershell/v2024/models/identity-attribute +tags: ['SDK', 'Software Development Kit', 'IdentityAttribute', 'V2024IdentityAttribute'] +--- + + +# IdentityAttribute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Identity attribute's technical name. | [required] +**DisplayName** | Pointer to **String** | Identity attribute's business-friendly name. | [optional] +**Standard** | Pointer to **Boolean** | Indicates whether the attribute is 'standard' or 'default'. | [optional] [default to $false] +**Type** | Pointer to **String** | Identity attribute's type. | [optional] +**Multi** | Pointer to **Boolean** | Indicates whether the identity attribute is multi-valued. | [optional] [default to $false] +**Searchable** | Pointer to **Boolean** | Indicates whether the identity attribute is searchable. | [optional] [default to $false] +**System** | Pointer to **Boolean** | Indicates whether the identity attribute is 'system', meaning that it doesn't have a source and isn't configurable. | [optional] [default to $false] +**Sources** | Pointer to [**[]Source1**](source1) | Identity attribute's list of sources - this specifies how the rule's value is derived. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAttribute = Initialize-PSSailpoint.V2024IdentityAttribute -Name costCenter ` + -DisplayName Cost Center ` + -Standard false ` + -Type string ` + -Multi false ` + -Searchable false ` + -System false ` + -Sources null +``` + +- Convert the resource to JSON +```powershell +$IdentityAttribute | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttribute1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttribute1.md new file mode 100644 index 000000000..3a642fc1c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttribute1.md @@ -0,0 +1,39 @@ +--- +id: v2024-identity-attribute1 +title: IdentityAttribute1 +pagination_label: IdentityAttribute1 +sidebar_label: IdentityAttribute1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttribute1', 'V2024IdentityAttribute1'] +slug: /tools/sdk/powershell/v2024/models/identity-attribute1 +tags: ['SDK', 'Software Development Kit', 'IdentityAttribute1', 'V2024IdentityAttribute1'] +--- + + +# IdentityAttribute1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | The system (camel-cased) name of the identity attribute to bring in | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$IdentityAttribute1 = Initialize-PSSailpoint.V2024IdentityAttribute1 -Name email ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$IdentityAttribute1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributeConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributeConfig.md new file mode 100644 index 000000000..358857406 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributeConfig.md @@ -0,0 +1,37 @@ +--- +id: v2024-identity-attribute-config +title: IdentityAttributeConfig +pagination_label: IdentityAttributeConfig +sidebar_label: IdentityAttributeConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributeConfig', 'V2024IdentityAttributeConfig'] +slug: /tools/sdk/powershell/v2024/models/identity-attribute-config +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig', 'V2024IdentityAttributeConfig'] +--- + + +# IdentityAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **Boolean** | The backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false] +**AttributeTransforms** | Pointer to [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributeConfig = Initialize-PSSailpoint.V2024IdentityAttributeConfig -Enabled true ` + -AttributeTransforms null +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributeConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributeNames.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributeNames.md new file mode 100644 index 000000000..3608069d1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributeNames.md @@ -0,0 +1,35 @@ +--- +id: v2024-identity-attribute-names +title: IdentityAttributeNames +pagination_label: IdentityAttributeNames +sidebar_label: IdentityAttributeNames +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributeNames', 'V2024IdentityAttributeNames'] +slug: /tools/sdk/powershell/v2024/models/identity-attribute-names +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeNames', 'V2024IdentityAttributeNames'] +--- + + +# IdentityAttributeNames + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]String** | List of identity attributes' technical names. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributeNames = Initialize-PSSailpoint.V2024IdentityAttributeNames -Ids [name, displayName] +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributeNames | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributePreview.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributePreview.md new file mode 100644 index 000000000..dfffa67f8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributePreview.md @@ -0,0 +1,41 @@ +--- +id: v2024-identity-attribute-preview +title: IdentityAttributePreview +pagination_label: IdentityAttributePreview +sidebar_label: IdentityAttributePreview +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributePreview', 'V2024IdentityAttributePreview'] +slug: /tools/sdk/powershell/v2024/models/identity-attribute-preview +tags: ['SDK', 'Software Development Kit', 'IdentityAttributePreview', 'V2024IdentityAttributePreview'] +--- + + +# IdentityAttributePreview + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Name of the attribute that is being previewed. | [optional] +**Value** | Pointer to **String** | Value that was derived during the preview. | [optional] +**PreviousValue** | Pointer to **String** | The value of the attribute before the preview. | [optional] +**ErrorMessages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributePreview = Initialize-PSSailpoint.V2024IdentityAttributePreview -Name email ` + -Value email@mail.com ` + -PreviousValue oldEmail@mail.com ` + -ErrorMessages null +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributePreview | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributeTransform.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributeTransform.md new file mode 100644 index 000000000..c99353560 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributeTransform.md @@ -0,0 +1,37 @@ +--- +id: v2024-identity-attribute-transform +title: IdentityAttributeTransform +pagination_label: IdentityAttributeTransform +sidebar_label: IdentityAttributeTransform +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributeTransform', 'V2024IdentityAttributeTransform'] +slug: /tools/sdk/powershell/v2024/models/identity-attribute-transform +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'V2024IdentityAttributeTransform'] +--- + + +# IdentityAttributeTransform + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityAttributeName** | Pointer to **String** | Name of the identity attribute. | [optional] +**TransformDefinition** | Pointer to [**TransformDefinition**](transform-definition) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributeTransform = Initialize-PSSailpoint.V2024IdentityAttributeTransform -IdentityAttributeName email ` + -TransformDefinition null +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributeTransform | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributesChanged.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributesChanged.md new file mode 100644 index 000000000..66833208e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributesChanged.md @@ -0,0 +1,37 @@ +--- +id: v2024-identity-attributes-changed +title: IdentityAttributesChanged +pagination_label: IdentityAttributesChanged +sidebar_label: IdentityAttributesChanged +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributesChanged', 'V2024IdentityAttributesChanged'] +slug: /tools/sdk/powershell/v2024/models/identity-attributes-changed +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChanged', 'V2024IdentityAttributesChanged'] +--- + + +# IdentityAttributesChanged + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**IdentityAttributesChangedIdentity**](identity-attributes-changed-identity) | | [required] +**Changes** | [**[]IdentityAttributesChangedChangesInner**](identity-attributes-changed-changes-inner) | A list of one or more identity attributes that changed on the identity. | [required] + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributesChanged = Initialize-PSSailpoint.V2024IdentityAttributesChanged -Identity null ` + -Changes null +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributesChanged | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributesChangedChangesInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributesChangedChangesInner.md new file mode 100644 index 000000000..2ba63dacc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributesChangedChangesInner.md @@ -0,0 +1,39 @@ +--- +id: v2024-identity-attributes-changed-changes-inner +title: IdentityAttributesChangedChangesInner +pagination_label: IdentityAttributesChangedChangesInner +sidebar_label: IdentityAttributesChangedChangesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributesChangedChangesInner', 'V2024IdentityAttributesChangedChangesInner'] +slug: /tools/sdk/powershell/v2024/models/identity-attributes-changed-changes-inner +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInner', 'V2024IdentityAttributesChangedChangesInner'] +--- + + +# IdentityAttributesChangedChangesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attribute** | **String** | The name of the identity attribute that changed. | [required] +**OldValue** | Pointer to [**IdentityAttributesChangedChangesInnerOldValue**](identity-attributes-changed-changes-inner-old-value) | | [optional] +**NewValue** | Pointer to [**IdentityAttributesChangedChangesInnerNewValue**](identity-attributes-changed-changes-inner-new-value) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributesChangedChangesInner = Initialize-PSSailpoint.V2024IdentityAttributesChangedChangesInner -Attribute department ` + -OldValue null ` + -NewValue null +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributesChangedChangesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributesChangedChangesInnerNewValue.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributesChangedChangesInnerNewValue.md new file mode 100644 index 000000000..874fdcf3d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributesChangedChangesInnerNewValue.md @@ -0,0 +1,34 @@ +--- +id: v2024-identity-attributes-changed-changes-inner-new-value +title: IdentityAttributesChangedChangesInnerNewValue +pagination_label: IdentityAttributesChangedChangesInnerNewValue +sidebar_label: IdentityAttributesChangedChangesInnerNewValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributesChangedChangesInnerNewValue', 'V2024IdentityAttributesChangedChangesInnerNewValue'] +slug: /tools/sdk/powershell/v2024/models/identity-attributes-changed-changes-inner-new-value +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInnerNewValue', 'V2024IdentityAttributesChangedChangesInnerNewValue'] +--- + + +# IdentityAttributesChangedChangesInnerNewValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributesChangedChangesInnerNewValue = Initialize-PSSailpoint.V2024IdentityAttributesChangedChangesInnerNewValue +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributesChangedChangesInnerNewValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributesChangedChangesInnerOldValue.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributesChangedChangesInnerOldValue.md new file mode 100644 index 000000000..7032c5792 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributesChangedChangesInnerOldValue.md @@ -0,0 +1,34 @@ +--- +id: v2024-identity-attributes-changed-changes-inner-old-value +title: IdentityAttributesChangedChangesInnerOldValue +pagination_label: IdentityAttributesChangedChangesInnerOldValue +sidebar_label: IdentityAttributesChangedChangesInnerOldValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributesChangedChangesInnerOldValue', 'V2024IdentityAttributesChangedChangesInnerOldValue'] +slug: /tools/sdk/powershell/v2024/models/identity-attributes-changed-changes-inner-old-value +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInnerOldValue', 'V2024IdentityAttributesChangedChangesInnerOldValue'] +--- + + +# IdentityAttributesChangedChangesInnerOldValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributesChangedChangesInnerOldValue = Initialize-PSSailpoint.V2024IdentityAttributesChangedChangesInnerOldValue +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributesChangedChangesInnerOldValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributesChangedChangesInnerOldValueOneOfValue.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributesChangedChangesInnerOldValueOneOfValue.md new file mode 100644 index 000000000..3abdba3f7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributesChangedChangesInnerOldValueOneOfValue.md @@ -0,0 +1,34 @@ +--- +id: v2024-identity-attributes-changed-changes-inner-old-value-one-of-value +title: IdentityAttributesChangedChangesInnerOldValueOneOfValue +pagination_label: IdentityAttributesChangedChangesInnerOldValueOneOfValue +sidebar_label: IdentityAttributesChangedChangesInnerOldValueOneOfValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributesChangedChangesInnerOldValueOneOfValue', 'V2024IdentityAttributesChangedChangesInnerOldValueOneOfValue'] +slug: /tools/sdk/powershell/v2024/models/identity-attributes-changed-changes-inner-old-value-one-of-value +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInnerOldValueOneOfValue', 'V2024IdentityAttributesChangedChangesInnerOldValueOneOfValue'] +--- + + +# IdentityAttributesChangedChangesInnerOldValueOneOfValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributesChangedChangesInnerOldValueOneOfValue = Initialize-PSSailpoint.V2024IdentityAttributesChangedChangesInnerOldValueOneOfValue +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributesChangedChangesInnerOldValueOneOfValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributesChangedIdentity.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributesChangedIdentity.md new file mode 100644 index 000000000..2f4e1804c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityAttributesChangedIdentity.md @@ -0,0 +1,39 @@ +--- +id: v2024-identity-attributes-changed-identity +title: IdentityAttributesChangedIdentity +pagination_label: IdentityAttributesChangedIdentity +sidebar_label: IdentityAttributesChangedIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributesChangedIdentity', 'V2024IdentityAttributesChangedIdentity'] +slug: /tools/sdk/powershell/v2024/models/identity-attributes-changed-identity +tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedIdentity', 'V2024IdentityAttributesChangedIdentity'] +--- + + +# IdentityAttributesChangedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | DTO type of identity whose attributes changed. | [required] +**Id** | **String** | ID of identity whose attributes changed. | [required] +**Name** | **String** | Display name of identity whose attributes changed. | [required] + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributesChangedIdentity = Initialize-PSSailpoint.V2024IdentityAttributesChangedIdentity -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributesChangedIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityCertDecisionSummary.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityCertDecisionSummary.md new file mode 100644 index 000000000..910ceed83 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityCertDecisionSummary.md @@ -0,0 +1,65 @@ +--- +id: v2024-identity-cert-decision-summary +title: IdentityCertDecisionSummary +pagination_label: IdentityCertDecisionSummary +sidebar_label: IdentityCertDecisionSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityCertDecisionSummary', 'V2024IdentityCertDecisionSummary'] +slug: /tools/sdk/powershell/v2024/models/identity-cert-decision-summary +tags: ['SDK', 'Software Development Kit', 'IdentityCertDecisionSummary', 'V2024IdentityCertDecisionSummary'] +--- + + +# IdentityCertDecisionSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EntitlementDecisionsMade** | Pointer to **Int32** | Number of entitlement decisions that have been made | [optional] +**AccessProfileDecisionsMade** | Pointer to **Int32** | Number of access profile decisions that have been made | [optional] +**RoleDecisionsMade** | Pointer to **Int32** | Number of role decisions that have been made | [optional] +**AccountDecisionsMade** | Pointer to **Int32** | Number of account decisions that have been made | [optional] +**EntitlementDecisionsTotal** | Pointer to **Int32** | The total number of entitlement decisions on the certification, both complete and incomplete | [optional] +**AccessProfileDecisionsTotal** | Pointer to **Int32** | The total number of access profile decisions on the certification, both complete and incomplete | [optional] +**RoleDecisionsTotal** | Pointer to **Int32** | The total number of role decisions on the certification, both complete and incomplete | [optional] +**AccountDecisionsTotal** | Pointer to **Int32** | The total number of account decisions on the certification, both complete and incomplete | [optional] +**EntitlementsApproved** | Pointer to **Int32** | The number of entitlement decisions that have been made which were approved | [optional] +**EntitlementsRevoked** | Pointer to **Int32** | The number of entitlement decisions that have been made which were revoked | [optional] +**AccessProfilesApproved** | Pointer to **Int32** | The number of access profile decisions that have been made which were approved | [optional] +**AccessProfilesRevoked** | Pointer to **Int32** | The number of access profile decisions that have been made which were revoked | [optional] +**RolesApproved** | Pointer to **Int32** | The number of role decisions that have been made which were approved | [optional] +**RolesRevoked** | Pointer to **Int32** | The number of role decisions that have been made which were revoked | [optional] +**AccountsApproved** | Pointer to **Int32** | The number of account decisions that have been made which were approved | [optional] +**AccountsRevoked** | Pointer to **Int32** | The number of account decisions that have been made which were revoked | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityCertDecisionSummary = Initialize-PSSailpoint.V2024IdentityCertDecisionSummary -EntitlementDecisionsMade 3 ` + -AccessProfileDecisionsMade 5 ` + -RoleDecisionsMade 2 ` + -AccountDecisionsMade 4 ` + -EntitlementDecisionsTotal 6 ` + -AccessProfileDecisionsTotal 10 ` + -RoleDecisionsTotal 4 ` + -AccountDecisionsTotal 8 ` + -EntitlementsApproved 2 ` + -EntitlementsRevoked 1 ` + -AccessProfilesApproved 3 ` + -AccessProfilesRevoked 2 ` + -RolesApproved 2 ` + -RolesRevoked 0 ` + -AccountsApproved 1 ` + -AccountsRevoked 3 +``` + +- Convert the resource to JSON +```powershell +$IdentityCertDecisionSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityCertificationDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityCertificationDto.md new file mode 100644 index 000000000..d2c228fcf --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityCertificationDto.md @@ -0,0 +1,67 @@ +--- +id: v2024-identity-certification-dto +title: IdentityCertificationDto +pagination_label: IdentityCertificationDto +sidebar_label: IdentityCertificationDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityCertificationDto', 'V2024IdentityCertificationDto'] +slug: /tools/sdk/powershell/v2024/models/identity-certification-dto +tags: ['SDK', 'Software Development Kit', 'IdentityCertificationDto', 'V2024IdentityCertificationDto'] +--- + + +# IdentityCertificationDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | id of the certification | [optional] +**Name** | Pointer to **String** | name of the certification | [optional] +**Campaign** | Pointer to [**CampaignReference**](campaign-reference) | | [optional] +**Completed** | Pointer to **Boolean** | Have all decisions been made? | [optional] +**IdentitiesCompleted** | Pointer to **Int32** | The number of identities for whom all decisions have been made and are complete. | [optional] +**IdentitiesTotal** | Pointer to **Int32** | The total number of identities in the Certification, both complete and incomplete. | [optional] +**Created** | Pointer to **System.DateTime** | created date | [optional] +**Modified** | Pointer to **System.DateTime** | modified date | [optional] +**DecisionsMade** | Pointer to **Int32** | The number of approve/revoke/acknowledge decisions that have been made. | [optional] +**DecisionsTotal** | Pointer to **Int32** | The total number of approve/revoke/acknowledge decisions. | [optional] +**Due** | Pointer to **System.DateTime** | The due date of the certification. | [optional] +**Signed** | Pointer to **System.DateTime** | The date the reviewer signed off on the Certification. | [optional] +**Reviewer** | Pointer to [**Reviewer**](reviewer) | | [optional] +**Reassignment** | Pointer to [**Reassignment**](reassignment) | | [optional] +**HasErrors** | Pointer to **Boolean** | Identifies if the certification has an error | [optional] +**ErrorMessage** | Pointer to **String** | Description of the certification error | [optional] +**Phase** | Pointer to [**CertificationPhase**](certification-phase) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityCertificationDto = Initialize-PSSailpoint.V2024IdentityCertificationDto -Id 2c9180835d2e5168015d32f890ca1581 ` + -Name Source Owner Access Review for Employees [source] ` + -Campaign null ` + -Completed true ` + -IdentitiesCompleted 5 ` + -IdentitiesTotal 10 ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -DecisionsMade 20 ` + -DecisionsTotal 40 ` + -Due 2018-10-19T13:49:37.385Z ` + -Signed 2018-10-19T13:49:37.385Z ` + -Reviewer null ` + -Reassignment null ` + -HasErrors false ` + -ErrorMessage The certification has an error ` + -Phase null +``` + +- Convert the resource to JSON +```powershell +$IdentityCertificationDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityCertified.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityCertified.md new file mode 100644 index 000000000..fdc953ad4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityCertified.md @@ -0,0 +1,49 @@ +--- +id: v2024-identity-certified +title: IdentityCertified +pagination_label: IdentityCertified +sidebar_label: IdentityCertified +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityCertified', 'V2024IdentityCertified'] +slug: /tools/sdk/powershell/v2024/models/identity-certified +tags: ['SDK', 'Software Development Kit', 'IdentityCertified', 'V2024IdentityCertified'] +--- + + +# IdentityCertified + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CertificationId** | Pointer to **String** | the id of the certification item | [optional] +**CertificationName** | Pointer to **String** | the certification item name | [optional] +**SignedDate** | Pointer to **String** | the date ceritification was signed | [optional] +**Certifiers** | Pointer to [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [optional] +**Reviewers** | Pointer to [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional] +**Signer** | Pointer to [**CertifierResponse**](certifier-response) | | [optional] +**EventType** | Pointer to **String** | the event type | [optional] +**Dt** | Pointer to **String** | the date of event | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityCertified = Initialize-PSSailpoint.V2024IdentityCertified -CertificationId 2c91808a77ff216301782327a50f09bf ` + -CertificationName Cert name ` + -SignedDate 2019-03-08T22:37:33.901Z ` + -Certifiers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` + -Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` + -Signer null ` + -EventType IdentityCertified ` + -Dt 2019-03-08T22:37:33.901Z +``` + +- Convert the resource to JSON +```powershell +$IdentityCertified | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityCompareResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityCompareResponse.md new file mode 100644 index 000000000..59e10d855 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityCompareResponse.md @@ -0,0 +1,35 @@ +--- +id: v2024-identity-compare-response +title: IdentityCompareResponse +pagination_label: IdentityCompareResponse +sidebar_label: IdentityCompareResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityCompareResponse', 'V2024IdentityCompareResponse'] +slug: /tools/sdk/powershell/v2024/models/identity-compare-response +tags: ['SDK', 'Software Development Kit', 'IdentityCompareResponse', 'V2024IdentityCompareResponse'] +--- + + +# IdentityCompareResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessItemDiff** | Pointer to [**map[string]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityCompareResponse = Initialize-PSSailpoint.V2024IdentityCompareResponse -AccessItemDiff null +``` + +- Convert the resource to JSON +```powershell +$IdentityCompareResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityCreated.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityCreated.md new file mode 100644 index 000000000..ac3ba8107 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityCreated.md @@ -0,0 +1,37 @@ +--- +id: v2024-identity-created +title: IdentityCreated +pagination_label: IdentityCreated +sidebar_label: IdentityCreated +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityCreated', 'V2024IdentityCreated'] +slug: /tools/sdk/powershell/v2024/models/identity-created +tags: ['SDK', 'Software Development Kit', 'IdentityCreated', 'V2024IdentityCreated'] +--- + + +# IdentityCreated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**IdentityCreatedIdentity**](identity-created-identity) | | [required] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes assigned to the identity. Attributes are determined by the identity profile. | [required] + +## Examples + +- Prepare the resource +```powershell +$IdentityCreated = Initialize-PSSailpoint.V2024IdentityCreated -Identity null ` + -Attributes {firstname=John} +``` + +- Convert the resource to JSON +```powershell +$IdentityCreated | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityCreatedIdentity.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityCreatedIdentity.md new file mode 100644 index 000000000..05066115f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityCreatedIdentity.md @@ -0,0 +1,39 @@ +--- +id: v2024-identity-created-identity +title: IdentityCreatedIdentity +pagination_label: IdentityCreatedIdentity +sidebar_label: IdentityCreatedIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityCreatedIdentity', 'V2024IdentityCreatedIdentity'] +slug: /tools/sdk/powershell/v2024/models/identity-created-identity +tags: ['SDK', 'Software Development Kit', 'IdentityCreatedIdentity', 'V2024IdentityCreatedIdentity'] +--- + + +# IdentityCreatedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | Created identity's DTO type. | [required] +**Id** | **String** | Created identity ID. | [required] +**Name** | **String** | Created identity's display name. | [required] + +## Examples + +- Prepare the resource +```powershell +$IdentityCreatedIdentity = Initialize-PSSailpoint.V2024IdentityCreatedIdentity -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$IdentityCreatedIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityDeleted.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityDeleted.md new file mode 100644 index 000000000..08344e937 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityDeleted.md @@ -0,0 +1,37 @@ +--- +id: v2024-identity-deleted +title: IdentityDeleted +pagination_label: IdentityDeleted +sidebar_label: IdentityDeleted +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityDeleted', 'V2024IdentityDeleted'] +slug: /tools/sdk/powershell/v2024/models/identity-deleted +tags: ['SDK', 'Software Development Kit', 'IdentityDeleted', 'V2024IdentityDeleted'] +--- + + +# IdentityDeleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | [**IdentityDeletedIdentity**](identity-deleted-identity) | | [required] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes assigned to the identity. Attributes are determined by the identity profile. | [required] + +## Examples + +- Prepare the resource +```powershell +$IdentityDeleted = Initialize-PSSailpoint.V2024IdentityDeleted -Identity null ` + -Attributes {firstname=John} +``` + +- Convert the resource to JSON +```powershell +$IdentityDeleted | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityDeletedIdentity.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityDeletedIdentity.md new file mode 100644 index 000000000..1008467b9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityDeletedIdentity.md @@ -0,0 +1,39 @@ +--- +id: v2024-identity-deleted-identity +title: IdentityDeletedIdentity +pagination_label: IdentityDeletedIdentity +sidebar_label: IdentityDeletedIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityDeletedIdentity', 'V2024IdentityDeletedIdentity'] +slug: /tools/sdk/powershell/v2024/models/identity-deleted-identity +tags: ['SDK', 'Software Development Kit', 'IdentityDeletedIdentity', 'V2024IdentityDeletedIdentity'] +--- + + +# IdentityDeletedIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | Deleted identity's DTO type. | [required] +**Id** | **String** | Deleted identity ID. | [required] +**Name** | **String** | Deleted identity's display name. | [required] + +## Examples + +- Prepare the resource +```powershell +$IdentityDeletedIdentity = Initialize-PSSailpoint.V2024IdentityDeletedIdentity -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$IdentityDeletedIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityDocument.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityDocument.md new file mode 100644 index 000000000..078b3e3f6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityDocument.md @@ -0,0 +1,101 @@ +--- +id: v2024-identity-document +title: IdentityDocument +pagination_label: IdentityDocument +sidebar_label: IdentityDocument +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityDocument', 'V2024IdentityDocument'] +slug: /tools/sdk/powershell/v2024/models/identity-document +tags: ['SDK', 'Software Development Kit', 'IdentityDocument', 'V2024IdentityDocument'] +--- + + +# IdentityDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the referenced object. | [required] +**Name** | **String** | The human readable name of the referenced object. | [required] +**Type** | [**DocumentType**](document-type) | | [required] +**DisplayName** | Pointer to **String** | Identity's display name. | [optional] +**FirstName** | Pointer to **String** | Identity's first name. | [optional] +**LastName** | Pointer to **String** | Identity's last name. | [optional] +**Email** | Pointer to **String** | Identity's primary email address. | [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] +**Phone** | Pointer to **String** | Identity's phone number. | [optional] +**Synced** | Pointer to **String** | 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] +**Inactive** | Pointer to **Boolean** | Indicates whether the identity is inactive. | [optional] [default to $false] +**Protected** | Pointer to **Boolean** | Indicates whether the identity is protected. | [optional] [default to $false] +**Status** | Pointer to **String** | Identity's status in SailPoint. | [optional] +**EmployeeNumber** | Pointer to **String** | Identity's employee number. | [optional] +**Manager** | Pointer to [**IdentityDocumentAllOfManager**](identity-document-all-of-manager) | | [optional] +**IsManager** | Pointer to **Boolean** | Indicates whether the identity is a manager of other identities. | [optional] +**IdentityProfile** | Pointer to [**IdentityDocumentAllOfIdentityProfile**](identity-document-all-of-identity-profile) | | [optional] +**Source** | Pointer to [**IdentityDocumentAllOfSource**](identity-document-all-of-source) | | [optional] +**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Map or dictionary of key/value pairs. | [optional] +**ProcessingState** | Pointer to **String** | Identity's processing state. | [optional] +**ProcessingDetails** | Pointer to [**ProcessingDetails**](processing-details) | | [optional] +**Accounts** | Pointer to [**[]BaseAccount**](base-account) | List of accounts associated with the identity. | [optional] +**AccountCount** | Pointer to **Int32** | Number of accounts associated with the identity. | [optional] +**Apps** | Pointer to [**[]App**](app) | List of applications the identity has access to. | [optional] +**AppCount** | Pointer to **Int32** | Number of applications the identity has access to. | [optional] +**Access** | Pointer to [**[]IdentityAccess**](identity-access) | List of access items assigned to the identity. | [optional] +**AccessCount** | Pointer to **Int32** | Number of access items assigned to the identity. | [optional] +**EntitlementCount** | Pointer to **Int32** | Number of entitlements assigned to the identity. | [optional] +**RoleCount** | Pointer to **Int32** | Number of roles assigned to the identity. | [optional] +**AccessProfileCount** | Pointer to **Int32** | Number of access profiles assigned to the identity. | [optional] +**Owns** | Pointer to [**[]Owns**](owns) | Access items the identity owns. | [optional] +**OwnsCount** | Pointer to **Int32** | Number of access items the identity owns. | [optional] +**Tags** | Pointer to **[]String** | Tags that have been applied to the object. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityDocument = Initialize-PSSailpoint.V2024IdentityDocument -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -Type null ` + -DisplayName Carol.Adams ` + -FirstName Carol ` + -LastName Adams ` + -Email Carol.Adams@sailpointdemo.com ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Phone +1 440-527-3672 ` + -Synced null ` + -Inactive false ` + -Protected false ` + -Status UNREGISTERED ` + -EmployeeNumber 1a2a3d4e ` + -Manager null ` + -IsManager false ` + -IdentityProfile null ` + -Source null ` + -Attributes {country=US, firstname=Carol, cloudStatus=UNREGISTERED} ` + -ProcessingState null ` + -ProcessingDetails null ` + -Accounts null ` + -AccountCount 3 ` + -Apps null ` + -AppCount 2 ` + -Access null ` + -AccessCount 5 ` + -EntitlementCount 10 ` + -RoleCount 1 ` + -AccessProfileCount 1 ` + -Owns null ` + -OwnsCount 5 ` + -Tags [TAG_1, TAG_2] +``` + +- Convert the resource to JSON +```powershell +$IdentityDocument | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityDocumentAllOfIdentityProfile.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityDocumentAllOfIdentityProfile.md new file mode 100644 index 000000000..706a4095f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityDocumentAllOfIdentityProfile.md @@ -0,0 +1,37 @@ +--- +id: v2024-identity-document-all-of-identity-profile +title: IdentityDocumentAllOfIdentityProfile +pagination_label: IdentityDocumentAllOfIdentityProfile +sidebar_label: IdentityDocumentAllOfIdentityProfile +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityDocumentAllOfIdentityProfile', 'V2024IdentityDocumentAllOfIdentityProfile'] +slug: /tools/sdk/powershell/v2024/models/identity-document-all-of-identity-profile +tags: ['SDK', 'Software Development Kit', 'IdentityDocumentAllOfIdentityProfile', 'V2024IdentityDocumentAllOfIdentityProfile'] +--- + + +# IdentityDocumentAllOfIdentityProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Identity profile's ID. | [optional] +**Name** | Pointer to **String** | Identity profile's name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityDocumentAllOfIdentityProfile = Initialize-PSSailpoint.V2024IdentityDocumentAllOfIdentityProfile -Id 3bc8ad26b8664945866b31339d1ff7d2 ` + -Name HR Employees +``` + +- Convert the resource to JSON +```powershell +$IdentityDocumentAllOfIdentityProfile | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityDocumentAllOfManager.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityDocumentAllOfManager.md new file mode 100644 index 000000000..0259e0715 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityDocumentAllOfManager.md @@ -0,0 +1,39 @@ +--- +id: v2024-identity-document-all-of-manager +title: IdentityDocumentAllOfManager +pagination_label: IdentityDocumentAllOfManager +sidebar_label: IdentityDocumentAllOfManager +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityDocumentAllOfManager', 'V2024IdentityDocumentAllOfManager'] +slug: /tools/sdk/powershell/v2024/models/identity-document-all-of-manager +tags: ['SDK', 'Software Development Kit', 'IdentityDocumentAllOfManager', 'V2024IdentityDocumentAllOfManager'] +--- + + +# IdentityDocumentAllOfManager + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of identity's manager. | [optional] +**Name** | Pointer to **String** | Name of identity's manager. | [optional] +**DisplayName** | Pointer to **String** | Display name of identity's manager. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityDocumentAllOfManager = Initialize-PSSailpoint.V2024IdentityDocumentAllOfManager -Id 2c9180867dfe694b017e208e27c05799 ` + -Name Amanda.Ross ` + -DisplayName Amanda.Ross +``` + +- Convert the resource to JSON +```powershell +$IdentityDocumentAllOfManager | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityDocumentAllOfSource.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityDocumentAllOfSource.md new file mode 100644 index 000000000..bf8077850 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityDocumentAllOfSource.md @@ -0,0 +1,37 @@ +--- +id: v2024-identity-document-all-of-source +title: IdentityDocumentAllOfSource +pagination_label: IdentityDocumentAllOfSource +sidebar_label: IdentityDocumentAllOfSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityDocumentAllOfSource', 'V2024IdentityDocumentAllOfSource'] +slug: /tools/sdk/powershell/v2024/models/identity-document-all-of-source +tags: ['SDK', 'Software Development Kit', 'IdentityDocumentAllOfSource', 'V2024IdentityDocumentAllOfSource'] +--- + + +# IdentityDocumentAllOfSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of identity's source. | [optional] +**Name** | Pointer to **String** | Display name of identity's source. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityDocumentAllOfSource = Initialize-PSSailpoint.V2024IdentityDocumentAllOfSource -Id 2c91808b6e9e6fb8016eec1a2b6f7b5f ` + -Name ODS-HR-Employees +``` + +- Convert the resource to JSON +```powershell +$IdentityDocumentAllOfSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityEntities.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityEntities.md new file mode 100644 index 000000000..4731ddf15 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityEntities.md @@ -0,0 +1,35 @@ +--- +id: v2024-identity-entities +title: IdentityEntities +pagination_label: IdentityEntities +sidebar_label: IdentityEntities +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityEntities', 'V2024IdentityEntities'] +slug: /tools/sdk/powershell/v2024/models/identity-entities +tags: ['SDK', 'Software Development Kit', 'IdentityEntities', 'V2024IdentityEntities'] +--- + + +# IdentityEntities + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityEntity** | Pointer to [**IdentityEntitiesIdentityEntity**](identity-entities-identity-entity) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityEntities = Initialize-PSSailpoint.V2024IdentityEntities -IdentityEntity null +``` + +- Convert the resource to JSON +```powershell +$IdentityEntities | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityEntitiesIdentityEntity.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityEntitiesIdentityEntity.md new file mode 100644 index 000000000..727c87da5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityEntitiesIdentityEntity.md @@ -0,0 +1,39 @@ +--- +id: v2024-identity-entities-identity-entity +title: IdentityEntitiesIdentityEntity +pagination_label: IdentityEntitiesIdentityEntity +sidebar_label: IdentityEntitiesIdentityEntity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityEntitiesIdentityEntity', 'V2024IdentityEntitiesIdentityEntity'] +slug: /tools/sdk/powershell/v2024/models/identity-entities-identity-entity +tags: ['SDK', 'Software Development Kit', 'IdentityEntitiesIdentityEntity', 'V2024IdentityEntitiesIdentityEntity'] +--- + + +# IdentityEntitiesIdentityEntity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | id of the resource to which the identity is associated | [optional] +**Name** | Pointer to **String** | name of the resource to which the identity is associated | [optional] +**Type** | Pointer to **String** | type of the resource to which the identity is associated | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityEntitiesIdentityEntity = Initialize-PSSailpoint.V2024IdentityEntitiesIdentityEntity -Id 031034e97f094a4096c1be53f75f6b91 ` + -Name Gaston.800ddf9640a ` + -Type CAMPAIGN_CAMPAIGNER +``` + +- Convert the resource to JSON +```powershell +$IdentityEntitiesIdentityEntity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityExceptionReportReference.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityExceptionReportReference.md new file mode 100644 index 000000000..8da3ebaa9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityExceptionReportReference.md @@ -0,0 +1,37 @@ +--- +id: v2024-identity-exception-report-reference +title: IdentityExceptionReportReference +pagination_label: IdentityExceptionReportReference +sidebar_label: IdentityExceptionReportReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityExceptionReportReference', 'V2024IdentityExceptionReportReference'] +slug: /tools/sdk/powershell/v2024/models/identity-exception-report-reference +tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'V2024IdentityExceptionReportReference'] +--- + + +# IdentityExceptionReportReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TaskResultId** | Pointer to **String** | The id of the task result. | [optional] +**ReportName** | Pointer to **String** | The name of the report. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityExceptionReportReference = Initialize-PSSailpoint.V2024IdentityExceptionReportReference -TaskResultId 2b838de9-db9b-abcf-e646-d4f274ad4238 ` + -ReportName My annual report +``` + +- Convert the resource to JSON +```powershell +$IdentityExceptionReportReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityHistoryResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityHistoryResponse.md new file mode 100644 index 000000000..49cf530b3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityHistoryResponse.md @@ -0,0 +1,45 @@ +--- +id: v2024-identity-history-response +title: IdentityHistoryResponse +pagination_label: IdentityHistoryResponse +sidebar_label: IdentityHistoryResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityHistoryResponse', 'V2024IdentityHistoryResponse'] +slug: /tools/sdk/powershell/v2024/models/identity-history-response +tags: ['SDK', 'Software Development Kit', 'IdentityHistoryResponse', 'V2024IdentityHistoryResponse'] +--- + + +# IdentityHistoryResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | the identity ID | [optional] +**DisplayName** | Pointer to **String** | the display name of the identity | [optional] +**Snapshot** | Pointer to **String** | the date when the identity record was created | [optional] +**DeletedDate** | Pointer to **String** | the date when the identity was deleted | [optional] +**AccessItemCount** | Pointer to **map[string]Int32** | A map containing the count of each access item | [optional] +**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map containing the identity attributes | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityHistoryResponse = Initialize-PSSailpoint.V2024IdentityHistoryResponse -Id bc693f07e7b645539626c25954c58554 ` + -DisplayName Adam Zampa ` + -Snapshot 2007-03-01T13:00:00.000Z ` + -DeletedDate 2007-03-01T13:00:00.000Z ` + -AccessItemCount {app=0, role=2, entitlement=4, accessProfile=3, account=1} ` + -Attributes {jobTitle=HR Manager, location=NYC, firstname=Adam, lastname=Zampa, department=HR} +``` + +- Convert the resource to JSON +```powershell +$IdentityHistoryResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityLifecycleState.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityLifecycleState.md new file mode 100644 index 000000000..c4d74fc37 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityLifecycleState.md @@ -0,0 +1,37 @@ +--- +id: v2024-identity-lifecycle-state +title: IdentityLifecycleState +pagination_label: IdentityLifecycleState +sidebar_label: IdentityLifecycleState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityLifecycleState', 'V2024IdentityLifecycleState'] +slug: /tools/sdk/powershell/v2024/models/identity-lifecycle-state +tags: ['SDK', 'Software Development Kit', 'IdentityLifecycleState', 'V2024IdentityLifecycleState'] +--- + + +# IdentityLifecycleState + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**StateName** | **String** | The name of the lifecycle state | [required] +**ManuallyUpdated** | **Boolean** | Whether the lifecycle state has been manually or automatically set | [required] + +## Examples + +- Prepare the resource +```powershell +$IdentityLifecycleState = Initialize-PSSailpoint.V2024IdentityLifecycleState -StateName active ` + -ManuallyUpdated true +``` + +- Convert the resource to JSON +```powershell +$IdentityLifecycleState | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityListItem.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityListItem.md new file mode 100644 index 000000000..af5bf5476 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityListItem.md @@ -0,0 +1,45 @@ +--- +id: v2024-identity-list-item +title: IdentityListItem +pagination_label: IdentityListItem +sidebar_label: IdentityListItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityListItem', 'V2024IdentityListItem'] +slug: /tools/sdk/powershell/v2024/models/identity-list-item +tags: ['SDK', 'Software Development Kit', 'IdentityListItem', 'V2024IdentityListItem'] +--- + + +# IdentityListItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | the identity ID | [optional] +**DisplayName** | Pointer to **String** | the display name of the identity | [optional] +**FirstName** | Pointer to **String** | the first name of the identity | [optional] +**LastName** | Pointer to **String** | the last name of the identity | [optional] +**Active** | Pointer to **Boolean** | indicates if an identity is active or not | [optional] [default to $true] +**DeletedDate** | Pointer to **String** | the date when the identity was deleted | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityListItem = Initialize-PSSailpoint.V2024IdentityListItem -Id bc693f07e7b645539626c25954c58554 ` + -DisplayName Adam Zampa ` + -FirstName Adam ` + -LastName Zampa ` + -Active true ` + -DeletedDate 2007-03-01T13:00:00.000Z +``` + +- Convert the resource to JSON +```powershell +$IdentityListItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityManagerRef.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityManagerRef.md new file mode 100644 index 000000000..ffbf91ef6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityManagerRef.md @@ -0,0 +1,39 @@ +--- +id: v2024-identity-manager-ref +title: IdentityManagerRef +pagination_label: IdentityManagerRef +sidebar_label: IdentityManagerRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityManagerRef', 'V2024IdentityManagerRef'] +slug: /tools/sdk/powershell/v2024/models/identity-manager-ref +tags: ['SDK', 'Software Development Kit', 'IdentityManagerRef', 'V2024IdentityManagerRef'] +--- + + +# IdentityManagerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | DTO type of identity's manager | [optional] +**Id** | Pointer to **String** | ID of identity's manager | [optional] +**Name** | Pointer to **String** | Human-readable display name of identity's manager | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityManagerRef = Initialize-PSSailpoint.V2024IdentityManagerRef -Type IDENTITY ` + -Id 2c4180a46faadee4016fb4e018c20626 ` + -Name Robert Robinson +``` + +- Convert the resource to JSON +```powershell +$IdentityManagerRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityOwnershipAssociationDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityOwnershipAssociationDetails.md new file mode 100644 index 000000000..6544be579 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityOwnershipAssociationDetails.md @@ -0,0 +1,35 @@ +--- +id: v2024-identity-ownership-association-details +title: IdentityOwnershipAssociationDetails +pagination_label: IdentityOwnershipAssociationDetails +sidebar_label: IdentityOwnershipAssociationDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityOwnershipAssociationDetails', 'V2024IdentityOwnershipAssociationDetails'] +slug: /tools/sdk/powershell/v2024/models/identity-ownership-association-details +tags: ['SDK', 'Software Development Kit', 'IdentityOwnershipAssociationDetails', 'V2024IdentityOwnershipAssociationDetails'] +--- + + +# IdentityOwnershipAssociationDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AssociationDetails** | Pointer to [**[]IdentityOwnershipAssociationDetailsAssociationDetailsInner**](identity-ownership-association-details-association-details-inner) | list of all the resource associations for the identity | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityOwnershipAssociationDetails = Initialize-PSSailpoint.V2024IdentityOwnershipAssociationDetails -AssociationDetails null +``` + +- Convert the resource to JSON +```powershell +$IdentityOwnershipAssociationDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md new file mode 100644 index 000000000..290eca283 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md @@ -0,0 +1,37 @@ +--- +id: v2024-identity-ownership-association-details-association-details-inner +title: IdentityOwnershipAssociationDetailsAssociationDetailsInner +pagination_label: IdentityOwnershipAssociationDetailsAssociationDetailsInner +sidebar_label: IdentityOwnershipAssociationDetailsAssociationDetailsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityOwnershipAssociationDetailsAssociationDetailsInner', 'V2024IdentityOwnershipAssociationDetailsAssociationDetailsInner'] +slug: /tools/sdk/powershell/v2024/models/identity-ownership-association-details-association-details-inner +tags: ['SDK', 'Software Development Kit', 'IdentityOwnershipAssociationDetailsAssociationDetailsInner', 'V2024IdentityOwnershipAssociationDetailsAssociationDetailsInner'] +--- + + +# IdentityOwnershipAssociationDetailsAssociationDetailsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AssociationType** | Pointer to **String** | association type with the identity | [optional] +**Entities** | Pointer to [**[]IdentityEntities**](identity-entities) | the specific resource this identity has ownership on | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityOwnershipAssociationDetailsAssociationDetailsInner = Initialize-PSSailpoint.V2024IdentityOwnershipAssociationDetailsAssociationDetailsInner -AssociationType ROLE_OWNER ` + -Entities {id=b660a232f05b4e04812ca974b3011e0f, name=Gaston.800ddf9640a, type=ROLE} +``` + +- Convert the resource to JSON +```powershell +$IdentityOwnershipAssociationDetailsAssociationDetailsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityPreviewRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityPreviewRequest.md new file mode 100644 index 000000000..1250a8265 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityPreviewRequest.md @@ -0,0 +1,37 @@ +--- +id: v2024-identity-preview-request +title: IdentityPreviewRequest +pagination_label: IdentityPreviewRequest +sidebar_label: IdentityPreviewRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityPreviewRequest', 'V2024IdentityPreviewRequest'] +slug: /tools/sdk/powershell/v2024/models/identity-preview-request +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewRequest', 'V2024IdentityPreviewRequest'] +--- + + +# IdentityPreviewRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **String** | The Identity id | [optional] +**IdentityAttributeConfig** | Pointer to [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityPreviewRequest = Initialize-PSSailpoint.V2024IdentityPreviewRequest -IdentityId null ` + -IdentityAttributeConfig null +``` + +- Convert the resource to JSON +```powershell +$IdentityPreviewRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityPreviewResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityPreviewResponse.md new file mode 100644 index 000000000..10ff77959 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityPreviewResponse.md @@ -0,0 +1,37 @@ +--- +id: v2024-identity-preview-response +title: IdentityPreviewResponse +pagination_label: IdentityPreviewResponse +sidebar_label: IdentityPreviewResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityPreviewResponse', 'V2024IdentityPreviewResponse'] +slug: /tools/sdk/powershell/v2024/models/identity-preview-response +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewResponse', 'V2024IdentityPreviewResponse'] +--- + + +# IdentityPreviewResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to [**IdentityPreviewResponseIdentity**](identity-preview-response-identity) | | [optional] +**PreviewAttributes** | Pointer to [**[]IdentityAttributePreview**](identity-attribute-preview) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityPreviewResponse = Initialize-PSSailpoint.V2024IdentityPreviewResponse -Identity null ` + -PreviewAttributes null +``` + +- Convert the resource to JSON +```powershell +$IdentityPreviewResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityPreviewResponseIdentity.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityPreviewResponseIdentity.md new file mode 100644 index 000000000..ac2a4399f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityPreviewResponseIdentity.md @@ -0,0 +1,39 @@ +--- +id: v2024-identity-preview-response-identity +title: IdentityPreviewResponseIdentity +pagination_label: IdentityPreviewResponseIdentity +sidebar_label: IdentityPreviewResponseIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityPreviewResponseIdentity', 'V2024IdentityPreviewResponseIdentity'] +slug: /tools/sdk/powershell/v2024/models/identity-preview-response-identity +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewResponseIdentity', 'V2024IdentityPreviewResponseIdentity'] +--- + + +# IdentityPreviewResponseIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Identity's DTO type. | [optional] +**Id** | Pointer to **String** | Identity ID. | [optional] +**Name** | Pointer to **String** | Identity's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityPreviewResponseIdentity = Initialize-PSSailpoint.V2024IdentityPreviewResponseIdentity -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$IdentityPreviewResponseIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityProfile.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityProfile.md new file mode 100644 index 000000000..be6dc5a91 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityProfile.md @@ -0,0 +1,59 @@ +--- +id: v2024-identity-profile +title: IdentityProfile +pagination_label: IdentityProfile +sidebar_label: IdentityProfile +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfile', 'V2024IdentityProfile'] +slug: /tools/sdk/powershell/v2024/models/identity-profile +tags: ['SDK', 'Software Development Kit', 'IdentityProfile', 'V2024IdentityProfile'] +--- + + +# IdentityProfile + +## Properties + +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] +**Description** | Pointer to **String** | The description of the Identity Profile. | [optional] +**Owner** | Pointer to [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] +**Priority** | Pointer to **Int64** | The priority for an Identity Profile. | [optional] +**AuthoritativeSource** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | [required] +**IdentityRefreshRequired** | Pointer to **Boolean** | True if a identity refresh is needed. Typically triggered when a change on the source has been made. | [optional] [default to $false] +**IdentityCount** | Pointer to **Int32** | The number of identities that belong to the Identity Profile. | [optional] +**IdentityAttributeConfig** | Pointer to [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] +**IdentityExceptionReportReference** | Pointer to [**IdentityExceptionReportReference**](identity-exception-report-reference) | | [optional] +**HasTimeBasedAttr** | Pointer to **Boolean** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$IdentityProfile = Initialize-PSSailpoint.V2024IdentityProfile -Id id12345 ` + -Name aName ` + -Created 2015-05-28T14:07:17Z ` + -Modified 2015-05-28T14:07:17Z ` + -Description My custom flat file profile ` + -Owner null ` + -Priority 10 ` + -AuthoritativeSource null ` + -IdentityRefreshRequired true ` + -IdentityCount 8 ` + -IdentityAttributeConfig null ` + -IdentityExceptionReportReference null ` + -HasTimeBasedAttr true +``` + +- Convert the resource to JSON +```powershell +$IdentityProfile | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityProfileAllOfAuthoritativeSource.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityProfileAllOfAuthoritativeSource.md new file mode 100644 index 000000000..8d5b9997d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityProfileAllOfAuthoritativeSource.md @@ -0,0 +1,39 @@ +--- +id: v2024-identity-profile-all-of-authoritative-source +title: IdentityProfileAllOfAuthoritativeSource +pagination_label: IdentityProfileAllOfAuthoritativeSource +sidebar_label: IdentityProfileAllOfAuthoritativeSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfileAllOfAuthoritativeSource', 'V2024IdentityProfileAllOfAuthoritativeSource'] +slug: /tools/sdk/powershell/v2024/models/identity-profile-all-of-authoritative-source +tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSource', 'V2024IdentityProfileAllOfAuthoritativeSource'] +--- + + +# IdentityProfileAllOfAuthoritativeSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "SOURCE" ] | Type of the object to which this reference applies | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityProfileAllOfAuthoritativeSource = Initialize-PSSailpoint.V2024IdentityProfileAllOfAuthoritativeSource -Type SOURCE ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name HR Active Directory +``` + +- Convert the resource to JSON +```powershell +$IdentityProfileAllOfAuthoritativeSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityProfileAllOfOwner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityProfileAllOfOwner.md new file mode 100644 index 000000000..2e4fe65c0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityProfileAllOfOwner.md @@ -0,0 +1,39 @@ +--- +id: v2024-identity-profile-all-of-owner +title: IdentityProfileAllOfOwner +pagination_label: IdentityProfileAllOfOwner +sidebar_label: IdentityProfileAllOfOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfileAllOfOwner', 'V2024IdentityProfileAllOfOwner'] +slug: /tools/sdk/powershell/v2024/models/identity-profile-all-of-owner +tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'V2024IdentityProfileAllOfOwner'] +--- + + +# IdentityProfileAllOfOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Type of the object to which this reference applies | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityProfileAllOfOwner = Initialize-PSSailpoint.V2024IdentityProfileAllOfOwner -Type IDENTITY ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$IdentityProfileAllOfOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityProfileExportedObject.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityProfileExportedObject.md new file mode 100644 index 000000000..6bd3405c2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityProfileExportedObject.md @@ -0,0 +1,39 @@ +--- +id: v2024-identity-profile-exported-object +title: IdentityProfileExportedObject +pagination_label: IdentityProfileExportedObject +sidebar_label: IdentityProfileExportedObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfileExportedObject', 'V2024IdentityProfileExportedObject'] +slug: /tools/sdk/powershell/v2024/models/identity-profile-exported-object +tags: ['SDK', 'Software Development Kit', 'IdentityProfileExportedObject', 'V2024IdentityProfileExportedObject'] +--- + + +# IdentityProfileExportedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | Pointer to **Int32** | Version or object from the target service. | [optional] +**Self** | Pointer to [**IdentityProfileExportedObjectSelf**](identity-profile-exported-object-self) | | [optional] +**Object** | Pointer to [**IdentityProfile**](identity-profile) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityProfileExportedObject = Initialize-PSSailpoint.V2024IdentityProfileExportedObject -Version 1 ` + -Self null ` + -Object null +``` + +- Convert the resource to JSON +```powershell +$IdentityProfileExportedObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityProfileExportedObjectSelf.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityProfileExportedObjectSelf.md new file mode 100644 index 000000000..2f7a4c74a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityProfileExportedObjectSelf.md @@ -0,0 +1,39 @@ +--- +id: v2024-identity-profile-exported-object-self +title: IdentityProfileExportedObjectSelf +pagination_label: IdentityProfileExportedObjectSelf +sidebar_label: IdentityProfileExportedObjectSelf +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfileExportedObjectSelf', 'V2024IdentityProfileExportedObjectSelf'] +slug: /tools/sdk/powershell/v2024/models/identity-profile-exported-object-self +tags: ['SDK', 'Software Development Kit', 'IdentityProfileExportedObjectSelf', 'V2024IdentityProfileExportedObjectSelf'] +--- + + +# IdentityProfileExportedObjectSelf + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "ACCESS_REQUEST_CONFIG", "ATTR_SYNC_SOURCE_CONFIG", "AUTH_ORG", "CAMPAIGN_FILTER", "FORM_DEFINITION", "GOVERNANCE_GROUP", "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "LIFECYCLE_STATE", "NOTIFICATION_TEMPLATE", "PASSWORD_POLICY", "PASSWORD_SYNC_GROUP", "PUBLIC_IDENTITIES_CONFIG", "ROLE", "RULE", "SEGMENT", "SERVICE_DESK_INTEGRATION", "SOD_POLICY", "SOURCE", "TAG", "TRANSFORM", "TRIGGER_SUBSCRIPTION", "WORKFLOW" ] | Exported object's DTO type. | [optional] +**Id** | Pointer to **String** | Exported object's ID. | [optional] +**Name** | Pointer to **String** | Exported object's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityProfileExportedObjectSelf = Initialize-PSSailpoint.V2024IdentityProfileExportedObjectSelf -Type SOURCE ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name HR Active Directory +``` + +- Convert the resource to JSON +```powershell +$IdentityProfileExportedObjectSelf | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityProfileIdentityErrorReportArguments.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityProfileIdentityErrorReportArguments.md new file mode 100644 index 000000000..cdb53f7af --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityProfileIdentityErrorReportArguments.md @@ -0,0 +1,35 @@ +--- +id: v2024-identity-profile-identity-error-report-arguments +title: IdentityProfileIdentityErrorReportArguments +pagination_label: IdentityProfileIdentityErrorReportArguments +sidebar_label: IdentityProfileIdentityErrorReportArguments +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfileIdentityErrorReportArguments', 'V2024IdentityProfileIdentityErrorReportArguments'] +slug: /tools/sdk/powershell/v2024/models/identity-profile-identity-error-report-arguments +tags: ['SDK', 'Software Development Kit', 'IdentityProfileIdentityErrorReportArguments', 'V2024IdentityProfileIdentityErrorReportArguments'] +--- + + +# IdentityProfileIdentityErrorReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AuthoritativeSource** | **String** | Source ID. | [required] + +## Examples + +- Prepare the resource +```powershell +$IdentityProfileIdentityErrorReportArguments = Initialize-PSSailpoint.V2024IdentityProfileIdentityErrorReportArguments -AuthoritativeSource 1234sourceId5678902 +``` + +- Convert the resource to JSON +```powershell +$IdentityProfileIdentityErrorReportArguments | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityReference.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityReference.md new file mode 100644 index 000000000..6eeef1e69 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityReference.md @@ -0,0 +1,39 @@ +--- +id: v2024-identity-reference +title: IdentityReference +pagination_label: IdentityReference +sidebar_label: IdentityReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityReference', 'V2024IdentityReference'] +slug: /tools/sdk/powershell/v2024/models/identity-reference +tags: ['SDK', 'Software Development Kit', 'IdentityReference', 'V2024IdentityReference'] +--- + + +# IdentityReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **String** | Identity id | [optional] +**Name** | Pointer to **String** | Human-readable display name of identity. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityReference = Initialize-PSSailpoint.V2024IdentityReference -Type null ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Thomas Edison +``` + +- Convert the resource to JSON +```powershell +$IdentityReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityReferenceWithNameAndEmail.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityReferenceWithNameAndEmail.md new file mode 100644 index 000000000..5772cc642 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityReferenceWithNameAndEmail.md @@ -0,0 +1,41 @@ +--- +id: v2024-identity-reference-with-name-and-email +title: IdentityReferenceWithNameAndEmail +pagination_label: IdentityReferenceWithNameAndEmail +sidebar_label: IdentityReferenceWithNameAndEmail +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityReferenceWithNameAndEmail', 'V2024IdentityReferenceWithNameAndEmail'] +slug: /tools/sdk/powershell/v2024/models/identity-reference-with-name-and-email +tags: ['SDK', 'Software Development Kit', 'IdentityReferenceWithNameAndEmail', 'V2024IdentityReferenceWithNameAndEmail'] +--- + + +# IdentityReferenceWithNameAndEmail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **String** | The type can only be IDENTITY. This is read-only. | [optional] +**Id** | Pointer to **String** | Identity ID. | [optional] +**Name** | Pointer to **String** | Identity's human-readable display name. This is read-only. | [optional] +**Email** | Pointer to **String** | Identity's email address. This is read-only. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityReferenceWithNameAndEmail = Initialize-PSSailpoint.V2024IdentityReferenceWithNameAndEmail -Type IDENTITY ` + -Id 5168015d32f890ca15812c9180835d2e ` + -Name Alison Ferguso ` + -Email alison.ferguso@identitysoon.com +``` + +- Convert the resource to JSON +```powershell +$IdentityReferenceWithNameAndEmail | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentitySnapshotSummaryResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentitySnapshotSummaryResponse.md new file mode 100644 index 000000000..f851d9056 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentitySnapshotSummaryResponse.md @@ -0,0 +1,35 @@ +--- +id: v2024-identity-snapshot-summary-response +title: IdentitySnapshotSummaryResponse +pagination_label: IdentitySnapshotSummaryResponse +sidebar_label: IdentitySnapshotSummaryResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentitySnapshotSummaryResponse', 'V2024IdentitySnapshotSummaryResponse'] +slug: /tools/sdk/powershell/v2024/models/identity-snapshot-summary-response +tags: ['SDK', 'Software Development Kit', 'IdentitySnapshotSummaryResponse', 'V2024IdentitySnapshotSummaryResponse'] +--- + + +# IdentitySnapshotSummaryResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Snapshot** | Pointer to **String** | the date when the identity record was created | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentitySnapshotSummaryResponse = Initialize-PSSailpoint.V2024IdentitySnapshotSummaryResponse -Snapshot 2007-03-01T13:00:00.000Z +``` + +- Convert the resource to JSON +```powershell +$IdentitySnapshotSummaryResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentitySummary.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentitySummary.md new file mode 100644 index 000000000..7b0a983a0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentitySummary.md @@ -0,0 +1,41 @@ +--- +id: v2024-identity-summary +title: IdentitySummary +pagination_label: IdentitySummary +sidebar_label: IdentitySummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentitySummary', 'V2024IdentitySummary'] +slug: /tools/sdk/powershell/v2024/models/identity-summary +tags: ['SDK', 'Software Development Kit', 'IdentitySummary', 'V2024IdentitySummary'] +--- + + +# IdentitySummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of this identity summary | [optional] +**Name** | Pointer to **String** | Human-readable display name of identity | [optional] +**IdentityId** | Pointer to **String** | ID of the identity that this summary represents | [optional] +**Completed** | Pointer to **Boolean** | Indicates if all access items for this summary have been decided on | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$IdentitySummary = Initialize-PSSailpoint.V2024IdentitySummary -Id ff80818155fe8c080155fe8d925b0316 ` + -Name SailPoint Services ` + -IdentityId c15b9f5cca5a4e9599eaa0e64fa921bd ` + -Completed true +``` + +- Convert the resource to JSON +```powershell +$IdentitySummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentitySyncJob.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentitySyncJob.md new file mode 100644 index 000000000..01b79d61e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentitySyncJob.md @@ -0,0 +1,39 @@ +--- +id: v2024-identity-sync-job +title: IdentitySyncJob +pagination_label: IdentitySyncJob +sidebar_label: IdentitySyncJob +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentitySyncJob', 'V2024IdentitySyncJob'] +slug: /tools/sdk/powershell/v2024/models/identity-sync-job +tags: ['SDK', 'Software Development Kit', 'IdentitySyncJob', 'V2024IdentitySyncJob'] +--- + + +# IdentitySyncJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Job ID. | [required] +**Status** | **Enum** [ "QUEUED", "IN_PROGRESS", "SUCCESS", "ERROR" ] | The job status. | [required] +**Payload** | [**IdentitySyncPayload**](identity-sync-payload) | | [required] + +## Examples + +- Prepare the resource +```powershell +$IdentitySyncJob = Initialize-PSSailpoint.V2024IdentitySyncJob -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -Status IN_PROGRESS ` + -Payload null +``` + +- Convert the resource to JSON +```powershell +$IdentitySyncJob | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentitySyncPayload.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentitySyncPayload.md new file mode 100644 index 000000000..9f79902bc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentitySyncPayload.md @@ -0,0 +1,37 @@ +--- +id: v2024-identity-sync-payload +title: IdentitySyncPayload +pagination_label: IdentitySyncPayload +sidebar_label: IdentitySyncPayload +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentitySyncPayload', 'V2024IdentitySyncPayload'] +slug: /tools/sdk/powershell/v2024/models/identity-sync-payload +tags: ['SDK', 'Software Development Kit', 'IdentitySyncPayload', 'V2024IdentitySyncPayload'] +--- + + +# IdentitySyncPayload + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **String** | Payload type. | [required] +**DataJson** | **String** | Payload type. | [required] + +## Examples + +- Prepare the resource +```powershell +$IdentitySyncPayload = Initialize-PSSailpoint.V2024IdentitySyncPayload -Type SYNCHRONIZE_IDENTITY_ATTRIBUTES ` + -DataJson {"identityId":"2c918083746f642c01746f990884012a"} +``` + +- Convert the resource to JSON +```powershell +$IdentitySyncPayload | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityWithNewAccess.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityWithNewAccess.md new file mode 100644 index 000000000..99f771554 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityWithNewAccess.md @@ -0,0 +1,37 @@ +--- +id: v2024-identity-with-new-access +title: IdentityWithNewAccess +pagination_label: IdentityWithNewAccess +sidebar_label: IdentityWithNewAccess +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityWithNewAccess', 'V2024IdentityWithNewAccess'] +slug: /tools/sdk/powershell/v2024/models/identity-with-new-access +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess', 'V2024IdentityWithNewAccess'] +--- + + +# IdentityWithNewAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **String** | Identity id to be checked. | [required] +**AccessRefs** | [**[]IdentityWithNewAccessAccessRefsInner**](identity-with-new-access-access-refs-inner) | The list of entitlements to consider for possible violations in a preventive check. | [required] + +## Examples + +- Prepare the resource +```powershell +$IdentityWithNewAccess = Initialize-PSSailpoint.V2024IdentityWithNewAccess -IdentityId 2c91808568c529c60168cca6f90c1313 ` + -AccessRefs [{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}] +``` + +- Convert the resource to JSON +```powershell +$IdentityWithNewAccess | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityWithNewAccess1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityWithNewAccess1.md new file mode 100644 index 000000000..62187e293 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityWithNewAccess1.md @@ -0,0 +1,39 @@ +--- +id: v2024-identity-with-new-access1 +title: IdentityWithNewAccess1 +pagination_label: IdentityWithNewAccess1 +sidebar_label: IdentityWithNewAccess1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityWithNewAccess1', 'V2024IdentityWithNewAccess1'] +slug: /tools/sdk/powershell/v2024/models/identity-with-new-access1 +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess1', 'V2024IdentityWithNewAccess1'] +--- + + +# IdentityWithNewAccess1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **String** | Set of identity IDs to be checked. | [required] +**AccessRefs** | [**[]EntitlementRef1**](entitlement-ref1) | The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type. | [required] +**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityWithNewAccess1 = Initialize-PSSailpoint.V2024IdentityWithNewAccess1 -IdentityId 2c91809050db617d0150e0bf3215385e ` + -AccessRefs null ` + -ClientMetadata {clientName=client1, clientId=2c91808f7892918f0178b78da4a305a1} +``` + +- Convert the resource to JSON +```powershell +$IdentityWithNewAccess1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityWithNewAccessAccessRefsInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityWithNewAccessAccessRefsInner.md new file mode 100644 index 000000000..c24edbea7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IdentityWithNewAccessAccessRefsInner.md @@ -0,0 +1,39 @@ +--- +id: v2024-identity-with-new-access-access-refs-inner +title: IdentityWithNewAccessAccessRefsInner +pagination_label: IdentityWithNewAccessAccessRefsInner +sidebar_label: IdentityWithNewAccessAccessRefsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityWithNewAccessAccessRefsInner', 'V2024IdentityWithNewAccessAccessRefsInner'] +slug: /tools/sdk/powershell/v2024/models/identity-with-new-access-access-refs-inner +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccessAccessRefsInner', 'V2024IdentityWithNewAccessAccessRefsInner'] +--- + + +# IdentityWithNewAccessAccessRefsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | Entitlement's DTO type. | [optional] +**Id** | Pointer to **String** | Entitlement's ID. | [optional] +**Name** | Pointer to **String** | Entitlement's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityWithNewAccessAccessRefsInner = Initialize-PSSailpoint.V2024IdentityWithNewAccessAccessRefsInner -Type ENTITLEMENT ` + -Id 2c91809773dee32014e13e122092014e ` + -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local +``` + +- Convert the resource to JSON +```powershell +$IdentityWithNewAccessAccessRefsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ImportAccountsRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ImportAccountsRequest.md new file mode 100644 index 000000000..8e72e82bd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ImportAccountsRequest.md @@ -0,0 +1,37 @@ +--- +id: v2024-import-accounts-request +title: ImportAccountsRequest +pagination_label: ImportAccountsRequest +sidebar_label: ImportAccountsRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ImportAccountsRequest', 'V2024ImportAccountsRequest'] +slug: /tools/sdk/powershell/v2024/models/import-accounts-request +tags: ['SDK', 'Software Development Kit', 'ImportAccountsRequest', 'V2024ImportAccountsRequest'] +--- + + +# ImportAccountsRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | Pointer to **System.IO.FileInfo** | The CSV file containing the source accounts to aggregate. | [optional] +**DisableOptimization** | Pointer to **String** | Use this flag to reprocess every account whether or not the data has changed. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImportAccountsRequest = Initialize-PSSailpoint.V2024ImportAccountsRequest -File null ` + -DisableOptimization true +``` + +- Convert the resource to JSON +```powershell +$ImportAccountsRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ImportEntitlementsBySourceRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ImportEntitlementsBySourceRequest.md new file mode 100644 index 000000000..2ab300c90 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ImportEntitlementsBySourceRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-import-entitlements-by-source-request +title: ImportEntitlementsBySourceRequest +pagination_label: ImportEntitlementsBySourceRequest +sidebar_label: ImportEntitlementsBySourceRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ImportEntitlementsBySourceRequest', 'V2024ImportEntitlementsBySourceRequest'] +slug: /tools/sdk/powershell/v2024/models/import-entitlements-by-source-request +tags: ['SDK', 'Software Development Kit', 'ImportEntitlementsBySourceRequest', 'V2024ImportEntitlementsBySourceRequest'] +--- + + +# ImportEntitlementsBySourceRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CsvFile** | Pointer to **System.IO.FileInfo** | The CSV file containing the source entitlements to aggregate. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImportEntitlementsBySourceRequest = Initialize-PSSailpoint.V2024ImportEntitlementsBySourceRequest -CsvFile null +``` + +- Convert the resource to JSON +```powershell +$ImportEntitlementsBySourceRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ImportFormDefinitions202Response.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ImportFormDefinitions202Response.md new file mode 100644 index 000000000..9fb9ddf5c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ImportFormDefinitions202Response.md @@ -0,0 +1,41 @@ +--- +id: v2024-import-form-definitions202-response +title: ImportFormDefinitions202Response +pagination_label: ImportFormDefinitions202Response +sidebar_label: ImportFormDefinitions202Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ImportFormDefinitions202Response', 'V2024ImportFormDefinitions202Response'] +slug: /tools/sdk/powershell/v2024/models/import-form-definitions202-response +tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitions202Response', 'V2024ImportFormDefinitions202Response'] +--- + + +# ImportFormDefinitions202Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Errors** | Pointer to [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional] +**ImportedObjects** | Pointer to [**[]ExportFormDefinitionsByTenant200ResponseInner**](export-form-definitions-by-tenant200-response-inner) | | [optional] +**Infos** | Pointer to [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional] +**Warnings** | Pointer to [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImportFormDefinitions202Response = Initialize-PSSailpoint.V2024ImportFormDefinitions202Response -Errors null ` + -ImportedObjects null ` + -Infos null ` + -Warnings null +``` + +- Convert the resource to JSON +```powershell +$ImportFormDefinitions202Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ImportFormDefinitions202ResponseErrorsInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ImportFormDefinitions202ResponseErrorsInner.md new file mode 100644 index 000000000..0018a00f9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ImportFormDefinitions202ResponseErrorsInner.md @@ -0,0 +1,39 @@ +--- +id: v2024-import-form-definitions202-response-errors-inner +title: ImportFormDefinitions202ResponseErrorsInner +pagination_label: ImportFormDefinitions202ResponseErrorsInner +sidebar_label: ImportFormDefinitions202ResponseErrorsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ImportFormDefinitions202ResponseErrorsInner', 'V2024ImportFormDefinitions202ResponseErrorsInner'] +slug: /tools/sdk/powershell/v2024/models/import-form-definitions202-response-errors-inner +tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitions202ResponseErrorsInner', 'V2024ImportFormDefinitions202ResponseErrorsInner'] +--- + + +# ImportFormDefinitions202ResponseErrorsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Detail** | Pointer to [**map[string]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | | [optional] +**Key** | Pointer to **String** | | [optional] +**Text** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImportFormDefinitions202ResponseErrorsInner = Initialize-PSSailpoint.V2024ImportFormDefinitions202ResponseErrorsInner -Detail null ` + -Key null ` + -Text null +``` + +- Convert the resource to JSON +```powershell +$ImportFormDefinitions202ResponseErrorsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ImportNonEmployeeRecordsInBulkRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ImportNonEmployeeRecordsInBulkRequest.md new file mode 100644 index 000000000..7fd5840e2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ImportNonEmployeeRecordsInBulkRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-import-non-employee-records-in-bulk-request +title: ImportNonEmployeeRecordsInBulkRequest +pagination_label: ImportNonEmployeeRecordsInBulkRequest +sidebar_label: ImportNonEmployeeRecordsInBulkRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ImportNonEmployeeRecordsInBulkRequest', 'V2024ImportNonEmployeeRecordsInBulkRequest'] +slug: /tools/sdk/powershell/v2024/models/import-non-employee-records-in-bulk-request +tags: ['SDK', 'Software Development Kit', 'ImportNonEmployeeRecordsInBulkRequest', 'V2024ImportNonEmployeeRecordsInBulkRequest'] +--- + + +# ImportNonEmployeeRecordsInBulkRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarData** | **System.IO.FileInfo** | | [required] + +## Examples + +- Prepare the resource +```powershell +$ImportNonEmployeeRecordsInBulkRequest = Initialize-PSSailpoint.V2024ImportNonEmployeeRecordsInBulkRequest -VarData null +``` + +- Convert the resource to JSON +```powershell +$ImportNonEmployeeRecordsInBulkRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ImportObject.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ImportObject.md new file mode 100644 index 000000000..83a6e4b97 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ImportObject.md @@ -0,0 +1,39 @@ +--- +id: v2024-import-object +title: ImportObject +pagination_label: ImportObject +sidebar_label: ImportObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ImportObject', 'V2024ImportObject'] +slug: /tools/sdk/powershell/v2024/models/import-object +tags: ['SDK', 'Software Development Kit', 'ImportObject', 'V2024ImportObject'] +--- + + +# ImportObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "RULE", "SOURCE", "TRANSFORM", "TRIGGER_SUBSCRIPTION" ] | DTO type of object created or updated by import. | [optional] +**Id** | Pointer to **String** | ID of object created or updated by import. | [optional] +**Name** | Pointer to **String** | Display name of object created or updated by import. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImportObject = Initialize-PSSailpoint.V2024ImportObject -Type SOURCE ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name HR Active Directory +``` + +- Convert the resource to JSON +```powershell +$ImportObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ImportOptions.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ImportOptions.md new file mode 100644 index 000000000..5ae3b3d9e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ImportOptions.md @@ -0,0 +1,43 @@ +--- +id: v2024-import-options +title: ImportOptions +pagination_label: ImportOptions +sidebar_label: ImportOptions +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ImportOptions', 'V2024ImportOptions'] +slug: /tools/sdk/powershell/v2024/models/import-options +tags: ['SDK', 'Software Development Kit', 'ImportOptions', 'V2024ImportOptions'] +--- + + +# ImportOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ExcludeTypes** | Pointer to **[]String** | Object type names to be excluded from an sp-config export command. | [optional] +**IncludeTypes** | Pointer to **[]String** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional] +**ObjectOptions** | Pointer to [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional] +**DefaultReferences** | Pointer to **[]String** | List of object types that can be used to resolve references on import. | [optional] +**ExcludeBackup** | Pointer to **Boolean** | By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. If excludeBackup is true, the backup will not be performed. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$ImportOptions = Initialize-PSSailpoint.V2024ImportOptions -ExcludeTypes null ` + -IncludeTypes null ` + -ObjectOptions {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}} ` + -DefaultReferences null ` + -ExcludeBackup false +``` + +- Convert the resource to JSON +```powershell +$ImportOptions | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ImportSpConfigRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ImportSpConfigRequest.md new file mode 100644 index 000000000..832beda87 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ImportSpConfigRequest.md @@ -0,0 +1,37 @@ +--- +id: v2024-import-sp-config-request +title: ImportSpConfigRequest +pagination_label: ImportSpConfigRequest +sidebar_label: ImportSpConfigRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ImportSpConfigRequest', 'V2024ImportSpConfigRequest'] +slug: /tools/sdk/powershell/v2024/models/import-sp-config-request +tags: ['SDK', 'Software Development Kit', 'ImportSpConfigRequest', 'V2024ImportSpConfigRequest'] +--- + + +# ImportSpConfigRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarData** | **System.IO.FileInfo** | JSON file containing the objects to be imported. | [required] +**Options** | Pointer to [**ImportOptions**](import-options) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImportSpConfigRequest = Initialize-PSSailpoint.V2024ImportSpConfigRequest -VarData null ` + -Options null +``` + +- Convert the resource to JSON +```powershell +$ImportSpConfigRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IndexOf.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IndexOf.md new file mode 100644 index 000000000..14a94c3a1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/IndexOf.md @@ -0,0 +1,39 @@ +--- +id: v2024-index-of +title: IndexOf +pagination_label: IndexOf +sidebar_label: IndexOf +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IndexOf', 'V2024IndexOf'] +slug: /tools/sdk/powershell/v2024/models/index-of +tags: ['SDK', 'Software Development Kit', 'IndexOf', 'V2024IndexOf'] +--- + + +# IndexOf + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Substring** | **String** | A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring. | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$IndexOf = Initialize-PSSailpoint.V2024IndexOf -Substring admin_ ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$IndexOf | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/InnerHit.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/InnerHit.md new file mode 100644 index 000000000..0ddae71a4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/InnerHit.md @@ -0,0 +1,37 @@ +--- +id: v2024-inner-hit +title: InnerHit +pagination_label: InnerHit +sidebar_label: InnerHit +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'InnerHit', 'V2024InnerHit'] +slug: /tools/sdk/powershell/v2024/models/inner-hit +tags: ['SDK', 'Software Development Kit', 'InnerHit', 'V2024InnerHit'] +--- + + +# InnerHit + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | **String** | The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [required] +**Type** | **String** | The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document ""nested"" within another document. For example, an identity can have nested documents for access, accounts, and apps. | [required] + +## Examples + +- Prepare the resource +```powershell +$InnerHit = Initialize-PSSailpoint.V2024InnerHit -Query source.name:\"Active Directory\" ` + -Type access +``` + +- Convert the resource to JSON +```powershell +$InnerHit | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/InviteIdentitiesRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/InviteIdentitiesRequest.md new file mode 100644 index 000000000..3b5c9da10 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/InviteIdentitiesRequest.md @@ -0,0 +1,37 @@ +--- +id: v2024-invite-identities-request +title: InviteIdentitiesRequest +pagination_label: InviteIdentitiesRequest +sidebar_label: InviteIdentitiesRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'InviteIdentitiesRequest', 'V2024InviteIdentitiesRequest'] +slug: /tools/sdk/powershell/v2024/models/invite-identities-request +tags: ['SDK', 'Software Development Kit', 'InviteIdentitiesRequest', 'V2024InviteIdentitiesRequest'] +--- + + +# InviteIdentitiesRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]String** | The list of Identities IDs to invite - required when 'uninvited' is false | [optional] +**Uninvited** | Pointer to **Boolean** | indicator (optional) to invite all unregistered identities in the system within a limit 1000. This parameter makes sense only when 'ids' is empty. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$InviteIdentitiesRequest = Initialize-PSSailpoint.V2024InviteIdentitiesRequest -Ids [2b568c65bc3c4c57a43bd97e3a8e55, 2c9180867769897d01776ed5f125512f] ` + -Uninvited false +``` + +- Convert the resource to JSON +```powershell +$InviteIdentitiesRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Invocation.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Invocation.md new file mode 100644 index 000000000..c4cdc195e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Invocation.md @@ -0,0 +1,41 @@ +--- +id: v2024-invocation +title: Invocation +pagination_label: Invocation +sidebar_label: Invocation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Invocation', 'V2024Invocation'] +slug: /tools/sdk/powershell/v2024/models/invocation +tags: ['SDK', 'Software Development Kit', 'Invocation', 'V2024Invocation'] +--- + + +# Invocation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Invocation ID | [optional] +**TriggerId** | Pointer to **String** | Trigger ID | [optional] +**Secret** | Pointer to **String** | Unique invocation secret. | [optional] +**ContentJson** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | JSON map of invocation metadata. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Invocation = Initialize-PSSailpoint.V2024Invocation -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -TriggerId idn:access-requested ` + -Secret 0f979022-08be-44f2-b6f9-7393ec73ed9b ` + -ContentJson {workflowId=1234} +``` + +- Convert the resource to JSON +```powershell +$Invocation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/InvocationStatus.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/InvocationStatus.md new file mode 100644 index 000000000..9d9d1bf7a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/InvocationStatus.md @@ -0,0 +1,51 @@ +--- +id: v2024-invocation-status +title: InvocationStatus +pagination_label: InvocationStatus +sidebar_label: InvocationStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'InvocationStatus', 'V2024InvocationStatus'] +slug: /tools/sdk/powershell/v2024/models/invocation-status +tags: ['SDK', 'Software Development Kit', 'InvocationStatus', 'V2024InvocationStatus'] +--- + + +# InvocationStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Invocation ID | [required] +**TriggerId** | **String** | Trigger ID | [required] +**SubscriptionName** | **String** | Subscription name | [required] +**SubscriptionId** | **String** | Subscription ID | [required] +**Type** | [**InvocationStatusType**](invocation-status-type) | | [required] +**Created** | **System.DateTime** | Invocation created timestamp. ISO-8601 in UTC. | [required] +**Completed** | Pointer to **System.DateTime** | Invocation completed timestamp; empty fields imply invocation is in-flight or not completed. ISO-8601 in UTC. | [optional] +**StartInvocationInput** | [**StartInvocationInput**](start-invocation-input) | | [required] +**CompleteInvocationInput** | Pointer to [**CompleteInvocationInput**](complete-invocation-input) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$InvocationStatus = Initialize-PSSailpoint.V2024InvocationStatus -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -TriggerId idn:access-request-post-approval ` + -SubscriptionName Access request subscription ` + -SubscriptionId 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -Type null ` + -Created 2020-03-27T20:40:10.738Z ` + -Completed 2020-03-27T20:42:14.738Z ` + -StartInvocationInput null ` + -CompleteInvocationInput null +``` + +- Convert the resource to JSON +```powershell +$InvocationStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/InvocationStatusType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/InvocationStatusType.md new file mode 100644 index 000000000..624d3d414 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/InvocationStatusType.md @@ -0,0 +1,24 @@ +--- +id: v2024-invocation-status-type +title: InvocationStatusType +pagination_label: InvocationStatusType +sidebar_label: InvocationStatusType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'InvocationStatusType', 'V2024InvocationStatusType'] +slug: /tools/sdk/powershell/v2024/models/invocation-status-type +tags: ['SDK', 'Software Development Kit', 'InvocationStatusType', 'V2024InvocationStatusType'] +--- + + +# InvocationStatusType + +## Enum + + +* `TEST` (value: `"TEST"`) + +* `REAL_TIME` (value: `"REAL_TIME"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/JsonPatch.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/JsonPatch.md new file mode 100644 index 000000000..29a12be5f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/JsonPatch.md @@ -0,0 +1,35 @@ +--- +id: v2024-json-patch +title: JsonPatch +pagination_label: JsonPatch +sidebar_label: JsonPatch +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'JsonPatch', 'V2024JsonPatch'] +slug: /tools/sdk/powershell/v2024/models/json-patch +tags: ['SDK', 'Software Development Kit', 'JsonPatch', 'V2024JsonPatch'] +--- + + +# JsonPatch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operations** | Pointer to [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] + +## Examples + +- Prepare the resource +```powershell +$JsonPatch = Initialize-PSSailpoint.V2024JsonPatch -Operations null +``` + +- Convert the resource to JSON +```powershell +$JsonPatch | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/JsonPatchOperation.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/JsonPatchOperation.md new file mode 100644 index 000000000..f4a433f6f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/JsonPatchOperation.md @@ -0,0 +1,39 @@ +--- +id: v2024-json-patch-operation +title: JsonPatchOperation +pagination_label: JsonPatchOperation +sidebar_label: JsonPatchOperation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'JsonPatchOperation', 'V2024JsonPatchOperation'] +slug: /tools/sdk/powershell/v2024/models/json-patch-operation +tags: ['SDK', 'Software Development Kit', 'JsonPatchOperation', 'V2024JsonPatchOperation'] +--- + + +# JsonPatchOperation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | **Enum** [ "add", "remove", "replace", "move", "copy", "test" ] | The operation to be performed | [required] +**Path** | **String** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required] +**Value** | Pointer to [**JsonPatchOperationValue**](json-patch-operation-value) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$JsonPatchOperation = Initialize-PSSailpoint.V2024JsonPatchOperation -Op replace ` + -Path /description ` + -Value null +``` + +- Convert the resource to JSON +```powershell +$JsonPatchOperation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/JsonPatchOperationValue.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/JsonPatchOperationValue.md new file mode 100644 index 000000000..b113b0beb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/JsonPatchOperationValue.md @@ -0,0 +1,34 @@ +--- +id: v2024-json-patch-operation-value +title: JsonPatchOperationValue +pagination_label: JsonPatchOperationValue +sidebar_label: JsonPatchOperationValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'JsonPatchOperationValue', 'V2024JsonPatchOperationValue'] +slug: /tools/sdk/powershell/v2024/models/json-patch-operation-value +tags: ['SDK', 'Software Development Kit', 'JsonPatchOperationValue', 'V2024JsonPatchOperationValue'] +--- + + +# JsonPatchOperationValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$JsonPatchOperationValue = Initialize-PSSailpoint.V2024JsonPatchOperationValue +``` + +- Convert the resource to JSON +```powershell +$JsonPatchOperationValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/KbaAnswerRequestItem.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/KbaAnswerRequestItem.md new file mode 100644 index 000000000..da53fe2fc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/KbaAnswerRequestItem.md @@ -0,0 +1,37 @@ +--- +id: v2024-kba-answer-request-item +title: KbaAnswerRequestItem +pagination_label: KbaAnswerRequestItem +sidebar_label: KbaAnswerRequestItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'KbaAnswerRequestItem', 'V2024KbaAnswerRequestItem'] +slug: /tools/sdk/powershell/v2024/models/kba-answer-request-item +tags: ['SDK', 'Software Development Kit', 'KbaAnswerRequestItem', 'V2024KbaAnswerRequestItem'] +--- + + +# KbaAnswerRequestItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Question Id | [required] +**Answer** | **String** | An answer for the KBA question | [required] + +## Examples + +- Prepare the resource +```powershell +$KbaAnswerRequestItem = Initialize-PSSailpoint.V2024KbaAnswerRequestItem -Id c54fee53-2d63-4fc5-9259-3e93b9994135 ` + -Answer Your answer +``` + +- Convert the resource to JSON +```powershell +$KbaAnswerRequestItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/KbaAnswerResponseItem.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/KbaAnswerResponseItem.md new file mode 100644 index 000000000..6bc3d6f2d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/KbaAnswerResponseItem.md @@ -0,0 +1,39 @@ +--- +id: v2024-kba-answer-response-item +title: KbaAnswerResponseItem +pagination_label: KbaAnswerResponseItem +sidebar_label: KbaAnswerResponseItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'KbaAnswerResponseItem', 'V2024KbaAnswerResponseItem'] +slug: /tools/sdk/powershell/v2024/models/kba-answer-response-item +tags: ['SDK', 'Software Development Kit', 'KbaAnswerResponseItem', 'V2024KbaAnswerResponseItem'] +--- + + +# KbaAnswerResponseItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Question Id | [required] +**Question** | **String** | Question description | [required] +**HasAnswer** | **Boolean** | Denotes whether the KBA question has an answer configured for the current user | [required] + +## Examples + +- Prepare the resource +```powershell +$KbaAnswerResponseItem = Initialize-PSSailpoint.V2024KbaAnswerResponseItem -Id c54fee53-2d63-4fc5-9259-3e93b9994135 ` + -Question [{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}] ` + -HasAnswer true +``` + +- Convert the resource to JSON +```powershell +$KbaAnswerResponseItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/KbaQuestion.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/KbaQuestion.md new file mode 100644 index 000000000..fe6d826b2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/KbaQuestion.md @@ -0,0 +1,41 @@ +--- +id: v2024-kba-question +title: KbaQuestion +pagination_label: KbaQuestion +sidebar_label: KbaQuestion +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'KbaQuestion', 'V2024KbaQuestion'] +slug: /tools/sdk/powershell/v2024/models/kba-question +tags: ['SDK', 'Software Development Kit', 'KbaQuestion', 'V2024KbaQuestion'] +--- + + +# KbaQuestion + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | KBA Question Id | [required] +**Text** | **String** | KBA Question description | [required] +**HasAnswer** | **Boolean** | Denotes whether the KBA question has an answer configured for any user in the tenant | [required] +**NumAnswers** | **Int32** | Denotes the number of KBA configurations for this question | [required] + +## Examples + +- Prepare the resource +```powershell +$KbaQuestion = Initialize-PSSailpoint.V2024KbaQuestion -Id 143cfd3b-c23f-426b-ae5f-d3db06fa5919 ` + -Text [{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}] ` + -HasAnswer true ` + -NumAnswers 5 +``` + +- Convert the resource to JSON +```powershell +$KbaQuestion | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LatestOutlierSummary.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LatestOutlierSummary.md new file mode 100644 index 000000000..71b00df11 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LatestOutlierSummary.md @@ -0,0 +1,43 @@ +--- +id: v2024-latest-outlier-summary +title: LatestOutlierSummary +pagination_label: LatestOutlierSummary +sidebar_label: LatestOutlierSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LatestOutlierSummary', 'V2024LatestOutlierSummary'] +slug: /tools/sdk/powershell/v2024/models/latest-outlier-summary +tags: ['SDK', 'Software Development Kit', 'LatestOutlierSummary', 'V2024LatestOutlierSummary'] +--- + + +# LatestOutlierSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "LOW_SIMILARITY", "STRUCTURAL" ] | The type of outlier summary | [optional] +**SnapshotDate** | Pointer to **System.DateTime** | The date the bulk outlier detection ran/snapshot was created | [optional] +**TotalOutliers** | Pointer to **Int32** | Total number of outliers for the customer making the request | [optional] +**TotalIdentities** | Pointer to **Int32** | Total number of identities for the customer making the request | [optional] +**TotalIgnored** | Pointer to **Int32** | Total number of ignored outliers | [optional] + +## Examples + +- Prepare the resource +```powershell +$LatestOutlierSummary = Initialize-PSSailpoint.V2024LatestOutlierSummary -Type LOW_SIMILARITY ` + -SnapshotDate 2021-05-01T18:40:35.772Z ` + -TotalOutliers 50 ` + -TotalIdentities 5000 ` + -TotalIgnored 10 +``` + +- Convert the resource to JSON +```powershell +$LatestOutlierSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LeftPad.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LeftPad.md new file mode 100644 index 000000000..a4bc2b427 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LeftPad.md @@ -0,0 +1,41 @@ +--- +id: v2024-left-pad +title: LeftPad +pagination_label: LeftPad +sidebar_label: LeftPad +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LeftPad', 'V2024LeftPad'] +slug: /tools/sdk/powershell/v2024/models/left-pad +tags: ['SDK', 'Software Development Kit', 'LeftPad', 'V2024LeftPad'] +--- + + +# LeftPad + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Length** | **String** | An integer value for the desired length of the final output string | [required] +**Padding** | Pointer to **String** | A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space ("" "") character for padding | [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] + +## Examples + +- Prepare the resource +```powershell +$LeftPad = Initialize-PSSailpoint.V2024LeftPad -Length 4 ` + -Padding 0 ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$LeftPad | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/License.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/License.md new file mode 100644 index 000000000..fa796d6c3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/License.md @@ -0,0 +1,37 @@ +--- +id: v2024-license +title: License +pagination_label: License +sidebar_label: License +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'License', 'V2024License'] +slug: /tools/sdk/powershell/v2024/models/license +tags: ['SDK', 'Software Development Kit', 'License', 'V2024License'] +--- + + +# License + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LicenseId** | Pointer to **String** | Name of the license | [optional] +**LegacyFeatureName** | Pointer to **String** | Legacy name of the license | [optional] + +## Examples + +- Prepare the resource +```powershell +$License = Initialize-PSSailpoint.V2024License -LicenseId idn:access-request ` + -LegacyFeatureName ACCESS_REQUEST +``` + +- Convert the resource to JSON +```powershell +$License | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LifecycleState.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LifecycleState.md new file mode 100644 index 000000000..409dd5039 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LifecycleState.md @@ -0,0 +1,57 @@ +--- +id: v2024-lifecycle-state +title: LifecycleState +pagination_label: LifecycleState +sidebar_label: LifecycleState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LifecycleState', 'V2024LifecycleState'] +slug: /tools/sdk/powershell/v2024/models/lifecycle-state +tags: ['SDK', 'Software Development Kit', 'LifecycleState', 'V2024LifecycleState'] +--- + + +# LifecycleState + +## Properties + +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] +**Enabled** | Pointer to **Boolean** | Indicates whether the lifecycle state is enabled or disabled. | [optional] [default to $false] +**TechnicalName** | **String** | The lifecycle state's technical name. This is for internal use. | [required] +**Description** | Pointer to **String** | Lifecycle state's description. | [optional] +**IdentityCount** | Pointer to **Int32** | Number of identities that have the lifecycle state. | [optional] [readonly] +**EmailNotificationOption** | Pointer to [**EmailNotificationOption**](email-notification-option) | | [optional] +**AccountActions** | Pointer to [**[]AccountAction**](account-action) | | [optional] +**AccessProfileIds** | Pointer to **[]String** | List of unique access-profile IDs that are associated with the lifecycle state. | [optional] +**IdentityState** | Pointer to **String** | The lifecycle state's associated identity state. This field is generally 'null'. | [optional] + +## Examples + +- Prepare the resource +```powershell +$LifecycleState = Initialize-PSSailpoint.V2024LifecycleState -Id id12345 ` + -Name aName ` + -Created 2015-05-28T14:07:17Z ` + -Modified 2015-05-28T14:07:17Z ` + -Enabled true ` + -TechnicalName Technical Name ` + -Description Lifecycle description ` + -IdentityCount 42 ` + -EmailNotificationOption null ` + -AccountActions null ` + -AccessProfileIds [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500] ` + -IdentityState null +``` + +- Convert the resource to JSON +```powershell +$LifecycleState | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LifecycleStateDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LifecycleStateDto.md new file mode 100644 index 000000000..e2e529b4d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LifecycleStateDto.md @@ -0,0 +1,37 @@ +--- +id: v2024-lifecycle-state-dto +title: LifecycleStateDto +pagination_label: LifecycleStateDto +sidebar_label: LifecycleStateDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LifecycleStateDto', 'V2024LifecycleStateDto'] +slug: /tools/sdk/powershell/v2024/models/lifecycle-state-dto +tags: ['SDK', 'Software Development Kit', 'LifecycleStateDto', 'V2024LifecycleStateDto'] +--- + + +# LifecycleStateDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**StateName** | **String** | The name of the lifecycle state | [required] +**ManuallyUpdated** | **Boolean** | Whether the lifecycle state has been manually or automatically set | [required] + +## Examples + +- Prepare the resource +```powershell +$LifecycleStateDto = Initialize-PSSailpoint.V2024LifecycleStateDto -StateName active ` + -ManuallyUpdated true +``` + +- Convert the resource to JSON +```powershell +$LifecycleStateDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LifecyclestateDeleted.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LifecyclestateDeleted.md new file mode 100644 index 000000000..9da865b01 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LifecyclestateDeleted.md @@ -0,0 +1,39 @@ +--- +id: v2024-lifecyclestate-deleted +title: LifecyclestateDeleted +pagination_label: LifecyclestateDeleted +sidebar_label: LifecyclestateDeleted +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LifecyclestateDeleted', 'V2024LifecyclestateDeleted'] +slug: /tools/sdk/powershell/v2024/models/lifecyclestate-deleted +tags: ['SDK', 'Software Development Kit', 'LifecyclestateDeleted', 'V2024LifecyclestateDeleted'] +--- + + +# LifecyclestateDeleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "LIFECYCLE_STATE" ] | Deleted lifecycle state's DTO type. | [optional] +**Id** | Pointer to **String** | Deleted lifecycle state ID. | [optional] +**Name** | Pointer to **String** | Deleted lifecycle state's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$LifecyclestateDeleted = Initialize-PSSailpoint.V2024LifecyclestateDeleted -Type LIFECYCLE_STATE ` + -Id 12345 ` + -Name Contractor Lifecycle +``` + +- Convert the resource to JSON +```powershell +$LifecyclestateDeleted | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListAccessProfiles401Response.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListAccessProfiles401Response.md new file mode 100644 index 000000000..5cca67899 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListAccessProfiles401Response.md @@ -0,0 +1,35 @@ +--- +id: v2024-list-access-profiles401-response +title: ListAccessProfiles401Response +pagination_label: ListAccessProfiles401Response +sidebar_label: ListAccessProfiles401Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ListAccessProfiles401Response', 'V2024ListAccessProfiles401Response'] +slug: /tools/sdk/powershell/v2024/models/list-access-profiles401-response +tags: ['SDK', 'Software Development Kit', 'ListAccessProfiles401Response', 'V2024ListAccessProfiles401Response'] +--- + + +# ListAccessProfiles401Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarError** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A message describing the error | [optional] + +## Examples + +- Prepare the resource +```powershell +$ListAccessProfiles401Response = Initialize-PSSailpoint.V2024ListAccessProfiles401Response -VarError JWT validation failed: JWT is expired +``` + +- Convert the resource to JSON +```powershell +$ListAccessProfiles401Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListAccessProfiles429Response.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListAccessProfiles429Response.md new file mode 100644 index 000000000..1391d1ec0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListAccessProfiles429Response.md @@ -0,0 +1,35 @@ +--- +id: v2024-list-access-profiles429-response +title: ListAccessProfiles429Response +pagination_label: ListAccessProfiles429Response +sidebar_label: ListAccessProfiles429Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ListAccessProfiles429Response', 'V2024ListAccessProfiles429Response'] +slug: /tools/sdk/powershell/v2024/models/list-access-profiles429-response +tags: ['SDK', 'Software Development Kit', 'ListAccessProfiles429Response', 'V2024ListAccessProfiles429Response'] +--- + + +# ListAccessProfiles429Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A message describing the error | [optional] + +## Examples + +- Prepare the resource +```powershell +$ListAccessProfiles429Response = Initialize-PSSailpoint.V2024ListAccessProfiles429Response -Message Rate Limit Exceeded +``` + +- Convert the resource to JSON +```powershell +$ListAccessProfiles429Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListCampaignFilters200Response.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListCampaignFilters200Response.md new file mode 100644 index 000000000..d0940eadf --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListCampaignFilters200Response.md @@ -0,0 +1,37 @@ +--- +id: v2024-list-campaign-filters200-response +title: ListCampaignFilters200Response +pagination_label: ListCampaignFilters200Response +sidebar_label: ListCampaignFilters200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ListCampaignFilters200Response', 'V2024ListCampaignFilters200Response'] +slug: /tools/sdk/powershell/v2024/models/list-campaign-filters200-response +tags: ['SDK', 'Software Development Kit', 'ListCampaignFilters200Response', 'V2024ListCampaignFilters200Response'] +--- + + +# ListCampaignFilters200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Items** | Pointer to [**[]CampaignFilterDetails**](campaign-filter-details) | List of campaign filters. | [optional] +**Count** | Pointer to **Int32** | Number of filters returned. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ListCampaignFilters200Response = Initialize-PSSailpoint.V2024ListCampaignFilters200Response -Items null ` + -Count 2 +``` + +- Convert the resource to JSON +```powershell +$ListCampaignFilters200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListCompleteWorkflowLibrary200ResponseInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListCompleteWorkflowLibrary200ResponseInner.md new file mode 100644 index 000000000..897d0f4f2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListCompleteWorkflowLibrary200ResponseInner.md @@ -0,0 +1,59 @@ +--- +id: v2024-list-complete-workflow-library200-response-inner +title: ListCompleteWorkflowLibrary200ResponseInner +pagination_label: ListCompleteWorkflowLibrary200ResponseInner +sidebar_label: ListCompleteWorkflowLibrary200ResponseInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ListCompleteWorkflowLibrary200ResponseInner', 'V2024ListCompleteWorkflowLibrary200ResponseInner'] +slug: /tools/sdk/powershell/v2024/models/list-complete-workflow-library200-response-inner +tags: ['SDK', 'Software Development Kit', 'ListCompleteWorkflowLibrary200ResponseInner', 'V2024ListCompleteWorkflowLibrary200ResponseInner'] +--- + + +# ListCompleteWorkflowLibrary200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Operator ID. | [optional] +**Name** | Pointer to **String** | Operator friendly name | [optional] +**Type** | Pointer to **String** | Operator type | [optional] +**Description** | Pointer to **String** | Description of the operator | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the operator accepts | [optional] +**ExampleOutput** | Pointer to [**WorkflowLibraryActionExampleOutput**](workflow-library-action-example-output) | | [optional] +**Deprecated** | Pointer to **Boolean** | | [optional] +**DeprecatedBy** | Pointer to **System.DateTime** | | [optional] +**VersionNumber** | Pointer to **Int32** | Version number | [optional] +**IsSimulationEnabled** | Pointer to **Boolean** | | [optional] +**IsDynamicSchema** | Pointer to **Boolean** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**OutputSchema** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Example output schema | [optional] +**InputExample** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Example trigger payload if applicable | [optional] + +## Examples + +- Prepare the resource +```powershell +$ListCompleteWorkflowLibrary200ResponseInner = Initialize-PSSailpoint.V2024ListCompleteWorkflowLibrary200ResponseInner -Id sp:compare-boolean ` + -Name Compare Boolean Values ` + -Type OPERATOR ` + -Description Compare two boolean values and decide what happens based on the result. ` + -FormFields [{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] ` + -ExampleOutput null ` + -Deprecated null ` + -DeprecatedBy null ` + -VersionNumber null ` + -IsSimulationEnabled null ` + -IsDynamicSchema false ` + -OutputSchema null ` + -InputExample {changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} +``` + +- Convert the resource to JSON +```powershell +$ListCompleteWorkflowLibrary200ResponseInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListFormDefinitionsByTenantResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListFormDefinitionsByTenantResponse.md new file mode 100644 index 000000000..d2a4c9fab --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListFormDefinitionsByTenantResponse.md @@ -0,0 +1,37 @@ +--- +id: v2024-list-form-definitions-by-tenant-response +title: ListFormDefinitionsByTenantResponse +pagination_label: ListFormDefinitionsByTenantResponse +sidebar_label: ListFormDefinitionsByTenantResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ListFormDefinitionsByTenantResponse', 'V2024ListFormDefinitionsByTenantResponse'] +slug: /tools/sdk/powershell/v2024/models/list-form-definitions-by-tenant-response +tags: ['SDK', 'Software Development Kit', 'ListFormDefinitionsByTenantResponse', 'V2024ListFormDefinitionsByTenantResponse'] +--- + + +# ListFormDefinitionsByTenantResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | Pointer to **Int64** | Count number of results. | [optional] +**Results** | Pointer to [**[]FormDefinitionResponse**](form-definition-response) | List of FormDefinitionResponse items. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ListFormDefinitionsByTenantResponse = Initialize-PSSailpoint.V2024ListFormDefinitionsByTenantResponse -Count 1 ` + -Results null +``` + +- Convert the resource to JSON +```powershell +$ListFormDefinitionsByTenantResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListFormElementDataByElementIDResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListFormElementDataByElementIDResponse.md new file mode 100644 index 000000000..48efb86f6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListFormElementDataByElementIDResponse.md @@ -0,0 +1,35 @@ +--- +id: v2024-list-form-element-data-by-element-id-response +title: ListFormElementDataByElementIDResponse +pagination_label: ListFormElementDataByElementIDResponse +sidebar_label: ListFormElementDataByElementIDResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ListFormElementDataByElementIDResponse', 'V2024ListFormElementDataByElementIDResponse'] +slug: /tools/sdk/powershell/v2024/models/list-form-element-data-by-element-id-response +tags: ['SDK', 'Software Development Kit', 'ListFormElementDataByElementIDResponse', 'V2024ListFormElementDataByElementIDResponse'] +--- + + +# ListFormElementDataByElementIDResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Results** | Pointer to [**[]FormElementDataSourceConfigOptions**](form-element-data-source-config-options) | Results holds a list of FormElementDataSourceConfigOptions items | [optional] + +## Examples + +- Prepare the resource +```powershell +$ListFormElementDataByElementIDResponse = Initialize-PSSailpoint.V2024ListFormElementDataByElementIDResponse -Results {"results":[{"label":"Alfred 255e71dfc6e","subLabel":"Alfred.255e71dfc6e@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16676"},{"label":"Alize eba9d4cd27da","subLabel":"Alize.eba9d4cd27da@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f1667c"},{"label":"Antonina 01f69c3ea","subLabel":"Antonina.01f69c3ea@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f9667e"},{"label":"Ardella 21e78ce155","subLabel":"Ardella.21e78ce155@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e6667a"},{"label":"Arnaldo d8582b6e17","subLabel":"Arnaldo.d8582b6e17@testmail.identitysoon.com","value":"2c918084821847c5018227ced3426686"},{"label":"Aurelia admin24828","subLabel":"Aurelia.admin24828@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16674"},{"label":"Barbara 72ca418fdd","subLabel":"Barbara.72ca418fdd@testmail.identitysoon.com","value":"2c918084821847c5018227ced2fb6680"},{"label":"Barbara ee1a2436ee","subLabel":"Barbara.ee1a2436ee@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e56678"},{"label":"Baylee 652d72432f3","subLabel":"Baylee.652d72432f3@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aee"},{"label":"Brock e76b56ae4d49","subLabel":"Brock.e76b56ae4d49@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aef"}]} +``` + +- Convert the resource to JSON +```powershell +$ListFormElementDataByElementIDResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListFormInstancesByTenantResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListFormInstancesByTenantResponse.md new file mode 100644 index 000000000..04fa4980a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListFormInstancesByTenantResponse.md @@ -0,0 +1,37 @@ +--- +id: v2024-list-form-instances-by-tenant-response +title: ListFormInstancesByTenantResponse +pagination_label: ListFormInstancesByTenantResponse +sidebar_label: ListFormInstancesByTenantResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ListFormInstancesByTenantResponse', 'V2024ListFormInstancesByTenantResponse'] +slug: /tools/sdk/powershell/v2024/models/list-form-instances-by-tenant-response +tags: ['SDK', 'Software Development Kit', 'ListFormInstancesByTenantResponse', 'V2024ListFormInstancesByTenantResponse'] +--- + + +# ListFormInstancesByTenantResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | Pointer to **Int64** | Count number of Results | [optional] +**Results** | Pointer to [**[]FormInstanceResponse**](form-instance-response) | Results holds a list of FormInstanceResponse items | [optional] + +## Examples + +- Prepare the resource +```powershell +$ListFormInstancesByTenantResponse = Initialize-PSSailpoint.V2024ListFormInstancesByTenantResponse -Count 1 ` + -Results null +``` + +- Convert the resource to JSON +```powershell +$ListFormInstancesByTenantResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListIdentityAccessItems200ResponseInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListIdentityAccessItems200ResponseInner.md new file mode 100644 index 000000000..129ffe863 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListIdentityAccessItems200ResponseInner.md @@ -0,0 +1,71 @@ +--- +id: v2024-list-identity-access-items200-response-inner +title: ListIdentityAccessItems200ResponseInner +pagination_label: ListIdentityAccessItems200ResponseInner +sidebar_label: ListIdentityAccessItems200ResponseInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ListIdentityAccessItems200ResponseInner', 'V2024ListIdentityAccessItems200ResponseInner'] +slug: /tools/sdk/powershell/v2024/models/list-identity-access-items200-response-inner +tags: ['SDK', 'Software Development Kit', 'ListIdentityAccessItems200ResponseInner', 'V2024ListIdentityAccessItems200ResponseInner'] +--- + + +# ListIdentityAccessItems200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessType** | Pointer to **String** | the access item type. role in this case | [optional] +**Id** | Pointer to **String** | the access item id | [optional] +**Name** | Pointer to **String** | the access profile name | [optional] +**SourceName** | Pointer to **String** | the associated source name if it exists | [optional] +**SourceId** | Pointer to **String** | the id of the source | [optional] +**Description** | Pointer to **String** | the description for the role | [optional] +**DisplayName** | Pointer to **String** | the role display name | [optional] +**EntitlementCount** | Pointer to **String** | the number of entitlements the account will create | [optional] +**AppDisplayName** | Pointer to **String** | the name of | [optional] +**RemoveDate** | Pointer to **String** | the date the role is no longer assigned to the specified identity | [optional] +**Standalone** | **Boolean** | indicates whether the entitlement is standalone | [required] +**Revocable** | **Boolean** | indicates whether the role is revocable | [required] +**NativeIdentity** | Pointer to **String** | the native identifier used to uniquely identify an acccount | [optional] +**AppRoleId** | Pointer to **String** | the app role id | [optional] +**Attribute** | Pointer to **String** | the entitlement attribute | [optional] +**Value** | Pointer to **String** | the associated value | [optional] +**EntitlementType** | Pointer to **String** | the type of entitlement | [optional] +**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required] +**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required] + +## Examples + +- Prepare the resource +```powershell +$ListIdentityAccessItems200ResponseInner = Initialize-PSSailpoint.V2024ListIdentityAccessItems200ResponseInner -AccessType role ` + -Id 2c918087763e69d901763e72e97f006f ` + -Name sample ` + -SourceName Source Name ` + -SourceId 2793o32dwd ` + -Description Role - Workday/Citizenship access ` + -DisplayName sample ` + -EntitlementCount 12 ` + -AppDisplayName AppName ` + -RemoveDate 2024-07-01T06:00:00.00Z ` + -Standalone true ` + -Revocable true ` + -NativeIdentity dr.arden.ogahn.d ` + -AppRoleId 2c918087763e69d901763e72e97f006f ` + -Attribute groups ` + -Value Upward mobility access ` + -EntitlementType entitlement ` + -Privileged false ` + -CloudGoverned true +``` + +- Convert the resource to JSON +```powershell +$ListIdentityAccessItems200ResponseInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListPredefinedSelectOptionsResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListPredefinedSelectOptionsResponse.md new file mode 100644 index 000000000..429460c19 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListPredefinedSelectOptionsResponse.md @@ -0,0 +1,35 @@ +--- +id: v2024-list-predefined-select-options-response +title: ListPredefinedSelectOptionsResponse +pagination_label: ListPredefinedSelectOptionsResponse +sidebar_label: ListPredefinedSelectOptionsResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ListPredefinedSelectOptionsResponse', 'V2024ListPredefinedSelectOptionsResponse'] +slug: /tools/sdk/powershell/v2024/models/list-predefined-select-options-response +tags: ['SDK', 'Software Development Kit', 'ListPredefinedSelectOptionsResponse', 'V2024ListPredefinedSelectOptionsResponse'] +--- + + +# ListPredefinedSelectOptionsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Results** | Pointer to **[]String** | Results holds a list of PreDefinedSelectOption items | [optional] + +## Examples + +- Prepare the resource +```powershell +$ListPredefinedSelectOptionsResponse = Initialize-PSSailpoint.V2024ListPredefinedSelectOptionsResponse -Results null +``` + +- Convert the resource to JSON +```powershell +$ListPredefinedSelectOptionsResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListWorkgroupMembers200ResponseInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListWorkgroupMembers200ResponseInner.md new file mode 100644 index 000000000..eef896837 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ListWorkgroupMembers200ResponseInner.md @@ -0,0 +1,41 @@ +--- +id: v2024-list-workgroup-members200-response-inner +title: ListWorkgroupMembers200ResponseInner +pagination_label: ListWorkgroupMembers200ResponseInner +sidebar_label: ListWorkgroupMembers200ResponseInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ListWorkgroupMembers200ResponseInner', 'V2024ListWorkgroupMembers200ResponseInner'] +slug: /tools/sdk/powershell/v2024/models/list-workgroup-members200-response-inner +tags: ['SDK', 'Software Development Kit', 'ListWorkgroupMembers200ResponseInner', 'V2024ListWorkgroupMembers200ResponseInner'] +--- + + +# ListWorkgroupMembers200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Workgroup member identity DTO type. | [optional] +**Id** | Pointer to **String** | Workgroup member identity ID. | [optional] +**Name** | Pointer to **String** | Workgroup member identity display name. | [optional] +**Email** | Pointer to **String** | Workgroup member identity email. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ListWorkgroupMembers200ResponseInner = Initialize-PSSailpoint.V2024ListWorkgroupMembers200ResponseInner -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels ` + -Email michael.michaels@sailpoint.com +``` + +- Convert the resource to JSON +```powershell +$ListWorkgroupMembers200ResponseInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadAccountsTask.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadAccountsTask.md new file mode 100644 index 000000000..6716b812c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadAccountsTask.md @@ -0,0 +1,37 @@ +--- +id: v2024-load-accounts-task +title: LoadAccountsTask +pagination_label: LoadAccountsTask +sidebar_label: LoadAccountsTask +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LoadAccountsTask', 'V2024LoadAccountsTask'] +slug: /tools/sdk/powershell/v2024/models/load-accounts-task +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTask', 'V2024LoadAccountsTask'] +--- + + +# LoadAccountsTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Success** | Pointer to **Boolean** | The status of the result | [optional] [default to $true] +**Task** | Pointer to [**LoadAccountsTaskTask**](load-accounts-task-task) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$LoadAccountsTask = Initialize-PSSailpoint.V2024LoadAccountsTask -Success true ` + -Task null +``` + +- Convert the resource to JSON +```powershell +$LoadAccountsTask | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadAccountsTaskTask.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadAccountsTaskTask.md new file mode 100644 index 000000000..7ae49fc86 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadAccountsTaskTask.md @@ -0,0 +1,61 @@ +--- +id: v2024-load-accounts-task-task +title: LoadAccountsTaskTask +pagination_label: LoadAccountsTaskTask +sidebar_label: LoadAccountsTaskTask +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LoadAccountsTaskTask', 'V2024LoadAccountsTaskTask'] +slug: /tools/sdk/powershell/v2024/models/load-accounts-task-task +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTask', 'V2024LoadAccountsTaskTask'] +--- + + +# LoadAccountsTaskTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | System-generated unique ID of the task this taskStatus represents | [optional] +**Type** | Pointer to **String** | Type of task this task represents | [optional] +**Name** | Pointer to **String** | The name of the aggregation process | [optional] +**Description** | Pointer to **String** | The description of the task | [optional] +**Launcher** | Pointer to **String** | The user who initiated the task | [optional] +**Created** | Pointer to **System.DateTime** | The Task creation date | [optional] +**Launched** | Pointer to **System.DateTime** | The task start date | [optional] +**Completed** | Pointer to **System.DateTime** | The task completion date | [optional] +**CompletionStatus** | Pointer to **Enum** [ "SUCCESS", "WARNING", "ERROR", "TERMINATED", "TEMP_ERROR" ] | Task completion status. | [optional] +**ParentName** | Pointer to **String** | Name of the parent task if exists. | [optional] +**Messages** | Pointer to [**[]LoadAccountsTaskTaskMessagesInner**](load-accounts-task-task-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional] +**Progress** | Pointer to **String** | Current task state. | [optional] +**Attributes** | Pointer to [**LoadAccountsTaskTaskAttributes**](load-accounts-task-task-attributes) | | [optional] +**Returns** | Pointer to [**[]LoadAccountsTaskTaskReturnsInner**](load-accounts-task-task-returns-inner) | Return values from the task | [optional] + +## Examples + +- Prepare the resource +```powershell +$LoadAccountsTaskTask = Initialize-PSSailpoint.V2024LoadAccountsTaskTask -Id ef38f94347e94562b5bb8424a56397d8 ` + -Type QUARTZ ` + -Name Cloud Account Aggregation ` + -Description Aggregate from the specified application ` + -Launcher John Doe ` + -Created null ` + -Launched null ` + -Completed null ` + -CompletionStatus Success ` + -ParentName Audit Report ` + -Messages [] ` + -Progress Initializing... ` + -Attributes null ` + -Returns null +``` + +- Convert the resource to JSON +```powershell +$LoadAccountsTaskTask | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadAccountsTaskTaskAttributes.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadAccountsTaskTaskAttributes.md new file mode 100644 index 000000000..1d4338bbd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadAccountsTaskTaskAttributes.md @@ -0,0 +1,37 @@ +--- +id: v2024-load-accounts-task-task-attributes +title: LoadAccountsTaskTaskAttributes +pagination_label: LoadAccountsTaskTaskAttributes +sidebar_label: LoadAccountsTaskTaskAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LoadAccountsTaskTaskAttributes', 'V2024LoadAccountsTaskTaskAttributes'] +slug: /tools/sdk/powershell/v2024/models/load-accounts-task-task-attributes +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTaskAttributes', 'V2024LoadAccountsTaskTaskAttributes'] +--- + + +# LoadAccountsTaskTaskAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AppId** | Pointer to **String** | The id of the source | [optional] +**OptimizedAggregation** | Pointer to **String** | The indicator if the aggregation process was enabled/disabled for the aggregation job | [optional] + +## Examples + +- Prepare the resource +```powershell +$LoadAccountsTaskTaskAttributes = Initialize-PSSailpoint.V2024LoadAccountsTaskTaskAttributes -AppId c31386cb18bb403cbb6df4c86294ff82 ` + -OptimizedAggregation enabled +``` + +- Convert the resource to JSON +```powershell +$LoadAccountsTaskTaskAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadAccountsTaskTaskMessagesInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadAccountsTaskTaskMessagesInner.md new file mode 100644 index 000000000..953d5eabb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadAccountsTaskTaskMessagesInner.md @@ -0,0 +1,43 @@ +--- +id: v2024-load-accounts-task-task-messages-inner +title: LoadAccountsTaskTaskMessagesInner +pagination_label: LoadAccountsTaskTaskMessagesInner +sidebar_label: LoadAccountsTaskTaskMessagesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LoadAccountsTaskTaskMessagesInner', 'V2024LoadAccountsTaskTaskMessagesInner'] +slug: /tools/sdk/powershell/v2024/models/load-accounts-task-task-messages-inner +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTaskMessagesInner', 'V2024LoadAccountsTaskTaskMessagesInner'] +--- + + +# LoadAccountsTaskTaskMessagesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "INFO", "WARN", "ERROR" ] | Type of the message. | [optional] +**VarError** | Pointer to **Boolean** | Flag whether message is an error. | [optional] [default to $false] +**Warning** | Pointer to **Boolean** | Flag whether message is a warning. | [optional] [default to $false] +**Key** | Pointer to **String** | Message string identifier. | [optional] +**LocalizedText** | Pointer to **String** | Message context with the locale based language. | [optional] + +## Examples + +- Prepare the resource +```powershell +$LoadAccountsTaskTaskMessagesInner = Initialize-PSSailpoint.V2024LoadAccountsTaskTaskMessagesInner -Type WARN ` + -VarError false ` + -Warning true ` + -Key This aggregation failed because the currently running aggregation must complete before the next one can start. ` + -LocalizedText This aggregation failed because the currently running aggregation must complete before the next one can start. +``` + +- Convert the resource to JSON +```powershell +$LoadAccountsTaskTaskMessagesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadAccountsTaskTaskReturnsInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadAccountsTaskTaskReturnsInner.md new file mode 100644 index 000000000..77193942c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadAccountsTaskTaskReturnsInner.md @@ -0,0 +1,37 @@ +--- +id: v2024-load-accounts-task-task-returns-inner +title: LoadAccountsTaskTaskReturnsInner +pagination_label: LoadAccountsTaskTaskReturnsInner +sidebar_label: LoadAccountsTaskTaskReturnsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LoadAccountsTaskTaskReturnsInner', 'V2024LoadAccountsTaskTaskReturnsInner'] +slug: /tools/sdk/powershell/v2024/models/load-accounts-task-task-returns-inner +tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTaskReturnsInner', 'V2024LoadAccountsTaskTaskReturnsInner'] +--- + + +# LoadAccountsTaskTaskReturnsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayLabel** | Pointer to **String** | The display label of the return value | [optional] +**AttributeName** | Pointer to **String** | The attribute name of the return value | [optional] + +## Examples + +- Prepare the resource +```powershell +$LoadAccountsTaskTaskReturnsInner = Initialize-PSSailpoint.V2024LoadAccountsTaskTaskReturnsInner -DisplayLabel TASK_OUT_ACCOUNT_AGGREGATION_APPLICATIONS ` + -AttributeName applications +``` + +- Convert the resource to JSON +```powershell +$LoadAccountsTaskTaskReturnsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadEntitlementTask.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadEntitlementTask.md new file mode 100644 index 000000000..ca8ad7852 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadEntitlementTask.md @@ -0,0 +1,47 @@ +--- +id: v2024-load-entitlement-task +title: LoadEntitlementTask +pagination_label: LoadEntitlementTask +sidebar_label: LoadEntitlementTask +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LoadEntitlementTask', 'V2024LoadEntitlementTask'] +slug: /tools/sdk/powershell/v2024/models/load-entitlement-task +tags: ['SDK', 'Software Development Kit', 'LoadEntitlementTask', 'V2024LoadEntitlementTask'] +--- + + +# LoadEntitlementTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | System-generated unique ID of the task this taskStatus represents | [optional] +**Type** | Pointer to **String** | Type of task this task represents | [optional] +**UniqueName** | Pointer to **String** | The name of the task | [optional] +**Description** | Pointer to **String** | The description of the task | [optional] +**Launcher** | Pointer to **String** | The user who initiated the task | [optional] +**Created** | Pointer to **System.DateTime** | The creation date of the task | [optional] +**Returns** | Pointer to [**[]LoadEntitlementTaskReturnsInner**](load-entitlement-task-returns-inner) | Return values from the task | [optional] + +## Examples + +- Prepare the resource +```powershell +$LoadEntitlementTask = Initialize-PSSailpoint.V2024LoadEntitlementTask -Id ef38f94347e94562b5bb8424a56397d8 ` + -Type QUARTZ ` + -UniqueName Cloud Group Aggregation ` + -Description Aggregate from the specified application ` + -Launcher John Doe ` + -Created 2020-07-11T21:23:15Z ` + -Returns [{displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_APPLICATIONS, attributeName=applications}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_TOTAL, attributeName=total}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_CREATED, attributeName=groupsCreated}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_UPDATED, attributeName=groupsUpdated}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_DELETED, attributeName=groupsDeleted}] +``` + +- Convert the resource to JSON +```powershell +$LoadEntitlementTask | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadEntitlementTaskReturnsInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadEntitlementTaskReturnsInner.md new file mode 100644 index 000000000..2cca6ad5f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadEntitlementTaskReturnsInner.md @@ -0,0 +1,37 @@ +--- +id: v2024-load-entitlement-task-returns-inner +title: LoadEntitlementTaskReturnsInner +pagination_label: LoadEntitlementTaskReturnsInner +sidebar_label: LoadEntitlementTaskReturnsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LoadEntitlementTaskReturnsInner', 'V2024LoadEntitlementTaskReturnsInner'] +slug: /tools/sdk/powershell/v2024/models/load-entitlement-task-returns-inner +tags: ['SDK', 'Software Development Kit', 'LoadEntitlementTaskReturnsInner', 'V2024LoadEntitlementTaskReturnsInner'] +--- + + +# LoadEntitlementTaskReturnsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayLabel** | Pointer to **String** | The display label for the return value | [optional] +**AttributeName** | Pointer to **String** | The attribute name for the return value | [optional] + +## Examples + +- Prepare the resource +```powershell +$LoadEntitlementTaskReturnsInner = Initialize-PSSailpoint.V2024LoadEntitlementTaskReturnsInner -DisplayLabel TASK_OUT_ACCOUNT_GROUP_AGGREGATION_APPLICATIONS ` + -AttributeName applications +``` + +- Convert the resource to JSON +```powershell +$LoadEntitlementTaskReturnsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadUncorrelatedAccountsTask.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadUncorrelatedAccountsTask.md new file mode 100644 index 000000000..a874f5572 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadUncorrelatedAccountsTask.md @@ -0,0 +1,37 @@ +--- +id: v2024-load-uncorrelated-accounts-task +title: LoadUncorrelatedAccountsTask +pagination_label: LoadUncorrelatedAccountsTask +sidebar_label: LoadUncorrelatedAccountsTask +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LoadUncorrelatedAccountsTask', 'V2024LoadUncorrelatedAccountsTask'] +slug: /tools/sdk/powershell/v2024/models/load-uncorrelated-accounts-task +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTask', 'V2024LoadUncorrelatedAccountsTask'] +--- + + +# LoadUncorrelatedAccountsTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Success** | Pointer to **Boolean** | The status of the result | [optional] [default to $true] +**Task** | Pointer to [**LoadUncorrelatedAccountsTaskTask**](load-uncorrelated-accounts-task-task) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$LoadUncorrelatedAccountsTask = Initialize-PSSailpoint.V2024LoadUncorrelatedAccountsTask -Success true ` + -Task null +``` + +- Convert the resource to JSON +```powershell +$LoadUncorrelatedAccountsTask | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadUncorrelatedAccountsTaskTask.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadUncorrelatedAccountsTaskTask.md new file mode 100644 index 000000000..5f54baa9b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadUncorrelatedAccountsTaskTask.md @@ -0,0 +1,61 @@ +--- +id: v2024-load-uncorrelated-accounts-task-task +title: LoadUncorrelatedAccountsTaskTask +pagination_label: LoadUncorrelatedAccountsTaskTask +sidebar_label: LoadUncorrelatedAccountsTaskTask +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LoadUncorrelatedAccountsTaskTask', 'V2024LoadUncorrelatedAccountsTaskTask'] +slug: /tools/sdk/powershell/v2024/models/load-uncorrelated-accounts-task-task +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTaskTask', 'V2024LoadUncorrelatedAccountsTaskTask'] +--- + + +# LoadUncorrelatedAccountsTaskTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | System-generated unique ID of the task this taskStatus represents | [optional] +**Type** | Pointer to **String** | Type of task this task represents | [optional] +**Name** | Pointer to **String** | The name of uncorrelated accounts process | [optional] +**Description** | Pointer to **String** | The description of the task | [optional] +**Launcher** | Pointer to **String** | The user who initiated the task | [optional] +**Created** | Pointer to **System.DateTime** | The Task creation date | [optional] +**Launched** | Pointer to **System.DateTime** | The task start date | [optional] +**Completed** | Pointer to **System.DateTime** | The task completion date | [optional] +**CompletionStatus** | Pointer to **Enum** [ "SUCCESS", "WARNING", "ERROR", "TERMINATED", "TEMP_ERROR" ] | Task completion status. | [optional] +**ParentName** | Pointer to **String** | Name of the parent task if exists. | [optional] +**Messages** | Pointer to [**[]LoadUncorrelatedAccountsTaskTaskMessagesInner**](load-uncorrelated-accounts-task-task-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional] +**Progress** | Pointer to **String** | Current task state. | [optional] +**Attributes** | Pointer to [**LoadUncorrelatedAccountsTaskTaskAttributes**](load-uncorrelated-accounts-task-task-attributes) | | [optional] +**Returns** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Return values from the task | [optional] + +## Examples + +- Prepare the resource +```powershell +$LoadUncorrelatedAccountsTaskTask = Initialize-PSSailpoint.V2024LoadUncorrelatedAccountsTaskTask -Id 90b83a6bb737489494794f84cd3a51e6 ` + -Type QUARTZ ` + -Name Cloud Process Uncorrelated Accounts ` + -Description Processes uncorrelated accounts for the specified application. ` + -Launcher John Doe ` + -Created null ` + -Launched null ` + -Completed null ` + -CompletionStatus Success ` + -ParentName Audit Report ` + -Messages [] ` + -Progress Initializing... ` + -Attributes null ` + -Returns [{displayLabel=TASK_OUT_ACCOUNT_CORRELATION_APPLICATIONS, attributeName=applications}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_TOTAL, attributeName=total}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_IGNORED, attributeName=correlationFailures}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_FAILURES, attributeName=ignored}, {displayLabel=TASK_OUT_UNCHANGED_ACCOUNTS, attributeName=optimized}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION__CREATED, attributeName=created}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_UPDATED, attributeName=updated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_DELETED, attributeName=deleted}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGER_CHANGES, attributeName=managerChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_BUSINESS_ROLE_CHANGES, attributeName=detectedRoleChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_EXCEPTION_CHANGES, attributeName=exceptionChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICIES, attributeName=policies}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICY_VIOLATIONS, attributeName=policyViolations}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICY_NOTIFICATIONS, attributeName=policyNotifications}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCORES_CHANGED, attributeName=scoresChanged}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SNAPSHOTS_CREATED, attributeName=snapshotsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_CREATED, attributeName=scopesCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_CORRELATED, attributeName=scopesCorrelated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_SELECTED, attributeName=scopesSelected}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_DORMANT, attributeName=scopesDormant}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_UNSCOPED_IDENTITIES, attributeName=unscopedIdentities}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_CERTIFICATIONS_CREATED, attributeName=certificationsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_CERTIFICATIONS_DELETED, attributeName=certificationsDeleted}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_APPLICATIONS_GENERATED, attributeName=applicationsGenerated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGED_ATTRIBUTES_PROMOTED, attributeName=managedAttributesCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGED_ATTRIBUTES_PROMOTED_BY_APP, attributeName=managedAttributesCreatedByApplication}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_IDENTITYENTITLEMENTS_CREATED, attributeName=identityEntitlementsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_GROUPS_CREATED, attributeName=groupsCreated}] +``` + +- Convert the resource to JSON +```powershell +$LoadUncorrelatedAccountsTaskTask | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadUncorrelatedAccountsTaskTaskAttributes.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadUncorrelatedAccountsTaskTaskAttributes.md new file mode 100644 index 000000000..37780cc44 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadUncorrelatedAccountsTaskTaskAttributes.md @@ -0,0 +1,37 @@ +--- +id: v2024-load-uncorrelated-accounts-task-task-attributes +title: LoadUncorrelatedAccountsTaskTaskAttributes +pagination_label: LoadUncorrelatedAccountsTaskTaskAttributes +sidebar_label: LoadUncorrelatedAccountsTaskTaskAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LoadUncorrelatedAccountsTaskTaskAttributes', 'V2024LoadUncorrelatedAccountsTaskTaskAttributes'] +slug: /tools/sdk/powershell/v2024/models/load-uncorrelated-accounts-task-task-attributes +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTaskTaskAttributes', 'V2024LoadUncorrelatedAccountsTaskTaskAttributes'] +--- + + +# LoadUncorrelatedAccountsTaskTaskAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**QpocJobId** | Pointer to **String** | The id of qpoc job | [optional] +**TaskStartDelay** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | the task start delay value | [optional] + +## Examples + +- Prepare the resource +```powershell +$LoadUncorrelatedAccountsTaskTaskAttributes = Initialize-PSSailpoint.V2024LoadUncorrelatedAccountsTaskTaskAttributes -QpocJobId 5d303d46-fc51-48cd-9c6d-4e211e3ab63c ` + -TaskStartDelay +``` + +- Convert the resource to JSON +```powershell +$LoadUncorrelatedAccountsTaskTaskAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadUncorrelatedAccountsTaskTaskMessagesInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadUncorrelatedAccountsTaskTaskMessagesInner.md new file mode 100644 index 000000000..945435c39 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LoadUncorrelatedAccountsTaskTaskMessagesInner.md @@ -0,0 +1,43 @@ +--- +id: v2024-load-uncorrelated-accounts-task-task-messages-inner +title: LoadUncorrelatedAccountsTaskTaskMessagesInner +pagination_label: LoadUncorrelatedAccountsTaskTaskMessagesInner +sidebar_label: LoadUncorrelatedAccountsTaskTaskMessagesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LoadUncorrelatedAccountsTaskTaskMessagesInner', 'V2024LoadUncorrelatedAccountsTaskTaskMessagesInner'] +slug: /tools/sdk/powershell/v2024/models/load-uncorrelated-accounts-task-task-messages-inner +tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTaskTaskMessagesInner', 'V2024LoadUncorrelatedAccountsTaskTaskMessagesInner'] +--- + + +# LoadUncorrelatedAccountsTaskTaskMessagesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "INFO", "WARN", "ERROR" ] | Type of the message. | [optional] +**VarError** | Pointer to **Boolean** | Flag whether message is an error. | [optional] [default to $false] +**Warning** | Pointer to **Boolean** | Flag whether message is a warning. | [optional] [default to $false] +**Key** | Pointer to **String** | Message string identifier. | [optional] +**LocalizedText** | Pointer to **String** | Message context with the locale based language. | [optional] + +## Examples + +- Prepare the resource +```powershell +$LoadUncorrelatedAccountsTaskTaskMessagesInner = Initialize-PSSailpoint.V2024LoadUncorrelatedAccountsTaskTaskMessagesInner -Type WARN ` + -VarError false ` + -Warning true ` + -Key This correlation failed because the currently running correlation must complete before the next one can start. ` + -LocalizedText This correlation failed because the currently running correlation must complete before the next one can start. +``` + +- Convert the resource to JSON +```powershell +$LoadUncorrelatedAccountsTaskTaskMessagesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LocaleOrigin.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LocaleOrigin.md new file mode 100644 index 000000000..69e5510b4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LocaleOrigin.md @@ -0,0 +1,24 @@ +--- +id: v2024-locale-origin +title: LocaleOrigin +pagination_label: LocaleOrigin +sidebar_label: LocaleOrigin +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LocaleOrigin', 'V2024LocaleOrigin'] +slug: /tools/sdk/powershell/v2024/models/locale-origin +tags: ['SDK', 'Software Development Kit', 'LocaleOrigin', 'V2024LocaleOrigin'] +--- + + +# LocaleOrigin + +## Enum + + +* `DEFAULT` (value: `"DEFAULT"`) + +* `REQUEST` (value: `"REQUEST"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LocalizedMessage.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LocalizedMessage.md new file mode 100644 index 000000000..b96473377 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LocalizedMessage.md @@ -0,0 +1,37 @@ +--- +id: v2024-localized-message +title: LocalizedMessage +pagination_label: LocalizedMessage +sidebar_label: LocalizedMessage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LocalizedMessage', 'V2024LocalizedMessage'] +slug: /tools/sdk/powershell/v2024/models/localized-message +tags: ['SDK', 'Software Development Kit', 'LocalizedMessage', 'V2024LocalizedMessage'] +--- + + +# LocalizedMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Locale** | **String** | Message locale | [required] +**Message** | **String** | Message text | [required] + +## Examples + +- Prepare the resource +```powershell +$LocalizedMessage = Initialize-PSSailpoint.V2024LocalizedMessage -Locale An error has occurred! ` + -Message Error has occurred! +``` + +- Convert the resource to JSON +```powershell +$LocalizedMessage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Lookup.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Lookup.md new file mode 100644 index 000000000..8c57c200a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Lookup.md @@ -0,0 +1,39 @@ +--- +id: v2024-lookup +title: Lookup +pagination_label: Lookup +sidebar_label: Lookup +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Lookup', 'V2024Lookup'] +slug: /tools/sdk/powershell/v2024/models/lookup +tags: ['SDK', 'Software Development Kit', 'Lookup', 'V2024Lookup'] +--- + + +# Lookup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Table** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return ""Unknown Region"" for the attribute that is mapped to this transform. | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$Lookup = Initialize-PSSailpoint.V2024Lookup -Table {USA=Americas, FRA=EMEA, AUS=APAC, default=Unknown Region} ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Lookup | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LookupStep.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LookupStep.md new file mode 100644 index 000000000..deb534b45 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/LookupStep.md @@ -0,0 +1,39 @@ +--- +id: v2024-lookup-step +title: LookupStep +pagination_label: LookupStep +sidebar_label: LookupStep +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LookupStep', 'V2024LookupStep'] +slug: /tools/sdk/powershell/v2024/models/lookup-step +tags: ['SDK', 'Software Development Kit', 'LookupStep', 'V2024LookupStep'] +--- + + +# LookupStep + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReassignedToId** | Pointer to **String** | The ID of the Identity who work is reassigned to | [optional] +**ReassignedFromId** | Pointer to **String** | The ID of the Identity who work is reassigned from | [optional] +**ReassignmentType** | Pointer to [**ReassignmentTypeEnum**](reassignment-type-enum) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$LookupStep = Initialize-PSSailpoint.V2024LookupStep -ReassignedToId 869320b6b6f34a169b6178b1a865e66f ` + -ReassignedFromId 51948a8f306a4e7a9a6f8f5d032fa59e ` + -ReassignmentType null +``` + +- Convert the resource to JSON +```powershell +$LookupStep | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Lower.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Lower.md new file mode 100644 index 000000000..198b5a8c8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Lower.md @@ -0,0 +1,37 @@ +--- +id: v2024-lower +title: Lower +pagination_label: Lower +sidebar_label: Lower +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Lower', 'V2024Lower'] +slug: /tools/sdk/powershell/v2024/models/lower +tags: ['SDK', 'Software Development Kit', 'Lower', 'V2024Lower'] +--- + + +# Lower + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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] + +## Examples + +- Prepare the resource +```powershell +$Lower = Initialize-PSSailpoint.V2024Lower -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Lower | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MailFromAttributes.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MailFromAttributes.md new file mode 100644 index 000000000..3f60e79a2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MailFromAttributes.md @@ -0,0 +1,43 @@ +--- +id: v2024-mail-from-attributes +title: MailFromAttributes +pagination_label: MailFromAttributes +sidebar_label: MailFromAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MailFromAttributes', 'V2024MailFromAttributes'] +slug: /tools/sdk/powershell/v2024/models/mail-from-attributes +tags: ['SDK', 'Software Development Kit', 'MailFromAttributes', 'V2024MailFromAttributes'] +--- + + +# MailFromAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to **String** | The email identity | [optional] +**MailFromDomain** | Pointer to **String** | The name of a domain that an email identity uses as a custom MAIL FROM domain | [optional] +**MxRecord** | Pointer to **String** | MX record that is required in customer's DNS to allow the domain to receive bounce and complaint notifications that email providers send you | [optional] +**TxtRecord** | Pointer to **String** | TXT record that is required in customer's DNS in order to prove that Amazon SES is authorized to send email from your domain | [optional] +**MailFromDomainStatus** | Pointer to **Enum** [ "PENDING", "SUCCESS", "FAILED" ] | The current status of the MAIL FROM verification | [optional] + +## Examples + +- Prepare the resource +```powershell +$MailFromAttributes = Initialize-PSSailpoint.V2024MailFromAttributes -Identity bob.smith@sailpoint.com ` + -MailFromDomain foo.sailpoint.com ` + -MxRecord 10 feedback-smtp.us-east-1.amazonses.com ` + -TxtRecord v=spf1 include:amazonses.com ~all ` + -MailFromDomainStatus PENDING +``` + +- Convert the resource to JSON +```powershell +$MailFromAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MailFromAttributesDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MailFromAttributesDto.md new file mode 100644 index 000000000..6f4ea9266 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MailFromAttributesDto.md @@ -0,0 +1,37 @@ +--- +id: v2024-mail-from-attributes-dto +title: MailFromAttributesDto +pagination_label: MailFromAttributesDto +sidebar_label: MailFromAttributesDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MailFromAttributesDto', 'V2024MailFromAttributesDto'] +slug: /tools/sdk/powershell/v2024/models/mail-from-attributes-dto +tags: ['SDK', 'Software Development Kit', 'MailFromAttributesDto', 'V2024MailFromAttributesDto'] +--- + + +# MailFromAttributesDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to **String** | The identity or domain address | [optional] +**MailFromDomain** | Pointer to **String** | The new MAIL FROM domain of the identity. Must be a subdomain of the identity. | [optional] + +## Examples + +- Prepare the resource +```powershell +$MailFromAttributesDto = Initialize-PSSailpoint.V2024MailFromAttributesDto -Identity BobSmith@sailpoint.com ` + -MailFromDomain example.sailpoint.com +``` + +- Convert the resource to JSON +```powershell +$MailFromAttributesDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClient.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClient.md new file mode 100644 index 000000000..dfaec8d3d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClient.md @@ -0,0 +1,75 @@ +--- +id: v2024-managed-client +title: ManagedClient +pagination_label: ManagedClient +sidebar_label: ManagedClient +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClient', 'V2024ManagedClient'] +slug: /tools/sdk/powershell/v2024/models/managed-client +tags: ['SDK', 'Software Development Kit', 'ManagedClient', 'V2024ManagedClient'] +--- + + +# ManagedClient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ManagedClient ID | [optional] [readonly] +**AlertKey** | Pointer to **String** | ManagedClient alert key | [optional] [readonly] +**ApiGatewayBaseUrl** | Pointer to **String** | | [optional] +**Cookbook** | Pointer to **String** | | [optional] +**CcId** | Pointer to **Int64** | Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) | [optional] +**ClientId** | **String** | The client ID used in API management | [required] +**ClusterId** | **String** | Cluster ID that the ManagedClient is linked to | [required] +**Description** | **String** | ManagedClient description | [required][default to ""] +**IpAddress** | Pointer to **String** | The public IP address of the ManagedClient | [optional] [readonly] +**LastSeen** | Pointer to **System.DateTime** | When the ManagedClient was last seen by the server | [optional] [readonly] +**Name** | Pointer to **String** | ManagedClient name | [optional] [default to "VA-$clientId"] +**SinceLastSeen** | Pointer to **String** | Milliseconds since the ManagedClient has polled the server | [optional] [readonly] +**Status** | Pointer to **Enum** [ "NORMAL", "UNDEFINED", "NOT_CONFIGURED", "CONFIGURING", "WARNING", "ERROR", "FAILED" ] | Status of the ManagedClient | [optional] [readonly] +**Type** | **String** | Type of the ManagedClient (VA, CCG) | [required] +**ClusterType** | Pointer to **Enum** [ "idn", "iai", "spConnectCluster", "sqsCluster", "das-rc", "das-pc", "das-dc" ] | Cluster Type of the ManagedClient | [optional] [readonly] +**VaDownloadUrl** | Pointer to **String** | ManagedClient VA download URL | [optional] [readonly] +**VaVersion** | Pointer to **String** | Version that the ManagedClient's VA is running | [optional] [readonly] +**Secret** | Pointer to **String** | Client's apiKey | [optional] +**CreatedAt** | Pointer to **System.DateTime** | The date/time this ManagedClient was created | [optional] +**UpdatedAt** | Pointer to **System.DateTime** | The date/time this ManagedClient was last updated | [optional] +**ProvisionStatus** | Pointer to **Enum** [ "PROVISIONED", "DRAFT" ] | The provisioning status of the ManagedClient | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$ManagedClient = Initialize-PSSailpoint.V2024ManagedClient -Id 2c9180878eaf4204018eb019c3570003 ` + -AlertKey CLIENT_STATUS_NOT_CONFIGURED ` + -ApiGatewayBaseUrl null ` + -Cookbook null ` + -CcId 2248 ` + -ClientId 00be54a2-bb6d-402f-9159-beb2d5319347 ` + -ClusterId e1ff7bb24c934240bbf55e1aa39e41c5 ` + -Description A short description of the ManagedClient ` + -IpAddress 123.456.78.90 ` + -LastSeen 2020-01-01T00:00Z ` + -Name aName ` + -SinceLastSeen 15000 ` + -Status NORMAL ` + -Type VA ` + -ClusterType idn ` + -VaDownloadUrl aUrl ` + -VaVersion va-megapod-useast1-610-1621372012 ` + -Secret ef878e15eaa8c8d3e2fa52f41125e2a0eeadadc6a14f931a33ad3e1b62d56381 ` + -CreatedAt 2023-08-04T20:48:01.865Z ` + -UpdatedAt 2023-08-04T20:48:01.865Z ` + -ProvisionStatus PROVISIONED +``` + +- Convert the resource to JSON +```powershell +$ManagedClient | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClientRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClientRequest.md new file mode 100644 index 000000000..fbacca343 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClientRequest.md @@ -0,0 +1,41 @@ +--- +id: v2024-managed-client-request +title: ManagedClientRequest +pagination_label: ManagedClientRequest +sidebar_label: ManagedClientRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClientRequest', 'V2024ManagedClientRequest'] +slug: /tools/sdk/powershell/v2024/models/managed-client-request +tags: ['SDK', 'Software Development Kit', 'ManagedClientRequest', 'V2024ManagedClientRequest'] +--- + + +# ManagedClientRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClusterId** | **String** | Cluster ID that the ManagedClient is linked to | [required] +**Description** | Pointer to **String** | description for the ManagedClient to create | [optional] +**Name** | Pointer to **String** | name for the ManagedClient to create | [optional] +**Type** | Pointer to **String** | Type of the ManagedClient (VA, CCG) to create | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagedClientRequest = Initialize-PSSailpoint.V2024ManagedClientRequest -ClusterId aClusterId ` + -Description A short description of the ManagedClient ` + -Name aName ` + -Type VA +``` + +- Convert the resource to JSON +```powershell +$ManagedClientRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClientStatus.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClientStatus.md new file mode 100644 index 000000000..500ff7a99 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClientStatus.md @@ -0,0 +1,41 @@ +--- +id: v2024-managed-client-status +title: ManagedClientStatus +pagination_label: ManagedClientStatus +sidebar_label: ManagedClientStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClientStatus', 'V2024ManagedClientStatus'] +slug: /tools/sdk/powershell/v2024/models/managed-client-status +tags: ['SDK', 'Software Development Kit', 'ManagedClientStatus', 'V2024ManagedClientStatus'] +--- + + +# ManagedClientStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Body** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | ManagedClientStatus body information | [required] +**Status** | [**ManagedClientStatusCode**](managed-client-status-code) | | [required] +**Type** | [**ManagedClientType**](managed-client-type) | | [required] +**Timestamp** | **System.DateTime** | timestamp on the Client Status update | [required] + +## Examples + +- Prepare the resource +```powershell +$ManagedClientStatus = Initialize-PSSailpoint.V2024ManagedClientStatus -Body {alertKey=, id=5678, clusterId=1234, ccg_etag=ccg_etag123xyz456, ccg_pin=NONE, cookbook_etag=20210420125956-20210511144538, hostname=megapod-useast1-secret-hostname.sailpoint.com, internal_ip=127.0.0.1, lastSeen=1620843964604, sinceSeen=14708, sinceSeenMillis=14708, localDev=false, stacktrace=, state=null, status=NORMAL, uuid=null, product=idn, va_version=null, platform_version=2, os_version=2345.3.1, os_type=flatcar, hypervisor=unknown} ` + -Status null ` + -Type null ` + -Timestamp 2020-01-01T00:00Z +``` + +- Convert the resource to JSON +```powershell +$ManagedClientStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClientStatusCode.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClientStatusCode.md new file mode 100644 index 000000000..d8cd67eee --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClientStatusCode.md @@ -0,0 +1,34 @@ +--- +id: v2024-managed-client-status-code +title: ManagedClientStatusCode +pagination_label: ManagedClientStatusCode +sidebar_label: ManagedClientStatusCode +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClientStatusCode', 'V2024ManagedClientStatusCode'] +slug: /tools/sdk/powershell/v2024/models/managed-client-status-code +tags: ['SDK', 'Software Development Kit', 'ManagedClientStatusCode', 'V2024ManagedClientStatusCode'] +--- + + +# ManagedClientStatusCode + +## Enum + + +* `NORMAL` (value: `"NORMAL"`) + +* `UNDEFINED` (value: `"UNDEFINED"`) + +* `NOT_CONFIGURED` (value: `"NOT_CONFIGURED"`) + +* `CONFIGURING` (value: `"CONFIGURING"`) + +* `WARNING` (value: `"WARNING"`) + +* `ERROR` (value: `"ERROR"`) + +* `FAILED` (value: `"FAILED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClientType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClientType.md new file mode 100644 index 000000000..771663e62 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClientType.md @@ -0,0 +1,28 @@ +--- +id: v2024-managed-client-type +title: ManagedClientType +pagination_label: ManagedClientType +sidebar_label: ManagedClientType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClientType', 'V2024ManagedClientType'] +slug: /tools/sdk/powershell/v2024/models/managed-client-type +tags: ['SDK', 'Software Development Kit', 'ManagedClientType', 'V2024ManagedClientType'] +--- + + +# ManagedClientType + +## Enum + + +* `CCG` (value: `"CCG"`) + +* `VA` (value: `"VA"`) + +* `INTERNAL` (value: `"INTERNAL"`) + +* `IIQ_HARVESTER` (value: `"IIQ_HARVESTER"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedCluster.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedCluster.md new file mode 100644 index 000000000..4253d57e1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedCluster.md @@ -0,0 +1,83 @@ +--- +id: v2024-managed-cluster +title: ManagedCluster +pagination_label: ManagedCluster +sidebar_label: ManagedCluster +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedCluster', 'V2024ManagedCluster'] +slug: /tools/sdk/powershell/v2024/models/managed-cluster +tags: ['SDK', 'Software Development Kit', 'ManagedCluster', 'V2024ManagedCluster'] +--- + + +# ManagedCluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | ManagedCluster ID | [required] +**Name** | Pointer to **String** | ManagedCluster name | [optional] +**Pod** | Pointer to **String** | ManagedCluster pod | [optional] +**Org** | Pointer to **String** | ManagedCluster org | [optional] +**Type** | Pointer to [**ManagedClusterTypes**](managed-cluster-types) | | [optional] +**Configuration** | Pointer to **map[string]String** | ManagedProcess configuration map | [optional] +**KeyPair** | Pointer to [**ManagedClusterKeyPair**](managed-cluster-key-pair) | | [optional] +**Attributes** | Pointer to [**ManagedClusterAttributes**](managed-cluster-attributes) | | [optional] +**Description** | Pointer to **String** | ManagedCluster description | [optional] [default to "q"] +**Redis** | Pointer to [**ManagedClusterRedis**](managed-cluster-redis) | | [optional] +**ClientType** | [**ManagedClientType**](managed-client-type) | | [required] +**CcgVersion** | **String** | CCG version used by the ManagedCluster | [required] +**PinnedConfig** | Pointer to **Boolean** | boolean flag indiacting whether or not the cluster configuration is pinned | [optional] [default to $false] +**LogConfiguration** | Pointer to [**ClientLogConfiguration**](client-log-configuration) | | [optional] +**Operational** | Pointer to **Boolean** | Whether or not the cluster is operational or not | [optional] [default to $false] +**Status** | Pointer to **String** | Cluster status | [optional] +**PublicKeyCertificate** | Pointer to **String** | Public key certificate | [optional] +**PublicKeyThumbprint** | Pointer to **String** | Public key thumbprint | [optional] +**PublicKey** | Pointer to **String** | Public key | [optional] +**AlertKey** | Pointer to **String** | Key describing any immediate cluster alerts | [optional] +**ClientIds** | Pointer to **[]String** | List of clients in a cluster | [optional] +**ServiceCount** | Pointer to **Int32** | Number of services bound to a cluster | [optional] [default to 0] +**CcId** | Pointer to **String** | CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished | [optional] [default to "0"] +**CreatedAt** | Pointer to **System.DateTime** | The date/time this cluster was created | [optional] +**UpdatedAt** | Pointer to **System.DateTime** | The date/time this cluster was last updated | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagedCluster = Initialize-PSSailpoint.V2024ManagedCluster -Id e1ff7bb24c934240bbf55e1aa39e41c5 ` + -Name Managed Cluster Name ` + -Pod megapod-useast1 ` + -Org denali ` + -Type null ` + -Configuration {clusterExternalId=e1ff7bb24c934240bbf55e1aa39e41c5, clusterType=sqsCluster, gmtOffset=-5} ` + -KeyPair null ` + -Attributes null ` + -Description A short description of the managed cluster. ` + -Redis null ` + -ClientType null ` + -CcgVersion v01 ` + -PinnedConfig false ` + -LogConfiguration null ` + -Operational false ` + -Status NORMAL ` + -PublicKeyCertificate -----BEGIN CERTIFICATE-----TCCAb2gAwIBAgIBADANBgkqhkiG9w0BAQsFADAuMQ0wCwYDVQQD-----END CERTIFICATE----- ` + -PublicKeyThumbprint obc6pLiulGbtZ ` + -PublicKey -----BEGIN PUBLIC KEY-----jANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3WgnsxP52MDgBTfHR+5n4-----END PUBLIC KEY----- ` + -AlertKey LIMITED_RESOURCES ` + -ClientIds [1244, 1245] ` + -ServiceCount 6 ` + -CcId 1533 ` + -CreatedAt 2023-08-04T20:48:01.865Z ` + -UpdatedAt 2023-08-04T20:48:01.865Z +``` + +- Convert the resource to JSON +```powershell +$ManagedCluster | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClusterAttributes.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClusterAttributes.md new file mode 100644 index 000000000..55e7ea197 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClusterAttributes.md @@ -0,0 +1,37 @@ +--- +id: v2024-managed-cluster-attributes +title: ManagedClusterAttributes +pagination_label: ManagedClusterAttributes +sidebar_label: ManagedClusterAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterAttributes', 'V2024ManagedClusterAttributes'] +slug: /tools/sdk/powershell/v2024/models/managed-cluster-attributes +tags: ['SDK', 'Software Development Kit', 'ManagedClusterAttributes', 'V2024ManagedClusterAttributes'] +--- + + +# ManagedClusterAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Queue** | Pointer to [**ManagedClusterQueue**](managed-cluster-queue) | | [optional] +**Keystore** | Pointer to **String** | ManagedCluster keystore for spConnectCluster type | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagedClusterAttributes = Initialize-PSSailpoint.V2024ManagedClusterAttributes -Queue null ` + -Keystore /u3+7QAAAAIAAAABAAAAAQAvL3Byb3h5LWNsdXN0ZXIvMmM5MTgwODc3Yjg3MW +``` + +- Convert the resource to JSON +```powershell +$ManagedClusterAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClusterKeyPair.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClusterKeyPair.md new file mode 100644 index 000000000..ba0af4309 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClusterKeyPair.md @@ -0,0 +1,39 @@ +--- +id: v2024-managed-cluster-key-pair +title: ManagedClusterKeyPair +pagination_label: ManagedClusterKeyPair +sidebar_label: ManagedClusterKeyPair +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterKeyPair', 'V2024ManagedClusterKeyPair'] +slug: /tools/sdk/powershell/v2024/models/managed-cluster-key-pair +tags: ['SDK', 'Software Development Kit', 'ManagedClusterKeyPair', 'V2024ManagedClusterKeyPair'] +--- + + +# ManagedClusterKeyPair + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PublicKey** | Pointer to **String** | ManagedCluster publicKey | [optional] +**PublicKeyThumbprint** | Pointer to **String** | ManagedCluster publicKeyThumbprint | [optional] +**PublicKeyCertificate** | Pointer to **String** | ManagedCluster publicKeyCertificate | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagedClusterKeyPair = Initialize-PSSailpoint.V2024ManagedClusterKeyPair -PublicKey -----BEGIN PUBLIC KEY-----******-----END PUBLIC KEY----- ` + -PublicKeyThumbprint 6CMlaJIV44-xJxcB3CJBjDUUn54 ` + -PublicKeyCertificate -----BEGIN CERTIFICATE-----****-----END CERTIFICATE----- +``` + +- Convert the resource to JSON +```powershell +$ManagedClusterKeyPair | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClusterQueue.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClusterQueue.md new file mode 100644 index 000000000..365d610c6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClusterQueue.md @@ -0,0 +1,37 @@ +--- +id: v2024-managed-cluster-queue +title: ManagedClusterQueue +pagination_label: ManagedClusterQueue +sidebar_label: ManagedClusterQueue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterQueue', 'V2024ManagedClusterQueue'] +slug: /tools/sdk/powershell/v2024/models/managed-cluster-queue +tags: ['SDK', 'Software Development Kit', 'ManagedClusterQueue', 'V2024ManagedClusterQueue'] +--- + + +# ManagedClusterQueue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | ManagedCluster queue name | [optional] +**Region** | Pointer to **String** | ManagedCluster queue aws region | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagedClusterQueue = Initialize-PSSailpoint.V2024ManagedClusterQueue -Name megapod-useast1-denali-lwt-cluster-1533 ` + -Region us-east-1 +``` + +- Convert the resource to JSON +```powershell +$ManagedClusterQueue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClusterRedis.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClusterRedis.md new file mode 100644 index 000000000..51ca7fd10 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClusterRedis.md @@ -0,0 +1,37 @@ +--- +id: v2024-managed-cluster-redis +title: ManagedClusterRedis +pagination_label: ManagedClusterRedis +sidebar_label: ManagedClusterRedis +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterRedis', 'V2024ManagedClusterRedis'] +slug: /tools/sdk/powershell/v2024/models/managed-cluster-redis +tags: ['SDK', 'Software Development Kit', 'ManagedClusterRedis', 'V2024ManagedClusterRedis'] +--- + + +# ManagedClusterRedis + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RedisHost** | Pointer to **String** | ManagedCluster redisHost | [optional] +**RedisPort** | Pointer to **Int32** | ManagedCluster redisPort | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagedClusterRedis = Initialize-PSSailpoint.V2024ManagedClusterRedis -RedisHost megapod-useast1-shared-redis.cloud.sailpoint.com ` + -RedisPort 6379 +``` + +- Convert the resource to JSON +```powershell +$ManagedClusterRedis | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClusterRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClusterRequest.md new file mode 100644 index 000000000..75524d31f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClusterRequest.md @@ -0,0 +1,41 @@ +--- +id: v2024-managed-cluster-request +title: ManagedClusterRequest +pagination_label: ManagedClusterRequest +sidebar_label: ManagedClusterRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterRequest', 'V2024ManagedClusterRequest'] +slug: /tools/sdk/powershell/v2024/models/managed-cluster-request +tags: ['SDK', 'Software Development Kit', 'ManagedClusterRequest', 'V2024ManagedClusterRequest'] +--- + + +# ManagedClusterRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | ManagedCluster name | [required] +**Type** | Pointer to [**ManagedClusterTypes**](managed-cluster-types) | | [optional] +**Configuration** | Pointer to **map[string]String** | ManagedProcess configuration map | [optional] +**Description** | Pointer to **String** | ManagedCluster description | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagedClusterRequest = Initialize-PSSailpoint.V2024ManagedClusterRequest -Name Managed Cluster Name ` + -Type null ` + -Configuration {clusterExternalId=externalId, ccgVersion=77.0.0} ` + -Description A short description of the managed cluster. +``` + +- Convert the resource to JSON +```powershell +$ManagedClusterRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClusterTypes.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClusterTypes.md new file mode 100644 index 000000000..fe77f5112 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagedClusterTypes.md @@ -0,0 +1,24 @@ +--- +id: v2024-managed-cluster-types +title: ManagedClusterTypes +pagination_label: ManagedClusterTypes +sidebar_label: ManagedClusterTypes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterTypes', 'V2024ManagedClusterTypes'] +slug: /tools/sdk/powershell/v2024/models/managed-cluster-types +tags: ['SDK', 'Software Development Kit', 'ManagedClusterTypes', 'V2024ManagedClusterTypes'] +--- + + +# ManagedClusterTypes + +## Enum + + +* `idn` (value: `"idn"`) + +* `iai` (value: `"iai"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagerCorrelationMapping.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagerCorrelationMapping.md new file mode 100644 index 000000000..4339491fe --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManagerCorrelationMapping.md @@ -0,0 +1,37 @@ +--- +id: v2024-manager-correlation-mapping +title: ManagerCorrelationMapping +pagination_label: ManagerCorrelationMapping +sidebar_label: ManagerCorrelationMapping +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagerCorrelationMapping', 'V2024ManagerCorrelationMapping'] +slug: /tools/sdk/powershell/v2024/models/manager-correlation-mapping +tags: ['SDK', 'Software Development Kit', 'ManagerCorrelationMapping', 'V2024ManagerCorrelationMapping'] +--- + + +# ManagerCorrelationMapping + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountAttributeName** | Pointer to **String** | Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. | [optional] +**IdentityAttributeName** | Pointer to **String** | Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagerCorrelationMapping = Initialize-PSSailpoint.V2024ManagerCorrelationMapping -AccountAttributeName manager ` + -IdentityAttributeName manager +``` + +- Convert the resource to JSON +```powershell +$ManagerCorrelationMapping | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManualDiscoverApplications.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManualDiscoverApplications.md new file mode 100644 index 000000000..fc6880cd1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManualDiscoverApplications.md @@ -0,0 +1,37 @@ +--- +id: v2024-manual-discover-applications +title: ManualDiscoverApplications +pagination_label: ManualDiscoverApplications +sidebar_label: ManualDiscoverApplications +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManualDiscoverApplications', 'V2024ManualDiscoverApplications'] +slug: /tools/sdk/powershell/v2024/models/manual-discover-applications +tags: ['SDK', 'Software Development Kit', 'ManualDiscoverApplications', 'V2024ManualDiscoverApplications'] +--- + + +# ManualDiscoverApplications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | **System.IO.FileInfo** | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. | [required] + +## Examples + +- Prepare the resource +```powershell +$ManualDiscoverApplications = Initialize-PSSailpoint.V2024ManualDiscoverApplications -File application_name,description +"Sample App","This is a sample description for Sample App." +"Another App","Description for Another App." +``` + +- Convert the resource to JSON +```powershell +$ManualDiscoverApplications | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManualDiscoverApplicationsTemplate.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManualDiscoverApplicationsTemplate.md new file mode 100644 index 000000000..9a7166f9a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManualDiscoverApplicationsTemplate.md @@ -0,0 +1,37 @@ +--- +id: v2024-manual-discover-applications-template +title: ManualDiscoverApplicationsTemplate +pagination_label: ManualDiscoverApplicationsTemplate +sidebar_label: ManualDiscoverApplicationsTemplate +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManualDiscoverApplicationsTemplate', 'V2024ManualDiscoverApplicationsTemplate'] +slug: /tools/sdk/powershell/v2024/models/manual-discover-applications-template +tags: ['SDK', 'Software Development Kit', 'ManualDiscoverApplicationsTemplate', 'V2024ManualDiscoverApplicationsTemplate'] +--- + + +# ManualDiscoverApplicationsTemplate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationName** | Pointer to **String** | Name of the application. | [optional] +**Description** | Pointer to **String** | Description of the application. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManualDiscoverApplicationsTemplate = Initialize-PSSailpoint.V2024ManualDiscoverApplicationsTemplate -ApplicationName Example Application ` + -Description Example Description +``` + +- Convert the resource to JSON +```powershell +$ManualDiscoverApplicationsTemplate | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManualWorkItemDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManualWorkItemDetails.md new file mode 100644 index 000000000..4c34964b7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManualWorkItemDetails.md @@ -0,0 +1,45 @@ +--- +id: v2024-manual-work-item-details +title: ManualWorkItemDetails +pagination_label: ManualWorkItemDetails +sidebar_label: ManualWorkItemDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManualWorkItemDetails', 'V2024ManualWorkItemDetails'] +slug: /tools/sdk/powershell/v2024/models/manual-work-item-details +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetails', 'V2024ManualWorkItemDetails'] +--- + + +# ManualWorkItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Forwarded** | Pointer to **Boolean** | True if the request for this item was forwarded from one owner to another. | [optional] [default to $false] +**OriginalOwner** | Pointer to [**ManualWorkItemDetailsOriginalOwner**](manual-work-item-details-original-owner) | | [optional] +**CurrentOwner** | Pointer to [**ManualWorkItemDetailsCurrentOwner**](manual-work-item-details-current-owner) | | [optional] +**Modified** | Pointer to **System.DateTime** | Time at which item was modified. | [optional] +**Status** | Pointer to [**ManualWorkItemState**](manual-work-item-state) | | [optional] +**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManualWorkItemDetails = Initialize-PSSailpoint.V2024ManualWorkItemDetails -Forwarded true ` + -OriginalOwner null ` + -CurrentOwner null ` + -Modified 2019-08-23T18:52:57.398Z ` + -Status null ` + -ForwardHistory null +``` + +- Convert the resource to JSON +```powershell +$ManualWorkItemDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManualWorkItemDetails1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManualWorkItemDetails1.md new file mode 100644 index 000000000..ac2b712da --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManualWorkItemDetails1.md @@ -0,0 +1,45 @@ +--- +id: v2024-manual-work-item-details1 +title: ManualWorkItemDetails1 +pagination_label: ManualWorkItemDetails1 +sidebar_label: ManualWorkItemDetails1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManualWorkItemDetails1', 'V2024ManualWorkItemDetails1'] +slug: /tools/sdk/powershell/v2024/models/manual-work-item-details1 +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetails1', 'V2024ManualWorkItemDetails1'] +--- + + +# ManualWorkItemDetails1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Forwarded** | Pointer to **Boolean** | True if the request for this item was forwarded from one owner to another. | [optional] [default to $false] +**OriginalOwner** | Pointer to [**ManualWorkItemDetailsOriginalOwner**](manual-work-item-details-original-owner) | | [optional] +**CurrentOwner** | Pointer to [**ManualWorkItemDetailsCurrentOwner**](manual-work-item-details-current-owner) | | [optional] +**Modified** | Pointer to **System.DateTime** | Time at which item was modified. | [optional] +**Status** | Pointer to [**ManualWorkItemState**](manual-work-item-state) | | [optional] +**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory1**](approval-forward-history1) | The history of approval forward action. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManualWorkItemDetails1 = Initialize-PSSailpoint.V2024ManualWorkItemDetails1 -Forwarded true ` + -OriginalOwner null ` + -CurrentOwner null ` + -Modified 2019-08-23T18:52:57.398Z ` + -Status null ` + -ForwardHistory null +``` + +- Convert the resource to JSON +```powershell +$ManualWorkItemDetails1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManualWorkItemDetailsCurrentOwner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManualWorkItemDetailsCurrentOwner.md new file mode 100644 index 000000000..1c368104c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManualWorkItemDetailsCurrentOwner.md @@ -0,0 +1,39 @@ +--- +id: v2024-manual-work-item-details-current-owner +title: ManualWorkItemDetailsCurrentOwner +pagination_label: ManualWorkItemDetailsCurrentOwner +sidebar_label: ManualWorkItemDetailsCurrentOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManualWorkItemDetailsCurrentOwner', 'V2024ManualWorkItemDetailsCurrentOwner'] +slug: /tools/sdk/powershell/v2024/models/manual-work-item-details-current-owner +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetailsCurrentOwner', 'V2024ManualWorkItemDetailsCurrentOwner'] +--- + + +# ManualWorkItemDetailsCurrentOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP", "IDENTITY" ] | DTO type of current work item owner's identity. | [optional] +**Id** | Pointer to **String** | ID of current work item owner's identity. | [optional] +**Name** | Pointer to **String** | Display name of current work item owner. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManualWorkItemDetailsCurrentOwner = Initialize-PSSailpoint.V2024ManualWorkItemDetailsCurrentOwner -Type IDENTITY ` + -Id 2c3780a46faadee4016fb4e018c20652 ` + -Name Allen Albertson +``` + +- Convert the resource to JSON +```powershell +$ManualWorkItemDetailsCurrentOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManualWorkItemDetailsOriginalOwner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManualWorkItemDetailsOriginalOwner.md new file mode 100644 index 000000000..80188b1df --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManualWorkItemDetailsOriginalOwner.md @@ -0,0 +1,39 @@ +--- +id: v2024-manual-work-item-details-original-owner +title: ManualWorkItemDetailsOriginalOwner +pagination_label: ManualWorkItemDetailsOriginalOwner +sidebar_label: ManualWorkItemDetailsOriginalOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManualWorkItemDetailsOriginalOwner', 'V2024ManualWorkItemDetailsOriginalOwner'] +slug: /tools/sdk/powershell/v2024/models/manual-work-item-details-original-owner +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetailsOriginalOwner', 'V2024ManualWorkItemDetailsOriginalOwner'] +--- + + +# ManualWorkItemDetailsOriginalOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP", "IDENTITY" ] | DTO type of original work item owner's identity. | [optional] +**Id** | Pointer to **String** | ID of original work item owner's identity. | [optional] +**Name** | Pointer to **String** | Display name of original work item owner. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManualWorkItemDetailsOriginalOwner = Initialize-PSSailpoint.V2024ManualWorkItemDetailsOriginalOwner -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$ManualWorkItemDetailsOriginalOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManualWorkItemState.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManualWorkItemState.md new file mode 100644 index 000000000..a027f32dd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManualWorkItemState.md @@ -0,0 +1,32 @@ +--- +id: v2024-manual-work-item-state +title: ManualWorkItemState +pagination_label: ManualWorkItemState +sidebar_label: ManualWorkItemState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManualWorkItemState', 'V2024ManualWorkItemState'] +slug: /tools/sdk/powershell/v2024/models/manual-work-item-state +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemState', 'V2024ManualWorkItemState'] +--- + + +# ManualWorkItemState + +## Enum + + +* `PENDING` (value: `"PENDING"`) + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `EXPIRED` (value: `"EXPIRED"`) + +* `CANCELLED` (value: `"CANCELLED"`) + +* `ARCHIVED` (value: `"ARCHIVED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManuallyUpdatedFieldsDTO.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManuallyUpdatedFieldsDTO.md new file mode 100644 index 000000000..29f4c0413 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ManuallyUpdatedFieldsDTO.md @@ -0,0 +1,37 @@ +--- +id: v2024-manually-updated-fields-dto +title: ManuallyUpdatedFieldsDTO +pagination_label: ManuallyUpdatedFieldsDTO +sidebar_label: ManuallyUpdatedFieldsDTO +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManuallyUpdatedFieldsDTO', 'V2024ManuallyUpdatedFieldsDTO'] +slug: /tools/sdk/powershell/v2024/models/manually-updated-fields-dto +tags: ['SDK', 'Software Development Kit', 'ManuallyUpdatedFieldsDTO', 'V2024ManuallyUpdatedFieldsDTO'] +--- + + +# ManuallyUpdatedFieldsDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DISPLAYNAME** | Pointer to **Boolean** | True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `name` property. | [optional] [default to $false] +**DESCRIPTION** | Pointer to **Boolean** | True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `description` property. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$ManuallyUpdatedFieldsDTO = Initialize-PSSailpoint.V2024ManuallyUpdatedFieldsDTO -DISPLAYNAME true ` + -DESCRIPTION true +``` + +- Convert the resource to JSON +```powershell +$ManuallyUpdatedFieldsDTO | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MatchTerm.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MatchTerm.md new file mode 100644 index 000000000..ff73808f3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MatchTerm.md @@ -0,0 +1,45 @@ +--- +id: v2024-match-term +title: MatchTerm +pagination_label: MatchTerm +sidebar_label: MatchTerm +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MatchTerm', 'V2024MatchTerm'] +slug: /tools/sdk/powershell/v2024/models/match-term +tags: ['SDK', 'Software Development Kit', 'MatchTerm', 'V2024MatchTerm'] +--- + + +# MatchTerm + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The attribute name | [optional] +**Value** | Pointer to **String** | The attribute value | [optional] +**Op** | Pointer to **String** | The operator between name and value | [optional] +**Container** | Pointer to **Boolean** | If it is a container or a real match term | [optional] [default to $false] +**And** | Pointer to **Boolean** | If it is AND logical operator for the children match terms | [optional] [default to $false] +**Children** | Pointer to [**[]System.Collections.Hashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The children under this match term | [optional] + +## Examples + +- Prepare the resource +```powershell +$MatchTerm = Initialize-PSSailpoint.V2024MatchTerm -Name mail ` + -Value 1234 Albany Dr ` + -Op eq ` + -Container true ` + -And false ` + -Children [{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}] +``` + +- Convert the resource to JSON +```powershell +$MatchTerm | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Medium.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Medium.md new file mode 100644 index 000000000..6413c3fea --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Medium.md @@ -0,0 +1,30 @@ +--- +id: v2024-medium +title: Medium +pagination_label: Medium +sidebar_label: Medium +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Medium', 'V2024Medium'] +slug: /tools/sdk/powershell/v2024/models/medium +tags: ['SDK', 'Software Development Kit', 'Medium', 'V2024Medium'] +--- + + +# Medium + +## Enum + + +* `EMAIL` (value: `"EMAIL"`) + +* `SMS` (value: `"SMS"`) + +* `PHONE` (value: `"PHONE"`) + +* `SLACK` (value: `"SLACK"`) + +* `TEAMS` (value: `"TEAMS"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MetricAggregation.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MetricAggregation.md new file mode 100644 index 000000000..d6f4f7441 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MetricAggregation.md @@ -0,0 +1,39 @@ +--- +id: v2024-metric-aggregation +title: MetricAggregation +pagination_label: MetricAggregation +sidebar_label: MetricAggregation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MetricAggregation', 'V2024MetricAggregation'] +slug: /tools/sdk/powershell/v2024/models/metric-aggregation +tags: ['SDK', 'Software Development Kit', 'MetricAggregation', 'V2024MetricAggregation'] +--- + + +# MetricAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | The name of the metric aggregate to be included in the result. If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. | [required] +**Type** | Pointer to [**MetricType**](metric-type) | | [optional] +**Field** | **String** | The field the calculation is performed on. Prefix the field name with '@' to reference a nested object. | [required] + +## Examples + +- Prepare the resource +```powershell +$MetricAggregation = Initialize-PSSailpoint.V2024MetricAggregation -Name Access Name Count ` + -Type null ` + -Field @access.name +``` + +- Convert the resource to JSON +```powershell +$MetricAggregation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MetricResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MetricResponse.md new file mode 100644 index 000000000..0716fc828 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MetricResponse.md @@ -0,0 +1,37 @@ +--- +id: v2024-metric-response +title: MetricResponse +pagination_label: MetricResponse +sidebar_label: MetricResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MetricResponse', 'V2024MetricResponse'] +slug: /tools/sdk/powershell/v2024/models/metric-response +tags: ['SDK', 'Software Development Kit', 'MetricResponse', 'V2024MetricResponse'] +--- + + +# MetricResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | the name of metric | [optional] +**Value** | Pointer to **Decimal** | the value associated to the metric | [optional] + +## Examples + +- Prepare the resource +```powershell +$MetricResponse = Initialize-PSSailpoint.V2024MetricResponse -Name null ` + -Value null +``` + +- Convert the resource to JSON +```powershell +$MetricResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MetricType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MetricType.md new file mode 100644 index 000000000..41d9d1a5f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MetricType.md @@ -0,0 +1,34 @@ +--- +id: v2024-metric-type +title: MetricType +pagination_label: MetricType +sidebar_label: MetricType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MetricType', 'V2024MetricType'] +slug: /tools/sdk/powershell/v2024/models/metric-type +tags: ['SDK', 'Software Development Kit', 'MetricType', 'V2024MetricType'] +--- + + +# MetricType + +## Enum + + +* `COUNT` (value: `"COUNT"`) + +* `UNIQUE_COUNT` (value: `"UNIQUE_COUNT"`) + +* `AVG` (value: `"AVG"`) + +* `SUM` (value: `"SUM"`) + +* `MEDIAN` (value: `"MEDIAN"`) + +* `MIN` (value: `"MIN"`) + +* `MAX` (value: `"MAX"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MfaConfigTestResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MfaConfigTestResponse.md new file mode 100644 index 000000000..64139b2f8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MfaConfigTestResponse.md @@ -0,0 +1,37 @@ +--- +id: v2024-mfa-config-test-response +title: MfaConfigTestResponse +pagination_label: MfaConfigTestResponse +sidebar_label: MfaConfigTestResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MfaConfigTestResponse', 'V2024MfaConfigTestResponse'] +slug: /tools/sdk/powershell/v2024/models/mfa-config-test-response +tags: ['SDK', 'Software Development Kit', 'MfaConfigTestResponse', 'V2024MfaConfigTestResponse'] +--- + + +# MfaConfigTestResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **Enum** [ "SUCCESS", "FAILED" ] | The configuration test result. | [optional] [readonly] +**VarError** | Pointer to **String** | The error message to indicate the failure of configuration test. | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$MfaConfigTestResponse = Initialize-PSSailpoint.V2024MfaConfigTestResponse -State SUCCESS ` + -VarError MFA Method is disabled. +``` + +- Convert the resource to JSON +```powershell +$MfaConfigTestResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MfaDuoConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MfaDuoConfig.md new file mode 100644 index 000000000..569c69025 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MfaDuoConfig.md @@ -0,0 +1,45 @@ +--- +id: v2024-mfa-duo-config +title: MfaDuoConfig +pagination_label: MfaDuoConfig +sidebar_label: MfaDuoConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MfaDuoConfig', 'V2024MfaDuoConfig'] +slug: /tools/sdk/powershell/v2024/models/mfa-duo-config +tags: ['SDK', 'Software Development Kit', 'MfaDuoConfig', 'V2024MfaDuoConfig'] +--- + + +# MfaDuoConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MfaMethod** | Pointer to **String** | Mfa method name | [optional] +**Enabled** | Pointer to **Boolean** | If MFA method is enabled. | [optional] [default to $false] +**VarHost** | Pointer to **String** | The server host name or IP address of the MFA provider. | [optional] +**AccessKey** | Pointer to **String** | The secret key for authenticating requests to the MFA provider. | [optional] +**IdentityAttribute** | Pointer to **String** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [optional] +**ConfigProperties** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map with additional config properties for the given MFA method - duo-web. | [optional] + +## Examples + +- Prepare the resource +```powershell +$MfaDuoConfig = Initialize-PSSailpoint.V2024MfaDuoConfig -MfaMethod duo-web ` + -Enabled true ` + -VarHost example.com ` + -AccessKey qw123Y3QlA5UqocYpdU3rEkzrK2D497y ` + -IdentityAttribute email ` + -ConfigProperties {skey=qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x, ikey=Q123WE45R6TY7890ZXCV} +``` + +- Convert the resource to JSON +```powershell +$MfaDuoConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MfaOktaConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MfaOktaConfig.md new file mode 100644 index 000000000..1275d22ca --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MfaOktaConfig.md @@ -0,0 +1,43 @@ +--- +id: v2024-mfa-okta-config +title: MfaOktaConfig +pagination_label: MfaOktaConfig +sidebar_label: MfaOktaConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MfaOktaConfig', 'V2024MfaOktaConfig'] +slug: /tools/sdk/powershell/v2024/models/mfa-okta-config +tags: ['SDK', 'Software Development Kit', 'MfaOktaConfig', 'V2024MfaOktaConfig'] +--- + + +# MfaOktaConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MfaMethod** | Pointer to **String** | Mfa method name | [optional] +**Enabled** | Pointer to **Boolean** | If MFA method is enabled. | [optional] [default to $false] +**VarHost** | Pointer to **String** | The server host name or IP address of the MFA provider. | [optional] +**AccessKey** | Pointer to **String** | The secret key for authenticating requests to the MFA provider. | [optional] +**IdentityAttribute** | Pointer to **String** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [optional] + +## Examples + +- Prepare the resource +```powershell +$MfaOktaConfig = Initialize-PSSailpoint.V2024MfaOktaConfig -MfaMethod okta-verify ` + -Enabled true ` + -VarHost example.com ` + -AccessKey qw123Y3QlA5UqocYpdU3rEkzrK2D497y ` + -IdentityAttribute email +``` + +- Convert the resource to JSON +```powershell +$MfaOktaConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MultiPolicyRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MultiPolicyRequest.md new file mode 100644 index 000000000..62286bdc2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/MultiPolicyRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-multi-policy-request +title: MultiPolicyRequest +pagination_label: MultiPolicyRequest +sidebar_label: MultiPolicyRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MultiPolicyRequest', 'V2024MultiPolicyRequest'] +slug: /tools/sdk/powershell/v2024/models/multi-policy-request +tags: ['SDK', 'Software Development Kit', 'MultiPolicyRequest', 'V2024MultiPolicyRequest'] +--- + + +# MultiPolicyRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FilteredPolicyList** | Pointer to **[]String** | Multi-policy report will be run for this list of ids | [optional] + +## Examples + +- Prepare the resource +```powershell +$MultiPolicyRequest = Initialize-PSSailpoint.V2024MultiPolicyRequest -FilteredPolicyList null +``` + +- Convert the resource to JSON +```powershell +$MultiPolicyRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NameNormalizer.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NameNormalizer.md new file mode 100644 index 000000000..24ab6be32 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NameNormalizer.md @@ -0,0 +1,37 @@ +--- +id: v2024-name-normalizer +title: NameNormalizer +pagination_label: NameNormalizer +sidebar_label: NameNormalizer +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NameNormalizer', 'V2024NameNormalizer'] +slug: /tools/sdk/powershell/v2024/models/name-normalizer +tags: ['SDK', 'Software Development Kit', 'NameNormalizer', 'V2024NameNormalizer'] +--- + + +# NameNormalizer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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] + +## Examples + +- Prepare the resource +```powershell +$NameNormalizer = Initialize-PSSailpoint.V2024NameNormalizer -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$NameNormalizer | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NamedConstructs.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NamedConstructs.md new file mode 100644 index 000000000..8011d0abe --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NamedConstructs.md @@ -0,0 +1,30 @@ +--- +id: v2024-named-constructs +title: NamedConstructs +pagination_label: NamedConstructs +sidebar_label: NamedConstructs +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NamedConstructs', 'V2024NamedConstructs'] +slug: /tools/sdk/powershell/v2024/models/named-constructs +tags: ['SDK', 'Software Development Kit', 'NamedConstructs', 'V2024NamedConstructs'] +--- + + +# NamedConstructs + +## Enum + + +* `ISO8601` (value: `"ISO8601"`) + +* `LDAP` (value: `"LDAP"`) + +* `PEOPLE_SOFT` (value: `"PEOPLE_SOFT"`) + +* `EPOCH_TIME_JAVA` (value: `"EPOCH_TIME_JAVA"`) + +* `EPOCH_TIME_WIN32` (value: `"EPOCH_TIME_WIN32"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NativeChangeDetectionConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NativeChangeDetectionConfig.md new file mode 100644 index 000000000..aee9efede --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NativeChangeDetectionConfig.md @@ -0,0 +1,45 @@ +--- +id: v2024-native-change-detection-config +title: NativeChangeDetectionConfig +pagination_label: NativeChangeDetectionConfig +sidebar_label: NativeChangeDetectionConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NativeChangeDetectionConfig', 'V2024NativeChangeDetectionConfig'] +slug: /tools/sdk/powershell/v2024/models/native-change-detection-config +tags: ['SDK', 'Software Development Kit', 'NativeChangeDetectionConfig', 'V2024NativeChangeDetectionConfig'] +--- + + +# NativeChangeDetectionConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **Boolean** | A flag indicating if Native Change Detection is enabled for a source. | [optional] [default to $false] +**Operations** | Pointer to **[]String** | Operation types for which Native Change Detection is enabled for a source. | [optional] +**AllEntitlements** | Pointer to **Boolean** | A flag indicating that all entitlements participate in Native Change Detection. | [optional] [default to $false] +**AllNonEntitlementAttributes** | Pointer to **Boolean** | A flag indicating that all non-entitlement account attributes participate in Native Change Detection. | [optional] [default to $false] +**SelectedEntitlements** | Pointer to **[]String** | If allEntitlements flag is off this field lists entitlements that participate in Native Change Detection. | [optional] +**SelectedNonEntitlementAttributes** | Pointer to **[]String** | If allNonEntitlementAttributes flag is off this field lists non-entitlement account attributes that participate in Native Change Detection. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NativeChangeDetectionConfig = Initialize-PSSailpoint.V2024NativeChangeDetectionConfig -Enabled true ` + -Operations [ACCOUNT_UPDATED, ACCOUNT_DELETED] ` + -AllEntitlements false ` + -AllNonEntitlementAttributes false ` + -SelectedEntitlements [memberOf, memberOfSharedMailbox] ` + -SelectedNonEntitlementAttributes [lastName, phoneNumber, objectType, servicePrincipalName] +``` + +- Convert the resource to JSON +```powershell +$NativeChangeDetectionConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NestedAggregation.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NestedAggregation.md new file mode 100644 index 000000000..59d5a7958 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NestedAggregation.md @@ -0,0 +1,37 @@ +--- +id: v2024-nested-aggregation +title: NestedAggregation +pagination_label: NestedAggregation +sidebar_label: NestedAggregation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NestedAggregation', 'V2024NestedAggregation'] +slug: /tools/sdk/powershell/v2024/models/nested-aggregation +tags: ['SDK', 'Software Development Kit', 'NestedAggregation', 'V2024NestedAggregation'] +--- + + +# NestedAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | The name of the nested aggregate to be included in the result. | [required] +**Type** | **String** | The type of the nested object. | [required] + +## Examples + +- Prepare the resource +```powershell +$NestedAggregation = Initialize-PSSailpoint.V2024NestedAggregation -Name id ` + -Type access +``` + +- Convert the resource to JSON +```powershell +$NestedAggregation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NetworkConfiguration.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NetworkConfiguration.md new file mode 100644 index 000000000..02913ac43 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NetworkConfiguration.md @@ -0,0 +1,39 @@ +--- +id: v2024-network-configuration +title: NetworkConfiguration +pagination_label: NetworkConfiguration +sidebar_label: NetworkConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NetworkConfiguration', 'V2024NetworkConfiguration'] +slug: /tools/sdk/powershell/v2024/models/network-configuration +tags: ['SDK', 'Software Development Kit', 'NetworkConfiguration', 'V2024NetworkConfiguration'] +--- + + +# NetworkConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Range** | Pointer to **[]String** | The collection of ip ranges. | [optional] +**Geolocation** | Pointer to **[]String** | The collection of country codes. | [optional] +**Whitelisted** | Pointer to **Boolean** | Denotes whether the provided lists are whitelisted or blacklisted for geo location. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$NetworkConfiguration = Initialize-PSSailpoint.V2024NetworkConfiguration -Range [1.3.7.2, 255.255.255.252/30] ` + -Geolocation [CA, FR, HT] ` + -Whitelisted true +``` + +- Convert the resource to JSON +```powershell +$NetworkConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeApprovalDecision.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeApprovalDecision.md new file mode 100644 index 000000000..a2ee79601 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeApprovalDecision.md @@ -0,0 +1,35 @@ +--- +id: v2024-non-employee-approval-decision +title: NonEmployeeApprovalDecision +pagination_label: NonEmployeeApprovalDecision +sidebar_label: NonEmployeeApprovalDecision +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalDecision', 'V2024NonEmployeeApprovalDecision'] +slug: /tools/sdk/powershell/v2024/models/non-employee-approval-decision +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalDecision', 'V2024NonEmployeeApprovalDecision'] +--- + + +# NonEmployeeApprovalDecision + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment on the approval item. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeApprovalDecision = Initialize-PSSailpoint.V2024NonEmployeeApprovalDecision -Comment Approved by manager +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeApprovalDecision | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeApprovalItem.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeApprovalItem.md new file mode 100644 index 000000000..2b03e0e23 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeApprovalItem.md @@ -0,0 +1,51 @@ +--- +id: v2024-non-employee-approval-item +title: NonEmployeeApprovalItem +pagination_label: NonEmployeeApprovalItem +sidebar_label: NonEmployeeApprovalItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalItem', 'V2024NonEmployeeApprovalItem'] +slug: /tools/sdk/powershell/v2024/models/non-employee-approval-item +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItem', 'V2024NonEmployeeApprovalItem'] +--- + + +# NonEmployeeApprovalItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee approval item id | [optional] +**Approver** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **String** | Requested identity account name | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**ApprovalOrder** | Pointer to **Double** | Approval order | [optional] +**Comment** | Pointer to **String** | comment of approver | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] +**NonEmployeeRequest** | Pointer to [**NonEmployeeRequestLite**](non-employee-request-lite) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeApprovalItem = Initialize-PSSailpoint.V2024NonEmployeeApprovalItem -Id 2c1e388b-1e55-4b0a-ab5c-897f1204159c ` + -Approver null ` + -AccountName test.account ` + -ApprovalStatus null ` + -ApprovalOrder 1 ` + -Comment I approve ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z ` + -NonEmployeeRequest null +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeApprovalItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeApprovalItemBase.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeApprovalItemBase.md new file mode 100644 index 000000000..be7cf0293 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeApprovalItemBase.md @@ -0,0 +1,49 @@ +--- +id: v2024-non-employee-approval-item-base +title: NonEmployeeApprovalItemBase +pagination_label: NonEmployeeApprovalItemBase +sidebar_label: NonEmployeeApprovalItemBase +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalItemBase', 'V2024NonEmployeeApprovalItemBase'] +slug: /tools/sdk/powershell/v2024/models/non-employee-approval-item-base +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItemBase', 'V2024NonEmployeeApprovalItemBase'] +--- + + +# NonEmployeeApprovalItemBase + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee approval item id | [optional] +**Approver** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **String** | Requested identity account name | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**ApprovalOrder** | Pointer to **Double** | Approval order | [optional] +**Comment** | Pointer to **String** | comment of approver | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeApprovalItemBase = Initialize-PSSailpoint.V2024NonEmployeeApprovalItemBase -Id 2c1e388b-1e55-4b0a-ab5c-897f1204159c ` + -Approver null ` + -AccountName test.account ` + -ApprovalStatus null ` + -ApprovalOrder 1 ` + -Comment I approve ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeApprovalItemBase | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeApprovalItemDetail.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeApprovalItemDetail.md new file mode 100644 index 000000000..86a5c776f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeApprovalItemDetail.md @@ -0,0 +1,51 @@ +--- +id: v2024-non-employee-approval-item-detail +title: NonEmployeeApprovalItemDetail +pagination_label: NonEmployeeApprovalItemDetail +sidebar_label: NonEmployeeApprovalItemDetail +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalItemDetail', 'V2024NonEmployeeApprovalItemDetail'] +slug: /tools/sdk/powershell/v2024/models/non-employee-approval-item-detail +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItemDetail', 'V2024NonEmployeeApprovalItemDetail'] +--- + + +# NonEmployeeApprovalItemDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee approval item id | [optional] +**Approver** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **String** | Requested identity account name | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**ApprovalOrder** | Pointer to **Double** | Approval order | [optional] +**Comment** | Pointer to **String** | comment of approver | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] +**NonEmployeeRequest** | Pointer to [**NonEmployeeRequestWithoutApprovalItem**](non-employee-request-without-approval-item) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeApprovalItemDetail = Initialize-PSSailpoint.V2024NonEmployeeApprovalItemDetail -Id 2c1e388b-1e55-4b0a-ab5c-897f1204159c ` + -Approver null ` + -AccountName test.account ` + -ApprovalStatus null ` + -ApprovalOrder 1 ` + -Comment I approve ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z ` + -NonEmployeeRequest null +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeApprovalItemDetail | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeApprovalSummary.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeApprovalSummary.md new file mode 100644 index 000000000..ac2a6b11d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeApprovalSummary.md @@ -0,0 +1,39 @@ +--- +id: v2024-non-employee-approval-summary +title: NonEmployeeApprovalSummary +pagination_label: NonEmployeeApprovalSummary +sidebar_label: NonEmployeeApprovalSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalSummary', 'V2024NonEmployeeApprovalSummary'] +slug: /tools/sdk/powershell/v2024/models/non-employee-approval-summary +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalSummary', 'V2024NonEmployeeApprovalSummary'] +--- + + +# NonEmployeeApprovalSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Approved** | Pointer to **Int32** | The number of approved non-employee approval requests. | [optional] +**Pending** | Pointer to **Int32** | The number of pending non-employee approval requests. | [optional] +**Rejected** | Pointer to **Int32** | The number of rejected non-employee approval requests. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeApprovalSummary = Initialize-PSSailpoint.V2024NonEmployeeApprovalSummary -Approved 2 ` + -Pending 2 ` + -Rejected 2 +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeApprovalSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeBulkUploadJob.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeBulkUploadJob.md new file mode 100644 index 000000000..2a5308261 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeBulkUploadJob.md @@ -0,0 +1,43 @@ +--- +id: v2024-non-employee-bulk-upload-job +title: NonEmployeeBulkUploadJob +pagination_label: NonEmployeeBulkUploadJob +sidebar_label: NonEmployeeBulkUploadJob +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeBulkUploadJob', 'V2024NonEmployeeBulkUploadJob'] +slug: /tools/sdk/powershell/v2024/models/non-employee-bulk-upload-job +tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadJob', 'V2024NonEmployeeBulkUploadJob'] +--- + + +# NonEmployeeBulkUploadJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The bulk upload job's ID. (UUID) | [optional] +**SourceId** | Pointer to **String** | The ID of the source to bulk-upload non-employees to. (UUID) | [optional] +**Created** | Pointer to **System.DateTime** | The date-time the job was submitted. | [optional] +**Modified** | Pointer to **System.DateTime** | The date-time that the job was last updated. | [optional] +**Status** | Pointer to **Enum** [ "PENDING", "IN_PROGRESS", "COMPLETED", "ERROR" ] | Returns the following values indicating the progress or result of the bulk upload job. ""PENDING"" means the job is queued and waiting to be processed. ""IN_PROGRESS"" means the job is currently being processed. ""COMPLETED"" means the job has been completed without any errors. ""ERROR"" means the job failed to process with errors. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeBulkUploadJob = Initialize-PSSailpoint.V2024NonEmployeeBulkUploadJob -Id 2c91808568c529c60168cca6f90cffff ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -Created 2019-08-23T18:52:59.162Z ` + -Modified 2019-08-23T18:52:59.162Z ` + -Status PENDING +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeBulkUploadJob | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeBulkUploadStatus.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeBulkUploadStatus.md new file mode 100644 index 000000000..56ce38b60 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeBulkUploadStatus.md @@ -0,0 +1,35 @@ +--- +id: v2024-non-employee-bulk-upload-status +title: NonEmployeeBulkUploadStatus +pagination_label: NonEmployeeBulkUploadStatus +sidebar_label: NonEmployeeBulkUploadStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeBulkUploadStatus', 'V2024NonEmployeeBulkUploadStatus'] +slug: /tools/sdk/powershell/v2024/models/non-employee-bulk-upload-status +tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadStatus', 'V2024NonEmployeeBulkUploadStatus'] +--- + + +# NonEmployeeBulkUploadStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **Enum** [ "PENDING", "IN_PROGRESS", "COMPLETED", "ERROR" ] | Returns the following values indicating the progress or result of the bulk upload job. ""PENDING"" means the job is queued and waiting to be processed. ""IN_PROGRESS"" means the job is currently being processed. ""COMPLETED"" means the job has been completed without any errors. ""ERROR"" means the job failed to process with errors. null means job has been submitted to the source. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeBulkUploadStatus = Initialize-PSSailpoint.V2024NonEmployeeBulkUploadStatus -Status PENDING +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeBulkUploadStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeIdentityDtoType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeIdentityDtoType.md new file mode 100644 index 000000000..d7e1b1798 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeIdentityDtoType.md @@ -0,0 +1,24 @@ +--- +id: v2024-non-employee-identity-dto-type +title: NonEmployeeIdentityDtoType +pagination_label: NonEmployeeIdentityDtoType +sidebar_label: NonEmployeeIdentityDtoType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeIdentityDtoType', 'V2024NonEmployeeIdentityDtoType'] +slug: /tools/sdk/powershell/v2024/models/non-employee-identity-dto-type +tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdentityDtoType', 'V2024NonEmployeeIdentityDtoType'] +--- + + +# NonEmployeeIdentityDtoType + +## Enum + + +* `GOVERNANCE_GROUP` (value: `"GOVERNANCE_GROUP"`) + +* `IDENTITY` (value: `"IDENTITY"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeIdentityReferenceWithId.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeIdentityReferenceWithId.md new file mode 100644 index 000000000..10688bd81 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeIdentityReferenceWithId.md @@ -0,0 +1,37 @@ +--- +id: v2024-non-employee-identity-reference-with-id +title: NonEmployeeIdentityReferenceWithId +pagination_label: NonEmployeeIdentityReferenceWithId +sidebar_label: NonEmployeeIdentityReferenceWithId +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeIdentityReferenceWithId', 'V2024NonEmployeeIdentityReferenceWithId'] +slug: /tools/sdk/powershell/v2024/models/non-employee-identity-reference-with-id +tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdentityReferenceWithId', 'V2024NonEmployeeIdentityReferenceWithId'] +--- + + +# NonEmployeeIdentityReferenceWithId + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**NonEmployeeIdentityDtoType**](non-employee-identity-dto-type) | | [optional] +**Id** | Pointer to **String** | Identity id | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeIdentityReferenceWithId = Initialize-PSSailpoint.V2024NonEmployeeIdentityReferenceWithId -Type null ` + -Id 5168015d32f890ca15812c9180835d2e +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeIdentityReferenceWithId | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeIdnUserRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeIdnUserRequest.md new file mode 100644 index 000000000..d58dfc05e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeIdnUserRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-non-employee-idn-user-request +title: NonEmployeeIdnUserRequest +pagination_label: NonEmployeeIdnUserRequest +sidebar_label: NonEmployeeIdnUserRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeIdnUserRequest', 'V2024NonEmployeeIdnUserRequest'] +slug: /tools/sdk/powershell/v2024/models/non-employee-idn-user-request +tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdnUserRequest', 'V2024NonEmployeeIdnUserRequest'] +--- + + +# NonEmployeeIdnUserRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Identity id. | [required] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeIdnUserRequest = Initialize-PSSailpoint.V2024NonEmployeeIdnUserRequest -Id 2c91808570313110017040b06f344ec9 +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeIdnUserRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeRecord.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeRecord.md new file mode 100644 index 000000000..49a05c045 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeRecord.md @@ -0,0 +1,59 @@ +--- +id: v2024-non-employee-record +title: NonEmployeeRecord +pagination_label: NonEmployeeRecord +sidebar_label: NonEmployeeRecord +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRecord', 'V2024NonEmployeeRecord'] +slug: /tools/sdk/powershell/v2024/models/non-employee-record +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRecord', 'V2024NonEmployeeRecord'] +--- + + +# NonEmployeeRecord + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee record id. | [optional] +**AccountName** | Pointer to **String** | Requested identity account name. | [optional] +**FirstName** | Pointer to **String** | Non-Employee's first name. | [optional] +**LastName** | Pointer to **String** | Non-Employee's last name. | [optional] +**Email** | Pointer to **String** | Non-Employee's email. | [optional] +**Phone** | Pointer to **String** | Non-Employee's phone. | [optional] +**Manager** | Pointer to **String** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**SourceId** | Pointer to **String** | Non-Employee's source id. | [optional] +**VarData** | Pointer to **map[string]String** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**StartDate** | Pointer to **System.DateTime** | Non-Employee employment start date. | [optional] +**EndDate** | Pointer to **System.DateTime** | Non-Employee employment end date. | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeRecord = Initialize-PSSailpoint.V2024NonEmployeeRecord -Id ef38f94347e94562b5bb8424a56397d8 ` + -AccountName Abby.Smith ` + -FirstName William ` + -LastName Smith ` + -Email william.smith@example.com ` + -Phone 5125555555 ` + -Manager jane.doe ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -VarData {description=Auditing} ` + -StartDate 2019-08-23T18:52:59.162Z ` + -EndDate 2020-08-23T18:52:59.162Z ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeRecord | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeRejectApprovalDecision.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeRejectApprovalDecision.md new file mode 100644 index 000000000..fe6a2807a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeRejectApprovalDecision.md @@ -0,0 +1,35 @@ +--- +id: v2024-non-employee-reject-approval-decision +title: NonEmployeeRejectApprovalDecision +pagination_label: NonEmployeeRejectApprovalDecision +sidebar_label: NonEmployeeRejectApprovalDecision +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRejectApprovalDecision', 'V2024NonEmployeeRejectApprovalDecision'] +slug: /tools/sdk/powershell/v2024/models/non-employee-reject-approval-decision +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRejectApprovalDecision', 'V2024NonEmployeeRejectApprovalDecision'] +--- + + +# NonEmployeeRejectApprovalDecision + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | **String** | Comment on the approval item. | [required] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeRejectApprovalDecision = Initialize-PSSailpoint.V2024NonEmployeeRejectApprovalDecision -Comment approved +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeRejectApprovalDecision | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeRequest.md new file mode 100644 index 000000000..df1de6788 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeRequest.md @@ -0,0 +1,73 @@ +--- +id: v2024-non-employee-request +title: NonEmployeeRequest +pagination_label: NonEmployeeRequest +sidebar_label: NonEmployeeRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequest', 'V2024NonEmployeeRequest'] +slug: /tools/sdk/powershell/v2024/models/non-employee-request +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequest', 'V2024NonEmployeeRequest'] +--- + + +# NonEmployeeRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] +**AccountName** | Pointer to **String** | Requested identity account name. | [optional] +**FirstName** | Pointer to **String** | Non-Employee's first name. | [optional] +**LastName** | Pointer to **String** | Non-Employee's last name. | [optional] +**Email** | Pointer to **String** | Non-Employee's email. | [optional] +**Phone** | Pointer to **String** | Non-Employee's phone. | [optional] +**Manager** | Pointer to **String** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**NonEmployeeSource** | Pointer to [**NonEmployeeSourceLite**](non-employee-source-lite) | | [optional] +**VarData** | Pointer to **map[string]String** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**ApprovalItems** | Pointer to [**[]NonEmployeeApprovalItemBase**](non-employee-approval-item-base) | List of approval item for the request | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**Comment** | Pointer to **String** | Comment of requester | [optional] +**CompletionDate** | Pointer to **System.DateTime** | When the request was completely approved. | [optional] +**StartDate** | Pointer to **System.DateTime** | Non-Employee employment start date. | [optional] +**EndDate** | Pointer to **System.DateTime** | Non-Employee employment end date. | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeRequest = Initialize-PSSailpoint.V2024NonEmployeeRequest -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -Name Retail ` + -Description Source description ` + -AccountName william.smith ` + -FirstName William ` + -LastName Smith ` + -Email william.smith@example.com ` + -Phone 5125555555 ` + -Manager jane.doe ` + -NonEmployeeSource null ` + -VarData {description=Auditing} ` + -ApprovalItems null ` + -ApprovalStatus null ` + -Comment approved ` + -CompletionDate 2020-03-24T11:11:41.139-05:00 ` + -StartDate 2020-03-24T00:00-05:00 ` + -EndDate 2021-03-25T00:00-05:00 ` + -Modified 2020-03-24T11:11:41.139-05:00 ` + -Created 2020-03-24T11:11:41.139-05:00 +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeRequestBody.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeRequestBody.md new file mode 100644 index 000000000..b7381588f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeRequestBody.md @@ -0,0 +1,53 @@ +--- +id: v2024-non-employee-request-body +title: NonEmployeeRequestBody +pagination_label: NonEmployeeRequestBody +sidebar_label: NonEmployeeRequestBody +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequestBody', 'V2024NonEmployeeRequestBody'] +slug: /tools/sdk/powershell/v2024/models/non-employee-request-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestBody', 'V2024NonEmployeeRequestBody'] +--- + + +# NonEmployeeRequestBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountName** | **String** | Requested identity account name. | [required] +**FirstName** | **String** | Non-Employee's first name. | [required] +**LastName** | **String** | Non-Employee's last name. | [required] +**Email** | **String** | Non-Employee's email. | [required] +**Phone** | **String** | Non-Employee's phone. | [required] +**Manager** | **String** | The account ID of a valid identity to serve as this non-employee's manager. | [required] +**SourceId** | **String** | Non-Employee's source id. | [required] +**VarData** | Pointer to **map[string]String** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**StartDate** | **System.DateTime** | Non-Employee employment start date. | [required] +**EndDate** | **System.DateTime** | Non-Employee employment end date. | [required] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeRequestBody = Initialize-PSSailpoint.V2024NonEmployeeRequestBody -AccountName william.smith ` + -FirstName William ` + -LastName Smith ` + -Email william.smith@example.com ` + -Phone 5125555555 ` + -Manager jane.doe ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -VarData {description=Auditing} ` + -StartDate 2020-03-24T00:00-05:00 ` + -EndDate 2021-03-25T00:00-05:00 +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeRequestBody | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeRequestLite.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeRequestLite.md new file mode 100644 index 000000000..3fde7a692 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeRequestLite.md @@ -0,0 +1,37 @@ +--- +id: v2024-non-employee-request-lite +title: NonEmployeeRequestLite +pagination_label: NonEmployeeRequestLite +sidebar_label: NonEmployeeRequestLite +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequestLite', 'V2024NonEmployeeRequestLite'] +slug: /tools/sdk/powershell/v2024/models/non-employee-request-lite +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestLite', 'V2024NonEmployeeRequestLite'] +--- + + +# NonEmployeeRequestLite + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee request id. | [optional] +**Requester** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeRequestLite = Initialize-PSSailpoint.V2024NonEmployeeRequestLite -Id ac110005-7156-1150-8171-5b292e3e0084 ` + -Requester null +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeRequestLite | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeRequestSummary.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeRequestSummary.md new file mode 100644 index 000000000..097db83ff --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeRequestSummary.md @@ -0,0 +1,41 @@ +--- +id: v2024-non-employee-request-summary +title: NonEmployeeRequestSummary +pagination_label: NonEmployeeRequestSummary +sidebar_label: NonEmployeeRequestSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequestSummary', 'V2024NonEmployeeRequestSummary'] +slug: /tools/sdk/powershell/v2024/models/non-employee-request-summary +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestSummary', 'V2024NonEmployeeRequestSummary'] +--- + + +# NonEmployeeRequestSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Approved** | Pointer to **Int32** | The number of approved non-employee requests on all sources that *requested-for* user manages. | [optional] +**Rejected** | Pointer to **Int32** | The number of rejected non-employee requests on all sources that *requested-for* user manages. | [optional] +**Pending** | Pointer to **Int32** | The number of pending non-employee requests on all sources that *requested-for* user manages. | [optional] +**NonEmployeeCount** | Pointer to **Int32** | The number of non-employee records on all sources that *requested-for* user manages. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeRequestSummary = Initialize-PSSailpoint.V2024NonEmployeeRequestSummary -Approved 2 ` + -Rejected 2 ` + -Pending 2 ` + -NonEmployeeCount 2 +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeRequestSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeRequestWithoutApprovalItem.md new file mode 100644 index 000000000..cedadd7d4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -0,0 +1,67 @@ +--- +id: v2024-non-employee-request-without-approval-item +title: NonEmployeeRequestWithoutApprovalItem +pagination_label: NonEmployeeRequestWithoutApprovalItem +sidebar_label: NonEmployeeRequestWithoutApprovalItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequestWithoutApprovalItem', 'V2024NonEmployeeRequestWithoutApprovalItem'] +slug: /tools/sdk/powershell/v2024/models/non-employee-request-without-approval-item +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestWithoutApprovalItem', 'V2024NonEmployeeRequestWithoutApprovalItem'] +--- + + +# NonEmployeeRequestWithoutApprovalItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee request id. | [optional] +**Requester** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **String** | Requested identity account name. | [optional] +**FirstName** | Pointer to **String** | Non-Employee's first name. | [optional] +**LastName** | Pointer to **String** | Non-Employee's last name. | [optional] +**Email** | Pointer to **String** | Non-Employee's email. | [optional] +**Phone** | Pointer to **String** | Non-Employee's phone. | [optional] +**Manager** | Pointer to **String** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**NonEmployeeSource** | Pointer to [**NonEmployeeSourceLiteWithSchemaAttributes**](non-employee-source-lite-with-schema-attributes) | | [optional] +**VarData** | Pointer to **map[string]String** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**Comment** | Pointer to **String** | Comment of requester | [optional] +**CompletionDate** | Pointer to **System.DateTime** | When the request was completely approved. | [optional] +**StartDate** | Pointer to **System.DateTime** | Non-Employee employment start date. | [optional] +**EndDate** | Pointer to **System.DateTime** | Non-Employee employment end date. | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V2024NonEmployeeRequestWithoutApprovalItem -Id ac110005-7156-1150-8171-5b292e3e0084 ` + -Requester null ` + -AccountName william.smith ` + -FirstName William ` + -LastName Smith ` + -Email william.smith@example.com ` + -Phone 5125555555 ` + -Manager jane.doe ` + -NonEmployeeSource null ` + -VarData {description=Auditing} ` + -ApprovalStatus null ` + -Comment approved ` + -CompletionDate 2020-03-24T11:11:41.139-05:00 ` + -StartDate Mon Mar 23 20:00:00 EDT 2020 ` + -EndDate Wed Mar 24 20:00:00 EDT 2021 ` + -Modified 2020-03-24T11:11:41.139-05:00 ` + -Created 2020-03-24T11:11:41.139-05:00 +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeRequestWithoutApprovalItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSchemaAttribute.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSchemaAttribute.md new file mode 100644 index 000000000..612af698b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSchemaAttribute.md @@ -0,0 +1,53 @@ +--- +id: v2024-non-employee-schema-attribute +title: NonEmployeeSchemaAttribute +pagination_label: NonEmployeeSchemaAttribute +sidebar_label: NonEmployeeSchemaAttribute +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSchemaAttribute', 'V2024NonEmployeeSchemaAttribute'] +slug: /tools/sdk/powershell/v2024/models/non-employee-schema-attribute +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttribute', 'V2024NonEmployeeSchemaAttribute'] +--- + + +# NonEmployeeSchemaAttribute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Schema Attribute Id | [optional] +**System** | Pointer to **Boolean** | True if this schema attribute is mandatory on all non-employees sources. | [optional] [default to $false] +**Modified** | Pointer to **System.DateTime** | When the schema attribute was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the schema attribute was created. | [optional] +**Type** | [**NonEmployeeSchemaAttributeType**](non-employee-schema-attribute-type) | | [required] +**Label** | **String** | Label displayed on the UI for this schema attribute. | [required] +**TechnicalName** | **String** | The technical name of the attribute. Must be unique per source. | [required] +**HelpText** | Pointer to **String** | help text displayed by UI. | [optional] +**Placeholder** | Pointer to **String** | Hint text that fills UI box. | [optional] +**Required** | Pointer to **Boolean** | If true, the schema attribute is required for all non-employees in the source | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeSchemaAttribute = Initialize-PSSailpoint.V2024NonEmployeeSchemaAttribute -Id ac110005-7156-1150-8171-5b292e3e0084 ` + -System true ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z ` + -Type null ` + -Label Account Name ` + -TechnicalName account.name ` + -HelpText The unique identifier for the account ` + -Placeholder Enter a unique user name for this account. ` + -Required true +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeSchemaAttribute | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSchemaAttributeBody.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSchemaAttributeBody.md new file mode 100644 index 000000000..e220fddba --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSchemaAttributeBody.md @@ -0,0 +1,45 @@ +--- +id: v2024-non-employee-schema-attribute-body +title: NonEmployeeSchemaAttributeBody +pagination_label: NonEmployeeSchemaAttributeBody +sidebar_label: NonEmployeeSchemaAttributeBody +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSchemaAttributeBody', 'V2024NonEmployeeSchemaAttributeBody'] +slug: /tools/sdk/powershell/v2024/models/non-employee-schema-attribute-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeBody', 'V2024NonEmployeeSchemaAttributeBody'] +--- + + +# NonEmployeeSchemaAttributeBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **String** | Type of the attribute. Only type 'TEXT' is supported for custom attributes. | [required] +**Label** | **String** | Label displayed on the UI for this schema attribute. | [required] +**TechnicalName** | **String** | The technical name of the attribute. Must be unique per source. | [required] +**HelpText** | Pointer to **String** | help text displayed by UI. | [optional] +**Placeholder** | Pointer to **String** | Hint text that fills UI box. | [optional] +**Required** | Pointer to **Boolean** | If true, the schema attribute is required for all non-employees in the source | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeSchemaAttributeBody = Initialize-PSSailpoint.V2024NonEmployeeSchemaAttributeBody -Type TEXT ` + -Label Account Name ` + -TechnicalName account.name ` + -HelpText The unique identifier for the account ` + -Placeholder Enter a unique user name for this account. ` + -Required true +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeSchemaAttributeBody | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSchemaAttributeType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSchemaAttributeType.md new file mode 100644 index 000000000..2d2e3bf0c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSchemaAttributeType.md @@ -0,0 +1,26 @@ +--- +id: v2024-non-employee-schema-attribute-type +title: NonEmployeeSchemaAttributeType +pagination_label: NonEmployeeSchemaAttributeType +sidebar_label: NonEmployeeSchemaAttributeType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSchemaAttributeType', 'V2024NonEmployeeSchemaAttributeType'] +slug: /tools/sdk/powershell/v2024/models/non-employee-schema-attribute-type +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeType', 'V2024NonEmployeeSchemaAttributeType'] +--- + + +# NonEmployeeSchemaAttributeType + +## Enum + + +* `TEXT` (value: `"TEXT"`) + +* `DATE` (value: `"DATE"`) + +* `IDENTITY` (value: `"IDENTITY"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSource.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSource.md new file mode 100644 index 000000000..aa6335e26 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSource.md @@ -0,0 +1,49 @@ +--- +id: v2024-non-employee-source +title: NonEmployeeSource +pagination_label: NonEmployeeSource +sidebar_label: NonEmployeeSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSource', 'V2024NonEmployeeSource'] +slug: /tools/sdk/powershell/v2024/models/non-employee-source +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSource', 'V2024NonEmployeeSource'] +--- + + +# NonEmployeeSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] +**Approvers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of approvers | [optional] +**AccountManagers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeSource = Initialize-PSSailpoint.V2024NonEmployeeSource -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -Name Retail ` + -Description Source description ` + -Approvers null ` + -AccountManagers null ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSourceLite.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSourceLite.md new file mode 100644 index 000000000..3046a5e77 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSourceLite.md @@ -0,0 +1,41 @@ +--- +id: v2024-non-employee-source-lite +title: NonEmployeeSourceLite +pagination_label: NonEmployeeSourceLite +sidebar_label: NonEmployeeSourceLite +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceLite', 'V2024NonEmployeeSourceLite'] +slug: /tools/sdk/powershell/v2024/models/non-employee-source-lite +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceLite', 'V2024NonEmployeeSourceLite'] +--- + + +# NonEmployeeSourceLite + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeSourceLite = Initialize-PSSailpoint.V2024NonEmployeeSourceLite -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -Name Retail ` + -Description Source description +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeSourceLite | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSourceLiteWithSchemaAttributes.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSourceLiteWithSchemaAttributes.md new file mode 100644 index 000000000..6d03f6031 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSourceLiteWithSchemaAttributes.md @@ -0,0 +1,43 @@ +--- +id: v2024-non-employee-source-lite-with-schema-attributes +title: NonEmployeeSourceLiteWithSchemaAttributes +pagination_label: NonEmployeeSourceLiteWithSchemaAttributes +sidebar_label: NonEmployeeSourceLiteWithSchemaAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceLiteWithSchemaAttributes', 'V2024NonEmployeeSourceLiteWithSchemaAttributes'] +slug: /tools/sdk/powershell/v2024/models/non-employee-source-lite-with-schema-attributes +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceLiteWithSchemaAttributes', 'V2024NonEmployeeSourceLiteWithSchemaAttributes'] +--- + + +# NonEmployeeSourceLiteWithSchemaAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] +**SchemaAttributes** | Pointer to [**[]NonEmployeeSchemaAttribute**](non-employee-schema-attribute) | List of schema attributes associated with this non-employee source. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeSourceLiteWithSchemaAttributes = Initialize-PSSailpoint.V2024NonEmployeeSourceLiteWithSchemaAttributes -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -Name Retail ` + -Description Source description ` + -SchemaAttributes null +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeSourceLiteWithSchemaAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSourceRequestBody.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSourceRequestBody.md new file mode 100644 index 000000000..155dfd7fe --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSourceRequestBody.md @@ -0,0 +1,45 @@ +--- +id: v2024-non-employee-source-request-body +title: NonEmployeeSourceRequestBody +pagination_label: NonEmployeeSourceRequestBody +sidebar_label: NonEmployeeSourceRequestBody +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceRequestBody', 'V2024NonEmployeeSourceRequestBody'] +slug: /tools/sdk/powershell/v2024/models/non-employee-source-request-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceRequestBody', 'V2024NonEmployeeSourceRequestBody'] +--- + + +# NonEmployeeSourceRequestBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Name of non-employee source. | [required] +**Description** | **String** | Description of non-employee source. | [required] +**Owner** | [**NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | | [required] +**ManagementWorkgroup** | Pointer to **String** | The ID for the management workgroup that contains source sub-admins | [optional] +**Approvers** | Pointer to [**[]NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | List of approvers. | [optional] +**AccountManagers** | Pointer to [**[]NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | List of account managers. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeSourceRequestBody = Initialize-PSSailpoint.V2024NonEmployeeSourceRequestBody -Name Retail ` + -Description Source description ` + -Owner null ` + -ManagementWorkgroup 123299 ` + -Approvers null ` + -AccountManagers null +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeSourceRequestBody | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSourceWithCloudExternalId.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSourceWithCloudExternalId.md new file mode 100644 index 000000000..72ed0f9f0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSourceWithCloudExternalId.md @@ -0,0 +1,51 @@ +--- +id: v2024-non-employee-source-with-cloud-external-id +title: NonEmployeeSourceWithCloudExternalId +pagination_label: NonEmployeeSourceWithCloudExternalId +sidebar_label: NonEmployeeSourceWithCloudExternalId +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceWithCloudExternalId', 'V2024NonEmployeeSourceWithCloudExternalId'] +slug: /tools/sdk/powershell/v2024/models/non-employee-source-with-cloud-external-id +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceWithCloudExternalId', 'V2024NonEmployeeSourceWithCloudExternalId'] +--- + + +# NonEmployeeSourceWithCloudExternalId + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] +**Approvers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of approvers | [optional] +**AccountManagers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] +**CloudExternalId** | Pointer to **String** | Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeSourceWithCloudExternalId = Initialize-PSSailpoint.V2024NonEmployeeSourceWithCloudExternalId -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -Name Retail ` + -Description Source description ` + -Approvers null ` + -AccountManagers null ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z ` + -CloudExternalId 99999 +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeSourceWithCloudExternalId | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSourceWithNECount.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSourceWithNECount.md new file mode 100644 index 000000000..4b4a8d38a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NonEmployeeSourceWithNECount.md @@ -0,0 +1,51 @@ +--- +id: v2024-non-employee-source-with-ne-count +title: NonEmployeeSourceWithNECount +pagination_label: NonEmployeeSourceWithNECount +sidebar_label: NonEmployeeSourceWithNECount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceWithNECount', 'V2024NonEmployeeSourceWithNECount'] +slug: /tools/sdk/powershell/v2024/models/non-employee-source-with-ne-count +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceWithNECount', 'V2024NonEmployeeSourceWithNECount'] +--- + + +# NonEmployeeSourceWithNECount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] +**Approvers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of approvers | [optional] +**AccountManagers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] +**NonEmployeeCount** | Pointer to **Int32** | Number of non-employee records associated with this source. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeSourceWithNECount = Initialize-PSSailpoint.V2024NonEmployeeSourceWithNECount -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -Name Retail ` + -Description Source description ` + -Approvers null ` + -AccountManagers null ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z ` + -NonEmployeeCount 120 +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeSourceWithNECount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NotificationTemplateContext.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NotificationTemplateContext.md new file mode 100644 index 000000000..f05cc34ce --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/NotificationTemplateContext.md @@ -0,0 +1,39 @@ +--- +id: v2024-notification-template-context +title: NotificationTemplateContext +pagination_label: NotificationTemplateContext +sidebar_label: NotificationTemplateContext +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NotificationTemplateContext', 'V2024NotificationTemplateContext'] +slug: /tools/sdk/powershell/v2024/models/notification-template-context +tags: ['SDK', 'Software Development Kit', 'NotificationTemplateContext', 'V2024NotificationTemplateContext'] +--- + + +# NotificationTemplateContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A JSON object that stores the context. | [optional] +**Created** | Pointer to **System.DateTime** | When the global context was created | [optional] +**Modified** | Pointer to **System.DateTime** | When the global context was last modified | [optional] + +## Examples + +- Prepare the resource +```powershell +$NotificationTemplateContext = Initialize-PSSailpoint.V2024NotificationTemplateContext -Attributes {productUrl=https://test-org.identitysoon.com, brandingConfigs={default={narrowLogoURL=null, productName=SailPoint, standardLogoURL=null, navigationColor=011E64, actionButtonColor=20B2DE, emailFromAddress=null, activeLinkColor=20B2DE, loginInformationalMessage=null}}} ` + -Created 2020-04-15T16:16:47.525Z ` + -Modified 2020-04-15T16:16:47.525Z +``` + +- Convert the resource to JSON +```powershell +$NotificationTemplateContext | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectExportImportNames.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectExportImportNames.md new file mode 100644 index 000000000..548517afb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectExportImportNames.md @@ -0,0 +1,35 @@ +--- +id: v2024-object-export-import-names +title: ObjectExportImportNames +pagination_label: ObjectExportImportNames +sidebar_label: ObjectExportImportNames +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectExportImportNames', 'V2024ObjectExportImportNames'] +slug: /tools/sdk/powershell/v2024/models/object-export-import-names +tags: ['SDK', 'Software Development Kit', 'ObjectExportImportNames', 'V2024ObjectExportImportNames'] +--- + + +# ObjectExportImportNames + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IncludedNames** | Pointer to **[]String** | Object names to be included in a backup. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ObjectExportImportNames = Initialize-PSSailpoint.V2024ObjectExportImportNames -IncludedNames null +``` + +- Convert the resource to JSON +```powershell +$ObjectExportImportNames | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectExportImportOptions.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectExportImportOptions.md new file mode 100644 index 000000000..3909f4635 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectExportImportOptions.md @@ -0,0 +1,37 @@ +--- +id: v2024-object-export-import-options +title: ObjectExportImportOptions +pagination_label: ObjectExportImportOptions +sidebar_label: ObjectExportImportOptions +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectExportImportOptions', 'V2024ObjectExportImportOptions'] +slug: /tools/sdk/powershell/v2024/models/object-export-import-options +tags: ['SDK', 'Software Development Kit', 'ObjectExportImportOptions', 'V2024ObjectExportImportOptions'] +--- + + +# ObjectExportImportOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IncludedIds** | Pointer to **[]String** | Object ids to be included in an import or export. | [optional] +**IncludedNames** | Pointer to **[]String** | Object names to be included in an import or export. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ObjectExportImportOptions = Initialize-PSSailpoint.V2024ObjectExportImportOptions -IncludedIds null ` + -IncludedNames null +``` + +- Convert the resource to JSON +```powershell +$ObjectExportImportOptions | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectImportResult.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectImportResult.md new file mode 100644 index 000000000..6022e78a6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectImportResult.md @@ -0,0 +1,41 @@ +--- +id: v2024-object-import-result +title: ObjectImportResult +pagination_label: ObjectImportResult +sidebar_label: ObjectImportResult +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectImportResult', 'V2024ObjectImportResult'] +slug: /tools/sdk/powershell/v2024/models/object-import-result +tags: ['SDK', 'Software Development Kit', 'ObjectImportResult', 'V2024ObjectImportResult'] +--- + + +# ObjectImportResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Infos** | [**[]SpConfigMessage**](sp-config-message) | Informational messages returned from the target service on import. | [required] +**Warnings** | [**[]SpConfigMessage**](sp-config-message) | Warning messages returned from the target service on import. | [required] +**Errors** | [**[]SpConfigMessage**](sp-config-message) | Error messages returned from the target service on import. | [required] +**ImportedObjects** | [**[]ImportObject**](import-object) | References to objects that were created or updated by the import. | [required] + +## Examples + +- Prepare the resource +```powershell +$ObjectImportResult = Initialize-PSSailpoint.V2024ObjectImportResult -Infos null ` + -Warnings null ` + -Errors null ` + -ImportedObjects null +``` + +- Convert the resource to JSON +```powershell +$ObjectImportResult | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectImportResult1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectImportResult1.md new file mode 100644 index 000000000..a0b34bb84 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectImportResult1.md @@ -0,0 +1,41 @@ +--- +id: v2024-object-import-result1 +title: ObjectImportResult1 +pagination_label: ObjectImportResult1 +sidebar_label: ObjectImportResult1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectImportResult1', 'V2024ObjectImportResult1'] +slug: /tools/sdk/powershell/v2024/models/object-import-result1 +tags: ['SDK', 'Software Development Kit', 'ObjectImportResult1', 'V2024ObjectImportResult1'] +--- + + +# ObjectImportResult1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Infos** | [**[]SpConfigMessage1**](sp-config-message1) | Informational messages returned from the target service on import. | [required] +**Warnings** | [**[]SpConfigMessage1**](sp-config-message1) | Warning messages returned from the target service on import. | [required] +**Errors** | [**[]SpConfigMessage1**](sp-config-message1) | Error messages returned from the target service on import. | [required] +**ImportedObjects** | [**[]ImportObject**](import-object) | References to objects that were created or updated by the import. | [required] + +## Examples + +- Prepare the resource +```powershell +$ObjectImportResult1 = Initialize-PSSailpoint.V2024ObjectImportResult1 -Infos null ` + -Warnings null ` + -Errors null ` + -ImportedObjects null +``` + +- Convert the resource to JSON +```powershell +$ObjectImportResult1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectMappingBulkCreateRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectMappingBulkCreateRequest.md new file mode 100644 index 000000000..2a9c23cb4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectMappingBulkCreateRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-object-mapping-bulk-create-request +title: ObjectMappingBulkCreateRequest +pagination_label: ObjectMappingBulkCreateRequest +sidebar_label: ObjectMappingBulkCreateRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectMappingBulkCreateRequest', 'V2024ObjectMappingBulkCreateRequest'] +slug: /tools/sdk/powershell/v2024/models/object-mapping-bulk-create-request +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkCreateRequest', 'V2024ObjectMappingBulkCreateRequest'] +--- + + +# ObjectMappingBulkCreateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NewObjectsMappings** | [**[]ObjectMappingRequest**](object-mapping-request) | | [required] + +## Examples + +- Prepare the resource +```powershell +$ObjectMappingBulkCreateRequest = Initialize-PSSailpoint.V2024ObjectMappingBulkCreateRequest -NewObjectsMappings null +``` + +- Convert the resource to JSON +```powershell +$ObjectMappingBulkCreateRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectMappingBulkCreateResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectMappingBulkCreateResponse.md new file mode 100644 index 000000000..ca2a3f194 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectMappingBulkCreateResponse.md @@ -0,0 +1,35 @@ +--- +id: v2024-object-mapping-bulk-create-response +title: ObjectMappingBulkCreateResponse +pagination_label: ObjectMappingBulkCreateResponse +sidebar_label: ObjectMappingBulkCreateResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectMappingBulkCreateResponse', 'V2024ObjectMappingBulkCreateResponse'] +slug: /tools/sdk/powershell/v2024/models/object-mapping-bulk-create-response +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkCreateResponse', 'V2024ObjectMappingBulkCreateResponse'] +--- + + +# ObjectMappingBulkCreateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AddedObjects** | Pointer to [**[]ObjectMappingResponse**](object-mapping-response) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ObjectMappingBulkCreateResponse = Initialize-PSSailpoint.V2024ObjectMappingBulkCreateResponse -AddedObjects null +``` + +- Convert the resource to JSON +```powershell +$ObjectMappingBulkCreateResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectMappingBulkPatchRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectMappingBulkPatchRequest.md new file mode 100644 index 000000000..6049f7180 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectMappingBulkPatchRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-object-mapping-bulk-patch-request +title: ObjectMappingBulkPatchRequest +pagination_label: ObjectMappingBulkPatchRequest +sidebar_label: ObjectMappingBulkPatchRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectMappingBulkPatchRequest', 'V2024ObjectMappingBulkPatchRequest'] +slug: /tools/sdk/powershell/v2024/models/object-mapping-bulk-patch-request +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkPatchRequest', 'V2024ObjectMappingBulkPatchRequest'] +--- + + +# ObjectMappingBulkPatchRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Patches** | [**map[string]JsonPatchOperation[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | Map of id of the object mapping to a JsonPatchOperation describing what to patch on that object mapping. | [required] + +## Examples + +- Prepare the resource +```powershell +$ObjectMappingBulkPatchRequest = Initialize-PSSailpoint.V2024ObjectMappingBulkPatchRequest -Patches {603b1a61-d03d-4ed1-864f-a508fbd1995d=[{op=replace, path=/enabled, value=true}], 00bece34-f50d-4227-8878-76f620b5a971=[{op=replace, path=/targetValue, value=New Target Value}]} +``` + +- Convert the resource to JSON +```powershell +$ObjectMappingBulkPatchRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectMappingBulkPatchResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectMappingBulkPatchResponse.md new file mode 100644 index 000000000..1741756cf --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectMappingBulkPatchResponse.md @@ -0,0 +1,35 @@ +--- +id: v2024-object-mapping-bulk-patch-response +title: ObjectMappingBulkPatchResponse +pagination_label: ObjectMappingBulkPatchResponse +sidebar_label: ObjectMappingBulkPatchResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectMappingBulkPatchResponse', 'V2024ObjectMappingBulkPatchResponse'] +slug: /tools/sdk/powershell/v2024/models/object-mapping-bulk-patch-response +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkPatchResponse', 'V2024ObjectMappingBulkPatchResponse'] +--- + + +# ObjectMappingBulkPatchResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PatchedObjects** | Pointer to [**[]ObjectMappingResponse**](object-mapping-response) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ObjectMappingBulkPatchResponse = Initialize-PSSailpoint.V2024ObjectMappingBulkPatchResponse -PatchedObjects null +``` + +- Convert the resource to JSON +```powershell +$ObjectMappingBulkPatchResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectMappingRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectMappingRequest.md new file mode 100644 index 000000000..b01722ed8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectMappingRequest.md @@ -0,0 +1,43 @@ +--- +id: v2024-object-mapping-request +title: ObjectMappingRequest +pagination_label: ObjectMappingRequest +sidebar_label: ObjectMappingRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectMappingRequest', 'V2024ObjectMappingRequest'] +slug: /tools/sdk/powershell/v2024/models/object-mapping-request +tags: ['SDK', 'Software Development Kit', 'ObjectMappingRequest', 'V2024ObjectMappingRequest'] +--- + + +# ObjectMappingRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectType** | **Enum** [ "ACCESS_PROFILE", "ACCESS_REQUEST_CONFIG", "ATTR_SYNC_SOURCE_CONFIG", "AUTH_ORG", "CAMPAIGN_FILTER", "ENTITLEMENT", "FORM_DEFINITION", "GOVERNANCE_GROUP", "IDENTITY", "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "LIFECYCLE_STATE", "NOTIFICATION_TEMPLATE", "PASSWORD_POLICY", "PASSWORD_SYNC_GROUP", "PUBLIC_IDENTITIES_CONFIG", "ROLE", "RULE", "SEGMENT", "SERVICE_DESK_INTEGRATION", "SOD_POLICY", "SOURCE", "TAG", "TRANSFORM", "TRIGGER_SUBSCRIPTION", "WORKFLOW" ] | Type of the object the mapping value applies to, must be one from enum | [required] +**JsonPath** | **String** | JSONPath expression denoting the path within the object where the mapping value should be applied | [required] +**SourceValue** | **String** | Original value at the jsonPath location within the object | [required] +**TargetValue** | **String** | Value to be assigned at the jsonPath location within the object | [required] +**Enabled** | Pointer to **Boolean** | Whether or not this object mapping is enabled | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$ObjectMappingRequest = Initialize-PSSailpoint.V2024ObjectMappingRequest -ObjectType IDENTITY ` + -JsonPath $.name ` + -SourceValue My Governance Group Name ` + -TargetValue My New Governance Group Name ` + -Enabled false +``` + +- Convert the resource to JSON +```powershell +$ObjectMappingRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectMappingResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectMappingResponse.md new file mode 100644 index 000000000..841cb35a7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ObjectMappingResponse.md @@ -0,0 +1,49 @@ +--- +id: v2024-object-mapping-response +title: ObjectMappingResponse +pagination_label: ObjectMappingResponse +sidebar_label: ObjectMappingResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectMappingResponse', 'V2024ObjectMappingResponse'] +slug: /tools/sdk/powershell/v2024/models/object-mapping-response +tags: ['SDK', 'Software Development Kit', 'ObjectMappingResponse', 'V2024ObjectMappingResponse'] +--- + + +# ObjectMappingResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectMappingId** | Pointer to **String** | Id of the object mapping | [optional] +**ObjectType** | Pointer to **Enum** [ "ACCESS_PROFILE", "ACCESS_REQUEST_CONFIG", "ATTR_SYNC_SOURCE_CONFIG", "AUTH_ORG", "CAMPAIGN_FILTER", "ENTITLEMENT", "FORM_DEFINITION", "GOVERNANCE_GROUP", "IDENTITY", "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "LIFECYCLE_STATE", "NOTIFICATION_TEMPLATE", "PASSWORD_POLICY", "PASSWORD_SYNC_GROUP", "PUBLIC_IDENTITIES_CONFIG", "ROLE", "RULE", "SEGMENT", "SERVICE_DESK_INTEGRATION", "SOD_POLICY", "SOURCE", "TAG", "TRANSFORM", "TRIGGER_SUBSCRIPTION", "WORKFLOW" ] | Type of the object the mapping value applies to | [optional] +**JsonPath** | Pointer to **String** | JSONPath expression denoting the path within the object where the mapping value should be applied | [optional] +**SourceValue** | Pointer to **String** | Original value at the jsonPath location within the object | [optional] +**TargetValue** | Pointer to **String** | Value to be assigned at the jsonPath location within the object | [optional] +**Enabled** | Pointer to **Boolean** | Whether or not this object mapping is enabled | [optional] [default to $false] +**Created** | Pointer to **String** | Object mapping creation timestamp | [optional] +**Modified** | Pointer to **String** | Object mapping latest update timestamp | [optional] + +## Examples + +- Prepare the resource +```powershell +$ObjectMappingResponse = Initialize-PSSailpoint.V2024ObjectMappingResponse -ObjectMappingId 3d6e0144-963f-4bd6-8d8d-d77b4e507ce4 ` + -ObjectType IDENTITY ` + -JsonPath $.name ` + -SourceValue My Governance Group Name ` + -TargetValue My New Governance Group Name ` + -Enabled false ` + -Created 2024-03-19T23:18:53.732Z ` + -Modified 2024-03-19T23:18:53.732Z +``` + +- Convert the resource to JSON +```powershell +$ObjectMappingResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Operation.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Operation.md new file mode 100644 index 000000000..179161bd3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Operation.md @@ -0,0 +1,34 @@ +--- +id: v2024-operation +title: Operation +pagination_label: Operation +sidebar_label: Operation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Operation', 'V2024Operation'] +slug: /tools/sdk/powershell/v2024/models/operation +tags: ['SDK', 'Software Development Kit', 'Operation', 'V2024Operation'] +--- + + +# Operation + +## Enum + + +* `EQUALS` (value: `"EQUALS"`) + +* `NOT_EQUALS` (value: `"NOT_EQUALS"`) + +* `CONTAINS` (value: `"CONTAINS"`) + +* `STARTS_WITH` (value: `"STARTS_WITH"`) + +* `ENDS_WITH` (value: `"ENDS_WITH"`) + +* `AND` (value: `"AND"`) + +* `OR` (value: `"OR"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OrgConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OrgConfig.md new file mode 100644 index 000000000..67e1a82c7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OrgConfig.md @@ -0,0 +1,53 @@ +--- +id: v2024-org-config +title: OrgConfig +pagination_label: OrgConfig +sidebar_label: OrgConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OrgConfig', 'V2024OrgConfig'] +slug: /tools/sdk/powershell/v2024/models/org-config +tags: ['SDK', 'Software Development Kit', 'OrgConfig', 'V2024OrgConfig'] +--- + + +# OrgConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OrgName** | Pointer to **String** | The name of the org. | [optional] +**TimeZone** | Pointer to **String** | The selected time zone which is to be used for the org. This directly affects when scheduled tasks are executed. Valid options can be found at /beta/org-config/valid-time-zones | [optional] +**LcsChangeHonorsSourceEnableFeature** | Pointer to **Boolean** | Flag to determine whether the LCS_CHANGE_HONORS_SOURCE_ENABLE_FEATURE flag is enabled for the current org. | [optional] +**ArmCustomerId** | Pointer to **String** | ARM Customer ID | [optional] +**ArmSapSystemIdMappings** | Pointer to **String** | A list of IDN::sourceId to ARM::systemId mappings. | [optional] +**ArmAuth** | Pointer to **String** | ARM authentication string | [optional] +**ArmDb** | Pointer to **String** | ARM database name | [optional] +**ArmSsoUrl** | Pointer to **String** | ARM SSO URL | [optional] +**IaiEnableCertificationRecommendations** | Pointer to **Boolean** | Flag to determine whether IAI Certification Recommendations are enabled for the current org | [optional] +**SodReportConfigs** | Pointer to [**[]ReportConfigDTO**](report-config-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$OrgConfig = Initialize-PSSailpoint.V2024OrgConfig -OrgName acme-solar ` + -TimeZone America/Toronto ` + -LcsChangeHonorsSourceEnableFeature false ` + -ArmCustomerId DE38E75A-5FF6-4A65-5DC7-08D64426B09E ` + -ArmSapSystemIdMappings [{sourceId=2c91808c791a94e501792388b0d62659, systemId=1556}, {sourceId=2_2c91808c791a94e501792388b0d62659, systemId=2_1556}, {sourceId=3_2c91808c791a94e501792388b0d62659, systemId=3_1556}] ` + -ArmAuth epiYNTRYA2S7swisDWk1Zv4VMNgvqEjiBh5_ufuCWsma2m-5XADijqBg0ijXLby5nS6lxZNXabhGnAPGeDGc4V3jQKrhwV-UHypRLs8ZLgOjiQNus9NimS0uPdKomRW6TFWqXyfnYd-znNgbbVuwUy9GyD9ebDVJSntPastxSx7UcyGuWBqfNZYpuxKRWe_7TVY60qL55jUqyz8N4XUbbdcxdbZ0uik6ut-Bv90MKTbZexBW_PR4qcgIkaEs4kIenLyBxnGziYo7AO0tJ8bGHO8FJRkibCpAQIt7PISLo7Gg_Xf9j10dKq2YDgy4pPTvz3fE2ZHYnXCXvXFSA-vVag== ` + -ArmDb EU ` + -ArmSsoUrl https://your-arm-sso-url ` + -IaiEnableCertificationRecommendations true ` + -SodReportConfigs null +``` + +- Convert the resource to JSON +```powershell +$OrgConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OriginalRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OriginalRequest.md new file mode 100644 index 000000000..98c50f56d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OriginalRequest.md @@ -0,0 +1,41 @@ +--- +id: v2024-original-request +title: OriginalRequest +pagination_label: OriginalRequest +sidebar_label: OriginalRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OriginalRequest', 'V2024OriginalRequest'] +slug: /tools/sdk/powershell/v2024/models/original-request +tags: ['SDK', 'Software Development Kit', 'OriginalRequest', 'V2024OriginalRequest'] +--- + + +# OriginalRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | Pointer to **String** | Account ID. | [optional] +**AttributeRequests** | Pointer to [**[]AttributeRequest**](attribute-request) | Attribute changes requested for account. | [optional] +**Op** | Pointer to **String** | Operation used. | [optional] +**Source** | Pointer to [**AccountSource**](account-source) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$OriginalRequest = Initialize-PSSailpoint.V2024OriginalRequest -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` + -AttributeRequests null ` + -Op add ` + -Source null +``` + +- Convert the resource to JSON +```powershell +$OriginalRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OrphanIdentitiesReportArguments.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OrphanIdentitiesReportArguments.md new file mode 100644 index 000000000..5aeb04d7c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OrphanIdentitiesReportArguments.md @@ -0,0 +1,35 @@ +--- +id: v2024-orphan-identities-report-arguments +title: OrphanIdentitiesReportArguments +pagination_label: OrphanIdentitiesReportArguments +sidebar_label: OrphanIdentitiesReportArguments +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OrphanIdentitiesReportArguments', 'V2024OrphanIdentitiesReportArguments'] +slug: /tools/sdk/powershell/v2024/models/orphan-identities-report-arguments +tags: ['SDK', 'Software Development Kit', 'OrphanIdentitiesReportArguments', 'V2024OrphanIdentitiesReportArguments'] +--- + + +# OrphanIdentitiesReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SelectedFormats** | Pointer to **[]String** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] + +## Examples + +- Prepare the resource +```powershell +$OrphanIdentitiesReportArguments = Initialize-PSSailpoint.V2024OrphanIdentitiesReportArguments -SelectedFormats [CSV] +``` + +- Convert the resource to JSON +```powershell +$OrphanIdentitiesReportArguments | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Outlier.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Outlier.md new file mode 100644 index 000000000..0ba61d455 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Outlier.md @@ -0,0 +1,55 @@ +--- +id: v2024-outlier +title: Outlier +pagination_label: Outlier +sidebar_label: Outlier +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Outlier', 'V2024Outlier'] +slug: /tools/sdk/powershell/v2024/models/outlier +tags: ['SDK', 'Software Development Kit', 'Outlier', 'V2024Outlier'] +--- + + +# Outlier + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The identity's unique identifier for the outlier record | [optional] +**IdentityId** | Pointer to **String** | The ID of the identity that is detected as an outlier | [optional] +**Type** | Pointer to **Enum** [ "LOW_SIMILARITY", "STRUCTURAL" ] | The type of outlier summary | [optional] +**FirstDetectionDate** | Pointer to **System.DateTime** | The first date the outlier was detected | [optional] +**LatestDetectionDate** | Pointer to **System.DateTime** | The most recent date the outlier was detected | [optional] +**Ignored** | Pointer to **Boolean** | Flag whether or not the outlier has been ignored | [optional] +**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Object containing mapped identity attributes | [optional] +**Score** | Pointer to **Double** | The outlier score determined by the detection engine ranging from 0..1 | [optional] +**UnignoreType** | Pointer to **Enum** [ "MANUAL", "AUTOMATIC" ] | Enum value of if the outlier manually or automatically un-ignored. Will be NULL if outlier is not ignored | [optional] +**UnignoreDate** | Pointer to **System.DateTime** | shows date when last time has been unignored outlier | [optional] +**IgnoreDate** | Pointer to **System.DateTime** | shows date when last time has been ignored outlier | [optional] + +## Examples + +- Prepare the resource +```powershell +$Outlier = Initialize-PSSailpoint.V2024Outlier -Id 5be33d3e-c54d-4ed7-af73-2380543e8283 ` + -IdentityId 5be33d3e-c54d-4ed7-af73-2380543e8283 ` + -Type LOW_SIMILARITY ` + -FirstDetectionDate 2021-05-01T18:40:35.772Z ` + -LatestDetectionDate 2021-05-03T18:40:35.772Z ` + -Ignored false ` + -Attributes {displayName=John Smith, jobTitle=Software Engineer, department=Engineering} ` + -Score 0.92 ` + -UnignoreType MANUAL ` + -UnignoreDate 2021-06-01T18:40:35.772Z ` + -IgnoreDate 2021-06-01T18:40:35.772Z +``` + +- Convert the resource to JSON +```powershell +$Outlier | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OutlierContributingFeature.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OutlierContributingFeature.md new file mode 100644 index 000000000..32c6fe7bc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OutlierContributingFeature.md @@ -0,0 +1,49 @@ +--- +id: v2024-outlier-contributing-feature +title: OutlierContributingFeature +pagination_label: OutlierContributingFeature +sidebar_label: OutlierContributingFeature +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OutlierContributingFeature', 'V2024OutlierContributingFeature'] +slug: /tools/sdk/powershell/v2024/models/outlier-contributing-feature +tags: ['SDK', 'Software Development Kit', 'OutlierContributingFeature', 'V2024OutlierContributingFeature'] +--- + + +# OutlierContributingFeature + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Contributing feature id | [optional] +**Name** | Pointer to **String** | The name of the feature | [optional] +**ValueType** | Pointer to **Enum** [ "INTEGER", "FLOAT" ] | The data type of the value field | [optional] +**Value** | Pointer to [**OutlierContributingFeatureValue**](outlier-contributing-feature-value) | | [optional] +**Importance** | Pointer to **Double** | The importance of the feature. This can also be a negative value | [optional] +**DisplayName** | Pointer to **String** | The (translated if header is passed) displayName for the feature | [optional] +**Description** | Pointer to **String** | The (translated if header is passed) description for the feature | [optional] +**TranslationMessages** | Pointer to [**OutlierFeatureTranslation**](outlier-feature-translation) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$OutlierContributingFeature = Initialize-PSSailpoint.V2024OutlierContributingFeature -Id 66e38828-5017-47af-92ff-9844871352c5 ` + -Name entitlement_count ` + -ValueType INTEGER ` + -Value null ` + -Importance -0.15 ` + -DisplayName Number of entitlements ` + -Description The total number of entitlements belonging to an identity ` + -TranslationMessages null +``` + +- Convert the resource to JSON +```powershell +$OutlierContributingFeature | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OutlierContributingFeatureValue.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OutlierContributingFeatureValue.md new file mode 100644 index 000000000..90ced054c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OutlierContributingFeatureValue.md @@ -0,0 +1,34 @@ +--- +id: v2024-outlier-contributing-feature-value +title: OutlierContributingFeatureValue +pagination_label: OutlierContributingFeatureValue +sidebar_label: OutlierContributingFeatureValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OutlierContributingFeatureValue', 'V2024OutlierContributingFeatureValue'] +slug: /tools/sdk/powershell/v2024/models/outlier-contributing-feature-value +tags: ['SDK', 'Software Development Kit', 'OutlierContributingFeatureValue', 'V2024OutlierContributingFeatureValue'] +--- + + +# OutlierContributingFeatureValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$OutlierContributingFeatureValue = Initialize-PSSailpoint.V2024OutlierContributingFeatureValue +``` + +- Convert the resource to JSON +```powershell +$OutlierContributingFeatureValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OutlierFeatureSummary.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OutlierFeatureSummary.md new file mode 100644 index 000000000..0a24e8ad1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OutlierFeatureSummary.md @@ -0,0 +1,49 @@ +--- +id: v2024-outlier-feature-summary +title: OutlierFeatureSummary +pagination_label: OutlierFeatureSummary +sidebar_label: OutlierFeatureSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OutlierFeatureSummary', 'V2024OutlierFeatureSummary'] +slug: /tools/sdk/powershell/v2024/models/outlier-feature-summary +tags: ['SDK', 'Software Development Kit', 'OutlierFeatureSummary', 'V2024OutlierFeatureSummary'] +--- + + +# OutlierFeatureSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ContributingFeatureName** | Pointer to **String** | Contributing feature name | [optional] +**IdentityOutlierDisplayName** | Pointer to **String** | Identity display name | [optional] +**OutlierFeatureDisplayValues** | Pointer to [**[]OutlierFeatureSummaryOutlierFeatureDisplayValuesInner**](outlier-feature-summary-outlier-feature-display-values-inner) | | [optional] +**FeatureDefinition** | Pointer to **String** | Definition of the feature | [optional] +**FeatureExplanation** | Pointer to **String** | Detailed explanation of the feature | [optional] +**PeerDisplayName** | Pointer to **String** | outlier's peer identity display name | [optional] +**PeerIdentityId** | Pointer to **String** | outlier's peer identity id | [optional] +**AccessItemReference** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Access Item reference | [optional] + +## Examples + +- Prepare the resource +```powershell +$OutlierFeatureSummary = Initialize-PSSailpoint.V2024OutlierFeatureSummary -ContributingFeatureName Rare Access ` + -IdentityOutlierDisplayName John Smith ` + -OutlierFeatureDisplayValues null ` + -FeatureDefinition Identity total number of entitlements ` + -FeatureExplanation An identity that has too much rare access has a higher change of becoming a security threat due to the unique access they possess ` + -PeerDisplayName Mary Jane ` + -PeerIdentityId 9f9d5d53ad0e48fba7352f6da9f1b8gbg ` + -AccessItemReference {displayName=All Rare Entitlements, searchPlaceholder=Search by name or description} +``` + +- Convert the resource to JSON +```powershell +$OutlierFeatureSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OutlierFeatureSummaryOutlierFeatureDisplayValuesInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OutlierFeatureSummaryOutlierFeatureDisplayValuesInner.md new file mode 100644 index 000000000..b217b6229 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OutlierFeatureSummaryOutlierFeatureDisplayValuesInner.md @@ -0,0 +1,39 @@ +--- +id: v2024-outlier-feature-summary-outlier-feature-display-values-inner +title: OutlierFeatureSummaryOutlierFeatureDisplayValuesInner +pagination_label: OutlierFeatureSummaryOutlierFeatureDisplayValuesInner +sidebar_label: OutlierFeatureSummaryOutlierFeatureDisplayValuesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OutlierFeatureSummaryOutlierFeatureDisplayValuesInner', 'V2024OutlierFeatureSummaryOutlierFeatureDisplayValuesInner'] +slug: /tools/sdk/powershell/v2024/models/outlier-feature-summary-outlier-feature-display-values-inner +tags: ['SDK', 'Software Development Kit', 'OutlierFeatureSummaryOutlierFeatureDisplayValuesInner', 'V2024OutlierFeatureSummaryOutlierFeatureDisplayValuesInner'] +--- + + +# OutlierFeatureSummaryOutlierFeatureDisplayValuesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayName** | Pointer to **String** | display name | [optional] +**Value** | Pointer to **String** | value | [optional] +**ValueType** | Pointer to **Enum** [ "INTEGER", "FLOAT" ] | The data type of the value field | [optional] + +## Examples + +- Prepare the resource +```powershell +$OutlierFeatureSummaryOutlierFeatureDisplayValuesInner = Initialize-PSSailpoint.V2024OutlierFeatureSummaryOutlierFeatureDisplayValuesInner -DisplayName Aliza Chris ` + -Value 55 ` + -ValueType INTEGER +``` + +- Convert the resource to JSON +```powershell +$OutlierFeatureSummaryOutlierFeatureDisplayValuesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OutlierFeatureTranslation.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OutlierFeatureTranslation.md new file mode 100644 index 000000000..3579eca01 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OutlierFeatureTranslation.md @@ -0,0 +1,37 @@ +--- +id: v2024-outlier-feature-translation +title: OutlierFeatureTranslation +pagination_label: OutlierFeatureTranslation +sidebar_label: OutlierFeatureTranslation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OutlierFeatureTranslation', 'V2024OutlierFeatureTranslation'] +slug: /tools/sdk/powershell/v2024/models/outlier-feature-translation +tags: ['SDK', 'Software Development Kit', 'OutlierFeatureTranslation', 'V2024OutlierFeatureTranslation'] +--- + + +# OutlierFeatureTranslation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayName** | Pointer to [**TranslationMessage**](translation-message) | | [optional] +**Description** | Pointer to [**TranslationMessage**](translation-message) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$OutlierFeatureTranslation = Initialize-PSSailpoint.V2024OutlierFeatureTranslation -DisplayName null ` + -Description null +``` + +- Convert the resource to JSON +```powershell +$OutlierFeatureTranslation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OutlierSummary.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OutlierSummary.md new file mode 100644 index 000000000..12037501e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OutlierSummary.md @@ -0,0 +1,43 @@ +--- +id: v2024-outlier-summary +title: OutlierSummary +pagination_label: OutlierSummary +sidebar_label: OutlierSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OutlierSummary', 'V2024OutlierSummary'] +slug: /tools/sdk/powershell/v2024/models/outlier-summary +tags: ['SDK', 'Software Development Kit', 'OutlierSummary', 'V2024OutlierSummary'] +--- + + +# OutlierSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "LOW_SIMILARITY", "STRUCTURAL" ] | The type of outlier summary | [optional] +**SnapshotDate** | Pointer to **System.DateTime** | The date the bulk outlier detection ran/snapshot was created | [optional] +**TotalOutliers** | Pointer to **Int32** | Total number of outliers for the customer making the request | [optional] +**TotalIdentities** | Pointer to **Int32** | Total number of identities for the customer making the request | [optional] +**TotalIgnored** | Pointer to **Int32** | | [optional] [default to 0] + +## Examples + +- Prepare the resource +```powershell +$OutlierSummary = Initialize-PSSailpoint.V2024OutlierSummary -Type LOW_SIMILARITY ` + -SnapshotDate 2021-05-01T18:40:35.772Z ` + -TotalOutliers 50 ` + -TotalIdentities 5000 ` + -TotalIgnored 0 +``` + +- Convert the resource to JSON +```powershell +$OutlierSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OutliersContributingFeatureAccessItems.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OutliersContributingFeatureAccessItems.md new file mode 100644 index 000000000..766daa397 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OutliersContributingFeatureAccessItems.md @@ -0,0 +1,45 @@ +--- +id: v2024-outliers-contributing-feature-access-items +title: OutliersContributingFeatureAccessItems +pagination_label: OutliersContributingFeatureAccessItems +sidebar_label: OutliersContributingFeatureAccessItems +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OutliersContributingFeatureAccessItems', 'V2024OutliersContributingFeatureAccessItems'] +slug: /tools/sdk/powershell/v2024/models/outliers-contributing-feature-access-items +tags: ['SDK', 'Software Development Kit', 'OutliersContributingFeatureAccessItems', 'V2024OutliersContributingFeatureAccessItems'] +--- + + +# OutliersContributingFeatureAccessItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of the access item | [optional] +**DisplayName** | Pointer to **String** | the display name of the access item | [optional] +**Description** | Pointer to **String** | Description of the access item. | [optional] +**AccessType** | Pointer to **Enum** [ "ENTITLEMENT", "ACCESS_PROFILE", "ROLE" ] | The type of the access item. | [optional] +**SourceName** | Pointer to **String** | the associated source name if it exists | [optional] +**ExtremelyRare** | Pointer to **Boolean** | rarest access | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$OutliersContributingFeatureAccessItems = Initialize-PSSailpoint.V2024OutliersContributingFeatureAccessItems -Id 2c938083633d259901633d2623ec0375 ` + -DisplayName Applied Research Access ` + -Description Access to research information, lab results, and schematics ` + -AccessType ENTITLEMENT ` + -SourceName appName ` + -ExtremelyRare true +``` + +- Convert the resource to JSON +```powershell +$OutliersContributingFeatureAccessItems | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OwnerDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OwnerDto.md new file mode 100644 index 000000000..cea246408 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OwnerDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-owner-dto +title: OwnerDto +pagination_label: OwnerDto +sidebar_label: OwnerDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OwnerDto', 'V2024OwnerDto'] +slug: /tools/sdk/powershell/v2024/models/owner-dto +tags: ['SDK', 'Software Development Kit', 'OwnerDto', 'V2024OwnerDto'] +--- + + +# OwnerDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Owner's DTO type. | [optional] +**Id** | Pointer to **String** | Owner's identity ID. | [optional] +**Name** | Pointer to **String** | Owner's name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$OwnerDto = Initialize-PSSailpoint.V2024OwnerDto -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Support +``` + +- Convert the resource to JSON +```powershell +$OwnerDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OwnerReference.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OwnerReference.md new file mode 100644 index 000000000..e0762d2c3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OwnerReference.md @@ -0,0 +1,39 @@ +--- +id: v2024-owner-reference +title: OwnerReference +pagination_label: OwnerReference +sidebar_label: OwnerReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OwnerReference', 'V2024OwnerReference'] +slug: /tools/sdk/powershell/v2024/models/owner-reference +tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'V2024OwnerReference'] +--- + + +# OwnerReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] +**Id** | Pointer to **String** | Identity id | [optional] +**Name** | Pointer to **String** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] + +## Examples + +- Prepare the resource +```powershell +$OwnerReference = Initialize-PSSailpoint.V2024OwnerReference -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name support +``` + +- Convert the resource to JSON +```powershell +$OwnerReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OwnerReferenceDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OwnerReferenceDto.md new file mode 100644 index 000000000..9fcac9b77 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OwnerReferenceDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-owner-reference-dto +title: OwnerReferenceDto +pagination_label: OwnerReferenceDto +sidebar_label: OwnerReferenceDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OwnerReferenceDto', 'V2024OwnerReferenceDto'] +slug: /tools/sdk/powershell/v2024/models/owner-reference-dto +tags: ['SDK', 'Software Development Kit', 'OwnerReferenceDto', 'V2024OwnerReferenceDto'] +--- + + +# OwnerReferenceDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The owner id for the entitlement | [optional] +**Name** | Pointer to **String** | The owner name for the entitlement | [optional] +**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of the owner. Initially only type IDENTITY is supported | [optional] + +## Examples + +- Prepare the resource +```powershell +$OwnerReferenceDto = Initialize-PSSailpoint.V2024OwnerReferenceDto -Id 2a2fdacca5e345f18bf7970cfbb8fec2 ` + -Name identity 1 ` + -Type IDENTITY +``` + +- Convert the resource to JSON +```powershell +$OwnerReferenceDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OwnerReferenceSegments.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OwnerReferenceSegments.md new file mode 100644 index 000000000..6c5750550 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/OwnerReferenceSegments.md @@ -0,0 +1,39 @@ +--- +id: v2024-owner-reference-segments +title: OwnerReferenceSegments +pagination_label: OwnerReferenceSegments +sidebar_label: OwnerReferenceSegments +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OwnerReferenceSegments', 'V2024OwnerReferenceSegments'] +slug: /tools/sdk/powershell/v2024/models/owner-reference-segments +tags: ['SDK', 'Software Development Kit', 'OwnerReferenceSegments', 'V2024OwnerReferenceSegments'] +--- + + +# OwnerReferenceSegments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] +**Id** | Pointer to **String** | Identity id | [optional] +**Name** | Pointer to **String** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] + +## Examples + +- Prepare the resource +```powershell +$OwnerReferenceSegments = Initialize-PSSailpoint.V2024OwnerReferenceSegments -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name support +``` + +- Convert the resource to JSON +```powershell +$OwnerReferenceSegments | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Owns.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Owns.md new file mode 100644 index 000000000..f3d69147c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Owns.md @@ -0,0 +1,47 @@ +--- +id: v2024-owns +title: Owns +pagination_label: Owns +sidebar_label: Owns +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Owns', 'V2024Owns'] +slug: /tools/sdk/powershell/v2024/models/owns +tags: ['SDK', 'Software Development Kit', 'Owns', 'V2024Owns'] +--- + + +# Owns + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Sources** | Pointer to [**[]Reference1**](reference1) | | [optional] +**Entitlements** | Pointer to [**[]Reference1**](reference1) | | [optional] +**AccessProfiles** | Pointer to [**[]Reference1**](reference1) | | [optional] +**Roles** | Pointer to [**[]Reference1**](reference1) | | [optional] +**Apps** | Pointer to [**[]Reference1**](reference1) | | [optional] +**GovernanceGroups** | Pointer to [**[]Reference1**](reference1) | | [optional] +**FallbackApprover** | Pointer to **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Owns = Initialize-PSSailpoint.V2024Owns -Sources null ` + -Entitlements null ` + -AccessProfiles null ` + -Roles null ` + -Apps null ` + -GovernanceGroups null ` + -FallbackApprover false +``` + +- Convert the resource to JSON +```powershell +$Owns | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordChangeRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordChangeRequest.md new file mode 100644 index 000000000..ad6148afc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordChangeRequest.md @@ -0,0 +1,43 @@ +--- +id: v2024-password-change-request +title: PasswordChangeRequest +pagination_label: PasswordChangeRequest +sidebar_label: PasswordChangeRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordChangeRequest', 'V2024PasswordChangeRequest'] +slug: /tools/sdk/powershell/v2024/models/password-change-request +tags: ['SDK', 'Software Development Kit', 'PasswordChangeRequest', 'V2024PasswordChangeRequest'] +--- + + +# PasswordChangeRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **String** | The identity ID that requested the password change | [optional] +**EncryptedPassword** | Pointer to **String** | The RSA encrypted password | [optional] +**PublicKeyId** | Pointer to **String** | The encryption key ID | [optional] +**AccountId** | Pointer to **String** | Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [optional] +**SourceId** | Pointer to **String** | The ID of the source for which identity is requesting the password change | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordChangeRequest = Initialize-PSSailpoint.V2024PasswordChangeRequest -IdentityId 8a807d4c73c545510173c545f0a002ff ` + -EncryptedPassword XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A== ` + -PublicKeyId YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2 ` + -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` + -SourceId 8a807d4c73c545510173c545d4b60246 +``` + +- Convert the resource to JSON +```powershell +$PasswordChangeRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordChangeResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordChangeResponse.md new file mode 100644 index 000000000..6a0b6069e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordChangeResponse.md @@ -0,0 +1,37 @@ +--- +id: v2024-password-change-response +title: PasswordChangeResponse +pagination_label: PasswordChangeResponse +sidebar_label: PasswordChangeResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordChangeResponse', 'V2024PasswordChangeResponse'] +slug: /tools/sdk/powershell/v2024/models/password-change-response +tags: ['SDK', 'Software Development Kit', 'PasswordChangeResponse', 'V2024PasswordChangeResponse'] +--- + + +# PasswordChangeResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | Pointer to **String** | The password change request ID | [optional] +**State** | Pointer to **Enum** [ "IN_PROGRESS", "FINISHED", "FAILED" ] | Password change state | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordChangeResponse = Initialize-PSSailpoint.V2024PasswordChangeResponse -RequestId 089899f13a8f4da7824996191587bab9 ` + -State IN_PROGRESS +``` + +- Convert the resource to JSON +```powershell +$PasswordChangeResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordDigitToken.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordDigitToken.md new file mode 100644 index 000000000..18926f90c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordDigitToken.md @@ -0,0 +1,37 @@ +--- +id: v2024-password-digit-token +title: PasswordDigitToken +pagination_label: PasswordDigitToken +sidebar_label: PasswordDigitToken +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordDigitToken', 'V2024PasswordDigitToken'] +slug: /tools/sdk/powershell/v2024/models/password-digit-token +tags: ['SDK', 'Software Development Kit', 'PasswordDigitToken', 'V2024PasswordDigitToken'] +--- + + +# PasswordDigitToken + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DigitToken** | Pointer to **String** | The digit token for password management | [optional] +**RequestId** | Pointer to **String** | The reference ID of the digit token generation request | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordDigitToken = Initialize-PSSailpoint.V2024PasswordDigitToken -DigitToken 09087713 ` + -RequestId e1267ecd-fcd9-4c73-9c55-12555efad136 +``` + +- Convert the resource to JSON +```powershell +$PasswordDigitToken | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordDigitTokenReset.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordDigitTokenReset.md new file mode 100644 index 000000000..e45527f14 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordDigitTokenReset.md @@ -0,0 +1,39 @@ +--- +id: v2024-password-digit-token-reset +title: PasswordDigitTokenReset +pagination_label: PasswordDigitTokenReset +sidebar_label: PasswordDigitTokenReset +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordDigitTokenReset', 'V2024PasswordDigitTokenReset'] +slug: /tools/sdk/powershell/v2024/models/password-digit-token-reset +tags: ['SDK', 'Software Development Kit', 'PasswordDigitTokenReset', 'V2024PasswordDigitTokenReset'] +--- + + +# PasswordDigitTokenReset + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserId** | **String** | The uid of the user requested for digit token | [required] +**Length** | Pointer to **Int32** | The length of digit token. It should be from 6 to 18, inclusive. The default value is 6. | [optional] +**DurationMinutes** | Pointer to **Int32** | The time to live for the digit token in minutes. The default value is 5 minutes. | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordDigitTokenReset = Initialize-PSSailpoint.V2024PasswordDigitTokenReset -UserId Abby.Smith ` + -Length 8 ` + -DurationMinutes 5 +``` + +- Convert the resource to JSON +```powershell +$PasswordDigitTokenReset | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordInfo.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordInfo.md new file mode 100644 index 000000000..7c6a27623 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordInfo.md @@ -0,0 +1,45 @@ +--- +id: v2024-password-info +title: PasswordInfo +pagination_label: PasswordInfo +sidebar_label: PasswordInfo +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordInfo', 'V2024PasswordInfo'] +slug: /tools/sdk/powershell/v2024/models/password-info +tags: ['SDK', 'Software Development Kit', 'PasswordInfo', 'V2024PasswordInfo'] +--- + + +# PasswordInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **String** | Identity ID | [optional] +**SourceId** | Pointer to **String** | source ID | [optional] +**PublicKeyId** | Pointer to **String** | public key ID | [optional] +**PublicKey** | Pointer to **String** | User's public key with Base64 encoding | [optional] +**Accounts** | Pointer to [**[]PasswordInfoAccount**](password-info-account) | Account info related to queried identity and source | [optional] +**Policies** | Pointer to **[]String** | Password constraints | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordInfo = Initialize-PSSailpoint.V2024PasswordInfo -IdentityId 2c918085744fec4301746f9a5bce4605 ` + -SourceId 2c918083746f642c01746f990884012a ` + -PublicKeyId N2M1OTJiMGEtMDJlZS00ZWU3LTkyYTEtNjA5YmI5NWE3ZWVh ` + -PublicKey MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuGFkWi2J75TztpbaPKd36bJnIB3J8gZ6UcoS9oSDYsqBzPpTsfZXYaEf4Y4BKGgJIXmE/lwhwuj7mU1itdZ2qTSNFtnXA8Fn75c3UUkk+h+wdZbkuSmqlsJo3R1OnJkwkJggcAy9Jvk9jlcrNLWorpQ1w9raUvxtvfgkSdq153KxotenQ1HciSyZ0nA/Kw0UaucLnho8xdRowZs11afXGXA9IT9H6D8T6zUdtSxm0nAyH+mluma5LdTfaM50W3l/L8q56Vrqmx2pZIiwdx/0+g3Y++jV70zom0ZBkC1MmSoLMrQYG5OICNjr72f78B2PaGXfarQHqARLjKpMVt9YIQIDAQAB ` + -Accounts null ` + -Policies [passwordRepeatedChar is 3, passwordMinAlpha is 1, passwordMinLength is 5, passwordMinNumeric is 1] +``` + +- Convert the resource to JSON +```powershell +$PasswordInfo | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordInfoAccount.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordInfoAccount.md new file mode 100644 index 000000000..7b1c1a381 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordInfoAccount.md @@ -0,0 +1,37 @@ +--- +id: v2024-password-info-account +title: PasswordInfoAccount +pagination_label: PasswordInfoAccount +sidebar_label: PasswordInfoAccount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordInfoAccount', 'V2024PasswordInfoAccount'] +slug: /tools/sdk/powershell/v2024/models/password-info-account +tags: ['SDK', 'Software Development Kit', 'PasswordInfoAccount', 'V2024PasswordInfoAccount'] +--- + + +# PasswordInfoAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | Pointer to **String** | Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [optional] +**AccountName** | Pointer to **String** | Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008 | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordInfoAccount = Initialize-PSSailpoint.V2024PasswordInfoAccount -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` + -AccountName Abby.Smith +``` + +- Convert the resource to JSON +```powershell +$PasswordInfoAccount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordInfoQueryDTO.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordInfoQueryDTO.md new file mode 100644 index 000000000..6c6461ffd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordInfoQueryDTO.md @@ -0,0 +1,37 @@ +--- +id: v2024-password-info-query-dto +title: PasswordInfoQueryDTO +pagination_label: PasswordInfoQueryDTO +sidebar_label: PasswordInfoQueryDTO +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordInfoQueryDTO', 'V2024PasswordInfoQueryDTO'] +slug: /tools/sdk/powershell/v2024/models/password-info-query-dto +tags: ['SDK', 'Software Development Kit', 'PasswordInfoQueryDTO', 'V2024PasswordInfoQueryDTO'] +--- + + +# PasswordInfoQueryDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserName** | Pointer to **String** | The login name of the user | [optional] +**SourceName** | Pointer to **String** | The display name of the source | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordInfoQueryDTO = Initialize-PSSailpoint.V2024PasswordInfoQueryDTO -UserName Abby.Smith ` + -SourceName My-AD +``` + +- Convert the resource to JSON +```powershell +$PasswordInfoQueryDTO | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordOrgConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordOrgConfig.md new file mode 100644 index 000000000..8b5aac30b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordOrgConfig.md @@ -0,0 +1,41 @@ +--- +id: v2024-password-org-config +title: PasswordOrgConfig +pagination_label: PasswordOrgConfig +sidebar_label: PasswordOrgConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordOrgConfig', 'V2024PasswordOrgConfig'] +slug: /tools/sdk/powershell/v2024/models/password-org-config +tags: ['SDK', 'Software Development Kit', 'PasswordOrgConfig', 'V2024PasswordOrgConfig'] +--- + + +# PasswordOrgConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CustomInstructionsEnabled** | Pointer to **Boolean** | Indicator whether custom password instructions feature is enabled. The default value is false. | [optional] [default to $false] +**DigitTokenEnabled** | Pointer to **Boolean** | Indicator whether ""digit token"" feature is enabled. The default value is false. | [optional] [default to $false] +**DigitTokenDurationMinutes** | Pointer to **Int32** | The duration of ""digit token"" in minutes. The default value is 5. | [optional] [default to 5] +**DigitTokenLength** | Pointer to **Int32** | The length of ""digit token"". The default value is 6. | [optional] [default to 6] + +## Examples + +- Prepare the resource +```powershell +$PasswordOrgConfig = Initialize-PSSailpoint.V2024PasswordOrgConfig -CustomInstructionsEnabled true ` + -DigitTokenEnabled true ` + -DigitTokenDurationMinutes 10 ` + -DigitTokenLength 9 +``` + +- Convert the resource to JSON +```powershell +$PasswordOrgConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordPolicyHoldersDtoAttributes.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordPolicyHoldersDtoAttributes.md new file mode 100644 index 000000000..1256d34d3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordPolicyHoldersDtoAttributes.md @@ -0,0 +1,35 @@ +--- +id: v2024-password-policy-holders-dto-attributes +title: PasswordPolicyHoldersDtoAttributes +pagination_label: PasswordPolicyHoldersDtoAttributes +sidebar_label: PasswordPolicyHoldersDtoAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordPolicyHoldersDtoAttributes', 'V2024PasswordPolicyHoldersDtoAttributes'] +slug: /tools/sdk/powershell/v2024/models/password-policy-holders-dto-attributes +tags: ['SDK', 'Software Development Kit', 'PasswordPolicyHoldersDtoAttributes', 'V2024PasswordPolicyHoldersDtoAttributes'] +--- + + +# PasswordPolicyHoldersDtoAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityAttr** | Pointer to [**[]PasswordPolicyHoldersDtoAttributesIdentityAttrInner**](password-policy-holders-dto-attributes-identity-attr-inner) | Attributes of PasswordPolicyHoldersDto | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordPolicyHoldersDtoAttributes = Initialize-PSSailpoint.V2024PasswordPolicyHoldersDtoAttributes -IdentityAttr null +``` + +- Convert the resource to JSON +```powershell +$PasswordPolicyHoldersDtoAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordPolicyHoldersDtoAttributesIdentityAttrInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordPolicyHoldersDtoAttributesIdentityAttrInner.md new file mode 100644 index 000000000..804c7f443 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordPolicyHoldersDtoAttributesIdentityAttrInner.md @@ -0,0 +1,37 @@ +--- +id: v2024-password-policy-holders-dto-attributes-identity-attr-inner +title: PasswordPolicyHoldersDtoAttributesIdentityAttrInner +pagination_label: PasswordPolicyHoldersDtoAttributesIdentityAttrInner +sidebar_label: PasswordPolicyHoldersDtoAttributesIdentityAttrInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordPolicyHoldersDtoAttributesIdentityAttrInner', 'V2024PasswordPolicyHoldersDtoAttributesIdentityAttrInner'] +slug: /tools/sdk/powershell/v2024/models/password-policy-holders-dto-attributes-identity-attr-inner +tags: ['SDK', 'Software Development Kit', 'PasswordPolicyHoldersDtoAttributesIdentityAttrInner', 'V2024PasswordPolicyHoldersDtoAttributesIdentityAttrInner'] +--- + + +# PasswordPolicyHoldersDtoAttributesIdentityAttrInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Attribute's name | [optional] +**Value** | Pointer to **String** | Attribute's value | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordPolicyHoldersDtoAttributesIdentityAttrInner = Initialize-PSSailpoint.V2024PasswordPolicyHoldersDtoAttributesIdentityAttrInner -Name Country ` + -Value Canada +``` + +- Convert the resource to JSON +```powershell +$PasswordPolicyHoldersDtoAttributesIdentityAttrInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordPolicyHoldersDtoInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordPolicyHoldersDtoInner.md new file mode 100644 index 000000000..8d7c1a3c0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordPolicyHoldersDtoInner.md @@ -0,0 +1,39 @@ +--- +id: v2024-password-policy-holders-dto-inner +title: PasswordPolicyHoldersDtoInner +pagination_label: PasswordPolicyHoldersDtoInner +sidebar_label: PasswordPolicyHoldersDtoInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordPolicyHoldersDtoInner', 'V2024PasswordPolicyHoldersDtoInner'] +slug: /tools/sdk/powershell/v2024/models/password-policy-holders-dto-inner +tags: ['SDK', 'Software Development Kit', 'PasswordPolicyHoldersDtoInner', 'V2024PasswordPolicyHoldersDtoInner'] +--- + + +# PasswordPolicyHoldersDtoInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PolicyId** | Pointer to **String** | The password policy Id. | [optional] +**PolicyName** | Pointer to **String** | The name of the password policy. | [optional] +**Selectors** | Pointer to [**PasswordPolicyHoldersDtoAttributes**](password-policy-holders-dto-attributes) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordPolicyHoldersDtoInner = Initialize-PSSailpoint.V2024PasswordPolicyHoldersDtoInner -PolicyId 2c91808e7d976f3b017d9f5ceae440c8 ` + -PolicyName PasswordPolicy Example ` + -Selectors {identityAttr=[{name=displayName, value=Robert}, {name=lastname, value=Juice}]} +``` + +- Convert the resource to JSON +```powershell +$PasswordPolicyHoldersDtoInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordPolicyV3Dto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordPolicyV3Dto.md new file mode 100644 index 000000000..29ddef97b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordPolicyV3Dto.md @@ -0,0 +1,95 @@ +--- +id: v2024-password-policy-v3-dto +title: PasswordPolicyV3Dto +pagination_label: PasswordPolicyV3Dto +sidebar_label: PasswordPolicyV3Dto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordPolicyV3Dto', 'V2024PasswordPolicyV3Dto'] +slug: /tools/sdk/powershell/v2024/models/password-policy-v3-dto +tags: ['SDK', 'Software Development Kit', 'PasswordPolicyV3Dto', 'V2024PasswordPolicyV3Dto'] +--- + + +# PasswordPolicyV3Dto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The password policy Id. | [optional] +**Description** | Pointer to **String** | Description for current password policy. | [optional] +**Name** | Pointer to **String** | The name of the password policy. | [optional] +**DateCreated** | Pointer to **System.DateTime** | Date the Password Policy was created. | [optional] +**LastUpdated** | Pointer to **System.DateTime** | Date the Password Policy was updated. | [optional] +**FirstExpirationReminder** | Pointer to **Int64** | The number of days before expiration remaninder. | [optional] +**AccountIdMinWordLength** | Pointer to **Int64** | The minimun length of account Id. By default is equals to -1. | [optional] +**AccountNameMinWordLength** | Pointer to **Int64** | The minimun length of account name. By default is equals to -1. | [optional] +**MinAlpha** | Pointer to **Int64** | Maximum alpha. By default is equals to 0. | [optional] +**MinCharacterTypes** | Pointer to **Int64** | MinCharacterTypes. By default is equals to -1. | [optional] +**MaxLength** | Pointer to **Int64** | Maximum length of the password. | [optional] +**MinLength** | Pointer to **Int64** | Minimum length of the password. By default is equals to 0. | [optional] +**MaxRepeatedChars** | Pointer to **Int64** | Maximum repetition of the same character in the password. By default is equals to -1. | [optional] +**MinLower** | Pointer to **Int64** | Minimum amount of lower case character in the password. By default is equals to 0. | [optional] +**MinNumeric** | Pointer to **Int64** | Minimum amount of numeric characters in the password. By default is equals to 0. | [optional] +**MinSpecial** | Pointer to **Int64** | Minimum amount of special symbols in the password. By default is equals to 0. | [optional] +**MinUpper** | Pointer to **Int64** | Minimum amount of upper case symbols in the password. By default is equals to 0. | [optional] +**PasswordExpiration** | Pointer to **Int64** | Number of days before current password expires. By default is equals to 90. | [optional] +**DefaultPolicy** | Pointer to **Boolean** | Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default. | [optional] [default to $false] +**EnablePasswdExpiration** | Pointer to **Boolean** | Defines whether this policy is enabled to expire or not. This field is false by default. | [optional] [default to $false] +**RequireStrongAuthn** | Pointer to **Boolean** | Defines whether this policy require strong Auth or not. This field is false by default. | [optional] [default to $false] +**RequireStrongAuthOffNetwork** | Pointer to **Boolean** | Defines whether this policy require strong Auth of network or not. This field is false by default. | [optional] [default to $false] +**RequireStrongAuthUntrustedGeographies** | Pointer to **Boolean** | Defines whether this policy require strong Auth for untrusted geographies. This field is false by default. | [optional] [default to $false] +**UseAccountAttributes** | Pointer to **Boolean** | Defines whether this policy uses account attributes or not. This field is false by default. | [optional] [default to $false] +**UseDictionary** | Pointer to **Boolean** | Defines whether this policy uses dictionary or not. This field is false by default. | [optional] [default to $false] +**UseIdentityAttributes** | Pointer to **Boolean** | Defines whether this policy uses identity attributes or not. This field is false by default. | [optional] [default to $false] +**ValidateAgainstAccountId** | Pointer to **Boolean** | Defines whether this policy validate against account id or not. This field is false by default. | [optional] [default to $false] +**ValidateAgainstAccountName** | Pointer to **Boolean** | Defines whether this policy validate against account name or not. This field is false by default. | [optional] [default to $false] +**Created** | Pointer to **String** | | [optional] +**Modified** | Pointer to **String** | | [optional] +**SourceIds** | Pointer to **[]String** | List of sources IDs managed by this password policy. | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordPolicyV3Dto = Initialize-PSSailpoint.V2024PasswordPolicyV3Dto -Id 2c91808e7d976f3b017d9f5ceae440c8 ` + -Description Information about the Password Policy ` + -Name PasswordPolicy Example ` + -DateCreated null ` + -LastUpdated null ` + -FirstExpirationReminder 45 ` + -AccountIdMinWordLength 4 ` + -AccountNameMinWordLength 6 ` + -MinAlpha 5 ` + -MinCharacterTypes 5 ` + -MaxLength 25 ` + -MinLength 8 ` + -MaxRepeatedChars 3 ` + -MinLower 8 ` + -MinNumeric 8 ` + -MinSpecial 8 ` + -MinUpper 8 ` + -PasswordExpiration 8 ` + -DefaultPolicy true ` + -EnablePasswdExpiration true ` + -RequireStrongAuthn true ` + -RequireStrongAuthOffNetwork true ` + -RequireStrongAuthUntrustedGeographies true ` + -UseAccountAttributes false ` + -UseDictionary false ` + -UseIdentityAttributes false ` + -ValidateAgainstAccountId false ` + -ValidateAgainstAccountName true ` + -Created null ` + -Modified null ` + -SourceIds [2c91808382ffee0b01830de154f14034, 2f98808382ffee0b01830de154f12134] +``` + +- Convert the resource to JSON +```powershell +$PasswordPolicyV3Dto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordStatus.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordStatus.md new file mode 100644 index 000000000..d18cd58e5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordStatus.md @@ -0,0 +1,41 @@ +--- +id: v2024-password-status +title: PasswordStatus +pagination_label: PasswordStatus +sidebar_label: PasswordStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordStatus', 'V2024PasswordStatus'] +slug: /tools/sdk/powershell/v2024/models/password-status +tags: ['SDK', 'Software Development Kit', 'PasswordStatus', 'V2024PasswordStatus'] +--- + + +# PasswordStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | Pointer to **String** | The password change request ID | [optional] +**State** | Pointer to **Enum** [ "IN_PROGRESS", "FINISHED", "FAILED" ] | Password change state | [optional] +**Errors** | Pointer to **[]String** | The errors during the password change request | [optional] +**SourceIds** | Pointer to **[]String** | List of source IDs in the password change request | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordStatus = Initialize-PSSailpoint.V2024PasswordStatus -RequestId 089899f13a8f4da7824996191587bab9 ` + -State IN_PROGRESS ` + -Errors [The password change payload is invalid] ` + -SourceIds [2c918083746f642c01746f990884012a] +``` + +- Convert the resource to JSON +```powershell +$PasswordStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordSyncGroup.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordSyncGroup.md new file mode 100644 index 000000000..3b8df4218 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PasswordSyncGroup.md @@ -0,0 +1,45 @@ +--- +id: v2024-password-sync-group +title: PasswordSyncGroup +pagination_label: PasswordSyncGroup +sidebar_label: PasswordSyncGroup +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordSyncGroup', 'V2024PasswordSyncGroup'] +slug: /tools/sdk/powershell/v2024/models/password-sync-group +tags: ['SDK', 'Software Development Kit', 'PasswordSyncGroup', 'V2024PasswordSyncGroup'] +--- + + +# PasswordSyncGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the sync group | [optional] +**Name** | Pointer to **String** | Name of the sync group | [optional] +**PasswordPolicyId** | Pointer to **String** | ID of the password policy | [optional] +**SourceIds** | Pointer to **[]String** | List of password managed sources IDs | [optional] +**Created** | Pointer to **System.DateTime** | The date and time this sync group was created | [optional] +**Modified** | Pointer to **System.DateTime** | The date and time this sync group was last modified | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordSyncGroup = Initialize-PSSailpoint.V2024PasswordSyncGroup -Id 6881f631-3bd5-4213-9c75-8e05cc3e35dd ` + -Name Password Sync Group 1 ` + -PasswordPolicyId 2c91808d744ba0ce01746f93b6204501 ` + -SourceIds [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500] ` + -Created 2023-03-16T04:00Z ` + -Modified 2023-03-16T04:00Z +``` + +- Convert the resource to JSON +```powershell +$PasswordSyncGroup | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PatOwner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PatOwner.md new file mode 100644 index 000000000..a618ca80c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PatOwner.md @@ -0,0 +1,39 @@ +--- +id: v2024-pat-owner +title: PatOwner +pagination_label: PatOwner +sidebar_label: PatOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PatOwner', 'V2024PatOwner'] +slug: /tools/sdk/powershell/v2024/models/pat-owner +tags: ['SDK', 'Software Development Kit', 'PatOwner', 'V2024PatOwner'] +--- + + +# PatOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Personal access token owner's DTO type. | [optional] +**Id** | Pointer to **String** | Personal access token owner's identity ID. | [optional] +**Name** | Pointer to **String** | Personal access token owner's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$PatOwner = Initialize-PSSailpoint.V2024PatOwner -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Support +``` + +- Convert the resource to JSON +```powershell +$PatOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PatchPotentialRoleRequestInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PatchPotentialRoleRequestInner.md new file mode 100644 index 000000000..6a7a8403d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PatchPotentialRoleRequestInner.md @@ -0,0 +1,39 @@ +--- +id: v2024-patch-potential-role-request-inner +title: PatchPotentialRoleRequestInner +pagination_label: PatchPotentialRoleRequestInner +sidebar_label: PatchPotentialRoleRequestInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PatchPotentialRoleRequestInner', 'V2024PatchPotentialRoleRequestInner'] +slug: /tools/sdk/powershell/v2024/models/patch-potential-role-request-inner +tags: ['SDK', 'Software Development Kit', 'PatchPotentialRoleRequestInner', 'V2024PatchPotentialRoleRequestInner'] +--- + + +# PatchPotentialRoleRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | Pointer to **Enum** [ "remove", "replace" ] | The operation to be performed | [optional] +**Path** | **String** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required] +**Value** | Pointer to [**JsonPatchOperationValue**](json-patch-operation-value) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PatchPotentialRoleRequestInner = Initialize-PSSailpoint.V2024PatchPotentialRoleRequestInner -Op replace ` + -Path /description ` + -Value null +``` + +- Convert the resource to JSON +```powershell +$PatchPotentialRoleRequestInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PatchServiceDeskIntegrationRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PatchServiceDeskIntegrationRequest.md new file mode 100644 index 000000000..7f650c082 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PatchServiceDeskIntegrationRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-patch-service-desk-integration-request +title: PatchServiceDeskIntegrationRequest +pagination_label: PatchServiceDeskIntegrationRequest +sidebar_label: PatchServiceDeskIntegrationRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PatchServiceDeskIntegrationRequest', 'V2024PatchServiceDeskIntegrationRequest'] +slug: /tools/sdk/powershell/v2024/models/patch-service-desk-integration-request +tags: ['SDK', 'Software Development Kit', 'PatchServiceDeskIntegrationRequest', 'V2024PatchServiceDeskIntegrationRequest'] +--- + + +# PatchServiceDeskIntegrationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operations** | Pointer to [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] + +## Examples + +- Prepare the resource +```powershell +$PatchServiceDeskIntegrationRequest = Initialize-PSSailpoint.V2024PatchServiceDeskIntegrationRequest -Operations null +``` + +- Convert the resource to JSON +```powershell +$PatchServiceDeskIntegrationRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PeerGroupMember.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PeerGroupMember.md new file mode 100644 index 000000000..6bc01b3db --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PeerGroupMember.md @@ -0,0 +1,41 @@ +--- +id: v2024-peer-group-member +title: PeerGroupMember +pagination_label: PeerGroupMember +sidebar_label: PeerGroupMember +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PeerGroupMember', 'V2024PeerGroupMember'] +slug: /tools/sdk/powershell/v2024/models/peer-group-member +tags: ['SDK', 'Software Development Kit', 'PeerGroupMember', 'V2024PeerGroupMember'] +--- + + +# PeerGroupMember + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | A unique identifier for the peer group member. | [optional] +**Type** | Pointer to **String** | The type of the peer group member. | [optional] +**PeerGroupId** | Pointer to **String** | The ID of the peer group. | [optional] +**Attributes** | Pointer to [**map[string]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Arbitrary key-value pairs, belonging to the peer group member. | [optional] + +## Examples + +- Prepare the resource +```powershell +$PeerGroupMember = Initialize-PSSailpoint.V2024PeerGroupMember -Id null ` + -Type null ` + -PeerGroupId null ` + -Attributes null +``` + +- Convert the resource to JSON +```powershell +$PeerGroupMember | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PendingApproval.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PendingApproval.md new file mode 100644 index 000000000..c6319bb14 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PendingApproval.md @@ -0,0 +1,71 @@ +--- +id: v2024-pending-approval +title: PendingApproval +pagination_label: PendingApproval +sidebar_label: PendingApproval +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PendingApproval', 'V2024PendingApproval'] +slug: /tools/sdk/powershell/v2024/models/pending-approval +tags: ['SDK', 'Software Development Kit', 'PendingApproval', 'V2024PendingApproval'] +--- + + +# PendingApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The approval id. | [optional] +**Name** | Pointer to **String** | The name of the approval. | [optional] +**Created** | Pointer to **System.DateTime** | When the approval was created. | [optional] +**Modified** | Pointer to **System.DateTime** | When the approval was modified last time. | [optional] +**RequestCreated** | Pointer to **System.DateTime** | When the access-request was created. | [optional] +**RequestType** | Pointer to [**AccessRequestType**](access-request-type) | | [optional] +**Requester** | Pointer to [**AccessItemRequester**](access-item-requester) | | [optional] +**RequestedFor** | Pointer to [**[]AccessItemRequestedFor**](access-item-requested-for) | Identities access was requested for. | [optional] +**Owner** | Pointer to [**PendingApprovalOwner**](pending-approval-owner) | | [optional] +**RequestedObject** | Pointer to [**RequestableObjectReference**](requestable-object-reference) | | [optional] +**RequesterComment** | Pointer to [**CommentDto**](comment-dto) | | [optional] +**PreviousReviewersComments** | Pointer to [**[]CommentDto**](comment-dto) | The history of the previous reviewers comments. | [optional] +**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] +**CommentRequiredWhenRejected** | Pointer to **Boolean** | When true the rejector has to provide comments when rejecting | [optional] [default to $false] +**ActionInProcess** | Pointer to [**PendingApprovalAction**](pending-approval-action) | | [optional] +**RemoveDate** | Pointer to **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +**RemoveDateUpdateRequested** | Pointer to **Boolean** | If true, then the request is to change the remove date or sunset date. | [optional] [default to $false] +**CurrentRemoveDate** | Pointer to **System.DateTime** | The remove date or sunset date that was assigned at the time of the request. | [optional] +**SodViolationContext** | Pointer to [**SodViolationContextCheckCompleted**](sod-violation-context-check-completed) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PendingApproval = Initialize-PSSailpoint.V2024PendingApproval -Id id12345 ` + -Name aName ` + -Created 2017-07-11T18:45:37.098Z ` + -Modified 2018-07-25T20:22:28.104Z ` + -RequestCreated 2017-07-11T18:45:35.098Z ` + -RequestType null ` + -Requester null ` + -RequestedFor null ` + -Owner null ` + -RequestedObject null ` + -RequesterComment null ` + -PreviousReviewersComments null ` + -ForwardHistory null ` + -CommentRequiredWhenRejected true ` + -ActionInProcess null ` + -RemoveDate 2020-07-11T00:00Z ` + -RemoveDateUpdateRequested true ` + -CurrentRemoveDate 2020-07-11T00:00Z ` + -SodViolationContext null +``` + +- Convert the resource to JSON +```powershell +$PendingApproval | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PendingApprovalAction.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PendingApprovalAction.md new file mode 100644 index 000000000..469891845 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PendingApprovalAction.md @@ -0,0 +1,26 @@ +--- +id: v2024-pending-approval-action +title: PendingApprovalAction +pagination_label: PendingApprovalAction +sidebar_label: PendingApprovalAction +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PendingApprovalAction', 'V2024PendingApprovalAction'] +slug: /tools/sdk/powershell/v2024/models/pending-approval-action +tags: ['SDK', 'Software Development Kit', 'PendingApprovalAction', 'V2024PendingApprovalAction'] +--- + + +# PendingApprovalAction + +## Enum + + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `FORWARDED` (value: `"FORWARDED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PendingApprovalOwner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PendingApprovalOwner.md new file mode 100644 index 000000000..0d7cdad8f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PendingApprovalOwner.md @@ -0,0 +1,39 @@ +--- +id: v2024-pending-approval-owner +title: PendingApprovalOwner +pagination_label: PendingApprovalOwner +sidebar_label: PendingApprovalOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PendingApprovalOwner', 'V2024PendingApprovalOwner'] +slug: /tools/sdk/powershell/v2024/models/pending-approval-owner +tags: ['SDK', 'Software Development Kit', 'PendingApprovalOwner', 'V2024PendingApprovalOwner'] +--- + + +# PendingApprovalOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Access item owner's DTO type. | [optional] +**Id** | Pointer to **String** | Access item owner's identity ID. | [optional] +**Name** | Pointer to **String** | Access item owner's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$PendingApprovalOwner = Initialize-PSSailpoint.V2024PendingApprovalOwner -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Support +``` + +- Convert the resource to JSON +```powershell +$PendingApprovalOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PermissionDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PermissionDto.md new file mode 100644 index 000000000..46fc5489a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PermissionDto.md @@ -0,0 +1,37 @@ +--- +id: v2024-permission-dto +title: PermissionDto +pagination_label: PermissionDto +sidebar_label: PermissionDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PermissionDto', 'V2024PermissionDto'] +slug: /tools/sdk/powershell/v2024/models/permission-dto +tags: ['SDK', 'Software Development Kit', 'PermissionDto', 'V2024PermissionDto'] +--- + + +# PermissionDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Rights** | Pointer to **[]String** | All the rights (e.g. actions) that this permission allows on the target | [optional] [readonly] +**Target** | Pointer to **String** | The target the permission would grants rights on. | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$PermissionDto = Initialize-PSSailpoint.V2024PermissionDto -Rights null ` + -Target SYS.GV_$TRANSACTION +``` + +- Convert the resource to JSON +```powershell +$PermissionDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PreApprovalTriggerDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PreApprovalTriggerDetails.md new file mode 100644 index 000000000..b6d389271 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PreApprovalTriggerDetails.md @@ -0,0 +1,39 @@ +--- +id: v2024-pre-approval-trigger-details +title: PreApprovalTriggerDetails +pagination_label: PreApprovalTriggerDetails +sidebar_label: PreApprovalTriggerDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PreApprovalTriggerDetails', 'V2024PreApprovalTriggerDetails'] +slug: /tools/sdk/powershell/v2024/models/pre-approval-trigger-details +tags: ['SDK', 'Software Development Kit', 'PreApprovalTriggerDetails', 'V2024PreApprovalTriggerDetails'] +--- + + +# PreApprovalTriggerDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment left for the pre-approval decision | [optional] +**Reviewer** | Pointer to **String** | The reviewer of the pre-approval decision | [optional] +**Decision** | Pointer to **Enum** [ "APPROVED", "REJECTED" ] | The decision of the pre-approval trigger | [optional] + +## Examples + +- Prepare the resource +```powershell +$PreApprovalTriggerDetails = Initialize-PSSailpoint.V2024PreApprovalTriggerDetails -Comment Access is Approved ` + -Reviewer John Doe ` + -Decision APPROVED +``` + +- Convert the resource to JSON +```powershell +$PreApprovalTriggerDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PreferencesDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PreferencesDto.md new file mode 100644 index 000000000..756d0e6a1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PreferencesDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-preferences-dto +title: PreferencesDto +pagination_label: PreferencesDto +sidebar_label: PreferencesDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PreferencesDto', 'V2024PreferencesDto'] +slug: /tools/sdk/powershell/v2024/models/preferences-dto +tags: ['SDK', 'Software Development Kit', 'PreferencesDto', 'V2024PreferencesDto'] +--- + + +# PreferencesDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **String** | The template notification key. | [optional] +**Mediums** | Pointer to [**[]Medium**](medium) | List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future. | [optional] +**Modified** | Pointer to **System.DateTime** | Modified date of preference | [optional] + +## Examples + +- Prepare the resource +```powershell +$PreferencesDto = Initialize-PSSailpoint.V2024PreferencesDto -Key cloud_manual_work_item_summary ` + -Mediums [EMAIL] ` + -Modified 2020-05-15T14:37:06.909Z +``` + +- Convert the resource to JSON +```powershell +$PreferencesDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PreviewDataSourceResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PreviewDataSourceResponse.md new file mode 100644 index 000000000..1b6bff009 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PreviewDataSourceResponse.md @@ -0,0 +1,35 @@ +--- +id: v2024-preview-data-source-response +title: PreviewDataSourceResponse +pagination_label: PreviewDataSourceResponse +sidebar_label: PreviewDataSourceResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PreviewDataSourceResponse', 'V2024PreviewDataSourceResponse'] +slug: /tools/sdk/powershell/v2024/models/preview-data-source-response +tags: ['SDK', 'Software Development Kit', 'PreviewDataSourceResponse', 'V2024PreviewDataSourceResponse'] +--- + + +# PreviewDataSourceResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Results** | Pointer to [**[]FormElementDataSourceConfigOptions**](form-element-data-source-config-options) | Results holds a list of FormElementDataSourceConfigOptions items | [optional] + +## Examples + +- Prepare the resource +```powershell +$PreviewDataSourceResponse = Initialize-PSSailpoint.V2024PreviewDataSourceResponse -Results {"results":[{"label":"Alfred 255e71dfc6e","subLabel":"Alfred.255e71dfc6e@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16676"},{"label":"Alize eba9d4cd27da","subLabel":"Alize.eba9d4cd27da@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f1667c"},{"label":"Antonina 01f69c3ea","subLabel":"Antonina.01f69c3ea@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f9667e"},{"label":"Ardella 21e78ce155","subLabel":"Ardella.21e78ce155@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e6667a"},{"label":"Arnaldo d8582b6e17","subLabel":"Arnaldo.d8582b6e17@testmail.identitysoon.com","value":"2c918084821847c5018227ced3426686"},{"label":"Aurelia admin24828","subLabel":"Aurelia.admin24828@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16674"},{"label":"Barbara 72ca418fdd","subLabel":"Barbara.72ca418fdd@testmail.identitysoon.com","value":"2c918084821847c5018227ced2fb6680"},{"label":"Barbara ee1a2436ee","subLabel":"Barbara.ee1a2436ee@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e56678"},{"label":"Baylee 652d72432f3","subLabel":"Baylee.652d72432f3@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aee"},{"label":"Brock e76b56ae4d49","subLabel":"Brock.e76b56ae4d49@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aef"}]} +``` + +- Convert the resource to JSON +```powershell +$PreviewDataSourceResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProcessIdentitiesRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProcessIdentitiesRequest.md new file mode 100644 index 000000000..b11ab3dc9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProcessIdentitiesRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-process-identities-request +title: ProcessIdentitiesRequest +pagination_label: ProcessIdentitiesRequest +sidebar_label: ProcessIdentitiesRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProcessIdentitiesRequest', 'V2024ProcessIdentitiesRequest'] +slug: /tools/sdk/powershell/v2024/models/process-identities-request +tags: ['SDK', 'Software Development Kit', 'ProcessIdentitiesRequest', 'V2024ProcessIdentitiesRequest'] +--- + + +# ProcessIdentitiesRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityIds** | Pointer to **[]String** | List of up to 250 identity IDs to process. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProcessIdentitiesRequest = Initialize-PSSailpoint.V2024ProcessIdentitiesRequest -IdentityIds null +``` + +- Convert the resource to JSON +```powershell +$ProcessIdentitiesRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProcessingDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProcessingDetails.md new file mode 100644 index 000000000..db9bd9b77 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProcessingDetails.md @@ -0,0 +1,43 @@ +--- +id: v2024-processing-details +title: ProcessingDetails +pagination_label: ProcessingDetails +sidebar_label: ProcessingDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProcessingDetails', 'V2024ProcessingDetails'] +slug: /tools/sdk/powershell/v2024/models/processing-details +tags: ['SDK', 'Software Development Kit', 'ProcessingDetails', 'V2024ProcessingDetails'] +--- + + +# ProcessingDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Date** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] +**Stage** | Pointer to **String** | | [optional] +**RetryCount** | Pointer to **Int32** | | [optional] +**VarStackTrace** | Pointer to **String** | | [optional] +**Message** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProcessingDetails = Initialize-PSSailpoint.V2024ProcessingDetails -Date 2018-06-25T20:22:28.104Z ` + -Stage In Process ` + -RetryCount 0 ` + -VarStackTrace <stack trace> ` + -Message <message> +``` + +- Convert the resource to JSON +```powershell +$ProcessingDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Product.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Product.md new file mode 100644 index 000000000..66ebe084e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Product.md @@ -0,0 +1,65 @@ +--- +id: v2024-product +title: Product +pagination_label: Product +sidebar_label: Product +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Product', 'V2024Product'] +slug: /tools/sdk/powershell/v2024/models/product +tags: ['SDK', 'Software Development Kit', 'Product', 'V2024Product'] +--- + + +# Product + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ProductName** | Pointer to **String** | Name of the Product | [optional] +**Url** | Pointer to **String** | URL of the Product | [optional] +**ProductTenantId** | Pointer to **String** | An identifier for a specific product-tenant combination | [optional] +**ProductRegion** | Pointer to **String** | Product region | [optional] +**ProductRight** | Pointer to **String** | Right needed for the Product | [optional] +**ApiUrl** | Pointer to **String** | API URL of the Product | [optional] +**Licenses** | Pointer to [**[]License**](license) | | [optional] +**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Additional attributes for a product | [optional] +**Zone** | Pointer to **String** | Zone | [optional] +**Status** | Pointer to **String** | Status of the product | [optional] +**StatusDateTime** | Pointer to **System.DateTime** | Status datetime | [optional] +**Reason** | Pointer to **String** | If there's a tenant provisioning failure then reason will have the description of error | [optional] +**Notes** | Pointer to **String** | Product could have additional notes added during tenant provisioning. | [optional] +**DateCreated** | Pointer to **System.DateTime** | Date when the product was created | [optional] +**LastUpdated** | Pointer to **System.DateTime** | Date when the product was last updated | [optional] +**OrgType** | Pointer to **Enum** [ "development", "staging", "production", "test", "partner", "training", "demonstration", "sandbox" ] | Type of org | [optional] + +## Examples + +- Prepare the resource +```powershell +$Product = Initialize-PSSailpoint.V2024Product -ProductName idn ` + -Url https://tenant-name.identitynow.com ` + -ProductTenantId tenant#product ` + -ProductRegion us-east-1 ` + -ProductRight idn:ui:view ` + -ApiUrl https://tenant-name.api.identitynow.com ` + -Licenses null ` + -Attributes {domain=https://tenant-name.identitynow.com, maxRegisteredUsers=250} ` + -Zone Deployment zone for the Product ` + -Status active ` + -StatusDateTime 2020-05-19T13:49:37.385Z ` + -Reason Reason ` + -Notes Example notes ` + -DateCreated 2020-05-19T13:49:37.385Z ` + -LastUpdated 2020-05-19T13:49:37.385Z ` + -OrgType test +``` + +- Convert the resource to JSON +```powershell +$Product | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCompleted.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCompleted.md new file mode 100644 index 000000000..878c8eac3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCompleted.md @@ -0,0 +1,49 @@ +--- +id: v2024-provisioning-completed +title: ProvisioningCompleted +pagination_label: ProvisioningCompleted +sidebar_label: ProvisioningCompleted +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCompleted', 'V2024ProvisioningCompleted'] +slug: /tools/sdk/powershell/v2024/models/provisioning-completed +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompleted', 'V2024ProvisioningCompleted'] +--- + + +# ProvisioningCompleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TrackingNumber** | **String** | The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. | [required] +**Sources** | **String** | One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. | [required] +**Action** | Pointer to **String** | Origin of where the provisioning request came from. | [optional] +**Errors** | Pointer to **[]String** | A list of any accumulated error messages that occurred during provisioning. | [optional] +**Warnings** | Pointer to **[]String** | A list of any accumulated warning messages that occurred during provisioning. | [optional] +**Recipient** | [**ProvisioningCompletedRecipient**](provisioning-completed-recipient) | | [required] +**Requester** | Pointer to [**ProvisioningCompletedRequester**](provisioning-completed-requester) | | [optional] +**AccountRequests** | [**[]ProvisioningCompletedAccountRequestsInner**](provisioning-completed-account-requests-inner) | A list of provisioning instructions to perform on an account-by-account basis. | [required] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningCompleted = Initialize-PSSailpoint.V2024ProvisioningCompleted -TrackingNumber 4b4d982dddff4267ab12f0f1e72b5a6d ` + -Sources Corp AD, Corp LDAP, Corp Salesforce ` + -Action IdentityRefresh ` + -Errors null ` + -Warnings null ` + -Recipient null ` + -Requester null ` + -AccountRequests null +``` + +- Convert the resource to JSON +```powershell +$ProvisioningCompleted | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCompletedAccountRequestsInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCompletedAccountRequestsInner.md new file mode 100644 index 000000000..027d6eecf --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCompletedAccountRequestsInner.md @@ -0,0 +1,47 @@ +--- +id: v2024-provisioning-completed-account-requests-inner +title: ProvisioningCompletedAccountRequestsInner +pagination_label: ProvisioningCompletedAccountRequestsInner +sidebar_label: ProvisioningCompletedAccountRequestsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCompletedAccountRequestsInner', 'V2024ProvisioningCompletedAccountRequestsInner'] +slug: /tools/sdk/powershell/v2024/models/provisioning-completed-account-requests-inner +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsInner', 'V2024ProvisioningCompletedAccountRequestsInner'] +--- + + +# ProvisioningCompletedAccountRequestsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | [**ProvisioningCompletedAccountRequestsInnerSource**](provisioning-completed-account-requests-inner-source) | | [required] +**AccountId** | Pointer to **String** | The unique idenfier of the account being provisioned. | [optional] +**AccountOperation** | **String** | The provisioning operation; typically Create, Modify, Enable, Disable, Unlock, or Delete. | [required] +**ProvisioningResult** | **Enum** [ "SUCCESS", "PENDING", "FAILED" ] | The overall result of the provisioning transaction; this could be success, pending, failed, etc. | [required] +**ProvisioningTarget** | **String** | The name of the provisioning channel selected; this could be the same as the source, or could be a Service Desk Integration Module (SDIM). | [required] +**TicketId** | Pointer to **String** | A reference to a tracking number, if this is sent to a Service Desk Integration Module (SDIM). | [optional] +**AttributeRequests** | Pointer to [**[]ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner**](provisioning-completed-account-requests-inner-attribute-requests-inner) | A list of attributes as part of the provisioning transaction. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningCompletedAccountRequestsInner = Initialize-PSSailpoint.V2024ProvisioningCompletedAccountRequestsInner -Source null ` + -AccountId CN=Chewy.Bacca,ou=hardcorefigter,ou=wookies,dc=starwars,dc=com ` + -AccountOperation Modify ` + -ProvisioningResult SUCCESS ` + -ProvisioningTarget Corp AD ` + -TicketId 72619262 ` + -AttributeRequests null +``` + +- Convert the resource to JSON +```powershell +$ProvisioningCompletedAccountRequestsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md new file mode 100644 index 000000000..dea1efe5d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md @@ -0,0 +1,39 @@ +--- +id: v2024-provisioning-completed-account-requests-inner-attribute-requests-inner +title: ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner +pagination_label: ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner +sidebar_label: ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner', 'V2024ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner'] +slug: /tools/sdk/powershell/v2024/models/provisioning-completed-account-requests-inner-attribute-requests-inner +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner', 'V2024ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner'] +--- + + +# ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AttributeName** | **String** | The name of the attribute being provisioned. | [required] +**AttributeValue** | Pointer to **String** | The value of the attribute being provisioned. | [optional] +**Operation** | **Enum** [ "Add", "Set", "Remove" ] | The operation to handle the attribute. | [required] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner = Initialize-PSSailpoint.V2024ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner -AttributeName memberOf ` + -AttributeValue CN=jedi,DC=starwars,DC=com ` + -Operation Add +``` + +- Convert the resource to JSON +```powershell +$ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCompletedAccountRequestsInnerSource.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCompletedAccountRequestsInnerSource.md new file mode 100644 index 000000000..4eaf044ce --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCompletedAccountRequestsInnerSource.md @@ -0,0 +1,39 @@ +--- +id: v2024-provisioning-completed-account-requests-inner-source +title: ProvisioningCompletedAccountRequestsInnerSource +pagination_label: ProvisioningCompletedAccountRequestsInnerSource +sidebar_label: ProvisioningCompletedAccountRequestsInnerSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCompletedAccountRequestsInnerSource', 'V2024ProvisioningCompletedAccountRequestsInnerSource'] +slug: /tools/sdk/powershell/v2024/models/provisioning-completed-account-requests-inner-source +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsInnerSource', 'V2024ProvisioningCompletedAccountRequestsInnerSource'] +--- + + +# ProvisioningCompletedAccountRequestsInnerSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | ID of the object to which this reference applies | [required] +**Type** | **Enum** [ "SOURCE" ] | The type of object that is referenced | [required] +**Name** | **String** | Human-readable display name of the object to which this reference applies | [required] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningCompletedAccountRequestsInnerSource = Initialize-PSSailpoint.V2024ProvisioningCompletedAccountRequestsInnerSource -Id 4e4d982dddff4267ab12f0f1e72b5a6d ` + -Type SOURCE ` + -Name Corporate Active Directory +``` + +- Convert the resource to JSON +```powershell +$ProvisioningCompletedAccountRequestsInnerSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCompletedRecipient.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCompletedRecipient.md new file mode 100644 index 000000000..e67b1df9c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCompletedRecipient.md @@ -0,0 +1,39 @@ +--- +id: v2024-provisioning-completed-recipient +title: ProvisioningCompletedRecipient +pagination_label: ProvisioningCompletedRecipient +sidebar_label: ProvisioningCompletedRecipient +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCompletedRecipient', 'V2024ProvisioningCompletedRecipient'] +slug: /tools/sdk/powershell/v2024/models/provisioning-completed-recipient +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedRecipient', 'V2024ProvisioningCompletedRecipient'] +--- + + +# ProvisioningCompletedRecipient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | Provisioning recipient DTO type. | [required] +**Id** | **String** | Provisioning recipient's identity ID. | [required] +**Name** | **String** | Provisioning recipient's display name. | [required] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningCompletedRecipient = Initialize-PSSailpoint.V2024ProvisioningCompletedRecipient -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$ProvisioningCompletedRecipient | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCompletedRequester.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCompletedRequester.md new file mode 100644 index 000000000..955125de1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCompletedRequester.md @@ -0,0 +1,39 @@ +--- +id: v2024-provisioning-completed-requester +title: ProvisioningCompletedRequester +pagination_label: ProvisioningCompletedRequester +sidebar_label: ProvisioningCompletedRequester +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCompletedRequester', 'V2024ProvisioningCompletedRequester'] +slug: /tools/sdk/powershell/v2024/models/provisioning-completed-requester +tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedRequester', 'V2024ProvisioningCompletedRequester'] +--- + + +# ProvisioningCompletedRequester + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | Provisioning requester's DTO type. | [required] +**Id** | **String** | Provisioning requester's identity ID. | [required] +**Name** | **String** | Provisioning owner's human-readable display name. | [required] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningCompletedRequester = Initialize-PSSailpoint.V2024ProvisioningCompletedRequester -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20648 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$ProvisioningCompletedRequester | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningConfig.md new file mode 100644 index 000000000..346d612a1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningConfig.md @@ -0,0 +1,43 @@ +--- +id: v2024-provisioning-config +title: ProvisioningConfig +pagination_label: ProvisioningConfig +sidebar_label: ProvisioningConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningConfig', 'V2024ProvisioningConfig'] +slug: /tools/sdk/powershell/v2024/models/provisioning-config +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfig', 'V2024ProvisioningConfig'] +--- + + +# ProvisioningConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UniversalManager** | Pointer to **Boolean** | Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. | [optional] [readonly] [default to $false] +**ManagedResourceRefs** | Pointer to [**[]ServiceDeskSource**](service-desk-source) | References to sources for the Service Desk integration template. May only be specified if universalManager is false. | [optional] +**PlanInitializerScript** | Pointer to [**ProvisioningConfigPlanInitializerScript**](provisioning-config-plan-initializer-script) | | [optional] +**NoProvisioningRequests** | Pointer to **Boolean** | Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. | [optional] [default to $false] +**ProvisioningRequestExpiration** | Pointer to **Int32** | When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningConfig = Initialize-PSSailpoint.V2024ProvisioningConfig -UniversalManager true ` + -ManagedResourceRefs [{type=SOURCE, id=2c9180855d191c59015d291ceb051111, name=My Source 1}, {type=SOURCE, id=2c9180855d191c59015d291ceb052222, name=My Source 2}] ` + -PlanInitializerScript null ` + -NoProvisioningRequests true ` + -ProvisioningRequestExpiration 7 +``` + +- Convert the resource to JSON +```powershell +$ProvisioningConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningConfig1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningConfig1.md new file mode 100644 index 000000000..bc8717694 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningConfig1.md @@ -0,0 +1,43 @@ +--- +id: v2024-provisioning-config1 +title: ProvisioningConfig1 +pagination_label: ProvisioningConfig1 +sidebar_label: ProvisioningConfig1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningConfig1', 'V2024ProvisioningConfig1'] +slug: /tools/sdk/powershell/v2024/models/provisioning-config1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfig1', 'V2024ProvisioningConfig1'] +--- + + +# ProvisioningConfig1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UniversalManager** | Pointer to **Boolean** | Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. | [optional] [readonly] [default to $false] +**ManagedResourceRefs** | Pointer to [**[]ProvisioningConfig1ManagedResourceRefsInner**](provisioning-config1-managed-resource-refs-inner) | References to sources for the Service Desk integration template. May only be specified if universalManager is false. | [optional] +**PlanInitializerScript** | Pointer to [**ProvisioningConfig1PlanInitializerScript**](provisioning-config1-plan-initializer-script) | | [optional] +**NoProvisioningRequests** | Pointer to **Boolean** | Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. | [optional] [default to $false] +**ProvisioningRequestExpiration** | Pointer to **Int32** | When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningConfig1 = Initialize-PSSailpoint.V2024ProvisioningConfig1 -UniversalManager true ` + -ManagedResourceRefs [{type=SOURCE, id=2c9180855d191c59015d291ceb051111, name=My Source 1}, {type=SOURCE, id=2c9180855d191c59015d291ceb052222, name=My Source 2}] ` + -PlanInitializerScript null ` + -NoProvisioningRequests true ` + -ProvisioningRequestExpiration 7 +``` + +- Convert the resource to JSON +```powershell +$ProvisioningConfig1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningConfig1ManagedResourceRefsInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningConfig1ManagedResourceRefsInner.md new file mode 100644 index 000000000..7c502eefa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningConfig1ManagedResourceRefsInner.md @@ -0,0 +1,39 @@ +--- +id: v2024-provisioning-config1-managed-resource-refs-inner +title: ProvisioningConfig1ManagedResourceRefsInner +pagination_label: ProvisioningConfig1ManagedResourceRefsInner +sidebar_label: ProvisioningConfig1ManagedResourceRefsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningConfig1ManagedResourceRefsInner', 'V2024ProvisioningConfig1ManagedResourceRefsInner'] +slug: /tools/sdk/powershell/v2024/models/provisioning-config1-managed-resource-refs-inner +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfig1ManagedResourceRefsInner', 'V2024ProvisioningConfig1ManagedResourceRefsInner'] +--- + + +# ProvisioningConfig1ManagedResourceRefsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "SOURCE" ] | The type of object being referenced | [optional] +**Id** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | ID of the source | [optional] +**Name** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Human-readable display name of the source | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningConfig1ManagedResourceRefsInner = Initialize-PSSailpoint.V2024ProvisioningConfig1ManagedResourceRefsInner -Type SOURCE ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name My Source +``` + +- Convert the resource to JSON +```powershell +$ProvisioningConfig1ManagedResourceRefsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningConfig1PlanInitializerScript.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningConfig1PlanInitializerScript.md new file mode 100644 index 000000000..f7fecba8d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningConfig1PlanInitializerScript.md @@ -0,0 +1,36 @@ +--- +id: v2024-provisioning-config1-plan-initializer-script +title: ProvisioningConfig1PlanInitializerScript +pagination_label: ProvisioningConfig1PlanInitializerScript +sidebar_label: ProvisioningConfig1PlanInitializerScript +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningConfig1PlanInitializerScript', 'V2024ProvisioningConfig1PlanInitializerScript'] +slug: /tools/sdk/powershell/v2024/models/provisioning-config1-plan-initializer-script +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfig1PlanInitializerScript', 'V2024ProvisioningConfig1PlanInitializerScript'] +--- + + +# ProvisioningConfig1PlanInitializerScript + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | Pointer to **String** | This is a Rule that allows provisioning instruction changes. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningConfig1PlanInitializerScript = Initialize-PSSailpoint.V2024ProvisioningConfig1PlanInitializerScript -Source <?xml version='1.0' encoding='UTF-8'?>\r\n<!DOCTYPE Rule PUBLIC \"sailpoint.dtd\" \"sailpoint.dtd\">\r\n<Rule name=\"Example Rule\" type=\"BeforeProvisioning\">\r\n <Description>Before Provisioning Rule which changes disables and enables to a modify.</Description>\r\n <Source><![CDATA[\r\nimport sailpoint.object.*;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest.Operation;\r\nimport sailpoint.object.ProvisioningPlan.AttributeRequest;\r\nimport sailpoint.object.ProvisioningPlan;\r\nimport sailpoint.object.ProvisioningPlan.Operation;\r\n\r\nfor ( AccountRequest accountRequest : plan.getAccountRequests() ) {\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Disable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Enable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n}\r\n\r\n ]]></Source> + +``` + +- Convert the resource to JSON +```powershell +$ProvisioningConfig1PlanInitializerScript | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningConfigPlanInitializerScript.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningConfigPlanInitializerScript.md new file mode 100644 index 000000000..1ccf5bd0a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningConfigPlanInitializerScript.md @@ -0,0 +1,36 @@ +--- +id: v2024-provisioning-config-plan-initializer-script +title: ProvisioningConfigPlanInitializerScript +pagination_label: ProvisioningConfigPlanInitializerScript +sidebar_label: ProvisioningConfigPlanInitializerScript +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningConfigPlanInitializerScript', 'V2024ProvisioningConfigPlanInitializerScript'] +slug: /tools/sdk/powershell/v2024/models/provisioning-config-plan-initializer-script +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfigPlanInitializerScript', 'V2024ProvisioningConfigPlanInitializerScript'] +--- + + +# ProvisioningConfigPlanInitializerScript + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | Pointer to **String** | This is a Rule that allows provisioning instruction changes. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningConfigPlanInitializerScript = Initialize-PSSailpoint.V2024ProvisioningConfigPlanInitializerScript -Source <?xml version='1.0' encoding='UTF-8'?>\r\n<!DOCTYPE Rule PUBLIC \"sailpoint.dtd\" \"sailpoint.dtd\">\r\n<Rule name=\"Example Rule\" type=\"BeforeProvisioning\">\r\n <Description>Before Provisioning Rule which changes disables and enables to a modify.</Description>\r\n <Source><![CDATA[\r\nimport sailpoint.object.*;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest.Operation;\r\nimport sailpoint.object.ProvisioningPlan.AttributeRequest;\r\nimport sailpoint.object.ProvisioningPlan;\r\nimport sailpoint.object.ProvisioningPlan.Operation;\r\n\r\nfor ( AccountRequest accountRequest : plan.getAccountRequests() ) {\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Disable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Enable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n}\r\n\r\n ]]></Source> + +``` + +- Convert the resource to JSON +```powershell +$ProvisioningConfigPlanInitializerScript | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCriteriaLevel1.md new file mode 100644 index 000000000..3ca7e53d9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCriteriaLevel1.md @@ -0,0 +1,41 @@ +--- +id: v2024-provisioning-criteria-level1 +title: ProvisioningCriteriaLevel1 +pagination_label: ProvisioningCriteriaLevel1 +sidebar_label: ProvisioningCriteriaLevel1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCriteriaLevel1', 'V2024ProvisioningCriteriaLevel1'] +slug: /tools/sdk/powershell/v2024/models/provisioning-criteria-level1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'V2024ProvisioningCriteriaLevel1'] +--- + + +# ProvisioningCriteriaLevel1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**Attribute** | Pointer to **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] +**Value** | Pointer to **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] +**Children** | Pointer to [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningCriteriaLevel1 = Initialize-PSSailpoint.V2024ProvisioningCriteriaLevel1 -Operation null ` + -Attribute email ` + -Value carlee.cert1c9f9b6fd@mailinator.com ` + -Children null +``` + +- Convert the resource to JSON +```powershell +$ProvisioningCriteriaLevel1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCriteriaLevel2.md new file mode 100644 index 000000000..f00792e73 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCriteriaLevel2.md @@ -0,0 +1,41 @@ +--- +id: v2024-provisioning-criteria-level2 +title: ProvisioningCriteriaLevel2 +pagination_label: ProvisioningCriteriaLevel2 +sidebar_label: ProvisioningCriteriaLevel2 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCriteriaLevel2', 'V2024ProvisioningCriteriaLevel2'] +slug: /tools/sdk/powershell/v2024/models/provisioning-criteria-level2 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'V2024ProvisioningCriteriaLevel2'] +--- + + +# ProvisioningCriteriaLevel2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**Attribute** | Pointer to **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] +**Value** | Pointer to **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] +**Children** | Pointer to [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningCriteriaLevel2 = Initialize-PSSailpoint.V2024ProvisioningCriteriaLevel2 -Operation null ` + -Attribute email ` + -Value carlee.cert1c9f9b6fd@mailinator.com ` + -Children null +``` + +- Convert the resource to JSON +```powershell +$ProvisioningCriteriaLevel2 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCriteriaLevel3.md new file mode 100644 index 000000000..bb90ccff2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCriteriaLevel3.md @@ -0,0 +1,41 @@ +--- +id: v2024-provisioning-criteria-level3 +title: ProvisioningCriteriaLevel3 +pagination_label: ProvisioningCriteriaLevel3 +sidebar_label: ProvisioningCriteriaLevel3 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCriteriaLevel3', 'V2024ProvisioningCriteriaLevel3'] +slug: /tools/sdk/powershell/v2024/models/provisioning-criteria-level3 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'V2024ProvisioningCriteriaLevel3'] +--- + + +# ProvisioningCriteriaLevel3 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**Attribute** | Pointer to **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] +**Value** | Pointer to **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] +**Children** | Pointer to **String** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningCriteriaLevel3 = Initialize-PSSailpoint.V2024ProvisioningCriteriaLevel3 -Operation null ` + -Attribute email ` + -Value carlee.cert1c9f9b6fd@mailinator.com ` + -Children null +``` + +- Convert the resource to JSON +```powershell +$ProvisioningCriteriaLevel3 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCriteriaOperation.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCriteriaOperation.md new file mode 100644 index 000000000..83d42f3b2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningCriteriaOperation.md @@ -0,0 +1,32 @@ +--- +id: v2024-provisioning-criteria-operation +title: ProvisioningCriteriaOperation +pagination_label: ProvisioningCriteriaOperation +sidebar_label: ProvisioningCriteriaOperation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCriteriaOperation', 'V2024ProvisioningCriteriaOperation'] +slug: /tools/sdk/powershell/v2024/models/provisioning-criteria-operation +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaOperation', 'V2024ProvisioningCriteriaOperation'] +--- + + +# ProvisioningCriteriaOperation + +## Enum + + +* `EQUALS` (value: `"EQUALS"`) + +* `NOT_EQUALS` (value: `"NOT_EQUALS"`) + +* `CONTAINS` (value: `"CONTAINS"`) + +* `HAS` (value: `"HAS"`) + +* `AND` (value: `"AND"`) + +* `OR` (value: `"OR"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningDetails.md new file mode 100644 index 000000000..fe57d54c8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningDetails.md @@ -0,0 +1,35 @@ +--- +id: v2024-provisioning-details +title: ProvisioningDetails +pagination_label: ProvisioningDetails +sidebar_label: ProvisioningDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningDetails', 'V2024ProvisioningDetails'] +slug: /tools/sdk/powershell/v2024/models/provisioning-details +tags: ['SDK', 'Software Development Kit', 'ProvisioningDetails', 'V2024ProvisioningDetails'] +--- + + +# ProvisioningDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OrderedSubPhaseReferences** | Pointer to **String** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain ""manualWorkItemDetails"" which indicate that there is further information in that object for this phase. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningDetails = Initialize-PSSailpoint.V2024ProvisioningDetails -OrderedSubPhaseReferences manualWorkItemDetails +``` + +- Convert the resource to JSON +```powershell +$ProvisioningDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningPolicy.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningPolicy.md new file mode 100644 index 000000000..3811cdf23 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningPolicy.md @@ -0,0 +1,41 @@ +--- +id: v2024-provisioning-policy +title: ProvisioningPolicy +pagination_label: ProvisioningPolicy +sidebar_label: ProvisioningPolicy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningPolicy', 'V2024ProvisioningPolicy'] +slug: /tools/sdk/powershell/v2024/models/provisioning-policy +tags: ['SDK', 'Software Development Kit', 'ProvisioningPolicy', 'V2024ProvisioningPolicy'] +--- + + +# ProvisioningPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | the provisioning policy name | [required] +**Description** | Pointer to **String** | the description of the provisioning policy | [optional] +**UsageType** | Pointer to [**UsageType**](usage-type) | | [optional] +**Fields** | Pointer to [**[]FieldDetailsDto**](field-details-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningPolicy = Initialize-PSSailpoint.V2024ProvisioningPolicy -Name example provisioning policy for inactive identities ` + -Description this provisioning policy creates access based on an identity going inactive ` + -UsageType null ` + -Fields null +``` + +- Convert the resource to JSON +```powershell +$ProvisioningPolicy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningPolicyDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningPolicyDto.md new file mode 100644 index 000000000..315f78c27 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningPolicyDto.md @@ -0,0 +1,41 @@ +--- +id: v2024-provisioning-policy-dto +title: ProvisioningPolicyDto +pagination_label: ProvisioningPolicyDto +sidebar_label: ProvisioningPolicyDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningPolicyDto', 'V2024ProvisioningPolicyDto'] +slug: /tools/sdk/powershell/v2024/models/provisioning-policy-dto +tags: ['SDK', 'Software Development Kit', 'ProvisioningPolicyDto', 'V2024ProvisioningPolicyDto'] +--- + + +# ProvisioningPolicyDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | the provisioning policy name | [required] +**Description** | Pointer to **String** | the description of the provisioning policy | [optional] +**UsageType** | Pointer to [**UsageType**](usage-type) | | [optional] +**Fields** | Pointer to [**[]FieldDetailsDto**](field-details-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningPolicyDto = Initialize-PSSailpoint.V2024ProvisioningPolicyDto -Name example provisioning policy for inactive identities ` + -Description this provisioning policy creates access based on an identity going inactive ` + -UsageType null ` + -Fields null +``` + +- Convert the resource to JSON +```powershell +$ProvisioningPolicyDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningState.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningState.md new file mode 100644 index 000000000..ff87dafe9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ProvisioningState.md @@ -0,0 +1,32 @@ +--- +id: v2024-provisioning-state +title: ProvisioningState +pagination_label: ProvisioningState +sidebar_label: ProvisioningState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningState', 'V2024ProvisioningState'] +slug: /tools/sdk/powershell/v2024/models/provisioning-state +tags: ['SDK', 'Software Development Kit', 'ProvisioningState', 'V2024ProvisioningState'] +--- + + +# ProvisioningState + +## Enum + + +* `PENDING` (value: `"PENDING"`) + +* `FINISHED` (value: `"FINISHED"`) + +* `UNVERIFIABLE` (value: `"UNVERIFIABLE"`) + +* `COMMITED` (value: `"COMMITED"`) + +* `FAILED` (value: `"FAILED"`) + +* `RETRY` (value: `"RETRY"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PublicIdentity.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PublicIdentity.md new file mode 100644 index 000000000..4b731ccfa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PublicIdentity.md @@ -0,0 +1,49 @@ +--- +id: v2024-public-identity +title: PublicIdentity +pagination_label: PublicIdentity +sidebar_label: PublicIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PublicIdentity', 'V2024PublicIdentity'] +slug: /tools/sdk/powershell/v2024/models/public-identity +tags: ['SDK', 'Software Development Kit', 'PublicIdentity', 'V2024PublicIdentity'] +--- + + +# PublicIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Identity id | [optional] +**Name** | Pointer to **String** | Human-readable display name of identity. | [optional] +**Alias** | Pointer to **String** | Alternate unique identifier for the identity. | [optional] +**Email** | Pointer to **String** | Email address of identity. | [optional] +**Status** | Pointer to **String** | The lifecycle status for the identity | [optional] +**IdentityState** | Pointer to **Enum** [ "ACTIVE", "INACTIVE_SHORT_TERM", "INACTIVE_LONG_TERM" ] | The current state of the identity, which determines how Identity Security Cloud interacts with the identity. An identity that is Active will be included identity picklists in Request Center, identity processing, and more. Identities that are Inactive will be excluded from these features. | [optional] +**Manager** | Pointer to [**IdentityReference**](identity-reference) | | [optional] +**Attributes** | Pointer to [**[]PublicIdentityAttributesInner**](public-identity-attributes-inner) | The public identity attributes of the identity | [optional] + +## Examples + +- Prepare the resource +```powershell +$PublicIdentity = Initialize-PSSailpoint.V2024PublicIdentity -Id 2c9180857182305e0171993735622948 ` + -Name Alison Ferguso ` + -Alias alison.ferguso ` + -Email alison.ferguso@acme-solar.com ` + -Status Active ` + -IdentityState ACTIVE ` + -Manager null ` + -Attributes null +``` + +- Convert the resource to JSON +```powershell +$PublicIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PublicIdentityAttributeConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PublicIdentityAttributeConfig.md new file mode 100644 index 000000000..804509a44 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PublicIdentityAttributeConfig.md @@ -0,0 +1,37 @@ +--- +id: v2024-public-identity-attribute-config +title: PublicIdentityAttributeConfig +pagination_label: PublicIdentityAttributeConfig +sidebar_label: PublicIdentityAttributeConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PublicIdentityAttributeConfig', 'V2024PublicIdentityAttributeConfig'] +slug: /tools/sdk/powershell/v2024/models/public-identity-attribute-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentityAttributeConfig', 'V2024PublicIdentityAttributeConfig'] +--- + + +# PublicIdentityAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **String** | The attribute key | [optional] +**Name** | Pointer to **String** | The attribute display name | [optional] + +## Examples + +- Prepare the resource +```powershell +$PublicIdentityAttributeConfig = Initialize-PSSailpoint.V2024PublicIdentityAttributeConfig -Key country ` + -Name Country +``` + +- Convert the resource to JSON +```powershell +$PublicIdentityAttributeConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PublicIdentityAttributesInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PublicIdentityAttributesInner.md new file mode 100644 index 000000000..969d34e6c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PublicIdentityAttributesInner.md @@ -0,0 +1,39 @@ +--- +id: v2024-public-identity-attributes-inner +title: PublicIdentityAttributesInner +pagination_label: PublicIdentityAttributesInner +sidebar_label: PublicIdentityAttributesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PublicIdentityAttributesInner', 'V2024PublicIdentityAttributesInner'] +slug: /tools/sdk/powershell/v2024/models/public-identity-attributes-inner +tags: ['SDK', 'Software Development Kit', 'PublicIdentityAttributesInner', 'V2024PublicIdentityAttributesInner'] +--- + + +# PublicIdentityAttributesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **String** | The attribute key | [optional] +**Name** | Pointer to **String** | Human-readable display name of the attribute | [optional] +**Value** | Pointer to **String** | The attribute value | [optional] + +## Examples + +- Prepare the resource +```powershell +$PublicIdentityAttributesInner = Initialize-PSSailpoint.V2024PublicIdentityAttributesInner -Key country ` + -Name Country ` + -Value US +``` + +- Convert the resource to JSON +```powershell +$PublicIdentityAttributesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PublicIdentityConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PublicIdentityConfig.md new file mode 100644 index 000000000..bcc7822a4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PublicIdentityConfig.md @@ -0,0 +1,39 @@ +--- +id: v2024-public-identity-config +title: PublicIdentityConfig +pagination_label: PublicIdentityConfig +sidebar_label: PublicIdentityConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PublicIdentityConfig', 'V2024PublicIdentityConfig'] +slug: /tools/sdk/powershell/v2024/models/public-identity-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentityConfig', 'V2024PublicIdentityConfig'] +--- + + +# PublicIdentityConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**[]PublicIdentityAttributeConfig**](public-identity-attribute-config) | Up to 5 identity attributes that will be available to everyone in the org for all users in the org. | [optional] +**Modified** | Pointer to **System.DateTime** | When this configuration was last modified. | [optional] +**ModifiedBy** | Pointer to [**IdentityReference**](identity-reference) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PublicIdentityConfig = Initialize-PSSailpoint.V2024PublicIdentityConfig -Attributes null ` + -Modified 2018-06-25T20:22:28.104Z ` + -ModifiedBy null +``` + +- Convert the resource to JSON +```powershell +$PublicIdentityConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PutClientLogConfigurationRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PutClientLogConfigurationRequest.md new file mode 100644 index 000000000..f6fd209c4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PutClientLogConfigurationRequest.md @@ -0,0 +1,43 @@ +--- +id: v2024-put-client-log-configuration-request +title: PutClientLogConfigurationRequest +pagination_label: PutClientLogConfigurationRequest +sidebar_label: PutClientLogConfigurationRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PutClientLogConfigurationRequest', 'V2024PutClientLogConfigurationRequest'] +slug: /tools/sdk/powershell/v2024/models/put-client-log-configuration-request +tags: ['SDK', 'Software Development Kit', 'PutClientLogConfigurationRequest', 'V2024PutClientLogConfigurationRequest'] +--- + + +# PutClientLogConfigurationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClientId** | Pointer to **String** | Log configuration's client ID | [optional] +**DurationMinutes** | Pointer to **Int32** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [optional] [default to 240] +**RootLevel** | [**StandardLevel**](standard-level) | | [required] +**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] +**Expiration** | Pointer to **System.DateTime** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [optional] + +## Examples + +- Prepare the resource +```powershell +$PutClientLogConfigurationRequest = Initialize-PSSailpoint.V2024PutClientLogConfigurationRequest -ClientId 3a38a51992e8445ab51a549c0a70ee66 ` + -DurationMinutes 120 ` + -RootLevel null ` + -LogLevels INFO ` + -Expiration 2024-11-06T01:31:08.013164Z +``` + +- Convert the resource to JSON +```powershell +$PutClientLogConfigurationRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PutConnectorCorrelationConfigRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PutConnectorCorrelationConfigRequest.md new file mode 100644 index 000000000..044153ad9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PutConnectorCorrelationConfigRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-put-connector-correlation-config-request +title: PutConnectorCorrelationConfigRequest +pagination_label: PutConnectorCorrelationConfigRequest +sidebar_label: PutConnectorCorrelationConfigRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PutConnectorCorrelationConfigRequest', 'V2024PutConnectorCorrelationConfigRequest'] +slug: /tools/sdk/powershell/v2024/models/put-connector-correlation-config-request +tags: ['SDK', 'Software Development Kit', 'PutConnectorCorrelationConfigRequest', 'V2024PutConnectorCorrelationConfigRequest'] +--- + + +# PutConnectorCorrelationConfigRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | **System.IO.FileInfo** | connector correlation config xml file | [required] + +## Examples + +- Prepare the resource +```powershell +$PutConnectorCorrelationConfigRequest = Initialize-PSSailpoint.V2024PutConnectorCorrelationConfigRequest -File null +``` + +- Convert the resource to JSON +```powershell +$PutConnectorCorrelationConfigRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PutConnectorSourceConfigRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PutConnectorSourceConfigRequest.md new file mode 100644 index 000000000..d78478bbd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PutConnectorSourceConfigRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-put-connector-source-config-request +title: PutConnectorSourceConfigRequest +pagination_label: PutConnectorSourceConfigRequest +sidebar_label: PutConnectorSourceConfigRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PutConnectorSourceConfigRequest', 'V2024PutConnectorSourceConfigRequest'] +slug: /tools/sdk/powershell/v2024/models/put-connector-source-config-request +tags: ['SDK', 'Software Development Kit', 'PutConnectorSourceConfigRequest', 'V2024PutConnectorSourceConfigRequest'] +--- + + +# PutConnectorSourceConfigRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | **System.IO.FileInfo** | connector source config xml file | [required] + +## Examples + +- Prepare the resource +```powershell +$PutConnectorSourceConfigRequest = Initialize-PSSailpoint.V2024PutConnectorSourceConfigRequest -File null +``` + +- Convert the resource to JSON +```powershell +$PutConnectorSourceConfigRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PutConnectorSourceTemplateRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PutConnectorSourceTemplateRequest.md new file mode 100644 index 000000000..933c04e3a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PutConnectorSourceTemplateRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-put-connector-source-template-request +title: PutConnectorSourceTemplateRequest +pagination_label: PutConnectorSourceTemplateRequest +sidebar_label: PutConnectorSourceTemplateRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PutConnectorSourceTemplateRequest', 'V2024PutConnectorSourceTemplateRequest'] +slug: /tools/sdk/powershell/v2024/models/put-connector-source-template-request +tags: ['SDK', 'Software Development Kit', 'PutConnectorSourceTemplateRequest', 'V2024PutConnectorSourceTemplateRequest'] +--- + + +# PutConnectorSourceTemplateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | **System.IO.FileInfo** | connector source template xml file | [required] + +## Examples + +- Prepare the resource +```powershell +$PutConnectorSourceTemplateRequest = Initialize-PSSailpoint.V2024PutConnectorSourceTemplateRequest -File null +``` + +- Convert the resource to JSON +```powershell +$PutConnectorSourceTemplateRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PutPasswordDictionaryRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PutPasswordDictionaryRequest.md new file mode 100644 index 000000000..422e4be3e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/PutPasswordDictionaryRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-put-password-dictionary-request +title: PutPasswordDictionaryRequest +pagination_label: PutPasswordDictionaryRequest +sidebar_label: PutPasswordDictionaryRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PutPasswordDictionaryRequest', 'V2024PutPasswordDictionaryRequest'] +slug: /tools/sdk/powershell/v2024/models/put-password-dictionary-request +tags: ['SDK', 'Software Development Kit', 'PutPasswordDictionaryRequest', 'V2024PutPasswordDictionaryRequest'] +--- + + +# PutPasswordDictionaryRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | Pointer to **System.IO.FileInfo** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PutPasswordDictionaryRequest = Initialize-PSSailpoint.V2024PutPasswordDictionaryRequest -File null +``` + +- Convert the resource to JSON +```powershell +$PutPasswordDictionaryRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Query.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Query.md new file mode 100644 index 000000000..ed5b40faa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Query.md @@ -0,0 +1,41 @@ +--- +id: v2024-query +title: Query +pagination_label: Query +sidebar_label: Query +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Query', 'V2024Query'] +slug: /tools/sdk/powershell/v2024/models/query +tags: ['SDK', 'Software Development Kit', 'Query', 'V2024Query'] +--- + + +# Query + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | Pointer to **String** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [optional] +**Fields** | Pointer to **String** | The fields the query will be applied to. Fields provide you with a simple way to add additional fields to search, without making the query too complicated. For example, you can use the fields to specify that you want your query of ""a*"" to be applied to ""name"", ""firstName"", and the ""source.name"". The response will include all results matching the ""a*"" query found in those three fields. A field's availability depends on the indices being searched. For example, if you are searching ""identities"", you can apply your search to the ""firstName"" field, but you couldn't use ""firstName"" with a search on ""access profiles"". Refer to the response schema for the respective lists of available fields. | [optional] +**TimeZone** | Pointer to **String** | The time zone to be applied to any range query related to dates. | [optional] +**InnerHit** | Pointer to [**InnerHit**](inner-hit) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Query = Initialize-PSSailpoint.V2024Query -Query name:a* ` + -Fields [firstName,lastName,email] ` + -TimeZone America/Chicago ` + -InnerHit null +``` + +- Convert the resource to JSON +```powershell +$Query | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/QueryResultFilter.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/QueryResultFilter.md new file mode 100644 index 000000000..c3f75e69a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/QueryResultFilter.md @@ -0,0 +1,37 @@ +--- +id: v2024-query-result-filter +title: QueryResultFilter +pagination_label: QueryResultFilter +sidebar_label: QueryResultFilter +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'QueryResultFilter', 'V2024QueryResultFilter'] +slug: /tools/sdk/powershell/v2024/models/query-result-filter +tags: ['SDK', 'Software Development Kit', 'QueryResultFilter', 'V2024QueryResultFilter'] +--- + + +# QueryResultFilter + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Includes** | Pointer to **[]String** | The list of field names to include in the result documents. | [optional] +**Excludes** | Pointer to **[]String** | The list of field names to exclude from the result documents. | [optional] + +## Examples + +- Prepare the resource +```powershell +$QueryResultFilter = Initialize-PSSailpoint.V2024QueryResultFilter -Includes [name, displayName] ` + -Excludes [stacktrace] +``` + +- Convert the resource to JSON +```powershell +$QueryResultFilter | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/QueryType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/QueryType.md new file mode 100644 index 000000000..2d99fd5ab --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/QueryType.md @@ -0,0 +1,28 @@ +--- +id: v2024-query-type +title: QueryType +pagination_label: QueryType +sidebar_label: QueryType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'QueryType', 'V2024QueryType'] +slug: /tools/sdk/powershell/v2024/models/query-type +tags: ['SDK', 'Software Development Kit', 'QueryType', 'V2024QueryType'] +--- + + +# QueryType + +## Enum + + +* `DSL` (value: `"DSL"`) + +* `SAILPOINT` (value: `"SAILPOINT"`) + +* `TEXT` (value: `"TEXT"`) + +* `TYPEAHEAD` (value: `"TYPEAHEAD"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/QueuedCheckConfigDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/QueuedCheckConfigDetails.md new file mode 100644 index 000000000..0aa7bd441 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/QueuedCheckConfigDetails.md @@ -0,0 +1,37 @@ +--- +id: v2024-queued-check-config-details +title: QueuedCheckConfigDetails +pagination_label: QueuedCheckConfigDetails +sidebar_label: QueuedCheckConfigDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'QueuedCheckConfigDetails', 'V2024QueuedCheckConfigDetails'] +slug: /tools/sdk/powershell/v2024/models/queued-check-config-details +tags: ['SDK', 'Software Development Kit', 'QueuedCheckConfigDetails', 'V2024QueuedCheckConfigDetails'] +--- + + +# QueuedCheckConfigDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ProvisioningStatusCheckIntervalMinutes** | **String** | Interval in minutes between status checks | [required] +**ProvisioningMaxStatusCheckDays** | **String** | Maximum number of days to check | [required] + +## Examples + +- Prepare the resource +```powershell +$QueuedCheckConfigDetails = Initialize-PSSailpoint.V2024QueuedCheckConfigDetails -ProvisioningStatusCheckIntervalMinutes 30 ` + -ProvisioningMaxStatusCheckDays 2 +``` + +- Convert the resource to JSON +```powershell +$QueuedCheckConfigDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RandomAlphaNumeric.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RandomAlphaNumeric.md new file mode 100644 index 000000000..509188f20 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RandomAlphaNumeric.md @@ -0,0 +1,39 @@ +--- +id: v2024-random-alpha-numeric +title: RandomAlphaNumeric +pagination_label: RandomAlphaNumeric +sidebar_label: RandomAlphaNumeric +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RandomAlphaNumeric', 'V2024RandomAlphaNumeric'] +slug: /tools/sdk/powershell/v2024/models/random-alpha-numeric +tags: ['SDK', 'Software Development Kit', 'RandomAlphaNumeric', 'V2024RandomAlphaNumeric'] +--- + + +# RandomAlphaNumeric + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Length** | Pointer to **String** | This is an integer value specifying the size/number of characters the random string must contain * This value must be a positive number and cannot be blank * If no length is provided, the transform will default to a value of `32` * Due to identity attribute data constraints, the maximum allowable value is `450` characters | [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] + +## Examples + +- Prepare the resource +```powershell +$RandomAlphaNumeric = Initialize-PSSailpoint.V2024RandomAlphaNumeric -Length 10 ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$RandomAlphaNumeric | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RandomNumeric.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RandomNumeric.md new file mode 100644 index 000000000..15d6acd6b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RandomNumeric.md @@ -0,0 +1,39 @@ +--- +id: v2024-random-numeric +title: RandomNumeric +pagination_label: RandomNumeric +sidebar_label: RandomNumeric +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RandomNumeric', 'V2024RandomNumeric'] +slug: /tools/sdk/powershell/v2024/models/random-numeric +tags: ['SDK', 'Software Development Kit', 'RandomNumeric', 'V2024RandomNumeric'] +--- + + +# RandomNumeric + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Length** | Pointer to **String** | This is an integer value specifying the size/number of characters the random string must contain * This value must be a positive number and cannot be blank * If no length is provided, the transform will default to a value of `32` * Due to identity attribute data constraints, the maximum allowable value is `450` characters | [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] + +## Examples + +- Prepare the resource +```powershell +$RandomNumeric = Initialize-PSSailpoint.V2024RandomNumeric -Length 10 ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$RandomNumeric | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Range.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Range.md new file mode 100644 index 000000000..c07691515 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Range.md @@ -0,0 +1,37 @@ +--- +id: v2024-range +title: Range +pagination_label: Range +sidebar_label: Range +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Range', 'V2024Range'] +slug: /tools/sdk/powershell/v2024/models/range +tags: ['SDK', 'Software Development Kit', 'Range', 'V2024Range'] +--- + + +# Range + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Lower** | Pointer to [**Bound**](bound) | | [optional] +**Upper** | Pointer to [**Bound**](bound) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Range = Initialize-PSSailpoint.V2024Range -Lower null ` + -Upper null +``` + +- Convert the resource to JSON +```powershell +$Range | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReassignReference.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReassignReference.md new file mode 100644 index 000000000..cefc3b3aa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReassignReference.md @@ -0,0 +1,37 @@ +--- +id: v2024-reassign-reference +title: ReassignReference +pagination_label: ReassignReference +sidebar_label: ReassignReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReassignReference', 'V2024ReassignReference'] +slug: /tools/sdk/powershell/v2024/models/reassign-reference +tags: ['SDK', 'Software Development Kit', 'ReassignReference', 'V2024ReassignReference'] +--- + + +# ReassignReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The ID of item or identity being reassigned. | [required] +**Type** | **Enum** [ "TARGET_SUMMARY", "ITEM", "IDENTITY_SUMMARY" ] | The type of item or identity being reassigned. | [required] + +## Examples + +- Prepare the resource +```powershell +$ReassignReference = Initialize-PSSailpoint.V2024ReassignReference -Id ef38f94347e94562b5bb8424a56397d8 ` + -Type ITEM +``` + +- Convert the resource to JSON +```powershell +$ReassignReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Reassignment.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Reassignment.md new file mode 100644 index 000000000..315fa4753 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Reassignment.md @@ -0,0 +1,37 @@ +--- +id: v2024-reassignment +title: Reassignment +pagination_label: Reassignment +sidebar_label: Reassignment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Reassignment', 'V2024Reassignment'] +slug: /tools/sdk/powershell/v2024/models/reassignment +tags: ['SDK', 'Software Development Kit', 'Reassignment', 'V2024Reassignment'] +--- + + +# Reassignment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarFrom** | Pointer to [**CertificationReference**](certification-reference) | | [optional] +**Comment** | Pointer to **String** | The comment entered when the Certification was reassigned | [optional] + +## Examples + +- Prepare the resource +```powershell +$Reassignment = Initialize-PSSailpoint.V2024Reassignment -VarFrom null ` + -Comment Reassigned for a reason +``` + +- Convert the resource to JSON +```powershell +$Reassignment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Reassignment1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Reassignment1.md new file mode 100644 index 000000000..387e05f7a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Reassignment1.md @@ -0,0 +1,37 @@ +--- +id: v2024-reassignment1 +title: Reassignment1 +pagination_label: Reassignment1 +sidebar_label: Reassignment1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Reassignment1', 'V2024Reassignment1'] +slug: /tools/sdk/powershell/v2024/models/reassignment1 +tags: ['SDK', 'Software Development Kit', 'Reassignment1', 'V2024Reassignment1'] +--- + + +# Reassignment1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarFrom** | Pointer to [**CertificationReference1**](certification-reference1) | | [optional] +**Comment** | Pointer to **String** | Comments from the previous reviewer. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Reassignment1 = Initialize-PSSailpoint.V2024Reassignment1 -VarFrom null ` + -Comment Please review +``` + +- Convert the resource to JSON +```powershell +$Reassignment1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReassignmentReference.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReassignmentReference.md new file mode 100644 index 000000000..cd7df877b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReassignmentReference.md @@ -0,0 +1,37 @@ +--- +id: v2024-reassignment-reference +title: ReassignmentReference +pagination_label: ReassignmentReference +sidebar_label: ReassignmentReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReassignmentReference', 'V2024ReassignmentReference'] +slug: /tools/sdk/powershell/v2024/models/reassignment-reference +tags: ['SDK', 'Software Development Kit', 'ReassignmentReference', 'V2024ReassignmentReference'] +--- + + +# ReassignmentReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The ID of item or identity being reassigned. | [required] +**Type** | **Enum** [ "TARGET_SUMMARY", "ITEM", "IDENTITY_SUMMARY" ] | The type of item or identity being reassigned. | [required] + +## Examples + +- Prepare the resource +```powershell +$ReassignmentReference = Initialize-PSSailpoint.V2024ReassignmentReference -Id ef38f94347e94562b5bb8424a56397d8 ` + -Type ITEM +``` + +- Convert the resource to JSON +```powershell +$ReassignmentReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReassignmentTrailDTO.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReassignmentTrailDTO.md new file mode 100644 index 000000000..6e320cc17 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReassignmentTrailDTO.md @@ -0,0 +1,39 @@ +--- +id: v2024-reassignment-trail-dto +title: ReassignmentTrailDTO +pagination_label: ReassignmentTrailDTO +sidebar_label: ReassignmentTrailDTO +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReassignmentTrailDTO', 'V2024ReassignmentTrailDTO'] +slug: /tools/sdk/powershell/v2024/models/reassignment-trail-dto +tags: ['SDK', 'Software Development Kit', 'ReassignmentTrailDTO', 'V2024ReassignmentTrailDTO'] +--- + + +# ReassignmentTrailDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PreviousOwner** | Pointer to **String** | The ID of previous owner identity. | [optional] +**NewOwner** | Pointer to **String** | The ID of new owner identity. | [optional] +**ReassignmentType** | Pointer to **String** | The type of reassignment. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReassignmentTrailDTO = Initialize-PSSailpoint.V2024ReassignmentTrailDTO -PreviousOwner ef38f94347e94562b5bb8424a56397d8 ` + -NewOwner ef38f94347e94562b5bb8424a56397a3 ` + -ReassignmentType AUTOMATIC_REASSIGNMENT +``` + +- Convert the resource to JSON +```powershell +$ReassignmentTrailDTO | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReassignmentType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReassignmentType.md new file mode 100644 index 000000000..55a7efbdd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReassignmentType.md @@ -0,0 +1,28 @@ +--- +id: v2024-reassignment-type +title: ReassignmentType +pagination_label: ReassignmentType +sidebar_label: ReassignmentType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReassignmentType', 'V2024ReassignmentType'] +slug: /tools/sdk/powershell/v2024/models/reassignment-type +tags: ['SDK', 'Software Development Kit', 'ReassignmentType', 'V2024ReassignmentType'] +--- + + +# ReassignmentType + +## Enum + + +* `MANUAL_REASSIGNMENT` (value: `"MANUAL_REASSIGNMENT"`) + +* `AUTOMATIC_REASSIGNMENT` (value: `"AUTOMATIC_REASSIGNMENT"`) + +* `AUTO_ESCALATION` (value: `"AUTO_ESCALATION"`) + +* `SELF_REVIEW_DELEGATION` (value: `"SELF_REVIEW_DELEGATION"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReassignmentTypeEnum.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReassignmentTypeEnum.md new file mode 100644 index 000000000..d72798250 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReassignmentTypeEnum.md @@ -0,0 +1,28 @@ +--- +id: v2024-reassignment-type-enum +title: ReassignmentTypeEnum +pagination_label: ReassignmentTypeEnum +sidebar_label: ReassignmentTypeEnum +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReassignmentTypeEnum', 'V2024ReassignmentTypeEnum'] +slug: /tools/sdk/powershell/v2024/models/reassignment-type-enum +tags: ['SDK', 'Software Development Kit', 'ReassignmentTypeEnum', 'V2024ReassignmentTypeEnum'] +--- + + +# ReassignmentTypeEnum + +## Enum + + +* `MANUAL_REASSIGNMENT` (value: `"MANUAL_REASSIGNMENT,"`) + +* `AUTOMATIC_REASSIGNMENT` (value: `"AUTOMATIC_REASSIGNMENT,"`) + +* `AUTO_ESCALATION` (value: `"AUTO_ESCALATION,"`) + +* `SELF_REVIEW_DELEGATION` (value: `"SELF_REVIEW_DELEGATION"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Recommendation.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Recommendation.md new file mode 100644 index 000000000..0e67fc203 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Recommendation.md @@ -0,0 +1,37 @@ +--- +id: v2024-recommendation +title: Recommendation +pagination_label: Recommendation +sidebar_label: Recommendation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Recommendation', 'V2024Recommendation'] +slug: /tools/sdk/powershell/v2024/models/recommendation +tags: ['SDK', 'Software Development Kit', 'Recommendation', 'V2024Recommendation'] +--- + + +# Recommendation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "HUMAN", "MACHINE" ] | Recommended type of account. | [required] +**Method** | **Enum** [ "DISCOVERY", "SOURCE", "CRITERIA" ] | Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. | [required] + +## Examples + +- Prepare the resource +```powershell +$Recommendation = Initialize-PSSailpoint.V2024Recommendation -Type MACHINE ` + -Method DISCOVERY +``` + +- Convert the resource to JSON +```powershell +$Recommendation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RecommendationConfigDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RecommendationConfigDto.md new file mode 100644 index 000000000..c3eba8b7a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RecommendationConfigDto.md @@ -0,0 +1,41 @@ +--- +id: v2024-recommendation-config-dto +title: RecommendationConfigDto +pagination_label: RecommendationConfigDto +sidebar_label: RecommendationConfigDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RecommendationConfigDto', 'V2024RecommendationConfigDto'] +slug: /tools/sdk/powershell/v2024/models/recommendation-config-dto +tags: ['SDK', 'Software Development Kit', 'RecommendationConfigDto', 'V2024RecommendationConfigDto'] +--- + + +# RecommendationConfigDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RecommenderFeatures** | Pointer to **[]String** | List of identity attributes to use for calculating certification recommendations | [optional] +**PeerGroupPercentageThreshold** | Pointer to **Double** | The percent value that the recommendation calculation must surpass to produce a YES recommendation | [optional] +**RunAutoSelectOnce** | Pointer to **Boolean** | If true, rulesRecommenderConfig will be refreshed with new programatically selected attribute and threshold values on the next pipeline run | [optional] [default to $false] +**OnlyTuneThreshold** | Pointer to **Boolean** | If true, rulesRecommenderConfig will be refreshed with new programatically selected threshold values on the next pipeline run | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$RecommendationConfigDto = Initialize-PSSailpoint.V2024RecommendationConfigDto -RecommenderFeatures [jobTitle, location, peer_group, department, active] ` + -PeerGroupPercentageThreshold 0.5 ` + -RunAutoSelectOnce false ` + -OnlyTuneThreshold false +``` + +- Convert the resource to JSON +```powershell +$RecommendationConfigDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RecommendationRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RecommendationRequest.md new file mode 100644 index 000000000..594ac1813 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RecommendationRequest.md @@ -0,0 +1,37 @@ +--- +id: v2024-recommendation-request +title: RecommendationRequest +pagination_label: RecommendationRequest +sidebar_label: RecommendationRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RecommendationRequest', 'V2024RecommendationRequest'] +slug: /tools/sdk/powershell/v2024/models/recommendation-request +tags: ['SDK', 'Software Development Kit', 'RecommendationRequest', 'V2024RecommendationRequest'] +--- + + +# RecommendationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **String** | The identity ID | [optional] +**Item** | Pointer to [**AccessItemRef**](access-item-ref) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RecommendationRequest = Initialize-PSSailpoint.V2024RecommendationRequest -IdentityId 2c938083633d259901633d25c68c00fa ` + -Item null +``` + +- Convert the resource to JSON +```powershell +$RecommendationRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RecommendationRequestDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RecommendationRequestDto.md new file mode 100644 index 000000000..c5a892f30 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RecommendationRequestDto.md @@ -0,0 +1,43 @@ +--- +id: v2024-recommendation-request-dto +title: RecommendationRequestDto +pagination_label: RecommendationRequestDto +sidebar_label: RecommendationRequestDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RecommendationRequestDto', 'V2024RecommendationRequestDto'] +slug: /tools/sdk/powershell/v2024/models/recommendation-request-dto +tags: ['SDK', 'Software Development Kit', 'RecommendationRequestDto', 'V2024RecommendationRequestDto'] +--- + + +# RecommendationRequestDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Requests** | Pointer to [**[]RecommendationRequest**](recommendation-request) | | [optional] +**ExcludeInterpretations** | Pointer to **Boolean** | Exclude interpretations in the response if ""true"". Return interpretations in the response if this attribute is not specified. | [optional] [default to $false] +**IncludeTranslationMessages** | Pointer to **Boolean** | When set to true, the calling system uses the translated messages for the specified language | [optional] [default to $false] +**IncludeDebugInformation** | Pointer to **Boolean** | Returns the recommender calculations if set to true | [optional] [default to $false] +**PrescribeMode** | Pointer to **Boolean** | When set to true, uses prescribedRulesRecommenderConfig to get identity attributes and peer group threshold instead of standard config. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$RecommendationRequestDto = Initialize-PSSailpoint.V2024RecommendationRequestDto -Requests null ` + -ExcludeInterpretations false ` + -IncludeTranslationMessages false ` + -IncludeDebugInformation true ` + -PrescribeMode false +``` + +- Convert the resource to JSON +```powershell +$RecommendationRequestDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RecommendationResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RecommendationResponse.md new file mode 100644 index 000000000..aab717aaa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RecommendationResponse.md @@ -0,0 +1,43 @@ +--- +id: v2024-recommendation-response +title: RecommendationResponse +pagination_label: RecommendationResponse +sidebar_label: RecommendationResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RecommendationResponse', 'V2024RecommendationResponse'] +slug: /tools/sdk/powershell/v2024/models/recommendation-response +tags: ['SDK', 'Software Development Kit', 'RecommendationResponse', 'V2024RecommendationResponse'] +--- + + +# RecommendationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Request** | Pointer to [**RecommendationRequest**](recommendation-request) | | [optional] +**Recommendation** | Pointer to **Enum** [ "true", "false", "MAYBE", "NOT_FOUND" ] | The recommendation - YES if the access is recommended, NO if not recommended, MAYBE if there is not enough information to make a recommendation, NOT_FOUND if the identity is not found in the system | [optional] +**Interpretations** | Pointer to **[]String** | The list of interpretations explaining the recommendation. The array is empty if includeInterpretations is false or not present in the request. e.g. - [ ""Not approved in the last 6 months."" ]. Interpretations will be translated using the client's locale as found in the Accept-Language header. If a translation for the client's locale cannot be found, the US English translation will be returned. | [optional] +**TranslationMessages** | Pointer to [**[]TranslationMessage**](translation-message) | The list of translation messages, if they have been requested. | [optional] +**RecommenderCalculations** | Pointer to [**RecommenderCalculations**](recommender-calculations) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RecommendationResponse = Initialize-PSSailpoint.V2024RecommendationResponse -Request null ` + -Recommendation true ` + -Interpretations [75% of identities with the same department have this access. This information had a high impact on the overall score., 67% of identities with the same peer group have this access. This information had a low impact on the overall score., 42% of identities with the same location have this access. This information had a low impact on the overall score.] ` + -TranslationMessages [{key=recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values=[75, department]}] ` + -RecommenderCalculations null +``` + +- Convert the resource to JSON +```powershell +$RecommendationResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RecommendationResponseDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RecommendationResponseDto.md new file mode 100644 index 000000000..a914a72ff --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RecommendationResponseDto.md @@ -0,0 +1,35 @@ +--- +id: v2024-recommendation-response-dto +title: RecommendationResponseDto +pagination_label: RecommendationResponseDto +sidebar_label: RecommendationResponseDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RecommendationResponseDto', 'V2024RecommendationResponseDto'] +slug: /tools/sdk/powershell/v2024/models/recommendation-response-dto +tags: ['SDK', 'Software Development Kit', 'RecommendationResponseDto', 'V2024RecommendationResponseDto'] +--- + + +# RecommendationResponseDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Response** | Pointer to [**[]RecommendationResponse**](recommendation-response) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RecommendationResponseDto = Initialize-PSSailpoint.V2024RecommendationResponseDto -Response null +``` + +- Convert the resource to JSON +```powershell +$RecommendationResponseDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RecommenderCalculations.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RecommenderCalculations.md new file mode 100644 index 000000000..734865f19 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RecommenderCalculations.md @@ -0,0 +1,49 @@ +--- +id: v2024-recommender-calculations +title: RecommenderCalculations +pagination_label: RecommenderCalculations +sidebar_label: RecommenderCalculations +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RecommenderCalculations', 'V2024RecommenderCalculations'] +slug: /tools/sdk/powershell/v2024/models/recommender-calculations +tags: ['SDK', 'Software Development Kit', 'RecommenderCalculations', 'V2024RecommenderCalculations'] +--- + + +# RecommenderCalculations + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **String** | The ID of the identity | [optional] +**EntitlementId** | Pointer to **String** | The entitlement ID | [optional] +**Recommendation** | Pointer to **String** | The actual recommendation | [optional] +**OverallWeightedScore** | Pointer to **Decimal** | The overall weighted score | [optional] +**FeatureWeightedScores** | Pointer to **map[string]Decimal** | The weighted score of each individual feature | [optional] +**Threshold** | Pointer to **Decimal** | The configured value against which the overallWeightedScore is compared | [optional] +**IdentityAttributes** | Pointer to [**map[string]RecommenderCalculationsIdentityAttributesValue**](recommender-calculations-identity-attributes-value) | The values for your configured features | [optional] +**FeatureValues** | Pointer to [**FeatureValueDto**](feature-value-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RecommenderCalculations = Initialize-PSSailpoint.V2024RecommenderCalculations -IdentityId 2c91808457d8f3ab0157e3e62cb4213c ` + -EntitlementId 2c91809050db617d0150e0bf3215385e ` + -Recommendation YES ` + -OverallWeightedScore null ` + -FeatureWeightedScores null ` + -Threshold null ` + -IdentityAttributes null ` + -FeatureValues null +``` + +- Convert the resource to JSON +```powershell +$RecommenderCalculations | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RecommenderCalculationsIdentityAttributesValue.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RecommenderCalculationsIdentityAttributesValue.md new file mode 100644 index 000000000..a2c58c79c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RecommenderCalculationsIdentityAttributesValue.md @@ -0,0 +1,35 @@ +--- +id: v2024-recommender-calculations-identity-attributes-value +title: RecommenderCalculationsIdentityAttributesValue +pagination_label: RecommenderCalculationsIdentityAttributesValue +sidebar_label: RecommenderCalculationsIdentityAttributesValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RecommenderCalculationsIdentityAttributesValue', 'V2024RecommenderCalculationsIdentityAttributesValue'] +slug: /tools/sdk/powershell/v2024/models/recommender-calculations-identity-attributes-value +tags: ['SDK', 'Software Development Kit', 'RecommenderCalculationsIdentityAttributesValue', 'V2024RecommenderCalculationsIdentityAttributesValue'] +--- + + +# RecommenderCalculationsIdentityAttributesValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RecommenderCalculationsIdentityAttributesValue = Initialize-PSSailpoint.V2024RecommenderCalculationsIdentityAttributesValue -Value null +``` + +- Convert the resource to JSON +```powershell +$RecommenderCalculationsIdentityAttributesValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Reference.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Reference.md new file mode 100644 index 000000000..a24605421 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Reference.md @@ -0,0 +1,39 @@ +--- +id: v2024-reference +title: Reference +pagination_label: Reference +sidebar_label: Reference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Reference', 'V2024Reference'] +slug: /tools/sdk/powershell/v2024/models/reference +tags: ['SDK', 'Software Development Kit', 'Reference', 'V2024Reference'] +--- + + +# Reference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | This ID specifies the name of the pre-existing transform which you want to use within your current transform | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$Reference = Initialize-PSSailpoint.V2024Reference -Id Existing Transform ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Reference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Reference1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Reference1.md new file mode 100644 index 000000000..81934dc91 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Reference1.md @@ -0,0 +1,37 @@ +--- +id: v2024-reference1 +title: Reference1 +pagination_label: Reference1 +sidebar_label: Reference1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Reference1', 'V2024Reference1'] +slug: /tools/sdk/powershell/v2024/models/reference1 +tags: ['SDK', 'Software Development Kit', 'Reference1', 'V2024Reference1'] +--- + + +# Reference1 + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$Reference1 = Initialize-PSSailpoint.V2024Reference1 -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe +``` + +- Convert the resource to JSON +```powershell +$Reference1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RemediationItemDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RemediationItemDetails.md new file mode 100644 index 000000000..7cee76bd4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RemediationItemDetails.md @@ -0,0 +1,51 @@ +--- +id: v2024-remediation-item-details +title: RemediationItemDetails +pagination_label: RemediationItemDetails +sidebar_label: RemediationItemDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RemediationItemDetails', 'V2024RemediationItemDetails'] +slug: /tools/sdk/powershell/v2024/models/remediation-item-details +tags: ['SDK', 'Software Development Kit', 'RemediationItemDetails', 'V2024RemediationItemDetails'] +--- + + +# RemediationItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of the certification | [optional] +**TargetId** | Pointer to **String** | The ID of the certification target | [optional] +**TargetName** | Pointer to **String** | The name of the certification target | [optional] +**TargetDisplayName** | Pointer to **String** | The display name of the certification target | [optional] +**ApplicationName** | Pointer to **String** | The name of the application/source | [optional] +**AttributeName** | Pointer to **String** | The name of the attribute being certified | [optional] +**AttributeOperation** | Pointer to **String** | The operation of the certification on the attribute | [optional] +**AttributeValue** | Pointer to **String** | The value of the attribute being certified | [optional] +**NativeIdentity** | Pointer to **String** | The native identity of the target | [optional] + +## Examples + +- Prepare the resource +```powershell +$RemediationItemDetails = Initialize-PSSailpoint.V2024RemediationItemDetails -Id 2c9180835d2e5168015d32f890ca1581 ` + -TargetId 2c9180835d2e5168015d32f890ca1581 ` + -TargetName john.smith ` + -TargetDisplayName emailAddress ` + -ApplicationName Active Directory ` + -AttributeName phoneNumber ` + -AttributeOperation update ` + -AttributeValue 512-555-1212 ` + -NativeIdentity jason.smith2 +``` + +- Convert the resource to JSON +```powershell +$RemediationItemDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RemediationItems.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RemediationItems.md new file mode 100644 index 000000000..3be6a3234 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RemediationItems.md @@ -0,0 +1,51 @@ +--- +id: v2024-remediation-items +title: RemediationItems +pagination_label: RemediationItems +sidebar_label: RemediationItems +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RemediationItems', 'V2024RemediationItems'] +slug: /tools/sdk/powershell/v2024/models/remediation-items +tags: ['SDK', 'Software Development Kit', 'RemediationItems', 'V2024RemediationItems'] +--- + + +# RemediationItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of the certification | [optional] +**TargetId** | Pointer to **String** | The ID of the certification target | [optional] +**TargetName** | Pointer to **String** | The name of the certification target | [optional] +**TargetDisplayName** | Pointer to **String** | The display name of the certification target | [optional] +**ApplicationName** | Pointer to **String** | The name of the application/source | [optional] +**AttributeName** | Pointer to **String** | The name of the attribute being certified | [optional] +**AttributeOperation** | Pointer to **String** | The operation of the certification on the attribute | [optional] +**AttributeValue** | Pointer to **String** | The value of the attribute being certified | [optional] +**NativeIdentity** | Pointer to **String** | The native identity of the target | [optional] + +## Examples + +- Prepare the resource +```powershell +$RemediationItems = Initialize-PSSailpoint.V2024RemediationItems -Id 2c9180835d2e5168015d32f890ca1581 ` + -TargetId 2c9180835d2e5168015d32f890ca1581 ` + -TargetName john.smith ` + -TargetDisplayName emailAddress ` + -ApplicationName Active Directory ` + -AttributeName phoneNumber ` + -AttributeOperation update ` + -AttributeValue 512-555-1212 ` + -NativeIdentity jason.smith2 +``` + +- Convert the resource to JSON +```powershell +$RemediationItems | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Replace.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Replace.md new file mode 100644 index 000000000..cb562d44a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Replace.md @@ -0,0 +1,41 @@ +--- +id: v2024-replace +title: Replace +pagination_label: Replace +sidebar_label: Replace +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Replace', 'V2024Replace'] +slug: /tools/sdk/powershell/v2024/models/replace +tags: ['SDK', 'Software Development Kit', 'Replace', 'V2024Replace'] +--- + + +# Replace + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Regex** | **String** | This can be a string or a regex pattern in which you want to replace. | [required] +**Replacement** | **String** | This is the replacement string that should be substituded wherever the string or pattern is found. | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$Replace = Initialize-PSSailpoint.V2024Replace -Regex [^a-zA-Z] ` + -Replacement ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Replace | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReplaceAll.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReplaceAll.md new file mode 100644 index 000000000..5f0122772 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReplaceAll.md @@ -0,0 +1,39 @@ +--- +id: v2024-replace-all +title: ReplaceAll +pagination_label: ReplaceAll +sidebar_label: ReplaceAll +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReplaceAll', 'V2024ReplaceAll'] +slug: /tools/sdk/powershell/v2024/models/replace-all +tags: ['SDK', 'Software Development Kit', 'ReplaceAll', 'V2024ReplaceAll'] +--- + + +# ReplaceAll + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Table** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value. | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$ReplaceAll = Initialize-PSSailpoint.V2024ReplaceAll -Table {-= , "=', ñ=n} ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$ReplaceAll | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReportConfigDTO.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReportConfigDTO.md new file mode 100644 index 000000000..40df6ee28 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReportConfigDTO.md @@ -0,0 +1,41 @@ +--- +id: v2024-report-config-dto +title: ReportConfigDTO +pagination_label: ReportConfigDTO +sidebar_label: ReportConfigDTO +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReportConfigDTO', 'V2024ReportConfigDTO'] +slug: /tools/sdk/powershell/v2024/models/report-config-dto +tags: ['SDK', 'Software Development Kit', 'ReportConfigDTO', 'V2024ReportConfigDTO'] +--- + + +# ReportConfigDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ColumnName** | Pointer to **String** | Name of column in report | [optional] +**Required** | Pointer to **Boolean** | If true, column is required in all reports, and this entry is immutable. A 400 error will result from any attempt to modify the column's definition. | [optional] [default to $false] +**Included** | Pointer to **Boolean** | If true, column is included in the report. A 400 error will be thrown if an attempt is made to set included=false if required==true. | [optional] [default to $false] +**Order** | Pointer to **Int32** | Relative sort order for the column. Columns will be displayed left-to-right in nondecreasing order. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReportConfigDTO = Initialize-PSSailpoint.V2024ReportConfigDTO -ColumnName SOD Business Name ` + -Required true ` + -Included false ` + -Order 2 +``` + +- Convert the resource to JSON +```powershell +$ReportConfigDTO | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReportDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReportDetails.md new file mode 100644 index 000000000..3a79aadec --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReportDetails.md @@ -0,0 +1,37 @@ +--- +id: v2024-report-details +title: ReportDetails +pagination_label: ReportDetails +sidebar_label: ReportDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReportDetails', 'V2024ReportDetails'] +slug: /tools/sdk/powershell/v2024/models/report-details +tags: ['SDK', 'Software Development Kit', 'ReportDetails', 'V2024ReportDetails'] +--- + + +# ReportDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReportType** | Pointer to **Enum** [ "ACCOUNTS", "IDENTITIES_DETAILS", "IDENTITIES", "IDENTITY_PROFILE_IDENTITY_ERROR", "ORPHAN_IDENTITIES", "SEARCH_EXPORT", "UNCORRELATED_ACCOUNTS" ] | Use this property to define what report should be processed in the RDE service. | [optional] +**Arguments** | Pointer to [**ReportDetailsArguments**](report-details-arguments) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReportDetails = Initialize-PSSailpoint.V2024ReportDetails -ReportType ACCOUNTS ` + -Arguments null +``` + +- Convert the resource to JSON +```powershell +$ReportDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReportDetailsArguments.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReportDetailsArguments.md new file mode 100644 index 000000000..521cb81aa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReportDetailsArguments.md @@ -0,0 +1,51 @@ +--- +id: v2024-report-details-arguments +title: ReportDetailsArguments +pagination_label: ReportDetailsArguments +sidebar_label: ReportDetailsArguments +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReportDetailsArguments', 'V2024ReportDetailsArguments'] +slug: /tools/sdk/powershell/v2024/models/report-details-arguments +tags: ['SDK', 'Software Development Kit', 'ReportDetailsArguments', 'V2024ReportDetailsArguments'] +--- + + +# ReportDetailsArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Application** | **String** | Source ID. | [required] +**SourceName** | **String** | Source name. | [required] +**CorrelatedOnly** | **Boolean** | Flag to specify if only correlated identities are included in report. | [required][default to $false] +**AuthoritativeSource** | **String** | Source ID. | [required] +**SelectedFormats** | Pointer to **[]String** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] +**Indices** | Pointer to [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**Query** | **String** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [required] +**Columns** | Pointer to **String** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional] +**Sort** | Pointer to **[]String** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReportDetailsArguments = Initialize-PSSailpoint.V2024ReportDetailsArguments -Application 2c9180897eSourceIde781782f705b9 ` + -SourceName Active Directory ` + -CorrelatedOnly true ` + -AuthoritativeSource 1234sourceId5678902 ` + -SelectedFormats [CSV] ` + -Indices [entitlements] ` + -Query name:a* ` + -Columns displayName,firstName,lastName,email,created,attributes.cloudLifecycleState ` + -Sort [displayName, +id] +``` + +- Convert the resource to JSON +```powershell +$ReportDetailsArguments | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReportResultReference.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReportResultReference.md new file mode 100644 index 000000000..927b8613d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReportResultReference.md @@ -0,0 +1,41 @@ +--- +id: v2024-report-result-reference +title: ReportResultReference +pagination_label: ReportResultReference +sidebar_label: ReportResultReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReportResultReference', 'V2024ReportResultReference'] +slug: /tools/sdk/powershell/v2024/models/report-result-reference +tags: ['SDK', 'Software Development Kit', 'ReportResultReference', 'V2024ReportResultReference'] +--- + + +# ReportResultReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "REPORT_RESULT" ] | SOD policy violation report result DTO type. | [optional] +**Id** | Pointer to **String** | SOD policy violation report result ID. | [optional] +**Name** | Pointer to **String** | Human-readable name of the SOD policy violation report result. | [optional] +**Status** | Pointer to **Enum** [ "SUCCESS", "WARNING", "ERROR", "TERMINATED", "TEMP_ERROR", "PENDING" ] | Status of a SOD policy violation report. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReportResultReference = Initialize-PSSailpoint.V2024ReportResultReference -Type REPORT_RESULT ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name SOD Policy 1 Violation ` + -Status PENDING +``` + +- Convert the resource to JSON +```powershell +$ReportResultReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReportResults.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReportResults.md new file mode 100644 index 000000000..1b949db85 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReportResults.md @@ -0,0 +1,49 @@ +--- +id: v2024-report-results +title: ReportResults +pagination_label: ReportResults +sidebar_label: ReportResults +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReportResults', 'V2024ReportResults'] +slug: /tools/sdk/powershell/v2024/models/report-results +tags: ['SDK', 'Software Development Kit', 'ReportResults', 'V2024ReportResults'] +--- + + +# ReportResults + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReportType** | Pointer to **Enum** [ "ACCOUNTS", "IDENTITIES_DETAILS", "IDENTITIES", "IDENTITY_PROFILE_IDENTITY_ERROR", "ORPHAN_IDENTITIES", "SEARCH_EXPORT", "UNCORRELATED_ACCOUNTS" ] | Use this property to define what report should be processed in the RDE service. | [optional] +**TaskDefName** | Pointer to **String** | Name of the task definition which is started to process requesting report. Usually the same as report name | [optional] +**Id** | Pointer to **String** | Unique task definition identifier. | [optional] +**Created** | Pointer to **System.DateTime** | Report processing start date | [optional] +**Status** | Pointer to **Enum** [ "SUCCESS", "FAILURE", "WARNING", "TERMINATED" ] | Report current state or result status. | [optional] +**Duration** | Pointer to **Int64** | Report processing time in ms. | [optional] +**Rows** | Pointer to **Int64** | Report size in rows. | [optional] +**AvailableFormats** | Pointer to **[]String** | Output report file formats. This are formats for calling get endpoint as a query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReportResults = Initialize-PSSailpoint.V2024ReportResults -ReportType IDENTITIES_DETAILS ` + -TaskDefName Identities Details Report ` + -Id a248c16fe22222b2bd49615481311111 ` + -Created null ` + -Status SUCCESS ` + -Duration 342 ` + -Rows 37 ` + -AvailableFormats [CSV] +``` + +- Convert the resource to JSON +```powershell +$ReportResults | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReportType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReportType.md new file mode 100644 index 000000000..75f03784f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReportType.md @@ -0,0 +1,28 @@ +--- +id: v2024-report-type +title: ReportType +pagination_label: ReportType +sidebar_label: ReportType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReportType', 'V2024ReportType'] +slug: /tools/sdk/powershell/v2024/models/report-type +tags: ['SDK', 'Software Development Kit', 'ReportType', 'V2024ReportType'] +--- + + +# ReportType + +## Enum + + +* `CAMPAIGN_COMPOSITION_REPORT` (value: `"CAMPAIGN_COMPOSITION_REPORT"`) + +* `CAMPAIGN_REMEDIATION_STATUS_REPORT` (value: `"CAMPAIGN_REMEDIATION_STATUS_REPORT"`) + +* `CAMPAIGN_STATUS_REPORT` (value: `"CAMPAIGN_STATUS_REPORT"`) + +* `CERTIFICATION_SIGNOFF_REPORT` (value: `"CERTIFICATION_SIGNOFF_REPORT"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestOnBehalfOfConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestOnBehalfOfConfig.md new file mode 100644 index 000000000..8aa87b2ae --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestOnBehalfOfConfig.md @@ -0,0 +1,37 @@ +--- +id: v2024-request-on-behalf-of-config +title: RequestOnBehalfOfConfig +pagination_label: RequestOnBehalfOfConfig +sidebar_label: RequestOnBehalfOfConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestOnBehalfOfConfig', 'V2024RequestOnBehalfOfConfig'] +slug: /tools/sdk/powershell/v2024/models/request-on-behalf-of-config +tags: ['SDK', 'Software Development Kit', 'RequestOnBehalfOfConfig', 'V2024RequestOnBehalfOfConfig'] +--- + + +# RequestOnBehalfOfConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AllowRequestOnBehalfOfAnyoneByAnyone** | Pointer to **Boolean** | If this is true, anyone can request access for anyone. | [optional] [default to $false] +**AllowRequestOnBehalfOfEmployeeByManager** | Pointer to **Boolean** | If this is true, a manager can request access for his or her direct reports. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$RequestOnBehalfOfConfig = Initialize-PSSailpoint.V2024RequestOnBehalfOfConfig -AllowRequestOnBehalfOfAnyoneByAnyone true ` + -AllowRequestOnBehalfOfEmployeeByManager true +``` + +- Convert the resource to JSON +```powershell +$RequestOnBehalfOfConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Requestability.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Requestability.md new file mode 100644 index 000000000..78d5042d7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Requestability.md @@ -0,0 +1,39 @@ +--- +id: v2024-requestability +title: Requestability +pagination_label: Requestability +sidebar_label: Requestability +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Requestability', 'V2024Requestability'] +slug: /tools/sdk/powershell/v2024/models/requestability +tags: ['SDK', 'Software Development Kit', 'Requestability', 'V2024Requestability'] +--- + + +# Requestability + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommentsRequired** | Pointer to **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] +**DenialCommentsRequired** | Pointer to **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] +**ApprovalSchemes** | Pointer to [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] + +## Examples + +- Prepare the resource +```powershell +$Requestability = Initialize-PSSailpoint.V2024Requestability -CommentsRequired true ` + -DenialCommentsRequired true ` + -ApprovalSchemes null +``` + +- Convert the resource to JSON +```powershell +$Requestability | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestabilityForRole.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestabilityForRole.md new file mode 100644 index 000000000..45ef3436b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestabilityForRole.md @@ -0,0 +1,39 @@ +--- +id: v2024-requestability-for-role +title: RequestabilityForRole +pagination_label: RequestabilityForRole +sidebar_label: RequestabilityForRole +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestabilityForRole', 'V2024RequestabilityForRole'] +slug: /tools/sdk/powershell/v2024/models/requestability-for-role +tags: ['SDK', 'Software Development Kit', 'RequestabilityForRole', 'V2024RequestabilityForRole'] +--- + + +# RequestabilityForRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommentsRequired** | Pointer to **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] +**DenialCommentsRequired** | Pointer to **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] +**ApprovalSchemes** | Pointer to [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestabilityForRole = Initialize-PSSailpoint.V2024RequestabilityForRole -CommentsRequired true ` + -DenialCommentsRequired true ` + -ApprovalSchemes null +``` + +- Convert the resource to JSON +```powershell +$RequestabilityForRole | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestableObject.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestableObject.md new file mode 100644 index 000000000..43e846fc6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestableObject.md @@ -0,0 +1,53 @@ +--- +id: v2024-requestable-object +title: RequestableObject +pagination_label: RequestableObject +sidebar_label: RequestableObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestableObject', 'V2024RequestableObject'] +slug: /tools/sdk/powershell/v2024/models/requestable-object +tags: ['SDK', 'Software Development Kit', 'RequestableObject', 'V2024RequestableObject'] +--- + + +# RequestableObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the requestable object itself | [optional] +**Name** | Pointer to **String** | Human-readable display name of the requestable object | [optional] +**Created** | Pointer to **System.DateTime** | The time when the requestable object was created | [optional] +**Modified** | Pointer to **System.DateTime** | The time when the requestable object was last modified | [optional] +**Description** | Pointer to **String** | Description of the requestable object. | [optional] +**Type** | Pointer to [**RequestableObjectType**](requestable-object-type) | | [optional] +**RequestStatus** | Pointer to [**RequestableObjectRequestStatus**](requestable-object-request-status) | | [optional] +**IdentityRequestId** | Pointer to **String** | If *requestStatus* is *PENDING*, indicates the id of the associated account activity. | [optional] +**OwnerRef** | Pointer to [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**RequestCommentsRequired** | Pointer to **Boolean** | Whether the requester must provide comments when requesting the object. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestableObject = Initialize-PSSailpoint.V2024RequestableObject -Id 2c9180835d2e5168015d32f890ca1581 ` + -Name Applied Research Access ` + -Created 2017-07-11T18:45:37.098Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Description Access to research information, lab results, and schematics. ` + -Type null ` + -RequestStatus null ` + -IdentityRequestId null ` + -OwnerRef null ` + -RequestCommentsRequired false +``` + +- Convert the resource to JSON +```powershell +$RequestableObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestableObjectReference.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestableObjectReference.md new file mode 100644 index 000000000..ece1a8db6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestableObjectReference.md @@ -0,0 +1,41 @@ +--- +id: v2024-requestable-object-reference +title: RequestableObjectReference +pagination_label: RequestableObjectReference +sidebar_label: RequestableObjectReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestableObjectReference', 'V2024RequestableObjectReference'] +slug: /tools/sdk/powershell/v2024/models/requestable-object-reference +tags: ['SDK', 'Software Development Kit', 'RequestableObjectReference', 'V2024RequestableObjectReference'] +--- + + +# RequestableObjectReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the object. | [optional] +**Name** | Pointer to **String** | Name of the object. | [optional] +**Description** | Pointer to **String** | Description of the object. | [optional] +**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | Type of the object. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestableObjectReference = Initialize-PSSailpoint.V2024RequestableObjectReference -Id 2c9180835d2e5168015d32f890ca1581 ` + -Name Applied Research Access ` + -Description Access to research information, lab results, and schematics ` + -Type ROLE +``` + +- Convert the resource to JSON +```powershell +$RequestableObjectReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestableObjectRequestStatus.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestableObjectRequestStatus.md new file mode 100644 index 000000000..2f65cd2e9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestableObjectRequestStatus.md @@ -0,0 +1,26 @@ +--- +id: v2024-requestable-object-request-status +title: RequestableObjectRequestStatus +pagination_label: RequestableObjectRequestStatus +sidebar_label: RequestableObjectRequestStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestableObjectRequestStatus', 'V2024RequestableObjectRequestStatus'] +slug: /tools/sdk/powershell/v2024/models/requestable-object-request-status +tags: ['SDK', 'Software Development Kit', 'RequestableObjectRequestStatus', 'V2024RequestableObjectRequestStatus'] +--- + + +# RequestableObjectRequestStatus + +## Enum + + +* `AVAILABLE` (value: `"AVAILABLE"`) + +* `PENDING` (value: `"PENDING"`) + +* `ASSIGNED` (value: `"ASSIGNED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestableObjectType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestableObjectType.md new file mode 100644 index 000000000..43dbf3209 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestableObjectType.md @@ -0,0 +1,26 @@ +--- +id: v2024-requestable-object-type +title: RequestableObjectType +pagination_label: RequestableObjectType +sidebar_label: RequestableObjectType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestableObjectType', 'V2024RequestableObjectType'] +slug: /tools/sdk/powershell/v2024/models/requestable-object-type +tags: ['SDK', 'Software Development Kit', 'RequestableObjectType', 'V2024RequestableObjectType'] +--- + + +# RequestableObjectType + +## Enum + + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ROLE` (value: `"ROLE"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemDetails.md new file mode 100644 index 000000000..aa8ecb00c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemDetails.md @@ -0,0 +1,37 @@ +--- +id: v2024-requested-item-details +title: RequestedItemDetails +pagination_label: RequestedItemDetails +sidebar_label: RequestedItemDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemDetails', 'V2024RequestedItemDetails'] +slug: /tools/sdk/powershell/v2024/models/requested-item-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemDetails', 'V2024RequestedItemDetails'] +--- + + +# RequestedItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "ENTITLEMENT", "ROLE" ] | The type of access item requested. | [optional] +**Id** | Pointer to **String** | The id of the access item requested. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemDetails = Initialize-PSSailpoint.V2024RequestedItemDetails -Type ENTITLEMENT ` + -Id 779c6fd7171540bba1184e5946112c28 +``` + +- Convert the resource to JSON +```powershell +$RequestedItemDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemStatus.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemStatus.md new file mode 100644 index 000000000..f3ae7690c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemStatus.md @@ -0,0 +1,81 @@ +--- +id: v2024-requested-item-status +title: RequestedItemStatus +pagination_label: RequestedItemStatus +sidebar_label: RequestedItemStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatus', 'V2024RequestedItemStatus'] +slug: /tools/sdk/powershell/v2024/models/requested-item-status +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatus', 'V2024RequestedItemStatus'] +--- + + +# RequestedItemStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Human-readable display name of the item being requested. | [optional] +**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | Type of requested object. | [optional] +**CancelledRequestDetails** | Pointer to [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional] +**ErrorMessages** | Pointer to [**[]ErrorMessageDto[]**](error-message-dto) | List of list of localized error messages, if any, encountered during the approval/provisioning process. | [optional] +**State** | Pointer to [**RequestedItemStatusRequestState**](requested-item-status-request-state) | | [optional] +**ApprovalDetails** | Pointer to [**[]ApprovalStatusDto**](approval-status-dto) | Approval details for each item. | [optional] +**ApprovalIds** | Pointer to **[]String** | List of approval IDs associated with the request. | [optional] +**ManualWorkItemDetails** | Pointer to [**[]ManualWorkItemDetails**](manual-work-item-details) | Manual work items created for provisioning the item. | [optional] +**AccountActivityItemId** | Pointer to **String** | Id of associated account activity item. | [optional] +**RequestType** | Pointer to [**AccessRequestType**](access-request-type) | | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] +**Requester** | Pointer to [**AccessItemRequester**](access-item-requester) | | [optional] +**RequestedFor** | Pointer to [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] +**RequesterComment** | Pointer to [**RequestedItemStatusRequesterComment**](requested-item-status-requester-comment) | | [optional] +**SodViolationContext** | Pointer to [**RequestedItemStatusSodViolationContext**](requested-item-status-sod-violation-context) | | [optional] +**ProvisioningDetails** | Pointer to [**RequestedItemStatusProvisioningDetails**](requested-item-status-provisioning-details) | | [optional] +**PreApprovalTriggerDetails** | Pointer to [**RequestedItemStatusPreApprovalTriggerDetails**](requested-item-status-pre-approval-trigger-details) | | [optional] +**AccessRequestPhases** | Pointer to [**[]AccessRequestPhases**](access-request-phases) | A list of Phases that the Access Request has gone through in order, to help determine the status of the request. | [optional] +**Description** | Pointer to **String** | Description associated to the requested object. | [optional] +**RemoveDate** | Pointer to **System.DateTime** | When the role access is scheduled for removal. | [optional] +**Cancelable** | Pointer to **Boolean** | True if the request can be canceled. | [optional] [default to $false] +**AccessRequestId** | Pointer to **String** | This is the account activity id. | [optional] +**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemStatus = Initialize-PSSailpoint.V2024RequestedItemStatus -Name AccessProfile1 ` + -Type ACCESS_PROFILE ` + -CancelledRequestDetails null ` + -ErrorMessages null ` + -State null ` + -ApprovalDetails null ` + -ApprovalIds [85f0cf482dd44327b593624c07906c21, fa57e1bfa36f41ee85e33ee59fcbeac5] ` + -ManualWorkItemDetails null ` + -AccountActivityItemId 2c9180926cbfbddd016cbfc7c3b10010 ` + -RequestType null ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z ` + -Requester null ` + -RequestedFor null ` + -RequesterComment null ` + -SodViolationContext null ` + -ProvisioningDetails null ` + -PreApprovalTriggerDetails null ` + -AccessRequestPhases null ` + -Description This is the Engineering role that engineers are granted. ` + -RemoveDate 2019-10-23T00:00Z ` + -Cancelable true ` + -AccessRequestId 2b838de9-db9b-abcf-e646-d4f274ad4238 ` + -ClientMetadata {key1=value1, key2=value2} +``` + +- Convert the resource to JSON +```powershell +$RequestedItemStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemStatusCancelledRequestDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemStatusCancelledRequestDetails.md new file mode 100644 index 000000000..33786f5e3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemStatusCancelledRequestDetails.md @@ -0,0 +1,39 @@ +--- +id: v2024-requested-item-status-cancelled-request-details +title: RequestedItemStatusCancelledRequestDetails +pagination_label: RequestedItemStatusCancelledRequestDetails +sidebar_label: RequestedItemStatusCancelledRequestDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusCancelledRequestDetails', 'V2024RequestedItemStatusCancelledRequestDetails'] +slug: /tools/sdk/powershell/v2024/models/requested-item-status-cancelled-request-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusCancelledRequestDetails', 'V2024RequestedItemStatusCancelledRequestDetails'] +--- + + +# RequestedItemStatusCancelledRequestDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment made by the owner when cancelling the associated request. | [optional] +**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**Modified** | Pointer to **System.DateTime** | Date comment was added by the owner when cancelling the associated request. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemStatusCancelledRequestDetails = Initialize-PSSailpoint.V2024RequestedItemStatusCancelledRequestDetails -Comment This request must be cancelled. ` + -Owner null ` + -Modified 2019-12-20T09:17:12.192Z +``` + +- Convert the resource to JSON +```powershell +$RequestedItemStatusCancelledRequestDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemStatusPreApprovalTriggerDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemStatusPreApprovalTriggerDetails.md new file mode 100644 index 000000000..4df78b73a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemStatusPreApprovalTriggerDetails.md @@ -0,0 +1,39 @@ +--- +id: v2024-requested-item-status-pre-approval-trigger-details +title: RequestedItemStatusPreApprovalTriggerDetails +pagination_label: RequestedItemStatusPreApprovalTriggerDetails +sidebar_label: RequestedItemStatusPreApprovalTriggerDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusPreApprovalTriggerDetails', 'V2024RequestedItemStatusPreApprovalTriggerDetails'] +slug: /tools/sdk/powershell/v2024/models/requested-item-status-pre-approval-trigger-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusPreApprovalTriggerDetails', 'V2024RequestedItemStatusPreApprovalTriggerDetails'] +--- + + +# RequestedItemStatusPreApprovalTriggerDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment left for the pre-approval decision | [optional] +**Reviewer** | Pointer to **String** | The reviewer of the pre-approval decision | [optional] +**Decision** | Pointer to **Enum** [ "APPROVED", "REJECTED" ] | The decision of the pre-approval trigger | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemStatusPreApprovalTriggerDetails = Initialize-PSSailpoint.V2024RequestedItemStatusPreApprovalTriggerDetails -Comment Access is Approved ` + -Reviewer John Doe ` + -Decision APPROVED +``` + +- Convert the resource to JSON +```powershell +$RequestedItemStatusPreApprovalTriggerDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemStatusProvisioningDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemStatusProvisioningDetails.md new file mode 100644 index 000000000..1dd7403de --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemStatusProvisioningDetails.md @@ -0,0 +1,35 @@ +--- +id: v2024-requested-item-status-provisioning-details +title: RequestedItemStatusProvisioningDetails +pagination_label: RequestedItemStatusProvisioningDetails +sidebar_label: RequestedItemStatusProvisioningDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusProvisioningDetails', 'V2024RequestedItemStatusProvisioningDetails'] +slug: /tools/sdk/powershell/v2024/models/requested-item-status-provisioning-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusProvisioningDetails', 'V2024RequestedItemStatusProvisioningDetails'] +--- + + +# RequestedItemStatusProvisioningDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OrderedSubPhaseReferences** | Pointer to **String** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain ""manualWorkItemDetails"" which indicate that there is further information in that object for this phase. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemStatusProvisioningDetails = Initialize-PSSailpoint.V2024RequestedItemStatusProvisioningDetails -OrderedSubPhaseReferences manualWorkItemDetails +``` + +- Convert the resource to JSON +```powershell +$RequestedItemStatusProvisioningDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemStatusRequestState.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemStatusRequestState.md new file mode 100644 index 000000000..f22dc96bf --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemStatusRequestState.md @@ -0,0 +1,38 @@ +--- +id: v2024-requested-item-status-request-state +title: RequestedItemStatusRequestState +pagination_label: RequestedItemStatusRequestState +sidebar_label: RequestedItemStatusRequestState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusRequestState', 'V2024RequestedItemStatusRequestState'] +slug: /tools/sdk/powershell/v2024/models/requested-item-status-request-state +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequestState', 'V2024RequestedItemStatusRequestState'] +--- + + +# RequestedItemStatusRequestState + +## Enum + + +* `EXECUTING` (value: `"EXECUTING"`) + +* `REQUEST_COMPLETED` (value: `"REQUEST_COMPLETED"`) + +* `CANCELLED` (value: `"CANCELLED"`) + +* `TERMINATED` (value: `"TERMINATED"`) + +* `PROVISIONING_VERIFICATION_PENDING` (value: `"PROVISIONING_VERIFICATION_PENDING"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `PROVISIONING_FAILED` (value: `"PROVISIONING_FAILED"`) + +* `NOT_ALL_ITEMS_PROVISIONED` (value: `"NOT_ALL_ITEMS_PROVISIONED"`) + +* `ERROR` (value: `"ERROR"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemStatusRequestedFor.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemStatusRequestedFor.md new file mode 100644 index 000000000..68f76d6c1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemStatusRequestedFor.md @@ -0,0 +1,39 @@ +--- +id: v2024-requested-item-status-requested-for +title: RequestedItemStatusRequestedFor +pagination_label: RequestedItemStatusRequestedFor +sidebar_label: RequestedItemStatusRequestedFor +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusRequestedFor', 'V2024RequestedItemStatusRequestedFor'] +slug: /tools/sdk/powershell/v2024/models/requested-item-status-requested-for +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequestedFor', 'V2024RequestedItemStatusRequestedFor'] +--- + + +# RequestedItemStatusRequestedFor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Type of the object to which this reference applies | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemStatusRequestedFor = Initialize-PSSailpoint.V2024RequestedItemStatusRequestedFor -Type IDENTITY ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$RequestedItemStatusRequestedFor | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemStatusRequesterComment.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemStatusRequesterComment.md new file mode 100644 index 000000000..6d4e9133b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemStatusRequesterComment.md @@ -0,0 +1,39 @@ +--- +id: v2024-requested-item-status-requester-comment +title: RequestedItemStatusRequesterComment +pagination_label: RequestedItemStatusRequesterComment +sidebar_label: RequestedItemStatusRequesterComment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusRequesterComment', 'V2024RequestedItemStatusRequesterComment'] +slug: /tools/sdk/powershell/v2024/models/requested-item-status-requester-comment +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequesterComment', 'V2024RequestedItemStatusRequesterComment'] +--- + + +# RequestedItemStatusRequesterComment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment content. | [optional] +**Created** | Pointer to **System.DateTime** | Date and time comment was created. | [optional] +**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemStatusRequesterComment = Initialize-PSSailpoint.V2024RequestedItemStatusRequesterComment -Comment This is a comment. ` + -Created 2017-07-11T18:45:37.098Z ` + -Author null +``` + +- Convert the resource to JSON +```powershell +$RequestedItemStatusRequesterComment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemStatusSodViolationContext.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemStatusSodViolationContext.md new file mode 100644 index 000000000..9e3e4a270 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RequestedItemStatusSodViolationContext.md @@ -0,0 +1,39 @@ +--- +id: v2024-requested-item-status-sod-violation-context +title: RequestedItemStatusSodViolationContext +pagination_label: RequestedItemStatusSodViolationContext +sidebar_label: RequestedItemStatusSodViolationContext +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusSodViolationContext', 'V2024RequestedItemStatusSodViolationContext'] +slug: /tools/sdk/powershell/v2024/models/requested-item-status-sod-violation-context +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusSodViolationContext', 'V2024RequestedItemStatusSodViolationContext'] +--- + + +# RequestedItemStatusSodViolationContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **Enum** [ "SUCCESS", "ERROR" ] | The status of SOD violation check | [optional] +**Uuid** | Pointer to **String** | The id of the Violation check event | [optional] +**ViolationCheckResult** | Pointer to [**SodViolationCheckResult**](sod-violation-check-result) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemStatusSodViolationContext = Initialize-PSSailpoint.V2024RequestedItemStatusSodViolationContext -State SUCCESS ` + -Uuid f73d16e9-a038-46c5-b217-1246e15fdbdd ` + -ViolationCheckResult null +``` + +- Convert the resource to JSON +```powershell +$RequestedItemStatusSodViolationContext | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ResourceObject.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ResourceObject.md new file mode 100644 index 000000000..21ea6634c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ResourceObject.md @@ -0,0 +1,59 @@ +--- +id: v2024-resource-object +title: ResourceObject +pagination_label: ResourceObject +sidebar_label: ResourceObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ResourceObject', 'V2024ResourceObject'] +slug: /tools/sdk/powershell/v2024/models/resource-object +tags: ['SDK', 'Software Development Kit', 'ResourceObject', 'V2024ResourceObject'] +--- + + +# ResourceObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Instance** | Pointer to **String** | Identifier of the specific instance where this object resides. | [optional] [readonly] +**Identity** | Pointer to **String** | Native identity of the object in the Source. | [optional] [readonly] +**Uuid** | Pointer to **String** | Universal unique identifier of the object in the Source. | [optional] [readonly] +**PreviousIdentity** | Pointer to **String** | Native identity that the object has previously. | [optional] [readonly] +**Name** | Pointer to **String** | Display name for this object. | [optional] [readonly] +**ObjectType** | Pointer to **String** | Type of object. | [optional] [readonly] +**Incomplete** | Pointer to **Boolean** | A flag indicating that this is an incomplete object. Used in special cases where the connector has to return account information in several phases and the objects might not have a complete set of all account attributes. The attributes in this object will replace the corresponding attributes in the Link, but no other Link attributes will be changed. | [optional] [readonly] +**Incremental** | Pointer to **Boolean** | A flag indicating that this is an incremental change object. This is similar to incomplete but it also means that the values of any multi-valued attributes in this object should be merged with the existing values in the Link rather than replacing the existing Link value. | [optional] [readonly] +**Delete** | Pointer to **Boolean** | A flag indicating that this object has been deleted. This is set only when doing delta aggregation and the connector supports detection of native deletes. | [optional] [readonly] +**Remove** | Pointer to **Boolean** | A flag set indicating that the values in the attributes represent things to remove rather than things to add. Setting this implies incremental. The values which are always for multi-valued attributes are removed from the current values. | [optional] [readonly] +**Missing** | Pointer to **[]String** | A list of attribute names that are not included in this object. This is only used with SMConnector and will only contain ""groups"". | [optional] [readonly] +**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Attributes of this ResourceObject. | [optional] [readonly] +**FinalUpdate** | Pointer to **Boolean** | In Aggregation, for sparse object the count for total accounts scanned identities updated is not incremented. | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$ResourceObject = Initialize-PSSailpoint.V2024ResourceObject -Instance null ` + -Identity CN=Aaron Carr,OU=test1,DC=test2,DC=test ` + -Uuid {abf7bd9b-68b4-4d21-9b70-870c58ebf844} ` + -PreviousIdentity null ` + -Name Aaron Carr ` + -ObjectType account ` + -Incomplete false ` + -Incremental false ` + -Delete false ` + -Remove false ` + -Missing [missFieldOne, missFieldTwo] ` + -Attributes {telephoneNumber=12-(345)678-9012, mail=example@test.com, displayName=Aaron Carr} ` + -FinalUpdate false +``` + +- Convert the resource to JSON +```powershell +$ResourceObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ResourceObjectsRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ResourceObjectsRequest.md new file mode 100644 index 000000000..3598449b6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ResourceObjectsRequest.md @@ -0,0 +1,37 @@ +--- +id: v2024-resource-objects-request +title: ResourceObjectsRequest +pagination_label: ResourceObjectsRequest +sidebar_label: ResourceObjectsRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ResourceObjectsRequest', 'V2024ResourceObjectsRequest'] +slug: /tools/sdk/powershell/v2024/models/resource-objects-request +tags: ['SDK', 'Software Development Kit', 'ResourceObjectsRequest', 'V2024ResourceObjectsRequest'] +--- + + +# ResourceObjectsRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectType** | Pointer to **String** | The type of resource objects to iterate over. | [optional] [default to "account"] +**MaxCount** | Pointer to **Int32** | The maximum number of resource objects to iterate over and return. | [optional] [default to 25] + +## Examples + +- Prepare the resource +```powershell +$ResourceObjectsRequest = Initialize-PSSailpoint.V2024ResourceObjectsRequest -ObjectType group ` + -MaxCount 100 +``` + +- Convert the resource to JSON +```powershell +$ResourceObjectsRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ResourceObjectsResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ResourceObjectsResponse.md new file mode 100644 index 000000000..7ba94d341 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ResourceObjectsResponse.md @@ -0,0 +1,43 @@ +--- +id: v2024-resource-objects-response +title: ResourceObjectsResponse +pagination_label: ResourceObjectsResponse +sidebar_label: ResourceObjectsResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ResourceObjectsResponse', 'V2024ResourceObjectsResponse'] +slug: /tools/sdk/powershell/v2024/models/resource-objects-response +tags: ['SDK', 'Software Development Kit', 'ResourceObjectsResponse', 'V2024ResourceObjectsResponse'] +--- + + +# ResourceObjectsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the source | [optional] [readonly] +**Name** | Pointer to **String** | Name of the source | [optional] [readonly] +**ObjectCount** | Pointer to **Int32** | The number of objects that were fetched by the connector. | [optional] [readonly] +**ElapsedMillis** | Pointer to **Int32** | The number of milliseconds spent on the entire request. | [optional] [readonly] +**ResourceObjects** | Pointer to [**[]ResourceObject**](resource-object) | Fetched objects from the source connector. | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$ResourceObjectsResponse = Initialize-PSSailpoint.V2024ResourceObjectsResponse -Id 2c91808568c529c60168cca6f90c1313 ` + -Name ODS-AD-Test [source-999999] ` + -ObjectCount 25 ` + -ElapsedMillis 1055 ` + -ResourceObjects null +``` + +- Convert the resource to JSON +```powershell +$ResourceObjectsResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReviewDecision.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReviewDecision.md new file mode 100644 index 000000000..5703c6e8c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReviewDecision.md @@ -0,0 +1,45 @@ +--- +id: v2024-review-decision +title: ReviewDecision +pagination_label: ReviewDecision +sidebar_label: ReviewDecision +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewDecision', 'V2024ReviewDecision'] +slug: /tools/sdk/powershell/v2024/models/review-decision +tags: ['SDK', 'Software Development Kit', 'ReviewDecision', 'V2024ReviewDecision'] +--- + + +# ReviewDecision + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The id of the review decision | [required] +**Decision** | [**CertificationDecision**](certification-decision) | | [required] +**ProposedEndDate** | Pointer to **System.DateTime** | The date at which a user's access should be taken away. Should only be set for `REVOKE` decisions. | [optional] +**Bulk** | **Boolean** | Indicates whether decision should be marked as part of a larger bulk decision | [required] +**Recommendation** | Pointer to [**ReviewRecommendation**](review-recommendation) | | [optional] +**Comments** | Pointer to **String** | Comments recorded when the decision was made | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReviewDecision = Initialize-PSSailpoint.V2024ReviewDecision -Id ef38f94347e94562b5bb8424a56397d8 ` + -Decision null ` + -ProposedEndDate 2017-07-11T18:45:37.098Z ` + -Bulk true ` + -Recommendation null ` + -Comments This user no longer needs access to this source +``` + +- Convert the resource to JSON +```powershell +$ReviewDecision | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReviewReassign.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReviewReassign.md new file mode 100644 index 000000000..97bf31773 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReviewReassign.md @@ -0,0 +1,39 @@ +--- +id: v2024-review-reassign +title: ReviewReassign +pagination_label: ReviewReassign +sidebar_label: ReviewReassign +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewReassign', 'V2024ReviewReassign'] +slug: /tools/sdk/powershell/v2024/models/review-reassign +tags: ['SDK', 'Software Development Kit', 'ReviewReassign', 'V2024ReviewReassign'] +--- + + +# ReviewReassign + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$ReviewReassign = Initialize-PSSailpoint.V2024ReviewReassign -Reassign null ` + -ReassignTo ef38f94347e94562b5bb8424a56397d8 ` + -Reason reassigned for some reason +``` + +- Convert the resource to JSON +```powershell +$ReviewReassign | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReviewRecommendation.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReviewRecommendation.md new file mode 100644 index 000000000..a9b856494 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReviewRecommendation.md @@ -0,0 +1,39 @@ +--- +id: v2024-review-recommendation +title: ReviewRecommendation +pagination_label: ReviewRecommendation +sidebar_label: ReviewRecommendation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewRecommendation', 'V2024ReviewRecommendation'] +slug: /tools/sdk/powershell/v2024/models/review-recommendation +tags: ['SDK', 'Software Development Kit', 'ReviewRecommendation', 'V2024ReviewRecommendation'] +--- + + +# ReviewRecommendation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Recommendation** | Pointer to **String** | The recommendation from IAI at the time of the decision. This field will be null if no recommendation was made. | [optional] +**Reasons** | Pointer to **[]String** | A list of reasons for the recommendation. | [optional] +**Timestamp** | Pointer to **System.DateTime** | The time at which the recommendation was recorded. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReviewRecommendation = Initialize-PSSailpoint.V2024ReviewRecommendation -Recommendation null ` + -Reasons [Reason 1, Reason 2] ` + -Timestamp 2020-06-01T13:49:37.385Z +``` + +- Convert the resource to JSON +```powershell +$ReviewRecommendation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReviewableAccessProfile.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReviewableAccessProfile.md new file mode 100644 index 000000000..3e22d2230 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReviewableAccessProfile.md @@ -0,0 +1,53 @@ +--- +id: v2024-reviewable-access-profile +title: ReviewableAccessProfile +pagination_label: ReviewableAccessProfile +sidebar_label: ReviewableAccessProfile +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewableAccessProfile', 'V2024ReviewableAccessProfile'] +slug: /tools/sdk/powershell/v2024/models/reviewable-access-profile +tags: ['SDK', 'Software Development Kit', 'ReviewableAccessProfile', 'V2024ReviewableAccessProfile'] +--- + + +# ReviewableAccessProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The id of the Access Profile | [optional] +**Name** | Pointer to **String** | Name of the Access Profile | [optional] +**Description** | Pointer to **String** | Information about the Access Profile | [optional] +**Privileged** | Pointer to **Boolean** | Indicates if the entitlement is a privileged entitlement | [optional] +**CloudGoverned** | Pointer to **Boolean** | True if the entitlement is cloud governed | [optional] +**EndDate** | Pointer to **System.DateTime** | The date at which a user's access expires | [optional] +**Owner** | Pointer to [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**Entitlements** | Pointer to [**[]ReviewableEntitlement**](reviewable-entitlement) | A list of entitlements associated with this Access Profile | [optional] +**Created** | Pointer to **System.DateTime** | Date the Access Profile was created. | [optional] +**Modified** | Pointer to **System.DateTime** | Date the Access Profile was last modified. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReviewableAccessProfile = Initialize-PSSailpoint.V2024ReviewableAccessProfile -Id 2c91808a7190d06e01719938fcd20792 ` + -Name Employee-database-read-write ` + -Description Collection of entitlements to read/write the employee database ` + -Privileged false ` + -CloudGoverned false ` + -EndDate 2021-12-25T00:00Z ` + -Owner null ` + -Entitlements null ` + -Created 2021-01-01T22:32:58.104Z ` + -Modified 2021-02-01T22:32:58.104Z +``` + +- Convert the resource to JSON +```powershell +$ReviewableAccessProfile | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReviewableEntitlement.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReviewableEntitlement.md new file mode 100644 index 000000000..2ed4a6d76 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReviewableEntitlement.md @@ -0,0 +1,69 @@ +--- +id: v2024-reviewable-entitlement +title: ReviewableEntitlement +pagination_label: ReviewableEntitlement +sidebar_label: ReviewableEntitlement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewableEntitlement', 'V2024ReviewableEntitlement'] +slug: /tools/sdk/powershell/v2024/models/reviewable-entitlement +tags: ['SDK', 'Software Development Kit', 'ReviewableEntitlement', 'V2024ReviewableEntitlement'] +--- + + +# ReviewableEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The id for the entitlement | [optional] +**Name** | Pointer to **String** | The name of the entitlement | [optional] +**Description** | Pointer to **String** | Information about the entitlement | [optional] +**Privileged** | Pointer to **Boolean** | Indicates if the entitlement is a privileged entitlement | [optional] [default to $false] +**Owner** | Pointer to [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**AttributeName** | Pointer to **String** | The name of the attribute on the source | [optional] +**AttributeValue** | Pointer to **String** | The value of the attribute on the source | [optional] +**SourceSchemaObjectType** | Pointer to **String** | The schema object type on the source used to represent the entitlement and its attributes | [optional] +**SourceName** | Pointer to **String** | The name of the source for which this entitlement belongs | [optional] +**SourceType** | Pointer to **String** | The type of the source for which the entitlement belongs | [optional] +**SourceId** | Pointer to **String** | The ID of the source for which the entitlement belongs | [optional] +**HasPermissions** | Pointer to **Boolean** | Indicates if the entitlement has permissions | [optional] [default to $false] +**IsPermission** | Pointer to **Boolean** | Indicates if the entitlement is a representation of an account permission | [optional] [default to $false] +**Revocable** | Pointer to **Boolean** | Indicates whether the entitlement can be revoked | [optional] [default to $false] +**CloudGoverned** | Pointer to **Boolean** | True if the entitlement is cloud governed | [optional] [default to $false] +**ContainsDataAccess** | Pointer to **Boolean** | True if the entitlement has DAS data | [optional] [default to $false] +**DataAccess** | Pointer to [**DataAccess**](data-access) | | [optional] +**Account** | Pointer to [**ReviewableEntitlementAccount**](reviewable-entitlement-account) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReviewableEntitlement = Initialize-PSSailpoint.V2024ReviewableEntitlement -Id 2c918085718230600171993742c63558 ` + -Name CN=entitlement.bbb7c650 ` + -Description Gives read/write access to the company database ` + -Privileged false ` + -Owner null ` + -AttributeName memberOf ` + -AttributeValue CN=entitlement.bbb7c650 ` + -SourceSchemaObjectType groups ` + -SourceName ODS-AD-Source ` + -SourceType Active Directory - Direct ` + -SourceId 78ca6be511cb41fbb86dba2fcca7780c ` + -HasPermissions false ` + -IsPermission false ` + -Revocable true ` + -CloudGoverned false ` + -ContainsDataAccess true ` + -DataAccess null ` + -Account null +``` + +- Convert the resource to JSON +```powershell +$ReviewableEntitlement | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReviewableEntitlementAccount.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReviewableEntitlementAccount.md new file mode 100644 index 000000000..b9d40a338 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReviewableEntitlementAccount.md @@ -0,0 +1,57 @@ +--- +id: v2024-reviewable-entitlement-account +title: ReviewableEntitlementAccount +pagination_label: ReviewableEntitlementAccount +sidebar_label: ReviewableEntitlementAccount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewableEntitlementAccount', 'V2024ReviewableEntitlementAccount'] +slug: /tools/sdk/powershell/v2024/models/reviewable-entitlement-account +tags: ['SDK', 'Software Development Kit', 'ReviewableEntitlementAccount', 'V2024ReviewableEntitlementAccount'] +--- + + +# ReviewableEntitlementAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NativeIdentity** | Pointer to **String** | The native identity for this account | [optional] +**Disabled** | Pointer to **Boolean** | Indicates whether this account is currently disabled | [optional] [default to $false] +**Locked** | Pointer to **Boolean** | Indicates whether this account is currently locked | [optional] [default to $false] +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **String** | The id associated with the account | [optional] +**Name** | Pointer to **String** | The account name | [optional] +**Created** | Pointer to **System.DateTime** | When the account was created | [optional] +**Modified** | Pointer to **System.DateTime** | When the account was last modified | [optional] +**ActivityInsights** | Pointer to [**ActivityInsights**](activity-insights) | | [optional] +**Description** | Pointer to **String** | Information about the account | [optional] +**GovernanceGroupId** | Pointer to **String** | The id associated with the machine Account Governance Group | [optional] +**Owner** | Pointer to [**ReviewableEntitlementAccountOwner**](reviewable-entitlement-account-owner) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReviewableEntitlementAccount = Initialize-PSSailpoint.V2024ReviewableEntitlementAccount -NativeIdentity CN=Alison Ferguso ` + -Disabled false ` + -Locked false ` + -Type null ` + -Id 2c9180857182305e0171993737eb29e6 ` + -Name Alison Ferguso ` + -Created 2020-04-20T20:11:05.067Z ` + -Modified 2020-05-20T18:57:16.987Z ` + -ActivityInsights null ` + -Description Account for Read/write to the company database ` + -GovernanceGroupId 2c9180857182305e0171993737eb29e6 ` + -Owner null +``` + +- Convert the resource to JSON +```powershell +$ReviewableEntitlementAccount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReviewableEntitlementAccountOwner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReviewableEntitlementAccountOwner.md new file mode 100644 index 000000000..19825afb6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReviewableEntitlementAccountOwner.md @@ -0,0 +1,39 @@ +--- +id: v2024-reviewable-entitlement-account-owner +title: ReviewableEntitlementAccountOwner +pagination_label: ReviewableEntitlementAccountOwner +sidebar_label: ReviewableEntitlementAccountOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewableEntitlementAccountOwner', 'V2024ReviewableEntitlementAccountOwner'] +slug: /tools/sdk/powershell/v2024/models/reviewable-entitlement-account-owner +tags: ['SDK', 'Software Development Kit', 'ReviewableEntitlementAccountOwner', 'V2024ReviewableEntitlementAccountOwner'] +--- + + +# ReviewableEntitlementAccountOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The id associated with the machine account owner | [optional] +**Type** | Pointer to **Enum** [ "IDENTITY" ] | An enumeration of the types of Owner supported within the IdentityNow infrastructure. | [optional] +**DisplayName** | Pointer to **String** | The machine account owner's display name | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReviewableEntitlementAccountOwner = Initialize-PSSailpoint.V2024ReviewableEntitlementAccountOwner -Id 2c9180857182305e0171993737eb29e8 ` + -Type IDENTITY ` + -DisplayName Alison Ferguson +``` + +- Convert the resource to JSON +```powershell +$ReviewableEntitlementAccountOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReviewableRole.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReviewableRole.md new file mode 100644 index 000000000..8cb865a56 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ReviewableRole.md @@ -0,0 +1,51 @@ +--- +id: v2024-reviewable-role +title: ReviewableRole +pagination_label: ReviewableRole +sidebar_label: ReviewableRole +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewableRole', 'V2024ReviewableRole'] +slug: /tools/sdk/powershell/v2024/models/reviewable-role +tags: ['SDK', 'Software Development Kit', 'ReviewableRole', 'V2024ReviewableRole'] +--- + + +# ReviewableRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The id for the Role | [optional] +**Name** | Pointer to **String** | The name of the Role | [optional] +**Description** | Pointer to **String** | Information about the Role | [optional] +**Privileged** | Pointer to **Boolean** | Indicates if the entitlement is a privileged entitlement | [optional] +**Owner** | Pointer to [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**Revocable** | Pointer to **Boolean** | Indicates whether the Role can be revoked or requested | [optional] +**EndDate** | Pointer to **System.DateTime** | The date when a user's access expires. | [optional] +**AccessProfiles** | Pointer to [**[]ReviewableAccessProfile**](reviewable-access-profile) | The list of Access Profiles associated with this Role | [optional] +**Entitlements** | Pointer to [**[]ReviewableEntitlement**](reviewable-entitlement) | The list of entitlements associated with this Role | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReviewableRole = Initialize-PSSailpoint.V2024ReviewableRole -Id 2c91808a7190d06e0171993907fd0794 ` + -Name Accounting-Employees ` + -Description Role for members of the accounting department with the necessary Access Profiles ` + -Privileged false ` + -Owner null ` + -Revocable false ` + -EndDate 2021-12-25T00:00Z ` + -AccessProfiles null ` + -Entitlements null +``` + +- Convert the resource to JSON +```powershell +$ReviewableRole | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Reviewer.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Reviewer.md new file mode 100644 index 000000000..2f88ac5c0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Reviewer.md @@ -0,0 +1,45 @@ +--- +id: v2024-reviewer +title: Reviewer +pagination_label: Reviewer +sidebar_label: Reviewer +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Reviewer', 'V2024Reviewer'] +slug: /tools/sdk/powershell/v2024/models/reviewer +tags: ['SDK', 'Software Development Kit', 'Reviewer', 'V2024Reviewer'] +--- + + +# Reviewer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The id of the reviewer. | [optional] +**Name** | Pointer to **String** | The name of the reviewer. | [optional] +**Email** | Pointer to **String** | The email of the reviewing identity. | [optional] +**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of the reviewing identity. | [optional] +**Created** | Pointer to **System.DateTime** | The created date of the reviewing identity. | [optional] +**Modified** | Pointer to **System.DateTime** | The modified date of the reviewing identity. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Reviewer = Initialize-PSSailpoint.V2024Reviewer -Id ef38f94347e94562b5bb8424a56397d8 ` + -Name Reviewer Name ` + -Email reviewer@test.com ` + -Type IDENTITY ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z +``` + +- Convert the resource to JSON +```powershell +$Reviewer | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Reviewer1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Reviewer1.md new file mode 100644 index 000000000..e3011ccd7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Reviewer1.md @@ -0,0 +1,41 @@ +--- +id: v2024-reviewer1 +title: Reviewer1 +pagination_label: Reviewer1 +sidebar_label: Reviewer1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Reviewer1', 'V2024Reviewer1'] +slug: /tools/sdk/powershell/v2024/models/reviewer1 +tags: ['SDK', 'Software Development Kit', 'Reviewer1', 'V2024Reviewer1'] +--- + + +# Reviewer1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY", "GOVERNANCE_GROUP" ] | The reviewer's DTO type. | [required] +**Id** | **String** | The reviewer's ID. | [required] +**Name** | **String** | The reviewer's display name. | [required] +**Email** | Pointer to **String** | The reviewing identity's email. Only applicable to `IDENTITY`. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Reviewer1 = Initialize-PSSailpoint.V2024Reviewer1 -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels ` + -Email reviewer@test.com +``` + +- Convert the resource to JSON +```powershell +$Reviewer1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Revocability.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Revocability.md new file mode 100644 index 000000000..1d32c3c22 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Revocability.md @@ -0,0 +1,35 @@ +--- +id: v2024-revocability +title: Revocability +pagination_label: Revocability +sidebar_label: Revocability +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Revocability', 'V2024Revocability'] +slug: /tools/sdk/powershell/v2024/models/revocability +tags: ['SDK', 'Software Development Kit', 'Revocability', 'V2024Revocability'] +--- + + +# Revocability + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalSchemes** | Pointer to [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] + +## Examples + +- Prepare the resource +```powershell +$Revocability = Initialize-PSSailpoint.V2024Revocability -ApprovalSchemes null +``` + +- Convert the resource to JSON +```powershell +$Revocability | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RevocabilityForRole.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RevocabilityForRole.md new file mode 100644 index 000000000..95cf03ee3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RevocabilityForRole.md @@ -0,0 +1,39 @@ +--- +id: v2024-revocability-for-role +title: RevocabilityForRole +pagination_label: RevocabilityForRole +sidebar_label: RevocabilityForRole +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RevocabilityForRole', 'V2024RevocabilityForRole'] +slug: /tools/sdk/powershell/v2024/models/revocability-for-role +tags: ['SDK', 'Software Development Kit', 'RevocabilityForRole', 'V2024RevocabilityForRole'] +--- + + +# RevocabilityForRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommentsRequired** | Pointer to **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] +**DenialCommentsRequired** | Pointer to **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] +**ApprovalSchemes** | Pointer to [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the revocation request | [optional] + +## Examples + +- Prepare the resource +```powershell +$RevocabilityForRole = Initialize-PSSailpoint.V2024RevocabilityForRole -CommentsRequired false ` + -DenialCommentsRequired false ` + -ApprovalSchemes null +``` + +- Convert the resource to JSON +```powershell +$RevocabilityForRole | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RightPad.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RightPad.md new file mode 100644 index 000000000..8d41e6bfe --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RightPad.md @@ -0,0 +1,41 @@ +--- +id: v2024-right-pad +title: RightPad +pagination_label: RightPad +sidebar_label: RightPad +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RightPad', 'V2024RightPad'] +slug: /tools/sdk/powershell/v2024/models/right-pad +tags: ['SDK', 'Software Development Kit', 'RightPad', 'V2024RightPad'] +--- + + +# RightPad + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Length** | **String** | An integer value for the desired length of the final output string | [required] +**Padding** | Pointer to **String** | A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space ("" "") character for padding | [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] + +## Examples + +- Prepare the resource +```powershell +$RightPad = Initialize-PSSailpoint.V2024RightPad -Length 4 ` + -Padding 0 ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$RightPad | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Role.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Role.md new file mode 100644 index 000000000..dd99d12d7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Role.md @@ -0,0 +1,69 @@ +--- +id: v2024-role +title: Role +pagination_label: Role +sidebar_label: Role +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Role', 'V2024Role'] +slug: /tools/sdk/powershell/v2024/models/role +tags: ['SDK', 'Software Development Kit', 'Role', 'V2024Role'] +--- + + +# Role + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result. | [optional] +**Name** | **String** | The human-readable display name of the Role | [required] +**Created** | Pointer to **System.DateTime** | Date the Role was created | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | Date the Role was last modified. | [optional] [readonly] +**Description** | Pointer to **String** | A human-readable description of the Role | [optional] +**Owner** | [**OwnerReference**](owner-reference) | | [required] +**AccessProfiles** | Pointer to [**[]AccessProfileRef**](access-profile-ref) | | [optional] +**Entitlements** | Pointer to [**[]EntitlementRef**](entitlement-ref) | | [optional] +**Membership** | Pointer to [**RoleMembershipSelector**](role-membership-selector) | | [optional] +**LegacyMembershipInfo** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. | [optional] +**Enabled** | Pointer to **Boolean** | Whether the Role is enabled or not. | [optional] [default to $false] +**Requestable** | Pointer to **Boolean** | Whether the Role can be the target of access requests. | [optional] [default to $false] +**AccessRequestConfig** | Pointer to [**RequestabilityForRole**](requestability-for-role) | | [optional] +**RevocationRequestConfig** | Pointer to [**RevocabilityForRole**](revocability-for-role) | | [optional] +**Segments** | Pointer to **[]String** | List of IDs of segments, if any, to which this Role is assigned. | [optional] +**Dimensional** | Pointer to **Boolean** | Whether the Role is dimensional. | [optional] [default to $false] +**DimensionRefs** | Pointer to [**[]DimensionRef**](dimension-ref) | List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional. | [optional] +**AccessModelMetadata** | Pointer to [**AttributeDTOList**](attribute-dto-list) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Role = Initialize-PSSailpoint.V2024Role -Id 2c918086749d78830174a1a40e121518 ` + -Name Role 2567 ` + -Created 2021-03-01T22:32:58.104Z ` + -Modified 2021-03-02T20:22:28.104Z ` + -Description Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor. ` + -Owner null ` + -AccessProfiles null ` + -Entitlements null ` + -Membership null ` + -LegacyMembershipInfo {type=IDENTITY_LIST} ` + -Enabled true ` + -Requestable true ` + -AccessRequestConfig null ` + -RevocationRequestConfig null ` + -Segments [f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a] ` + -Dimensional null ` + -DimensionRefs null ` + -AccessModelMetadata null +``` + +- Convert the resource to JSON +```powershell +$Role | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleAssignmentDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleAssignmentDto.md new file mode 100644 index 000000000..c7bc290ef --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleAssignmentDto.md @@ -0,0 +1,51 @@ +--- +id: v2024-role-assignment-dto +title: RoleAssignmentDto +pagination_label: RoleAssignmentDto +sidebar_label: RoleAssignmentDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleAssignmentDto', 'V2024RoleAssignmentDto'] +slug: /tools/sdk/powershell/v2024/models/role-assignment-dto +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentDto', 'V2024RoleAssignmentDto'] +--- + + +# RoleAssignmentDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Assignment Id | [optional] +**Role** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] +**Comments** | Pointer to **String** | Comments added by the user when the assignment was made | [optional] +**AssignmentSource** | Pointer to **String** | Source describing how this assignment was made | [optional] +**Assigner** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] +**AssignedDimensions** | Pointer to [**[]BaseReferenceDto1**](base-reference-dto1) | Dimensions assigned related to this role | [optional] +**AssignmentContext** | Pointer to [**AssignmentContextDto**](assignment-context-dto) | | [optional] +**AccountTargets** | Pointer to [**[]RoleTargetDto**](role-target-dto) | | [optional] +**RemoveDate** | Pointer to **String** | Date that the assignment will be removed | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleAssignmentDto = Initialize-PSSailpoint.V2024RoleAssignmentDto -Id 1cbb0705b38c4226b1334eadd8874086 ` + -Role null ` + -Comments I'm a new Engineer and need this role to do my work ` + -AssignmentSource UI ` + -Assigner null ` + -AssignedDimensions [{id=1acc8ffe5fcf457090de28bee2af36ee, type=DIMENSION, name=Northeast region}] ` + -AssignmentContext null ` + -AccountTargets null ` + -RemoveDate Wed Feb 14 10:58:42 +``` + +- Convert the resource to JSON +```powershell +$RoleAssignmentDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleAssignmentRef.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleAssignmentRef.md new file mode 100644 index 000000000..27f1b6a03 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleAssignmentRef.md @@ -0,0 +1,37 @@ +--- +id: v2024-role-assignment-ref +title: RoleAssignmentRef +pagination_label: RoleAssignmentRef +sidebar_label: RoleAssignmentRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleAssignmentRef', 'V2024RoleAssignmentRef'] +slug: /tools/sdk/powershell/v2024/models/role-assignment-ref +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentRef', 'V2024RoleAssignmentRef'] +--- + + +# RoleAssignmentRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Assignment Id | [optional] +**Role** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleAssignmentRef = Initialize-PSSailpoint.V2024RoleAssignmentRef -Id 1cbb0705b38c4226b1334eadd8874086 ` + -Role null +``` + +- Convert the resource to JSON +```powershell +$RoleAssignmentRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleAssignmentSourceType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleAssignmentSourceType.md new file mode 100644 index 000000000..b8df1a4d9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleAssignmentSourceType.md @@ -0,0 +1,24 @@ +--- +id: v2024-role-assignment-source-type +title: RoleAssignmentSourceType +pagination_label: RoleAssignmentSourceType +sidebar_label: RoleAssignmentSourceType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleAssignmentSourceType', 'V2024RoleAssignmentSourceType'] +slug: /tools/sdk/powershell/v2024/models/role-assignment-source-type +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentSourceType', 'V2024RoleAssignmentSourceType'] +--- + + +# RoleAssignmentSourceType + +## Enum + + +* `ACCESS_REQUEST` (value: `"ACCESS_REQUEST"`) + +* `ROLE_MEMBERSHIP` (value: `"ROLE_MEMBERSHIP"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleBulkDeleteRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleBulkDeleteRequest.md new file mode 100644 index 000000000..6494db369 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleBulkDeleteRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-role-bulk-delete-request +title: RoleBulkDeleteRequest +pagination_label: RoleBulkDeleteRequest +sidebar_label: RoleBulkDeleteRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleBulkDeleteRequest', 'V2024RoleBulkDeleteRequest'] +slug: /tools/sdk/powershell/v2024/models/role-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'RoleBulkDeleteRequest', 'V2024RoleBulkDeleteRequest'] +--- + + +# RoleBulkDeleteRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RoleIds** | **[]String** | List of IDs of Roles to be deleted. | [required] + +## Examples + +- Prepare the resource +```powershell +$RoleBulkDeleteRequest = Initialize-PSSailpoint.V2024RoleBulkDeleteRequest -RoleIds [2c9180847812e0b1017817051919ecca, 2c9180887812e0b201781e129f151816] +``` + +- Convert the resource to JSON +```powershell +$RoleBulkDeleteRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleBulkUpdateResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleBulkUpdateResponse.md new file mode 100644 index 000000000..91bacf3c0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleBulkUpdateResponse.md @@ -0,0 +1,41 @@ +--- +id: v2024-role-bulk-update-response +title: RoleBulkUpdateResponse +pagination_label: RoleBulkUpdateResponse +sidebar_label: RoleBulkUpdateResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleBulkUpdateResponse', 'V2024RoleBulkUpdateResponse'] +slug: /tools/sdk/powershell/v2024/models/role-bulk-update-response +tags: ['SDK', 'Software Development Kit', 'RoleBulkUpdateResponse', 'V2024RoleBulkUpdateResponse'] +--- + + +# RoleBulkUpdateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the task which is executing the bulk update. This also used in to the bulk-update/** API to track status. | [optional] +**Type** | Pointer to **String** | Type of the bulk update object. | [optional] +**Status** | Pointer to **Enum** [ "CREATED", "PRE_PROCESS", "PRE_PROCESS_COMPLETED", "POST_PROCESS", "COMPLETED", "CHUNK_PENDING", "CHUNK_PROCESSING" ] | The status of the bulk update request, could also checked by getBulkUpdateStatus API | [optional] +**Created** | Pointer to **System.DateTime** | Time when the bulk update request was created | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleBulkUpdateResponse = Initialize-PSSailpoint.V2024RoleBulkUpdateResponse -Id 2c9180867817ac4d017817c491119a20 ` + -Type Role ` + -Status CREATED ` + -Created 2020-10-08T18:33:52.029Z +``` + +- Convert the resource to JSON +```powershell +$RoleBulkUpdateResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleCriteriaKey.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleCriteriaKey.md new file mode 100644 index 000000000..450a4cf89 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleCriteriaKey.md @@ -0,0 +1,39 @@ +--- +id: v2024-role-criteria-key +title: RoleCriteriaKey +pagination_label: RoleCriteriaKey +sidebar_label: RoleCriteriaKey +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaKey', 'V2024RoleCriteriaKey'] +slug: /tools/sdk/powershell/v2024/models/role-criteria-key +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKey', 'V2024RoleCriteriaKey'] +--- + + +# RoleCriteriaKey + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**RoleCriteriaKeyType**](role-criteria-key-type) | | [required] +**Property** | **String** | The name of the attribute or entitlement to which the associated criteria applies. | [required] +**SourceId** | Pointer to **String** | ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleCriteriaKey = Initialize-PSSailpoint.V2024RoleCriteriaKey -Type null ` + -Property attribute.email ` + -SourceId 2c9180867427f3a301745aec18211519 +``` + +- Convert the resource to JSON +```powershell +$RoleCriteriaKey | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleCriteriaKeyType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleCriteriaKeyType.md new file mode 100644 index 000000000..687084a3c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleCriteriaKeyType.md @@ -0,0 +1,26 @@ +--- +id: v2024-role-criteria-key-type +title: RoleCriteriaKeyType +pagination_label: RoleCriteriaKeyType +sidebar_label: RoleCriteriaKeyType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaKeyType', 'V2024RoleCriteriaKeyType'] +slug: /tools/sdk/powershell/v2024/models/role-criteria-key-type +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKeyType', 'V2024RoleCriteriaKeyType'] +--- + + +# RoleCriteriaKeyType + +## Enum + + +* `IDENTITY` (value: `"IDENTITY"`) + +* `ACCOUNT` (value: `"ACCOUNT"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleCriteriaLevel1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleCriteriaLevel1.md new file mode 100644 index 000000000..3a94b1709 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleCriteriaLevel1.md @@ -0,0 +1,41 @@ +--- +id: v2024-role-criteria-level1 +title: RoleCriteriaLevel1 +pagination_label: RoleCriteriaLevel1 +sidebar_label: RoleCriteriaLevel1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaLevel1', 'V2024RoleCriteriaLevel1'] +slug: /tools/sdk/powershell/v2024/models/role-criteria-level1 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel1', 'V2024RoleCriteriaLevel1'] +--- + + +# RoleCriteriaLevel1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**Key** | Pointer to [**RoleCriteriaKey**](role-criteria-key) | | [optional] +**StringValue** | Pointer to **String** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] +**Children** | Pointer to [**[]RoleCriteriaLevel2**](role-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleCriteriaLevel1 = Initialize-PSSailpoint.V2024RoleCriteriaLevel1 -Operation null ` + -Key null ` + -StringValue carlee.cert1c9f9b6fd@mailinator.com ` + -Children null +``` + +- Convert the resource to JSON +```powershell +$RoleCriteriaLevel1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleCriteriaLevel2.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleCriteriaLevel2.md new file mode 100644 index 000000000..19e7a6e49 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleCriteriaLevel2.md @@ -0,0 +1,41 @@ +--- +id: v2024-role-criteria-level2 +title: RoleCriteriaLevel2 +pagination_label: RoleCriteriaLevel2 +sidebar_label: RoleCriteriaLevel2 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaLevel2', 'V2024RoleCriteriaLevel2'] +slug: /tools/sdk/powershell/v2024/models/role-criteria-level2 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel2', 'V2024RoleCriteriaLevel2'] +--- + + +# RoleCriteriaLevel2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**Key** | Pointer to [**RoleCriteriaKey**](role-criteria-key) | | [optional] +**StringValue** | Pointer to **String** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] +**Children** | Pointer to [**[]RoleCriteriaLevel3**](role-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleCriteriaLevel2 = Initialize-PSSailpoint.V2024RoleCriteriaLevel2 -Operation null ` + -Key null ` + -StringValue carlee.cert1c9f9b6fd@mailinator.com ` + -Children null +``` + +- Convert the resource to JSON +```powershell +$RoleCriteriaLevel2 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleCriteriaLevel3.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleCriteriaLevel3.md new file mode 100644 index 000000000..60ce08659 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleCriteriaLevel3.md @@ -0,0 +1,39 @@ +--- +id: v2024-role-criteria-level3 +title: RoleCriteriaLevel3 +pagination_label: RoleCriteriaLevel3 +sidebar_label: RoleCriteriaLevel3 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaLevel3', 'V2024RoleCriteriaLevel3'] +slug: /tools/sdk/powershell/v2024/models/role-criteria-level3 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel3', 'V2024RoleCriteriaLevel3'] +--- + + +# RoleCriteriaLevel3 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**Key** | Pointer to [**RoleCriteriaKey**](role-criteria-key) | | [optional] +**StringValue** | Pointer to **String** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleCriteriaLevel3 = Initialize-PSSailpoint.V2024RoleCriteriaLevel3 -Operation null ` + -Key null ` + -StringValue carlee.cert1c9f9b6fd@mailinator.com +``` + +- Convert the resource to JSON +```powershell +$RoleCriteriaLevel3 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleCriteriaOperation.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleCriteriaOperation.md new file mode 100644 index 000000000..d56de1ad9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleCriteriaOperation.md @@ -0,0 +1,34 @@ +--- +id: v2024-role-criteria-operation +title: RoleCriteriaOperation +pagination_label: RoleCriteriaOperation +sidebar_label: RoleCriteriaOperation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaOperation', 'V2024RoleCriteriaOperation'] +slug: /tools/sdk/powershell/v2024/models/role-criteria-operation +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaOperation', 'V2024RoleCriteriaOperation'] +--- + + +# RoleCriteriaOperation + +## Enum + + +* `EQUALS` (value: `"EQUALS"`) + +* `NOT_EQUALS` (value: `"NOT_EQUALS"`) + +* `CONTAINS` (value: `"CONTAINS"`) + +* `STARTS_WITH` (value: `"STARTS_WITH"`) + +* `ENDS_WITH` (value: `"ENDS_WITH"`) + +* `AND` (value: `"AND"`) + +* `OR` (value: `"OR"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleDocument.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleDocument.md new file mode 100644 index 000000000..b4fcfd985 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleDocument.md @@ -0,0 +1,69 @@ +--- +id: v2024-role-document +title: RoleDocument +pagination_label: RoleDocument +sidebar_label: RoleDocument +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleDocument', 'V2024RoleDocument'] +slug: /tools/sdk/powershell/v2024/models/role-document +tags: ['SDK', 'Software Development Kit', 'RoleDocument', 'V2024RoleDocument'] +--- + + +# RoleDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the referenced object. | [required] +**Name** | **String** | The human readable name of the referenced object. | [required] +**Type** | [**DocumentType**](document-type) | | [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] +**AccessProfiles** | Pointer to [**[]BaseAccessProfile**](base-access-profile) | Access profiles included with the role. | [optional] +**AccessProfileCount** | Pointer to **Int32** | Number of access profiles included with the role. | [optional] +**Tags** | Pointer to **[]String** | Tags that have been applied to the object. | [optional] +**Segments** | Pointer to [**[]BaseSegment**](base-segment) | Segments with the role. | [optional] +**SegmentCount** | Pointer to **Int32** | Number of segments with the role. | [optional] +**Entitlements** | Pointer to [**[]BaseEntitlement**](base-entitlement) | Entitlements included with the role. | [optional] +**EntitlementCount** | Pointer to **Int32** | Number of entitlements included with the role. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleDocument = Initialize-PSSailpoint.V2024RoleDocument -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -Type null ` + -Description The admin role ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Synced 2018-06-25T20:22:33.104Z ` + -Enabled true ` + -Requestable true ` + -RequestCommentsRequired false ` + -Owner null ` + -AccessProfiles null ` + -AccessProfileCount 1 ` + -Tags [TAG_1, TAG_2] ` + -Segments null ` + -SegmentCount 1 ` + -Entitlements null ` + -EntitlementCount 3 +``` + +- Convert the resource to JSON +```powershell +$RoleDocument | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleGetAllBulkUpdateResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleGetAllBulkUpdateResponse.md new file mode 100644 index 000000000..5a46a33df --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleGetAllBulkUpdateResponse.md @@ -0,0 +1,41 @@ +--- +id: v2024-role-get-all-bulk-update-response +title: RoleGetAllBulkUpdateResponse +pagination_label: RoleGetAllBulkUpdateResponse +sidebar_label: RoleGetAllBulkUpdateResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleGetAllBulkUpdateResponse', 'V2024RoleGetAllBulkUpdateResponse'] +slug: /tools/sdk/powershell/v2024/models/role-get-all-bulk-update-response +tags: ['SDK', 'Software Development Kit', 'RoleGetAllBulkUpdateResponse', 'V2024RoleGetAllBulkUpdateResponse'] +--- + + +# RoleGetAllBulkUpdateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the task which is executing the bulk update. This also used in to the bulk-update/** API to track status. | [optional] +**Type** | Pointer to **String** | Type of the bulk update object. | [optional] +**Status** | Pointer to **Enum** [ "CREATED", "PRE_PROCESS", "POST_PROCESS", "CHUNK_PENDING", "CHUNK_PROCESSING" ] | The status of the bulk update request, only list unfinished request's status, the status could also checked by getBulkUpdateStatus API | [optional] +**Created** | Pointer to **System.DateTime** | Time when the bulk update request was created | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleGetAllBulkUpdateResponse = Initialize-PSSailpoint.V2024RoleGetAllBulkUpdateResponse -Id 2c9180867817ac4d017817c491119a20 ` + -Type Role ` + -Status CREATED ` + -Created 2020-10-08T18:33:52.029Z +``` + +- Convert the resource to JSON +```powershell +$RoleGetAllBulkUpdateResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleIdentity.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleIdentity.md new file mode 100644 index 000000000..cdc411336 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleIdentity.md @@ -0,0 +1,43 @@ +--- +id: v2024-role-identity +title: RoleIdentity +pagination_label: RoleIdentity +sidebar_label: RoleIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleIdentity', 'V2024RoleIdentity'] +slug: /tools/sdk/powershell/v2024/models/role-identity +tags: ['SDK', 'Software Development Kit', 'RoleIdentity', 'V2024RoleIdentity'] +--- + + +# RoleIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of the Identity | [optional] +**AliasName** | Pointer to **String** | The alias / username of the Identity | [optional] +**Name** | Pointer to **String** | The human-readable display name of the Identity | [optional] +**Email** | Pointer to **String** | Email address of the Identity | [optional] +**RoleAssignmentSource** | Pointer to [**RoleAssignmentSourceType**](role-assignment-source-type) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleIdentity = Initialize-PSSailpoint.V2024RoleIdentity -Id 2c9180a46faadee4016fb4e018c20639 ` + -AliasName t.edison ` + -Name Thomas Edison ` + -Email t.edison@identitynow.com ` + -RoleAssignmentSource null +``` + +- Convert the resource to JSON +```powershell +$RoleIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleInsight.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleInsight.md new file mode 100644 index 000000000..84be463be --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleInsight.md @@ -0,0 +1,45 @@ +--- +id: v2024-role-insight +title: RoleInsight +pagination_label: RoleInsight +sidebar_label: RoleInsight +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsight', 'V2024RoleInsight'] +slug: /tools/sdk/powershell/v2024/models/role-insight +tags: ['SDK', 'Software Development Kit', 'RoleInsight', 'V2024RoleInsight'] +--- + + +# RoleInsight + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Insight id | [optional] +**NumberOfUpdates** | Pointer to **Int32** | Total number of updates for this role | [optional] +**CreatedDate** | Pointer to **System.DateTime** | The date-time insights were last created for this role. | [optional] +**ModifiedDate** | Pointer to **System.DateTime** | The date-time insights were last modified for this role. | [optional] +**Role** | Pointer to [**RoleInsightsRole**](role-insights-role) | | [optional] +**Insight** | Pointer to [**RoleInsightsInsight**](role-insights-insight) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleInsight = Initialize-PSSailpoint.V2024RoleInsight -Id 1467e61e-f284-439c-ba2d-c6cc11cf0941 ` + -NumberOfUpdates 5 ` + -CreatedDate null ` + -ModifiedDate 2020-05-19T13:49:37.385Z ` + -Role null ` + -Insight null +``` + +- Convert the resource to JSON +```powershell +$RoleInsight | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleInsightsEntitlement.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleInsightsEntitlement.md new file mode 100644 index 000000000..83009423e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleInsightsEntitlement.md @@ -0,0 +1,45 @@ +--- +id: v2024-role-insights-entitlement +title: RoleInsightsEntitlement +pagination_label: RoleInsightsEntitlement +sidebar_label: RoleInsightsEntitlement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsightsEntitlement', 'V2024RoleInsightsEntitlement'] +slug: /tools/sdk/powershell/v2024/models/role-insights-entitlement +tags: ['SDK', 'Software Development Kit', 'RoleInsightsEntitlement', 'V2024RoleInsightsEntitlement'] +--- + + +# RoleInsightsEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Name of the entitlement | [optional] +**Id** | Pointer to **String** | Id of the entitlement | [optional] +**Description** | Pointer to **String** | Description for the entitlement | [optional] +**Source** | Pointer to **String** | Source or the application for the entitlement | [optional] +**Attribute** | Pointer to **String** | Attribute for the entitlement | [optional] +**Value** | Pointer to **String** | Attribute value for the entitlement | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleInsightsEntitlement = Initialize-PSSailpoint.V2024RoleInsightsEntitlement -Name null ` + -Id null ` + -Description null ` + -Source null ` + -Attribute null ` + -Value null +``` + +- Convert the resource to JSON +```powershell +$RoleInsightsEntitlement | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleInsightsEntitlementChanges.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleInsightsEntitlementChanges.md new file mode 100644 index 000000000..6062b0fb0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleInsightsEntitlementChanges.md @@ -0,0 +1,47 @@ +--- +id: v2024-role-insights-entitlement-changes +title: RoleInsightsEntitlementChanges +pagination_label: RoleInsightsEntitlementChanges +sidebar_label: RoleInsightsEntitlementChanges +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsightsEntitlementChanges', 'V2024RoleInsightsEntitlementChanges'] +slug: /tools/sdk/powershell/v2024/models/role-insights-entitlement-changes +tags: ['SDK', 'Software Development Kit', 'RoleInsightsEntitlementChanges', 'V2024RoleInsightsEntitlementChanges'] +--- + + +# RoleInsightsEntitlementChanges + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Name of the entitlement | [optional] +**Id** | Pointer to **String** | Id of the entitlement | [optional] +**Description** | Pointer to **String** | Description for the entitlement | [optional] +**Attribute** | Pointer to **String** | Attribute for the entitlement | [optional] +**Value** | Pointer to **String** | Attribute value for the entitlement | [optional] +**Source** | Pointer to **String** | Source or the application for the entitlement | [optional] +**Insight** | Pointer to [**RoleInsightsInsight**](role-insights-insight) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleInsightsEntitlementChanges = Initialize-PSSailpoint.V2024RoleInsightsEntitlementChanges -Name null ` + -Id null ` + -Description null ` + -Attribute null ` + -Value null ` + -Source null ` + -Insight null +``` + +- Convert the resource to JSON +```powershell +$RoleInsightsEntitlementChanges | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleInsightsIdentities.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleInsightsIdentities.md new file mode 100644 index 000000000..e1d19c2ad --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleInsightsIdentities.md @@ -0,0 +1,39 @@ +--- +id: v2024-role-insights-identities +title: RoleInsightsIdentities +pagination_label: RoleInsightsIdentities +sidebar_label: RoleInsightsIdentities +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsightsIdentities', 'V2024RoleInsightsIdentities'] +slug: /tools/sdk/powershell/v2024/models/role-insights-identities +tags: ['SDK', 'Software Development Kit', 'RoleInsightsIdentities', 'V2024RoleInsightsIdentities'] +--- + + +# RoleInsightsIdentities + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id for identity | [optional] +**Name** | Pointer to **String** | Name for identity | [optional] +**Attributes** | Pointer to **map[string]String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleInsightsIdentities = Initialize-PSSailpoint.V2024RoleInsightsIdentities -Id null ` + -Name null ` + -Attributes null +``` + +- Convert the resource to JSON +```powershell +$RoleInsightsIdentities | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleInsightsInsight.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleInsightsInsight.md new file mode 100644 index 000000000..5c314acf3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleInsightsInsight.md @@ -0,0 +1,43 @@ +--- +id: v2024-role-insights-insight +title: RoleInsightsInsight +pagination_label: RoleInsightsInsight +sidebar_label: RoleInsightsInsight +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsightsInsight', 'V2024RoleInsightsInsight'] +slug: /tools/sdk/powershell/v2024/models/role-insights-insight +tags: ['SDK', 'Software Development Kit', 'RoleInsightsInsight', 'V2024RoleInsightsInsight'] +--- + + +# RoleInsightsInsight + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **String** | The number of identities in this role with the entitlement. | [optional] +**IdentitiesWithAccess** | Pointer to **Int32** | The number of identities in this role with the entitlement. | [optional] +**IdentitiesImpacted** | Pointer to **Int32** | The number of identities in this role that do not have the specified entitlement. | [optional] +**TotalNumberOfIdentities** | Pointer to **Int32** | The total number of identities. | [optional] +**ImpactedIdentityNames** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleInsightsInsight = Initialize-PSSailpoint.V2024RoleInsightsInsight -Type ADD ` + -IdentitiesWithAccess 850 ` + -IdentitiesImpacted 150 ` + -TotalNumberOfIdentities 1000 ` + -ImpactedIdentityNames null +``` + +- Convert the resource to JSON +```powershell +$RoleInsightsInsight | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleInsightsResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleInsightsResponse.md new file mode 100644 index 000000000..b56ae7c01 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleInsightsResponse.md @@ -0,0 +1,45 @@ +--- +id: v2024-role-insights-response +title: RoleInsightsResponse +pagination_label: RoleInsightsResponse +sidebar_label: RoleInsightsResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsightsResponse', 'V2024RoleInsightsResponse'] +slug: /tools/sdk/powershell/v2024/models/role-insights-response +tags: ['SDK', 'Software Development Kit', 'RoleInsightsResponse', 'V2024RoleInsightsResponse'] +--- + + +# RoleInsightsResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Request Id for a role insight generation request | [optional] +**CreatedDate** | Pointer to **System.DateTime** | The date-time role insights request was created. | [optional] +**LastGenerated** | Pointer to **System.DateTime** | The date-time role insights request was completed. | [optional] +**NumberOfUpdates** | Pointer to **Int32** | Total number of updates for this request. Starts with 0 and will have correct number when request is COMPLETED. | [optional] +**RoleIds** | Pointer to **[]String** | The role IDs that are in this request. | [optional] +**Status** | Pointer to **Enum** [ "CREATED", "IN PROGRESS", "COMPLETED", "FAILED" ] | Request status | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleInsightsResponse = Initialize-PSSailpoint.V2024RoleInsightsResponse -Id 8c190e67-87aa-4ed9-a90b-d9d5344523fb ` + -CreatedDate 2020-09-16T18:49:32.150Z ` + -LastGenerated 2020-09-16T18:50:12.150Z ` + -NumberOfUpdates 0 ` + -RoleIds null ` + -Status null +``` + +- Convert the resource to JSON +```powershell +$RoleInsightsResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleInsightsRole.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleInsightsRole.md new file mode 100644 index 000000000..accfbd73a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleInsightsRole.md @@ -0,0 +1,43 @@ +--- +id: v2024-role-insights-role +title: RoleInsightsRole +pagination_label: RoleInsightsRole +sidebar_label: RoleInsightsRole +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsightsRole', 'V2024RoleInsightsRole'] +slug: /tools/sdk/powershell/v2024/models/role-insights-role +tags: ['SDK', 'Software Development Kit', 'RoleInsightsRole', 'V2024RoleInsightsRole'] +--- + + +# RoleInsightsRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Role name | [optional] +**Id** | Pointer to **String** | Role id | [optional] +**Description** | Pointer to **String** | Role description | [optional] +**OwnerName** | Pointer to **String** | Role owner name | [optional] +**OwnerId** | Pointer to **String** | Role owner id | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleInsightsRole = Initialize-PSSailpoint.V2024RoleInsightsRole -Name Software Engineer ` + -Id 1467e61e-f284-439c-ba2d-c6cc11cf0941 ` + -Description Person who develops software ` + -OwnerName Bob ` + -OwnerId 1467e61e-f284-439c-ba2d-c6cc11cf0941 +``` + +- Convert the resource to JSON +```powershell +$RoleInsightsRole | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleInsightsSummary.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleInsightsSummary.md new file mode 100644 index 000000000..6aa159324 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleInsightsSummary.md @@ -0,0 +1,45 @@ +--- +id: v2024-role-insights-summary +title: RoleInsightsSummary +pagination_label: RoleInsightsSummary +sidebar_label: RoleInsightsSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsightsSummary', 'V2024RoleInsightsSummary'] +slug: /tools/sdk/powershell/v2024/models/role-insights-summary +tags: ['SDK', 'Software Development Kit', 'RoleInsightsSummary', 'V2024RoleInsightsSummary'] +--- + + +# RoleInsightsSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NumberOfUpdates** | Pointer to **Int32** | Total number of roles with updates | [optional] +**LastGenerated** | Pointer to **System.DateTime** | The date-time role insights were last found. | [optional] +**EntitlementsIncludedInRoles** | Pointer to **Int32** | The number of entitlements included in roles (vs free radicals). | [optional] +**TotalNumberOfEntitlements** | Pointer to **Int32** | The total number of entitlements. | [optional] +**IdentitiesWithAccessViaRoles** | Pointer to **Int32** | The number of identities in roles vs. identities with just entitlements and not in roles. | [optional] +**TotalNumberOfIdentities** | Pointer to **Int32** | The total number of identities. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleInsightsSummary = Initialize-PSSailpoint.V2024RoleInsightsSummary -NumberOfUpdates null ` + -LastGenerated 2020-05-19T13:49:37.385Z ` + -EntitlementsIncludedInRoles 45 ` + -TotalNumberOfEntitlements 250 ` + -IdentitiesWithAccessViaRoles 550 ` + -TotalNumberOfIdentities 980 +``` + +- Convert the resource to JSON +```powershell +$RoleInsightsSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleListFilterDTO.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleListFilterDTO.md new file mode 100644 index 000000000..33ef4daef --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleListFilterDTO.md @@ -0,0 +1,37 @@ +--- +id: v2024-role-list-filter-dto +title: RoleListFilterDTO +pagination_label: RoleListFilterDTO +sidebar_label: RoleListFilterDTO +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleListFilterDTO', 'V2024RoleListFilterDTO'] +slug: /tools/sdk/powershell/v2024/models/role-list-filter-dto +tags: ['SDK', 'Software Development Kit', 'RoleListFilterDTO', 'V2024RoleListFilterDTO'] +--- + + +# RoleListFilterDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Filters** | Pointer to **String** | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* | [optional] +**AmmKeyValues** | Pointer to [**[]RoleListFilterDTOAmmKeyValuesInner**](role-list-filter-dto-amm-key-values-inner) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleListFilterDTO = Initialize-PSSailpoint.V2024RoleListFilterDTO -Filters dimensional eq false ` + -AmmKeyValues [{attribute=iscFederalClassifications, values=[secret]}] +``` + +- Convert the resource to JSON +```powershell +$RoleListFilterDTO | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleListFilterDTOAmmKeyValuesInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleListFilterDTOAmmKeyValuesInner.md new file mode 100644 index 000000000..c6de1614c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleListFilterDTOAmmKeyValuesInner.md @@ -0,0 +1,37 @@ +--- +id: v2024-role-list-filter-dto-amm-key-values-inner +title: RoleListFilterDTOAmmKeyValuesInner +pagination_label: RoleListFilterDTOAmmKeyValuesInner +sidebar_label: RoleListFilterDTOAmmKeyValuesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleListFilterDTOAmmKeyValuesInner', 'V2024RoleListFilterDTOAmmKeyValuesInner'] +slug: /tools/sdk/powershell/v2024/models/role-list-filter-dto-amm-key-values-inner +tags: ['SDK', 'Software Development Kit', 'RoleListFilterDTOAmmKeyValuesInner', 'V2024RoleListFilterDTOAmmKeyValuesInner'] +--- + + +# RoleListFilterDTOAmmKeyValuesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attribute** | Pointer to **String** | attribute key of a metadata. | [optional] +**Values** | Pointer to **[]String** | A list of attribute key names to filter roles. If the values is empty, will only filter by attribute key. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleListFilterDTOAmmKeyValuesInner = Initialize-PSSailpoint.V2024RoleListFilterDTOAmmKeyValuesInner -Attribute iscFederalClassifications ` + -Values [secret] +``` + +- Convert the resource to JSON +```powershell +$RoleListFilterDTOAmmKeyValuesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMatchDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMatchDto.md new file mode 100644 index 000000000..6cd08c003 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMatchDto.md @@ -0,0 +1,37 @@ +--- +id: v2024-role-match-dto +title: RoleMatchDto +pagination_label: RoleMatchDto +sidebar_label: RoleMatchDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMatchDto', 'V2024RoleMatchDto'] +slug: /tools/sdk/powershell/v2024/models/role-match-dto +tags: ['SDK', 'Software Development Kit', 'RoleMatchDto', 'V2024RoleMatchDto'] +--- + + +# RoleMatchDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RoleRef** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] +**MatchedAttributes** | Pointer to [**[]ContextAttributeDto**](context-attribute-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMatchDto = Initialize-PSSailpoint.V2024RoleMatchDto -RoleRef null ` + -MatchedAttributes null +``` + +- Convert the resource to JSON +```powershell +$RoleMatchDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMembershipIdentity.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMembershipIdentity.md new file mode 100644 index 000000000..608b3f703 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMembershipIdentity.md @@ -0,0 +1,41 @@ +--- +id: v2024-role-membership-identity +title: RoleMembershipIdentity +pagination_label: RoleMembershipIdentity +sidebar_label: RoleMembershipIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMembershipIdentity', 'V2024RoleMembershipIdentity'] +slug: /tools/sdk/powershell/v2024/models/role-membership-identity +tags: ['SDK', 'Software Development Kit', 'RoleMembershipIdentity', 'V2024RoleMembershipIdentity'] +--- + + +# RoleMembershipIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **String** | Identity id | [optional] +**Name** | Pointer to **String** | Human-readable display name of the Identity. | [optional] +**AliasName** | Pointer to **String** | User name of the Identity | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMembershipIdentity = Initialize-PSSailpoint.V2024RoleMembershipIdentity -Type null ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Thomas Edison ` + -AliasName t.edison +``` + +- Convert the resource to JSON +```powershell +$RoleMembershipIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMembershipSelector.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMembershipSelector.md new file mode 100644 index 000000000..c264959ae --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMembershipSelector.md @@ -0,0 +1,39 @@ +--- +id: v2024-role-membership-selector +title: RoleMembershipSelector +pagination_label: RoleMembershipSelector +sidebar_label: RoleMembershipSelector +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMembershipSelector', 'V2024RoleMembershipSelector'] +slug: /tools/sdk/powershell/v2024/models/role-membership-selector +tags: ['SDK', 'Software Development Kit', 'RoleMembershipSelector', 'V2024RoleMembershipSelector'] +--- + + +# RoleMembershipSelector + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**RoleMembershipSelectorType**](role-membership-selector-type) | | [optional] +**Criteria** | Pointer to [**RoleCriteriaLevel1**](role-criteria-level1) | | [optional] +**Identities** | Pointer to [**[]RoleMembershipIdentity**](role-membership-identity) | Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMembershipSelector = Initialize-PSSailpoint.V2024RoleMembershipSelector -Type null ` + -Criteria null ` + -Identities null +``` + +- Convert the resource to JSON +```powershell +$RoleMembershipSelector | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMembershipSelectorType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMembershipSelectorType.md new file mode 100644 index 000000000..2b3838945 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMembershipSelectorType.md @@ -0,0 +1,24 @@ +--- +id: v2024-role-membership-selector-type +title: RoleMembershipSelectorType +pagination_label: RoleMembershipSelectorType +sidebar_label: RoleMembershipSelectorType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMembershipSelectorType', 'V2024RoleMembershipSelectorType'] +slug: /tools/sdk/powershell/v2024/models/role-membership-selector-type +tags: ['SDK', 'Software Development Kit', 'RoleMembershipSelectorType', 'V2024RoleMembershipSelectorType'] +--- + + +# RoleMembershipSelectorType + +## Enum + + +* `STANDARD` (value: `"STANDARD"`) + +* `IDENTITY_LIST` (value: `"IDENTITY_LIST"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMetadataBulkUpdateByFilterRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMetadataBulkUpdateByFilterRequest.md new file mode 100644 index 000000000..1309abbdd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMetadataBulkUpdateByFilterRequest.md @@ -0,0 +1,41 @@ +--- +id: v2024-role-metadata-bulk-update-by-filter-request +title: RoleMetadataBulkUpdateByFilterRequest +pagination_label: RoleMetadataBulkUpdateByFilterRequest +sidebar_label: RoleMetadataBulkUpdateByFilterRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMetadataBulkUpdateByFilterRequest', 'V2024RoleMetadataBulkUpdateByFilterRequest'] +slug: /tools/sdk/powershell/v2024/models/role-metadata-bulk-update-by-filter-request +tags: ['SDK', 'Software Development Kit', 'RoleMetadataBulkUpdateByFilterRequest', 'V2024RoleMetadataBulkUpdateByFilterRequest'] +--- + + +# RoleMetadataBulkUpdateByFilterRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Filters** | **String** | Filtering is supported for the following fields and operators: **id** : *eq, in* **name** : *eq, sw* **created** : *gt, lt, ge, le* **modified** : *gt, lt, ge, le* **owner.id** : *eq, in* **requestable** : *eq* | [required] +**Operation** | **Enum** [ "ADD", "REMOVE", "REPLACE" ] | The operation to be performed | [required] +**ReplaceScope** | Pointer to **Enum** [ "ALL", "ATTRIBUTE" ] | The choice of update scope. | [optional] +**Values** | [**[]RoleMetadataBulkUpdateByFilterRequestValuesInner**](role-metadata-bulk-update-by-filter-request-values-inner) | The metadata to be updated, including attribute key and value. | [required] + +## Examples + +- Prepare the resource +```powershell +$RoleMetadataBulkUpdateByFilterRequest = Initialize-PSSailpoint.V2024RoleMetadataBulkUpdateByFilterRequest -Filters requestable eq false ` + -Operation REPLACE ` + -ReplaceScope ALL ` + -Values [{attribute=iscFederalClassifications, values=[topSecret]}] +``` + +- Convert the resource to JSON +```powershell +$RoleMetadataBulkUpdateByFilterRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMetadataBulkUpdateByFilterRequestValuesInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMetadataBulkUpdateByFilterRequestValuesInner.md new file mode 100644 index 000000000..d41e48dcb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMetadataBulkUpdateByFilterRequestValuesInner.md @@ -0,0 +1,37 @@ +--- +id: v2024-role-metadata-bulk-update-by-filter-request-values-inner +title: RoleMetadataBulkUpdateByFilterRequestValuesInner +pagination_label: RoleMetadataBulkUpdateByFilterRequestValuesInner +sidebar_label: RoleMetadataBulkUpdateByFilterRequestValuesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMetadataBulkUpdateByFilterRequestValuesInner', 'V2024RoleMetadataBulkUpdateByFilterRequestValuesInner'] +slug: /tools/sdk/powershell/v2024/models/role-metadata-bulk-update-by-filter-request-values-inner +tags: ['SDK', 'Software Development Kit', 'RoleMetadataBulkUpdateByFilterRequestValuesInner', 'V2024RoleMetadataBulkUpdateByFilterRequestValuesInner'] +--- + + +# RoleMetadataBulkUpdateByFilterRequestValuesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AttributeKey** | Pointer to **String** | the key of metadata attribute | [optional] +**Values** | **[]String** | the values of attribute to be updated | [required] + +## Examples + +- Prepare the resource +```powershell +$RoleMetadataBulkUpdateByFilterRequestValuesInner = Initialize-PSSailpoint.V2024RoleMetadataBulkUpdateByFilterRequestValuesInner -AttributeKey iscFederalClassifications ` + -Values [secret] +``` + +- Convert the resource to JSON +```powershell +$RoleMetadataBulkUpdateByFilterRequestValuesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMetadataBulkUpdateByIdRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMetadataBulkUpdateByIdRequest.md new file mode 100644 index 000000000..4bc2155ce --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMetadataBulkUpdateByIdRequest.md @@ -0,0 +1,41 @@ +--- +id: v2024-role-metadata-bulk-update-by-id-request +title: RoleMetadataBulkUpdateByIdRequest +pagination_label: RoleMetadataBulkUpdateByIdRequest +sidebar_label: RoleMetadataBulkUpdateByIdRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMetadataBulkUpdateByIdRequest', 'V2024RoleMetadataBulkUpdateByIdRequest'] +slug: /tools/sdk/powershell/v2024/models/role-metadata-bulk-update-by-id-request +tags: ['SDK', 'Software Development Kit', 'RoleMetadataBulkUpdateByIdRequest', 'V2024RoleMetadataBulkUpdateByIdRequest'] +--- + + +# RoleMetadataBulkUpdateByIdRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Roles** | **[]String** | Roles' Id to be updated | [required] +**Operation** | **Enum** [ "ADD", "REMOVE", "REPLACE" ] | The operation to be performed | [required] +**ReplaceScope** | Pointer to **Enum** [ "ALL", "ATTRIBUTE" ] | The choice of update scope. | [optional] +**Values** | [**[]RoleMetadataBulkUpdateByIdRequestValuesInner**](role-metadata-bulk-update-by-id-request-values-inner) | The metadata to be updated, including attribute key and value. | [required] + +## Examples + +- Prepare the resource +```powershell +$RoleMetadataBulkUpdateByIdRequest = Initialize-PSSailpoint.V2024RoleMetadataBulkUpdateByIdRequest -Roles [b1db89554cfa431cb8b9921ea38d9367] ` + -Operation REPLACE ` + -ReplaceScope ALL ` + -Values [{attribute=iscFederalClassifications, values=[topSecret]}] +``` + +- Convert the resource to JSON +```powershell +$RoleMetadataBulkUpdateByIdRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMetadataBulkUpdateByIdRequestValuesInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMetadataBulkUpdateByIdRequestValuesInner.md new file mode 100644 index 000000000..eabb360f0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMetadataBulkUpdateByIdRequestValuesInner.md @@ -0,0 +1,37 @@ +--- +id: v2024-role-metadata-bulk-update-by-id-request-values-inner +title: RoleMetadataBulkUpdateByIdRequestValuesInner +pagination_label: RoleMetadataBulkUpdateByIdRequestValuesInner +sidebar_label: RoleMetadataBulkUpdateByIdRequestValuesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMetadataBulkUpdateByIdRequestValuesInner', 'V2024RoleMetadataBulkUpdateByIdRequestValuesInner'] +slug: /tools/sdk/powershell/v2024/models/role-metadata-bulk-update-by-id-request-values-inner +tags: ['SDK', 'Software Development Kit', 'RoleMetadataBulkUpdateByIdRequestValuesInner', 'V2024RoleMetadataBulkUpdateByIdRequestValuesInner'] +--- + + +# RoleMetadataBulkUpdateByIdRequestValuesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attribute** | **String** | the key of metadata attribute | [required] +**Values** | **[]String** | the values of attribute to be updated | [required] + +## Examples + +- Prepare the resource +```powershell +$RoleMetadataBulkUpdateByIdRequestValuesInner = Initialize-PSSailpoint.V2024RoleMetadataBulkUpdateByIdRequestValuesInner -Attribute iscFederalClassifications ` + -Values [secret] +``` + +- Convert the resource to JSON +```powershell +$RoleMetadataBulkUpdateByIdRequestValuesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMetadataBulkUpdateByQueryRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMetadataBulkUpdateByQueryRequest.md new file mode 100644 index 000000000..3dff351c2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMetadataBulkUpdateByQueryRequest.md @@ -0,0 +1,41 @@ +--- +id: v2024-role-metadata-bulk-update-by-query-request +title: RoleMetadataBulkUpdateByQueryRequest +pagination_label: RoleMetadataBulkUpdateByQueryRequest +sidebar_label: RoleMetadataBulkUpdateByQueryRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMetadataBulkUpdateByQueryRequest', 'V2024RoleMetadataBulkUpdateByQueryRequest'] +slug: /tools/sdk/powershell/v2024/models/role-metadata-bulk-update-by-query-request +tags: ['SDK', 'Software Development Kit', 'RoleMetadataBulkUpdateByQueryRequest', 'V2024RoleMetadataBulkUpdateByQueryRequest'] +--- + + +# RoleMetadataBulkUpdateByQueryRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | query the identities to be updated | [required] +**Operation** | **Enum** [ "ADD", "REMOVE", "REPLACE" ] | The operation to be performed | [required] +**ReplaceScope** | Pointer to **Enum** [ "ALL", "ATTRIBUTE" ] | The choice of update scope. | [optional] +**Values** | [**[]RoleMetadataBulkUpdateByQueryRequestValuesInner**](role-metadata-bulk-update-by-query-request-values-inner) | The metadata to be updated, including attribute key and value. | [required] + +## Examples + +- Prepare the resource +```powershell +$RoleMetadataBulkUpdateByQueryRequest = Initialize-PSSailpoint.V2024RoleMetadataBulkUpdateByQueryRequest -Query {query"={indices=[roles], queryType=TEXT, textQuery={terms=[test123], fields=[id], matchAny=false, contains=true}, includeNested=false}} ` + -Operation REPLACE ` + -ReplaceScope ALL ` + -Values null +``` + +- Convert the resource to JSON +```powershell +$RoleMetadataBulkUpdateByQueryRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMetadataBulkUpdateByQueryRequestValuesInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMetadataBulkUpdateByQueryRequestValuesInner.md new file mode 100644 index 000000000..107737985 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMetadataBulkUpdateByQueryRequestValuesInner.md @@ -0,0 +1,37 @@ +--- +id: v2024-role-metadata-bulk-update-by-query-request-values-inner +title: RoleMetadataBulkUpdateByQueryRequestValuesInner +pagination_label: RoleMetadataBulkUpdateByQueryRequestValuesInner +sidebar_label: RoleMetadataBulkUpdateByQueryRequestValuesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMetadataBulkUpdateByQueryRequestValuesInner', 'V2024RoleMetadataBulkUpdateByQueryRequestValuesInner'] +slug: /tools/sdk/powershell/v2024/models/role-metadata-bulk-update-by-query-request-values-inner +tags: ['SDK', 'Software Development Kit', 'RoleMetadataBulkUpdateByQueryRequestValuesInner', 'V2024RoleMetadataBulkUpdateByQueryRequestValuesInner'] +--- + + +# RoleMetadataBulkUpdateByQueryRequestValuesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AttributeKey** | Pointer to **String** | the key of metadata attribute | [optional] +**AttributeValue** | Pointer to **[]String** | the values of attribute to be updated | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMetadataBulkUpdateByQueryRequestValuesInner = Initialize-PSSailpoint.V2024RoleMetadataBulkUpdateByQueryRequestValuesInner -AttributeKey iscFederalClassifications ` + -AttributeValue [topSecret] +``` + +- Convert the resource to JSON +```powershell +$RoleMetadataBulkUpdateByQueryRequestValuesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningEntitlement.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningEntitlement.md new file mode 100644 index 000000000..b3bab6874 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningEntitlement.md @@ -0,0 +1,51 @@ +--- +id: v2024-role-mining-entitlement +title: RoleMiningEntitlement +pagination_label: RoleMiningEntitlement +sidebar_label: RoleMiningEntitlement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningEntitlement', 'V2024RoleMiningEntitlement'] +slug: /tools/sdk/powershell/v2024/models/role-mining-entitlement +tags: ['SDK', 'Software Development Kit', 'RoleMiningEntitlement', 'V2024RoleMiningEntitlement'] +--- + + +# RoleMiningEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EntitlementRef** | Pointer to [**RoleMiningEntitlementRef**](role-mining-entitlement-ref) | | [optional] +**Name** | Pointer to **String** | Name of the entitlement | [optional] +**ApplicationName** | Pointer to **String** | Application name of the entitlement | [optional] +**IdentityCount** | Pointer to **Int32** | The number of identities with this entitlement in a role. | [optional] +**Popularity** | Pointer to **Double** | The % popularity of this entitlement in a role. | [optional] +**PopularityInOrg** | Pointer to **Double** | The % popularity of this entitlement in the org. | [optional] +**SourceId** | Pointer to **String** | The ID of the source/application. | [optional] +**ActivitySourceState** | Pointer to **String** | The status of activity data for the source. Value is complete or notComplete. | [optional] +**SourceUsagePercent** | Pointer to **Double** | The percentage of identities in the potential role that have usage of the source/application of this entitlement. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningEntitlement = Initialize-PSSailpoint.V2024RoleMiningEntitlement -EntitlementRef null ` + -Name Add/modify/delete users ` + -ApplicationName AppName ` + -IdentityCount 45 ` + -Popularity 65.2 ` + -PopularityInOrg 35.8 ` + -SourceId 2c9180877620c1460176267f336a106f ` + -ActivitySourceState complete ` + -SourceUsagePercent 65.6 +``` + +- Convert the resource to JSON +```powershell +$RoleMiningEntitlement | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningEntitlementRef.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningEntitlementRef.md new file mode 100644 index 000000000..56992651c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningEntitlementRef.md @@ -0,0 +1,41 @@ +--- +id: v2024-role-mining-entitlement-ref +title: RoleMiningEntitlementRef +pagination_label: RoleMiningEntitlementRef +sidebar_label: RoleMiningEntitlementRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningEntitlementRef', 'V2024RoleMiningEntitlementRef'] +slug: /tools/sdk/powershell/v2024/models/role-mining-entitlement-ref +tags: ['SDK', 'Software Development Kit', 'RoleMiningEntitlementRef', 'V2024RoleMiningEntitlementRef'] +--- + + +# RoleMiningEntitlementRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the entitlement | [optional] +**Name** | Pointer to **String** | Name of the entitlement | [optional] +**Description** | Pointer to **String** | Description forthe entitlement | [optional] +**Attribute** | Pointer to **String** | The entitlement attribute | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningEntitlementRef = Initialize-PSSailpoint.V2024RoleMiningEntitlementRef -Id 2c91808a7e95e6e0017e96e2086206c8 ` + -Name App.entitlement.1 ` + -Description Entitlement 1 ` + -Attribute groups +``` + +- Convert the resource to JSON +```powershell +$RoleMiningEntitlementRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningIdentity.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningIdentity.md new file mode 100644 index 000000000..3c594b9dd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningIdentity.md @@ -0,0 +1,39 @@ +--- +id: v2024-role-mining-identity +title: RoleMiningIdentity +pagination_label: RoleMiningIdentity +sidebar_label: RoleMiningIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningIdentity', 'V2024RoleMiningIdentity'] +slug: /tools/sdk/powershell/v2024/models/role-mining-identity +tags: ['SDK', 'Software Development Kit', 'RoleMiningIdentity', 'V2024RoleMiningIdentity'] +--- + + +# RoleMiningIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the identity | [optional] +**Name** | Pointer to **String** | Name of the identity | [optional] +**Attributes** | Pointer to **map[string]String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningIdentity = Initialize-PSSailpoint.V2024RoleMiningIdentity -Id null ` + -Name null ` + -Attributes null +``` + +- Convert the resource to JSON +```powershell +$RoleMiningIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningIdentityDistribution.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningIdentityDistribution.md new file mode 100644 index 000000000..4d71172db --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningIdentityDistribution.md @@ -0,0 +1,37 @@ +--- +id: v2024-role-mining-identity-distribution +title: RoleMiningIdentityDistribution +pagination_label: RoleMiningIdentityDistribution +sidebar_label: RoleMiningIdentityDistribution +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningIdentityDistribution', 'V2024RoleMiningIdentityDistribution'] +slug: /tools/sdk/powershell/v2024/models/role-mining-identity-distribution +tags: ['SDK', 'Software Development Kit', 'RoleMiningIdentityDistribution', 'V2024RoleMiningIdentityDistribution'] +--- + + +# RoleMiningIdentityDistribution + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AttributeName** | Pointer to **String** | Id of the potential role | [optional] +**Distribution** | Pointer to **[]System.Collections.Hashtable** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningIdentityDistribution = Initialize-PSSailpoint.V2024RoleMiningIdentityDistribution -AttributeName department ` + -Distribution [{attributeValue=NM Tier 3, count=6}] +``` + +- Convert the resource to JSON +```powershell +$RoleMiningIdentityDistribution | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRole.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRole.md new file mode 100644 index 000000000..6585f4e76 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRole.md @@ -0,0 +1,71 @@ +--- +id: v2024-role-mining-potential-role +title: RoleMiningPotentialRole +pagination_label: RoleMiningPotentialRole +sidebar_label: RoleMiningPotentialRole +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRole', 'V2024RoleMiningPotentialRole'] +slug: /tools/sdk/powershell/v2024/models/role-mining-potential-role +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRole', 'V2024RoleMiningPotentialRole'] +--- + + +# RoleMiningPotentialRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CreatedBy** | Pointer to [**RoleMiningSessionResponseCreatedBy**](role-mining-session-response-created-by) | | [optional] +**Density** | Pointer to **Int32** | The density of a potential role. | [optional] +**Description** | Pointer to **String** | The description of a potential role. | [optional] +**EntitlementCount** | Pointer to **Int32** | The number of entitlements in a potential role. | [optional] +**ExcludedEntitlements** | Pointer to **[]String** | The list of entitlement ids to be excluded. | [optional] +**Freshness** | Pointer to **Int32** | The freshness of a potential role. | [optional] +**IdentityCount** | Pointer to **Int32** | The number of identities in a potential role. | [optional] +**IdentityDistribution** | Pointer to [**[]RoleMiningIdentityDistribution**](role-mining-identity-distribution) | Identity attribute distribution. | [optional] +**IdentityIds** | Pointer to **[]String** | The list of ids in a potential role. | [optional] +**Name** | Pointer to **String** | Name of the potential role. | [optional] +**ProvisionState** | Pointer to [**RoleMiningPotentialRoleProvisionState**](role-mining-potential-role-provision-state) | | [optional] +**Quality** | Pointer to **Int32** | The quality of a potential role. | [optional] +**RoleId** | Pointer to **String** | The roleId of a potential role. | [optional] +**Saved** | Pointer to **Boolean** | The potential role's saved status. | [optional] +**Session** | Pointer to [**RoleMiningSessionParametersDto**](role-mining-session-parameters-dto) | | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**Id** | Pointer to **String** | Id of the potential role | [optional] +**CreatedDate** | Pointer to **System.DateTime** | The date-time when this potential role was created. | [optional] +**ModifiedDate** | Pointer to **System.DateTime** | The date-time when this potential role was modified. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningPotentialRole = Initialize-PSSailpoint.V2024RoleMiningPotentialRole -CreatedBy null ` + -Density 75 ` + -Description Potential Role for Accounting dept ` + -EntitlementCount 25 ` + -ExcludedEntitlements [07a0b4e2, 13b4e2a0] ` + -Freshness 75 ` + -IdentityCount 25 ` + -IdentityDistribution null ` + -IdentityIds [07a0b4e2, 13b4e2a0] ` + -Name Saved Potential Role - 07/10 ` + -ProvisionState null ` + -Quality 100 ` + -RoleId 07a0b4e2-7a76-44fa-bd0b-c64654b66519 ` + -Saved true ` + -Session null ` + -Type null ` + -Id e0cc5d7d-bf7f-4f81-b2af-8885b09d9923 ` + -CreatedDate null ` + -ModifiedDate null +``` + +- Convert the resource to JSON +```powershell +$RoleMiningPotentialRole | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleApplication.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleApplication.md new file mode 100644 index 000000000..156c7c7f5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleApplication.md @@ -0,0 +1,37 @@ +--- +id: v2024-role-mining-potential-role-application +title: RoleMiningPotentialRoleApplication +pagination_label: RoleMiningPotentialRoleApplication +sidebar_label: RoleMiningPotentialRoleApplication +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleApplication', 'V2024RoleMiningPotentialRoleApplication'] +slug: /tools/sdk/powershell/v2024/models/role-mining-potential-role-application +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleApplication', 'V2024RoleMiningPotentialRoleApplication'] +--- + + +# RoleMiningPotentialRoleApplication + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the application | [optional] +**Name** | Pointer to **String** | Name of the application | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningPotentialRoleApplication = Initialize-PSSailpoint.V2024RoleMiningPotentialRoleApplication -Id {id=2c9180877212632a017228d5a796292b} ` + -Name {name=Slack} +``` + +- Convert the resource to JSON +```powershell +$RoleMiningPotentialRoleApplication | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleEditEntitlements.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleEditEntitlements.md new file mode 100644 index 000000000..2ba4bc674 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleEditEntitlements.md @@ -0,0 +1,37 @@ +--- +id: v2024-role-mining-potential-role-edit-entitlements +title: RoleMiningPotentialRoleEditEntitlements +pagination_label: RoleMiningPotentialRoleEditEntitlements +sidebar_label: RoleMiningPotentialRoleEditEntitlements +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleEditEntitlements', 'V2024RoleMiningPotentialRoleEditEntitlements'] +slug: /tools/sdk/powershell/v2024/models/role-mining-potential-role-edit-entitlements +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleEditEntitlements', 'V2024RoleMiningPotentialRoleEditEntitlements'] +--- + + +# RoleMiningPotentialRoleEditEntitlements + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]String** | The list of entitlement ids to be edited | [optional] +**Exclude** | Pointer to **Boolean** | If true, add ids to be exclusion list. If false, remove ids from the exclusion list. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningPotentialRoleEditEntitlements = Initialize-PSSailpoint.V2024RoleMiningPotentialRoleEditEntitlements -Ids null ` + -Exclude null +``` + +- Convert the resource to JSON +```powershell +$RoleMiningPotentialRoleEditEntitlements | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleEntitlements.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleEntitlements.md new file mode 100644 index 000000000..ace8dae2e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleEntitlements.md @@ -0,0 +1,37 @@ +--- +id: v2024-role-mining-potential-role-entitlements +title: RoleMiningPotentialRoleEntitlements +pagination_label: RoleMiningPotentialRoleEntitlements +sidebar_label: RoleMiningPotentialRoleEntitlements +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleEntitlements', 'V2024RoleMiningPotentialRoleEntitlements'] +slug: /tools/sdk/powershell/v2024/models/role-mining-potential-role-entitlements +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleEntitlements', 'V2024RoleMiningPotentialRoleEntitlements'] +--- + + +# RoleMiningPotentialRoleEntitlements + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the entitlement | [optional] +**Name** | Pointer to **String** | Name of the entitlement | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningPotentialRoleEntitlements = Initialize-PSSailpoint.V2024RoleMiningPotentialRoleEntitlements -Id {id=2c9180877212632a017228d5a796292c} ` + -Name {name=LauncherTest2} +``` + +- Convert the resource to JSON +```powershell +$RoleMiningPotentialRoleEntitlements | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleExportRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleExportRequest.md new file mode 100644 index 000000000..9b3ce12f4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleExportRequest.md @@ -0,0 +1,37 @@ +--- +id: v2024-role-mining-potential-role-export-request +title: RoleMiningPotentialRoleExportRequest +pagination_label: RoleMiningPotentialRoleExportRequest +sidebar_label: RoleMiningPotentialRoleExportRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleExportRequest', 'V2024RoleMiningPotentialRoleExportRequest'] +slug: /tools/sdk/powershell/v2024/models/role-mining-potential-role-export-request +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleExportRequest', 'V2024RoleMiningPotentialRoleExportRequest'] +--- + + +# RoleMiningPotentialRoleExportRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MinEntitlementPopularity** | Pointer to **Int32** | The minimum popularity among identities in the role which an entitlement must have to be included in the report | [optional] +**IncludeCommonAccess** | Pointer to **Boolean** | If false, do not include entitlements that are highly popular among the entire orginization | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningPotentialRoleExportRequest = Initialize-PSSailpoint.V2024RoleMiningPotentialRoleExportRequest -MinEntitlementPopularity 0 ` + -IncludeCommonAccess true +``` + +- Convert the resource to JSON +```powershell +$RoleMiningPotentialRoleExportRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleExportResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleExportResponse.md new file mode 100644 index 000000000..c97b0d2cb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleExportResponse.md @@ -0,0 +1,41 @@ +--- +id: v2024-role-mining-potential-role-export-response +title: RoleMiningPotentialRoleExportResponse +pagination_label: RoleMiningPotentialRoleExportResponse +sidebar_label: RoleMiningPotentialRoleExportResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleExportResponse', 'V2024RoleMiningPotentialRoleExportResponse'] +slug: /tools/sdk/powershell/v2024/models/role-mining-potential-role-export-response +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleExportResponse', 'V2024RoleMiningPotentialRoleExportResponse'] +--- + + +# RoleMiningPotentialRoleExportResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MinEntitlementPopularity** | Pointer to **Int32** | The minimum popularity among identities in the role which an entitlement must have to be included in the report | [optional] +**IncludeCommonAccess** | Pointer to **Boolean** | If false, do not include entitlements that are highly popular among the entire orginization | [optional] +**ExportId** | Pointer to **String** | ID used to reference this export | [optional] +**Status** | Pointer to [**RoleMiningPotentialRoleExportState**](role-mining-potential-role-export-state) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningPotentialRoleExportResponse = Initialize-PSSailpoint.V2024RoleMiningPotentialRoleExportResponse -MinEntitlementPopularity 0 ` + -IncludeCommonAccess true ` + -ExportId 0c6cdb76-1227-4aaf-af21-192dbdfbfa04 ` + -Status null +``` + +- Convert the resource to JSON +```powershell +$RoleMiningPotentialRoleExportResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleExportState.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleExportState.md new file mode 100644 index 000000000..d2f7bb2f2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleExportState.md @@ -0,0 +1,28 @@ +--- +id: v2024-role-mining-potential-role-export-state +title: RoleMiningPotentialRoleExportState +pagination_label: RoleMiningPotentialRoleExportState +sidebar_label: RoleMiningPotentialRoleExportState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleExportState', 'V2024RoleMiningPotentialRoleExportState'] +slug: /tools/sdk/powershell/v2024/models/role-mining-potential-role-export-state +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleExportState', 'V2024RoleMiningPotentialRoleExportState'] +--- + + +# RoleMiningPotentialRoleExportState + +## Enum + + +* `QUEUED` (value: `"QUEUED"`) + +* `IN_PROGRESS` (value: `"IN_PROGRESS"`) + +* `SUCCESS` (value: `"SUCCESS"`) + +* `ERROR` (value: `"ERROR"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleProvisionRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleProvisionRequest.md new file mode 100644 index 000000000..54b986393 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleProvisionRequest.md @@ -0,0 +1,43 @@ +--- +id: v2024-role-mining-potential-role-provision-request +title: RoleMiningPotentialRoleProvisionRequest +pagination_label: RoleMiningPotentialRoleProvisionRequest +sidebar_label: RoleMiningPotentialRoleProvisionRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleProvisionRequest', 'V2024RoleMiningPotentialRoleProvisionRequest'] +slug: /tools/sdk/powershell/v2024/models/role-mining-potential-role-provision-request +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleProvisionRequest', 'V2024RoleMiningPotentialRoleProvisionRequest'] +--- + + +# RoleMiningPotentialRoleProvisionRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RoleName** | Pointer to **String** | Name of the new role being created | [optional] +**RoleDescription** | Pointer to **String** | Short description of the new role being created | [optional] +**OwnerId** | Pointer to **String** | ID of the identity that will own this role | [optional] +**IncludeIdentities** | Pointer to **Boolean** | When true, create access requests for the identities associated with the potential role | [optional] [default to $false] +**DirectlyAssignedEntitlements** | Pointer to **Boolean** | When true, assign entitlements directly to the role; otherwise, create access profiles containing the entitlements | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningPotentialRoleProvisionRequest = Initialize-PSSailpoint.V2024RoleMiningPotentialRoleProvisionRequest -RoleName Finance - Accounting ` + -RoleDescription General access for accounting department ` + -OwnerId 2b568c65bc3c4c57a43bd97e3a8e41 ` + -IncludeIdentities true ` + -DirectlyAssignedEntitlements false +``` + +- Convert the resource to JSON +```powershell +$RoleMiningPotentialRoleProvisionRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleProvisionState.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleProvisionState.md new file mode 100644 index 000000000..1f574228d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleProvisionState.md @@ -0,0 +1,28 @@ +--- +id: v2024-role-mining-potential-role-provision-state +title: RoleMiningPotentialRoleProvisionState +pagination_label: RoleMiningPotentialRoleProvisionState +sidebar_label: RoleMiningPotentialRoleProvisionState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleProvisionState', 'V2024RoleMiningPotentialRoleProvisionState'] +slug: /tools/sdk/powershell/v2024/models/role-mining-potential-role-provision-state +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleProvisionState', 'V2024RoleMiningPotentialRoleProvisionState'] +--- + + +# RoleMiningPotentialRoleProvisionState + +## Enum + + +* `POTENTIAL` (value: `"POTENTIAL"`) + +* `PENDING` (value: `"PENDING"`) + +* `COMPLETE` (value: `"COMPLETE"`) + +* `FAILED` (value: `"FAILED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleRef.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleRef.md new file mode 100644 index 000000000..8b111287e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleRef.md @@ -0,0 +1,37 @@ +--- +id: v2024-role-mining-potential-role-ref +title: RoleMiningPotentialRoleRef +pagination_label: RoleMiningPotentialRoleRef +sidebar_label: RoleMiningPotentialRoleRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleRef', 'V2024RoleMiningPotentialRoleRef'] +slug: /tools/sdk/powershell/v2024/models/role-mining-potential-role-ref +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleRef', 'V2024RoleMiningPotentialRoleRef'] +--- + + +# RoleMiningPotentialRoleRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the potential role | [optional] +**Name** | Pointer to **String** | Name of the potential role | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningPotentialRoleRef = Initialize-PSSailpoint.V2024RoleMiningPotentialRoleRef -Id e0cc5d7d-bf7f-4f81-b2af-8885b09d9923 ` + -Name Potential Role - e0cc5d +``` + +- Convert the resource to JSON +```powershell +$RoleMiningPotentialRoleRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleSourceUsage.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleSourceUsage.md new file mode 100644 index 000000000..7d7d2f6db --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleSourceUsage.md @@ -0,0 +1,41 @@ +--- +id: v2024-role-mining-potential-role-source-usage +title: RoleMiningPotentialRoleSourceUsage +pagination_label: RoleMiningPotentialRoleSourceUsage +sidebar_label: RoleMiningPotentialRoleSourceUsage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleSourceUsage', 'V2024RoleMiningPotentialRoleSourceUsage'] +slug: /tools/sdk/powershell/v2024/models/role-mining-potential-role-source-usage +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSourceUsage', 'V2024RoleMiningPotentialRoleSourceUsage'] +--- + + +# RoleMiningPotentialRoleSourceUsage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The identity ID | [optional] +**DisplayName** | Pointer to **String** | Display name for the identity | [optional] +**Email** | Pointer to **String** | Email address for the identity | [optional] +**UsageCount** | Pointer to **Int32** | The number of days there has been usage of the source by the identity. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningPotentialRoleSourceUsage = Initialize-PSSailpoint.V2024RoleMiningPotentialRoleSourceUsage -Id 2c918089762475180176267f894b54dc ` + -DisplayName Kirk Koepp ` + -Email kirk.koepp@testmail.identitynow.com ` + -UsageCount 25 +``` + +- Convert the resource to JSON +```powershell +$RoleMiningPotentialRoleSourceUsage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleSummary.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleSummary.md new file mode 100644 index 000000000..78a6654d1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleSummary.md @@ -0,0 +1,67 @@ +--- +id: v2024-role-mining-potential-role-summary +title: RoleMiningPotentialRoleSummary +pagination_label: RoleMiningPotentialRoleSummary +sidebar_label: RoleMiningPotentialRoleSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleSummary', 'V2024RoleMiningPotentialRoleSummary'] +slug: /tools/sdk/powershell/v2024/models/role-mining-potential-role-summary +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSummary', 'V2024RoleMiningPotentialRoleSummary'] +--- + + +# RoleMiningPotentialRoleSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the potential role | [optional] +**Name** | Pointer to **String** | Name of the potential role | [optional] +**PotentialRoleRef** | Pointer to [**RoleMiningPotentialRoleRef**](role-mining-potential-role-ref) | | [optional] +**IdentityCount** | Pointer to **Int32** | The number of identities in a potential role. | [optional] +**EntitlementCount** | Pointer to **Int32** | The number of entitlements in a potential role. | [optional] +**IdentityGroupStatus** | Pointer to **String** | The status for this identity group which can be ""REQUESTED"" or ""OBTAINED"" | [optional] +**ProvisionState** | Pointer to [**RoleMiningPotentialRoleProvisionState**](role-mining-potential-role-provision-state) | | [optional] +**RoleId** | Pointer to **String** | ID of the provisioned role in IIQ or IDN. Null if this potential role has not been provisioned. | [optional] +**Density** | Pointer to **Int32** | The density metric (0-100) of this potential role. Higher density values indicate higher similarity amongst the identities. | [optional] +**Freshness** | Pointer to **Int32** | The freshness metric (0-100) of this potential role. Higher freshness values indicate this potential role is more distinctive compared to existing roles. | [optional] +**Quality** | Pointer to **Int32** | The quality metric (0-100) of this potential role. Higher quality values indicate this potential role has high density and freshness. | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**CreatedBy** | Pointer to [**RoleMiningPotentialRoleSummaryCreatedBy**](role-mining-potential-role-summary-created-by) | | [optional] +**CreatedDate** | Pointer to **System.DateTime** | The date-time when this potential role was created. | [optional] +**Saved** | Pointer to **Boolean** | The potential role's saved status | [optional] [default to $false] +**Description** | Pointer to **String** | Description of the potential role | [optional] +**Session** | Pointer to [**RoleMiningSessionParametersDto**](role-mining-session-parameters-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningPotentialRoleSummary = Initialize-PSSailpoint.V2024RoleMiningPotentialRoleSummary -Id e0cc5d7d-bf7f-4f81-b2af-8885b09d9923 ` + -Name Potential Role - e0cc5d ` + -PotentialRoleRef null ` + -IdentityCount 25 ` + -EntitlementCount 15 ` + -IdentityGroupStatus OBTAINED ` + -ProvisionState null ` + -RoleId 2a4be6fbcf3c4e66b95a0c15ffd591 ` + -Density 90 ` + -Freshness 70 ` + -Quality 80 ` + -Type null ` + -CreatedBy null ` + -CreatedDate null ` + -Saved true ` + -Description null ` + -Session null +``` + +- Convert the resource to JSON +```powershell +$RoleMiningPotentialRoleSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleSummaryCreatedBy.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleSummaryCreatedBy.md new file mode 100644 index 000000000..5ae36c350 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningPotentialRoleSummaryCreatedBy.md @@ -0,0 +1,37 @@ +--- +id: v2024-role-mining-potential-role-summary-created-by +title: RoleMiningPotentialRoleSummaryCreatedBy +pagination_label: RoleMiningPotentialRoleSummaryCreatedBy +sidebar_label: RoleMiningPotentialRoleSummaryCreatedBy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleSummaryCreatedBy', 'V2024RoleMiningPotentialRoleSummaryCreatedBy'] +slug: /tools/sdk/powershell/v2024/models/role-mining-potential-role-summary-created-by +tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSummaryCreatedBy', 'V2024RoleMiningPotentialRoleSummaryCreatedBy'] +--- + + +# RoleMiningPotentialRoleSummaryCreatedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the creator | [optional] +**DisplayName** | Pointer to **String** | The display name of the creator | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningPotentialRoleSummaryCreatedBy = Initialize-PSSailpoint.V2024RoleMiningPotentialRoleSummaryCreatedBy -Id 2c918090761a5aac0176215c46a62d58 ` + -DisplayName Ashley.Pierce +``` + +- Convert the resource to JSON +```powershell +$RoleMiningPotentialRoleSummaryCreatedBy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningRoleType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningRoleType.md new file mode 100644 index 000000000..815c71624 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningRoleType.md @@ -0,0 +1,24 @@ +--- +id: v2024-role-mining-role-type +title: RoleMiningRoleType +pagination_label: RoleMiningRoleType +sidebar_label: RoleMiningRoleType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningRoleType', 'V2024RoleMiningRoleType'] +slug: /tools/sdk/powershell/v2024/models/role-mining-role-type +tags: ['SDK', 'Software Development Kit', 'RoleMiningRoleType', 'V2024RoleMiningRoleType'] +--- + + +# RoleMiningRoleType + +## Enum + + +* `SPECIALIZED` (value: `"SPECIALIZED"`) + +* `COMMON` (value: `"COMMON"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionDraftRoleDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionDraftRoleDto.md new file mode 100644 index 000000000..9278142c4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionDraftRoleDto.md @@ -0,0 +1,53 @@ +--- +id: v2024-role-mining-session-draft-role-dto +title: RoleMiningSessionDraftRoleDto +pagination_label: RoleMiningSessionDraftRoleDto +sidebar_label: RoleMiningSessionDraftRoleDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionDraftRoleDto', 'V2024RoleMiningSessionDraftRoleDto'] +slug: /tools/sdk/powershell/v2024/models/role-mining-session-draft-role-dto +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionDraftRoleDto', 'V2024RoleMiningSessionDraftRoleDto'] +--- + + +# RoleMiningSessionDraftRoleDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Name of the draft role | [optional] +**Description** | Pointer to **String** | Draft role description | [optional] +**IdentityIds** | Pointer to **[]String** | The list of identities for this role mining session. | [optional] +**EntitlementIds** | Pointer to **[]String** | The list of entitlement ids for this role mining session. | [optional] +**ExcludedEntitlements** | Pointer to **[]String** | The list of excluded entitlement ids. | [optional] +**Modified** | Pointer to **System.DateTime** | Last modified date | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**Id** | Pointer to **String** | Id of the potential draft role | [optional] +**CreatedDate** | Pointer to **System.DateTime** | The date-time when this potential draft role was created. | [optional] +**ModifiedDate** | Pointer to **System.DateTime** | The date-time when this potential draft role was modified. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningSessionDraftRoleDto = Initialize-PSSailpoint.V2024RoleMiningSessionDraftRoleDto -Name Saved RM Session - 07/10 ` + -Description Person who develops software ` + -IdentityIds [2c918090761a5aac0176215c46a62d58, 2c918090761a5aac01722015c46a62d42] ` + -EntitlementIds [2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e] ` + -ExcludedEntitlements [07a0b4e2, 13b4e2a0] ` + -Modified 2020-09-16T18:49:32.150Z ` + -Type null ` + -Id e0cc5d7d-bf7f-4f81-b2af-8885b09d9923 ` + -CreatedDate null ` + -ModifiedDate null +``` + +- Convert the resource to JSON +```powershell +$RoleMiningSessionDraftRoleDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionDto.md new file mode 100644 index 000000000..a42f0f721 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionDto.md @@ -0,0 +1,55 @@ +--- +id: v2024-role-mining-session-dto +title: RoleMiningSessionDto +pagination_label: RoleMiningSessionDto +sidebar_label: RoleMiningSessionDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionDto', 'V2024RoleMiningSessionDto'] +slug: /tools/sdk/powershell/v2024/models/role-mining-session-dto +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionDto', 'V2024RoleMiningSessionDto'] +--- + + +# RoleMiningSessionDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Scope** | Pointer to [**RoleMiningSessionScope**](role-mining-session-scope) | | [optional] +**PruneThreshold** | Pointer to **Int32** | The prune threshold to be used or null to calculate prescribedPruneThreshold | [optional] +**PrescribedPruneThreshold** | Pointer to **Int32** | The calculated prescribedPruneThreshold | [optional] +**MinNumIdentitiesInPotentialRole** | Pointer to **Int32** | Minimum number of identities in a potential role | [optional] +**PotentialRoleCount** | Pointer to **Int32** | Number of potential roles | [optional] +**PotentialRolesReadyCount** | Pointer to **Int32** | Number of potential roles ready | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**EmailRecipientId** | Pointer to **String** | The id of the user who will receive an email about the role mining session | [optional] +**IdentityCount** | Pointer to **Int32** | Number of identities in the population which meet the search criteria or identity list provided | [optional] +**Saved** | Pointer to **Boolean** | The session's saved status | [optional] [default to $false] +**Name** | Pointer to **String** | The session's saved name | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningSessionDto = Initialize-PSSailpoint.V2024RoleMiningSessionDto -Scope null ` + -PruneThreshold 50 ` + -PrescribedPruneThreshold 10 ` + -MinNumIdentitiesInPotentialRole 20 ` + -PotentialRoleCount 0 ` + -PotentialRolesReadyCount 0 ` + -Type null ` + -EmailRecipientId 2c918090761a5aac0176215c46a62d58 ` + -IdentityCount 0 ` + -Saved true ` + -Name Saved RM Session - 07/10 +``` + +- Convert the resource to JSON +```powershell +$RoleMiningSessionDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionParametersDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionParametersDto.md new file mode 100644 index 000000000..dd116342b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionParametersDto.md @@ -0,0 +1,51 @@ +--- +id: v2024-role-mining-session-parameters-dto +title: RoleMiningSessionParametersDto +pagination_label: RoleMiningSessionParametersDto +sidebar_label: RoleMiningSessionParametersDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionParametersDto', 'V2024RoleMiningSessionParametersDto'] +slug: /tools/sdk/powershell/v2024/models/role-mining-session-parameters-dto +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionParametersDto', 'V2024RoleMiningSessionParametersDto'] +--- + + +# RoleMiningSessionParametersDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of the role mining session | [optional] +**Name** | Pointer to **String** | The session's saved name | [optional] +**MinNumIdentitiesInPotentialRole** | Pointer to **Int32** | Minimum number of identities in a potential role | [optional] +**PruneThreshold** | Pointer to **Int32** | The prune threshold to be used or null to calculate prescribedPruneThreshold | [optional] +**Saved** | Pointer to **Boolean** | The session's saved status | [optional] [default to $true] +**Scope** | Pointer to [**RoleMiningSessionScope**](role-mining-session-scope) | | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] +**State** | Pointer to [**RoleMiningSessionState**](role-mining-session-state) | | [optional] +**ScopingMethod** | Pointer to [**RoleMiningSessionScopingMethod**](role-mining-session-scoping-method) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningSessionParametersDto = Initialize-PSSailpoint.V2024RoleMiningSessionParametersDto -Id 9f36f5e5-1e81-4eca-b087-548959d91c71 ` + -Name Saved RM Session - 07/10 ` + -MinNumIdentitiesInPotentialRole 20 ` + -PruneThreshold 5 ` + -Saved true ` + -Scope null ` + -Type null ` + -State null ` + -ScopingMethod null +``` + +- Convert the resource to JSON +```powershell +$RoleMiningSessionParametersDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionResponse.md new file mode 100644 index 000000000..b998818b0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionResponse.md @@ -0,0 +1,69 @@ +--- +id: v2024-role-mining-session-response +title: RoleMiningSessionResponse +pagination_label: RoleMiningSessionResponse +sidebar_label: RoleMiningSessionResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionResponse', 'V2024RoleMiningSessionResponse'] +slug: /tools/sdk/powershell/v2024/models/role-mining-session-response +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionResponse', 'V2024RoleMiningSessionResponse'] +--- + + +# RoleMiningSessionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Scope** | Pointer to [**RoleMiningSessionScope**](role-mining-session-scope) | | [optional] +**MinNumIdentitiesInPotentialRole** | Pointer to **Int32** | Minimum number of identities in a potential role | [optional] +**ScopingMethod** | Pointer to **String** | The scoping method of the role mining session | [optional] +**PrescribedPruneThreshold** | Pointer to **Int32** | The computed (or prescribed) prune threshold for this session | [optional] +**PruneThreshold** | Pointer to **Int32** | The prune threshold to be used for this role mining session | [optional] +**PotentialRoleCount** | Pointer to **Int32** | The number of potential roles | [optional] +**PotentialRolesReadyCount** | Pointer to **Int32** | The number of potential roles which have completed processing | [optional] +**Status** | Pointer to [**RoleMiningSessionStatus**](role-mining-session-status) | | [optional] +**EmailRecipientId** | Pointer to **String** | The id of the user who will receive an email about the role mining session | [optional] +**CreatedBy** | Pointer to [**RoleMiningSessionResponseCreatedBy**](role-mining-session-response-created-by) | | [optional] +**IdentityCount** | Pointer to **Int32** | The number of identities | [optional] +**Saved** | Pointer to **Boolean** | The session's saved status | [optional] [default to $false] +**Name** | Pointer to **String** | The session's saved name | [optional] +**DataFilePath** | Pointer to **String** | The data file path of the role mining session | [optional] +**Id** | Pointer to **String** | Session Id for this role mining session | [optional] +**CreatedDate** | Pointer to **System.DateTime** | The date-time when this role mining session was created. | [optional] +**ModifiedDate** | Pointer to **System.DateTime** | The date-time when this role mining session was completed. | [optional] +**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningSessionResponse = Initialize-PSSailpoint.V2024RoleMiningSessionResponse -Scope null ` + -MinNumIdentitiesInPotentialRole 20 ` + -ScopingMethod AUTO_RM ` + -PrescribedPruneThreshold 83 ` + -PruneThreshold 70 ` + -PotentialRoleCount 8 ` + -PotentialRolesReadyCount 4 ` + -Status null ` + -EmailRecipientId null ` + -CreatedBy null ` + -IdentityCount 39 ` + -Saved true ` + -Name Saved RM Session - 07/10 ` + -DataFilePath null ` + -Id 8c190e67-87aa-4ed9-a90b-d9d5344523fb ` + -CreatedDate null ` + -ModifiedDate null ` + -Type null +``` + +- Convert the resource to JSON +```powershell +$RoleMiningSessionResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionResponseCreatedBy.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionResponseCreatedBy.md new file mode 100644 index 000000000..e36c1b5c9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionResponseCreatedBy.md @@ -0,0 +1,37 @@ +--- +id: v2024-role-mining-session-response-created-by +title: RoleMiningSessionResponseCreatedBy +pagination_label: RoleMiningSessionResponseCreatedBy +sidebar_label: RoleMiningSessionResponseCreatedBy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionResponseCreatedBy', 'V2024RoleMiningSessionResponseCreatedBy'] +slug: /tools/sdk/powershell/v2024/models/role-mining-session-response-created-by +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionResponseCreatedBy', 'V2024RoleMiningSessionResponseCreatedBy'] +--- + + +# RoleMiningSessionResponseCreatedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the creator | [optional] +**DisplayName** | Pointer to **String** | The display name of the creator | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningSessionResponseCreatedBy = Initialize-PSSailpoint.V2024RoleMiningSessionResponseCreatedBy -Id 2c918090761a5aac0176215c46a62d58 ` + -DisplayName Ashley.Pierce +``` + +- Convert the resource to JSON +```powershell +$RoleMiningSessionResponseCreatedBy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionScope.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionScope.md new file mode 100644 index 000000000..7f02faa06 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionScope.md @@ -0,0 +1,39 @@ +--- +id: v2024-role-mining-session-scope +title: RoleMiningSessionScope +pagination_label: RoleMiningSessionScope +sidebar_label: RoleMiningSessionScope +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionScope', 'V2024RoleMiningSessionScope'] +slug: /tools/sdk/powershell/v2024/models/role-mining-session-scope +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionScope', 'V2024RoleMiningSessionScope'] +--- + + +# RoleMiningSessionScope + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityIds** | Pointer to **[]String** | The list of identities for this role mining session. | [optional] +**Criteria** | Pointer to **String** | The ""search"" criteria that produces the list of identities for this role mining session. | [optional] +**AttributeFilterCriteria** | Pointer to [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The filter criteria for this role mining session. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningSessionScope = Initialize-PSSailpoint.V2024RoleMiningSessionScope -IdentityIds [2c918090761a5aac0176215c46a62d58, 2c918090761a5aac01722015c46a62d42] ` + -Criteria source.name:DataScienceDataset ` + -AttributeFilterCriteria {displayName={untranslated=Location: Miami}, ariaLabel={untranslated=Location: Miami}, data={displayName={translateKey=IDN.IDENTITY_ATTRIBUTES.LOCATION}, name=location, operator=EQUALS, values=[Miami]}} +``` + +- Convert the resource to JSON +```powershell +$RoleMiningSessionScope | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionScopingMethod.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionScopingMethod.md new file mode 100644 index 000000000..cc9a89f2c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionScopingMethod.md @@ -0,0 +1,24 @@ +--- +id: v2024-role-mining-session-scoping-method +title: RoleMiningSessionScopingMethod +pagination_label: RoleMiningSessionScopingMethod +sidebar_label: RoleMiningSessionScopingMethod +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionScopingMethod', 'V2024RoleMiningSessionScopingMethod'] +slug: /tools/sdk/powershell/v2024/models/role-mining-session-scoping-method +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionScopingMethod', 'V2024RoleMiningSessionScopingMethod'] +--- + + +# RoleMiningSessionScopingMethod + +## Enum + + +* `MANUAL` (value: `"MANUAL"`) + +* `AUTO_RM` (value: `"AUTO_RM"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionState.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionState.md new file mode 100644 index 000000000..b9e895e3b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionState.md @@ -0,0 +1,32 @@ +--- +id: v2024-role-mining-session-state +title: RoleMiningSessionState +pagination_label: RoleMiningSessionState +sidebar_label: RoleMiningSessionState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionState', 'V2024RoleMiningSessionState'] +slug: /tools/sdk/powershell/v2024/models/role-mining-session-state +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionState', 'V2024RoleMiningSessionState'] +--- + + +# RoleMiningSessionState + +## Enum + + +* `CREATED` (value: `"CREATED"`) + +* `UPDATED` (value: `"UPDATED"`) + +* `IDENTITIES_OBTAINED` (value: `"IDENTITIES_OBTAINED"`) + +* `PRUNE_THRESHOLD_OBTAINED` (value: `"PRUNE_THRESHOLD_OBTAINED"`) + +* `POTENTIAL_ROLES_PROCESSING` (value: `"POTENTIAL_ROLES_PROCESSING"`) + +* `POTENTIAL_ROLES_CREATED` (value: `"POTENTIAL_ROLES_CREATED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionStatus.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionStatus.md new file mode 100644 index 000000000..9db992e38 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleMiningSessionStatus.md @@ -0,0 +1,35 @@ +--- +id: v2024-role-mining-session-status +title: RoleMiningSessionStatus +pagination_label: RoleMiningSessionStatus +sidebar_label: RoleMiningSessionStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionStatus', 'V2024RoleMiningSessionStatus'] +slug: /tools/sdk/powershell/v2024/models/role-mining-session-status +tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionStatus', 'V2024RoleMiningSessionStatus'] +--- + + +# RoleMiningSessionStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to [**RoleMiningSessionState**](role-mining-session-state) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMiningSessionStatus = Initialize-PSSailpoint.V2024RoleMiningSessionStatus -State null +``` + +- Convert the resource to JSON +```powershell +$RoleMiningSessionStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleSummary.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleSummary.md new file mode 100644 index 000000000..c771ca4e5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleSummary.md @@ -0,0 +1,49 @@ +--- +id: v2024-role-summary +title: RoleSummary +pagination_label: RoleSummary +sidebar_label: RoleSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleSummary', 'V2024RoleSummary'] +slug: /tools/sdk/powershell/v2024/models/role-summary +tags: ['SDK', 'Software Development Kit', 'RoleSummary', 'V2024RoleSummary'] +--- + + +# RoleSummary + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$RoleSummary = Initialize-PSSailpoint.V2024RoleSummary -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -DisplayName John Q. Doe ` + -Type null ` + -Description null ` + -Owner null ` + -Disabled null ` + -Revocable null +``` + +- Convert the resource to JSON +```powershell +$RoleSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleTargetDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleTargetDto.md new file mode 100644 index 000000000..c825e3992 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/RoleTargetDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-role-target-dto +title: RoleTargetDto +pagination_label: RoleTargetDto +sidebar_label: RoleTargetDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleTargetDto', 'V2024RoleTargetDto'] +slug: /tools/sdk/powershell/v2024/models/role-target-dto +tags: ['SDK', 'Software Development Kit', 'RoleTargetDto', 'V2024RoleTargetDto'] +--- + + +# RoleTargetDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] +**AccountInfo** | Pointer to [**AccountInfoDto**](account-info-dto) | | [optional] +**RoleName** | Pointer to **String** | Specific role name for this target if using multiple accounts | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleTargetDto = Initialize-PSSailpoint.V2024RoleTargetDto -Source null ` + -AccountInfo null ` + -RoleName Marketing +``` + +- Convert the resource to JSON +```powershell +$RoleTargetDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Rule.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Rule.md new file mode 100644 index 000000000..10b1906f5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Rule.md @@ -0,0 +1,47 @@ +--- +id: v2024-rule +title: Rule +pagination_label: Rule +sidebar_label: Rule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Rule', 'V2024Rule'] +slug: /tools/sdk/powershell/v2024/models/rule +tags: ['SDK', 'Software Development Kit', 'Rule', 'V2024Rule'] +--- + + +# Rule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | This must always be set to ""Cloud Services Deployment Utility"" | [required] +**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] +**Operation** | **String** | The operation to perform `getReferenceIdentityAttribute` | [required] +**IncludeNumbers** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include numbers | [required] +**IncludeSpecialChars** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include special characters | [required] +**Length** | **String** | This specifies how long the randomly generated string needs to be >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters | [required] +**Uid** | **String** | This is the SailPoint User Name (uid) value of the identity whose attribute is desired As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. | [required] + +## Examples + +- Prepare the resource +```powershell +$Rule = Initialize-PSSailpoint.V2024Rule -Name Cloud Services Deployment Utility ` + -RequiresPeriodicRefresh false ` + -Operation getReferenceIdentityAttribute ` + -IncludeNumbers true ` + -IncludeSpecialChars true ` + -Length 10 ` + -Uid 2c91808570313110017040b06f344ec9 +``` + +- Convert the resource to JSON +```powershell +$Rule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearch.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearch.md new file mode 100644 index 000000000..2d224ad78 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearch.md @@ -0,0 +1,63 @@ +--- +id: v2024-saved-search +title: SavedSearch +pagination_label: SavedSearch +sidebar_label: SavedSearch +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearch', 'V2024SavedSearch'] +slug: /tools/sdk/powershell/v2024/models/saved-search +tags: ['SDK', 'Software Development Kit', 'SavedSearch', 'V2024SavedSearch'] +--- + + +# SavedSearch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the saved search. | [optional] +**Description** | Pointer to **String** | The description of the saved search. | [optional] +**Created** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] +**Modified** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] +**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required] +**Columns** | Pointer to [**map[string]Column[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] +**Query** | **String** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required] +**Fields** | Pointer to **[]String** | The fields to be searched against in a multi-field query. | [optional] +**OrderBy** | Pointer to **map[string]String[]** | Sort by index. This takes precedence over the `sort` property. | [optional] +**Sort** | Pointer to **[]String** | The fields to be used to sort the search results. | [optional] +**Filters** | Pointer to [**SavedSearchDetailFilters**](saved-search-detail-filters) | | [optional] +**Id** | Pointer to **String** | The saved search ID. | [optional] +**Owner** | Pointer to [**TypedReference**](typed-reference) | | [optional] +**OwnerId** | Pointer to **String** | The ID of the identity that owns this saved search. | [optional] +**Public** | Pointer to **Boolean** | Whether this saved search is visible to anyone but the owner. This field will always be false as there is no way to set a saved search as public at this time. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$SavedSearch = Initialize-PSSailpoint.V2024SavedSearch -Name Disabled accounts ` + -Description Disabled accounts ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Indices [identities] ` + -Columns {identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]} ` + -Query @accounts(disabled:true) ` + -Fields [disabled] ` + -OrderBy {identity=[lastName, firstName], role=[name]} ` + -Sort [displayName] ` + -Filters null ` + -Id 0de46054-fe90-434a-b84e-c6b3359d0c64 ` + -Owner null ` + -OwnerId 2c91808568c529c60168cca6f90c1313 ` + -Public false +``` + +- Convert the resource to JSON +```powershell +$SavedSearch | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearchComplete.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearchComplete.md new file mode 100644 index 000000000..537000cae --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearchComplete.md @@ -0,0 +1,47 @@ +--- +id: v2024-saved-search-complete +title: SavedSearchComplete +pagination_label: SavedSearchComplete +sidebar_label: SavedSearchComplete +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearchComplete', 'V2024SavedSearchComplete'] +slug: /tools/sdk/powershell/v2024/models/saved-search-complete +tags: ['SDK', 'Software Development Kit', 'SavedSearchComplete', 'V2024SavedSearchComplete'] +--- + + +# SavedSearchComplete + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FileName** | **String** | A name for the report file. | [required] +**OwnerEmail** | **String** | The email address of the identity that owns the saved search. | [required] +**OwnerName** | **String** | The name of the identity that owns the saved search. | [required] +**Query** | **String** | The search query that was used to generate the report. | [required] +**SearchName** | **String** | The name of the saved search. | [required] +**SearchResults** | [**SavedSearchCompleteSearchResults**](saved-search-complete-search-results) | | [required] +**SignedS3Url** | **String** | The Amazon S3 URL to download the report from. | [required] + +## Examples + +- Prepare the resource +```powershell +$SavedSearchComplete = Initialize-PSSailpoint.V2024SavedSearchComplete -FileName Modified.zip ` + -OwnerEmail test@sailpoint.com ` + -OwnerName Cloud Support ` + -Query modified:[now-7y/d TO now] ` + -SearchName Modified Activity ` + -SearchResults null ` + -SignedS3Url https://sptcbu-org-data-useast1.s3.amazonaws.com/arsenal-john/reports/Events%20Export.2020-05-06%2018%2759%20GMT.3e580592-86e4-4953-8aea-49e6ef20a086.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200506T185919Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=AKIAV5E54XOGTS4Q4L7A%2F20200506%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2e732bb97a12a1fd8a215613e3c31fcdae8ba1fb6a25916843ab5b51d2ddefbc +``` + +- Convert the resource to JSON +```powershell +$SavedSearchComplete | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearchCompleteSearchResults.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearchCompleteSearchResults.md new file mode 100644 index 000000000..adb8f899b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearchCompleteSearchResults.md @@ -0,0 +1,39 @@ +--- +id: v2024-saved-search-complete-search-results +title: SavedSearchCompleteSearchResults +pagination_label: SavedSearchCompleteSearchResults +sidebar_label: SavedSearchCompleteSearchResults +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearchCompleteSearchResults', 'V2024SavedSearchCompleteSearchResults'] +slug: /tools/sdk/powershell/v2024/models/saved-search-complete-search-results +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResults', 'V2024SavedSearchCompleteSearchResults'] +--- + + +# SavedSearchCompleteSearchResults + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Account** | Pointer to [**SavedSearchCompleteSearchResultsAccount**](saved-search-complete-search-results-account) | | [optional] +**Entitlement** | Pointer to [**SavedSearchCompleteSearchResultsEntitlement**](saved-search-complete-search-results-entitlement) | | [optional] +**Identity** | Pointer to [**SavedSearchCompleteSearchResultsIdentity**](saved-search-complete-search-results-identity) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SavedSearchCompleteSearchResults = Initialize-PSSailpoint.V2024SavedSearchCompleteSearchResults -Account null ` + -Entitlement null ` + -Identity null +``` + +- Convert the resource to JSON +```powershell +$SavedSearchCompleteSearchResults | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearchCompleteSearchResultsAccount.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearchCompleteSearchResultsAccount.md new file mode 100644 index 000000000..f32a84cd5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearchCompleteSearchResultsAccount.md @@ -0,0 +1,39 @@ +--- +id: v2024-saved-search-complete-search-results-account +title: SavedSearchCompleteSearchResultsAccount +pagination_label: SavedSearchCompleteSearchResultsAccount +sidebar_label: SavedSearchCompleteSearchResultsAccount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearchCompleteSearchResultsAccount', 'V2024SavedSearchCompleteSearchResultsAccount'] +slug: /tools/sdk/powershell/v2024/models/saved-search-complete-search-results-account +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsAccount', 'V2024SavedSearchCompleteSearchResultsAccount'] +--- + + +# SavedSearchCompleteSearchResultsAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | **String** | The number of rows in the table. | [required] +**Noun** | **String** | The type of object represented in the table. | [required] +**Preview** | **[]String[]** | A sample of the data in the table. | [required] + +## Examples + +- Prepare the resource +```powershell +$SavedSearchCompleteSearchResultsAccount = Initialize-PSSailpoint.V2024SavedSearchCompleteSearchResultsAccount -Count 3 ` + -Noun accounts ` + -Preview null +``` + +- Convert the resource to JSON +```powershell +$SavedSearchCompleteSearchResultsAccount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearchCompleteSearchResultsEntitlement.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearchCompleteSearchResultsEntitlement.md new file mode 100644 index 000000000..b5bf78974 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearchCompleteSearchResultsEntitlement.md @@ -0,0 +1,39 @@ +--- +id: v2024-saved-search-complete-search-results-entitlement +title: SavedSearchCompleteSearchResultsEntitlement +pagination_label: SavedSearchCompleteSearchResultsEntitlement +sidebar_label: SavedSearchCompleteSearchResultsEntitlement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearchCompleteSearchResultsEntitlement', 'V2024SavedSearchCompleteSearchResultsEntitlement'] +slug: /tools/sdk/powershell/v2024/models/saved-search-complete-search-results-entitlement +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsEntitlement', 'V2024SavedSearchCompleteSearchResultsEntitlement'] +--- + + +# SavedSearchCompleteSearchResultsEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | **String** | The number of rows in the table. | [required] +**Noun** | **String** | The type of object represented in the table. | [required] +**Preview** | **[]String[]** | A sample of the data in the table. | [required] + +## Examples + +- Prepare the resource +```powershell +$SavedSearchCompleteSearchResultsEntitlement = Initialize-PSSailpoint.V2024SavedSearchCompleteSearchResultsEntitlement -Count 2 ` + -Noun entitlements ` + -Preview null +``` + +- Convert the resource to JSON +```powershell +$SavedSearchCompleteSearchResultsEntitlement | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearchCompleteSearchResultsIdentity.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearchCompleteSearchResultsIdentity.md new file mode 100644 index 000000000..f024d8223 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearchCompleteSearchResultsIdentity.md @@ -0,0 +1,39 @@ +--- +id: v2024-saved-search-complete-search-results-identity +title: SavedSearchCompleteSearchResultsIdentity +pagination_label: SavedSearchCompleteSearchResultsIdentity +sidebar_label: SavedSearchCompleteSearchResultsIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearchCompleteSearchResultsIdentity', 'V2024SavedSearchCompleteSearchResultsIdentity'] +slug: /tools/sdk/powershell/v2024/models/saved-search-complete-search-results-identity +tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsIdentity', 'V2024SavedSearchCompleteSearchResultsIdentity'] +--- + + +# SavedSearchCompleteSearchResultsIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | **String** | The number of rows in the table. | [required] +**Noun** | **String** | The type of object represented in the table. | [required] +**Preview** | **[]String[]** | A sample of the data in the table. | [required] + +## Examples + +- Prepare the resource +```powershell +$SavedSearchCompleteSearchResultsIdentity = Initialize-PSSailpoint.V2024SavedSearchCompleteSearchResultsIdentity -Count 2 ` + -Noun identities ` + -Preview null +``` + +- Convert the resource to JSON +```powershell +$SavedSearchCompleteSearchResultsIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearchDetail.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearchDetail.md new file mode 100644 index 000000000..d053f51d3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearchDetail.md @@ -0,0 +1,51 @@ +--- +id: v2024-saved-search-detail +title: SavedSearchDetail +pagination_label: SavedSearchDetail +sidebar_label: SavedSearchDetail +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearchDetail', 'V2024SavedSearchDetail'] +slug: /tools/sdk/powershell/v2024/models/saved-search-detail +tags: ['SDK', 'Software Development Kit', 'SavedSearchDetail', 'V2024SavedSearchDetail'] +--- + + +# SavedSearchDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] +**Modified** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] +**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required] +**Columns** | Pointer to [**map[string]Column[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] +**Query** | **String** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required] +**Fields** | Pointer to **[]String** | The fields to be searched against in a multi-field query. | [optional] +**OrderBy** | Pointer to **map[string]String[]** | Sort by index. This takes precedence over the `sort` property. | [optional] +**Sort** | Pointer to **[]String** | The fields to be used to sort the search results. | [optional] +**Filters** | Pointer to [**SavedSearchDetailFilters**](saved-search-detail-filters) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SavedSearchDetail = Initialize-PSSailpoint.V2024SavedSearchDetail -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Indices [identities] ` + -Columns {identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]} ` + -Query @accounts(disabled:true) ` + -Fields [disabled] ` + -OrderBy {identity=[lastName, firstName], role=[name]} ` + -Sort [displayName] ` + -Filters null +``` + +- Convert the resource to JSON +```powershell +$SavedSearchDetail | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearchDetailFilters.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearchDetailFilters.md new file mode 100644 index 000000000..5ac22c365 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearchDetailFilters.md @@ -0,0 +1,41 @@ +--- +id: v2024-saved-search-detail-filters +title: SavedSearchDetailFilters +pagination_label: SavedSearchDetailFilters +sidebar_label: SavedSearchDetailFilters +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearchDetailFilters', 'V2024SavedSearchDetailFilters'] +slug: /tools/sdk/powershell/v2024/models/saved-search-detail-filters +tags: ['SDK', 'Software Development Kit', 'SavedSearchDetailFilters', 'V2024SavedSearchDetailFilters'] +--- + + +# SavedSearchDetailFilters + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**FilterType**](filter-type) | | [optional] +**Range** | Pointer to [**Range**](range) | | [optional] +**Terms** | Pointer to **[]String** | The terms to be filtered. | [optional] +**Exclude** | Pointer to **Boolean** | Indicates if the filter excludes results. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$SavedSearchDetailFilters = Initialize-PSSailpoint.V2024SavedSearchDetailFilters -Type null ` + -Range null ` + -Terms null ` + -Exclude false +``` + +- Convert the resource to JSON +```powershell +$SavedSearchDetailFilters | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearchName.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearchName.md new file mode 100644 index 000000000..6ff5ae3a7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SavedSearchName.md @@ -0,0 +1,37 @@ +--- +id: v2024-saved-search-name +title: SavedSearchName +pagination_label: SavedSearchName +sidebar_label: SavedSearchName +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearchName', 'V2024SavedSearchName'] +slug: /tools/sdk/powershell/v2024/models/saved-search-name +tags: ['SDK', 'Software Development Kit', 'SavedSearchName', 'V2024SavedSearchName'] +--- + + +# SavedSearchName + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the saved search. | [optional] +**Description** | Pointer to **String** | The description of the saved search. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SavedSearchName = Initialize-PSSailpoint.V2024SavedSearchName -Name Disabled accounts ` + -Description Disabled accounts +``` + +- Convert the resource to JSON +```powershell +$SavedSearchName | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Schedule.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Schedule.md new file mode 100644 index 000000000..dcacf343a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Schedule.md @@ -0,0 +1,45 @@ +--- +id: v2024-schedule +title: Schedule +pagination_label: Schedule +sidebar_label: Schedule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule', 'V2024Schedule'] +slug: /tools/sdk/powershell/v2024/models/schedule +tags: ['SDK', 'Software Development Kit', 'Schedule', 'V2024Schedule'] +--- + + +# Schedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "WEEKLY", "MONTHLY", "ANNUALLY", "CALENDAR" ] | Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type can be configured. For example, a DAILY schedule can have 'hours' set, but not 'days'; a WEEKLY schedule can have both 'hours' and 'days' set. | [required] +**Months** | Pointer to [**ScheduleMonths**](schedule-months) | | [optional] +**Days** | Pointer to [**ScheduleDays**](schedule-days) | | [optional] +**Hours** | [**ScheduleHours**](schedule-hours) | | [required] +**Expiration** | Pointer to **System.DateTime** | Specifies the time after which this schedule will no longer occur. | [optional] +**TimeZoneId** | Pointer to **String** | The time zone to use when running the schedule. For instance, if the schedule is scheduled to run at 1AM, and this field is set to ""CST"", the schedule will run at 1AM CST. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Schedule = Initialize-PSSailpoint.V2024Schedule -Type WEEKLY ` + -Months null ` + -Days null ` + -Hours null ` + -Expiration null ` + -TimeZoneId CST +``` + +- Convert the resource to JSON +```powershell +$Schedule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Schedule1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Schedule1.md new file mode 100644 index 000000000..093a22a61 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Schedule1.md @@ -0,0 +1,37 @@ +--- +id: v2024-schedule1 +title: Schedule1 +pagination_label: Schedule1 +sidebar_label: Schedule1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule1', 'V2024Schedule1'] +slug: /tools/sdk/powershell/v2024/models/schedule1 +tags: ['SDK', 'Software Development Kit', 'Schedule1', 'V2024Schedule1'] +--- + + +# Schedule1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "ACCOUNT_AGGREGATION", "GROUP_AGGREGATION" ] | The type of the Schedule. | [required] +**CronExpression** | **String** | The cron expression of the schedule. | [required] + +## Examples + +- Prepare the resource +```powershell +$Schedule1 = Initialize-PSSailpoint.V2024Schedule1 -Type ACCOUNT_AGGREGATION ` + -CronExpression 0 0 5,13,21 * * ? +``` + +- Convert the resource to JSON +```powershell +$Schedule1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Schedule2.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Schedule2.md new file mode 100644 index 000000000..d0d2e005f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Schedule2.md @@ -0,0 +1,45 @@ +--- +id: v2024-schedule2 +title: Schedule2 +pagination_label: Schedule2 +sidebar_label: Schedule2 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule2', 'V2024Schedule2'] +slug: /tools/sdk/powershell/v2024/models/schedule2 +tags: ['SDK', 'Software Development Kit', 'Schedule2', 'V2024Schedule2'] +--- + + +# Schedule2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**ScheduleType**](schedule-type) | | [required] +**Months** | Pointer to [**Schedule2Months**](schedule2-months) | | [optional] +**Days** | Pointer to [**Schedule2Days**](schedule2-days) | | [optional] +**Hours** | [**Schedule2Hours**](schedule2-hours) | | [required] +**Expiration** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] +**TimeZoneId** | Pointer to **String** | The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org's default timezone is used. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Schedule2 = Initialize-PSSailpoint.V2024Schedule2 -Type null ` + -Months null ` + -Days null ` + -Hours null ` + -Expiration 2018-06-25T20:22:28.104Z ` + -TimeZoneId America/Chicago +``` + +- Convert the resource to JSON +```powershell +$Schedule2 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Schedule2Days.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Schedule2Days.md new file mode 100644 index 000000000..2561b44f1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Schedule2Days.md @@ -0,0 +1,37 @@ +--- +id: v2024-schedule2-days +title: Schedule2Days +pagination_label: Schedule2Days +sidebar_label: Schedule2Days +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule2Days', 'V2024Schedule2Days'] +slug: /tools/sdk/powershell/v2024/models/schedule2-days +tags: ['SDK', 'Software Development Kit', 'Schedule2Days', 'V2024Schedule2Days'] +--- + + +# Schedule2Days + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationId** | Pointer to **String** | The application id | [optional] +**AccountMatchConfig** | Pointer to [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Schedule2Days = Initialize-PSSailpoint.V2024Schedule2Days -ApplicationId 2c91808874ff91550175097daaec161c" ` + -AccountMatchConfig null +``` + +- Convert the resource to JSON +```powershell +$Schedule2Days | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Schedule2Hours.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Schedule2Hours.md new file mode 100644 index 000000000..b7d487b06 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Schedule2Hours.md @@ -0,0 +1,37 @@ +--- +id: v2024-schedule2-hours +title: Schedule2Hours +pagination_label: Schedule2Hours +sidebar_label: Schedule2Hours +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule2Hours', 'V2024Schedule2Hours'] +slug: /tools/sdk/powershell/v2024/models/schedule2-hours +tags: ['SDK', 'Software Development Kit', 'Schedule2Hours', 'V2024Schedule2Hours'] +--- + + +# Schedule2Hours + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationId** | Pointer to **String** | The application id | [optional] +**AccountMatchConfig** | Pointer to [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Schedule2Hours = Initialize-PSSailpoint.V2024Schedule2Hours -ApplicationId 2c91808874ff91550175097daaec161c" ` + -AccountMatchConfig null +``` + +- Convert the resource to JSON +```powershell +$Schedule2Hours | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Schedule2Months.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Schedule2Months.md new file mode 100644 index 000000000..49aaa62d7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Schedule2Months.md @@ -0,0 +1,37 @@ +--- +id: v2024-schedule2-months +title: Schedule2Months +pagination_label: Schedule2Months +sidebar_label: Schedule2Months +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule2Months', 'V2024Schedule2Months'] +slug: /tools/sdk/powershell/v2024/models/schedule2-months +tags: ['SDK', 'Software Development Kit', 'Schedule2Months', 'V2024Schedule2Months'] +--- + + +# Schedule2Months + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationId** | Pointer to **String** | The application id | [optional] +**AccountMatchConfig** | Pointer to [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Schedule2Months = Initialize-PSSailpoint.V2024Schedule2Months -ApplicationId 2c91808874ff91550175097daaec161c" ` + -AccountMatchConfig null +``` + +- Convert the resource to JSON +```powershell +$Schedule2Months | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ScheduleDays.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ScheduleDays.md new file mode 100644 index 000000000..061361aad --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ScheduleDays.md @@ -0,0 +1,39 @@ +--- +id: v2024-schedule-days +title: ScheduleDays +pagination_label: ScheduleDays +sidebar_label: ScheduleDays +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduleDays', 'V2024ScheduleDays'] +slug: /tools/sdk/powershell/v2024/models/schedule-days +tags: ['SDK', 'Software Development Kit', 'ScheduleDays', 'V2024ScheduleDays'] +--- + + +# ScheduleDays + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "LIST", "RANGE" ] | Enum type to specify days value | [required] +**Values** | **[]String** | Values of the days based on the enum type mentioned above | [required] +**Interval** | Pointer to **Int64** | Interval between the cert generations | [optional] + +## Examples + +- Prepare the resource +```powershell +$ScheduleDays = Initialize-PSSailpoint.V2024ScheduleDays -Type LIST ` + -Values [1] ` + -Interval 2 +``` + +- Convert the resource to JSON +```powershell +$ScheduleDays | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ScheduleHours.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ScheduleHours.md new file mode 100644 index 000000000..1250504a5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ScheduleHours.md @@ -0,0 +1,39 @@ +--- +id: v2024-schedule-hours +title: ScheduleHours +pagination_label: ScheduleHours +sidebar_label: ScheduleHours +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduleHours', 'V2024ScheduleHours'] +slug: /tools/sdk/powershell/v2024/models/schedule-hours +tags: ['SDK', 'Software Development Kit', 'ScheduleHours', 'V2024ScheduleHours'] +--- + + +# ScheduleHours + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "LIST", "RANGE" ] | Enum type to specify hours value | [required] +**Values** | **[]String** | Values of the days based on the enum type mentioned above | [required] +**Interval** | Pointer to **Int64** | Interval between the cert generations | [optional] + +## Examples + +- Prepare the resource +```powershell +$ScheduleHours = Initialize-PSSailpoint.V2024ScheduleHours -Type LIST ` + -Values [1] ` + -Interval 2 +``` + +- Convert the resource to JSON +```powershell +$ScheduleHours | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ScheduleMonths.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ScheduleMonths.md new file mode 100644 index 000000000..915e80a72 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ScheduleMonths.md @@ -0,0 +1,39 @@ +--- +id: v2024-schedule-months +title: ScheduleMonths +pagination_label: ScheduleMonths +sidebar_label: ScheduleMonths +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduleMonths', 'V2024ScheduleMonths'] +slug: /tools/sdk/powershell/v2024/models/schedule-months +tags: ['SDK', 'Software Development Kit', 'ScheduleMonths', 'V2024ScheduleMonths'] +--- + + +# ScheduleMonths + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "LIST", "RANGE" ] | Enum type to specify months value | [required] +**Values** | **[]String** | Values of the months based on the enum type mentioned above | [required] +**Interval** | Pointer to **Int64** | Interval between the cert generations | [optional] + +## Examples + +- Prepare the resource +```powershell +$ScheduleMonths = Initialize-PSSailpoint.V2024ScheduleMonths -Type LIST ` + -Values [1] ` + -Interval 2 +``` + +- Convert the resource to JSON +```powershell +$ScheduleMonths | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ScheduleType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ScheduleType.md new file mode 100644 index 000000000..d51f42c14 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ScheduleType.md @@ -0,0 +1,30 @@ +--- +id: v2024-schedule-type +title: ScheduleType +pagination_label: ScheduleType +sidebar_label: ScheduleType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduleType', 'V2024ScheduleType'] +slug: /tools/sdk/powershell/v2024/models/schedule-type +tags: ['SDK', 'Software Development Kit', 'ScheduleType', 'V2024ScheduleType'] +--- + + +# ScheduleType + +## Enum + + +* `DAILY` (value: `"DAILY"`) + +* `WEEKLY` (value: `"WEEKLY"`) + +* `MONTHLY` (value: `"MONTHLY"`) + +* `CALENDAR` (value: `"CALENDAR"`) + +* `ANNUALLY` (value: `"ANNUALLY"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ScheduledAttributes.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ScheduledAttributes.md new file mode 100644 index 000000000..1909aaf6f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ScheduledAttributes.md @@ -0,0 +1,43 @@ +--- +id: v2024-scheduled-attributes +title: ScheduledAttributes +pagination_label: ScheduledAttributes +sidebar_label: ScheduledAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledAttributes', 'V2024ScheduledAttributes'] +slug: /tools/sdk/powershell/v2024/models/scheduled-attributes +tags: ['SDK', 'Software Development Kit', 'ScheduledAttributes', 'V2024ScheduledAttributes'] +--- + + +# ScheduledAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CronString** | Pointer to **String** | A valid CRON expression | [optional] +**Frequency** | **Enum** [ "daily", "weekly", "monthly", "yearly", "cronSchedule" ] | Frequency of execution | [required] +**TimeZone** | Pointer to **String** | Time zone identifier | [optional] +**WeeklyDays** | Pointer to **[]String** | Scheduled days of the week for execution | [optional] +**WeeklyTimes** | Pointer to **[]String** | Scheduled execution times | [optional] + +## Examples + +- Prepare the resource +```powershell +$ScheduledAttributes = Initialize-PSSailpoint.V2024ScheduledAttributes -CronString 0 9 * * 1 ` + -Frequency null ` + -TimeZone America/Chicago ` + -WeeklyDays Monday ` + -WeeklyTimes Monday +``` + +- Convert the resource to JSON +```powershell +$ScheduledAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ScheduledSearch.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ScheduledSearch.md new file mode 100644 index 000000000..ad345c715 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ScheduledSearch.md @@ -0,0 +1,59 @@ +--- +id: v2024-scheduled-search +title: ScheduledSearch +pagination_label: ScheduledSearch +sidebar_label: ScheduledSearch +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledSearch', 'V2024ScheduledSearch'] +slug: /tools/sdk/powershell/v2024/models/scheduled-search +tags: ['SDK', 'Software Development Kit', 'ScheduledSearch', 'V2024ScheduledSearch'] +--- + + +# ScheduledSearch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the scheduled search. | [optional] +**Description** | Pointer to **String** | The description of the scheduled search. | [optional] +**SavedSearchId** | **String** | The ID of the saved search that will be executed. | [required] +**Created** | Pointer to **System.DateTime** | The date the scheduled search was initially created. | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | The last date the scheduled search was modified. | [optional] [readonly] +**Schedule** | [**Schedule2**](schedule2) | | [required] +**Recipients** | [**[]SearchScheduleRecipientsInner**](search-schedule-recipients-inner) | A list of identities that should receive the scheduled search report via email. | [required] +**Enabled** | Pointer to **Boolean** | Indicates if the scheduled search is enabled. | [optional] [default to $false] +**EmailEmptyResults** | Pointer to **Boolean** | Indicates if email generation should occur when search returns no results. | [optional] [default to $false] +**DisplayQueryDetails** | Pointer to **Boolean** | Indicates if the generated email should include the query and search results preview (which could include PII). | [optional] [default to $false] +**Id** | **String** | The scheduled search ID. | [required][readonly] +**Owner** | [**ScheduledSearchAllOfOwner**](scheduled-search-all-of-owner) | | [required] +**OwnerId** | **String** | The ID of the scheduled search owner. Please use the `id` in the `owner` object instead. | [required][readonly] + +## Examples + +- Prepare the resource +```powershell +$ScheduledSearch = Initialize-PSSailpoint.V2024ScheduledSearch -Name Daily disabled accounts ` + -Description Daily disabled accounts ` + -SavedSearchId 554f1511-f0a1-4744-ab14-599514d3e57c ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Schedule null ` + -Recipients null ` + -Enabled false ` + -EmailEmptyResults false ` + -DisplayQueryDetails false ` + -Id 0de46054-fe90-434a-b84e-c6b3359d0c64 ` + -Owner null ` + -OwnerId 2c9180867624cbd7017642d8c8c81f67 +``` + +- Convert the resource to JSON +```powershell +$ScheduledSearch | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ScheduledSearchAllOfOwner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ScheduledSearchAllOfOwner.md new file mode 100644 index 000000000..842b07016 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ScheduledSearchAllOfOwner.md @@ -0,0 +1,37 @@ +--- +id: v2024-scheduled-search-all-of-owner +title: ScheduledSearchAllOfOwner +pagination_label: ScheduledSearchAllOfOwner +sidebar_label: ScheduledSearchAllOfOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledSearchAllOfOwner', 'V2024ScheduledSearchAllOfOwner'] +slug: /tools/sdk/powershell/v2024/models/scheduled-search-all-of-owner +tags: ['SDK', 'Software Development Kit', 'ScheduledSearchAllOfOwner', 'V2024ScheduledSearchAllOfOwner'] +--- + + +# ScheduledSearchAllOfOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | The type of object being referenced | [required] +**Id** | **String** | The ID of the referenced object | [required] + +## Examples + +- Prepare the resource +```powershell +$ScheduledSearchAllOfOwner = Initialize-PSSailpoint.V2024ScheduledSearchAllOfOwner -Type IDENTITY ` + -Id 2c9180867624cbd7017642d8c8c81f67 +``` + +- Convert the resource to JSON +```powershell +$ScheduledSearchAllOfOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ScheduledSearchName.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ScheduledSearchName.md new file mode 100644 index 000000000..72170dfd6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ScheduledSearchName.md @@ -0,0 +1,37 @@ +--- +id: v2024-scheduled-search-name +title: ScheduledSearchName +pagination_label: ScheduledSearchName +sidebar_label: ScheduledSearchName +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledSearchName', 'V2024ScheduledSearchName'] +slug: /tools/sdk/powershell/v2024/models/scheduled-search-name +tags: ['SDK', 'Software Development Kit', 'ScheduledSearchName', 'V2024ScheduledSearchName'] +--- + + +# ScheduledSearchName + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the scheduled search. | [optional] +**Description** | Pointer to **String** | The description of the scheduled search. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ScheduledSearchName = Initialize-PSSailpoint.V2024ScheduledSearchName -Name Daily disabled accounts ` + -Description Daily disabled accounts +``` + +- Convert the resource to JSON +```powershell +$ScheduledSearchName | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Schema.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Schema.md new file mode 100644 index 000000000..b5bb13f5a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Schema.md @@ -0,0 +1,57 @@ +--- +id: v2024-schema +title: Schema +pagination_label: Schema +sidebar_label: Schema +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Schema', 'V2024Schema'] +slug: /tools/sdk/powershell/v2024/models/schema +tags: ['SDK', 'Software Development Kit', 'Schema', 'V2024Schema'] +--- + + +# Schema + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The id of the Schema. | [optional] +**Name** | Pointer to **String** | The name of the Schema. | [optional] +**NativeObjectType** | Pointer to **String** | The name of the object type on the native system that the schema represents. | [optional] +**IdentityAttribute** | Pointer to **String** | The name of the attribute used to calculate the unique identifier for an object in the schema. | [optional] +**DisplayAttribute** | Pointer to **String** | The name of the attribute used to calculate the display value for an object in the schema. | [optional] +**HierarchyAttribute** | Pointer to **String** | The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. | [optional] +**IncludePermissions** | Pointer to **Boolean** | Flag indicating whether or not the include permissions with the object data when aggregating the schema. | [optional] +**Features** | Pointer to **[]String** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**Configuration** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Holds any extra configuration data that the schema may require. | [optional] +**Attributes** | Pointer to [**[]AttributeDefinition**](attribute-definition) | The attribute definitions which form the schema. | [optional] +**Created** | Pointer to **System.DateTime** | The date the Schema was created. | [optional] +**Modified** | Pointer to **System.DateTime** | The date the Schema was last modified. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Schema = Initialize-PSSailpoint.V2024Schema -Id 2c9180835d191a86015d28455b4a2329 ` + -Name account ` + -NativeObjectType User ` + -IdentityAttribute sAMAccountName ` + -DisplayAttribute distinguishedName ` + -HierarchyAttribute memberOf ` + -IncludePermissions false ` + -Features [PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS] ` + -Configuration {groupMemberAttribute=member} ` + -Attributes [{name=sAMAccountName, type=STRING, isMultiValued=false, isEntitlement=false, isGroup=false}, {name=memberOf, type=STRING, schema={type=CONNECTOR_SCHEMA, id=2c9180887671ff8c01767b4671fc7d60, name=group}, description=Group membership, isMultiValued=true, isEntitlement=true, isGroup=true}] ` + -Created 2019-12-24T22:32:58.104Z ` + -Modified 2019-12-31T20:22:28.104Z +``` + +- Convert the resource to JSON +```powershell +$Schema | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Search.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Search.md new file mode 100644 index 000000000..899cd3968 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Search.md @@ -0,0 +1,65 @@ +--- +id: v2024-search +title: Search +pagination_label: Search +sidebar_label: Search +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Search', 'V2024Search'] +slug: /tools/sdk/powershell/v2024/models/search +tags: ['SDK', 'Software Development Kit', 'Search', 'V2024Search'] +--- + + +# Search + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Indices** | Pointer to [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**QueryType** | Pointer to [**QueryType**](query-type) | | [optional] +**QueryVersion** | Pointer to **String** | | [optional] +**Query** | Pointer to [**Query**](query) | | [optional] +**QueryDsl** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax. | [optional] +**TextQuery** | Pointer to [**TextQuery**](text-query) | | [optional] +**TypeAheadQuery** | Pointer to [**TypeAheadQuery**](type-ahead-query) | | [optional] +**IncludeNested** | Pointer to **Boolean** | Indicates whether nested objects from returned search results should be included. | [optional] [default to $true] +**QueryResultFilter** | Pointer to [**QueryResultFilter**](query-result-filter) | | [optional] +**AggregationType** | Pointer to [**AggregationType**](aggregation-type) | | [optional] +**AggregationsVersion** | Pointer to **String** | | [optional] +**AggregationsDsl** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax. | [optional] +**Aggregations** | Pointer to [**SearchAggregationSpecification**](search-aggregation-specification) | | [optional] +**Sort** | Pointer to **[]String** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] +**SearchAfter** | Pointer to **[]String** | Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging. For example, when searching for identities, if you are sorting by displayName you will also want to include ID, for example [""displayName"", ""id""]. If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is ""John Doe"", then using that displayName and ID will start a new search after this identity. The searchAfter value will look like [""John Doe"",""2c91808375d8e80a0175e1f88a575221""] | [optional] +**Filters** | Pointer to [**map[string]ModelFilter**](model-filter) | The filters to be applied for each filtered field name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Search = Initialize-PSSailpoint.V2024Search -Indices [identities] ` + -QueryType null ` + -QueryVersion null ` + -Query null ` + -QueryDsl {match={name=john.doe}} ` + -TextQuery null ` + -TypeAheadQuery null ` + -IncludeNested true ` + -QueryResultFilter null ` + -AggregationType null ` + -AggregationsVersion null ` + -AggregationsDsl {} ` + -Aggregations null ` + -Sort [displayName, +id] ` + -SearchAfter [John Doe, 2c91808375d8e80a0175e1f88a575221] ` + -Filters {} +``` + +- Convert the resource to JSON +```powershell +$Search | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchAggregationSpecification.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchAggregationSpecification.md new file mode 100644 index 000000000..8248da012 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchAggregationSpecification.md @@ -0,0 +1,43 @@ +--- +id: v2024-search-aggregation-specification +title: SearchAggregationSpecification +pagination_label: SearchAggregationSpecification +sidebar_label: SearchAggregationSpecification +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchAggregationSpecification', 'V2024SearchAggregationSpecification'] +slug: /tools/sdk/powershell/v2024/models/search-aggregation-specification +tags: ['SDK', 'Software Development Kit', 'SearchAggregationSpecification', 'V2024SearchAggregationSpecification'] +--- + + +# SearchAggregationSpecification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Nested** | Pointer to [**NestedAggregation**](nested-aggregation) | | [optional] +**Metric** | Pointer to [**MetricAggregation**](metric-aggregation) | | [optional] +**VarFilter** | Pointer to [**FilterAggregation**](filter-aggregation) | | [optional] +**Bucket** | Pointer to [**BucketAggregation**](bucket-aggregation) | | [optional] +**SubAggregation** | Pointer to [**SubSearchAggregationSpecification**](sub-search-aggregation-specification) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchAggregationSpecification = Initialize-PSSailpoint.V2024SearchAggregationSpecification -Nested null ` + -Metric null ` + -VarFilter null ` + -Bucket null ` + -SubAggregation null +``` + +- Convert the resource to JSON +```powershell +$SearchAggregationSpecification | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchArguments.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchArguments.md new file mode 100644 index 000000000..2c811254b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchArguments.md @@ -0,0 +1,39 @@ +--- +id: v2024-search-arguments +title: SearchArguments +pagination_label: SearchArguments +sidebar_label: SearchArguments +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchArguments', 'V2024SearchArguments'] +slug: /tools/sdk/powershell/v2024/models/search-arguments +tags: ['SDK', 'Software Development Kit', 'SearchArguments', 'V2024SearchArguments'] +--- + + +# SearchArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ScheduleId** | Pointer to **String** | The ID of the scheduled search that triggered the saved search execution. | [optional] +**Owner** | Pointer to [**TypedReference**](typed-reference) | The owner of the scheduled search being tested. | [optional] +**Recipients** | Pointer to [**[]TypedReference**](typed-reference) | The email recipients of the scheduled search being tested. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchArguments = Initialize-PSSailpoint.V2024SearchArguments -ScheduleId 7a724640-0c17-4ce9-a8c3-4a89738459c8 ` + -Owner null ` + -Recipients null +``` + +- Convert the resource to JSON +```powershell +$SearchArguments | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchAttributeConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchAttributeConfig.md new file mode 100644 index 000000000..77ab7c0bd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchAttributeConfig.md @@ -0,0 +1,39 @@ +--- +id: v2024-search-attribute-config +title: SearchAttributeConfig +pagination_label: SearchAttributeConfig +sidebar_label: SearchAttributeConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchAttributeConfig', 'V2024SearchAttributeConfig'] +slug: /tools/sdk/powershell/v2024/models/search-attribute-config +tags: ['SDK', 'Software Development Kit', 'SearchAttributeConfig', 'V2024SearchAttributeConfig'] +--- + + +# SearchAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Name of the new attribute | [optional] +**DisplayName** | Pointer to **String** | The display name of the new attribute | [optional] +**ApplicationAttributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Map of application id and their associated attribute. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchAttributeConfig = Initialize-PSSailpoint.V2024SearchAttributeConfig -Name newMailAttribute ` + -DisplayName New Mail Attribute ` + -ApplicationAttributes {2c91808b79fd2422017a0b35d30f3968=employeeNumber, 2c91808b79fd2422017a0b36008f396b=employeeNumber} +``` + +- Convert the resource to JSON +```powershell +$SearchAttributeConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchDocument.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchDocument.md new file mode 100644 index 000000000..81ab84df9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchDocument.md @@ -0,0 +1,169 @@ +--- +id: v2024-search-document +title: SearchDocument +pagination_label: SearchDocument +sidebar_label: SearchDocument +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchDocument', 'V2024SearchDocument'] +slug: /tools/sdk/powershell/v2024/models/search-document +tags: ['SDK', 'Software Development Kit', 'SearchDocument', 'V2024SearchDocument'] +--- + + +# SearchDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the referenced object. | [required] +**Name** | **String** | The human readable name of the referenced object. | [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** | [**DocumentType**](document-type) | | [required] +**Source** | Pointer to [**IdentityDocumentAllOfSource**](identity-document-all-of-source) | | [optional] +**Entitlements** | Pointer to [**[]BaseEntitlement**](base-entitlement) | Entitlements included with the role. | [optional] +**EntitlementCount** | Pointer to **Int32** | Number of entitlements included with the role. | [optional] +**Tags** | Pointer to **[]String** | Tags that have been applied to the object. | [optional] +**Action** | Pointer to **String** | Name of the event as it's displayed in audit reports. | [optional] +**Stage** | Pointer to **String** | Activity's current stage. | [optional] +**Origin** | Pointer to **String** | Activity's origin. | [optional] +**Status** | Pointer to **String** | Identity's status in SailPoint. | [optional] +**Requester** | Pointer to [**AccountSource**](account-source) | | [optional] +**Recipient** | Pointer to [**AccountSource**](account-source) | | [optional] +**TrackingNumber** | Pointer to **String** | ID of the group of events. | [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 [**[]Approval1**](approval1) | 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] +**DisplayName** | Pointer to **String** | Identity's display name. | [optional] +**Segments** | Pointer to [**[]BaseSegment**](base-segment) | Segments with the role. | [optional] +**SegmentCount** | Pointer to **Int32** | Number of segments with the role. | [optional] +**CloudGoverned** | Pointer to **Boolean** | Indicates whether the entitlement is cloud governed. | [optional] [default to $false] +**Privileged** | Pointer to **Boolean** | Indicates whether the entitlement is privileged. | [optional] [default to $false] +**IdentityCount** | Pointer to **Int32** | Number of identities who have access to the entitlement. | [optional] +**Type** | Pointer to **String** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional] +**Actor** | Pointer to **String** | Name of the actor that generated the event. | [optional] +**Target** | Pointer to **String** | Name of the target, or recipient, of the event. | [optional] +**Stack** | Pointer to **String** | The event's stack. | [optional] +**IpAddress** | Pointer to **String** | Target system's IP address. | [optional] +**Details** | Pointer to **String** | ID of event's details. | [optional] +**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Map or dictionary of key/value pairs. | [optional] +**Objects** | Pointer to **[]String** | Objects the event is happening to. | [optional] +**Operation** | Pointer to **String** | Operation, or action, performed during the event. | [optional] +**TechnicalName** | Pointer to **String** | Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. | [optional] +**FirstName** | Pointer to **String** | Identity's first name. | [optional] +**LastName** | Pointer to **String** | Identity's last name. | [optional] +**Email** | Pointer to **String** | Identity's primary email address. | [optional] +**Phone** | Pointer to **String** | Identity's phone number. | [optional] +**Inactive** | Pointer to **Boolean** | Indicates whether the identity is inactive. | [optional] [default to $false] +**Protected** | Pointer to **Boolean** | Indicates whether the identity is protected. | [optional] [default to $false] +**EmployeeNumber** | Pointer to **String** | Identity's employee number. | [optional] +**Manager** | Pointer to [**IdentityDocumentAllOfManager**](identity-document-all-of-manager) | | [optional] +**IsManager** | Pointer to **Boolean** | Indicates whether the identity is a manager of other identities. | [optional] +**IdentityProfile** | Pointer to [**IdentityDocumentAllOfIdentityProfile**](identity-document-all-of-identity-profile) | | [optional] +**ProcessingState** | Pointer to **String** | Identity's processing state. | [optional] +**ProcessingDetails** | Pointer to [**ProcessingDetails**](processing-details) | | [optional] +**Accounts** | Pointer to [**[]BaseAccount**](base-account) | List of accounts associated with the identity. | [optional] +**AccountCount** | Pointer to **Int32** | Number of accounts associated with the identity. | [optional] +**Apps** | Pointer to [**[]App**](app) | List of applications the identity has access to. | [optional] +**AppCount** | Pointer to **Int32** | Number of applications the identity has access to. | [optional] +**Access** | Pointer to [**[]IdentityAccess**](identity-access) | List of access items assigned to the identity. | [optional] +**AccessCount** | Pointer to **Int32** | Number of access items assigned to the identity. | [optional] +**RoleCount** | Pointer to **Int32** | Number of roles assigned to the identity. | [optional] +**AccessProfileCount** | Pointer to **Int32** | Number of access profiles included with the role. | [optional] +**Owns** | Pointer to [**[]Owns**](owns) | Access items the identity owns. | [optional] +**OwnsCount** | Pointer to **Int32** | Number of access items the identity owns. | [optional] +**AccessProfiles** | Pointer to [**[]BaseAccessProfile**](base-access-profile) | Access profiles included with the role. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchDocument = Initialize-PSSailpoint.V2024SearchDocument -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -Description The admin role ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Synced 2018-06-25T20:22:33.104Z ` + -Enabled true ` + -Requestable true ` + -RequestCommentsRequired false ` + -Owner null ` + -Type null ` + -Source null ` + -Entitlements null ` + -EntitlementCount 3 ` + -Tags [TAG_1, TAG_2] ` + -Action update ` + -Stage Completed ` + -Origin null ` + -Status UNREGISTERED ` + -Requester null ` + -Recipient null ` + -TrackingNumber 63f891e0735f4cc8bf1968144a1e7440 ` + -Errors null ` + -Warnings null ` + -Approvals null ` + -OriginalRequests null ` + -ExpansionItems null ` + -AccountRequests null ` + -Sources smartsheet-test, airtable-v4, IdentityNow ` + -DisplayName Carol.Adams ` + -Segments null ` + -SegmentCount 1 ` + -CloudGoverned false ` + -Privileged false ` + -IdentityCount 3 ` + -Type SYSTEM_CONFIG ` + -Actor System ` + -Target Carol.Adams ` + -Stack tpe ` + -IpAddress 52.52.97.85 ` + -Details 73b65dfbed1842548c207432a18c84b0 ` + -Attributes {country=US, firstname=Carol, cloudStatus=UNREGISTERED} ` + -Objects null ` + -Operation REQUEST ` + -TechnicalName AUTHENTICATION_REQUEST_PASSED ` + -FirstName Carol ` + -LastName Adams ` + -Email Carol.Adams@sailpointdemo.com ` + -Phone +1 440-527-3672 ` + -Inactive false ` + -Protected false ` + -EmployeeNumber 1a2a3d4e ` + -Manager null ` + -IsManager false ` + -IdentityProfile null ` + -ProcessingState null ` + -ProcessingDetails null ` + -Accounts null ` + -AccountCount 3 ` + -Apps null ` + -AppCount 2 ` + -Access null ` + -AccessCount 5 ` + -RoleCount 1 ` + -AccessProfileCount 1 ` + -Owns null ` + -OwnsCount 5 ` + -AccessProfiles null +``` + +- Convert the resource to JSON +```powershell +$SearchDocument | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchExportReportArguments.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchExportReportArguments.md new file mode 100644 index 000000000..dfb6f79b3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchExportReportArguments.md @@ -0,0 +1,41 @@ +--- +id: v2024-search-export-report-arguments +title: SearchExportReportArguments +pagination_label: SearchExportReportArguments +sidebar_label: SearchExportReportArguments +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchExportReportArguments', 'V2024SearchExportReportArguments'] +slug: /tools/sdk/powershell/v2024/models/search-export-report-arguments +tags: ['SDK', 'Software Development Kit', 'SearchExportReportArguments', 'V2024SearchExportReportArguments'] +--- + + +# SearchExportReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Indices** | Pointer to [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**Query** | **String** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [required] +**Columns** | Pointer to **String** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional] +**Sort** | Pointer to **[]String** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchExportReportArguments = Initialize-PSSailpoint.V2024SearchExportReportArguments -Indices [entitlements] ` + -Query name:a* ` + -Columns displayName,firstName,lastName,email,created,attributes.cloudLifecycleState ` + -Sort [displayName, +id] +``` + +- Convert the resource to JSON +```powershell +$SearchExportReportArguments | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchFilterType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchFilterType.md new file mode 100644 index 000000000..181716883 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchFilterType.md @@ -0,0 +1,22 @@ +--- +id: v2024-search-filter-type +title: SearchFilterType +pagination_label: SearchFilterType +sidebar_label: SearchFilterType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchFilterType', 'V2024SearchFilterType'] +slug: /tools/sdk/powershell/v2024/models/search-filter-type +tags: ['SDK', 'Software Development Kit', 'SearchFilterType', 'V2024SearchFilterType'] +--- + + +# SearchFilterType + +## Enum + + +* `TERM` (value: `"TERM"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchFormDefinitionsByTenant400Response.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchFormDefinitionsByTenant400Response.md new file mode 100644 index 000000000..8039a2ddb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchFormDefinitionsByTenant400Response.md @@ -0,0 +1,41 @@ +--- +id: v2024-search-form-definitions-by-tenant400-response +title: SearchFormDefinitionsByTenant400Response +pagination_label: SearchFormDefinitionsByTenant400Response +sidebar_label: SearchFormDefinitionsByTenant400Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchFormDefinitionsByTenant400Response', 'V2024SearchFormDefinitionsByTenant400Response'] +slug: /tools/sdk/powershell/v2024/models/search-form-definitions-by-tenant400-response +tags: ['SDK', 'Software Development Kit', 'SearchFormDefinitionsByTenant400Response', 'V2024SearchFormDefinitionsByTenant400Response'] +--- + + +# SearchFormDefinitionsByTenant400Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetailCode** | Pointer to **String** | | [optional] +**Messages** | Pointer to [**[]ErrorMessage**](error-message) | | [optional] +**StatusCode** | Pointer to **Int64** | | [optional] +**TrackingId** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchFormDefinitionsByTenant400Response = Initialize-PSSailpoint.V2024SearchFormDefinitionsByTenant400Response -DetailCode null ` + -Messages null ` + -StatusCode null ` + -TrackingId null +``` + +- Convert the resource to JSON +```powershell +$SearchFormDefinitionsByTenant400Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchSchedule.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchSchedule.md new file mode 100644 index 000000000..966332efb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchSchedule.md @@ -0,0 +1,49 @@ +--- +id: v2024-search-schedule +title: SearchSchedule +pagination_label: SearchSchedule +sidebar_label: SearchSchedule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchSchedule', 'V2024SearchSchedule'] +slug: /tools/sdk/powershell/v2024/models/search-schedule +tags: ['SDK', 'Software Development Kit', 'SearchSchedule', 'V2024SearchSchedule'] +--- + + +# SearchSchedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SavedSearchId** | **String** | The ID of the saved search that will be executed. | [required] +**Created** | Pointer to **System.DateTime** | The date the scheduled search was initially created. | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | The last date the scheduled search was modified. | [optional] [readonly] +**Schedule** | [**Schedule2**](schedule2) | | [required] +**Recipients** | [**[]SearchScheduleRecipientsInner**](search-schedule-recipients-inner) | A list of identities that should receive the scheduled search report via email. | [required] +**Enabled** | Pointer to **Boolean** | Indicates if the scheduled search is enabled. | [optional] [default to $false] +**EmailEmptyResults** | Pointer to **Boolean** | Indicates if email generation should occur when search returns no results. | [optional] [default to $false] +**DisplayQueryDetails** | Pointer to **Boolean** | Indicates if the generated email should include the query and search results preview (which could include PII). | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$SearchSchedule = Initialize-PSSailpoint.V2024SearchSchedule -SavedSearchId 554f1511-f0a1-4744-ab14-599514d3e57c ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Schedule null ` + -Recipients null ` + -Enabled false ` + -EmailEmptyResults false ` + -DisplayQueryDetails false +``` + +- Convert the resource to JSON +```powershell +$SearchSchedule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchScheduleRecipientsInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchScheduleRecipientsInner.md new file mode 100644 index 000000000..c50d3b77f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SearchScheduleRecipientsInner.md @@ -0,0 +1,37 @@ +--- +id: v2024-search-schedule-recipients-inner +title: SearchScheduleRecipientsInner +pagination_label: SearchScheduleRecipientsInner +sidebar_label: SearchScheduleRecipientsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchScheduleRecipientsInner', 'V2024SearchScheduleRecipientsInner'] +slug: /tools/sdk/powershell/v2024/models/search-schedule-recipients-inner +tags: ['SDK', 'Software Development Kit', 'SearchScheduleRecipientsInner', 'V2024SearchScheduleRecipientsInner'] +--- + + +# SearchScheduleRecipientsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | The type of object being referenced | [required] +**Id** | **String** | The ID of the referenced object | [required] + +## Examples + +- Prepare the resource +```powershell +$SearchScheduleRecipientsInner = Initialize-PSSailpoint.V2024SearchScheduleRecipientsInner -Type IDENTITY ` + -Id 2c9180867624cbd7017642d8c8c81f67 +``` + +- Convert the resource to JSON +```powershell +$SearchScheduleRecipientsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SectionDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SectionDetails.md new file mode 100644 index 000000000..db03a6a27 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SectionDetails.md @@ -0,0 +1,39 @@ +--- +id: v2024-section-details +title: SectionDetails +pagination_label: SectionDetails +sidebar_label: SectionDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SectionDetails', 'V2024SectionDetails'] +slug: /tools/sdk/powershell/v2024/models/section-details +tags: ['SDK', 'Software Development Kit', 'SectionDetails', 'V2024SectionDetails'] +--- + + +# SectionDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Name of the FormItem | [optional] +**Label** | Pointer to **String** | Label of the section | [optional] +**FormItems** | Pointer to [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | List of FormItems. FormItems can be SectionDetails and/or FieldDetails | [optional] + +## Examples + +- Prepare the resource +```powershell +$SectionDetails = Initialize-PSSailpoint.V2024SectionDetails -Name Field1 ` + -Label Section 1 ` + -FormItems [] +``` + +- Convert the resource to JSON +```powershell +$SectionDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Sed.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Sed.md new file mode 100644 index 000000000..5153961a4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Sed.md @@ -0,0 +1,61 @@ +--- +id: v2024-sed +title: Sed +pagination_label: Sed +sidebar_label: Sed +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Sed', 'V2024Sed'] +slug: /tools/sdk/powershell/v2024/models/sed +tags: ['SDK', 'Software Development Kit', 'Sed', 'V2024Sed'] +--- + + +# Sed + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | name of the entitlement | [optional] +**ApprovedBy** | Pointer to **String** | entitlement approved by | [optional] +**ApprovedType** | Pointer to **String** | entitlement approved type | [optional] +**ApprovedWhen** | Pointer to **System.DateTime** | entitlement approved then | [optional] +**Attribute** | Pointer to **String** | entitlement attribute | [optional] +**Description** | Pointer to **String** | description of entitlement | [optional] +**DisplayName** | Pointer to **String** | entitlement display name | [optional] +**Id** | Pointer to **String** | sed id | [optional] +**SourceId** | Pointer to **String** | entitlement source id | [optional] +**SourceName** | Pointer to **String** | entitlement source name | [optional] +**Status** | Pointer to **String** | entitlement status | [optional] +**SuggestedDescription** | Pointer to **String** | llm suggested entitlement description | [optional] +**Type** | Pointer to **String** | entitlement type | [optional] +**Value** | Pointer to **String** | entitlement value | [optional] + +## Examples + +- Prepare the resource +```powershell +$Sed = Initialize-PSSailpoint.V2024Sed -Name BatchInvoiceProcessing ` + -ApprovedBy 2c918086-76de-afbf-0176-f6d28f65565a ` + -ApprovedType admin ` + -ApprovedWhen null ` + -Attribute Role ` + -Description This entitlement allows automated processing of invoices in batches on a scheduled basis to streamline accounts payable procedures. ` + -DisplayName AWS-Cloud-Billing ` + -Id ead281ee-12a9-40ac-9534-36b5d7d65d53 ` + -SourceId 103f567b93ee49b991c40f9412f87643 ` + -SourceName IDN Salesforce ` + -Status suggested ` + -SuggestedDescription This entitlement allows automated processing of invoices in batches on a scheduled basis to streamline accounts payable ` + -Type group ` + -Value group +``` + +- Convert the resource to JSON +```powershell +$Sed | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedApproval.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedApproval.md new file mode 100644 index 000000000..f71ee9a80 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedApproval.md @@ -0,0 +1,35 @@ +--- +id: v2024-sed-approval +title: SedApproval +pagination_label: SedApproval +sidebar_label: SedApproval +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SedApproval', 'V2024SedApproval'] +slug: /tools/sdk/powershell/v2024/models/sed-approval +tags: ['SDK', 'Software Development Kit', 'SedApproval', 'V2024SedApproval'] +--- + + +# SedApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Items** | Pointer to **[]String** | List of SED id's | [optional] + +## Examples + +- Prepare the resource +```powershell +$SedApproval = Initialize-PSSailpoint.V2024SedApproval -Items 016629d1-1d25-463f-97f3-c6686846650 +``` + +- Convert the resource to JSON +```powershell +$SedApproval | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedApprovalStatus.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedApprovalStatus.md new file mode 100644 index 000000000..6475fff5d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedApprovalStatus.md @@ -0,0 +1,39 @@ +--- +id: v2024-sed-approval-status +title: SedApprovalStatus +pagination_label: SedApprovalStatus +sidebar_label: SedApprovalStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SedApprovalStatus', 'V2024SedApprovalStatus'] +slug: /tools/sdk/powershell/v2024/models/sed-approval-status +tags: ['SDK', 'Software Development Kit', 'SedApprovalStatus', 'V2024SedApprovalStatus'] +--- + + +# SedApprovalStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FailedReason** | Pointer to **String** | failed reason will be display if status is failed | [optional] +**Id** | Pointer to **String** | Sed id | [optional] +**Status** | Pointer to **String** | SUCCESS | FAILED | [optional] + +## Examples + +- Prepare the resource +```powershell +$SedApprovalStatus = Initialize-PSSailpoint.V2024SedApprovalStatus -FailedReason invalid status ` + -Id 016629d1-1d25-463f-97f3-0c6686846650 ` + -Status SUCCESS +``` + +- Convert the resource to JSON +```powershell +$SedApprovalStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedAssignee.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedAssignee.md new file mode 100644 index 000000000..02f4175ae --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedAssignee.md @@ -0,0 +1,37 @@ +--- +id: v2024-sed-assignee +title: SedAssignee +pagination_label: SedAssignee +sidebar_label: SedAssignee +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SedAssignee', 'V2024SedAssignee'] +slug: /tools/sdk/powershell/v2024/models/sed-assignee +tags: ['SDK', 'Software Development Kit', 'SedAssignee', 'V2024SedAssignee'] +--- + + +# SedAssignee + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY", "GROUP", "SOURCE_OWNER", "ENTITLEMENT_OWNER" ] | Type of assignment When value is PERSONA, the value MUST be SOURCE_OWNER or ENTITLEMENT_OWNER IDENTITY SED_ASSIGNEE_IDENTITY_TYPE GROUP SED_ASSIGNEE_GROUP_TYPE SOURCE_OWNER SED_ASSIGNEE_SOURCE_OWNER_TYPE ENTITLEMENT_OWNER SED_ASSIGNEE_ENTITLEMENT_OWNER_TYPE | [required] +**Value** | Pointer to **String** | Identity or Group identifier Empty when using source/entitlement owner personas | [optional] + +## Examples + +- Prepare the resource +```powershell +$SedAssignee = Initialize-PSSailpoint.V2024SedAssignee -Type SOURCE_OWNER ` + -Value 016629d1-1d25-463f-97f3-c6686846650 +``` + +- Convert the resource to JSON +```powershell +$SedAssignee | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedAssignment.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedAssignment.md new file mode 100644 index 000000000..d8983b596 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedAssignment.md @@ -0,0 +1,37 @@ +--- +id: v2024-sed-assignment +title: SedAssignment +pagination_label: SedAssignment +sidebar_label: SedAssignment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SedAssignment', 'V2024SedAssignment'] +slug: /tools/sdk/powershell/v2024/models/sed-assignment +tags: ['SDK', 'Software Development Kit', 'SedAssignment', 'V2024SedAssignment'] +--- + + +# SedAssignment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Assignee** | Pointer to [**SedAssignee**](sed-assignee) | | [optional] +**Items** | Pointer to **[]String** | List of SED id's | [optional] + +## Examples + +- Prepare the resource +```powershell +$SedAssignment = Initialize-PSSailpoint.V2024SedAssignment -Assignee null ` + -Items null +``` + +- Convert the resource to JSON +```powershell +$SedAssignment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedAssignmentResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedAssignmentResponse.md new file mode 100644 index 000000000..94aba81d5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedAssignmentResponse.md @@ -0,0 +1,35 @@ +--- +id: v2024-sed-assignment-response +title: SedAssignmentResponse +pagination_label: SedAssignmentResponse +sidebar_label: SedAssignmentResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SedAssignmentResponse', 'V2024SedAssignmentResponse'] +slug: /tools/sdk/powershell/v2024/models/sed-assignment-response +tags: ['SDK', 'Software Development Kit', 'SedAssignmentResponse', 'V2024SedAssignmentResponse'] +--- + + +# SedAssignmentResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchId** | Pointer to **String** | BatchId that groups all the ids together | [optional] + +## Examples + +- Prepare the resource +```powershell +$SedAssignmentResponse = Initialize-PSSailpoint.V2024SedAssignmentResponse -BatchId 016629d1-1d25-463f-97f3-0c6686846650 +``` + +- Convert the resource to JSON +```powershell +$SedAssignmentResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedBatchRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedBatchRequest.md new file mode 100644 index 000000000..fa737f8d8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedBatchRequest.md @@ -0,0 +1,37 @@ +--- +id: v2024-sed-batch-request +title: SedBatchRequest +pagination_label: SedBatchRequest +sidebar_label: SedBatchRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SedBatchRequest', 'V2024SedBatchRequest'] +slug: /tools/sdk/powershell/v2024/models/sed-batch-request +tags: ['SDK', 'Software Development Kit', 'SedBatchRequest', 'V2024SedBatchRequest'] +--- + + +# SedBatchRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Entitlements** | Pointer to **[]String** | list of entitlement ids | [optional] +**Seds** | Pointer to **[]String** | list of sed ids | [optional] + +## Examples + +- Prepare the resource +```powershell +$SedBatchRequest = Initialize-PSSailpoint.V2024SedBatchRequest -Entitlements null ` + -Seds null +``` + +- Convert the resource to JSON +```powershell +$SedBatchRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedBatchResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedBatchResponse.md new file mode 100644 index 000000000..d72a58d12 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedBatchResponse.md @@ -0,0 +1,35 @@ +--- +id: v2024-sed-batch-response +title: SedBatchResponse +pagination_label: SedBatchResponse +sidebar_label: SedBatchResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SedBatchResponse', 'V2024SedBatchResponse'] +slug: /tools/sdk/powershell/v2024/models/sed-batch-response +tags: ['SDK', 'Software Development Kit', 'SedBatchResponse', 'V2024SedBatchResponse'] +--- + + +# SedBatchResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchId** | Pointer to **String** | BatchId that groups all the ids together | [optional] + +## Examples + +- Prepare the resource +```powershell +$SedBatchResponse = Initialize-PSSailpoint.V2024SedBatchResponse -BatchId 016629d1-1d25-463f-97f3-0c6686846650 +``` + +- Convert the resource to JSON +```powershell +$SedBatchResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedBatchStats.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedBatchStats.md new file mode 100644 index 000000000..5fecc4a1e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedBatchStats.md @@ -0,0 +1,43 @@ +--- +id: v2024-sed-batch-stats +title: SedBatchStats +pagination_label: SedBatchStats +sidebar_label: SedBatchStats +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SedBatchStats', 'V2024SedBatchStats'] +slug: /tools/sdk/powershell/v2024/models/sed-batch-stats +tags: ['SDK', 'Software Development Kit', 'SedBatchStats', 'V2024SedBatchStats'] +--- + + +# SedBatchStats + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BatchComplete** | Pointer to **Boolean** | batch complete | [optional] [default to $false] +**BatchId** | Pointer to **String** | batch Id | [optional] +**DiscoveredCount** | Pointer to **Int64** | discovered count | [optional] +**DiscoveryComplete** | Pointer to **Boolean** | discovery complete | [optional] [default to $false] +**ProcessedCount** | Pointer to **Int64** | processed count | [optional] + +## Examples + +- Prepare the resource +```powershell +$SedBatchStats = Initialize-PSSailpoint.V2024SedBatchStats -BatchComplete true ` + -BatchId 016629d1-1d25-463f-97f3-0c6686846650 ` + -DiscoveredCount 100 ` + -DiscoveryComplete true ` + -ProcessedCount 100 +``` + +- Convert the resource to JSON +```powershell +$SedBatchStats | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedBatchStatus.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedBatchStatus.md new file mode 100644 index 000000000..87d3639c1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedBatchStatus.md @@ -0,0 +1,35 @@ +--- +id: v2024-sed-batch-status +title: SedBatchStatus +pagination_label: SedBatchStatus +sidebar_label: SedBatchStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SedBatchStatus', 'V2024SedBatchStatus'] +slug: /tools/sdk/powershell/v2024/models/sed-batch-status +tags: ['SDK', 'Software Development Kit', 'SedBatchStatus', 'V2024SedBatchStatus'] +--- + + +# SedBatchStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **String** | status of batch | [optional] + +## Examples + +- Prepare the resource +```powershell +$SedBatchStatus = Initialize-PSSailpoint.V2024SedBatchStatus -Status OK +``` + +- Convert the resource to JSON +```powershell +$SedBatchStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedPatch.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedPatch.md new file mode 100644 index 000000000..093ae6955 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SedPatch.md @@ -0,0 +1,39 @@ +--- +id: v2024-sed-patch +title: SedPatch +pagination_label: SedPatch +sidebar_label: SedPatch +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SedPatch', 'V2024SedPatch'] +slug: /tools/sdk/powershell/v2024/models/sed-patch +tags: ['SDK', 'Software Development Kit', 'SedPatch', 'V2024SedPatch'] +--- + + +# SedPatch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | Pointer to **String** | desired operation | [optional] +**Path** | Pointer to **String** | field to be patched | [optional] +**Value** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | value to replace with | [optional] + +## Examples + +- Prepare the resource +```powershell +$SedPatch = Initialize-PSSailpoint.V2024SedPatch -Op replace ` + -Path status ` + -Value approved +``` + +- Convert the resource to JSON +```powershell +$SedPatch | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Segment.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Segment.md new file mode 100644 index 000000000..e7c9fe7da --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Segment.md @@ -0,0 +1,49 @@ +--- +id: v2024-segment +title: Segment +pagination_label: Segment +sidebar_label: Segment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Segment', 'V2024Segment'] +slug: /tools/sdk/powershell/v2024/models/segment +tags: ['SDK', 'Software Development Kit', 'Segment', 'V2024Segment'] +--- + + +# Segment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The segment's ID. | [optional] +**Name** | Pointer to **String** | The segment's business name. | [optional] +**Created** | Pointer to **System.DateTime** | The time when the segment is created. | [optional] +**Modified** | Pointer to **System.DateTime** | The time when the segment is modified. | [optional] +**Description** | Pointer to **String** | The segment's optional description. | [optional] +**Owner** | Pointer to [**OwnerReferenceSegments**](owner-reference-segments) | | [optional] +**VisibilityCriteria** | Pointer to [**SegmentVisibilityCriteria**](segment-visibility-criteria) | | [optional] +**Active** | Pointer to **Boolean** | This boolean indicates whether the segment is currently active. Inactive segments have no effect. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$Segment = Initialize-PSSailpoint.V2024Segment -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -Name segment-xyz ` + -Created 2020-01-01T00:00Z ` + -Modified 2020-01-01T00:00Z ` + -Description This segment represents xyz ` + -Owner null ` + -VisibilityCriteria null ` + -Active true +``` + +- Convert the resource to JSON +```powershell +$Segment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SegmentVisibilityCriteria.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SegmentVisibilityCriteria.md new file mode 100644 index 000000000..3ed2fe7a1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SegmentVisibilityCriteria.md @@ -0,0 +1,35 @@ +--- +id: v2024-segment-visibility-criteria +title: SegmentVisibilityCriteria +pagination_label: SegmentVisibilityCriteria +sidebar_label: SegmentVisibilityCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SegmentVisibilityCriteria', 'V2024SegmentVisibilityCriteria'] +slug: /tools/sdk/powershell/v2024/models/segment-visibility-criteria +tags: ['SDK', 'Software Development Kit', 'SegmentVisibilityCriteria', 'V2024SegmentVisibilityCriteria'] +--- + + +# SegmentVisibilityCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Expression** | Pointer to [**Expression**](expression) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SegmentVisibilityCriteria = Initialize-PSSailpoint.V2024SegmentVisibilityCriteria -Expression null +``` + +- Convert the resource to JSON +```powershell +$SegmentVisibilityCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Selector.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Selector.md new file mode 100644 index 000000000..27917e200 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Selector.md @@ -0,0 +1,37 @@ +--- +id: v2024-selector +title: Selector +pagination_label: Selector +sidebar_label: Selector +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Selector', 'V2024Selector'] +slug: /tools/sdk/powershell/v2024/models/selector +tags: ['SDK', 'Software Development Kit', 'Selector', 'V2024Selector'] +--- + + +# Selector + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationId** | Pointer to **String** | The application id | [optional] +**AccountMatchConfig** | Pointer to [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Selector = Initialize-PSSailpoint.V2024Selector -ApplicationId 2c91808874ff91550175097daaec161c" ` + -AccountMatchConfig null +``` + +- Convert the resource to JSON +```powershell +$Selector | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SelectorAccountMatchConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SelectorAccountMatchConfig.md new file mode 100644 index 000000000..59822b568 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SelectorAccountMatchConfig.md @@ -0,0 +1,35 @@ +--- +id: v2024-selector-account-match-config +title: SelectorAccountMatchConfig +pagination_label: SelectorAccountMatchConfig +sidebar_label: SelectorAccountMatchConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SelectorAccountMatchConfig', 'V2024SelectorAccountMatchConfig'] +slug: /tools/sdk/powershell/v2024/models/selector-account-match-config +tags: ['SDK', 'Software Development Kit', 'SelectorAccountMatchConfig', 'V2024SelectorAccountMatchConfig'] +--- + + +# SelectorAccountMatchConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MatchExpression** | Pointer to [**SelectorAccountMatchConfigMatchExpression**](selector-account-match-config-match-expression) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SelectorAccountMatchConfig = Initialize-PSSailpoint.V2024SelectorAccountMatchConfig -MatchExpression null +``` + +- Convert the resource to JSON +```powershell +$SelectorAccountMatchConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SelectorAccountMatchConfigMatchExpression.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SelectorAccountMatchConfigMatchExpression.md new file mode 100644 index 000000000..8302cb888 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SelectorAccountMatchConfigMatchExpression.md @@ -0,0 +1,37 @@ +--- +id: v2024-selector-account-match-config-match-expression +title: SelectorAccountMatchConfigMatchExpression +pagination_label: SelectorAccountMatchConfigMatchExpression +sidebar_label: SelectorAccountMatchConfigMatchExpression +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SelectorAccountMatchConfigMatchExpression', 'V2024SelectorAccountMatchConfigMatchExpression'] +slug: /tools/sdk/powershell/v2024/models/selector-account-match-config-match-expression +tags: ['SDK', 'Software Development Kit', 'SelectorAccountMatchConfigMatchExpression', 'V2024SelectorAccountMatchConfigMatchExpression'] +--- + + +# SelectorAccountMatchConfigMatchExpression + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MatchTerms** | Pointer to [**[]MatchTerm**](match-term) | | [optional] +**And** | Pointer to **Boolean** | If it is AND operators for match terms | [optional] [default to $true] + +## Examples + +- Prepare the resource +```powershell +$SelectorAccountMatchConfigMatchExpression = Initialize-PSSailpoint.V2024SelectorAccountMatchConfigMatchExpression -MatchTerms [{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}] ` + -And true +``` + +- Convert the resource to JSON +```powershell +$SelectorAccountMatchConfigMatchExpression | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SelfImportExportDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SelfImportExportDto.md new file mode 100644 index 000000000..d752a3279 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SelfImportExportDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-self-import-export-dto +title: SelfImportExportDto +pagination_label: SelfImportExportDto +sidebar_label: SelfImportExportDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SelfImportExportDto', 'V2024SelfImportExportDto'] +slug: /tools/sdk/powershell/v2024/models/self-import-export-dto +tags: ['SDK', 'Software Development Kit', 'SelfImportExportDto', 'V2024SelfImportExportDto'] +--- + + +# SelfImportExportDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "ACCESS_REQUEST_CONFIG", "ATTR_SYNC_SOURCE_CONFIG", "AUTH_ORG", "CAMPAIGN_FILTER", "FORM_DEFINITION", "GOVERNANCE_GROUP", "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "LIFECYCLE_STATE", "NOTIFICATION_TEMPLATE", "PASSWORD_POLICY", "PASSWORD_SYNC_GROUP", "PUBLIC_IDENTITIES_CONFIG", "ROLE", "RULE", "SEGMENT", "SERVICE_DESK_INTEGRATION", "SOD_POLICY", "SOURCE", "TAG", "TRANSFORM", "TRIGGER_SUBSCRIPTION", "WORKFLOW" ] | Imported/exported object's DTO type. Import is currently only possible with the IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. | [optional] +**Id** | Pointer to **String** | Imported/exported object's ID. | [optional] +**Name** | Pointer to **String** | Imported/exported object's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SelfImportExportDto = Initialize-PSSailpoint.V2024SelfImportExportDto -Type SOURCE ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name HR Active Directory +``` + +- Convert the resource to JSON +```powershell +$SelfImportExportDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SendAccountVerificationRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SendAccountVerificationRequest.md new file mode 100644 index 000000000..a5c05e9aa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SendAccountVerificationRequest.md @@ -0,0 +1,37 @@ +--- +id: v2024-send-account-verification-request +title: SendAccountVerificationRequest +pagination_label: SendAccountVerificationRequest +sidebar_label: SendAccountVerificationRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SendAccountVerificationRequest', 'V2024SendAccountVerificationRequest'] +slug: /tools/sdk/powershell/v2024/models/send-account-verification-request +tags: ['SDK', 'Software Development Kit', 'SendAccountVerificationRequest', 'V2024SendAccountVerificationRequest'] +--- + + +# SendAccountVerificationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceName** | Pointer to **String** | The source name where identity account password should be reset | [optional] +**Via** | **Enum** [ "EMAIL_WORK", "EMAIL_PERSONAL", "LINK_WORK", "LINK_PERSONAL" ] | The method to send notification | [required] + +## Examples + +- Prepare the resource +```powershell +$SendAccountVerificationRequest = Initialize-PSSailpoint.V2024SendAccountVerificationRequest -SourceName Active Directory Source ` + -Via EMAIL_WORK +``` + +- Convert the resource to JSON +```powershell +$SendAccountVerificationRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SendTestNotificationRequestDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SendTestNotificationRequestDto.md new file mode 100644 index 000000000..7dcac2a4e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SendTestNotificationRequestDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-send-test-notification-request-dto +title: SendTestNotificationRequestDto +pagination_label: SendTestNotificationRequestDto +sidebar_label: SendTestNotificationRequestDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SendTestNotificationRequestDto', 'V2024SendTestNotificationRequestDto'] +slug: /tools/sdk/powershell/v2024/models/send-test-notification-request-dto +tags: ['SDK', 'Software Development Kit', 'SendTestNotificationRequestDto', 'V2024SendTestNotificationRequestDto'] +--- + + +# SendTestNotificationRequestDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **String** | The template notification key. | [optional] +**Medium** | Pointer to **Enum** [ "EMAIL", "SLACK", "TEAMS" ] | The notification medium. Has to be one of the following enum values. | [optional] +**Context** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A Json object that denotes the context specific to the template. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SendTestNotificationRequestDto = Initialize-PSSailpoint.V2024SendTestNotificationRequestDto -Key cloud_manual_work_item_summary ` + -Medium null ` + -Context null +``` + +- Convert the resource to JSON +```powershell +$SendTestNotificationRequestDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ServiceDeskIntegrationDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ServiceDeskIntegrationDto.md new file mode 100644 index 000000000..1bd57c011 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ServiceDeskIntegrationDto.md @@ -0,0 +1,59 @@ +--- +id: v2024-service-desk-integration-dto +title: ServiceDeskIntegrationDto +pagination_label: ServiceDeskIntegrationDto +sidebar_label: ServiceDeskIntegrationDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskIntegrationDto', 'V2024ServiceDeskIntegrationDto'] +slug: /tools/sdk/powershell/v2024/models/service-desk-integration-dto +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationDto', 'V2024ServiceDeskIntegrationDto'] +--- + + +# ServiceDeskIntegrationDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Unique identifier for the Service Desk integration | [optional] +**Name** | **String** | Service Desk integration's name. The name must be unique. | [required] +**Created** | Pointer to **System.DateTime** | The date and time the Service Desk integration was created | [optional] +**Modified** | Pointer to **System.DateTime** | The date and time the Service Desk integration was last modified | [optional] +**Description** | **String** | Service Desk integration's description. | [required] +**Type** | **String** | Service Desk integration types: - ServiceNowSDIM - ServiceNow | [required][default to "ServiceNowSDIM"] +**OwnerRef** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**ClusterRef** | Pointer to [**SourceClusterDto**](source-cluster-dto) | | [optional] +**Cluster** | Pointer to **String** | Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). | [optional] +**ManagedSources** | Pointer to **[]String** | Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). | [optional] +**ProvisioningConfig** | Pointer to [**ProvisioningConfig**](provisioning-config) | | [optional] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Service Desk integration's attributes. Validation constraints enforced by the implementation. | [required] +**BeforeProvisioningRule** | Pointer to [**BeforeProvisioningRuleDto**](before-provisioning-rule-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ServiceDeskIntegrationDto = Initialize-PSSailpoint.V2024ServiceDeskIntegrationDto -Id 62945a496ef440189b1f03e3623411c8 ` + -Name Service Desk Integration Name ` + -Created 2024-01-17T18:45:25.994Z ` + -Modified 2024-02-18T18:45:25.994Z ` + -Description A very nice Service Desk integration ` + -Type ServiceNowSDIM ` + -OwnerRef null ` + -ClusterRef null ` + -Cluster xyzzy999 ` + -ManagedSources [2c9180835d191a86015d28455b4a2329, 2c5680835d191a85765d28455b4a9823] ` + -ProvisioningConfig null ` + -Attributes {property=value, key=value} ` + -BeforeProvisioningRule null +``` + +- Convert the resource to JSON +```powershell +$ServiceDeskIntegrationDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ServiceDeskIntegrationDto1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ServiceDeskIntegrationDto1.md new file mode 100644 index 000000000..6aff10151 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ServiceDeskIntegrationDto1.md @@ -0,0 +1,53 @@ +--- +id: v2024-service-desk-integration-dto1 +title: ServiceDeskIntegrationDto1 +pagination_label: ServiceDeskIntegrationDto1 +sidebar_label: ServiceDeskIntegrationDto1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskIntegrationDto1', 'V2024ServiceDeskIntegrationDto1'] +slug: /tools/sdk/powershell/v2024/models/service-desk-integration-dto1 +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationDto1', 'V2024ServiceDeskIntegrationDto1'] +--- + + +# ServiceDeskIntegrationDto1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Service Desk integration's name. The name must be unique. | [required] +**Description** | **String** | Service Desk integration's description. | [required] +**Type** | **String** | Service Desk integration types: - ServiceNowSDIM - ServiceNow | [required][default to "ServiceNowSDIM"] +**OwnerRef** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**ClusterRef** | Pointer to [**SourceClusterDto**](source-cluster-dto) | | [optional] +**Cluster** | Pointer to **String** | Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). | [optional] +**ManagedSources** | Pointer to **[]String** | Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). | [optional] +**ProvisioningConfig** | Pointer to [**ProvisioningConfig1**](provisioning-config1) | | [optional] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Service Desk integration's attributes. Validation constraints enforced by the implementation. | [required] +**BeforeProvisioningRule** | Pointer to [**BeforeProvisioningRuleDto**](before-provisioning-rule-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ServiceDeskIntegrationDto1 = Initialize-PSSailpoint.V2024ServiceDeskIntegrationDto1 -Name Service Desk Integration Name ` + -Description A very nice Service Desk integration ` + -Type ServiceNowSDIM ` + -OwnerRef null ` + -ClusterRef null ` + -Cluster xyzzy999 ` + -ManagedSources [2c9180835d191a86015d28455b4a2329, 2c5680835d191a85765d28455b4a9823] ` + -ProvisioningConfig null ` + -Attributes {property=value, key=value} ` + -BeforeProvisioningRule null +``` + +- Convert the resource to JSON +```powershell +$ServiceDeskIntegrationDto1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ServiceDeskIntegrationTemplateDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ServiceDeskIntegrationTemplateDto.md new file mode 100644 index 000000000..92f2d8166 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ServiceDeskIntegrationTemplateDto.md @@ -0,0 +1,47 @@ +--- +id: v2024-service-desk-integration-template-dto +title: ServiceDeskIntegrationTemplateDto +pagination_label: ServiceDeskIntegrationTemplateDto +sidebar_label: ServiceDeskIntegrationTemplateDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskIntegrationTemplateDto', 'V2024ServiceDeskIntegrationTemplateDto'] +slug: /tools/sdk/powershell/v2024/models/service-desk-integration-template-dto +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationTemplateDto', 'V2024ServiceDeskIntegrationTemplateDto'] +--- + + +# ServiceDeskIntegrationTemplateDto + +## Properties + +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] +**Type** | **String** | The 'type' property specifies the type of the Service Desk integration template. | [required][default to "Web Service SDIM"] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template. | [required] +**ProvisioningConfig** | [**ProvisioningConfig**](provisioning-config) | | [required] + +## Examples + +- Prepare the resource +```powershell +$ServiceDeskIntegrationTemplateDto = Initialize-PSSailpoint.V2024ServiceDeskIntegrationTemplateDto -Id id12345 ` + -Name aName ` + -Created 2015-05-28T14:07:17Z ` + -Modified 2015-05-28T14:07:17Z ` + -Type Web Service SDIM ` + -Attributes {property=value, key=value} ` + -ProvisioningConfig null +``` + +- Convert the resource to JSON +```powershell +$ServiceDeskIntegrationTemplateDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ServiceDeskIntegrationTemplateType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ServiceDeskIntegrationTemplateType.md new file mode 100644 index 000000000..538261afd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ServiceDeskIntegrationTemplateType.md @@ -0,0 +1,39 @@ +--- +id: v2024-service-desk-integration-template-type +title: ServiceDeskIntegrationTemplateType +pagination_label: ServiceDeskIntegrationTemplateType +sidebar_label: ServiceDeskIntegrationTemplateType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskIntegrationTemplateType', 'V2024ServiceDeskIntegrationTemplateType'] +slug: /tools/sdk/powershell/v2024/models/service-desk-integration-template-type +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationTemplateType', 'V2024ServiceDeskIntegrationTemplateType'] +--- + + +# ServiceDeskIntegrationTemplateType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | This is the name of the type. | [optional] +**Type** | **String** | This is the type value for the type. | [required] +**ScriptName** | **String** | This is the scriptName attribute value for the type. | [required] + +## Examples + +- Prepare the resource +```powershell +$ServiceDeskIntegrationTemplateType = Initialize-PSSailpoint.V2024ServiceDeskIntegrationTemplateType -Name aName ` + -Type aType ` + -ScriptName aScriptName +``` + +- Convert the resource to JSON +```powershell +$ServiceDeskIntegrationTemplateType | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ServiceDeskSource.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ServiceDeskSource.md new file mode 100644 index 000000000..e9b15e286 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ServiceDeskSource.md @@ -0,0 +1,39 @@ +--- +id: v2024-service-desk-source +title: ServiceDeskSource +pagination_label: ServiceDeskSource +sidebar_label: ServiceDeskSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskSource', 'V2024ServiceDeskSource'] +slug: /tools/sdk/powershell/v2024/models/service-desk-source +tags: ['SDK', 'Software Development Kit', 'ServiceDeskSource', 'V2024ServiceDeskSource'] +--- + + +# ServiceDeskSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "SOURCE" ] | DTO type of source for service desk integration template. | [optional] +**Id** | Pointer to **String** | ID of source for service desk integration template. | [optional] +**Name** | Pointer to **String** | Human-readable name of source for service desk integration template. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ServiceDeskSource = Initialize-PSSailpoint.V2024ServiceDeskSource -Type SOURCE ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name HR Active Directory +``` + +- Convert the resource to JSON +```powershell +$ServiceDeskSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SetIcon200Response.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SetIcon200Response.md new file mode 100644 index 000000000..e1ea555da --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SetIcon200Response.md @@ -0,0 +1,35 @@ +--- +id: v2024-set-icon200-response +title: SetIcon200Response +pagination_label: SetIcon200Response +sidebar_label: SetIcon200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SetIcon200Response', 'V2024SetIcon200Response'] +slug: /tools/sdk/powershell/v2024/models/set-icon200-response +tags: ['SDK', 'Software Development Kit', 'SetIcon200Response', 'V2024SetIcon200Response'] +--- + + +# SetIcon200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Icon** | Pointer to **String** | url to file with icon | [optional] + +## Examples + +- Prepare the resource +```powershell +$SetIcon200Response = Initialize-PSSailpoint.V2024SetIcon200Response -Icon +``` + +- Convert the resource to JSON +```powershell +$SetIcon200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SetIconRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SetIconRequest.md new file mode 100644 index 000000000..e2ec6f743 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SetIconRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-set-icon-request +title: SetIconRequest +pagination_label: SetIconRequest +sidebar_label: SetIconRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SetIconRequest', 'V2024SetIconRequest'] +slug: /tools/sdk/powershell/v2024/models/set-icon-request +tags: ['SDK', 'Software Development Kit', 'SetIconRequest', 'V2024SetIconRequest'] +--- + + +# SetIconRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Image** | **System.IO.FileInfo** | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] | [required] + +## Examples + +- Prepare the resource +```powershell +$SetIconRequest = Initialize-PSSailpoint.V2024SetIconRequest -Image \x00\x00\x00\x02 +``` + +- Convert the resource to JSON +```powershell +$SetIconRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SetLifecycleState200Response.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SetLifecycleState200Response.md new file mode 100644 index 000000000..f2f62e3a3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SetLifecycleState200Response.md @@ -0,0 +1,35 @@ +--- +id: v2024-set-lifecycle-state200-response +title: SetLifecycleState200Response +pagination_label: SetLifecycleState200Response +sidebar_label: SetLifecycleState200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SetLifecycleState200Response', 'V2024SetLifecycleState200Response'] +slug: /tools/sdk/powershell/v2024/models/set-lifecycle-state200-response +tags: ['SDK', 'Software Development Kit', 'SetLifecycleState200Response', 'V2024SetLifecycleState200Response'] +--- + + +# SetLifecycleState200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountActivityId** | Pointer to **String** | ID of the IdentityRequest object that is generated when the workflow launches. To follow the IdentityRequest, you can provide this ID with a [Get Account Activity request](https://developer.sailpoint.com/docs/api/v3/get-account-activity/). The response will contain relevant information about the IdentityRequest, such as its status. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SetLifecycleState200Response = Initialize-PSSailpoint.V2024SetLifecycleState200Response -AccountActivityId 2c9180837ab5b716017ab7c6c9ef1e20 +``` + +- Convert the resource to JSON +```powershell +$SetLifecycleState200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SetLifecycleStateRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SetLifecycleStateRequest.md new file mode 100644 index 000000000..8f4e0765f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SetLifecycleStateRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-set-lifecycle-state-request +title: SetLifecycleStateRequest +pagination_label: SetLifecycleStateRequest +sidebar_label: SetLifecycleStateRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SetLifecycleStateRequest', 'V2024SetLifecycleStateRequest'] +slug: /tools/sdk/powershell/v2024/models/set-lifecycle-state-request +tags: ['SDK', 'Software Development Kit', 'SetLifecycleStateRequest', 'V2024SetLifecycleStateRequest'] +--- + + +# SetLifecycleStateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LifecycleStateId** | Pointer to **String** | ID of the lifecycle state to set. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SetLifecycleStateRequest = Initialize-PSSailpoint.V2024SetLifecycleStateRequest -LifecycleStateId 2c9180877a86e408017a8c19fefe046c +``` + +- Convert the resource to JSON +```powershell +$SetLifecycleStateRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SimIntegrationDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SimIntegrationDetails.md new file mode 100644 index 000000000..9fab844a3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SimIntegrationDetails.md @@ -0,0 +1,57 @@ +--- +id: v2024-sim-integration-details +title: SimIntegrationDetails +pagination_label: SimIntegrationDetails +sidebar_label: SimIntegrationDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SimIntegrationDetails', 'V2024SimIntegrationDetails'] +slug: /tools/sdk/powershell/v2024/models/sim-integration-details +tags: ['SDK', 'Software Development Kit', 'SimIntegrationDetails', 'V2024SimIntegrationDetails'] +--- + + +# SimIntegrationDetails + +## Properties + +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] +**Description** | Pointer to **String** | The description of the integration | [optional] +**Type** | Pointer to **String** | The integration type | [optional] +**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The attributes map containing the credentials used to configure the integration. | [optional] +**Sources** | Pointer to **[]String** | The list of sources (managed resources) | [optional] +**Cluster** | Pointer to **String** | The cluster/proxy | [optional] +**StatusMap** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Custom mapping between the integration result and the provisioning result | [optional] +**Request** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Request data to customize desc and body of the created ticket | [optional] +**BeforeProvisioningRule** | Pointer to [**SimIntegrationDetailsAllOfBeforeProvisioningRule**](sim-integration-details-all-of-before-provisioning-rule) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SimIntegrationDetails = Initialize-PSSailpoint.V2024SimIntegrationDetails -Id id12345 ` + -Name aName ` + -Created 2023-01-03T21:16:22.432Z ` + -Modified 2023-01-03T21:16:22.432Z ` + -Description Integration description ` + -Type ServiceNow Service Desk ` + -Attributes {"uid":"Walter White","firstname":"walter","cloudStatus":"UNREGISTERED","displayName":"Walter White","identificationNumber":"942","lastSyncDate":1470348809380,"email":"walter@gmail.com","lastname":"white"} ` + -Sources [2c9180835d191a86015d28455b4a2329, 2c5680835d191a85765d28455b4a9823] ` + -Cluster xyzzy999 ` + -StatusMap {closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued} ` + -Request {description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId} ` + -BeforeProvisioningRule null +``` + +- Convert the resource to JSON +```powershell +$SimIntegrationDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SimIntegrationDetailsAllOfBeforeProvisioningRule.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SimIntegrationDetailsAllOfBeforeProvisioningRule.md new file mode 100644 index 000000000..e982a69a4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SimIntegrationDetailsAllOfBeforeProvisioningRule.md @@ -0,0 +1,39 @@ +--- +id: v2024-sim-integration-details-all-of-before-provisioning-rule +title: SimIntegrationDetailsAllOfBeforeProvisioningRule +pagination_label: SimIntegrationDetailsAllOfBeforeProvisioningRule +sidebar_label: SimIntegrationDetailsAllOfBeforeProvisioningRule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SimIntegrationDetailsAllOfBeforeProvisioningRule', 'V2024SimIntegrationDetailsAllOfBeforeProvisioningRule'] +slug: /tools/sdk/powershell/v2024/models/sim-integration-details-all-of-before-provisioning-rule +tags: ['SDK', 'Software Development Kit', 'SimIntegrationDetailsAllOfBeforeProvisioningRule', 'V2024SimIntegrationDetailsAllOfBeforeProvisioningRule'] +--- + + +# SimIntegrationDetailsAllOfBeforeProvisioningRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **String** | ID of the rule | [optional] +**Name** | Pointer to **String** | Human-readable display name of the rule | [optional] + +## Examples + +- Prepare the resource +```powershell +$SimIntegrationDetailsAllOfBeforeProvisioningRule = Initialize-PSSailpoint.V2024SimIntegrationDetailsAllOfBeforeProvisioningRule -Type null ` + -Id 2c918085708c274401708c2a8a760001 ` + -Name Example Rule +``` + +- Convert the resource to JSON +```powershell +$SimIntegrationDetailsAllOfBeforeProvisioningRule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SlimCampaign.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SlimCampaign.md new file mode 100644 index 000000000..858dfd574 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SlimCampaign.md @@ -0,0 +1,61 @@ +--- +id: v2024-slim-campaign +title: SlimCampaign +pagination_label: SlimCampaign +sidebar_label: SlimCampaign +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SlimCampaign', 'V2024SlimCampaign'] +slug: /tools/sdk/powershell/v2024/models/slim-campaign +tags: ['SDK', 'Software Development Kit', 'SlimCampaign', 'V2024SlimCampaign'] +--- + + +# SlimCampaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the campaign | [optional] [readonly] +**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Deadline** | Pointer to **System.DateTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required] +**EmailNotificationEnabled** | Pointer to **Boolean** | Enables email notification for this campaign | [optional] [default to $false] +**AutoRevokeAllowed** | Pointer to **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] +**RecommendationsEnabled** | Pointer to **Boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to $false] +**Status** | Pointer to **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **System.DateTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **Int32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$SlimCampaign = Initialize-PSSailpoint.V2024SlimCampaign -Id 2c9079b270a266a60170a2779fcb0007 ` + -Name Manager Campaign ` + -Description Everyone needs to be reviewed by their manager ` + -Deadline 2020-03-15T10:00:01.456Z ` + -Type MANAGER ` + -EmailNotificationEnabled false ` + -AutoRevokeAllowed false ` + -RecommendationsEnabled true ` + -Status ACTIVE ` + -CorrelatedStatus CORRELATED ` + -Created 2020-03-03T22:15:13.611Z ` + -TotalCertifications 100 ` + -CompletedCertifications 10 ` + -Alerts null +``` + +- Convert the resource to JSON +```powershell +$SlimCampaign | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SlimDiscoveredApplications.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SlimDiscoveredApplications.md new file mode 100644 index 000000000..7986b713e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SlimDiscoveredApplications.md @@ -0,0 +1,51 @@ +--- +id: v2024-slim-discovered-applications +title: SlimDiscoveredApplications +pagination_label: SlimDiscoveredApplications +sidebar_label: SlimDiscoveredApplications +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SlimDiscoveredApplications', 'V2024SlimDiscoveredApplications'] +slug: /tools/sdk/powershell/v2024/models/slim-discovered-applications +tags: ['SDK', 'Software Development Kit', 'SlimDiscoveredApplications', 'V2024SlimDiscoveredApplications'] +--- + + +# SlimDiscoveredApplications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Unique identifier for the discovered application. | [optional] +**Name** | Pointer to **String** | Name of the discovered application. | [optional] +**DiscoverySource** | Pointer to **String** | Source from which the application was discovered. | [optional] +**DiscoveredVendor** | Pointer to **String** | The vendor associated with the discovered application. | [optional] +**Description** | Pointer to **String** | A brief description of the discovered application. | [optional] +**RecommendedConnectors** | Pointer to **[]String** | List of recommended connectors for the application. | [optional] +**DiscoveredAt** | Pointer to **System.DateTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**CreatedAt** | Pointer to **System.DateTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**Status** | Pointer to **String** | The status of an application within the discovery source. By default this field is set to ""ACTIVE"" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to ""INACTIVE"". | [optional] + +## Examples + +- Prepare the resource +```powershell +$SlimDiscoveredApplications = Initialize-PSSailpoint.V2024SlimDiscoveredApplications -Id null ` + -Name ExampleApp ` + -DiscoverySource csv ` + -DiscoveredVendor ExampleVendor ` + -Description An application for managing examples. ` + -RecommendedConnectors [ConnectorA, ConnectorB] ` + -DiscoveredAt 2023-01-01T12:00Z ` + -CreatedAt 2023-01-01T12:00Z ` + -Status ACTIVE +``` + +- Convert the resource to JSON +```powershell +$SlimDiscoveredApplications | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodExemptCriteria.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodExemptCriteria.md new file mode 100644 index 000000000..5f9c01eb3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodExemptCriteria.md @@ -0,0 +1,41 @@ +--- +id: v2024-sod-exempt-criteria +title: SodExemptCriteria +pagination_label: SodExemptCriteria +sidebar_label: SodExemptCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodExemptCriteria', 'V2024SodExemptCriteria'] +slug: /tools/sdk/powershell/v2024/models/sod-exempt-criteria +tags: ['SDK', 'Software Development Kit', 'SodExemptCriteria', 'V2024SodExemptCriteria'] +--- + + +# SodExemptCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Existing** | Pointer to **Boolean** | If the entitlement already belonged to the user or not. | [optional] [default to $false] +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **String** | Entitlement ID | [optional] +**Name** | Pointer to **String** | Entitlement name | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodExemptCriteria = Initialize-PSSailpoint.V2024SodExemptCriteria -Existing true ` + -Type null ` + -Id 2c918085771e9d3301773b3cb66f6398 ` + -Name My HR Entitlement +``` + +- Convert the resource to JSON +```powershell +$SodExemptCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodExemptCriteria1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodExemptCriteria1.md new file mode 100644 index 000000000..a9f6615dd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodExemptCriteria1.md @@ -0,0 +1,41 @@ +--- +id: v2024-sod-exempt-criteria1 +title: SodExemptCriteria1 +pagination_label: SodExemptCriteria1 +sidebar_label: SodExemptCriteria1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodExemptCriteria1', 'V2024SodExemptCriteria1'] +slug: /tools/sdk/powershell/v2024/models/sod-exempt-criteria1 +tags: ['SDK', 'Software Development Kit', 'SodExemptCriteria1', 'V2024SodExemptCriteria1'] +--- + + +# SodExemptCriteria1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Existing** | Pointer to **Boolean** | If the entitlement already belonged to the user or not. | [optional] [default to $false] +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **String** | Entitlement ID | [optional] +**Name** | Pointer to **String** | Entitlement name | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodExemptCriteria1 = Initialize-PSSailpoint.V2024SodExemptCriteria1 -Existing true ` + -Type null ` + -Id 2c918085771e9d3301773b3cb66f6398 ` + -Name My HR Entitlement +``` + +- Convert the resource to JSON +```powershell +$SodExemptCriteria1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodPolicy.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodPolicy.md new file mode 100644 index 000000000..bdc7c7476 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodPolicy.md @@ -0,0 +1,69 @@ +--- +id: v2024-sod-policy +title: SodPolicy +pagination_label: SodPolicy +sidebar_label: SodPolicy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicy', 'V2024SodPolicy'] +slug: /tools/sdk/powershell/v2024/models/sod-policy +tags: ['SDK', 'Software Development Kit', 'SodPolicy', 'V2024SodPolicy'] +--- + + +# SodPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Policy id | [optional] [readonly] +**Name** | Pointer to **String** | Policy Business Name | [optional] +**Created** | Pointer to **System.DateTime** | The time when this SOD policy is created. | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | The time when this SOD policy is modified. | [optional] [readonly] +**Description** | Pointer to **String** | Optional description of the SOD policy | [optional] +**OwnerRef** | Pointer to [**SodPolicyOwnerRef**](sod-policy-owner-ref) | | [optional] +**ExternalPolicyReference** | Pointer to **String** | Optional External Policy Reference | [optional] +**PolicyQuery** | Pointer to **String** | Search query of the SOD policy | [optional] +**CompensatingControls** | Pointer to **String** | Optional compensating controls(Mitigating Controls) | [optional] +**CorrectionAdvice** | Pointer to **String** | Optional correction advice | [optional] +**State** | Pointer to **Enum** [ "ENFORCED", "NOT_ENFORCED" ] | whether the policy is enforced or not | [optional] +**Tags** | Pointer to **[]String** | tags for this policy object | [optional] +**CreatorId** | Pointer to **String** | Policy's creator ID | [optional] [readonly] +**ModifierId** | Pointer to **String** | Policy's modifier ID | [optional] [readonly] +**ViolationOwnerAssignmentConfig** | Pointer to [**ViolationOwnerAssignmentConfig**](violation-owner-assignment-config) | | [optional] +**Scheduled** | Pointer to **Boolean** | defines whether a policy has been scheduled or not | [optional] [default to $false] +**Type** | Pointer to **Enum** [ "GENERAL", "CONFLICTING_ACCESS_BASED" ] | whether a policy is query based or conflicting access based | [optional] [default to "GENERAL"] +**ConflictingAccessCriteria** | Pointer to [**SodPolicyConflictingAccessCriteria**](sod-policy-conflicting-access-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodPolicy = Initialize-PSSailpoint.V2024SodPolicy -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -Name policy-xyz ` + -Created 2020-01-01T00:00Z ` + -Modified 2020-01-01T00:00Z ` + -Description This policy ensures compliance of xyz ` + -OwnerRef null ` + -ExternalPolicyReference XYZ policy ` + -PolicyQuery @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf) ` + -CompensatingControls Have a manager review the transaction decisions for their "out of compliance" employee ` + -CorrectionAdvice Based on the role of the employee, managers should remove access that is not required for their job function. ` + -State ENFORCED ` + -Tags [TAG1, TAG2] ` + -CreatorId 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -ModifierId 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -ViolationOwnerAssignmentConfig null ` + -Scheduled true ` + -Type GENERAL ` + -ConflictingAccessCriteria null +``` + +- Convert the resource to JSON +```powershell +$SodPolicy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodPolicyConflictingAccessCriteria.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodPolicyConflictingAccessCriteria.md new file mode 100644 index 000000000..b2ee50bb8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodPolicyConflictingAccessCriteria.md @@ -0,0 +1,37 @@ +--- +id: v2024-sod-policy-conflicting-access-criteria +title: SodPolicyConflictingAccessCriteria +pagination_label: SodPolicyConflictingAccessCriteria +sidebar_label: SodPolicyConflictingAccessCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicyConflictingAccessCriteria', 'V2024SodPolicyConflictingAccessCriteria'] +slug: /tools/sdk/powershell/v2024/models/sod-policy-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodPolicyConflictingAccessCriteria', 'V2024SodPolicyConflictingAccessCriteria'] +--- + + +# SodPolicyConflictingAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] +**RightCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodPolicyConflictingAccessCriteria = Initialize-PSSailpoint.V2024SodPolicyConflictingAccessCriteria -LeftCriteria null ` + -RightCriteria null +``` + +- Convert the resource to JSON +```powershell +$SodPolicyConflictingAccessCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodPolicyDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodPolicyDto.md new file mode 100644 index 000000000..b78ae41c1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodPolicyDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-sod-policy-dto +title: SodPolicyDto +pagination_label: SodPolicyDto +sidebar_label: SodPolicyDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicyDto', 'V2024SodPolicyDto'] +slug: /tools/sdk/powershell/v2024/models/sod-policy-dto +tags: ['SDK', 'Software Development Kit', 'SodPolicyDto', 'V2024SodPolicyDto'] +--- + + +# SodPolicyDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "SOD_POLICY" ] | SOD policy DTO type. | [optional] +**Id** | Pointer to **String** | SOD policy ID. | [optional] +**Name** | Pointer to **String** | SOD policy display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodPolicyDto = Initialize-PSSailpoint.V2024SodPolicyDto -Type SOD_POLICY ` + -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -Name Business SOD Policy +``` + +- Convert the resource to JSON +```powershell +$SodPolicyDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodPolicyOwnerRef.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodPolicyOwnerRef.md new file mode 100644 index 000000000..b7008292d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodPolicyOwnerRef.md @@ -0,0 +1,39 @@ +--- +id: v2024-sod-policy-owner-ref +title: SodPolicyOwnerRef +pagination_label: SodPolicyOwnerRef +sidebar_label: SodPolicyOwnerRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicyOwnerRef', 'V2024SodPolicyOwnerRef'] +slug: /tools/sdk/powershell/v2024/models/sod-policy-owner-ref +tags: ['SDK', 'Software Development Kit', 'SodPolicyOwnerRef', 'V2024SodPolicyOwnerRef'] +--- + + +# SodPolicyOwnerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY", "GOVERNANCE_GROUP" ] | Owner type. | [optional] +**Id** | Pointer to **String** | Owner's ID. | [optional] +**Name** | Pointer to **String** | Owner's name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodPolicyOwnerRef = Initialize-PSSailpoint.V2024SodPolicyOwnerRef -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Support +``` + +- Convert the resource to JSON +```powershell +$SodPolicyOwnerRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodPolicySchedule.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodPolicySchedule.md new file mode 100644 index 000000000..ffce2633b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodPolicySchedule.md @@ -0,0 +1,51 @@ +--- +id: v2024-sod-policy-schedule +title: SodPolicySchedule +pagination_label: SodPolicySchedule +sidebar_label: SodPolicySchedule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicySchedule', 'V2024SodPolicySchedule'] +slug: /tools/sdk/powershell/v2024/models/sod-policy-schedule +tags: ['SDK', 'Software Development Kit', 'SodPolicySchedule', 'V2024SodPolicySchedule'] +--- + + +# SodPolicySchedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | SOD Policy schedule name | [optional] +**Created** | Pointer to **System.DateTime** | The time when this SOD policy schedule is created. | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | The time when this SOD policy schedule is modified. | [optional] [readonly] +**Description** | Pointer to **String** | SOD Policy schedule description | [optional] +**Schedule** | Pointer to [**Schedule2**](schedule2) | | [optional] +**Recipients** | Pointer to [**[]SodRecipient**](sod-recipient) | | [optional] +**EmailEmptyResults** | Pointer to **Boolean** | Indicates if empty results need to be emailed | [optional] [default to $false] +**CreatorId** | Pointer to **String** | Policy's creator ID | [optional] [readonly] +**ModifierId** | Pointer to **String** | Policy's modifier ID | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$SodPolicySchedule = Initialize-PSSailpoint.V2024SodPolicySchedule -Name SCH-1584312283015 ` + -Created 2020-01-01T00:00Z ` + -Modified 2020-01-01T00:00Z ` + -Description Schedule for policy xyz ` + -Schedule null ` + -Recipients null ` + -EmailEmptyResults false ` + -CreatorId 0f11f2a47c944bf3a2bd742580fe3bde ` + -ModifierId 0f11f2a47c944bf3a2bd742580fe3bde +``` + +- Convert the resource to JSON +```powershell +$SodPolicySchedule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodRecipient.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodRecipient.md new file mode 100644 index 000000000..a9290f1ea --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodRecipient.md @@ -0,0 +1,39 @@ +--- +id: v2024-sod-recipient +title: SodRecipient +pagination_label: SodRecipient +sidebar_label: SodRecipient +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodRecipient', 'V2024SodRecipient'] +slug: /tools/sdk/powershell/v2024/models/sod-recipient +tags: ['SDK', 'Software Development Kit', 'SodRecipient', 'V2024SodRecipient'] +--- + + +# SodRecipient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | SOD policy recipient DTO type. | [optional] +**Id** | Pointer to **String** | SOD policy recipient's identity ID. | [optional] +**Name** | Pointer to **String** | SOD policy recipient's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodRecipient = Initialize-PSSailpoint.V2024SodRecipient -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$SodRecipient | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodReportResultDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodReportResultDto.md new file mode 100644 index 000000000..333bb4ad8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodReportResultDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-sod-report-result-dto +title: SodReportResultDto +pagination_label: SodReportResultDto +sidebar_label: SodReportResultDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodReportResultDto', 'V2024SodReportResultDto'] +slug: /tools/sdk/powershell/v2024/models/sod-report-result-dto +tags: ['SDK', 'Software Development Kit', 'SodReportResultDto', 'V2024SodReportResultDto'] +--- + + +# SodReportResultDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "REPORT_RESULT" ] | SOD policy violation report result DTO type. | [optional] +**Id** | Pointer to **String** | SOD policy violation report result ID. | [optional] +**Name** | Pointer to **String** | Human-readable name of the SOD policy violation report result. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodReportResultDto = Initialize-PSSailpoint.V2024SodReportResultDto -Type REPORT_RESULT ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name SOD Policy 1 Violation +``` + +- Convert the resource to JSON +```powershell +$SodReportResultDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationCheck.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationCheck.md new file mode 100644 index 000000000..3587a7cd8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationCheck.md @@ -0,0 +1,37 @@ +--- +id: v2024-sod-violation-check +title: SodViolationCheck +pagination_label: SodViolationCheck +sidebar_label: SodViolationCheck +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationCheck', 'V2024SodViolationCheck'] +slug: /tools/sdk/powershell/v2024/models/sod-violation-check +tags: ['SDK', 'Software Development Kit', 'SodViolationCheck', 'V2024SodViolationCheck'] +--- + + +# SodViolationCheck + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | **String** | The id of the original request | [required] +**Created** | Pointer to **System.DateTime** | The date-time when this request was created. | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$SodViolationCheck = Initialize-PSSailpoint.V2024SodViolationCheck -RequestId 089899f13a8f4da7824996191587bab9 ` + -Created 2020-01-01T00:00Z +``` + +- Convert the resource to JSON +```powershell +$SodViolationCheck | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationCheckResult.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationCheckResult.md new file mode 100644 index 000000000..45b023228 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationCheckResult.md @@ -0,0 +1,41 @@ +--- +id: v2024-sod-violation-check-result +title: SodViolationCheckResult +pagination_label: SodViolationCheckResult +sidebar_label: SodViolationCheckResult +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationCheckResult', 'V2024SodViolationCheckResult'] +slug: /tools/sdk/powershell/v2024/models/sod-violation-check-result +tags: ['SDK', 'Software Development Kit', 'SodViolationCheckResult', 'V2024SodViolationCheckResult'] +--- + + +# SodViolationCheckResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to [**ErrorMessageDto**](error-message-dto) | | [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 completion of the violation check. | [optional] +**ViolationContexts** | Pointer to [**[]SodViolationContext**](sod-violation-context) | | [optional] +**ViolatedPolicies** | Pointer to [**[]SodPolicyDto**](sod-policy-dto) | A list of the SOD policies that were violated. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationCheckResult = Initialize-PSSailpoint.V2024SodViolationCheckResult -Message null ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -ViolationContexts null ` + -ViolatedPolicies null +``` + +- Convert the resource to JSON +```powershell +$SodViolationCheckResult | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationCheckResult1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationCheckResult1.md new file mode 100644 index 000000000..db8f57f79 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationCheckResult1.md @@ -0,0 +1,41 @@ +--- +id: v2024-sod-violation-check-result1 +title: SodViolationCheckResult1 +pagination_label: SodViolationCheckResult1 +sidebar_label: SodViolationCheckResult1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationCheckResult1', 'V2024SodViolationCheckResult1'] +slug: /tools/sdk/powershell/v2024/models/sod-violation-check-result1 +tags: ['SDK', 'Software Development Kit', 'SodViolationCheckResult1', 'V2024SodViolationCheckResult1'] +--- + + +# SodViolationCheckResult1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to [**ErrorMessageDto1**](error-message-dto1) | | [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 completion of the violation check. | [optional] +**ViolationContexts** | Pointer to [**[]SodViolationContext1**](sod-violation-context1) | | [optional] +**ViolatedPolicies** | Pointer to [**[]SodPolicyDto**](sod-policy-dto) | A list of the SOD policies that were violated. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationCheckResult1 = Initialize-PSSailpoint.V2024SodViolationCheckResult1 -Message null ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -ViolationContexts null ` + -ViolatedPolicies null +``` + +- Convert the resource to JSON +```powershell +$SodViolationCheckResult1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationContext.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationContext.md new file mode 100644 index 000000000..3d7fe306e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationContext.md @@ -0,0 +1,37 @@ +--- +id: v2024-sod-violation-context +title: SodViolationContext +pagination_label: SodViolationContext +sidebar_label: SodViolationContext +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContext', 'V2024SodViolationContext'] +slug: /tools/sdk/powershell/v2024/models/sod-violation-context +tags: ['SDK', 'Software Development Kit', 'SodViolationContext', 'V2024SodViolationContext'] +--- + + +# SodViolationContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policy** | Pointer to [**SodPolicyDto**](sod-policy-dto) | | [optional] +**ConflictingAccessCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteria**](sod-violation-context-conflicting-access-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationContext = Initialize-PSSailpoint.V2024SodViolationContext -Policy null ` + -ConflictingAccessCriteria null +``` + +- Convert the resource to JSON +```powershell +$SodViolationContext | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationContext1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationContext1.md new file mode 100644 index 000000000..93ac1f0d7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationContext1.md @@ -0,0 +1,37 @@ +--- +id: v2024-sod-violation-context1 +title: SodViolationContext1 +pagination_label: SodViolationContext1 +sidebar_label: SodViolationContext1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContext1', 'V2024SodViolationContext1'] +slug: /tools/sdk/powershell/v2024/models/sod-violation-context1 +tags: ['SDK', 'Software Development Kit', 'SodViolationContext1', 'V2024SodViolationContext1'] +--- + + +# SodViolationContext1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policy** | Pointer to [**SodPolicyDto**](sod-policy-dto) | | [optional] +**ConflictingAccessCriteria** | Pointer to [**SodViolationContext1ConflictingAccessCriteria**](sod-violation-context1-conflicting-access-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationContext1 = Initialize-PSSailpoint.V2024SodViolationContext1 -Policy null ` + -ConflictingAccessCriteria null +``` + +- Convert the resource to JSON +```powershell +$SodViolationContext1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationContext1ConflictingAccessCriteria.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationContext1ConflictingAccessCriteria.md new file mode 100644 index 000000000..b16da7779 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationContext1ConflictingAccessCriteria.md @@ -0,0 +1,37 @@ +--- +id: v2024-sod-violation-context1-conflicting-access-criteria +title: SodViolationContext1ConflictingAccessCriteria +pagination_label: SodViolationContext1ConflictingAccessCriteria +sidebar_label: SodViolationContext1ConflictingAccessCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContext1ConflictingAccessCriteria', 'V2024SodViolationContext1ConflictingAccessCriteria'] +slug: /tools/sdk/powershell/v2024/models/sod-violation-context1-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContext1ConflictingAccessCriteria', 'V2024SodViolationContext1ConflictingAccessCriteria'] +--- + + +# SodViolationContext1ConflictingAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**SodViolationContext1ConflictingAccessCriteriaLeftCriteria**](sod-violation-context1-conflicting-access-criteria-left-criteria) | | [optional] +**RightCriteria** | Pointer to [**SodViolationContext1ConflictingAccessCriteriaLeftCriteria**](sod-violation-context1-conflicting-access-criteria-left-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationContext1ConflictingAccessCriteria = Initialize-PSSailpoint.V2024SodViolationContext1ConflictingAccessCriteria -LeftCriteria null ` + -RightCriteria null +``` + +- Convert the resource to JSON +```powershell +$SodViolationContext1ConflictingAccessCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationContext1ConflictingAccessCriteriaLeftCriteria.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationContext1ConflictingAccessCriteriaLeftCriteria.md new file mode 100644 index 000000000..7ba610459 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationContext1ConflictingAccessCriteriaLeftCriteria.md @@ -0,0 +1,35 @@ +--- +id: v2024-sod-violation-context1-conflicting-access-criteria-left-criteria +title: SodViolationContext1ConflictingAccessCriteriaLeftCriteria +pagination_label: SodViolationContext1ConflictingAccessCriteriaLeftCriteria +sidebar_label: SodViolationContext1ConflictingAccessCriteriaLeftCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContext1ConflictingAccessCriteriaLeftCriteria', 'V2024SodViolationContext1ConflictingAccessCriteriaLeftCriteria'] +slug: /tools/sdk/powershell/v2024/models/sod-violation-context1-conflicting-access-criteria-left-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContext1ConflictingAccessCriteriaLeftCriteria', 'V2024SodViolationContext1ConflictingAccessCriteriaLeftCriteria'] +--- + + +# SodViolationContext1ConflictingAccessCriteriaLeftCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CriteriaList** | Pointer to [**[]SodExemptCriteria1**](sod-exempt-criteria1) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationContext1ConflictingAccessCriteriaLeftCriteria = Initialize-PSSailpoint.V2024SodViolationContext1ConflictingAccessCriteriaLeftCriteria -CriteriaList null +``` + +- Convert the resource to JSON +```powershell +$SodViolationContext1ConflictingAccessCriteriaLeftCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationContextCheckCompleted.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationContextCheckCompleted.md new file mode 100644 index 000000000..d2dcb73d3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationContextCheckCompleted.md @@ -0,0 +1,39 @@ +--- +id: v2024-sod-violation-context-check-completed +title: SodViolationContextCheckCompleted +pagination_label: SodViolationContextCheckCompleted +sidebar_label: SodViolationContextCheckCompleted +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContextCheckCompleted', 'V2024SodViolationContextCheckCompleted'] +slug: /tools/sdk/powershell/v2024/models/sod-violation-context-check-completed +tags: ['SDK', 'Software Development Kit', 'SodViolationContextCheckCompleted', 'V2024SodViolationContextCheckCompleted'] +--- + + +# SodViolationContextCheckCompleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **Enum** [ "SUCCESS", "ERROR" ] | The status of SOD violation check | [optional] +**Uuid** | Pointer to **String** | The id of the Violation check event | [optional] +**ViolationCheckResult** | Pointer to [**SodViolationCheckResult**](sod-violation-check-result) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationContextCheckCompleted = Initialize-PSSailpoint.V2024SodViolationContextCheckCompleted -State SUCCESS ` + -Uuid f73d16e9-a038-46c5-b217-1246e15fdbdd ` + -ViolationCheckResult null +``` + +- Convert the resource to JSON +```powershell +$SodViolationContextCheckCompleted | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationContextCheckCompleted1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationContextCheckCompleted1.md new file mode 100644 index 000000000..cdcea3295 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationContextCheckCompleted1.md @@ -0,0 +1,39 @@ +--- +id: v2024-sod-violation-context-check-completed1 +title: SodViolationContextCheckCompleted1 +pagination_label: SodViolationContextCheckCompleted1 +sidebar_label: SodViolationContextCheckCompleted1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContextCheckCompleted1', 'V2024SodViolationContextCheckCompleted1'] +slug: /tools/sdk/powershell/v2024/models/sod-violation-context-check-completed1 +tags: ['SDK', 'Software Development Kit', 'SodViolationContextCheckCompleted1', 'V2024SodViolationContextCheckCompleted1'] +--- + + +# SodViolationContextCheckCompleted1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **Enum** [ "SUCCESS", "ERROR" ] | The status of SOD violation check | [optional] +**Uuid** | Pointer to **String** | The id of the Violation check event | [optional] +**ViolationCheckResult** | Pointer to [**SodViolationCheckResult1**](sod-violation-check-result1) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationContextCheckCompleted1 = Initialize-PSSailpoint.V2024SodViolationContextCheckCompleted1 -State SUCCESS ` + -Uuid f73d16e9-a038-46c5-b217-1246e15fdbdd ` + -ViolationCheckResult null +``` + +- Convert the resource to JSON +```powershell +$SodViolationContextCheckCompleted1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationContextConflictingAccessCriteria.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationContextConflictingAccessCriteria.md new file mode 100644 index 000000000..48142f21f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationContextConflictingAccessCriteria.md @@ -0,0 +1,37 @@ +--- +id: v2024-sod-violation-context-conflicting-access-criteria +title: SodViolationContextConflictingAccessCriteria +pagination_label: SodViolationContextConflictingAccessCriteria +sidebar_label: SodViolationContextConflictingAccessCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContextConflictingAccessCriteria', 'V2024SodViolationContextConflictingAccessCriteria'] +slug: /tools/sdk/powershell/v2024/models/sod-violation-context-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContextConflictingAccessCriteria', 'V2024SodViolationContextConflictingAccessCriteria'] +--- + + +# SodViolationContextConflictingAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteriaLeftCriteria**](sod-violation-context-conflicting-access-criteria-left-criteria) | | [optional] +**RightCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteriaLeftCriteria**](sod-violation-context-conflicting-access-criteria-left-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationContextConflictingAccessCriteria = Initialize-PSSailpoint.V2024SodViolationContextConflictingAccessCriteria -LeftCriteria null ` + -RightCriteria null +``` + +- Convert the resource to JSON +```powershell +$SodViolationContextConflictingAccessCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md new file mode 100644 index 000000000..d87c424ce --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md @@ -0,0 +1,35 @@ +--- +id: v2024-sod-violation-context-conflicting-access-criteria-left-criteria +title: SodViolationContextConflictingAccessCriteriaLeftCriteria +pagination_label: SodViolationContextConflictingAccessCriteriaLeftCriteria +sidebar_label: SodViolationContextConflictingAccessCriteriaLeftCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContextConflictingAccessCriteriaLeftCriteria', 'V2024SodViolationContextConflictingAccessCriteriaLeftCriteria'] +slug: /tools/sdk/powershell/v2024/models/sod-violation-context-conflicting-access-criteria-left-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContextConflictingAccessCriteriaLeftCriteria', 'V2024SodViolationContextConflictingAccessCriteriaLeftCriteria'] +--- + + +# SodViolationContextConflictingAccessCriteriaLeftCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CriteriaList** | Pointer to [**[]SodExemptCriteria**](sod-exempt-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationContextConflictingAccessCriteriaLeftCriteria = Initialize-PSSailpoint.V2024SodViolationContextConflictingAccessCriteriaLeftCriteria -CriteriaList null +``` + +- Convert the resource to JSON +```powershell +$SodViolationContextConflictingAccessCriteriaLeftCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Source.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Source.md new file mode 100644 index 000000000..aa4a1131c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Source.md @@ -0,0 +1,95 @@ +--- +id: v2024-source +title: Source +pagination_label: Source +sidebar_label: Source +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Source', 'V2024Source'] +slug: /tools/sdk/powershell/v2024/models/source +tags: ['SDK', 'Software Development Kit', 'Source', 'V2024Source'] +--- + + +# Source + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Source ID. | [optional] [readonly] +**Name** | **String** | Source's human-readable name. | [required] +**Description** | Pointer to **String** | Source's human-readable description. | [optional] +**Owner** | [**SourceOwner**](source-owner) | | [required] +**Cluster** | Pointer to [**SourceCluster**](source-cluster) | | [optional] +**AccountCorrelationConfig** | Pointer to [**SourceAccountCorrelationConfig**](source-account-correlation-config) | | [optional] +**AccountCorrelationRule** | Pointer to [**SourceAccountCorrelationRule**](source-account-correlation-rule) | | [optional] +**ManagerCorrelationMapping** | Pointer to [**SourceManagerCorrelationMapping**](source-manager-correlation-mapping) | | [optional] +**ManagerCorrelationRule** | Pointer to [**SourceManagerCorrelationRule**](source-manager-correlation-rule) | | [optional] +**BeforeProvisioningRule** | Pointer to [**SourceBeforeProvisioningRule**](source-before-provisioning-rule) | | [optional] +**Schemas** | Pointer to [**[]SourceSchemasInner**](source-schemas-inner) | List of references to schema objects. | [optional] +**PasswordPolicies** | Pointer to [**[]SourcePasswordPoliciesInner**](source-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional] +**Features** | Pointer to **[]String** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**Type** | Pointer to **String** | Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional] +**Connector** | **String** | Connector script name. | [required] +**ConnectorClass** | Pointer to **String** | Fully qualified name of the Java class that implements the connector interface. | [optional] +**ConnectorAttributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Connector specific configuration. This configuration will differ from type to type. | [optional] +**DeleteThreshold** | Pointer to **Int32** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional] +**Authoritative** | Pointer to **Boolean** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to $false] +**ManagementWorkgroup** | Pointer to [**SourceManagementWorkgroup**](source-management-workgroup) | | [optional] +**Healthy** | Pointer to **Boolean** | When this is true, it indicates that the source is healthy. | [optional] [default to $false] +**Status** | Pointer to **Enum** [ "SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT", "SOURCE_STATE_ERROR_CLUSTER", "SOURCE_STATE_ERROR_SOURCE", "SOURCE_STATE_ERROR_VA", "SOURCE_STATE_FAILURE_CLUSTER", "SOURCE_STATE_FAILURE_SOURCE", "SOURCE_STATE_HEALTHY", "SOURCE_STATE_UNCHECKED_CLUSTER", "SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES", "SOURCE_STATE_UNCHECKED_SOURCE", "SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS" ] | Status identifier that gives specific information about why a source is or isn't healthy. | [optional] +**Since** | Pointer to **String** | Timestamp that shows when a source health check was last performed. | [optional] +**ConnectorId** | Pointer to **String** | Connector ID | [optional] +**ConnectorName** | Pointer to **String** | Name of the connector that was chosen during source creation. | [optional] +**ConnectionType** | Pointer to **String** | Type of connection (direct or file). | [optional] +**ConnectorImplementationId** | Pointer to **String** | Connector implementation ID. | [optional] +**Created** | Pointer to **System.DateTime** | Date-time when the source was created | [optional] +**Modified** | Pointer to **System.DateTime** | Date-time when the source was last modified. | [optional] +**CredentialProviderEnabled** | Pointer to **Boolean** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to $false] +**Category** | Pointer to **String** | Source category (e.g. null, CredentialProvider). | [optional] + +## Examples + +- Prepare the resource +```powershell +$Source = Initialize-PSSailpoint.V2024Source -Id 2c91808568c529c60168cca6f90c1324 ` + -Name My Source ` + -Description This is the corporate directory. ` + -Owner null ` + -Cluster null ` + -AccountCorrelationConfig null ` + -AccountCorrelationRule null ` + -ManagerCorrelationMapping null ` + -ManagerCorrelationRule null ` + -BeforeProvisioningRule null ` + -Schemas [{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}] ` + -PasswordPolicies [{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}] ` + -Features [PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS] ` + -Type OpenLDAP - Direct ` + -Connector active-directory ` + -ConnectorClass sailpoint.connector.LDAPConnector ` + -ConnectorAttributes {healthCheckTimeout=30, authSearchAttributes=[cn, uid, mail]} ` + -DeleteThreshold 10 ` + -Authoritative false ` + -ManagementWorkgroup null ` + -Healthy true ` + -Status SOURCE_STATE_HEALTHY ` + -Since 2021-09-28T15:48:29.3801666300Z ` + -ConnectorId active-directory ` + -ConnectorName Active Directory ` + -ConnectionType file ` + -ConnectorImplementationId delimited-file ` + -Created 2022-02-08T14:50:03.827Z ` + -Modified 2024-01-23T18:08:50.897Z ` + -CredentialProviderEnabled false ` + -Category CredentialProvider +``` + +- Convert the resource to JSON +```powershell +$Source | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Source1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Source1.md new file mode 100644 index 000000000..95f5cfeda --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Source1.md @@ -0,0 +1,37 @@ +--- +id: v2024-source1 +title: Source1 +pagination_label: Source1 +sidebar_label: Source1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Source1', 'V2024Source1'] +slug: /tools/sdk/powershell/v2024/models/source1 +tags: ['SDK', 'Software Development Kit', 'Source1', 'V2024Source1'] +--- + + +# Source1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **String** | Attribute mapping type. | [optional] +**Properties** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Attribute mapping properties. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Source1 = Initialize-PSSailpoint.V2024Source1 -Type rule ` + -Properties {ruleType=IdentityAttribute, ruleName=Cloud Promote Identity Attribute} +``` + +- Convert the resource to JSON +```powershell +$Source1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAccountCorrelationConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAccountCorrelationConfig.md new file mode 100644 index 000000000..91f62214e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAccountCorrelationConfig.md @@ -0,0 +1,39 @@ +--- +id: v2024-source-account-correlation-config +title: SourceAccountCorrelationConfig +pagination_label: SourceAccountCorrelationConfig +sidebar_label: SourceAccountCorrelationConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAccountCorrelationConfig', 'V2024SourceAccountCorrelationConfig'] +slug: /tools/sdk/powershell/v2024/models/source-account-correlation-config +tags: ['SDK', 'Software Development Kit', 'SourceAccountCorrelationConfig', 'V2024SourceAccountCorrelationConfig'] +--- + + +# SourceAccountCorrelationConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ACCOUNT_CORRELATION_CONFIG" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Account correlation config ID. | [optional] +**Name** | Pointer to **String** | Account correlation config's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceAccountCorrelationConfig = Initialize-PSSailpoint.V2024SourceAccountCorrelationConfig -Type ACCOUNT_CORRELATION_CONFIG ` + -Id 2c9180855d191c59015d28583727245a ` + -Name Directory [source-62867] Account Correlation +``` + +- Convert the resource to JSON +```powershell +$SourceAccountCorrelationConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAccountCorrelationRule.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAccountCorrelationRule.md new file mode 100644 index 000000000..8ffd08800 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAccountCorrelationRule.md @@ -0,0 +1,39 @@ +--- +id: v2024-source-account-correlation-rule +title: SourceAccountCorrelationRule +pagination_label: SourceAccountCorrelationRule +sidebar_label: SourceAccountCorrelationRule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAccountCorrelationRule', 'V2024SourceAccountCorrelationRule'] +slug: /tools/sdk/powershell/v2024/models/source-account-correlation-rule +tags: ['SDK', 'Software Development Kit', 'SourceAccountCorrelationRule', 'V2024SourceAccountCorrelationRule'] +--- + + +# SourceAccountCorrelationRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "RULE" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Rule ID. | [optional] +**Name** | Pointer to **String** | Rule's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceAccountCorrelationRule = Initialize-PSSailpoint.V2024SourceAccountCorrelationRule -Type RULE ` + -Id 2c918085708c274401708c2a8a760001 ` + -Name Example Rule +``` + +- Convert the resource to JSON +```powershell +$SourceAccountCorrelationRule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAccountCreated.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAccountCreated.md new file mode 100644 index 000000000..02dcb760e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAccountCreated.md @@ -0,0 +1,49 @@ +--- +id: v2024-source-account-created +title: SourceAccountCreated +pagination_label: SourceAccountCreated +sidebar_label: SourceAccountCreated +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAccountCreated', 'V2024SourceAccountCreated'] +slug: /tools/sdk/powershell/v2024/models/source-account-created +tags: ['SDK', 'Software Development Kit', 'SourceAccountCreated', 'V2024SourceAccountCreated'] +--- + + +# SourceAccountCreated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Uuid** | Pointer to **String** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] +**Id** | **String** | SailPoint generated unique identifier. | [required] +**NativeIdentifier** | **String** | Unique ID of the account on the source. | [required] +**SourceId** | **String** | The ID of the source. | [required] +**SourceName** | **String** | The name of the source. | [required] +**IdentityId** | **String** | The ID of the identity that is correlated with this account. | [required] +**IdentityName** | **String** | The name of the identity that is correlated with this account. | [required] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceAccountCreated = Initialize-PSSailpoint.V2024SourceAccountCreated -Uuid b7264868-7201-415f-9118-b581d431c688 ` + -Id ee769173319b41d19ccec35ba52f237b ` + -NativeIdentifier E009 ` + -SourceId 2c918082814e693601816e09471b29b6 ` + -SourceName Active Directory ` + -IdentityId ee769173319b41d19ccec6c235423237b ` + -IdentityName john.doe ` + -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} +``` + +- Convert the resource to JSON +```powershell +$SourceAccountCreated | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAccountDeleted.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAccountDeleted.md new file mode 100644 index 000000000..ef18d8bb4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAccountDeleted.md @@ -0,0 +1,49 @@ +--- +id: v2024-source-account-deleted +title: SourceAccountDeleted +pagination_label: SourceAccountDeleted +sidebar_label: SourceAccountDeleted +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAccountDeleted', 'V2024SourceAccountDeleted'] +slug: /tools/sdk/powershell/v2024/models/source-account-deleted +tags: ['SDK', 'Software Development Kit', 'SourceAccountDeleted', 'V2024SourceAccountDeleted'] +--- + + +# SourceAccountDeleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Uuid** | Pointer to **String** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] +**Id** | **String** | SailPoint generated unique identifier. | [required] +**NativeIdentifier** | **String** | Unique ID of the account on the source. | [required] +**SourceId** | **String** | The ID of the source. | [required] +**SourceName** | **String** | The name of the source. | [required] +**IdentityId** | **String** | The ID of the identity that is correlated with this account. | [required] +**IdentityName** | **String** | The name of the identity that is correlated with this account. | [required] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceAccountDeleted = Initialize-PSSailpoint.V2024SourceAccountDeleted -Uuid b7264868-7201-415f-9118-b581d431c688 ` + -Id ee769173319b41d19ccec35ba52f237b ` + -NativeIdentifier E009 ` + -SourceId 2c918082814e693601816e09471b29b6 ` + -SourceName Active Directory ` + -IdentityId ee769173319b41d19ccec6c235423237b ` + -IdentityName john.doe ` + -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} +``` + +- Convert the resource to JSON +```powershell +$SourceAccountDeleted | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAccountUpdated.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAccountUpdated.md new file mode 100644 index 000000000..a49f6bff7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAccountUpdated.md @@ -0,0 +1,49 @@ +--- +id: v2024-source-account-updated +title: SourceAccountUpdated +pagination_label: SourceAccountUpdated +sidebar_label: SourceAccountUpdated +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAccountUpdated', 'V2024SourceAccountUpdated'] +slug: /tools/sdk/powershell/v2024/models/source-account-updated +tags: ['SDK', 'Software Development Kit', 'SourceAccountUpdated', 'V2024SourceAccountUpdated'] +--- + + +# SourceAccountUpdated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Uuid** | Pointer to **String** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] +**Id** | **String** | SailPoint generated unique identifier. | [required] +**NativeIdentifier** | **String** | Unique ID of the account on the source. | [required] +**SourceId** | **String** | The ID of the source. | [required] +**SourceName** | **String** | The name of the source. | [required] +**IdentityId** | **String** | The ID of the identity that is correlated with this account. | [required] +**IdentityName** | **String** | The name of the identity that is correlated with this account. | [required] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceAccountUpdated = Initialize-PSSailpoint.V2024SourceAccountUpdated -Uuid b7264868-7201-415f-9118-b581d431c688 ` + -Id ee769173319b41d19ccec35ba52f237b ` + -NativeIdentifier E009 ` + -SourceId 2c918082814e693601816e09471b29b6 ` + -SourceName Active Directory ` + -IdentityId ee769173319b41d19ccec6c235423237b ` + -IdentityName john.doe ` + -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} +``` + +- Convert the resource to JSON +```powershell +$SourceAccountUpdated | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceApp.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceApp.md new file mode 100644 index 000000000..c9a082926 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceApp.md @@ -0,0 +1,57 @@ +--- +id: v2024-source-app +title: SourceApp +pagination_label: SourceApp +sidebar_label: SourceApp +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceApp', 'V2024SourceApp'] +slug: /tools/sdk/powershell/v2024/models/source-app +tags: ['SDK', 'Software Development Kit', 'SourceApp', 'V2024SourceApp'] +--- + + +# SourceApp + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The source app id | [optional] +**CloudAppId** | Pointer to **String** | The deprecated source app id | [optional] +**Name** | Pointer to **String** | The source app name | [optional] +**Created** | Pointer to **System.DateTime** | Time when the source app was created | [optional] +**Modified** | Pointer to **System.DateTime** | Time when the source app was last modified | [optional] +**Enabled** | Pointer to **Boolean** | True if the source app is enabled | [optional] [default to $false] +**ProvisionRequestEnabled** | Pointer to **Boolean** | True if the source app is provision request enabled | [optional] [default to $false] +**Description** | Pointer to **String** | The description of the source app | [optional] +**MatchAllAccounts** | Pointer to **Boolean** | True if the source app match all accounts | [optional] [default to $false] +**AppCenterEnabled** | Pointer to **Boolean** | True if the source app is shown in the app center | [optional] [default to $true] +**AccountSource** | Pointer to [**SourceAppAccountSource**](source-app-account-source) | | [optional] +**Owner** | Pointer to [**BaseReferenceDto**](base-reference-dto) | The owner of source app | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceApp = Initialize-PSSailpoint.V2024SourceApp -Id 2c91808874ff91550175097daaec161c ` + -CloudAppId 9854520 ` + -Name my app ` + -Created 2020-10-08T18:33:52.029Z ` + -Modified 2020-10-08T18:33:52.029Z ` + -Enabled true ` + -ProvisionRequestEnabled true ` + -Description the source app for engineers ` + -MatchAllAccounts true ` + -AppCenterEnabled true ` + -AccountSource null ` + -Owner null +``` + +- Convert the resource to JSON +```powershell +$SourceApp | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAppAccountSource.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAppAccountSource.md new file mode 100644 index 000000000..b9de54584 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAppAccountSource.md @@ -0,0 +1,43 @@ +--- +id: v2024-source-app-account-source +title: SourceAppAccountSource +pagination_label: SourceAppAccountSource +sidebar_label: SourceAppAccountSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAppAccountSource', 'V2024SourceAppAccountSource'] +slug: /tools/sdk/powershell/v2024/models/source-app-account-source +tags: ['SDK', 'Software Development Kit', 'SourceAppAccountSource', 'V2024SourceAppAccountSource'] +--- + + +# SourceAppAccountSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The source ID | [optional] +**Type** | Pointer to **String** | The source type, will always be ""SOURCE"" | [optional] +**Name** | Pointer to **String** | The source name | [optional] +**UseForPasswordManagement** | Pointer to **Boolean** | If the source is used for password management | [optional] [default to $false] +**PasswordPolicies** | Pointer to [**[]BaseReferenceDto**](base-reference-dto) | The password policies for the source | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceAppAccountSource = Initialize-PSSailpoint.V2024SourceAppAccountSource -Id 2c9180827ca885d7017ca8ce28a000eb ` + -Type SOURCE ` + -Name ODS-AD-Source ` + -UseForPasswordManagement false ` + -PasswordPolicies [{type=PASSWORD_POLICY, id=006a072ecc6647f68bba9f4a4ad34649, name=Password Policy 1}] +``` + +- Convert the resource to JSON +```powershell +$SourceAppAccountSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAppBulkUpdateRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAppBulkUpdateRequest.md new file mode 100644 index 000000000..aac2355e9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAppBulkUpdateRequest.md @@ -0,0 +1,37 @@ +--- +id: v2024-source-app-bulk-update-request +title: SourceAppBulkUpdateRequest +pagination_label: SourceAppBulkUpdateRequest +sidebar_label: SourceAppBulkUpdateRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAppBulkUpdateRequest', 'V2024SourceAppBulkUpdateRequest'] +slug: /tools/sdk/powershell/v2024/models/source-app-bulk-update-request +tags: ['SDK', 'Software Development Kit', 'SourceAppBulkUpdateRequest', 'V2024SourceAppBulkUpdateRequest'] +--- + + +# SourceAppBulkUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AppIds** | **[]String** | List of source app ids to update | [required] +**JsonPatch** | [**[]JsonPatchOperation**](json-patch-operation) | The JSONPatch payload used to update the source app. | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceAppBulkUpdateRequest = Initialize-PSSailpoint.V2024SourceAppBulkUpdateRequest -AppIds [2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e, 2c91808a7624751a01762f19d692220f] ` + -JsonPatch [{op=replace, path=/enabled, value=false}, {op=replace, path=/matchAllAccounts, value=false}] +``` + +- Convert the resource to JSON +```powershell +$SourceAppBulkUpdateRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAppCreateDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAppCreateDto.md new file mode 100644 index 000000000..bde250ca1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAppCreateDto.md @@ -0,0 +1,41 @@ +--- +id: v2024-source-app-create-dto +title: SourceAppCreateDto +pagination_label: SourceAppCreateDto +sidebar_label: SourceAppCreateDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAppCreateDto', 'V2024SourceAppCreateDto'] +slug: /tools/sdk/powershell/v2024/models/source-app-create-dto +tags: ['SDK', 'Software Development Kit', 'SourceAppCreateDto', 'V2024SourceAppCreateDto'] +--- + + +# SourceAppCreateDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | The source app name | [required] +**Description** | **String** | The description of the source app | [required] +**MatchAllAccounts** | Pointer to **Boolean** | True if the source app match all accounts | [optional] [default to $false] +**AccountSource** | [**SourceAppCreateDtoAccountSource**](source-app-create-dto-account-source) | | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceAppCreateDto = Initialize-PSSailpoint.V2024SourceAppCreateDto -Name my app ` + -Description the source app for engineers ` + -MatchAllAccounts true ` + -AccountSource null +``` + +- Convert the resource to JSON +```powershell +$SourceAppCreateDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAppCreateDtoAccountSource.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAppCreateDtoAccountSource.md new file mode 100644 index 000000000..77d696593 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAppCreateDtoAccountSource.md @@ -0,0 +1,39 @@ +--- +id: v2024-source-app-create-dto-account-source +title: SourceAppCreateDtoAccountSource +pagination_label: SourceAppCreateDtoAccountSource +sidebar_label: SourceAppCreateDtoAccountSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAppCreateDtoAccountSource', 'V2024SourceAppCreateDtoAccountSource'] +slug: /tools/sdk/powershell/v2024/models/source-app-create-dto-account-source +tags: ['SDK', 'Software Development Kit', 'SourceAppCreateDtoAccountSource', 'V2024SourceAppCreateDtoAccountSource'] +--- + + +# SourceAppCreateDtoAccountSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The source ID | [required] +**Type** | Pointer to **String** | The source type, will always be ""SOURCE"" | [optional] +**Name** | Pointer to **String** | The source name | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceAppCreateDtoAccountSource = Initialize-PSSailpoint.V2024SourceAppCreateDtoAccountSource -Id 2c9180827ca885d7017ca8ce28a000eb ` + -Type SOURCE ` + -Name ODS-AD-Source +``` + +- Convert the resource to JSON +```powershell +$SourceAppCreateDtoAccountSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAppPatchDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAppPatchDto.md new file mode 100644 index 000000000..0d51526a9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceAppPatchDto.md @@ -0,0 +1,59 @@ +--- +id: v2024-source-app-patch-dto +title: SourceAppPatchDto +pagination_label: SourceAppPatchDto +sidebar_label: SourceAppPatchDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAppPatchDto', 'V2024SourceAppPatchDto'] +slug: /tools/sdk/powershell/v2024/models/source-app-patch-dto +tags: ['SDK', 'Software Development Kit', 'SourceAppPatchDto', 'V2024SourceAppPatchDto'] +--- + + +# SourceAppPatchDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The source app id | [optional] +**CloudAppId** | Pointer to **String** | The deprecated source app id | [optional] +**Name** | Pointer to **String** | The source app name | [optional] +**Created** | Pointer to **System.DateTime** | Time when the source app was created | [optional] +**Modified** | Pointer to **System.DateTime** | Time when the source app was last modified | [optional] +**Enabled** | Pointer to **Boolean** | True if the source app is enabled | [optional] [default to $false] +**ProvisionRequestEnabled** | Pointer to **Boolean** | True if the source app is provision request enabled | [optional] [default to $false] +**Description** | Pointer to **String** | The description of the source app | [optional] +**MatchAllAccounts** | Pointer to **Boolean** | True if the source app match all accounts | [optional] [default to $false] +**AppCenterEnabled** | Pointer to **Boolean** | True if the source app is shown in the app center | [optional] [default to $true] +**AccessProfiles** | Pointer to **[]String** | List of IDs of access profiles | [optional] +**AccountSource** | Pointer to [**SourceAppAccountSource**](source-app-account-source) | | [optional] +**Owner** | Pointer to [**BaseReferenceDto**](base-reference-dto) | The owner of source app | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceAppPatchDto = Initialize-PSSailpoint.V2024SourceAppPatchDto -Id 2c91808874ff91550175097daaec161c ` + -CloudAppId 9854520 ` + -Name my app ` + -Created 2020-10-08T18:33:52.029Z ` + -Modified 2020-10-08T18:33:52.029Z ` + -Enabled true ` + -ProvisionRequestEnabled true ` + -Description the source app for engineers ` + -MatchAllAccounts true ` + -AppCenterEnabled true ` + -AccessProfiles [2c9180857725c14301772a93bb77242d, c9dc28e148a24d65b3ccb5fb8ca5ddd9] ` + -AccountSource null ` + -Owner null +``` + +- Convert the resource to JSON +```powershell +$SourceAppPatchDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceBeforeProvisioningRule.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceBeforeProvisioningRule.md new file mode 100644 index 000000000..e76ab5f93 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceBeforeProvisioningRule.md @@ -0,0 +1,39 @@ +--- +id: v2024-source-before-provisioning-rule +title: SourceBeforeProvisioningRule +pagination_label: SourceBeforeProvisioningRule +sidebar_label: SourceBeforeProvisioningRule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceBeforeProvisioningRule', 'V2024SourceBeforeProvisioningRule'] +slug: /tools/sdk/powershell/v2024/models/source-before-provisioning-rule +tags: ['SDK', 'Software Development Kit', 'SourceBeforeProvisioningRule', 'V2024SourceBeforeProvisioningRule'] +--- + + +# SourceBeforeProvisioningRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "RULE" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Rule ID. | [optional] +**Name** | Pointer to **String** | Rule's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceBeforeProvisioningRule = Initialize-PSSailpoint.V2024SourceBeforeProvisioningRule -Type RULE ` + -Id 2c918085708c274401708c2a8a760001 ` + -Name Example Rule +``` + +- Convert the resource to JSON +```powershell +$SourceBeforeProvisioningRule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceCluster.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceCluster.md new file mode 100644 index 000000000..85c387595 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceCluster.md @@ -0,0 +1,39 @@ +--- +id: v2024-source-cluster +title: SourceCluster +pagination_label: SourceCluster +sidebar_label: SourceCluster +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceCluster', 'V2024SourceCluster'] +slug: /tools/sdk/powershell/v2024/models/source-cluster +tags: ['SDK', 'Software Development Kit', 'SourceCluster', 'V2024SourceCluster'] +--- + + +# SourceCluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "CLUSTER" ] | Type of object being referenced. | [required] +**Id** | **String** | Cluster ID. | [required] +**Name** | **String** | Cluster's human-readable display name. | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceCluster = Initialize-PSSailpoint.V2024SourceCluster -Type CLUSTER ` + -Id 2c9180866166b5b0016167c32ef31a66 ` + -Name Corporate Cluster +``` + +- Convert the resource to JSON +```powershell +$SourceCluster | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceClusterDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceClusterDto.md new file mode 100644 index 000000000..65f1f919e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceClusterDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-source-cluster-dto +title: SourceClusterDto +pagination_label: SourceClusterDto +sidebar_label: SourceClusterDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceClusterDto', 'V2024SourceClusterDto'] +slug: /tools/sdk/powershell/v2024/models/source-cluster-dto +tags: ['SDK', 'Software Development Kit', 'SourceClusterDto', 'V2024SourceClusterDto'] +--- + + +# SourceClusterDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "CLUSTER" ] | Source cluster DTO type. | [optional] +**Id** | Pointer to **String** | Source cluster ID. | [optional] +**Name** | Pointer to **String** | Source cluster display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceClusterDto = Initialize-PSSailpoint.V2024SourceClusterDto -Type CLUSTER ` + -Id 2c9180847a7fccdd017aa5896f9f4f6f ` + -Name Training VA +``` + +- Convert the resource to JSON +```powershell +$SourceClusterDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceCode.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceCode.md new file mode 100644 index 000000000..6a1403ed4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceCode.md @@ -0,0 +1,37 @@ +--- +id: v2024-source-code +title: SourceCode +pagination_label: SourceCode +sidebar_label: SourceCode +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceCode', 'V2024SourceCode'] +slug: /tools/sdk/powershell/v2024/models/source-code +tags: ['SDK', 'Software Development Kit', 'SourceCode', 'V2024SourceCode'] +--- + + +# SourceCode + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | **String** | the version of the code | [required] +**Script** | **String** | The code | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceCode = Initialize-PSSailpoint.V2024SourceCode -Version 1.0 ` + -Script return "Mr. " + firstName; +``` + +- Convert the resource to JSON +```powershell +$SourceCode | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceCreated.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceCreated.md new file mode 100644 index 000000000..529965bfd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceCreated.md @@ -0,0 +1,45 @@ +--- +id: v2024-source-created +title: SourceCreated +pagination_label: SourceCreated +sidebar_label: SourceCreated +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceCreated', 'V2024SourceCreated'] +slug: /tools/sdk/powershell/v2024/models/source-created +tags: ['SDK', 'Software Development Kit', 'SourceCreated', 'V2024SourceCreated'] +--- + + +# SourceCreated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the source. | [required] +**Name** | **String** | Human friendly name of the source. | [required] +**Type** | **String** | The connection type. | [required] +**Created** | **System.DateTime** | The date and time the source was created. | [required] +**Connector** | **String** | The connector type used to connect to the source. | [required] +**Actor** | [**SourceCreatedActor**](source-created-actor) | | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceCreated = Initialize-PSSailpoint.V2024SourceCreated -Id 2c9180866166b5b0016167c32ef31a66 ` + -Name Test source ` + -Type DIRECT_CONNECT ` + -Created 2021-03-29T22:01:50.474Z ` + -Connector active-directory ` + -Actor null +``` + +- Convert the resource to JSON +```powershell +$SourceCreated | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceCreatedActor.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceCreatedActor.md new file mode 100644 index 000000000..0dd63560b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceCreatedActor.md @@ -0,0 +1,39 @@ +--- +id: v2024-source-created-actor +title: SourceCreatedActor +pagination_label: SourceCreatedActor +sidebar_label: SourceCreatedActor +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceCreatedActor', 'V2024SourceCreatedActor'] +slug: /tools/sdk/powershell/v2024/models/source-created-actor +tags: ['SDK', 'Software Development Kit', 'SourceCreatedActor', 'V2024SourceCreatedActor'] +--- + + +# SourceCreatedActor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | DTO type of identity who created the source. | [required] +**Id** | **String** | ID of identity who created the source. | [required] +**Name** | **String** | Display name of identity who created the source. | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceCreatedActor = Initialize-PSSailpoint.V2024SourceCreatedActor -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20648 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$SourceCreatedActor | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceDeleted.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceDeleted.md new file mode 100644 index 000000000..fa6d2df79 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceDeleted.md @@ -0,0 +1,45 @@ +--- +id: v2024-source-deleted +title: SourceDeleted +pagination_label: SourceDeleted +sidebar_label: SourceDeleted +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceDeleted', 'V2024SourceDeleted'] +slug: /tools/sdk/powershell/v2024/models/source-deleted +tags: ['SDK', 'Software Development Kit', 'SourceDeleted', 'V2024SourceDeleted'] +--- + + +# SourceDeleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the source. | [required] +**Name** | **String** | Human friendly name of the source. | [required] +**Type** | **String** | The connection type. | [required] +**Deleted** | **System.DateTime** | The date and time the source was deleted. | [required] +**Connector** | **String** | The connector type used to connect to the source. | [required] +**Actor** | [**SourceDeletedActor**](source-deleted-actor) | | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceDeleted = Initialize-PSSailpoint.V2024SourceDeleted -Id 2c9180866166b5b0016167c32ef31a66 ` + -Name Test source ` + -Type DIRECT_CONNECT ` + -Deleted 2021-03-29T22:01:50.474Z ` + -Connector active-directory ` + -Actor null +``` + +- Convert the resource to JSON +```powershell +$SourceDeleted | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceDeletedActor.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceDeletedActor.md new file mode 100644 index 000000000..cf63ed813 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceDeletedActor.md @@ -0,0 +1,39 @@ +--- +id: v2024-source-deleted-actor +title: SourceDeletedActor +pagination_label: SourceDeletedActor +sidebar_label: SourceDeletedActor +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceDeletedActor', 'V2024SourceDeletedActor'] +slug: /tools/sdk/powershell/v2024/models/source-deleted-actor +tags: ['SDK', 'Software Development Kit', 'SourceDeletedActor', 'V2024SourceDeletedActor'] +--- + + +# SourceDeletedActor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | DTO type of identity who deleted the source. | [required] +**Id** | **String** | ID of identity who deleted the source. | [required] +**Name** | **String** | Display name of identity who deleted the source. | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceDeletedActor = Initialize-PSSailpoint.V2024SourceDeletedActor -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20648 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$SourceDeletedActor | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceEntitlementRequestConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceEntitlementRequestConfig.md new file mode 100644 index 000000000..a9a5e78a6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceEntitlementRequestConfig.md @@ -0,0 +1,35 @@ +--- +id: v2024-source-entitlement-request-config +title: SourceEntitlementRequestConfig +pagination_label: SourceEntitlementRequestConfig +sidebar_label: SourceEntitlementRequestConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceEntitlementRequestConfig', 'V2024SourceEntitlementRequestConfig'] +slug: /tools/sdk/powershell/v2024/models/source-entitlement-request-config +tags: ['SDK', 'Software Development Kit', 'SourceEntitlementRequestConfig', 'V2024SourceEntitlementRequestConfig'] +--- + + +# SourceEntitlementRequestConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestConfig** | Pointer to [**EntitlementAccessRequestConfig**](entitlement-access-request-config) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceEntitlementRequestConfig = Initialize-PSSailpoint.V2024SourceEntitlementRequestConfig -AccessRequestConfig null +``` + +- Convert the resource to JSON +```powershell +$SourceEntitlementRequestConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceHealthDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceHealthDto.md new file mode 100644 index 000000000..8baa5cd8c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceHealthDto.md @@ -0,0 +1,53 @@ +--- +id: v2024-source-health-dto +title: SourceHealthDto +pagination_label: SourceHealthDto +sidebar_label: SourceHealthDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceHealthDto', 'V2024SourceHealthDto'] +slug: /tools/sdk/powershell/v2024/models/source-health-dto +tags: ['SDK', 'Software Development Kit', 'SourceHealthDto', 'V2024SourceHealthDto'] +--- + + +# SourceHealthDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | the id of the Source | [optional] [readonly] +**Type** | Pointer to **String** | Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. | [optional] +**Name** | Pointer to **String** | the name of the source | [optional] +**Org** | Pointer to **String** | source's org | [optional] +**IsAuthoritative** | Pointer to **Boolean** | Is the source authoritative | [optional] +**IsCluster** | Pointer to **Boolean** | Is the source in a cluster | [optional] +**Hostname** | Pointer to **String** | source's hostname | [optional] +**Pod** | Pointer to **String** | source's pod | [optional] +**IqServiceVersion** | Pointer to **String** | The version of the iqService | [optional] +**Status** | Pointer to **Enum** [ "SOURCE_STATE_ERROR_CLUSTER", "SOURCE_STATE_ERROR_SOURCE", "SOURCE_STATE_ERROR_VA", "SOURCE_STATE_FAILURE_CLUSTER", "SOURCE_STATE_FAILURE_SOURCE", "SOURCE_STATE_HEALTHY", "SOURCE_STATE_UNCHECKED_CLUSTER", "SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES", "SOURCE_STATE_UNCHECKED_SOURCE", "SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS" ] | connection test result | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceHealthDto = Initialize-PSSailpoint.V2024SourceHealthDto -Id 2c91808568c529c60168cca6f90c1324 ` + -Type OpenLDAP - Direct ` + -Name Source1234 ` + -Org denali-cjh ` + -IsAuthoritative false ` + -IsCluster false ` + -Hostname megapod-useast1-secret-hostname.sailpoint.com ` + -Pod megapod-useast1 ` + -IqServiceVersion iqVersion123 ` + -Status SOURCE_STATE_UNCHECKED_SOURCE +``` + +- Convert the resource to JSON +```powershell +$SourceHealthDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceManagementWorkgroup.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceManagementWorkgroup.md new file mode 100644 index 000000000..95c73e821 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceManagementWorkgroup.md @@ -0,0 +1,39 @@ +--- +id: v2024-source-management-workgroup +title: SourceManagementWorkgroup +pagination_label: SourceManagementWorkgroup +sidebar_label: SourceManagementWorkgroup +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceManagementWorkgroup', 'V2024SourceManagementWorkgroup'] +slug: /tools/sdk/powershell/v2024/models/source-management-workgroup +tags: ['SDK', 'Software Development Kit', 'SourceManagementWorkgroup', 'V2024SourceManagementWorkgroup'] +--- + + +# SourceManagementWorkgroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Management workgroup ID. | [optional] +**Name** | Pointer to **String** | Management workgroup's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceManagementWorkgroup = Initialize-PSSailpoint.V2024SourceManagementWorkgroup -Type GOVERNANCE_GROUP ` + -Id 2c91808568c529c60168cca6f90c2222 ` + -Name My Management Workgroup +``` + +- Convert the resource to JSON +```powershell +$SourceManagementWorkgroup | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceManagerCorrelationMapping.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceManagerCorrelationMapping.md new file mode 100644 index 000000000..2baa549fa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceManagerCorrelationMapping.md @@ -0,0 +1,37 @@ +--- +id: v2024-source-manager-correlation-mapping +title: SourceManagerCorrelationMapping +pagination_label: SourceManagerCorrelationMapping +sidebar_label: SourceManagerCorrelationMapping +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceManagerCorrelationMapping', 'V2024SourceManagerCorrelationMapping'] +slug: /tools/sdk/powershell/v2024/models/source-manager-correlation-mapping +tags: ['SDK', 'Software Development Kit', 'SourceManagerCorrelationMapping', 'V2024SourceManagerCorrelationMapping'] +--- + + +# SourceManagerCorrelationMapping + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountAttributeName** | Pointer to **String** | Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. | [optional] +**IdentityAttributeName** | Pointer to **String** | Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceManagerCorrelationMapping = Initialize-PSSailpoint.V2024SourceManagerCorrelationMapping -AccountAttributeName manager ` + -IdentityAttributeName manager +``` + +- Convert the resource to JSON +```powershell +$SourceManagerCorrelationMapping | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceManagerCorrelationRule.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceManagerCorrelationRule.md new file mode 100644 index 000000000..a13efa683 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceManagerCorrelationRule.md @@ -0,0 +1,39 @@ +--- +id: v2024-source-manager-correlation-rule +title: SourceManagerCorrelationRule +pagination_label: SourceManagerCorrelationRule +sidebar_label: SourceManagerCorrelationRule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceManagerCorrelationRule', 'V2024SourceManagerCorrelationRule'] +slug: /tools/sdk/powershell/v2024/models/source-manager-correlation-rule +tags: ['SDK', 'Software Development Kit', 'SourceManagerCorrelationRule', 'V2024SourceManagerCorrelationRule'] +--- + + +# SourceManagerCorrelationRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "RULE" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Rule ID. | [optional] +**Name** | Pointer to **String** | Rule's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceManagerCorrelationRule = Initialize-PSSailpoint.V2024SourceManagerCorrelationRule -Type RULE ` + -Id 2c918085708c274401708c2a8a760001 ` + -Name Example Rule +``` + +- Convert the resource to JSON +```powershell +$SourceManagerCorrelationRule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceOwner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceOwner.md new file mode 100644 index 000000000..97f52ea9b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceOwner.md @@ -0,0 +1,39 @@ +--- +id: v2024-source-owner +title: SourceOwner +pagination_label: SourceOwner +sidebar_label: SourceOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceOwner', 'V2024SourceOwner'] +slug: /tools/sdk/powershell/v2024/models/source-owner +tags: ['SDK', 'Software Development Kit', 'SourceOwner', 'V2024SourceOwner'] +--- + + +# SourceOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Owner identity's ID. | [optional] +**Name** | Pointer to **String** | Owner identity's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceOwner = Initialize-PSSailpoint.V2024SourceOwner -Type IDENTITY ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name MyName +``` + +- Convert the resource to JSON +```powershell +$SourceOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourcePasswordPoliciesInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourcePasswordPoliciesInner.md new file mode 100644 index 000000000..72dafa126 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourcePasswordPoliciesInner.md @@ -0,0 +1,39 @@ +--- +id: v2024-source-password-policies-inner +title: SourcePasswordPoliciesInner +pagination_label: SourcePasswordPoliciesInner +sidebar_label: SourcePasswordPoliciesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourcePasswordPoliciesInner', 'V2024SourcePasswordPoliciesInner'] +slug: /tools/sdk/powershell/v2024/models/source-password-policies-inner +tags: ['SDK', 'Software Development Kit', 'SourcePasswordPoliciesInner', 'V2024SourcePasswordPoliciesInner'] +--- + + +# SourcePasswordPoliciesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "PASSWORD_POLICY" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Policy ID. | [optional] +**Name** | Pointer to **String** | Policy's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourcePasswordPoliciesInner = Initialize-PSSailpoint.V2024SourcePasswordPoliciesInner -Type PASSWORD_POLICY ` + -Id 2c91808568c529c60168cca6f90c1777 ` + -Name My Password Policy +``` + +- Convert the resource to JSON +```powershell +$SourcePasswordPoliciesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceSchedule.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceSchedule.md new file mode 100644 index 000000000..b4d966072 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceSchedule.md @@ -0,0 +1,37 @@ +--- +id: v2024-source-schedule +title: SourceSchedule +pagination_label: SourceSchedule +sidebar_label: SourceSchedule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceSchedule', 'V2024SourceSchedule'] +slug: /tools/sdk/powershell/v2024/models/source-schedule +tags: ['SDK', 'Software Development Kit', 'SourceSchedule', 'V2024SourceSchedule'] +--- + + +# SourceSchedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "ACCOUNT_AGGREGATION", "GROUP_AGGREGATION" ] | The type of the Schedule. | [required] +**CronExpression** | **String** | The cron expression of the schedule. | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceSchedule = Initialize-PSSailpoint.V2024SourceSchedule -Type ACCOUNT_AGGREGATION ` + -CronExpression 0 0 5,13,21 * * ? +``` + +- Convert the resource to JSON +```powershell +$SourceSchedule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceSchemasInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceSchemasInner.md new file mode 100644 index 000000000..1ac29f6eb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceSchemasInner.md @@ -0,0 +1,39 @@ +--- +id: v2024-source-schemas-inner +title: SourceSchemasInner +pagination_label: SourceSchemasInner +sidebar_label: SourceSchemasInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceSchemasInner', 'V2024SourceSchemasInner'] +slug: /tools/sdk/powershell/v2024/models/source-schemas-inner +tags: ['SDK', 'Software Development Kit', 'SourceSchemasInner', 'V2024SourceSchemasInner'] +--- + + +# SourceSchemasInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "CONNECTOR_SCHEMA" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Schema ID. | [optional] +**Name** | Pointer to **String** | Schema's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceSchemasInner = Initialize-PSSailpoint.V2024SourceSchemasInner -Type CONNECTOR_SCHEMA ` + -Id 2c91808568c529c60168cca6f90c1777 ` + -Name MySchema +``` + +- Convert the resource to JSON +```powershell +$SourceSchemasInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceSyncJob.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceSyncJob.md new file mode 100644 index 000000000..ee42fc922 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceSyncJob.md @@ -0,0 +1,39 @@ +--- +id: v2024-source-sync-job +title: SourceSyncJob +pagination_label: SourceSyncJob +sidebar_label: SourceSyncJob +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceSyncJob', 'V2024SourceSyncJob'] +slug: /tools/sdk/powershell/v2024/models/source-sync-job +tags: ['SDK', 'Software Development Kit', 'SourceSyncJob', 'V2024SourceSyncJob'] +--- + + +# SourceSyncJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Job ID. | [required] +**Status** | **Enum** [ "QUEUED", "IN_PROGRESS", "SUCCESS", "ERROR" ] | The job status. | [required] +**Payload** | [**SourceSyncPayload**](source-sync-payload) | | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceSyncJob = Initialize-PSSailpoint.V2024SourceSyncJob -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -Status IN_PROGRESS ` + -Payload null +``` + +- Convert the resource to JSON +```powershell +$SourceSyncJob | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceSyncPayload.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceSyncPayload.md new file mode 100644 index 000000000..07f17d46c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceSyncPayload.md @@ -0,0 +1,37 @@ +--- +id: v2024-source-sync-payload +title: SourceSyncPayload +pagination_label: SourceSyncPayload +sidebar_label: SourceSyncPayload +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceSyncPayload', 'V2024SourceSyncPayload'] +slug: /tools/sdk/powershell/v2024/models/source-sync-payload +tags: ['SDK', 'Software Development Kit', 'SourceSyncPayload', 'V2024SourceSyncPayload'] +--- + + +# SourceSyncPayload + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **String** | Payload type. | [required] +**DataJson** | **String** | Payload type. | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceSyncPayload = Initialize-PSSailpoint.V2024SourceSyncPayload -Type SYNCHRONIZE_SOURCE_ATTRIBUTES ` + -DataJson {"sourceId":"2c918083746f642c01746f990884012a"} +``` + +- Convert the resource to JSON +```powershell +$SourceSyncPayload | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceUpdated.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceUpdated.md new file mode 100644 index 000000000..6e60d2813 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceUpdated.md @@ -0,0 +1,45 @@ +--- +id: v2024-source-updated +title: SourceUpdated +pagination_label: SourceUpdated +sidebar_label: SourceUpdated +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceUpdated', 'V2024SourceUpdated'] +slug: /tools/sdk/powershell/v2024/models/source-updated +tags: ['SDK', 'Software Development Kit', 'SourceUpdated', 'V2024SourceUpdated'] +--- + + +# SourceUpdated + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the source. | [required] +**Name** | **String** | The user friendly name of the source. | [required] +**Type** | **String** | The connection type of the source. | [required] +**Modified** | **System.DateTime** | The date and time the source was modified. | [required] +**Connector** | **String** | The connector type used to connect to the source. | [required] +**Actor** | [**SourceUpdatedActor**](source-updated-actor) | | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceUpdated = Initialize-PSSailpoint.V2024SourceUpdated -Id 2c9180866166b5b0016167c32ef31a66 ` + -Name Corporate Active Directory ` + -Type DIRECT_CONNECT ` + -Modified 2021-03-29T22:01:50.474Z ` + -Connector active-directory ` + -Actor null +``` + +- Convert the resource to JSON +```powershell +$SourceUpdated | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceUpdatedActor.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceUpdatedActor.md new file mode 100644 index 000000000..c0c4311be --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceUpdatedActor.md @@ -0,0 +1,39 @@ +--- +id: v2024-source-updated-actor +title: SourceUpdatedActor +pagination_label: SourceUpdatedActor +sidebar_label: SourceUpdatedActor +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceUpdatedActor', 'V2024SourceUpdatedActor'] +slug: /tools/sdk/powershell/v2024/models/source-updated-actor +tags: ['SDK', 'Software Development Kit', 'SourceUpdatedActor', 'V2024SourceUpdatedActor'] +--- + + +# SourceUpdatedActor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | DTO type of identity who updated the source. | [required] +**Id** | Pointer to **String** | ID of identity who updated the source. | [optional] +**Name** | **String** | Display name of identity who updated the source. | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceUpdatedActor = Initialize-PSSailpoint.V2024SourceUpdatedActor -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20648 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$SourceUpdatedActor | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceUsage.md new file mode 100644 index 000000000..5bf9a755e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceUsage.md @@ -0,0 +1,37 @@ +--- +id: v2024-source-usage +title: SourceUsage +pagination_label: SourceUsage +sidebar_label: SourceUsage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceUsage', 'V2024SourceUsage'] +slug: /tools/sdk/powershell/v2024/models/source-usage +tags: ['SDK', 'Software Development Kit', 'SourceUsage', 'V2024SourceUsage'] +--- + + +# SourceUsage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Date** | Pointer to **System.DateTime** | The first day of the month for which activity is aggregated. | [optional] +**Count** | Pointer to **Double** | The average number of days that accounts were active within this source, for the month. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` + -Count 10.45 +``` + +- Convert the resource to JSON +```powershell +$SourceUsage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceUsageStatus.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceUsageStatus.md new file mode 100644 index 000000000..2a67c8b1e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SourceUsageStatus.md @@ -0,0 +1,35 @@ +--- +id: v2024-source-usage-status +title: SourceUsageStatus +pagination_label: SourceUsageStatus +sidebar_label: SourceUsageStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceUsageStatus', 'V2024SourceUsageStatus'] +slug: /tools/sdk/powershell/v2024/models/source-usage-status +tags: ['SDK', 'Software Development Kit', 'SourceUsageStatus', 'V2024SourceUsageStatus'] +--- + + +# SourceUsageStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **Enum** [ "COMPLETE", "INCOMPLETE" ] | Source Usage Status. Acceptable values are: - COMPLETE - This status means that an activity data source has been setup and usage insights are available for the source. - INCOMPLETE - This status means that an activity data source has not been setup and usage insights are not available for the source. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceUsageStatus = Initialize-PSSailpoint.V2024SourceUsageStatus -Status COMPLETE +``` + +- Convert the resource to JSON +```powershell +$SourceUsageStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigExportJob.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigExportJob.md new file mode 100644 index 000000000..a77e2e732 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigExportJob.md @@ -0,0 +1,47 @@ +--- +id: v2024-sp-config-export-job +title: SpConfigExportJob +pagination_label: SpConfigExportJob +sidebar_label: SpConfigExportJob +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigExportJob', 'V2024SpConfigExportJob'] +slug: /tools/sdk/powershell/v2024/models/sp-config-export-job +tags: ['SDK', 'Software Development Kit', 'SpConfigExportJob', 'V2024SpConfigExportJob'] +--- + + +# SpConfigExportJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | **String** | Unique id assigned to this job. | [required] +**Status** | **Enum** [ "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "CANCELLED", "FAILED" ] | Status of the job. | [required] +**Type** | **Enum** [ "EXPORT", "IMPORT" ] | Type of the job, either export or import. | [required] +**Expiration** | **System.DateTime** | The time until which the artifacts will be available for download. | [required] +**Created** | **System.DateTime** | The time the job was started. | [required] +**Modified** | **System.DateTime** | The time of the last update to the job. | [required] +**Description** | Pointer to **String** | Optional user defined description/name for export job. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SpConfigExportJob = Initialize-PSSailpoint.V2024SpConfigExportJob -JobId 3469b87d-48ca-439a-868f-2160001da8c1 ` + -Status COMPLETE ` + -Type IMPORT ` + -Expiration 2021-05-11T22:23:16Z ` + -Created 2021-05-11T22:23:16Z ` + -Modified 2021-05-11T22:23:16Z ` + -Description ETS configuration objects from Acme-Solar sandbox +``` + +- Convert the resource to JSON +```powershell +$SpConfigExportJob | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigExportJobStatus.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigExportJobStatus.md new file mode 100644 index 000000000..5ac1fed65 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigExportJobStatus.md @@ -0,0 +1,49 @@ +--- +id: v2024-sp-config-export-job-status +title: SpConfigExportJobStatus +pagination_label: SpConfigExportJobStatus +sidebar_label: SpConfigExportJobStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigExportJobStatus', 'V2024SpConfigExportJobStatus'] +slug: /tools/sdk/powershell/v2024/models/sp-config-export-job-status +tags: ['SDK', 'Software Development Kit', 'SpConfigExportJobStatus', 'V2024SpConfigExportJobStatus'] +--- + + +# SpConfigExportJobStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | **String** | Unique id assigned to this job. | [required] +**Status** | **Enum** [ "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "CANCELLED", "FAILED" ] | Status of the job. | [required] +**Type** | **Enum** [ "EXPORT", "IMPORT" ] | Type of the job, either export or import. | [required] +**Expiration** | **System.DateTime** | The time until which the artifacts will be available for download. | [required] +**Created** | **System.DateTime** | The time the job was started. | [required] +**Modified** | **System.DateTime** | The time of the last update to the job. | [required] +**Description** | Pointer to **String** | Optional user defined description/name for export job. | [optional] +**Completed** | Pointer to **System.DateTime** | The time the job was completed. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SpConfigExportJobStatus = Initialize-PSSailpoint.V2024SpConfigExportJobStatus -JobId 3469b87d-48ca-439a-868f-2160001da8c1 ` + -Status COMPLETE ` + -Type IMPORT ` + -Expiration 2021-05-11T22:23:16Z ` + -Created 2021-05-11T22:23:16Z ` + -Modified 2021-05-11T22:23:16Z ` + -Description ETS configuration objects from Acme-Solar sandbox ` + -Completed 2021-05-11T22:23:16Z +``` + +- Convert the resource to JSON +```powershell +$SpConfigExportJobStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigExportResults.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigExportResults.md new file mode 100644 index 000000000..f31c2d6fb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigExportResults.md @@ -0,0 +1,45 @@ +--- +id: v2024-sp-config-export-results +title: SpConfigExportResults +pagination_label: SpConfigExportResults +sidebar_label: SpConfigExportResults +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigExportResults', 'V2024SpConfigExportResults'] +slug: /tools/sdk/powershell/v2024/models/sp-config-export-results +tags: ['SDK', 'Software Development Kit', 'SpConfigExportResults', 'V2024SpConfigExportResults'] +--- + + +# SpConfigExportResults + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | Pointer to **Int32** | Current version of the export results object. | [optional] +**Timestamp** | Pointer to **System.DateTime** | Time the export was completed. | [optional] +**Tenant** | Pointer to **String** | Name of the tenant where this export originated. | [optional] +**Description** | Pointer to **String** | Optional user defined description/name for export job. | [optional] +**Options** | Pointer to [**ExportOptions**](export-options) | | [optional] +**Objects** | Pointer to [**[]ConfigObject**](config-object) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SpConfigExportResults = Initialize-PSSailpoint.V2024SpConfigExportResults -Version 1 ` + -Timestamp 2021-05-11T22:23:16Z ` + -Tenant sample-tenant ` + -Description Export Job 1 Test ` + -Options null ` + -Objects null +``` + +- Convert the resource to JSON +```powershell +$SpConfigExportResults | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigImportJobStatus.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigImportJobStatus.md new file mode 100644 index 000000000..82b7cc224 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigImportJobStatus.md @@ -0,0 +1,49 @@ +--- +id: v2024-sp-config-import-job-status +title: SpConfigImportJobStatus +pagination_label: SpConfigImportJobStatus +sidebar_label: SpConfigImportJobStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigImportJobStatus', 'V2024SpConfigImportJobStatus'] +slug: /tools/sdk/powershell/v2024/models/sp-config-import-job-status +tags: ['SDK', 'Software Development Kit', 'SpConfigImportJobStatus', 'V2024SpConfigImportJobStatus'] +--- + + +# SpConfigImportJobStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | **String** | Unique id assigned to this job. | [required] +**Status** | **Enum** [ "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "CANCELLED", "FAILED" ] | Status of the job. | [required] +**Type** | **Enum** [ "EXPORT", "IMPORT" ] | Type of the job, either export or import. | [required] +**Expiration** | **System.DateTime** | The time until which the artifacts will be available for download. | [required] +**Created** | **System.DateTime** | The time the job was started. | [required] +**Modified** | **System.DateTime** | The time of the last update to the job. | [required] +**Message** | Pointer to **String** | This message contains additional information about the overall status of the job. | [optional] +**Completed** | Pointer to **System.DateTime** | The time the job was completed. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SpConfigImportJobStatus = Initialize-PSSailpoint.V2024SpConfigImportJobStatus -JobId 3469b87d-48ca-439a-868f-2160001da8c1 ` + -Status COMPLETE ` + -Type IMPORT ` + -Expiration 2021-05-11T22:23:16Z ` + -Created 2021-05-11T22:23:16Z ` + -Modified 2021-05-11T22:23:16Z ` + -Message Download import results for details. ` + -Completed 2021-05-11T22:23:16Z +``` + +- Convert the resource to JSON +```powershell +$SpConfigImportJobStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigImportResults.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigImportResults.md new file mode 100644 index 000000000..ef38ed83a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigImportResults.md @@ -0,0 +1,37 @@ +--- +id: v2024-sp-config-import-results +title: SpConfigImportResults +pagination_label: SpConfigImportResults +sidebar_label: SpConfigImportResults +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigImportResults', 'V2024SpConfigImportResults'] +slug: /tools/sdk/powershell/v2024/models/sp-config-import-results +tags: ['SDK', 'Software Development Kit', 'SpConfigImportResults', 'V2024SpConfigImportResults'] +--- + + +# SpConfigImportResults + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Results** | [**map[string]ObjectImportResult1**](object-import-result1) | The results of an object configuration import job. | [required] +**ExportJobId** | Pointer to **String** | If a backup was performed before the import, this will contain the jobId of the backup job. This id can be used to retrieve the json file of the backup export. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SpConfigImportResults = Initialize-PSSailpoint.V2024SpConfigImportResults -Results {results={TRIGGER_SUBSCRIPTION={infos=[{key=IMPORT_PREVIEW, text=Object to be imported: [c953134c-2224-42f2-a84e-fa5cbb395904, Test 2], detail=null}, {key=IMPORT_PREVIEW, text=Object to be imported: [be9e116d-08e1-49fc-ab7f-fa585e96c9e4, Test 1], detail=null}], warnings=[], errors=[], importedObjects=[]}}} ` + -ExportJobId be9e116d-08e1-49fc-ab7f-fa585e96c9e4 +``` + +- Convert the resource to JSON +```powershell +$SpConfigImportResults | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigJob.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigJob.md new file mode 100644 index 000000000..352582183 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigJob.md @@ -0,0 +1,45 @@ +--- +id: v2024-sp-config-job +title: SpConfigJob +pagination_label: SpConfigJob +sidebar_label: SpConfigJob +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigJob', 'V2024SpConfigJob'] +slug: /tools/sdk/powershell/v2024/models/sp-config-job +tags: ['SDK', 'Software Development Kit', 'SpConfigJob', 'V2024SpConfigJob'] +--- + + +# SpConfigJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | **String** | Unique id assigned to this job. | [required] +**Status** | **Enum** [ "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "CANCELLED", "FAILED" ] | Status of the job. | [required] +**Type** | **Enum** [ "EXPORT", "IMPORT" ] | Type of the job, either export or import. | [required] +**Expiration** | **System.DateTime** | The time until which the artifacts will be available for download. | [required] +**Created** | **System.DateTime** | The time the job was started. | [required] +**Modified** | **System.DateTime** | The time of the last update to the job. | [required] + +## Examples + +- Prepare the resource +```powershell +$SpConfigJob = Initialize-PSSailpoint.V2024SpConfigJob -JobId 3469b87d-48ca-439a-868f-2160001da8c1 ` + -Status COMPLETE ` + -Type IMPORT ` + -Expiration 2021-05-11T22:23:16Z ` + -Created 2021-05-11T22:23:16Z ` + -Modified 2021-05-11T22:23:16Z +``` + +- Convert the resource to JSON +```powershell +$SpConfigJob | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigMessage.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigMessage.md new file mode 100644 index 000000000..76af657fe --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigMessage.md @@ -0,0 +1,39 @@ +--- +id: v2024-sp-config-message +title: SpConfigMessage +pagination_label: SpConfigMessage +sidebar_label: SpConfigMessage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigMessage', 'V2024SpConfigMessage'] +slug: /tools/sdk/powershell/v2024/models/sp-config-message +tags: ['SDK', 'Software Development Kit', 'SpConfigMessage', 'V2024SpConfigMessage'] +--- + + +# SpConfigMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | **String** | Message key. | [required] +**Text** | **String** | Message text. | [required] +**Details** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Message details if any, in key:value pairs. | [required] + +## Examples + +- Prepare the resource +```powershell +$SpConfigMessage = Initialize-PSSailpoint.V2024SpConfigMessage -Key UNKNOWN_REFERENCE_RESOLVER ` + -Text Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity] ` + -Details {details=message details} +``` + +- Convert the resource to JSON +```powershell +$SpConfigMessage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigMessage1.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigMessage1.md new file mode 100644 index 000000000..b5e11acd7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigMessage1.md @@ -0,0 +1,39 @@ +--- +id: v2024-sp-config-message1 +title: SpConfigMessage1 +pagination_label: SpConfigMessage1 +sidebar_label: SpConfigMessage1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigMessage1', 'V2024SpConfigMessage1'] +slug: /tools/sdk/powershell/v2024/models/sp-config-message1 +tags: ['SDK', 'Software Development Kit', 'SpConfigMessage1', 'V2024SpConfigMessage1'] +--- + + +# SpConfigMessage1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | **String** | Message key. | [required] +**Text** | **String** | Message text. | [required] +**Details** | [**map[string]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Message details if any, in key:value pairs. | [required] + +## Examples + +- Prepare the resource +```powershell +$SpConfigMessage1 = Initialize-PSSailpoint.V2024SpConfigMessage1 -Key UNKNOWN_REFERENCE_RESOLVER ` + -Text Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity] ` + -Details {details=message details} +``` + +- Convert the resource to JSON +```powershell +$SpConfigMessage1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigObject.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigObject.md new file mode 100644 index 000000000..a5602c74e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigObject.md @@ -0,0 +1,47 @@ +--- +id: v2024-sp-config-object +title: SpConfigObject +pagination_label: SpConfigObject +sidebar_label: SpConfigObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigObject', 'V2024SpConfigObject'] +slug: /tools/sdk/powershell/v2024/models/sp-config-object +tags: ['SDK', 'Software Development Kit', 'SpConfigObject', 'V2024SpConfigObject'] +--- + + +# SpConfigObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectType** | Pointer to **String** | The object type this configuration is for. | [optional] +**ReferenceExtractors** | Pointer to **[]String** | List of json paths within an exported object of this type that represent references that need to be resolved. | [optional] +**SignatureRequired** | Pointer to **Boolean** | If true, this type of object will be JWS signed and cannot be modified before import. | [optional] [default to $false] +**LegacyObject** | Pointer to **Boolean** | Whether this is a legacy object | [optional] [default to $false] +**OnePerTenant** | Pointer to **Boolean** | Whether there is only one object of this type | [optional] [default to $false] +**Exportable** | Pointer to **Boolean** | Whether this object can be exported or it is just a reference object | [optional] [default to $false] +**Rules** | Pointer to [**SpConfigRules**](sp-config-rules) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SpConfigObject = Initialize-PSSailpoint.V2024SpConfigObject -ObjectType TRIGGER_SUBSCRIPTION ` + -ReferenceExtractors [$.owner] ` + -SignatureRequired false ` + -LegacyObject false ` + -OnePerTenant false ` + -Exportable true ` + -Rules null +``` + +- Convert the resource to JSON +```powershell +$SpConfigObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigRule.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigRule.md new file mode 100644 index 000000000..25b7a4251 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigRule.md @@ -0,0 +1,39 @@ +--- +id: v2024-sp-config-rule +title: SpConfigRule +pagination_label: SpConfigRule +sidebar_label: SpConfigRule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigRule', 'V2024SpConfigRule'] +slug: /tools/sdk/powershell/v2024/models/sp-config-rule +tags: ['SDK', 'Software Development Kit', 'SpConfigRule', 'V2024SpConfigRule'] +--- + + +# SpConfigRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Path** | Pointer to **String** | JSONPath expression denoting the path within the object where a value substitution should be applied | [optional] +**Value** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Value to be assigned at the jsonPath location within the object | [optional] +**Mode** | Pointer to **[]String** | Draft modes to which this rule will apply | [optional] + +## Examples + +- Prepare the resource +```powershell +$SpConfigRule = Initialize-PSSailpoint.V2024SpConfigRule -Path $.enabled ` + -Value null ` + -Mode [RESTORE, PROMOTE] +``` + +- Convert the resource to JSON +```powershell +$SpConfigRule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigRules.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigRules.md new file mode 100644 index 000000000..8bf6f211d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SpConfigRules.md @@ -0,0 +1,39 @@ +--- +id: v2024-sp-config-rules +title: SpConfigRules +pagination_label: SpConfigRules +sidebar_label: SpConfigRules +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigRules', 'V2024SpConfigRules'] +slug: /tools/sdk/powershell/v2024/models/sp-config-rules +tags: ['SDK', 'Software Development Kit', 'SpConfigRules', 'V2024SpConfigRules'] +--- + + +# SpConfigRules + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TakeFromTargetRules** | Pointer to [**[]SpConfigRule**](sp-config-rule) | | [optional] +**DefaultRules** | Pointer to [**[]SpConfigRule**](sp-config-rule) | | [optional] +**Editable** | Pointer to **Boolean** | Whether this object can be edited | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$SpConfigRules = Initialize-PSSailpoint.V2024SpConfigRules -TakeFromTargetRules null ` + -DefaultRules null ` + -Editable true +``` + +- Convert the resource to JSON +```powershell +$SpConfigRules | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Split.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Split.md new file mode 100644 index 000000000..52f8229ca --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Split.md @@ -0,0 +1,43 @@ +--- +id: v2024-split +title: Split +pagination_label: Split +sidebar_label: Split +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Split', 'V2024Split'] +slug: /tools/sdk/powershell/v2024/models/split +tags: ['SDK', 'Software Development Kit', 'Split', 'V2024Split'] +--- + + +# Split + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Delimiter** | **String** | This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data | [required] +**Index** | **String** | An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc. | [required] +**Throws** | Pointer to **Boolean** | A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) `true` - The transform should return ""IndexOutOfBoundsException"" `false` - The transform should return null If not provided, the transform will default to false and return a null | [optional] [default to $false] +**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] + +## Examples + +- Prepare the resource +```powershell +$Split = Initialize-PSSailpoint.V2024Split -Delimiter , ` + -Index 5 ` + -Throws true ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Split | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/StandardLevel.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/StandardLevel.md new file mode 100644 index 000000000..a62b094dd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/StandardLevel.md @@ -0,0 +1,34 @@ +--- +id: v2024-standard-level +title: StandardLevel +pagination_label: StandardLevel +sidebar_label: StandardLevel +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'StandardLevel', 'V2024StandardLevel'] +slug: /tools/sdk/powershell/v2024/models/standard-level +tags: ['SDK', 'Software Development Kit', 'StandardLevel', 'V2024StandardLevel'] +--- + + +# StandardLevel + +## Enum + + +* `false` (value: `"false"`) + +* `FATAL` (value: `"FATAL"`) + +* `ERROR` (value: `"ERROR"`) + +* `WARN` (value: `"WARN"`) + +* `INFO` (value: `"INFO"`) + +* `DEBUG` (value: `"DEBUG"`) + +* `TRACE` (value: `"TRACE"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/StartInvocationInput.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/StartInvocationInput.md new file mode 100644 index 000000000..8414906a4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/StartInvocationInput.md @@ -0,0 +1,39 @@ +--- +id: v2024-start-invocation-input +title: StartInvocationInput +pagination_label: StartInvocationInput +sidebar_label: StartInvocationInput +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'StartInvocationInput', 'V2024StartInvocationInput'] +slug: /tools/sdk/powershell/v2024/models/start-invocation-input +tags: ['SDK', 'Software Development Kit', 'StartInvocationInput', 'V2024StartInvocationInput'] +--- + + +# StartInvocationInput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TriggerId** | Pointer to **String** | Trigger ID | [optional] +**VarInput** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Trigger input payload. Its schema is defined in the trigger definition. | [optional] +**ContentJson** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | JSON map of invocation metadata | [optional] + +## Examples + +- Prepare the resource +```powershell +$StartInvocationInput = Initialize-PSSailpoint.V2024StartInvocationInput -TriggerId idn:access-requested ` + -VarInput {identityId=201327fda1c44704ac01181e963d463c} ` + -ContentJson {workflowId=1234} +``` + +- Convert the resource to JSON +```powershell +$StartInvocationInput | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Static.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Static.md new file mode 100644 index 000000000..b5f3572f8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Static.md @@ -0,0 +1,37 @@ +--- +id: v2024-static +title: Static +pagination_label: Static +sidebar_label: Static +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Static', 'V2024Static'] +slug: /tools/sdk/powershell/v2024/models/static +tags: ['SDK', 'Software Development Kit', 'Static', 'V2024Static'] +--- + + +# Static + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Values** | **String** | This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language. | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$Static = Initialize-PSSailpoint.V2024Static -Values string$variable ` + -RequiresPeriodicRefresh false +``` + +- Convert the resource to JSON +```powershell +$Static | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/StatusResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/StatusResponse.md new file mode 100644 index 000000000..3cef9611f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/StatusResponse.md @@ -0,0 +1,43 @@ +--- +id: v2024-status-response +title: StatusResponse +pagination_label: StatusResponse +sidebar_label: StatusResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'StatusResponse', 'V2024StatusResponse'] +slug: /tools/sdk/powershell/v2024/models/status-response +tags: ['SDK', 'Software Development Kit', 'StatusResponse', 'V2024StatusResponse'] +--- + + +# StatusResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the source | [optional] [readonly] +**Name** | Pointer to **String** | Name of the source | [optional] [readonly] +**Status** | Pointer to **Enum** [ "SUCCESS", "FAILURE" ] | The status of the health check. | [optional] [readonly] +**ElapsedMillis** | Pointer to **Int32** | The number of milliseconds spent on the entire request. | [optional] [readonly] +**Details** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The document contains the results of the health check. The schema of this document depends on the type of source used. | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$StatusResponse = Initialize-PSSailpoint.V2024StatusResponse -Id 2c91808568c529c60168cca6f90c1313 ` + -Name ODS-AD-Test [source-999999] ` + -Status SUCCESS ` + -ElapsedMillis 1000 ` + -Details {useTLSForIQService=false, IQService={TLS Port=0, .NET CLR Version=4.0.30319.42000, SecondaryServiceStatus=Running, Port=5050, Host=AUTOMATION-AD, Name=IQService, IQServiceStatus=Running, SecondaryService=IQService-Instance1-Secondary, Version=IQService Sep-2020, secondaryPort=5051, OS Architecture=AMD64, Operating System=Microsoft Windows Server 2012 R2 Standard, highestDotNetVersion=4.8 or later, Build Time=09/22/2020 06:34 AM -0500}, IQServiceClientAuthEnabled=false, requestProcessedOn=1/19/2021 1:47:14 PM} +``` + +- Convert the resource to JSON +```powershell +$StatusResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SubSearchAggregationSpecification.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SubSearchAggregationSpecification.md new file mode 100644 index 000000000..71f15fe27 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SubSearchAggregationSpecification.md @@ -0,0 +1,43 @@ +--- +id: v2024-sub-search-aggregation-specification +title: SubSearchAggregationSpecification +pagination_label: SubSearchAggregationSpecification +sidebar_label: SubSearchAggregationSpecification +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SubSearchAggregationSpecification', 'V2024SubSearchAggregationSpecification'] +slug: /tools/sdk/powershell/v2024/models/sub-search-aggregation-specification +tags: ['SDK', 'Software Development Kit', 'SubSearchAggregationSpecification', 'V2024SubSearchAggregationSpecification'] +--- + + +# SubSearchAggregationSpecification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Nested** | Pointer to [**NestedAggregation**](nested-aggregation) | | [optional] +**Metric** | Pointer to [**MetricAggregation**](metric-aggregation) | | [optional] +**VarFilter** | Pointer to [**FilterAggregation**](filter-aggregation) | | [optional] +**Bucket** | Pointer to [**BucketAggregation**](bucket-aggregation) | | [optional] +**SubAggregation** | Pointer to [**Aggregations**](aggregations) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SubSearchAggregationSpecification = Initialize-PSSailpoint.V2024SubSearchAggregationSpecification -Nested null ` + -Metric null ` + -VarFilter null ` + -Bucket null ` + -SubAggregation null +``` + +- Convert the resource to JSON +```powershell +$SubSearchAggregationSpecification | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Subscription.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Subscription.md new file mode 100644 index 000000000..49d8b6e32 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Subscription.md @@ -0,0 +1,55 @@ +--- +id: v2024-subscription +title: Subscription +pagination_label: Subscription +sidebar_label: Subscription +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Subscription', 'V2024Subscription'] +slug: /tools/sdk/powershell/v2024/models/subscription +tags: ['SDK', 'Software Development Kit', 'Subscription', 'V2024Subscription'] +--- + + +# Subscription + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Subscription ID. | [required] +**Name** | **String** | Subscription name. | [required] +**Description** | Pointer to **String** | Subscription description. | [optional] +**TriggerId** | **String** | ID of trigger subscribed to. | [required] +**TriggerName** | **String** | Trigger name of trigger subscribed to. | [required] +**Type** | [**SubscriptionType**](subscription-type) | | [required] +**ResponseDeadline** | Pointer to **String** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to "PT1H"] +**HttpConfig** | Pointer to [**HttpConfig**](http-config) | | [optional] +**EventBridgeConfig** | Pointer to [**EventBridgeConfig**](event-bridge-config) | | [optional] +**Enabled** | **Boolean** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [required][default to $true] +**VarFilter** | Pointer to **String** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Subscription = Initialize-PSSailpoint.V2024Subscription -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -Name Access request subscription ` + -Description Access requested to site xyz ` + -TriggerId idn:access-request-post-approval ` + -TriggerName Access Requested ` + -Type null ` + -ResponseDeadline PT1H ` + -HttpConfig null ` + -EventBridgeConfig null ` + -Enabled true ` + -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] +``` + +- Convert the resource to JSON +```powershell +$Subscription | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SubscriptionPatchRequestInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SubscriptionPatchRequestInner.md new file mode 100644 index 000000000..9f5ed2864 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SubscriptionPatchRequestInner.md @@ -0,0 +1,39 @@ +--- +id: v2024-subscription-patch-request-inner +title: SubscriptionPatchRequestInner +pagination_label: SubscriptionPatchRequestInner +sidebar_label: SubscriptionPatchRequestInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SubscriptionPatchRequestInner', 'V2024SubscriptionPatchRequestInner'] +slug: /tools/sdk/powershell/v2024/models/subscription-patch-request-inner +tags: ['SDK', 'Software Development Kit', 'SubscriptionPatchRequestInner', 'V2024SubscriptionPatchRequestInner'] +--- + + +# SubscriptionPatchRequestInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | **Enum** [ "add", "remove", "replace", "move", "copy" ] | The operation to be performed | [required] +**Path** | **String** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required] +**Value** | Pointer to [**SubscriptionPatchRequestInnerValue**](subscription-patch-request-inner-value) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SubscriptionPatchRequestInner = Initialize-PSSailpoint.V2024SubscriptionPatchRequestInner -Op replace ` + -Path /description ` + -Value null +``` + +- Convert the resource to JSON +```powershell +$SubscriptionPatchRequestInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SubscriptionPatchRequestInnerValue.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SubscriptionPatchRequestInnerValue.md new file mode 100644 index 000000000..911a70c43 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SubscriptionPatchRequestInnerValue.md @@ -0,0 +1,34 @@ +--- +id: v2024-subscription-patch-request-inner-value +title: SubscriptionPatchRequestInnerValue +pagination_label: SubscriptionPatchRequestInnerValue +sidebar_label: SubscriptionPatchRequestInnerValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SubscriptionPatchRequestInnerValue', 'V2024SubscriptionPatchRequestInnerValue'] +slug: /tools/sdk/powershell/v2024/models/subscription-patch-request-inner-value +tags: ['SDK', 'Software Development Kit', 'SubscriptionPatchRequestInnerValue', 'V2024SubscriptionPatchRequestInnerValue'] +--- + + +# SubscriptionPatchRequestInnerValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$SubscriptionPatchRequestInnerValue = Initialize-PSSailpoint.V2024SubscriptionPatchRequestInnerValue +``` + +- Convert the resource to JSON +```powershell +$SubscriptionPatchRequestInnerValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SubscriptionPatchRequestInnerValueAnyOfInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SubscriptionPatchRequestInnerValueAnyOfInner.md new file mode 100644 index 000000000..5a1c51226 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SubscriptionPatchRequestInnerValueAnyOfInner.md @@ -0,0 +1,34 @@ +--- +id: v2024-subscription-patch-request-inner-value-any-of-inner +title: SubscriptionPatchRequestInnerValueAnyOfInner +pagination_label: SubscriptionPatchRequestInnerValueAnyOfInner +sidebar_label: SubscriptionPatchRequestInnerValueAnyOfInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SubscriptionPatchRequestInnerValueAnyOfInner', 'V2024SubscriptionPatchRequestInnerValueAnyOfInner'] +slug: /tools/sdk/powershell/v2024/models/subscription-patch-request-inner-value-any-of-inner +tags: ['SDK', 'Software Development Kit', 'SubscriptionPatchRequestInnerValueAnyOfInner', 'V2024SubscriptionPatchRequestInnerValueAnyOfInner'] +--- + + +# SubscriptionPatchRequestInnerValueAnyOfInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$SubscriptionPatchRequestInnerValueAnyOfInner = Initialize-PSSailpoint.V2024SubscriptionPatchRequestInnerValueAnyOfInner +``` + +- Convert the resource to JSON +```powershell +$SubscriptionPatchRequestInnerValueAnyOfInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SubscriptionPostRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SubscriptionPostRequest.md new file mode 100644 index 000000000..3d521f1dd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SubscriptionPostRequest.md @@ -0,0 +1,51 @@ +--- +id: v2024-subscription-post-request +title: SubscriptionPostRequest +pagination_label: SubscriptionPostRequest +sidebar_label: SubscriptionPostRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SubscriptionPostRequest', 'V2024SubscriptionPostRequest'] +slug: /tools/sdk/powershell/v2024/models/subscription-post-request +tags: ['SDK', 'Software Development Kit', 'SubscriptionPostRequest', 'V2024SubscriptionPostRequest'] +--- + + +# SubscriptionPostRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Subscription name. | [required] +**Description** | Pointer to **String** | Subscription description. | [optional] +**TriggerId** | **String** | ID of trigger subscribed to. | [required] +**Type** | [**SubscriptionType**](subscription-type) | | [required] +**ResponseDeadline** | Pointer to **String** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to "PT1H"] +**HttpConfig** | Pointer to [**HttpConfig**](http-config) | | [optional] +**EventBridgeConfig** | Pointer to [**EventBridgeConfig**](event-bridge-config) | | [optional] +**Enabled** | Pointer to **Boolean** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [optional] [default to $true] +**VarFilter** | Pointer to **String** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SubscriptionPostRequest = Initialize-PSSailpoint.V2024SubscriptionPostRequest -Name Access request subscription ` + -Description Access requested to site xyz ` + -TriggerId idn:access-requested ` + -Type null ` + -ResponseDeadline PT1H ` + -HttpConfig null ` + -EventBridgeConfig null ` + -Enabled true ` + -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] +``` + +- Convert the resource to JSON +```powershell +$SubscriptionPostRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SubscriptionPutRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SubscriptionPutRequest.md new file mode 100644 index 000000000..54256fd6d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SubscriptionPutRequest.md @@ -0,0 +1,49 @@ +--- +id: v2024-subscription-put-request +title: SubscriptionPutRequest +pagination_label: SubscriptionPutRequest +sidebar_label: SubscriptionPutRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SubscriptionPutRequest', 'V2024SubscriptionPutRequest'] +slug: /tools/sdk/powershell/v2024/models/subscription-put-request +tags: ['SDK', 'Software Development Kit', 'SubscriptionPutRequest', 'V2024SubscriptionPutRequest'] +--- + + +# SubscriptionPutRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Subscription name. | [optional] +**Description** | Pointer to **String** | Subscription description. | [optional] +**Type** | Pointer to [**SubscriptionType**](subscription-type) | | [optional] +**ResponseDeadline** | Pointer to **String** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to "PT1H"] +**HttpConfig** | Pointer to [**HttpConfig**](http-config) | | [optional] +**EventBridgeConfig** | Pointer to [**EventBridgeConfig**](event-bridge-config) | | [optional] +**Enabled** | Pointer to **Boolean** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [optional] [default to $true] +**VarFilter** | Pointer to **String** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SubscriptionPutRequest = Initialize-PSSailpoint.V2024SubscriptionPutRequest -Name Access request subscription ` + -Description Access requested to site xyz ` + -Type null ` + -ResponseDeadline PT1H ` + -HttpConfig null ` + -EventBridgeConfig null ` + -Enabled true ` + -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] +``` + +- Convert the resource to JSON +```powershell +$SubscriptionPutRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SubscriptionType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SubscriptionType.md new file mode 100644 index 000000000..785acef49 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/SubscriptionType.md @@ -0,0 +1,30 @@ +--- +id: v2024-subscription-type +title: SubscriptionType +pagination_label: SubscriptionType +sidebar_label: SubscriptionType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SubscriptionType', 'V2024SubscriptionType'] +slug: /tools/sdk/powershell/v2024/models/subscription-type +tags: ['SDK', 'Software Development Kit', 'SubscriptionType', 'V2024SubscriptionType'] +--- + + +# SubscriptionType + +## Enum + + +* `HTTP` (value: `"HTTP"`) + +* `EVENTBRIDGE` (value: `"EVENTBRIDGE"`) + +* `INLINE` (value: `"INLINE"`) + +* `SCRIPT` (value: `"SCRIPT"`) + +* `WORKFLOW` (value: `"WORKFLOW"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Substring.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Substring.md new file mode 100644 index 000000000..d70e90f39 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Substring.md @@ -0,0 +1,45 @@ +--- +id: v2024-substring +title: Substring +pagination_label: Substring +sidebar_label: Substring +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Substring', 'V2024Substring'] +slug: /tools/sdk/powershell/v2024/models/substring +tags: ['SDK', 'Software Development Kit', 'Substring', 'V2024Substring'] +--- + + +# Substring + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarBegin** | **Int32** | The index of the first character to include in the returned substring. If `begin` is set to -1, the transform will begin at character 0 of the input data | [required] +**BeginOffset** | Pointer to **Int32** | This integer value is the number of characters to add to the begin attribute when returning a substring. This attribute is only used if begin is not -1. | [optional] +**VarEnd** | Pointer to **Int32** | The index of the first character to exclude from the returned substring. If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. | [optional] +**EndOffset** | Pointer to **Int32** | This integer value is the number of characters to add to the end attribute when returning a substring. This attribute is only used if end is provided and is not -1. | [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] + +## Examples + +- Prepare the resource +```powershell +$Substring = Initialize-PSSailpoint.V2024Substring -VarBegin 1 ` + -BeginOffset 3 ` + -VarEnd 6 ` + -EndOffset 1 ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Substring | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaggedObject.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaggedObject.md new file mode 100644 index 000000000..8923c7eec --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaggedObject.md @@ -0,0 +1,37 @@ +--- +id: v2024-tagged-object +title: TaggedObject +pagination_label: TaggedObject +sidebar_label: TaggedObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaggedObject', 'V2024TaggedObject'] +slug: /tools/sdk/powershell/v2024/models/tagged-object +tags: ['SDK', 'Software Development Kit', 'TaggedObject', 'V2024TaggedObject'] +--- + + +# TaggedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectRef** | Pointer to [**TaggedObjectDto**](tagged-object-dto) | | [optional] +**Tags** | Pointer to **[]String** | Labels to be applied to an Object | [optional] + +## Examples + +- Prepare the resource +```powershell +$TaggedObject = Initialize-PSSailpoint.V2024TaggedObject -ObjectRef null ` + -Tags [BU_FINANCE, PCI] +``` + +- Convert the resource to JSON +```powershell +$TaggedObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaggedObjectDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaggedObjectDto.md new file mode 100644 index 000000000..19c0fc096 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaggedObjectDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-tagged-object-dto +title: TaggedObjectDto +pagination_label: TaggedObjectDto +sidebar_label: TaggedObjectDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaggedObjectDto', 'V2024TaggedObjectDto'] +slug: /tools/sdk/powershell/v2024/models/tagged-object-dto +tags: ['SDK', 'Software Development Kit', 'TaggedObjectDto', 'V2024TaggedObjectDto'] +--- + + +# TaggedObjectDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "APPLICATION", "CAMPAIGN", "ENTITLEMENT", "IDENTITY", "ROLE", "SOD_POLICY", "SOURCE" ] | DTO type | [optional] +**Id** | Pointer to **String** | ID of the object this reference applies to | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object this reference applies to | [optional] + +## Examples + +- Prepare the resource +```powershell +$TaggedObjectDto = Initialize-PSSailpoint.V2024TaggedObjectDto -Type IDENTITY ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$TaggedObjectDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Target.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Target.md new file mode 100644 index 000000000..137c80951 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Target.md @@ -0,0 +1,39 @@ +--- +id: v2024-target +title: Target +pagination_label: Target +sidebar_label: Target +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Target', 'V2024Target'] +slug: /tools/sdk/powershell/v2024/models/target +tags: ['SDK', 'Software Development Kit', 'Target', 'V2024Target'] +--- + + +# Target + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Target ID | [optional] +**Type** | Pointer to **Enum** [ "APPLICATION", "IDENTITY" ] | Target type | [optional] +**Name** | Pointer to **String** | Target name | [optional] + +## Examples + +- Prepare the resource +```powershell +$Target = Initialize-PSSailpoint.V2024Target -Id c6dc37bf508149b28ce5b7d90ca4bbf9 ` + -Type APPLICATION ` + -Name Active Directory [source] +``` + +- Convert the resource to JSON +```powershell +$Target | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskDefinitionSummary.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskDefinitionSummary.md new file mode 100644 index 000000000..f9f439606 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskDefinitionSummary.md @@ -0,0 +1,45 @@ +--- +id: v2024-task-definition-summary +title: TaskDefinitionSummary +pagination_label: TaskDefinitionSummary +sidebar_label: TaskDefinitionSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskDefinitionSummary', 'V2024TaskDefinitionSummary'] +slug: /tools/sdk/powershell/v2024/models/task-definition-summary +tags: ['SDK', 'Software Development Kit', 'TaskDefinitionSummary', 'V2024TaskDefinitionSummary'] +--- + + +# TaskDefinitionSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | System-generated unique ID of the TaskDefinition | [required] +**UniqueName** | **String** | Name of the TaskDefinition | [required] +**Description** | **String** | Description of the TaskDefinition | [required] +**ParentName** | **String** | Name of the parent of the TaskDefinition | [required] +**Executor** | **String** | Executor of the TaskDefinition | [required] +**Arguments** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Formal parameters of the TaskDefinition, without values | [required] + +## Examples + +- Prepare the resource +```powershell +$TaskDefinitionSummary = Initialize-PSSailpoint.V2024TaskDefinitionSummary -Id 2c91808475b4334b0175e1dff64b63c5 ` + -UniqueName Cloud Account Aggregation ` + -Description Aggregates from the specified application. ` + -ParentName Cloud Account Aggregation ` + -Executor sailpoint.task.ServiceTaskExecutor ` + -Arguments null +``` + +- Convert the resource to JSON +```powershell +$TaskDefinitionSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskResultDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskResultDetails.md new file mode 100644 index 000000000..b4cb5cbc7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskResultDetails.md @@ -0,0 +1,61 @@ +--- +id: v2024-task-result-details +title: TaskResultDetails +pagination_label: TaskResultDetails +sidebar_label: TaskResultDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskResultDetails', 'V2024TaskResultDetails'] +slug: /tools/sdk/powershell/v2024/models/task-result-details +tags: ['SDK', 'Software Development Kit', 'TaskResultDetails', 'V2024TaskResultDetails'] +--- + + +# TaskResultDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "QUARTZ", "QPOC", "MENTOS", "QUEUED_TASK" ] | Type of the job or task underlying in the report processing. It could be a quartz task, QPOC or MENTOS jobs or a refresh/sync task. | [optional] +**Id** | Pointer to **String** | Unique task definition identifier. | [optional] +**ReportType** | Pointer to **Enum** [ "ACCOUNTS", "IDENTITIES_DETAILS", "IDENTITIES", "IDENTITY_PROFILE_IDENTITY_ERROR", "ORPHAN_IDENTITIES", "SEARCH_EXPORT", "UNCORRELATED_ACCOUNTS" ] | Use this property to define what report should be processed in the RDE service. | [optional] +**Description** | Pointer to **String** | Description of the report purpose and/or contents. | [optional] +**ParentName** | Pointer to **String** | Name of the parent task/report if exists. | [optional] +**Launcher** | Pointer to **String** | Name of the report processing initiator. | [optional] +**Created** | Pointer to **System.DateTime** | Report creation date | [optional] +**Launched** | Pointer to **System.DateTime** | Report start date | [optional] +**Completed** | Pointer to **System.DateTime** | Report completion date | [optional] +**CompletionStatus** | Pointer to **Enum** [ "SUCCESS", "WARNING", "ERROR", "TERMINATED", "TEMP_ERROR" ] | Report completion status. | [optional] +**Messages** | Pointer to [**[]TaskResultDetailsMessagesInner**](task-result-details-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional] +**Returns** | Pointer to [**[]TaskResultDetailsReturnsInner**](task-result-details-returns-inner) | Task definition results, if necessary. | [optional] +**Attributes** | Pointer to [**map[string]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Extra attributes map(dictionary) needed for the report. | [optional] +**Progress** | Pointer to **String** | Current report state. | [optional] + +## Examples + +- Prepare the resource +```powershell +$TaskResultDetails = Initialize-PSSailpoint.V2024TaskResultDetails -Type MENTOS ` + -Id a248c16fe22222b2bd49615481311111 ` + -ReportType IDENTITIES_DETAILS ` + -Description A detailed view of the identities in the system. ` + -ParentName Audit Report ` + -Launcher cloudadmin ` + -Created null ` + -Launched null ` + -Completed null ` + -CompletionStatus Success ` + -Messages [] ` + -Returns [] ` + -Attributes {org=an-org} ` + -Progress Initializing... +``` + +- Convert the resource to JSON +```powershell +$TaskResultDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskResultDetailsMessagesInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskResultDetailsMessagesInner.md new file mode 100644 index 000000000..065462e55 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskResultDetailsMessagesInner.md @@ -0,0 +1,43 @@ +--- +id: v2024-task-result-details-messages-inner +title: TaskResultDetailsMessagesInner +pagination_label: TaskResultDetailsMessagesInner +sidebar_label: TaskResultDetailsMessagesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskResultDetailsMessagesInner', 'V2024TaskResultDetailsMessagesInner'] +slug: /tools/sdk/powershell/v2024/models/task-result-details-messages-inner +tags: ['SDK', 'Software Development Kit', 'TaskResultDetailsMessagesInner', 'V2024TaskResultDetailsMessagesInner'] +--- + + +# TaskResultDetailsMessagesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "INFO", "WARN", "ERROR" ] | Type of the message. | [optional] +**VarError** | Pointer to **Boolean** | Flag whether message is an error. | [optional] [default to $false] +**Warning** | Pointer to **Boolean** | Flag whether message is a warning. | [optional] [default to $false] +**Key** | Pointer to **String** | Message string identifier. | [optional] +**LocalizedText** | Pointer to **String** | Message context with the locale based language. | [optional] + +## Examples + +- Prepare the resource +```powershell +$TaskResultDetailsMessagesInner = Initialize-PSSailpoint.V2024TaskResultDetailsMessagesInner -Type WARN ` + -VarError false ` + -Warning true ` + -Key The following account(s) failed to correlate: A,B,C ` + -LocalizedText The following account(s) failed to correlate: A,B,C +``` + +- Convert the resource to JSON +```powershell +$TaskResultDetailsMessagesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskResultDetailsReturnsInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskResultDetailsReturnsInner.md new file mode 100644 index 000000000..be11df85a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskResultDetailsReturnsInner.md @@ -0,0 +1,37 @@ +--- +id: v2024-task-result-details-returns-inner +title: TaskResultDetailsReturnsInner +pagination_label: TaskResultDetailsReturnsInner +sidebar_label: TaskResultDetailsReturnsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskResultDetailsReturnsInner', 'V2024TaskResultDetailsReturnsInner'] +slug: /tools/sdk/powershell/v2024/models/task-result-details-returns-inner +tags: ['SDK', 'Software Development Kit', 'TaskResultDetailsReturnsInner', 'V2024TaskResultDetailsReturnsInner'] +--- + + +# TaskResultDetailsReturnsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayLabel** | Pointer to **String** | Attribute description. | [optional] +**AttributeName** | Pointer to **String** | System or database attribute name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$TaskResultDetailsReturnsInner = Initialize-PSSailpoint.V2024TaskResultDetailsReturnsInner -DisplayLabel ` + -AttributeName +``` + +- Convert the resource to JSON +```powershell +$TaskResultDetailsReturnsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskResultDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskResultDto.md new file mode 100644 index 000000000..442ab8e2e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskResultDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-task-result-dto +title: TaskResultDto +pagination_label: TaskResultDto +sidebar_label: TaskResultDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskResultDto', 'V2024TaskResultDto'] +slug: /tools/sdk/powershell/v2024/models/task-result-dto +tags: ['SDK', 'Software Development Kit', 'TaskResultDto', 'V2024TaskResultDto'] +--- + + +# TaskResultDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "TASK_RESULT" ] | Task result DTO type. | [optional] +**Id** | Pointer to **String** | Task result ID. | [optional] +**Name** | Pointer to **String** | Task result display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$TaskResultDto = Initialize-PSSailpoint.V2024TaskResultDto -Type TASK_RESULT ` + -Id 464ae7bf791e49fdb74606a2e4a89635 ` + -Name null +``` + +- Convert the resource to JSON +```powershell +$TaskResultDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskResultResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskResultResponse.md new file mode 100644 index 000000000..a1d48ae8c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskResultResponse.md @@ -0,0 +1,39 @@ +--- +id: v2024-task-result-response +title: TaskResultResponse +pagination_label: TaskResultResponse +sidebar_label: TaskResultResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskResultResponse', 'V2024TaskResultResponse'] +slug: /tools/sdk/powershell/v2024/models/task-result-response +tags: ['SDK', 'Software Development Kit', 'TaskResultResponse', 'V2024TaskResultResponse'] +--- + + +# TaskResultResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **String** | the type of response reference | [optional] +**Id** | Pointer to **String** | the task ID | [optional] +**Name** | Pointer to **String** | the task name (not used in this endpoint, always null) | [optional] + +## Examples + +- Prepare the resource +```powershell +$TaskResultResponse = Initialize-PSSailpoint.V2024TaskResultResponse -Type TASK_RESULT ` + -Id 78733556-9ea3-4f59-bf69-e5cd92b011b4 ` + -Name null +``` + +- Convert the resource to JSON +```powershell +$TaskResultResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskResultSimplified.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskResultSimplified.md new file mode 100644 index 000000000..d302d54b3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskResultSimplified.md @@ -0,0 +1,47 @@ +--- +id: v2024-task-result-simplified +title: TaskResultSimplified +pagination_label: TaskResultSimplified +sidebar_label: TaskResultSimplified +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskResultSimplified', 'V2024TaskResultSimplified'] +slug: /tools/sdk/powershell/v2024/models/task-result-simplified +tags: ['SDK', 'Software Development Kit', 'TaskResultSimplified', 'V2024TaskResultSimplified'] +--- + + +# TaskResultSimplified + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Task identifier | [optional] +**Name** | Pointer to **String** | Task name | [optional] +**Description** | Pointer to **String** | Task description | [optional] +**Launcher** | Pointer to **String** | User or process who launched the task | [optional] +**Completed** | Pointer to **System.DateTime** | Date time of completion | [optional] +**Launched** | Pointer to **System.DateTime** | Date time when the task was launched | [optional] +**CompletionStatus** | Pointer to **Enum** [ "Success", "Warning", "Error", "Terminated", "TempError" ] | Task result status | [optional] + +## Examples + +- Prepare the resource +```powershell +$TaskResultSimplified = Initialize-PSSailpoint.V2024TaskResultSimplified -Id ff8081814d977c21014da056804a0af3 ` + -Name Background Object Terminator c8f030f2-b1a6-4e33-99e8-6935bc18735d ` + -Description Generic task for terminating data in the overlay, used by the TerminationService. ` + -Launcher support ` + -Completed null ` + -Launched null ` + -CompletionStatus Success +``` + +- Convert the resource to JSON +```powershell +$TaskResultSimplified | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskReturnDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskReturnDetails.md new file mode 100644 index 000000000..208d4a54a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskReturnDetails.md @@ -0,0 +1,37 @@ +--- +id: v2024-task-return-details +title: TaskReturnDetails +pagination_label: TaskReturnDetails +sidebar_label: TaskReturnDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskReturnDetails', 'V2024TaskReturnDetails'] +slug: /tools/sdk/powershell/v2024/models/task-return-details +tags: ['SDK', 'Software Development Kit', 'TaskReturnDetails', 'V2024TaskReturnDetails'] +--- + + +# TaskReturnDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Display name of the TaskReturnDetails | [required] +**AttributeName** | **String** | Attribute the TaskReturnDetails is for | [required] + +## Examples + +- Prepare the resource +```powershell +$TaskReturnDetails = Initialize-PSSailpoint.V2024TaskReturnDetails -Name label ` + -AttributeName identityCount +``` + +- Convert the resource to JSON +```powershell +$TaskReturnDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskStatus.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskStatus.md new file mode 100644 index 000000000..1d372d0c5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskStatus.md @@ -0,0 +1,69 @@ +--- +id: v2024-task-status +title: TaskStatus +pagination_label: TaskStatus +sidebar_label: TaskStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskStatus', 'V2024TaskStatus'] +slug: /tools/sdk/powershell/v2024/models/task-status +tags: ['SDK', 'Software Development Kit', 'TaskStatus', 'V2024TaskStatus'] +--- + + +# TaskStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | System-generated unique ID of the task this TaskStatus represents | [required] +**Type** | **Enum** [ "QUARTZ", "QPOC", "QUEUED_TASK" ] | Type of task this TaskStatus represents | [required] +**UniqueName** | **String** | Name of the task this TaskStatus represents | [required] +**Description** | **String** | Description of the task this TaskStatus represents | [required] +**ParentName** | **String** | Name of the parent of the task this TaskStatus represents | [required] +**Launcher** | **String** | Service to execute the task this TaskStatus represents | [required] +**Target** | Pointer to [**Target**](target) | | [optional] +**Created** | **System.DateTime** | Creation date of the task this TaskStatus represents | [required] +**Modified** | **System.DateTime** | Last modification date of the task this TaskStatus represents | [required] +**Launched** | **System.DateTime** | Launch date of the task this TaskStatus represents | [required] +**Completed** | **System.DateTime** | Completion date of the task this TaskStatus represents | [required] +**CompletionStatus** | **Enum** [ "SUCCESS", "WARNING", "ERROR", "TERMINATED", "TEMPERROR" ] | Completion status of the task this TaskStatus represents | [required] +**Messages** | [**[]TaskStatusMessage**](task-status-message) | Messages associated with the task this TaskStatus represents | [required] +**Returns** | [**[]TaskReturnDetails**](task-return-details) | Return values from the task this TaskStatus represents | [required] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Attributes of the task this TaskStatus represents | [required] +**Progress** | **String** | Current progress of the task this TaskStatus represents | [required] +**PercentComplete** | **Int32** | Current percentage completion of the task this TaskStatus represents | [required] +**TaskDefinitionSummary** | Pointer to [**TaskDefinitionSummary**](task-definition-summary) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$TaskStatus = Initialize-PSSailpoint.V2024TaskStatus -Id id12345 ` + -Type QUARTZ ` + -UniqueName Big Task ` + -Description A Really Big Task ` + -ParentName Parent Task ` + -Launcher sweep ` + -Target null ` + -Created 2020-07-11T21:23:15Z ` + -Modified 2020-07-11T21:23:15Z ` + -Launched 2020-07-11T21:23:15Z ` + -Completed 2020-07-11T21:23:15Z ` + -CompletionStatus SUCCESS ` + -Messages null ` + -Returns null ` + -Attributes {identityCount=0} ` + -Progress Started ` + -PercentComplete 100 ` + -TaskDefinitionSummary null +``` + +- Convert the resource to JSON +```powershell +$TaskStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskStatusMessage.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskStatusMessage.md new file mode 100644 index 000000000..d8463a4aa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskStatusMessage.md @@ -0,0 +1,41 @@ +--- +id: v2024-task-status-message +title: TaskStatusMessage +pagination_label: TaskStatusMessage +sidebar_label: TaskStatusMessage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskStatusMessage', 'V2024TaskStatusMessage'] +slug: /tools/sdk/powershell/v2024/models/task-status-message +tags: ['SDK', 'Software Development Kit', 'TaskStatusMessage', 'V2024TaskStatusMessage'] +--- + + +# TaskStatusMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "INFO", "WARN", "ERROR" ] | Type of the message | [required] +**LocalizedText** | [**LocalizedMessage**](localized-message) | | [required] +**Key** | **String** | Key of the message | [required] +**Parameters** | [**[]TaskStatusMessageParametersInner**](task-status-message-parameters-inner) | Message parameters for internationalization | [required] + +## Examples + +- Prepare the resource +```powershell +$TaskStatusMessage = Initialize-PSSailpoint.V2024TaskStatusMessage -Type INFO ` + -LocalizedText null ` + -Key akey ` + -Parameters [{name=value}] +``` + +- Convert the resource to JSON +```powershell +$TaskStatusMessage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskStatusMessageParametersInner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskStatusMessageParametersInner.md new file mode 100644 index 000000000..d1ea3e972 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TaskStatusMessageParametersInner.md @@ -0,0 +1,34 @@ +--- +id: v2024-task-status-message-parameters-inner +title: TaskStatusMessageParametersInner +pagination_label: TaskStatusMessageParametersInner +sidebar_label: TaskStatusMessageParametersInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskStatusMessageParametersInner', 'V2024TaskStatusMessageParametersInner'] +slug: /tools/sdk/powershell/v2024/models/task-status-message-parameters-inner +tags: ['SDK', 'Software Development Kit', 'TaskStatusMessageParametersInner', 'V2024TaskStatusMessageParametersInner'] +--- + + +# TaskStatusMessageParametersInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$TaskStatusMessageParametersInner = Initialize-PSSailpoint.V2024TaskStatusMessageParametersInner +``` + +- Convert the resource to JSON +```powershell +$TaskStatusMessageParametersInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TemplateBulkDeleteDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TemplateBulkDeleteDto.md new file mode 100644 index 000000000..1e9df58bd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TemplateBulkDeleteDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-template-bulk-delete-dto +title: TemplateBulkDeleteDto +pagination_label: TemplateBulkDeleteDto +sidebar_label: TemplateBulkDeleteDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TemplateBulkDeleteDto', 'V2024TemplateBulkDeleteDto'] +slug: /tools/sdk/powershell/v2024/models/template-bulk-delete-dto +tags: ['SDK', 'Software Development Kit', 'TemplateBulkDeleteDto', 'V2024TemplateBulkDeleteDto'] +--- + + +# TemplateBulkDeleteDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | **String** | | [required] +**Medium** | Pointer to **Enum** [ "EMAIL", "PHONE", "SMS" ] | | [optional] +**Locale** | Pointer to **String** | The locale for the message text, a BCP 47 language tag. | [optional] + +## Examples + +- Prepare the resource +```powershell +$TemplateBulkDeleteDto = Initialize-PSSailpoint.V2024TemplateBulkDeleteDto -Key cloud_manual_work_item_summary ` + -Medium EMAIL ` + -Locale en +``` + +- Convert the resource to JSON +```powershell +$TemplateBulkDeleteDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TemplateDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TemplateDto.md new file mode 100644 index 000000000..08a10437f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TemplateDto.md @@ -0,0 +1,65 @@ +--- +id: v2024-template-dto +title: TemplateDto +pagination_label: TemplateDto +sidebar_label: TemplateDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TemplateDto', 'V2024TemplateDto'] +slug: /tools/sdk/powershell/v2024/models/template-dto +tags: ['SDK', 'Software Development Kit', 'TemplateDto', 'V2024TemplateDto'] +--- + + +# TemplateDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | **String** | The key of the template | [required] +**Name** | Pointer to **String** | The name of the Task Manager Subscription | [optional] +**Medium** | **Enum** [ "EMAIL", "PHONE", "SMS", "SLACK", "TEAMS" ] | The message medium. More mediums may be added in the future. | [required] +**Locale** | **String** | The locale for the message text, a BCP 47 language tag. | [required] +**Subject** | Pointer to **String** | The subject line in the template | [optional] +**Header** | Pointer to **String** | The header value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**Body** | Pointer to **String** | The body in the template | [optional] +**Footer** | Pointer to **String** | The footer value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**VarFrom** | Pointer to **String** | The ""From:"" address in the template | [optional] +**ReplyTo** | Pointer to **String** | The ""Reply To"" line in the template | [optional] +**Description** | Pointer to **String** | The description in the template | [optional] +**Id** | Pointer to **String** | This is auto-generated. | [optional] +**Created** | Pointer to **System.DateTime** | The time when this template is created. This is auto-generated. | [optional] +**Modified** | Pointer to **System.DateTime** | The time when this template was last modified. This is auto-generated. | [optional] +**SlackTemplate** | Pointer to **String** | | [optional] +**TeamsTemplate** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$TemplateDto = Initialize-PSSailpoint.V2024TemplateDto -Key cloud_manual_work_item_summary ` + -Name Task Manager Subscription ` + -Medium EMAIL ` + -Locale en ` + -Subject You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}. ` + -Header null ` + -Body Please go to the task manager ` + -Footer null ` + -VarFrom $__global.emailFromAddress ` + -ReplyTo $__global.emailFromAddress ` + -Description Daily digest - sent if number of outstanding tasks for task owner > 0 ` + -Id c17bea3a-574d-453c-9e04-4365fbf5af0b ` + -Created 2020-01-01T00:00Z ` + -Modified 2020-01-01T00:00Z ` + -SlackTemplate null ` + -TeamsTemplate null +``` + +- Convert the resource to JSON +```powershell +$TemplateDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TemplateDtoDefault.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TemplateDtoDefault.md new file mode 100644 index 000000000..c7c3b1129 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TemplateDtoDefault.md @@ -0,0 +1,59 @@ +--- +id: v2024-template-dto-default +title: TemplateDtoDefault +pagination_label: TemplateDtoDefault +sidebar_label: TemplateDtoDefault +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TemplateDtoDefault', 'V2024TemplateDtoDefault'] +slug: /tools/sdk/powershell/v2024/models/template-dto-default +tags: ['SDK', 'Software Development Kit', 'TemplateDtoDefault', 'V2024TemplateDtoDefault'] +--- + + +# TemplateDtoDefault + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **String** | The key of the default template | [optional] +**Name** | Pointer to **String** | The name of the default template | [optional] +**Medium** | Pointer to **Enum** [ "EMAIL", "PHONE", "SMS", "SLACK", "TEAMS" ] | The message medium. More mediums may be added in the future. | [optional] +**Locale** | Pointer to **String** | The locale for the message text, a BCP 47 language tag. | [optional] +**Subject** | Pointer to **String** | The subject of the default template | [optional] +**Header** | Pointer to **String** | The header value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**Body** | Pointer to **String** | The body of the default template | [optional] +**Footer** | Pointer to **String** | The footer value is now located within the body field. If included with non-null values, will result in a 400. | [optional] +**VarFrom** | Pointer to **String** | The ""From:"" address of the default template | [optional] +**ReplyTo** | Pointer to **String** | The ""Reply To"" field of the default template | [optional] +**Description** | Pointer to **String** | The description of the default template | [optional] +**SlackTemplate** | Pointer to [**TemplateSlack**](template-slack) | | [optional] +**TeamsTemplate** | Pointer to [**TemplateTeams**](template-teams) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$TemplateDtoDefault = Initialize-PSSailpoint.V2024TemplateDtoDefault -Key cloud_manual_work_item_summary ` + -Name Task Manager Subscription ` + -Medium EMAIL ` + -Locale en ` + -Subject You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}. ` + -Header null ` + -Body Please go to the task manager ` + -Footer null ` + -VarFrom $__global.emailFromAddress ` + -ReplyTo $__global.emailFromAddress ` + -Description Daily digest - sent if number of outstanding tasks for task owner > 0 ` + -SlackTemplate null ` + -TeamsTemplate null +``` + +- Convert the resource to JSON +```powershell +$TemplateDtoDefault | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TemplateSlack.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TemplateSlack.md new file mode 100644 index 000000000..15137689e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TemplateSlack.md @@ -0,0 +1,55 @@ +--- +id: v2024-template-slack +title: TemplateSlack +pagination_label: TemplateSlack +sidebar_label: TemplateSlack +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TemplateSlack', 'V2024TemplateSlack'] +slug: /tools/sdk/powershell/v2024/models/template-slack +tags: ['SDK', 'Software Development Kit', 'TemplateSlack', 'V2024TemplateSlack'] +--- + + +# TemplateSlack + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **String** | | [optional] +**Text** | Pointer to **String** | | [optional] +**Blocks** | Pointer to **String** | | [optional] +**Attachments** | Pointer to **String** | | [optional] +**NotificationType** | Pointer to **String** | | [optional] +**ApprovalId** | Pointer to **String** | | [optional] +**RequestId** | Pointer to **String** | | [optional] +**RequestedById** | Pointer to **String** | | [optional] +**IsSubscription** | Pointer to **Boolean** | | [optional] +**AutoApprovalData** | Pointer to [**TemplateSlackAutoApprovalData**](template-slack-auto-approval-data) | | [optional] +**CustomFields** | Pointer to [**TemplateSlackCustomFields**](template-slack-custom-fields) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$TemplateSlack = Initialize-PSSailpoint.V2024TemplateSlack -Key null ` + -Text null ` + -Blocks null ` + -Attachments null ` + -NotificationType null ` + -ApprovalId null ` + -RequestId null ` + -RequestedById null ` + -IsSubscription null ` + -AutoApprovalData null ` + -CustomFields null +``` + +- Convert the resource to JSON +```powershell +$TemplateSlack | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TemplateSlackAutoApprovalData.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TemplateSlackAutoApprovalData.md new file mode 100644 index 000000000..9872f869e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TemplateSlackAutoApprovalData.md @@ -0,0 +1,43 @@ +--- +id: v2024-template-slack-auto-approval-data +title: TemplateSlackAutoApprovalData +pagination_label: TemplateSlackAutoApprovalData +sidebar_label: TemplateSlackAutoApprovalData +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TemplateSlackAutoApprovalData', 'V2024TemplateSlackAutoApprovalData'] +slug: /tools/sdk/powershell/v2024/models/template-slack-auto-approval-data +tags: ['SDK', 'Software Development Kit', 'TemplateSlackAutoApprovalData', 'V2024TemplateSlackAutoApprovalData'] +--- + + +# TemplateSlackAutoApprovalData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsAutoApproved** | Pointer to **String** | | [optional] +**ItemId** | Pointer to **String** | | [optional] +**ItemType** | Pointer to **String** | | [optional] +**AutoApprovalMessageJSON** | Pointer to **String** | | [optional] +**AutoApprovalTitle** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$TemplateSlackAutoApprovalData = Initialize-PSSailpoint.V2024TemplateSlackAutoApprovalData -IsAutoApproved null ` + -ItemId null ` + -ItemType null ` + -AutoApprovalMessageJSON null ` + -AutoApprovalTitle null +``` + +- Convert the resource to JSON +```powershell +$TemplateSlackAutoApprovalData | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TemplateSlackCustomFields.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TemplateSlackCustomFields.md new file mode 100644 index 000000000..9a3ad70ee --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TemplateSlackCustomFields.md @@ -0,0 +1,41 @@ +--- +id: v2024-template-slack-custom-fields +title: TemplateSlackCustomFields +pagination_label: TemplateSlackCustomFields +sidebar_label: TemplateSlackCustomFields +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TemplateSlackCustomFields', 'V2024TemplateSlackCustomFields'] +slug: /tools/sdk/powershell/v2024/models/template-slack-custom-fields +tags: ['SDK', 'Software Development Kit', 'TemplateSlackCustomFields', 'V2024TemplateSlackCustomFields'] +--- + + +# TemplateSlackCustomFields + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestType** | Pointer to **String** | | [optional] +**ContainsDeny** | Pointer to **String** | | [optional] +**CampaignId** | Pointer to **String** | | [optional] +**CampaignStatus** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$TemplateSlackCustomFields = Initialize-PSSailpoint.V2024TemplateSlackCustomFields -RequestType null ` + -ContainsDeny null ` + -CampaignId null ` + -CampaignStatus null +``` + +- Convert the resource to JSON +```powershell +$TemplateSlackCustomFields | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TemplateTeams.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TemplateTeams.md new file mode 100644 index 000000000..e9e0ce45b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TemplateTeams.md @@ -0,0 +1,55 @@ +--- +id: v2024-template-teams +title: TemplateTeams +pagination_label: TemplateTeams +sidebar_label: TemplateTeams +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TemplateTeams', 'V2024TemplateTeams'] +slug: /tools/sdk/powershell/v2024/models/template-teams +tags: ['SDK', 'Software Development Kit', 'TemplateTeams', 'V2024TemplateTeams'] +--- + + +# TemplateTeams + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **String** | | [optional] +**Title** | Pointer to **String** | | [optional] +**Text** | Pointer to **String** | | [optional] +**MessageJSON** | Pointer to **String** | | [optional] +**IsSubscription** | Pointer to **Boolean** | | [optional] +**ApprovalId** | Pointer to **String** | | [optional] +**RequestId** | Pointer to **String** | | [optional] +**RequestedById** | Pointer to **String** | | [optional] +**NotificationType** | Pointer to **String** | | [optional] +**AutoApprovalData** | Pointer to [**TemplateSlackAutoApprovalData**](template-slack-auto-approval-data) | | [optional] +**CustomFields** | Pointer to [**TemplateSlackCustomFields**](template-slack-custom-fields) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$TemplateTeams = Initialize-PSSailpoint.V2024TemplateTeams -Key null ` + -Title null ` + -Text null ` + -MessageJSON null ` + -IsSubscription null ` + -ApprovalId null ` + -RequestId null ` + -RequestedById null ` + -NotificationType null ` + -AutoApprovalData null ` + -CustomFields null +``` + +- Convert the resource to JSON +```powershell +$TemplateTeams | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Tenant.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Tenant.md new file mode 100644 index 000000000..b0f19eb8a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Tenant.md @@ -0,0 +1,47 @@ +--- +id: v2024-tenant +title: Tenant +pagination_label: Tenant +sidebar_label: Tenant +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Tenant', 'V2024Tenant'] +slug: /tools/sdk/powershell/v2024/models/tenant +tags: ['SDK', 'Software Development Kit', 'Tenant', 'V2024Tenant'] +--- + + +# Tenant + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The unique identifier for the Tenant | [optional] [readonly] +**Name** | Pointer to **String** | Abbreviated name of the Tenant | [optional] +**FullName** | Pointer to **String** | Human-readable name of the Tenant | [optional] +**Pod** | Pointer to **String** | Deployment pod for the Tenant | [optional] +**Region** | Pointer to **String** | Deployment region for the Tenant | [optional] +**Description** | Pointer to **String** | Description of the Tenant | [optional] +**Products** | Pointer to [**[]Product**](product) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Tenant = Initialize-PSSailpoint.V2024Tenant -Id 2c91808568c529c60168cca6f90c1324 ` + -Name acme ` + -FullName Acme, Inc ` + -Pod example-pod ` + -Region us-east-1 ` + -Description Description of the Tenant ` + -Products null +``` + +- Convert the resource to JSON +```powershell +$Tenant | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TenantConfigurationDetails.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TenantConfigurationDetails.md new file mode 100644 index 000000000..7ab9065df --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TenantConfigurationDetails.md @@ -0,0 +1,35 @@ +--- +id: v2024-tenant-configuration-details +title: TenantConfigurationDetails +pagination_label: TenantConfigurationDetails +sidebar_label: TenantConfigurationDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TenantConfigurationDetails', 'V2024TenantConfigurationDetails'] +slug: /tools/sdk/powershell/v2024/models/tenant-configuration-details +tags: ['SDK', 'Software Development Kit', 'TenantConfigurationDetails', 'V2024TenantConfigurationDetails'] +--- + + +# TenantConfigurationDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Disabled** | Pointer to **Boolean** | Flag to determine if Reassignment Configuration is enabled or disabled for a tenant. When this flag is set to true, Reassignment Configuration is disabled. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$TenantConfigurationDetails = Initialize-PSSailpoint.V2024TenantConfigurationDetails -Disabled true +``` + +- Convert the resource to JSON +```powershell +$TenantConfigurationDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TenantConfigurationRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TenantConfigurationRequest.md new file mode 100644 index 000000000..7e73b5d64 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TenantConfigurationRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-tenant-configuration-request +title: TenantConfigurationRequest +pagination_label: TenantConfigurationRequest +sidebar_label: TenantConfigurationRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TenantConfigurationRequest', 'V2024TenantConfigurationRequest'] +slug: /tools/sdk/powershell/v2024/models/tenant-configuration-request +tags: ['SDK', 'Software Development Kit', 'TenantConfigurationRequest', 'V2024TenantConfigurationRequest'] +--- + + +# TenantConfigurationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ConfigDetails** | Pointer to [**TenantConfigurationDetails**](tenant-configuration-details) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$TenantConfigurationRequest = Initialize-PSSailpoint.V2024TenantConfigurationRequest -ConfigDetails null +``` + +- Convert the resource to JSON +```powershell +$TenantConfigurationRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TenantConfigurationResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TenantConfigurationResponse.md new file mode 100644 index 000000000..a1311c67e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TenantConfigurationResponse.md @@ -0,0 +1,37 @@ +--- +id: v2024-tenant-configuration-response +title: TenantConfigurationResponse +pagination_label: TenantConfigurationResponse +sidebar_label: TenantConfigurationResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TenantConfigurationResponse', 'V2024TenantConfigurationResponse'] +slug: /tools/sdk/powershell/v2024/models/tenant-configuration-response +tags: ['SDK', 'Software Development Kit', 'TenantConfigurationResponse', 'V2024TenantConfigurationResponse'] +--- + + +# TenantConfigurationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AuditDetails** | Pointer to [**AuditDetails**](audit-details) | | [optional] +**ConfigDetails** | Pointer to [**TenantConfigurationDetails**](tenant-configuration-details) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$TenantConfigurationResponse = Initialize-PSSailpoint.V2024TenantConfigurationResponse -AuditDetails null ` + -ConfigDetails null +``` + +- Convert the resource to JSON +```powershell +$TenantConfigurationResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TenantUiMetadataItemResponse.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TenantUiMetadataItemResponse.md new file mode 100644 index 000000000..81dd669b8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TenantUiMetadataItemResponse.md @@ -0,0 +1,39 @@ +--- +id: v2024-tenant-ui-metadata-item-response +title: TenantUiMetadataItemResponse +pagination_label: TenantUiMetadataItemResponse +sidebar_label: TenantUiMetadataItemResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TenantUiMetadataItemResponse', 'V2024TenantUiMetadataItemResponse'] +slug: /tools/sdk/powershell/v2024/models/tenant-ui-metadata-item-response +tags: ['SDK', 'Software Development Kit', 'TenantUiMetadataItemResponse', 'V2024TenantUiMetadataItemResponse'] +--- + + +# TenantUiMetadataItemResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IframeWhiteList** | Pointer to **String** | Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use ""null"". It will only allow include into iframe non authenticated portions of the product, such as password reset. | [optional] +**UsernameLabel** | Pointer to **String** | Descriptor for the username input field. If you would like to reset the value use ""null"". | [optional] +**UsernameEmptyText** | Pointer to **String** | Placeholder text displayed in the username input field. If you would like to reset the value use ""null"". | [optional] + +## Examples + +- Prepare the resource +```powershell +$TenantUiMetadataItemResponse = Initialize-PSSailpoint.V2024TenantUiMetadataItemResponse -IframeWhiteList http://example.com http://example2.com ` + -UsernameLabel Email ` + -UsernameEmptyText Please provide your work email address... +``` + +- Convert the resource to JSON +```powershell +$TenantUiMetadataItemResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TenantUiMetadataItemUpdateRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TenantUiMetadataItemUpdateRequest.md new file mode 100644 index 000000000..3f66bb5d3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TenantUiMetadataItemUpdateRequest.md @@ -0,0 +1,39 @@ +--- +id: v2024-tenant-ui-metadata-item-update-request +title: TenantUiMetadataItemUpdateRequest +pagination_label: TenantUiMetadataItemUpdateRequest +sidebar_label: TenantUiMetadataItemUpdateRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TenantUiMetadataItemUpdateRequest', 'V2024TenantUiMetadataItemUpdateRequest'] +slug: /tools/sdk/powershell/v2024/models/tenant-ui-metadata-item-update-request +tags: ['SDK', 'Software Development Kit', 'TenantUiMetadataItemUpdateRequest', 'V2024TenantUiMetadataItemUpdateRequest'] +--- + + +# TenantUiMetadataItemUpdateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IframeWhiteList** | Pointer to **String** | Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use ""null"". It will only allow include into iframe non authenticated portions of the product, such as password reset. | [optional] +**UsernameLabel** | Pointer to **String** | Descriptor for the username input field. If you would like to reset the value use ""null"". | [optional] +**UsernameEmptyText** | Pointer to **String** | Placeholder text displayed in the username input field. If you would like to reset the value use ""null"". | [optional] + +## Examples + +- Prepare the resource +```powershell +$TenantUiMetadataItemUpdateRequest = Initialize-PSSailpoint.V2024TenantUiMetadataItemUpdateRequest -IframeWhiteList http://example.com http://example2.com ` + -UsernameLabel Email ` + -UsernameEmptyText Please provide your work email address... +``` + +- Convert the resource to JSON +```powershell +$TenantUiMetadataItemUpdateRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TestExternalExecuteWorkflow200Response.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TestExternalExecuteWorkflow200Response.md new file mode 100644 index 000000000..cf891ec8a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TestExternalExecuteWorkflow200Response.md @@ -0,0 +1,35 @@ +--- +id: v2024-test-external-execute-workflow200-response +title: TestExternalExecuteWorkflow200Response +pagination_label: TestExternalExecuteWorkflow200Response +sidebar_label: TestExternalExecuteWorkflow200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TestExternalExecuteWorkflow200Response', 'V2024TestExternalExecuteWorkflow200Response'] +slug: /tools/sdk/powershell/v2024/models/test-external-execute-workflow200-response +tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflow200Response', 'V2024TestExternalExecuteWorkflow200Response'] +--- + + +# TestExternalExecuteWorkflow200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Payload** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The input that was received | [optional] + +## Examples + +- Prepare the resource +```powershell +$TestExternalExecuteWorkflow200Response = Initialize-PSSailpoint.V2024TestExternalExecuteWorkflow200Response -Payload {test=hello world} +``` + +- Convert the resource to JSON +```powershell +$TestExternalExecuteWorkflow200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TestExternalExecuteWorkflowRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TestExternalExecuteWorkflowRequest.md new file mode 100644 index 000000000..08b7ed259 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TestExternalExecuteWorkflowRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-test-external-execute-workflow-request +title: TestExternalExecuteWorkflowRequest +pagination_label: TestExternalExecuteWorkflowRequest +sidebar_label: TestExternalExecuteWorkflowRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TestExternalExecuteWorkflowRequest', 'V2024TestExternalExecuteWorkflowRequest'] +slug: /tools/sdk/powershell/v2024/models/test-external-execute-workflow-request +tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflowRequest', 'V2024TestExternalExecuteWorkflowRequest'] +--- + + +# TestExternalExecuteWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarInput** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The test input for the workflow | [optional] + +## Examples + +- Prepare the resource +```powershell +$TestExternalExecuteWorkflowRequest = Initialize-PSSailpoint.V2024TestExternalExecuteWorkflowRequest -VarInput {test=hello world} +``` + +- Convert the resource to JSON +```powershell +$TestExternalExecuteWorkflowRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TestInvocation.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TestInvocation.md new file mode 100644 index 000000000..054f2ce81 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TestInvocation.md @@ -0,0 +1,41 @@ +--- +id: v2024-test-invocation +title: TestInvocation +pagination_label: TestInvocation +sidebar_label: TestInvocation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TestInvocation', 'V2024TestInvocation'] +slug: /tools/sdk/powershell/v2024/models/test-invocation +tags: ['SDK', 'Software Development Kit', 'TestInvocation', 'V2024TestInvocation'] +--- + + +# TestInvocation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TriggerId** | **String** | Trigger ID | [required] +**VarInput** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Mock input to use for test invocation. This must adhere to the input schema defined in the trigger being invoked. If this property is omitted, then the default trigger sample payload will be sent. | [optional] +**ContentJson** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | JSON map of invocation metadata. | [required] +**SubscriptionIds** | Pointer to **[]String** | Only send the test event to the subscription IDs listed. If omitted, the test event will be sent to all subscribers. | [optional] + +## Examples + +- Prepare the resource +```powershell +$TestInvocation = Initialize-PSSailpoint.V2024TestInvocation -TriggerId idn:access-request-post-approval ` + -VarInput {identityId=201327fda1c44704ac01181e963d463c} ` + -ContentJson {workflowId=1234} ` + -SubscriptionIds [0f11f2a4-7c94-4bf3-a2bd-742580fe3bde] +``` + +- Convert the resource to JSON +```powershell +$TestInvocation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TestWorkflow200Response.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TestWorkflow200Response.md new file mode 100644 index 000000000..b49ae0133 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TestWorkflow200Response.md @@ -0,0 +1,35 @@ +--- +id: v2024-test-workflow200-response +title: TestWorkflow200Response +pagination_label: TestWorkflow200Response +sidebar_label: TestWorkflow200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TestWorkflow200Response', 'V2024TestWorkflow200Response'] +slug: /tools/sdk/powershell/v2024/models/test-workflow200-response +tags: ['SDK', 'Software Development Kit', 'TestWorkflow200Response', 'V2024TestWorkflow200Response'] +--- + + +# TestWorkflow200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**WorkflowExecutionId** | Pointer to **String** | The workflow execution id | [optional] + +## Examples + +- Prepare the resource +```powershell +$TestWorkflow200Response = Initialize-PSSailpoint.V2024TestWorkflow200Response -WorkflowExecutionId 0e11cefa-96e7-4b67-90d0-065bc1da5753 +``` + +- Convert the resource to JSON +```powershell +$TestWorkflow200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TestWorkflowRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TestWorkflowRequest.md new file mode 100644 index 000000000..89c40acf8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TestWorkflowRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-test-workflow-request +title: TestWorkflowRequest +pagination_label: TestWorkflowRequest +sidebar_label: TestWorkflowRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TestWorkflowRequest', 'V2024TestWorkflowRequest'] +slug: /tools/sdk/powershell/v2024/models/test-workflow-request +tags: ['SDK', 'Software Development Kit', 'TestWorkflowRequest', 'V2024TestWorkflowRequest'] +--- + + +# TestWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarInput** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The test input for the workflow. | [required] + +## Examples + +- Prepare the resource +```powershell +$TestWorkflowRequest = Initialize-PSSailpoint.V2024TestWorkflowRequest -VarInput null +``` + +- Convert the resource to JSON +```powershell +$TestWorkflowRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TextQuery.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TextQuery.md new file mode 100644 index 000000000..4e1ff742f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TextQuery.md @@ -0,0 +1,41 @@ +--- +id: v2024-text-query +title: TextQuery +pagination_label: TextQuery +sidebar_label: TextQuery +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TextQuery', 'V2024TextQuery'] +slug: /tools/sdk/powershell/v2024/models/text-query +tags: ['SDK', 'Software Development Kit', 'TextQuery', 'V2024TextQuery'] +--- + + +# TextQuery + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Terms** | **[]String** | Words or characters that specify a particular thing to be searched for. | [required] +**Fields** | **[]String** | The fields to be searched. | [required] +**MatchAny** | Pointer to **Boolean** | Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found. | [optional] [default to $false] +**Contains** | Pointer to **Boolean** | Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$TextQuery = Initialize-PSSailpoint.V2024TextQuery -Terms [The quick brown fox, 3141592, 7] ` + -Fields [displayName, employeeNumber, roleCount] ` + -MatchAny false ` + -Contains true +``` + +- Convert the resource to JSON +```powershell +$TextQuery | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Transform.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Transform.md new file mode 100644 index 000000000..c083a1649 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Transform.md @@ -0,0 +1,39 @@ +--- +id: v2024-transform +title: Transform +pagination_label: Transform +sidebar_label: Transform +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Transform', 'V2024Transform'] +slug: /tools/sdk/powershell/v2024/models/transform +tags: ['SDK', 'Software Development Kit', 'Transform', 'V2024Transform'] +--- + + +# Transform + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Unique name of this transform | [required] +**Type** | **Enum** [ "accountAttribute", "base64Decode", "base64Encode", "concat", "conditional", "dateCompare", "dateFormat", "dateMath", "decomposeDiacriticalMarks", "e164phone", "firstValid", "rule", "identityAttribute", "indexOf", "iso3166", "lastIndexOf", "leftPad", "lookup", "lower", "normalizeNames", "randomAlphaNumeric", "randomNumeric", "reference", "replaceAll", "replace", "rightPad", "split", "static", "substring", "trim", "upper", "usernameGenerator", "uuid", "displayName", "rfc5646" ] | The type of transform operation | [required] +**Attributes** | [**TransformAttributes**](transform-attributes) | | [required] + +## Examples + +- Prepare the resource +```powershell +$Transform = Initialize-PSSailpoint.V2024Transform -Name Timestamp To Date ` + -Type dateFormat ` + -Attributes null +``` + +- Convert the resource to JSON +```powershell +$Transform | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TransformAttributes.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TransformAttributes.md new file mode 100644 index 000000000..e2bdde4ee --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TransformAttributes.md @@ -0,0 +1,115 @@ +--- +id: v2024-transform-attributes +title: TransformAttributes +pagination_label: TransformAttributes +sidebar_label: TransformAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TransformAttributes', 'V2024TransformAttributes'] +slug: /tools/sdk/powershell/v2024/models/transform-attributes +tags: ['SDK', 'Software Development Kit', 'TransformAttributes', 'V2024TransformAttributes'] +--- + + +# TransformAttributes + +## Properties + +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] +**Values** | **String** | This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language. | [required] +**Expression** | **String** | A string value of the date and time components to operation on, along with the math operations to execute. | [required] +**PositiveCondition** | **String** | The output of the transform if the expression evalutes to true | [required] +**NegativeCondition** | **String** | The output of the transform if the expression evalutes to false | [required] +**FirstDate** | [**DateCompareFirstDate**](date-compare-first-date) | | [required] +**SecondDate** | [**DateCompareSecondDate**](date-compare-second-date) | | [required] +**Operator** | **Enum** [ "LT", "LTE", "GT", "GTE" ] | This is the comparison to perform. | Operation | Description | | --------- | ------- | | LT | Strictly less than: `firstDate < secondDate` | | LTE | Less than or equal to: `firstDate <= secondDate` | | GT | Strictly greater than: `firstDate > secondDate` | | GTE | Greater than or equal to: `firstDate >= secondDate` | | [required] +**InputFormat** | Pointer to [**DateFormatInputFormat**](date-format-input-format) | | [optional] +**OutputFormat** | Pointer to [**DateFormatOutputFormat**](date-format-output-format) | | [optional] +**RoundUp** | Pointer to **Boolean** | A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. If not provided, the transform will default to `false` `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) | [optional] [default to $false] +**DefaultRegion** | Pointer to **String** | This is an optional attribute that can be used to define the region of the phone number to format into. If defaultRegion is not provided, it will take US as the default country. The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) | [optional] +**IgnoreErrors** | Pointer to **Boolean** | a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. | [optional] [default to $false] +**Name** | **String** | The system (camel-cased) name of the identity attribute to bring in | [required] +**Operation** | **String** | The operation to perform `getReferenceIdentityAttribute` | [required] +**IncludeNumbers** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include numbers | [required] +**IncludeSpecialChars** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include special characters | [required] +**Length** | **String** | An integer value for the desired length of the final output string | [required] +**Uid** | **String** | This is the SailPoint User Name (uid) value of the identity whose attribute is desired As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. | [required] +**Substring** | **String** | A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring. | [required] +**Format** | Pointer to **String** | An optional value to denote which ISO 3166 format to return. Valid values are: `alpha2` - Two-character country code (e.g., ""US""); this is the default value if no format is supplied `alpha3` - Three-character country code (e.g., ""USA"") `numeric` - The numeric country code (e.g., ""840"") | [optional] +**Padding** | Pointer to **String** | A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space ("" "") character for padding | [optional] +**Table** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value. | [required] +**Id** | **String** | This ID specifies the name of the pre-existing transform which you want to use within your current transform | [required] +**Regex** | **String** | This can be a string or a regex pattern in which you want to replace. | [required] +**Replacement** | **String** | This is the replacement string that should be substituded wherever the string or pattern is found. | [required] +**Delimiter** | **String** | This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data | [required] +**Index** | **String** | An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc. | [required] +**Throws** | Pointer to **Boolean** | A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) `true` - The transform should return ""IndexOutOfBoundsException"" `false` - The transform should return null If not provided, the transform will default to false and return a null | [optional] [default to $false] +**VarBegin** | **Int32** | The index of the first character to include in the returned substring. If `begin` is set to -1, the transform will begin at character 0 of the input data | [required] +**BeginOffset** | Pointer to **Int32** | This integer value is the number of characters to add to the begin attribute when returning a substring. This attribute is only used if begin is not -1. | [optional] +**VarEnd** | Pointer to **Int32** | The index of the first character to exclude from the returned substring. If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. | [optional] +**EndOffset** | Pointer to **Int32** | This integer value is the number of characters to add to the end attribute when returning a substring. This attribute is only used if end is provided and is not -1. | [optional] + +## Examples + +- Prepare the resource +```powershell +$TransformAttributes = Initialize-PSSailpoint.V2024TransformAttributes -SourceName Workday ` + -AttributeName DEPARTMENT ` + -AccountSortAttribute created ` + -AccountSortDescending false ` + -AccountReturnFirstLink false ` + -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` + -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` + -Values string$variable ` + -Expression now+1w ` + -PositiveCondition true ` + -NegativeCondition false ` + -FirstDate null ` + -SecondDate null ` + -Operator LT ` + -InputFormat null ` + -OutputFormat null ` + -RoundUp false ` + -DefaultRegion US ` + -IgnoreErrors false ` + -Name email ` + -Operation getReferenceIdentityAttribute ` + -IncludeNumbers true ` + -IncludeSpecialChars true ` + -Length 4 ` + -Uid 2c91808570313110017040b06f344ec9 ` + -Substring admin_ ` + -Format alpha2 ` + -Padding 0 ` + -Table {-= , "=', ñ=n} ` + -Id Existing Transform ` + -Regex [^a-zA-Z] ` + -Replacement ` + -Delimiter , ` + -Index 5 ` + -Throws true ` + -VarBegin 1 ` + -BeginOffset 3 ` + -VarEnd 6 ` + -EndOffset 1 +``` + +- Convert the resource to JSON +```powershell +$TransformAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TransformDefinition.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TransformDefinition.md new file mode 100644 index 000000000..aed786c8c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TransformDefinition.md @@ -0,0 +1,37 @@ +--- +id: v2024-transform-definition +title: TransformDefinition +pagination_label: TransformDefinition +sidebar_label: TransformDefinition +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TransformDefinition', 'V2024TransformDefinition'] +slug: /tools/sdk/powershell/v2024/models/transform-definition +tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'V2024TransformDefinition'] +--- + + +# TransformDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **String** | The type of the transform definition. | [optional] +**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Arbitrary key-value pairs to store any metadata for the object | [optional] + +## Examples + +- Prepare the resource +```powershell +$TransformDefinition = Initialize-PSSailpoint.V2024TransformDefinition -Type accountAttribute ` + -Attributes {attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53} +``` + +- Convert the resource to JSON +```powershell +$TransformDefinition | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TransformRead.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TransformRead.md new file mode 100644 index 000000000..7e6138ff5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TransformRead.md @@ -0,0 +1,43 @@ +--- +id: v2024-transform-read +title: TransformRead +pagination_label: TransformRead +sidebar_label: TransformRead +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TransformRead', 'V2024TransformRead'] +slug: /tools/sdk/powershell/v2024/models/transform-read +tags: ['SDK', 'Software Development Kit', 'TransformRead', 'V2024TransformRead'] +--- + + +# TransformRead + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Unique name of this transform | [required] +**Type** | **Enum** [ "accountAttribute", "base64Decode", "base64Encode", "concat", "conditional", "dateCompare", "dateFormat", "dateMath", "decomposeDiacriticalMarks", "e164phone", "firstValid", "rule", "identityAttribute", "indexOf", "iso3166", "lastIndexOf", "leftPad", "lookup", "lower", "normalizeNames", "randomAlphaNumeric", "randomNumeric", "reference", "replaceAll", "replace", "rightPad", "split", "static", "substring", "trim", "upper", "usernameGenerator", "uuid", "displayName", "rfc5646" ] | The type of transform operation | [required] +**Attributes** | [**TransformAttributes**](transform-attributes) | | [required] +**Id** | **String** | Unique ID of this transform | [required] +**Internal** | **Boolean** | Indicates whether this is an internal SailPoint-created transform or a customer-created transform | [required][default to $false] + +## Examples + +- Prepare the resource +```powershell +$TransformRead = Initialize-PSSailpoint.V2024TransformRead -Name Timestamp To Date ` + -Type dateFormat ` + -Attributes null ` + -Id 2cd78adghjkja34jh2b1hkjhasuecd ` + -Internal false +``` + +- Convert the resource to JSON +```powershell +$TransformRead | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TransformRule.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TransformRule.md new file mode 100644 index 000000000..90d2d7515 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TransformRule.md @@ -0,0 +1,37 @@ +--- +id: v2024-transform-rule +title: TransformRule +pagination_label: TransformRule +sidebar_label: TransformRule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TransformRule', 'V2024TransformRule'] +slug: /tools/sdk/powershell/v2024/models/transform-rule +tags: ['SDK', 'Software Development Kit', 'TransformRule', 'V2024TransformRule'] +--- + + +# TransformRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | This is the name of the Transform rule that needs to be invoked by the transform | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$TransformRule = Initialize-PSSailpoint.V2024TransformRule -Name Transform Calculation Rule ` + -RequiresPeriodicRefresh false +``` + +- Convert the resource to JSON +```powershell +$TransformRule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TranslationMessage.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TranslationMessage.md new file mode 100644 index 000000000..09683492e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TranslationMessage.md @@ -0,0 +1,37 @@ +--- +id: v2024-translation-message +title: TranslationMessage +pagination_label: TranslationMessage +sidebar_label: TranslationMessage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TranslationMessage', 'V2024TranslationMessage'] +slug: /tools/sdk/powershell/v2024/models/translation-message +tags: ['SDK', 'Software Development Kit', 'TranslationMessage', 'V2024TranslationMessage'] +--- + + +# TranslationMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **String** | The key of the translation message | [optional] +**Values** | Pointer to **[]String** | The values corresponding to the translation messages | [optional] + +## Examples + +- Prepare the resource +```powershell +$TranslationMessage = Initialize-PSSailpoint.V2024TranslationMessage -Key recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH ` + -Values [75, department] +``` + +- Convert the resource to JSON +```powershell +$TranslationMessage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Trigger.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Trigger.md new file mode 100644 index 000000000..d0c936945 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Trigger.md @@ -0,0 +1,49 @@ +--- +id: v2024-trigger +title: Trigger +pagination_label: Trigger +sidebar_label: Trigger +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Trigger', 'V2024Trigger'] +slug: /tools/sdk/powershell/v2024/models/trigger +tags: ['SDK', 'Software Development Kit', 'Trigger', 'V2024Trigger'] +--- + + +# Trigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Unique identifier of the trigger. | [required] +**Name** | **String** | Trigger Name. | [required] +**Type** | [**TriggerType**](trigger-type) | | [required] +**Description** | Pointer to **String** | Trigger Description. | [optional] +**InputSchema** | **String** | The JSON schema of the payload that will be sent by the trigger to the subscribed service. | [required] +**ExampleInput** | [**TriggerExampleInput**](trigger-example-input) | | [required] +**OutputSchema** | Pointer to **String** | The JSON schema of the response that will be sent by the subscribed service to the trigger in response to an event. This only applies to a trigger type of `REQUEST_RESPONSE`. | [optional] +**ExampleOutput** | Pointer to [**TriggerExampleOutput**](trigger-example-output) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Trigger = Initialize-PSSailpoint.V2024Trigger -Id idn:access-request-dynamic-approver ` + -Name Access Request Dynamic Approver ` + -Type null ` + -Description Trigger for getting a dynamic approver. ` + -InputSchema {"definitions":{"record:AccessRequestDynamicApproverInput":{"type":"object","required":["accessRequestId","requestedFor","requestedItems","requestedBy"],"additionalProperties":true,"properties":{"accessRequestId":{"type":"string"},"requestedFor":{"$ref":"#/definitions/record:requestedForIdentityRef"},"requestedItems":{"type":"array","items":{"$ref":"#/definitions/record:requestedObjectRef"}},"requestedBy":{"$ref":"#/definitions/record:requestedByIdentityRef"}}},"record:requestedForIdentityRef":{"type":"object","required":["id","name","type"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}},"record:requestedObjectRef":{"type":"object","optional":["description","comment"],"required":["id","name","type","operation"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"oneOf":[{"type":"null"},{"type":"string"}]},"type":{"type":"string"},"operation":{"type":"string"},"comment":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"record:requestedByIdentityRef":{"type":"object","required":["type","id","name"],"additionalProperties":true,"properties":{"type":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}}},"$ref":"#/definitions/record:AccessRequestDynamicApproverInput"} ` + -ExampleInput null ` + -OutputSchema {"definitions":{"record:AccessRequestDynamicApproverOutput":{"type":["null","object"],"required":["id","name","type"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}},"$ref":"#/definitions/record:AccessRequestDynamicApproverOutput"} ` + -ExampleOutput null +``` + +- Convert the resource to JSON +```powershell +$Trigger | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TriggerExampleInput.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TriggerExampleInput.md new file mode 100644 index 000000000..ae026ad3e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TriggerExampleInput.md @@ -0,0 +1,131 @@ +--- +id: v2024-trigger-example-input +title: TriggerExampleInput +pagination_label: TriggerExampleInput +sidebar_label: TriggerExampleInput +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TriggerExampleInput', 'V2024TriggerExampleInput'] +slug: /tools/sdk/powershell/v2024/models/trigger-example-input +tags: ['SDK', 'Software Development Kit', 'TriggerExampleInput', 'V2024TriggerExampleInput'] +--- + + +# TriggerExampleInput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccessRequestId** | **String** | The unique ID of the access request. | [required] +**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required] +**RequestedItems** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details of the access items being requested. | [required] +**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required] +**RequestedItemsStatus** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details on the outcome of each access item. | [required] +**Source** | [**AccountUncorrelatedSource**](account-uncorrelated-source) | | [required] +**Status** | **Enum** [ "Success", "Failed", "Terminated" ] | The overall status of the collection. | [required] +**Started** | **System.DateTime** | The date and time when the account collection started. | [required] +**Completed** | **System.DateTime** | The date and time when the account collection finished. | [required] +**Errors** | **[]String** | A list of any accumulated error messages that occurred during provisioning. | [required] +**Warnings** | **[]String** | A list of any accumulated warning messages that occurred during provisioning. | [required] +**Stats** | [**AccountsCollectedForAggregationStats**](accounts-collected-for-aggregation-stats) | | [required] +**Identity** | [**IdentityDeletedIdentity**](identity-deleted-identity) | | [required] +**Account** | [**AccountUncorrelatedAccount**](account-uncorrelated-account) | | [required] +**Changes** | [**[]IdentityAttributesChangedChangesInner**](identity-attributes-changed-changes-inner) | A list of one or more identity attributes that changed on the identity. | [required] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required] +**EntitlementCount** | Pointer to **Int32** | The number of entitlements associated with this account. | [optional] +**Campaign** | [**CampaignGeneratedCampaign**](campaign-generated-campaign) | | [required] +**Certification** | [**CertificationSignedOffCertification**](certification-signed-off-certification) | | [required] +**TrackingNumber** | **String** | The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. | [required] +**Sources** | **String** | One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. | [required] +**Action** | Pointer to **String** | Origin of where the provisioning request came from. | [optional] +**Recipient** | [**ProvisioningCompletedRecipient**](provisioning-completed-recipient) | | [required] +**Requester** | Pointer to [**ProvisioningCompletedRequester**](provisioning-completed-requester) | | [optional] +**AccountRequests** | [**[]ProvisioningCompletedAccountRequestsInner**](provisioning-completed-account-requests-inner) | A list of provisioning instructions to perform on an account-by-account basis. | [required] +**FileName** | **String** | A name for the report file. | [required] +**OwnerEmail** | **String** | The email address of the identity that owns the saved search. | [required] +**OwnerName** | **String** | The name of the identity that owns the saved search. | [required] +**Query** | **String** | The search query that was used to generate the report. | [required] +**SearchName** | **String** | The name of the saved search. | [required] +**SearchResults** | [**SavedSearchCompleteSearchResults**](saved-search-complete-search-results) | | [required] +**SignedS3Url** | **String** | The Amazon S3 URL to download the report from. | [required] +**Uuid** | Pointer to **String** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] +**Id** | **String** | The unique ID of the source. | [required] +**NativeIdentifier** | **String** | Unique ID of the account on the source. | [required] +**SourceId** | **String** | The ID of the source. | [required] +**SourceName** | **String** | The name of the source. | [required] +**IdentityId** | **String** | The ID of the identity that is correlated with this account. | [required] +**IdentityName** | **String** | The name of the identity that is correlated with this account. | [required] +**Name** | **String** | The user friendly name of the source. | [required] +**Type** | **String** | The connection type of the source. | [required] +**Created** | **System.DateTime** | The date and time the status change occurred. | [required] +**Connector** | **String** | The connector type used to connect to the source. | [required] +**Actor** | [**SourceUpdatedActor**](source-updated-actor) | | [required] +**Deleted** | **System.DateTime** | The date and time the source was deleted. | [required] +**Modified** | **System.DateTime** | The date and time the source was modified. | [required] +**Application** | [**VAClusterStatusChangeEventApplication**](va-cluster-status-change-event-application) | | [required] +**HealthCheckResult** | [**VAClusterStatusChangeEventHealthCheckResult**](va-cluster-status-change-event-health-check-result) | | [required] +**PreviousHealthCheckResult** | [**VAClusterStatusChangeEventPreviousHealthCheckResult**](va-cluster-status-change-event-previous-health-check-result) | | [required] + +## Examples + +- Prepare the resource +```powershell +$TriggerExampleInput = Initialize-PSSailpoint.V2024TriggerExampleInput -AccessRequestId 2c91808b6ef1d43e016efba0ce470904 ` + -RequestedFor null ` + -RequestedItems null ` + -RequestedBy null ` + -RequestedItemsStatus null ` + -Source null ` + -Status Success ` + -Started 2020-06-29T22:01:50.474Z ` + -Completed 2020-06-29T22:02:04.090Z ` + -Errors null ` + -Warnings null ` + -Stats null ` + -Identity null ` + -Account null ` + -Changes null ` + -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} ` + -EntitlementCount 0 ` + -Campaign null ` + -Certification null ` + -TrackingNumber 4b4d982dddff4267ab12f0f1e72b5a6d ` + -Sources Corp AD, Corp LDAP, Corp Salesforce ` + -Action IdentityRefresh ` + -Recipient null ` + -Requester null ` + -AccountRequests null ` + -FileName Modified.zip ` + -OwnerEmail test@sailpoint.com ` + -OwnerName Cloud Support ` + -Query modified:[now-7y/d TO now] ` + -SearchName Modified Activity ` + -SearchResults null ` + -SignedS3Url https://sptcbu-org-data-useast1.s3.amazonaws.com/arsenal-john/reports/Events%20Export.2020-05-06%2018%2759%20GMT.3e580592-86e4-4953-8aea-49e6ef20a086.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200506T185919Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=AKIAV5E54XOGTS4Q4L7A%2F20200506%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2e732bb97a12a1fd8a215613e3c31fcdae8ba1fb6a25916843ab5b51d2ddefbc ` + -Uuid b7264868-7201-415f-9118-b581d431c688 ` + -Id 2c9180866166b5b0016167c32ef31a66 ` + -NativeIdentifier E009 ` + -SourceId 2c918082814e693601816e09471b29b6 ` + -SourceName Active Directory ` + -IdentityId ee769173319b41d19ccec6c235423237b ` + -IdentityName john.doe ` + -Name Corporate Active Directory ` + -Type DIRECT_CONNECT ` + -Created 2020-06-29T22:01:50.474Z ` + -Connector active-directory ` + -Actor null ` + -Deleted 2021-03-29T22:01:50.474Z ` + -Modified 2021-03-29T22:01:50.474Z ` + -Application null ` + -HealthCheckResult null ` + -PreviousHealthCheckResult null +``` + +- Convert the resource to JSON +```powershell +$TriggerExampleInput | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TriggerExampleOutput.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TriggerExampleOutput.md new file mode 100644 index 000000000..2c7eb03b4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TriggerExampleOutput.md @@ -0,0 +1,45 @@ +--- +id: v2024-trigger-example-output +title: TriggerExampleOutput +pagination_label: TriggerExampleOutput +sidebar_label: TriggerExampleOutput +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TriggerExampleOutput', 'V2024TriggerExampleOutput'] +slug: /tools/sdk/powershell/v2024/models/trigger-example-output +tags: ['SDK', 'Software Development Kit', 'TriggerExampleOutput', 'V2024TriggerExampleOutput'] +--- + + +# TriggerExampleOutput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the identity to add to the approver list for the access request. | [required] +**Name** | **String** | The name of the identity to add to the approver list for the access request. | [required] +**Type** | **Enum** [ "IDENTITY", "GOVERNANCE_GROUP" ] | The type of object being referenced. | [required] +**Approved** | **Boolean** | Whether or not to approve the access request. | [required] +**Comment** | **String** | A comment about the decision to approve or deny the request. | [required] +**Approver** | **String** | The name of the entity that approved or denied the request. | [required] + +## Examples + +- Prepare the resource +```powershell +$TriggerExampleOutput = Initialize-PSSailpoint.V2024TriggerExampleOutput -Id 2c91808b6ef1d43e016efba0ce470906 ` + -Name Adam Adams ` + -Type IDENTITY ` + -Approved false ` + -Comment This access should be denied, because this will cause an SOD violation. ` + -Approver AcmeCorpExternalIntegration +``` + +- Convert the resource to JSON +```powershell +$TriggerExampleOutput | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TriggerType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TriggerType.md new file mode 100644 index 000000000..1b1e493ca --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TriggerType.md @@ -0,0 +1,24 @@ +--- +id: v2024-trigger-type +title: TriggerType +pagination_label: TriggerType +sidebar_label: TriggerType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TriggerType', 'V2024TriggerType'] +slug: /tools/sdk/powershell/v2024/models/trigger-type +tags: ['SDK', 'Software Development Kit', 'TriggerType', 'V2024TriggerType'] +--- + + +# TriggerType + +## Enum + + +* `REQUEST_RESPONSE` (value: `"REQUEST_RESPONSE"`) + +* `FIRE_AND_FORGET` (value: `"FIRE_AND_FORGET"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Trim.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Trim.md new file mode 100644 index 000000000..bea16da4f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Trim.md @@ -0,0 +1,37 @@ +--- +id: v2024-trim +title: Trim +pagination_label: Trim +sidebar_label: Trim +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Trim', 'V2024Trim'] +slug: /tools/sdk/powershell/v2024/models/trim +tags: ['SDK', 'Software Development Kit', 'Trim', 'V2024Trim'] +--- + + +# Trim + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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] + +## Examples + +- Prepare the resource +```powershell +$Trim = Initialize-PSSailpoint.V2024Trim -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Trim | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TypeAheadQuery.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TypeAheadQuery.md new file mode 100644 index 000000000..e3cb42cc1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TypeAheadQuery.md @@ -0,0 +1,47 @@ +--- +id: v2024-type-ahead-query +title: TypeAheadQuery +pagination_label: TypeAheadQuery +sidebar_label: TypeAheadQuery +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TypeAheadQuery', 'V2024TypeAheadQuery'] +slug: /tools/sdk/powershell/v2024/models/type-ahead-query +tags: ['SDK', 'Software Development Kit', 'TypeAheadQuery', 'V2024TypeAheadQuery'] +--- + + +# TypeAheadQuery + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | **String** | The type ahead query string used to construct a phrase prefix match query. | [required] +**Field** | **String** | The field on which to perform the type ahead search. | [required] +**NestedType** | Pointer to **String** | The nested type. | [optional] +**MaxExpansions** | Pointer to **Int32** | The number of suffixes the last term will be expanded into. Influences the performance of the query and the number results returned. Valid values: 1 to 1000. | [optional] [default to 10] +**Size** | Pointer to **Int32** | The max amount of records the search will return. | [optional] [default to 100] +**Sort** | Pointer to **String** | The sort order of the returned records. | [optional] [default to "desc"] +**SortByValue** | Pointer to **Boolean** | The flag that defines the sort type, by count or value. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$TypeAheadQuery = Initialize-PSSailpoint.V2024TypeAheadQuery -Query Work ` + -Field source.name ` + -NestedType access ` + -MaxExpansions 10 ` + -Size 100 ` + -Sort asc ` + -SortByValue true +``` + +- Convert the resource to JSON +```powershell +$TypeAheadQuery | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TypedReference.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TypedReference.md new file mode 100644 index 000000000..e12c0e73c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/TypedReference.md @@ -0,0 +1,37 @@ +--- +id: v2024-typed-reference +title: TypedReference +pagination_label: TypedReference +sidebar_label: TypedReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TypedReference', 'V2024TypedReference'] +slug: /tools/sdk/powershell/v2024/models/typed-reference +tags: ['SDK', 'Software Development Kit', 'TypedReference', 'V2024TypedReference'] +--- + + +# TypedReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**DtoType**](dto-type) | | [required] +**Id** | **String** | The id of the object. | [required] + +## Examples + +- Prepare the resource +```powershell +$TypedReference = Initialize-PSSailpoint.V2024TypedReference -Type null ` + -Id 2c91808568c529c60168cca6f90c1313 +``` + +- Convert the resource to JSON +```powershell +$TypedReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UUIDGenerator.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UUIDGenerator.md new file mode 100644 index 000000000..cc31b3a44 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UUIDGenerator.md @@ -0,0 +1,35 @@ +--- +id: v2024-uuid-generator +title: UUIDGenerator +pagination_label: UUIDGenerator +sidebar_label: UUIDGenerator +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UUIDGenerator', 'V2024UUIDGenerator'] +slug: /tools/sdk/powershell/v2024/models/uuid-generator +tags: ['SDK', 'Software Development Kit', 'UUIDGenerator', 'V2024UUIDGenerator'] +--- + + +# UUIDGenerator + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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] + +## Examples + +- Prepare the resource +```powershell +$UUIDGenerator = Initialize-PSSailpoint.V2024UUIDGenerator -RequiresPeriodicRefresh false +``` + +- Convert the resource to JSON +```powershell +$UUIDGenerator | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UncorrelatedAccountsReportArguments.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UncorrelatedAccountsReportArguments.md new file mode 100644 index 000000000..9cd935362 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UncorrelatedAccountsReportArguments.md @@ -0,0 +1,35 @@ +--- +id: v2024-uncorrelated-accounts-report-arguments +title: UncorrelatedAccountsReportArguments +pagination_label: UncorrelatedAccountsReportArguments +sidebar_label: UncorrelatedAccountsReportArguments +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UncorrelatedAccountsReportArguments', 'V2024UncorrelatedAccountsReportArguments'] +slug: /tools/sdk/powershell/v2024/models/uncorrelated-accounts-report-arguments +tags: ['SDK', 'Software Development Kit', 'UncorrelatedAccountsReportArguments', 'V2024UncorrelatedAccountsReportArguments'] +--- + + +# UncorrelatedAccountsReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SelectedFormats** | Pointer to **[]String** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] + +## Examples + +- Prepare the resource +```powershell +$UncorrelatedAccountsReportArguments = Initialize-PSSailpoint.V2024UncorrelatedAccountsReportArguments -SelectedFormats [CSV] +``` + +- Convert the resource to JSON +```powershell +$UncorrelatedAccountsReportArguments | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UpdateAccessProfilesInBulk412Response.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UpdateAccessProfilesInBulk412Response.md new file mode 100644 index 000000000..48b01ac2a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UpdateAccessProfilesInBulk412Response.md @@ -0,0 +1,35 @@ +--- +id: v2024-update-access-profiles-in-bulk412-response +title: UpdateAccessProfilesInBulk412Response +pagination_label: UpdateAccessProfilesInBulk412Response +sidebar_label: UpdateAccessProfilesInBulk412Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UpdateAccessProfilesInBulk412Response', 'V2024UpdateAccessProfilesInBulk412Response'] +slug: /tools/sdk/powershell/v2024/models/update-access-profiles-in-bulk412-response +tags: ['SDK', 'Software Development Kit', 'UpdateAccessProfilesInBulk412Response', 'V2024UpdateAccessProfilesInBulk412Response'] +--- + + +# UpdateAccessProfilesInBulk412Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A message describing the error | [optional] + +## Examples + +- Prepare the resource +```powershell +$UpdateAccessProfilesInBulk412Response = Initialize-PSSailpoint.V2024UpdateAccessProfilesInBulk412Response -Message API/Feature not enabled for your organization. +``` + +- Convert the resource to JSON +```powershell +$UpdateAccessProfilesInBulk412Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UpdateDetail.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UpdateDetail.md new file mode 100644 index 000000000..92d24c3ce --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UpdateDetail.md @@ -0,0 +1,41 @@ +--- +id: v2024-update-detail +title: UpdateDetail +pagination_label: UpdateDetail +sidebar_label: UpdateDetail +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UpdateDetail', 'V2024UpdateDetail'] +slug: /tools/sdk/powershell/v2024/models/update-detail +tags: ['SDK', 'Software Development Kit', 'UpdateDetail', 'V2024UpdateDetail'] +--- + + +# UpdateDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to **String** | The detailed message for an update. Typically the relevent error message when status is error. | [optional] +**ScriptName** | Pointer to **String** | The connector script name | [optional] +**UpdatedFiles** | Pointer to **[]String** | The list of updated files supported by the connector | [optional] +**Status** | Pointer to **Enum** [ "ERROR", "UPDATED", "UNCHANGED", "SKIPPED" ] | The connector update status | [optional] + +## Examples + +- Prepare the resource +```powershell +$UpdateDetail = Initialize-PSSailpoint.V2024UpdateDetail -Message unsupported xsd version, please ensure latest xsd version http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd is used for source config ` + -ScriptName servicenow ` + -UpdatedFiles [pod/org/connectorFiles/testconnector/test1.jar] ` + -Status ERROR +``` + +- Convert the resource to JSON +```powershell +$UpdateDetail | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Upper.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Upper.md new file mode 100644 index 000000000..2ead365a5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Upper.md @@ -0,0 +1,37 @@ +--- +id: v2024-upper +title: Upper +pagination_label: Upper +sidebar_label: Upper +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Upper', 'V2024Upper'] +slug: /tools/sdk/powershell/v2024/models/upper +tags: ['SDK', 'Software Development Kit', 'Upper', 'V2024Upper'] +--- + + +# Upper + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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] + +## Examples + +- Prepare the resource +```powershell +$Upper = Initialize-PSSailpoint.V2024Upper -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Upper | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UsageType.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UsageType.md new file mode 100644 index 000000000..611a95c9c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UsageType.md @@ -0,0 +1,52 @@ +--- +id: v2024-usage-type +title: UsageType +pagination_label: UsageType +sidebar_label: UsageType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UsageType', 'V2024UsageType'] +slug: /tools/sdk/powershell/v2024/models/usage-type +tags: ['SDK', 'Software Development Kit', 'UsageType', 'V2024UsageType'] +--- + + +# UsageType + +## Enum + + +* `CREATE` (value: `"CREATE"`) + +* `UPDATE` (value: `"UPDATE"`) + +* `ENABLE` (value: `"ENABLE"`) + +* `DISABLE` (value: `"DISABLE"`) + +* `DELETE` (value: `"DELETE"`) + +* `ASSIGN` (value: `"ASSIGN"`) + +* `UNASSIGN` (value: `"UNASSIGN"`) + +* `CREATE_GROUP` (value: `"CREATE_GROUP"`) + +* `UPDATE_GROUP` (value: `"UPDATE_GROUP"`) + +* `DELETE_GROUP` (value: `"DELETE_GROUP"`) + +* `REGISTER` (value: `"REGISTER"`) + +* `CREATE_IDENTITY` (value: `"CREATE_IDENTITY"`) + +* `UPDATE_IDENTITY` (value: `"UPDATE_IDENTITY"`) + +* `EDIT_GROUP` (value: `"EDIT_GROUP"`) + +* `UNLOCK` (value: `"UNLOCK"`) + +* `CHANGE_PASSWORD` (value: `"CHANGE_PASSWORD"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UserApp.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UserApp.md new file mode 100644 index 000000000..791ed2fb6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UserApp.md @@ -0,0 +1,55 @@ +--- +id: v2024-user-app +title: UserApp +pagination_label: UserApp +sidebar_label: UserApp +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UserApp', 'V2024UserApp'] +slug: /tools/sdk/powershell/v2024/models/user-app +tags: ['SDK', 'Software Development Kit', 'UserApp', 'V2024UserApp'] +--- + + +# UserApp + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The user app id | [optional] +**Created** | Pointer to **System.DateTime** | Time when the user app was created | [optional] +**Modified** | Pointer to **System.DateTime** | Time when the user app was last modified | [optional] +**HasMultipleAccounts** | Pointer to **Boolean** | True if the owner has multiple accounts for the source | [optional] [default to $false] +**UseForPasswordManagement** | Pointer to **Boolean** | True if the source has password feature | [optional] [default to $false] +**ProvisionRequestEnabled** | Pointer to **Boolean** | True if the source app related to the user app is provision request enabled | [optional] [default to $false] +**AppCenterEnabled** | Pointer to **Boolean** | True if the source app related to the user app is shown in the app center | [optional] [default to $true] +**SourceApp** | Pointer to [**UserAppSourceApp**](user-app-source-app) | | [optional] +**Source** | Pointer to [**UserAppSource**](user-app-source) | | [optional] +**Account** | Pointer to [**UserAppAccount**](user-app-account) | | [optional] +**Owner** | Pointer to [**UserAppOwner**](user-app-owner) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$UserApp = Initialize-PSSailpoint.V2024UserApp -Id 2c91808874ff91550175097daaec161c ` + -Created 2020-10-08T18:33:52.029Z ` + -Modified 2020-10-08T18:33:52.029Z ` + -HasMultipleAccounts false ` + -UseForPasswordManagement true ` + -ProvisionRequestEnabled true ` + -AppCenterEnabled true ` + -SourceApp null ` + -Source null ` + -Account null ` + -Owner null +``` + +- Convert the resource to JSON +```powershell +$UserApp | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UserAppAccount.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UserAppAccount.md new file mode 100644 index 000000000..5ecae5a02 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UserAppAccount.md @@ -0,0 +1,39 @@ +--- +id: v2024-user-app-account +title: UserAppAccount +pagination_label: UserAppAccount +sidebar_label: UserAppAccount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UserAppAccount', 'V2024UserAppAccount'] +slug: /tools/sdk/powershell/v2024/models/user-app-account +tags: ['SDK', 'Software Development Kit', 'UserAppAccount', 'V2024UserAppAccount'] +--- + + +# UserAppAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | the account ID | [optional] +**Type** | Pointer to **String** | It will always be ""ACCOUNT"" | [optional] +**Name** | Pointer to **String** | the account name | [optional] + +## Examples + +- Prepare the resource +```powershell +$UserAppAccount = Initialize-PSSailpoint.V2024UserAppAccount -Id 85d173e7d57e496569df763231d6deb6a ` + -Type ACCOUNT ` + -Name test account +``` + +- Convert the resource to JSON +```powershell +$UserAppAccount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UserAppOwner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UserAppOwner.md new file mode 100644 index 000000000..623c5e073 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UserAppOwner.md @@ -0,0 +1,41 @@ +--- +id: v2024-user-app-owner +title: UserAppOwner +pagination_label: UserAppOwner +sidebar_label: UserAppOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UserAppOwner', 'V2024UserAppOwner'] +slug: /tools/sdk/powershell/v2024/models/user-app-owner +tags: ['SDK', 'Software Development Kit', 'UserAppOwner', 'V2024UserAppOwner'] +--- + + +# UserAppOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The identity ID | [optional] +**Type** | Pointer to **String** | It will always be ""IDENTITY"" | [optional] +**Name** | Pointer to **String** | The identity name | [optional] +**Alias** | Pointer to **String** | The identity alias | [optional] + +## Examples + +- Prepare the resource +```powershell +$UserAppOwner = Initialize-PSSailpoint.V2024UserAppOwner -Id 2c9180827ca885d7017ca8ce28a000eb ` + -Type IDENTITY ` + -Name John ` + -Alias John.Doe +``` + +- Convert the resource to JSON +```powershell +$UserAppOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UserAppSource.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UserAppSource.md new file mode 100644 index 000000000..cabedcb93 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UserAppSource.md @@ -0,0 +1,39 @@ +--- +id: v2024-user-app-source +title: UserAppSource +pagination_label: UserAppSource +sidebar_label: UserAppSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UserAppSource', 'V2024UserAppSource'] +slug: /tools/sdk/powershell/v2024/models/user-app-source +tags: ['SDK', 'Software Development Kit', 'UserAppSource', 'V2024UserAppSource'] +--- + + +# UserAppSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | the source ID | [optional] +**Type** | Pointer to **String** | It will always be ""SOURCE"" | [optional] +**Name** | Pointer to **String** | the source name | [optional] + +## Examples + +- Prepare the resource +```powershell +$UserAppSource = Initialize-PSSailpoint.V2024UserAppSource -Id 9870808a7190d06e01719938fcd20792 ` + -Type SOURCE ` + -Name test-source +``` + +- Convert the resource to JSON +```powershell +$UserAppSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UserAppSourceApp.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UserAppSourceApp.md new file mode 100644 index 000000000..253792914 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/UserAppSourceApp.md @@ -0,0 +1,39 @@ +--- +id: v2024-user-app-source-app +title: UserAppSourceApp +pagination_label: UserAppSourceApp +sidebar_label: UserAppSourceApp +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UserAppSourceApp', 'V2024UserAppSourceApp'] +slug: /tools/sdk/powershell/v2024/models/user-app-source-app +tags: ['SDK', 'Software Development Kit', 'UserAppSourceApp', 'V2024UserAppSourceApp'] +--- + + +# UserAppSourceApp + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | the source app ID | [optional] +**Type** | Pointer to **String** | It will always be ""APPLICATION"" | [optional] +**Name** | Pointer to **String** | the source app name | [optional] + +## Examples + +- Prepare the resource +```powershell +$UserAppSourceApp = Initialize-PSSailpoint.V2024UserAppSourceApp -Id edcb0951812949d085b60cd8bf35bc78 ` + -Type APPLICATION ` + -Name test-app +``` + +- Convert the resource to JSON +```powershell +$UserAppSourceApp | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/V3ConnectorDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/V3ConnectorDto.md new file mode 100644 index 000000000..c116c5533 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/V3ConnectorDto.md @@ -0,0 +1,49 @@ +--- +id: v2024-v3-connector-dto +title: V3ConnectorDto +pagination_label: V3ConnectorDto +sidebar_label: V3ConnectorDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'V3ConnectorDto', 'V2024V3ConnectorDto'] +slug: /tools/sdk/powershell/v2024/models/v3-connector-dto +tags: ['SDK', 'Software Development Kit', 'V3ConnectorDto', 'V2024V3ConnectorDto'] +--- + + +# V3ConnectorDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The connector name | [optional] +**Type** | Pointer to **String** | The connector type | [optional] +**ScriptName** | Pointer to **String** | The connector script name | [optional] +**ClassName** | Pointer to **String** | The connector class name. | [optional] +**Features** | Pointer to **[]String** | The list of features supported by the connector | [optional] +**DirectConnect** | Pointer to **Boolean** | true if the source is a direct connect source | [optional] [default to $false] +**ConnectorMetadata** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map containing metadata pertinent to the connector | [optional] +**Status** | Pointer to **Enum** [ "DEPRECATED", "DEVELOPMENT", "DEMO", "RELEASED" ] | The connector status | [optional] + +## Examples + +- Prepare the resource +```powershell +$V3ConnectorDto = Initialize-PSSailpoint.V2024V3ConnectorDto -Name name ` + -Type ServiceNow ` + -ScriptName servicenow ` + -ClassName sailpoint.connector.OpenConnectorAdapter ` + -Features [PROVISIONING, SYNC_PROVISIONING, SEARCH, UNSTRUCTURED_TARGETS] ` + -DirectConnect true ` + -ConnectorMetadata {supportedUI=ANGULAR, platform=ccg, shortDesc=connector description} ` + -Status RELEASED +``` + +- Convert the resource to JSON +```powershell +$V3ConnectorDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/V3CreateConnectorDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/V3CreateConnectorDto.md new file mode 100644 index 000000000..7972197f5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/V3CreateConnectorDto.md @@ -0,0 +1,43 @@ +--- +id: v2024-v3-create-connector-dto +title: V3CreateConnectorDto +pagination_label: V3CreateConnectorDto +sidebar_label: V3CreateConnectorDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'V3CreateConnectorDto', 'V2024V3CreateConnectorDto'] +slug: /tools/sdk/powershell/v2024/models/v3-create-connector-dto +tags: ['SDK', 'Software Development Kit', 'V3CreateConnectorDto', 'V2024V3CreateConnectorDto'] +--- + + +# V3CreateConnectorDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | The connector name. Need to be unique per tenant. The name will able be used to derive a url friendly unique scriptname that will be in response. Script name can then be used for all update endpoints | [required] +**Type** | Pointer to **String** | The connector type. If not specified will be defaulted to 'custom '+name | [optional] +**ClassName** | **String** | The connector class name. If you are implementing openconnector standard (what is recommended), then this need to be set to sailpoint.connector.OpenConnectorAdapter | [required] +**DirectConnect** | Pointer to **Boolean** | true if the source is a direct connect source | [optional] [default to $true] +**Status** | Pointer to **Enum** [ "DEVELOPMENT", "DEMO", "RELEASED" ] | The connector status | [optional] + +## Examples + +- Prepare the resource +```powershell +$V3CreateConnectorDto = Initialize-PSSailpoint.V2024V3CreateConnectorDto -Name custom connector ` + -Type custom connector type ` + -ClassName sailpoint.connector.OpenConnectorAdapter ` + -DirectConnect true ` + -Status RELEASED +``` + +- Convert the resource to JSON +```powershell +$V3CreateConnectorDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VAClusterStatusChangeEvent.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VAClusterStatusChangeEvent.md new file mode 100644 index 000000000..a3cee45a4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VAClusterStatusChangeEvent.md @@ -0,0 +1,43 @@ +--- +id: v2024-va-cluster-status-change-event +title: VAClusterStatusChangeEvent +pagination_label: VAClusterStatusChangeEvent +sidebar_label: VAClusterStatusChangeEvent +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VAClusterStatusChangeEvent', 'V2024VAClusterStatusChangeEvent'] +slug: /tools/sdk/powershell/v2024/models/va-cluster-status-change-event +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEvent', 'V2024VAClusterStatusChangeEvent'] +--- + + +# VAClusterStatusChangeEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | **System.DateTime** | The date and time the status change occurred. | [required] +**Type** | **Enum** [ "SOURCE", "CLUSTER" ] | The type of the object that initiated this event. | [required] +**Application** | [**VAClusterStatusChangeEventApplication**](va-cluster-status-change-event-application) | | [required] +**HealthCheckResult** | [**VAClusterStatusChangeEventHealthCheckResult**](va-cluster-status-change-event-health-check-result) | | [required] +**PreviousHealthCheckResult** | [**VAClusterStatusChangeEventPreviousHealthCheckResult**](va-cluster-status-change-event-previous-health-check-result) | | [required] + +## Examples + +- Prepare the resource +```powershell +$VAClusterStatusChangeEvent = Initialize-PSSailpoint.V2024VAClusterStatusChangeEvent -Created 2020-06-29T22:01:50.474Z ` + -Type CLUSTER ` + -Application null ` + -HealthCheckResult null ` + -PreviousHealthCheckResult null +``` + +- Convert the resource to JSON +```powershell +$VAClusterStatusChangeEvent | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VAClusterStatusChangeEventApplication.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VAClusterStatusChangeEventApplication.md new file mode 100644 index 000000000..1b214cb1d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VAClusterStatusChangeEventApplication.md @@ -0,0 +1,39 @@ +--- +id: v2024-va-cluster-status-change-event-application +title: VAClusterStatusChangeEventApplication +pagination_label: VAClusterStatusChangeEventApplication +sidebar_label: VAClusterStatusChangeEventApplication +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VAClusterStatusChangeEventApplication', 'V2024VAClusterStatusChangeEventApplication'] +slug: /tools/sdk/powershell/v2024/models/va-cluster-status-change-event-application +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventApplication', 'V2024VAClusterStatusChangeEventApplication'] +--- + + +# VAClusterStatusChangeEventApplication + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The GUID of the application | [required] +**Name** | **String** | The name of the application | [required] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Custom map of attributes for a source. This will only be populated if type is `SOURCE` and the source has a proxy. | [required] + +## Examples + +- Prepare the resource +```powershell +$VAClusterStatusChangeEventApplication = Initialize-PSSailpoint.V2024VAClusterStatusChangeEventApplication -Id 2c9180866166b5b0016167c32ef31a66 ` + -Name Production VA Cluster ` + -Attributes null +``` + +- Convert the resource to JSON +```powershell +$VAClusterStatusChangeEventApplication | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VAClusterStatusChangeEventHealthCheckResult.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VAClusterStatusChangeEventHealthCheckResult.md new file mode 100644 index 000000000..ea1adcb68 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VAClusterStatusChangeEventHealthCheckResult.md @@ -0,0 +1,39 @@ +--- +id: v2024-va-cluster-status-change-event-health-check-result +title: VAClusterStatusChangeEventHealthCheckResult +pagination_label: VAClusterStatusChangeEventHealthCheckResult +sidebar_label: VAClusterStatusChangeEventHealthCheckResult +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VAClusterStatusChangeEventHealthCheckResult', 'V2024VAClusterStatusChangeEventHealthCheckResult'] +slug: /tools/sdk/powershell/v2024/models/va-cluster-status-change-event-health-check-result +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventHealthCheckResult', 'V2024VAClusterStatusChangeEventHealthCheckResult'] +--- + + +# VAClusterStatusChangeEventHealthCheckResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | **String** | Detailed message of the result of the health check. | [required] +**ResultType** | **String** | The type of the health check result. | [required] +**Status** | **Enum** [ "Succeeded", "Failed" ] | The status of the health check. | [required] + +## Examples + +- Prepare the resource +```powershell +$VAClusterStatusChangeEventHealthCheckResult = Initialize-PSSailpoint.V2024VAClusterStatusChangeEventHealthCheckResult -Message Test Connection failed with exception. Error message - java.lang Exception ` + -ResultType SOURCE_STATE_ERROR_CLUSTER ` + -Status Succeeded +``` + +- Convert the resource to JSON +```powershell +$VAClusterStatusChangeEventHealthCheckResult | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md new file mode 100644 index 000000000..6f4fc26f1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md @@ -0,0 +1,39 @@ +--- +id: v2024-va-cluster-status-change-event-previous-health-check-result +title: VAClusterStatusChangeEventPreviousHealthCheckResult +pagination_label: VAClusterStatusChangeEventPreviousHealthCheckResult +sidebar_label: VAClusterStatusChangeEventPreviousHealthCheckResult +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VAClusterStatusChangeEventPreviousHealthCheckResult', 'V2024VAClusterStatusChangeEventPreviousHealthCheckResult'] +slug: /tools/sdk/powershell/v2024/models/va-cluster-status-change-event-previous-health-check-result +tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventPreviousHealthCheckResult', 'V2024VAClusterStatusChangeEventPreviousHealthCheckResult'] +--- + + +# VAClusterStatusChangeEventPreviousHealthCheckResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | **String** | Detailed message of the result of the health check. | [required] +**ResultType** | **String** | The type of the health check result. | [required] +**Status** | **Enum** [ "Succeeded", "Failed" ] | The status of the health check. | [required] + +## Examples + +- Prepare the resource +```powershell +$VAClusterStatusChangeEventPreviousHealthCheckResult = Initialize-PSSailpoint.V2024VAClusterStatusChangeEventPreviousHealthCheckResult -Message Test Connection failed with exception. Error message - java.lang Exception ` + -ResultType SOURCE_STATE_ERROR_CLUSTER ` + -Status Failed +``` + +- Convert the resource to JSON +```powershell +$VAClusterStatusChangeEventPreviousHealthCheckResult | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ValidateFilterInputDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ValidateFilterInputDto.md new file mode 100644 index 000000000..e52ad6d6b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ValidateFilterInputDto.md @@ -0,0 +1,37 @@ +--- +id: v2024-validate-filter-input-dto +title: ValidateFilterInputDto +pagination_label: ValidateFilterInputDto +sidebar_label: ValidateFilterInputDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ValidateFilterInputDto', 'V2024ValidateFilterInputDto'] +slug: /tools/sdk/powershell/v2024/models/validate-filter-input-dto +tags: ['SDK', 'Software Development Kit', 'ValidateFilterInputDto', 'V2024ValidateFilterInputDto'] +--- + + +# ValidateFilterInputDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarInput** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Mock input to evaluate filter expression against. | [required] +**VarFilter** | **String** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [required] + +## Examples + +- Prepare the resource +```powershell +$ValidateFilterInputDto = Initialize-PSSailpoint.V2024ValidateFilterInputDto -VarInput {identityId=201327fda1c44704ac01181e963d463c} ` + -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] +``` + +- Convert the resource to JSON +```powershell +$ValidateFilterInputDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ValidateFilterOutputDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ValidateFilterOutputDto.md new file mode 100644 index 000000000..096d8833b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ValidateFilterOutputDto.md @@ -0,0 +1,39 @@ +--- +id: v2024-validate-filter-output-dto +title: ValidateFilterOutputDto +pagination_label: ValidateFilterOutputDto +sidebar_label: ValidateFilterOutputDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ValidateFilterOutputDto', 'V2024ValidateFilterOutputDto'] +slug: /tools/sdk/powershell/v2024/models/validate-filter-output-dto +tags: ['SDK', 'Software Development Kit', 'ValidateFilterOutputDto', 'V2024ValidateFilterOutputDto'] +--- + + +# ValidateFilterOutputDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IsValid** | Pointer to **Boolean** | When this field is true, the filter expression is valid against the input. | [optional] [default to $false] +**IsValidJSONPath** | Pointer to **Boolean** | When this field is true, the filter expression is using a valid JSON path. | [optional] [default to $false] +**IsPathExist** | Pointer to **Boolean** | When this field is true, the filter expression is using an existing path. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$ValidateFilterOutputDto = Initialize-PSSailpoint.V2024ValidateFilterOutputDto -IsValid true ` + -IsValidJSONPath true ` + -IsPathExist true +``` + +- Convert the resource to JSON +```powershell +$ValidateFilterOutputDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Value.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Value.md new file mode 100644 index 000000000..5edd6d387 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Value.md @@ -0,0 +1,37 @@ +--- +id: v2024-value +title: Value +pagination_label: Value +sidebar_label: Value +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Value', 'V2024Value'] +slug: /tools/sdk/powershell/v2024/models/value +tags: ['SDK', 'Software Development Kit', 'Value', 'V2024Value'] +--- + + +# Value + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **String** | The type of attribute value | [optional] +**Value** | Pointer to **String** | The attribute value | [optional] + +## Examples + +- Prepare the resource +```powershell +$Value = Initialize-PSSailpoint.V2024Value -Type STRING ` + -Value Austin +``` + +- Convert the resource to JSON +```powershell +$Value | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VendorConnectorMapping.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VendorConnectorMapping.md new file mode 100644 index 000000000..11212796c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VendorConnectorMapping.md @@ -0,0 +1,51 @@ +--- +id: v2024-vendor-connector-mapping +title: VendorConnectorMapping +pagination_label: VendorConnectorMapping +sidebar_label: VendorConnectorMapping +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMapping', 'V2024VendorConnectorMapping'] +slug: /tools/sdk/powershell/v2024/models/vendor-connector-mapping +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMapping', 'V2024VendorConnectorMapping'] +--- + + +# VendorConnectorMapping + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The unique identifier for the vendor-connector mapping. | [optional] +**Vendor** | Pointer to **String** | The name of the vendor. | [optional] +**Connector** | Pointer to **String** | The name of the connector. | [optional] +**CreatedAt** | Pointer to **System.DateTime** | The creation timestamp of the mapping. | [optional] +**CreatedBy** | Pointer to **String** | The identifier of the user who created the mapping. | [optional] +**UpdatedAt** | Pointer to [**VendorConnectorMappingUpdatedAt**](vendor-connector-mapping-updated-at) | | [optional] +**UpdatedBy** | Pointer to [**VendorConnectorMappingUpdatedBy**](vendor-connector-mapping-updated-by) | | [optional] +**DeletedAt** | Pointer to [**VendorConnectorMappingDeletedAt**](vendor-connector-mapping-deleted-at) | | [optional] +**DeletedBy** | Pointer to [**VendorConnectorMappingDeletedBy**](vendor-connector-mapping-deleted-by) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$VendorConnectorMapping = Initialize-PSSailpoint.V2024VendorConnectorMapping -Id 78733556-9ea3-4f59-bf69-e5cd92b011b4 ` + -Vendor Example vendor ` + -Connector Example connector ` + -CreatedAt 2024-03-13T12:56:19.391294Z ` + -CreatedBy admin ` + -UpdatedAt null ` + -UpdatedBy null ` + -DeletedAt null ` + -DeletedBy null +``` + +- Convert the resource to JSON +```powershell +$VendorConnectorMapping | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VendorConnectorMappingDeletedAt.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VendorConnectorMappingDeletedAt.md new file mode 100644 index 000000000..b9d85d5e2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VendorConnectorMappingDeletedAt.md @@ -0,0 +1,37 @@ +--- +id: v2024-vendor-connector-mapping-deleted-at +title: VendorConnectorMappingDeletedAt +pagination_label: VendorConnectorMappingDeletedAt +sidebar_label: VendorConnectorMappingDeletedAt +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMappingDeletedAt', 'V2024VendorConnectorMappingDeletedAt'] +slug: /tools/sdk/powershell/v2024/models/vendor-connector-mapping-deleted-at +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingDeletedAt', 'V2024VendorConnectorMappingDeletedAt'] +--- + + +# VendorConnectorMappingDeletedAt + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Time** | Pointer to **System.DateTime** | The timestamp when the mapping was deleted, represented in ISO 8601 format, if applicable. | [optional] +**Valid** | Pointer to **Boolean** | A flag indicating if the 'Time' field is set and valid, i.e., if the mapping has been deleted. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$VendorConnectorMappingDeletedAt = Initialize-PSSailpoint.V2024VendorConnectorMappingDeletedAt -Time 0001-01-01T00:00Z ` + -Valid false +``` + +- Convert the resource to JSON +```powershell +$VendorConnectorMappingDeletedAt | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VendorConnectorMappingDeletedBy.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VendorConnectorMappingDeletedBy.md new file mode 100644 index 000000000..290787d63 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VendorConnectorMappingDeletedBy.md @@ -0,0 +1,37 @@ +--- +id: v2024-vendor-connector-mapping-deleted-by +title: VendorConnectorMappingDeletedBy +pagination_label: VendorConnectorMappingDeletedBy +sidebar_label: VendorConnectorMappingDeletedBy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMappingDeletedBy', 'V2024VendorConnectorMappingDeletedBy'] +slug: /tools/sdk/powershell/v2024/models/vendor-connector-mapping-deleted-by +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingDeletedBy', 'V2024VendorConnectorMappingDeletedBy'] +--- + + +# VendorConnectorMappingDeletedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**String** | Pointer to **String** | The identifier of the user who deleted the mapping, if applicable. | [optional] +**Valid** | Pointer to **Boolean** | A flag indicating if the 'String' field is set and valid, i.e., if the mapping has been deleted. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$VendorConnectorMappingDeletedBy = Initialize-PSSailpoint.V2024VendorConnectorMappingDeletedBy -String ` + -Valid false +``` + +- Convert the resource to JSON +```powershell +$VendorConnectorMappingDeletedBy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VendorConnectorMappingUpdatedAt.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VendorConnectorMappingUpdatedAt.md new file mode 100644 index 000000000..aa4d4da36 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VendorConnectorMappingUpdatedAt.md @@ -0,0 +1,37 @@ +--- +id: v2024-vendor-connector-mapping-updated-at +title: VendorConnectorMappingUpdatedAt +pagination_label: VendorConnectorMappingUpdatedAt +sidebar_label: VendorConnectorMappingUpdatedAt +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMappingUpdatedAt', 'V2024VendorConnectorMappingUpdatedAt'] +slug: /tools/sdk/powershell/v2024/models/vendor-connector-mapping-updated-at +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingUpdatedAt', 'V2024VendorConnectorMappingUpdatedAt'] +--- + + +# VendorConnectorMappingUpdatedAt + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Time** | Pointer to **System.DateTime** | The timestamp when the mapping was last updated, represented in ISO 8601 format. | [optional] +**Valid** | Pointer to **Boolean** | A flag indicating if the 'Time' field is set and valid. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$VendorConnectorMappingUpdatedAt = Initialize-PSSailpoint.V2024VendorConnectorMappingUpdatedAt -Time 2024-03-14T12:56:19.391294Z ` + -Valid true +``` + +- Convert the resource to JSON +```powershell +$VendorConnectorMappingUpdatedAt | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VendorConnectorMappingUpdatedBy.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VendorConnectorMappingUpdatedBy.md new file mode 100644 index 000000000..d69d4e360 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VendorConnectorMappingUpdatedBy.md @@ -0,0 +1,37 @@ +--- +id: v2024-vendor-connector-mapping-updated-by +title: VendorConnectorMappingUpdatedBy +pagination_label: VendorConnectorMappingUpdatedBy +sidebar_label: VendorConnectorMappingUpdatedBy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMappingUpdatedBy', 'V2024VendorConnectorMappingUpdatedBy'] +slug: /tools/sdk/powershell/v2024/models/vendor-connector-mapping-updated-by +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingUpdatedBy', 'V2024VendorConnectorMappingUpdatedBy'] +--- + + +# VendorConnectorMappingUpdatedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**String** | Pointer to **String** | The identifier of the user who last updated the mapping, if available. | [optional] +**Valid** | Pointer to **Boolean** | A flag indicating if the 'String' field is set and valid. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$VendorConnectorMappingUpdatedBy = Initialize-PSSailpoint.V2024VendorConnectorMappingUpdatedBy -String user-67891 ` + -Valid true +``` + +- Convert the resource to JSON +```powershell +$VendorConnectorMappingUpdatedBy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ViolationContext.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ViolationContext.md new file mode 100644 index 000000000..2e143c311 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ViolationContext.md @@ -0,0 +1,37 @@ +--- +id: v2024-violation-context +title: ViolationContext +pagination_label: ViolationContext +sidebar_label: ViolationContext +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationContext', 'V2024ViolationContext'] +slug: /tools/sdk/powershell/v2024/models/violation-context +tags: ['SDK', 'Software Development Kit', 'ViolationContext', 'V2024ViolationContext'] +--- + + +# ViolationContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policy** | Pointer to [**ViolationContextPolicy**](violation-context-policy) | | [optional] +**ConflictingAccessCriteria** | Pointer to [**ExceptionAccessCriteria**](exception-access-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ViolationContext = Initialize-PSSailpoint.V2024ViolationContext -Policy null ` + -ConflictingAccessCriteria null +``` + +- Convert the resource to JSON +```powershell +$ViolationContext | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ViolationContextPolicy.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ViolationContextPolicy.md new file mode 100644 index 000000000..0df70d0c1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ViolationContextPolicy.md @@ -0,0 +1,39 @@ +--- +id: v2024-violation-context-policy +title: ViolationContextPolicy +pagination_label: ViolationContextPolicy +sidebar_label: ViolationContextPolicy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationContextPolicy', 'V2024ViolationContextPolicy'] +slug: /tools/sdk/powershell/v2024/models/violation-context-policy +tags: ['SDK', 'Software Development Kit', 'ViolationContextPolicy', 'V2024ViolationContextPolicy'] +--- + + +# ViolationContextPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | The type of object that is referenced | [optional] +**Id** | Pointer to **String** | SOD policy ID. | [optional] +**Name** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ViolationContextPolicy = Initialize-PSSailpoint.V2024ViolationContextPolicy -Type ENTITLEMENT ` + -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -Name A very cool policy name +``` + +- Convert the resource to JSON +```powershell +$ViolationContextPolicy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ViolationOwnerAssignmentConfig.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ViolationOwnerAssignmentConfig.md new file mode 100644 index 000000000..ee4ea6a11 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ViolationOwnerAssignmentConfig.md @@ -0,0 +1,37 @@ +--- +id: v2024-violation-owner-assignment-config +title: ViolationOwnerAssignmentConfig +pagination_label: ViolationOwnerAssignmentConfig +sidebar_label: ViolationOwnerAssignmentConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationOwnerAssignmentConfig', 'V2024ViolationOwnerAssignmentConfig'] +slug: /tools/sdk/powershell/v2024/models/violation-owner-assignment-config +tags: ['SDK', 'Software Development Kit', 'ViolationOwnerAssignmentConfig', 'V2024ViolationOwnerAssignmentConfig'] +--- + + +# ViolationOwnerAssignmentConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AssignmentRule** | Pointer to **Enum** [ "MANAGER", "STATIC" ] | Details about the violations owner. MANAGER - identity's manager STATIC - Governance Group or Identity | [optional] +**OwnerRef** | Pointer to [**ViolationOwnerAssignmentConfigOwnerRef**](violation-owner-assignment-config-owner-ref) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ViolationOwnerAssignmentConfig = Initialize-PSSailpoint.V2024ViolationOwnerAssignmentConfig -AssignmentRule MANAGER ` + -OwnerRef null +``` + +- Convert the resource to JSON +```powershell +$ViolationOwnerAssignmentConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ViolationOwnerAssignmentConfigOwnerRef.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ViolationOwnerAssignmentConfigOwnerRef.md new file mode 100644 index 000000000..a303cd1ba --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ViolationOwnerAssignmentConfigOwnerRef.md @@ -0,0 +1,39 @@ +--- +id: v2024-violation-owner-assignment-config-owner-ref +title: ViolationOwnerAssignmentConfigOwnerRef +pagination_label: ViolationOwnerAssignmentConfigOwnerRef +sidebar_label: ViolationOwnerAssignmentConfigOwnerRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationOwnerAssignmentConfigOwnerRef', 'V2024ViolationOwnerAssignmentConfigOwnerRef'] +slug: /tools/sdk/powershell/v2024/models/violation-owner-assignment-config-owner-ref +tags: ['SDK', 'Software Development Kit', 'ViolationOwnerAssignmentConfigOwnerRef', 'V2024ViolationOwnerAssignmentConfigOwnerRef'] +--- + + +# ViolationOwnerAssignmentConfigOwnerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY", "GOVERNANCE_GROUP", "MANAGER" ] | Owner type. | [optional] +**Id** | Pointer to **String** | Owner's ID. | [optional] +**Name** | Pointer to **String** | Owner's name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ViolationOwnerAssignmentConfigOwnerRef = Initialize-PSSailpoint.V2024ViolationOwnerAssignmentConfigOwnerRef -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Support +``` + +- Convert the resource to JSON +```powershell +$ViolationOwnerAssignmentConfigOwnerRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ViolationPrediction.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ViolationPrediction.md new file mode 100644 index 000000000..5f4057607 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/ViolationPrediction.md @@ -0,0 +1,35 @@ +--- +id: v2024-violation-prediction +title: ViolationPrediction +pagination_label: ViolationPrediction +sidebar_label: ViolationPrediction +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationPrediction', 'V2024ViolationPrediction'] +slug: /tools/sdk/powershell/v2024/models/violation-prediction +tags: ['SDK', 'Software Development Kit', 'ViolationPrediction', 'V2024ViolationPrediction'] +--- + + +# ViolationPrediction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ViolationContexts** | Pointer to [**[]ViolationContext**](violation-context) | List of Violation Contexts | [optional] + +## Examples + +- Prepare the resource +```powershell +$ViolationPrediction = Initialize-PSSailpoint.V2024ViolationPrediction -ViolationContexts null +``` + +- Convert the resource to JSON +```powershell +$ViolationPrediction | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VisibilityCriteria.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VisibilityCriteria.md new file mode 100644 index 000000000..0ecef8ea2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/VisibilityCriteria.md @@ -0,0 +1,35 @@ +--- +id: v2024-visibility-criteria +title: VisibilityCriteria +pagination_label: VisibilityCriteria +sidebar_label: VisibilityCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VisibilityCriteria', 'V2024VisibilityCriteria'] +slug: /tools/sdk/powershell/v2024/models/visibility-criteria +tags: ['SDK', 'Software Development Kit', 'VisibilityCriteria', 'V2024VisibilityCriteria'] +--- + + +# VisibilityCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Expression** | Pointer to [**Expression**](expression) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$VisibilityCriteria = Initialize-PSSailpoint.V2024VisibilityCriteria -Expression null +``` + +- Convert the resource to JSON +```powershell +$VisibilityCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkItemForward.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkItemForward.md new file mode 100644 index 000000000..2e4639f58 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkItemForward.md @@ -0,0 +1,39 @@ +--- +id: v2024-work-item-forward +title: WorkItemForward +pagination_label: WorkItemForward +sidebar_label: WorkItemForward +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemForward', 'V2024WorkItemForward'] +slug: /tools/sdk/powershell/v2024/models/work-item-forward +tags: ['SDK', 'Software Development Kit', 'WorkItemForward', 'V2024WorkItemForward'] +--- + + +# WorkItemForward + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TargetOwnerId** | **String** | The ID of the identity to forward this work item to. | [required] +**Comment** | **String** | Comments to send to the target owner | [required] +**SendNotifications** | Pointer to **Boolean** | If true, send a notification to the target owner. | [optional] [default to $true] + +## Examples + +- Prepare the resource +```powershell +$WorkItemForward = Initialize-PSSailpoint.V2024WorkItemForward -TargetOwnerId 2c9180835d2e5168015d32f890ca1581 ` + -Comment I'm going on vacation. ` + -SendNotifications true +``` + +- Convert the resource to JSON +```powershell +$WorkItemForward | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkItemState.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkItemState.md new file mode 100644 index 000000000..4bb848cfb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkItemState.md @@ -0,0 +1,32 @@ +--- +id: v2024-work-item-state +title: WorkItemState +pagination_label: WorkItemState +sidebar_label: WorkItemState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemState', 'V2024WorkItemState'] +slug: /tools/sdk/powershell/v2024/models/work-item-state +tags: ['SDK', 'Software Development Kit', 'WorkItemState', 'V2024WorkItemState'] +--- + + +# WorkItemState + +## Enum + + +* `Finished` (value: `"Finished"`) + +* `Rejected` (value: `"Rejected"`) + +* `Returned` (value: `"Returned"`) + +* `Expired` (value: `"Expired"`) + +* `Pending` (value: `"Pending"`) + +* `Canceled` (value: `"Canceled"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkItemStateManualWorkItems.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkItemStateManualWorkItems.md new file mode 100644 index 000000000..5bf825120 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkItemStateManualWorkItems.md @@ -0,0 +1,32 @@ +--- +id: v2024-work-item-state-manual-work-items +title: WorkItemStateManualWorkItems +pagination_label: WorkItemStateManualWorkItems +sidebar_label: WorkItemStateManualWorkItems +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemStateManualWorkItems', 'V2024WorkItemStateManualWorkItems'] +slug: /tools/sdk/powershell/v2024/models/work-item-state-manual-work-items +tags: ['SDK', 'Software Development Kit', 'WorkItemStateManualWorkItems', 'V2024WorkItemStateManualWorkItems'] +--- + + +# WorkItemStateManualWorkItems + +## Enum + + +* `Finished` (value: `"Finished"`) + +* `Rejected` (value: `"Rejected"`) + +* `Returned` (value: `"Returned"`) + +* `Expired` (value: `"Expired"`) + +* `Pending` (value: `"Pending"`) + +* `Canceled` (value: `"Canceled"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkItemTypeManualWorkItems.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkItemTypeManualWorkItems.md new file mode 100644 index 000000000..6322b1033 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkItemTypeManualWorkItems.md @@ -0,0 +1,48 @@ +--- +id: v2024-work-item-type-manual-work-items +title: WorkItemTypeManualWorkItems +pagination_label: WorkItemTypeManualWorkItems +sidebar_label: WorkItemTypeManualWorkItems +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemTypeManualWorkItems', 'V2024WorkItemTypeManualWorkItems'] +slug: /tools/sdk/powershell/v2024/models/work-item-type-manual-work-items +tags: ['SDK', 'Software Development Kit', 'WorkItemTypeManualWorkItems', 'V2024WorkItemTypeManualWorkItems'] +--- + + +# WorkItemTypeManualWorkItems + +## Enum + + +* `Generic` (value: `"Generic"`) + +* `Certification` (value: `"Certification"`) + +* `Remediation` (value: `"Remediation"`) + +* `Delegation` (value: `"Delegation"`) + +* `Approval` (value: `"Approval"`) + +* `ViolationReview` (value: `"ViolationReview"`) + +* `Form` (value: `"Form"`) + +* `PolicyVioloation` (value: `"PolicyVioloation"`) + +* `Challenge` (value: `"Challenge"`) + +* `ImpactAnalysis` (value: `"ImpactAnalysis"`) + +* `Signoff` (value: `"Signoff"`) + +* `Event` (value: `"Event"`) + +* `ManualAction` (value: `"ManualAction"`) + +* `Test` (value: `"Test"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkItems.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkItems.md new file mode 100644 index 000000000..128e8b229 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkItems.md @@ -0,0 +1,67 @@ +--- +id: v2024-work-items +title: WorkItems +pagination_label: WorkItems +sidebar_label: WorkItems +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItems', 'V2024WorkItems'] +slug: /tools/sdk/powershell/v2024/models/work-items +tags: ['SDK', 'Software Development Kit', 'WorkItems', 'V2024WorkItems'] +--- + + +# WorkItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the work item | [optional] +**RequesterId** | Pointer to **String** | ID of the requester | [optional] +**RequesterDisplayName** | Pointer to **String** | The displayname of the requester | [optional] +**OwnerId** | Pointer to **String** | The ID of the owner | [optional] +**OwnerName** | Pointer to **String** | The name of the owner | [optional] +**Created** | Pointer to **System.DateTime** | Time when the work item was created | [optional] +**Modified** | Pointer to **System.DateTime** | Time when the work item was last updated | [optional] +**Description** | Pointer to **String** | The description of the work item | [optional] +**State** | Pointer to [**WorkItemStateManualWorkItems**](work-item-state-manual-work-items) | | [optional] +**Type** | Pointer to [**WorkItemTypeManualWorkItems**](work-item-type-manual-work-items) | | [optional] +**RemediationItems** | Pointer to [**[]RemediationItemDetails**](remediation-item-details) | A list of remediation items | [optional] +**ApprovalItems** | Pointer to [**[]ApprovalItemDetails**](approval-item-details) | A list of items that need to be approved | [optional] +**Name** | Pointer to **String** | The work item name | [optional] +**Completed** | Pointer to **System.DateTime** | The time at which the work item completed | [optional] +**NumItems** | Pointer to **Int32** | The number of items in the work item | [optional] +**Form** | Pointer to [**WorkItemsForm**](work-items-form) | | [optional] +**Errors** | Pointer to **[]String** | An array of errors that ocurred during the work item | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkItems = Initialize-PSSailpoint.V2024WorkItems -Id 2c9180835d2e5168015d32f890ca1581 ` + -RequesterId 2c9180835d2e5168015d32f890ca1581 ` + -RequesterDisplayName John Smith ` + -OwnerId 2c9180835d2e5168015d32f890ca1581 ` + -OwnerName Jason Smith ` + -Created 2017-07-11T18:45:37.098Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Description Create account on source 'AD' ` + -State null ` + -Type null ` + -RemediationItems null ` + -ApprovalItems null ` + -Name Account Create ` + -Completed 2018-10-19T13:49:37.385Z ` + -NumItems 19 ` + -Form null ` + -Errors [The work item ID that was specified was not found.] +``` + +- Convert the resource to JSON +```powershell +$WorkItems | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkItemsCount.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkItemsCount.md new file mode 100644 index 000000000..235850093 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkItemsCount.md @@ -0,0 +1,35 @@ +--- +id: v2024-work-items-count +title: WorkItemsCount +pagination_label: WorkItemsCount +sidebar_label: WorkItemsCount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemsCount', 'V2024WorkItemsCount'] +slug: /tools/sdk/powershell/v2024/models/work-items-count +tags: ['SDK', 'Software Development Kit', 'WorkItemsCount', 'V2024WorkItemsCount'] +--- + + +# WorkItemsCount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | Pointer to **Int32** | The count of work items | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkItemsCount = Initialize-PSSailpoint.V2024WorkItemsCount -Count 29 +``` + +- Convert the resource to JSON +```powershell +$WorkItemsCount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkItemsForm.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkItemsForm.md new file mode 100644 index 000000000..1bd11f654 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkItemsForm.md @@ -0,0 +1,45 @@ +--- +id: v2024-work-items-form +title: WorkItemsForm +pagination_label: WorkItemsForm +sidebar_label: WorkItemsForm +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemsForm', 'V2024WorkItemsForm'] +slug: /tools/sdk/powershell/v2024/models/work-items-form +tags: ['SDK', 'Software Development Kit', 'WorkItemsForm', 'V2024WorkItemsForm'] +--- + + +# WorkItemsForm + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the form | [optional] +**Name** | Pointer to **String** | Name of the form | [optional] +**Title** | Pointer to **String** | The form title | [optional] +**Subtitle** | Pointer to **String** | The form subtitle. | [optional] +**TargetUser** | Pointer to **String** | The name of the user that should be shown this form | [optional] +**Sections** | Pointer to [**[]SectionDetails**](section-details) | Sections of the form | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkItemsForm = Initialize-PSSailpoint.V2024WorkItemsForm -Id 2c9180835d2e5168015d32f890ca1581 ` + -Name AccountSelection Form ` + -Title Account Selection for John.Doe ` + -Subtitle Please select from the following ` + -TargetUser Jane.Doe ` + -Sections null +``` + +- Convert the resource to JSON +```powershell +$WorkItemsForm | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkItemsSummary.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkItemsSummary.md new file mode 100644 index 000000000..bae1bc38b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkItemsSummary.md @@ -0,0 +1,39 @@ +--- +id: v2024-work-items-summary +title: WorkItemsSummary +pagination_label: WorkItemsSummary +sidebar_label: WorkItemsSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemsSummary', 'V2024WorkItemsSummary'] +slug: /tools/sdk/powershell/v2024/models/work-items-summary +tags: ['SDK', 'Software Development Kit', 'WorkItemsSummary', 'V2024WorkItemsSummary'] +--- + + +# WorkItemsSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Open** | Pointer to **Int32** | The count of open work items | [optional] +**Completed** | Pointer to **Int32** | The count of completed work items | [optional] +**Total** | Pointer to **Int32** | The count of total work items | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkItemsSummary = Initialize-PSSailpoint.V2024WorkItemsSummary -Open 29 ` + -Completed 1 ` + -Total 30 +``` + +- Convert the resource to JSON +```powershell +$WorkItemsSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Workflow.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Workflow.md new file mode 100644 index 000000000..fb6f83266 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/Workflow.md @@ -0,0 +1,59 @@ +--- +id: v2024-workflow +title: Workflow +pagination_label: Workflow +sidebar_label: Workflow +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Workflow', 'V2024Workflow'] +slug: /tools/sdk/powershell/v2024/models/workflow +tags: ['SDK', 'Software Development Kit', 'Workflow', 'V2024Workflow'] +--- + + +# Workflow + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the workflow | [optional] +**Owner** | Pointer to [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] +**Description** | Pointer to **String** | Description of what the workflow accomplishes | [optional] +**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] +**Enabled** | Pointer to **Boolean** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to $false] +**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] +**Id** | Pointer to **String** | Workflow ID. This is a UUID generated upon creation. | [optional] +**ExecutionCount** | Pointer to **Int32** | The number of times this workflow has been executed. | [optional] +**FailureCount** | Pointer to **Int32** | The number of times this workflow has failed during execution. | [optional] +**Created** | Pointer to **System.DateTime** | The date and time the workflow was created. | [optional] +**Modified** | Pointer to **System.DateTime** | The date and time the workflow was modified. | [optional] +**ModifiedBy** | Pointer to [**WorkflowModifiedBy**](workflow-modified-by) | | [optional] +**Creator** | Pointer to [**WorkflowAllOfCreator**](workflow-all-of-creator) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Workflow = Initialize-PSSailpoint.V2024Workflow -Name Send Email ` + -Owner null ` + -Description Send an email to the identity who's attributes changed. ` + -Definition null ` + -Enabled false ` + -Trigger null ` + -Id d201c5e9-d37b-4aff-af14-66414f39d569 ` + -ExecutionCount 2 ` + -FailureCount 0 ` + -Created 2022-01-10T16:06:16.636381447Z ` + -Modified 2023-12-05T15:18:27.699132301Z ` + -ModifiedBy null ` + -Creator null +``` + +- Convert the resource to JSON +```powershell +$Workflow | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowAllOfCreator.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowAllOfCreator.md new file mode 100644 index 000000000..018c6d2b0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowAllOfCreator.md @@ -0,0 +1,39 @@ +--- +id: v2024-workflow-all-of-creator +title: WorkflowAllOfCreator +pagination_label: WorkflowAllOfCreator +sidebar_label: WorkflowAllOfCreator +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowAllOfCreator', 'V2024WorkflowAllOfCreator'] +slug: /tools/sdk/powershell/v2024/models/workflow-all-of-creator +tags: ['SDK', 'Software Development Kit', 'WorkflowAllOfCreator', 'V2024WorkflowAllOfCreator'] +--- + + +# WorkflowAllOfCreator + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Workflow creator's DTO type. | [optional] +**Id** | Pointer to **String** | Workflow creator's identity ID. | [optional] +**Name** | Pointer to **String** | Workflow creator's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowAllOfCreator = Initialize-PSSailpoint.V2024WorkflowAllOfCreator -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$WorkflowAllOfCreator | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowBody.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowBody.md new file mode 100644 index 000000000..9bbd8b3b9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowBody.md @@ -0,0 +1,45 @@ +--- +id: v2024-workflow-body +title: WorkflowBody +pagination_label: WorkflowBody +sidebar_label: WorkflowBody +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowBody', 'V2024WorkflowBody'] +slug: /tools/sdk/powershell/v2024/models/workflow-body +tags: ['SDK', 'Software Development Kit', 'WorkflowBody', 'V2024WorkflowBody'] +--- + + +# WorkflowBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the workflow | [optional] +**Owner** | Pointer to [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] +**Description** | Pointer to **String** | Description of what the workflow accomplishes | [optional] +**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] +**Enabled** | Pointer to **Boolean** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to $false] +**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowBody = Initialize-PSSailpoint.V2024WorkflowBody -Name Send Email ` + -Owner null ` + -Description Send an email to the identity who's attributes changed. ` + -Definition null ` + -Enabled false ` + -Trigger null +``` + +- Convert the resource to JSON +```powershell +$WorkflowBody | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowBodyOwner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowBodyOwner.md new file mode 100644 index 000000000..87abbc289 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowBodyOwner.md @@ -0,0 +1,39 @@ +--- +id: v2024-workflow-body-owner +title: WorkflowBodyOwner +pagination_label: WorkflowBodyOwner +sidebar_label: WorkflowBodyOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowBodyOwner', 'V2024WorkflowBodyOwner'] +slug: /tools/sdk/powershell/v2024/models/workflow-body-owner +tags: ['SDK', 'Software Development Kit', 'WorkflowBodyOwner', 'V2024WorkflowBodyOwner'] +--- + + +# WorkflowBodyOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of object that is referenced | [optional] +**Id** | Pointer to **String** | The unique ID of the object | [optional] +**Name** | Pointer to **String** | The name of the object | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowBodyOwner = Initialize-PSSailpoint.V2024WorkflowBodyOwner -Type IDENTITY ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$WorkflowBodyOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowDefinition.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowDefinition.md new file mode 100644 index 000000000..6b5a3d2ba --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowDefinition.md @@ -0,0 +1,37 @@ +--- +id: v2024-workflow-definition +title: WorkflowDefinition +pagination_label: WorkflowDefinition +sidebar_label: WorkflowDefinition +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowDefinition', 'V2024WorkflowDefinition'] +slug: /tools/sdk/powershell/v2024/models/workflow-definition +tags: ['SDK', 'Software Development Kit', 'WorkflowDefinition', 'V2024WorkflowDefinition'] +--- + + +# WorkflowDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Start** | Pointer to **String** | The name of the starting step. | [optional] +**Steps** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowDefinition = Initialize-PSSailpoint.V2024WorkflowDefinition -Start Send Email Test ` + -Steps {Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=ACTION}, success={type=success}} +``` + +- Convert the resource to JSON +```powershell +$WorkflowDefinition | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowExecution.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowExecution.md new file mode 100644 index 000000000..a1136c5c8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowExecution.md @@ -0,0 +1,45 @@ +--- +id: v2024-workflow-execution +title: WorkflowExecution +pagination_label: WorkflowExecution +sidebar_label: WorkflowExecution +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowExecution', 'V2024WorkflowExecution'] +slug: /tools/sdk/powershell/v2024/models/workflow-execution +tags: ['SDK', 'Software Development Kit', 'WorkflowExecution', 'V2024WorkflowExecution'] +--- + + +# WorkflowExecution + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Workflow execution ID. | [optional] +**WorkflowId** | Pointer to **String** | Workflow ID. | [optional] +**RequestId** | Pointer to **String** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] +**StartTime** | Pointer to **System.DateTime** | Date/time when the workflow started. | [optional] +**CloseTime** | Pointer to **System.DateTime** | Date/time when the workflow ended. | [optional] +**Status** | Pointer to **Enum** [ "Completed", "Failed", "Canceled", "Executing" ] | Workflow execution status. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowExecution = Initialize-PSSailpoint.V2024WorkflowExecution -Id b393f4e2-4785-4d7f-ab27-3a6b8ded4c81 ` + -WorkflowId d201c5d9-d37b-4a2f-af14-66414f39d568 ` + -RequestId 41e12a74fa7b4a6a98ae47887b64acdb ` + -StartTime 2022-02-07T20:13:29.356648026Z ` + -CloseTime 2022-02-07T20:13:31.682410165Z ` + -Status Completed +``` + +- Convert the resource to JSON +```powershell +$WorkflowExecution | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowExecutionEvent.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowExecutionEvent.md new file mode 100644 index 000000000..51e11c609 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowExecutionEvent.md @@ -0,0 +1,39 @@ +--- +id: v2024-workflow-execution-event +title: WorkflowExecutionEvent +pagination_label: WorkflowExecutionEvent +sidebar_label: WorkflowExecutionEvent +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowExecutionEvent', 'V2024WorkflowExecutionEvent'] +slug: /tools/sdk/powershell/v2024/models/workflow-execution-event +tags: ['SDK', 'Software Development Kit', 'WorkflowExecutionEvent', 'V2024WorkflowExecutionEvent'] +--- + + +# WorkflowExecutionEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "WorkflowExecutionScheduled", "WorkflowExecutionStarted", "WorkflowExecutionCompleted", "WorkflowExecutionFailed", "WorkflowTaskScheduled", "WorkflowTaskStarted", "WorkflowTaskCompleted", "WorkflowTaskFailed", "ActivityTaskScheduled", "ActivityTaskStarted", "ActivityTaskCompleted", "ActivityTaskFailed", "StartChildWorkflowExecutionInitiated", "ChildWorkflowExecutionStarted", "ChildWorkflowExecutionCompleted", "ChildWorkflowExecutionFailed" ] | The type of event | [optional] +**Timestamp** | Pointer to **System.DateTime** | The date-time when the event occurred | [optional] +**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Additional attributes associated with the event | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowExecutionEvent = Initialize-PSSailpoint.V2024WorkflowExecutionEvent -Type WorkflowTaskScheduled ` + -Timestamp 2022-02-07T20:13:31.640618296Z ` + -Attributes {} +``` + +- Convert the resource to JSON +```powershell +$WorkflowExecutionEvent | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowLibraryAction.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowLibraryAction.md new file mode 100644 index 000000000..11adfb572 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowLibraryAction.md @@ -0,0 +1,57 @@ +--- +id: v2024-workflow-library-action +title: WorkflowLibraryAction +pagination_label: WorkflowLibraryAction +sidebar_label: WorkflowLibraryAction +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryAction', 'V2024WorkflowLibraryAction'] +slug: /tools/sdk/powershell/v2024/models/workflow-library-action +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryAction', 'V2024WorkflowLibraryAction'] +--- + + +# WorkflowLibraryAction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Action ID. This is a static namespaced ID for the action | [optional] +**Name** | Pointer to **String** | Action Name | [optional] +**Type** | Pointer to **String** | Action type | [optional] +**Description** | Pointer to **String** | Action Description | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the action accepts | [optional] +**ExampleOutput** | Pointer to [**WorkflowLibraryActionExampleOutput**](workflow-library-action-example-output) | | [optional] +**Deprecated** | Pointer to **Boolean** | | [optional] +**DeprecatedBy** | Pointer to **System.DateTime** | | [optional] +**VersionNumber** | Pointer to **Int32** | Version number | [optional] +**IsSimulationEnabled** | Pointer to **Boolean** | | [optional] +**IsDynamicSchema** | Pointer to **Boolean** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] [default to $false] +**OutputSchema** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Defines the output schema, if any, that this action produces. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowLibraryAction = Initialize-PSSailpoint.V2024WorkflowLibraryAction -Id sp:create-campaign ` + -Name Create Certification Campaign ` + -Type ACTION ` + -Description Generates a certification campaign. ` + -FormFields null ` + -ExampleOutput null ` + -Deprecated null ` + -DeprecatedBy null ` + -VersionNumber null ` + -IsSimulationEnabled null ` + -IsDynamicSchema false ` + -OutputSchema {definitions={}, properties={autoRevokeAllowed={$id=#sp:create-campaign/autoRevokeAllowed, default=true, examples=[false], title=autoRevokeAllowed, type=boolean}, deadline={$id=#sp:create-campaign/deadline, default=, examples=[2020-12-25T06:00:00.468Z], format=date-time, pattern=^.*$, title=deadline, type=string}, description={$id=#sp:create-campaign/description, default=, examples=[A review of everyone's access by their manager.], pattern=^.*$, title=description, type=string}, emailNotificationEnabled={$id=#sp:create-campaign/emailNotificationEnabled, default=true, examples=[false], title=emailNotificationEnabled, type=boolean}, filter={$id=#sp:create-campaign/filter, properties={id={$id=#sp:create-campaign/filter/id, default=, examples=[e0adaae69852e8fe8b8a3d48e5ce757c], pattern=^.*$, title=id, type=string}, type={$id=#sp:create-campaign/filter/type, default=, examples=[CAMPAIGN_FILTER], pattern=^.*$, title=type, type=string}}, title=filter, type=object}, id={$id=#sp:create-campaign/id, default=, examples=[2c918086719eec070171a7e3355a360a], pattern=^.*$, title=id, type=string}, name={$id=#sp:create-campaign/name, default=, examples=[Manager Review], pattern=^.*$, title=name, type=string}, recommendationsEnabled={$id=#sp:create-campaign/recommendationsEnabled, default=true, examples=[false], title=recommendationEnabled, type=boolean}, type={$id=#sp:create-campaign/type, default=, examples=[MANAGER], pattern=^.*$, title=type, type=string}}, title=sp:create-campaign, type=object} +``` + +- Convert the resource to JSON +```powershell +$WorkflowLibraryAction | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowLibraryActionExampleOutput.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowLibraryActionExampleOutput.md new file mode 100644 index 000000000..0e3835724 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowLibraryActionExampleOutput.md @@ -0,0 +1,34 @@ +--- +id: v2024-workflow-library-action-example-output +title: WorkflowLibraryActionExampleOutput +pagination_label: WorkflowLibraryActionExampleOutput +sidebar_label: WorkflowLibraryActionExampleOutput +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryActionExampleOutput', 'V2024WorkflowLibraryActionExampleOutput'] +slug: /tools/sdk/powershell/v2024/models/workflow-library-action-example-output +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryActionExampleOutput', 'V2024WorkflowLibraryActionExampleOutput'] +--- + + +# WorkflowLibraryActionExampleOutput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$WorkflowLibraryActionExampleOutput = Initialize-PSSailpoint.V2024WorkflowLibraryActionExampleOutput +``` + +- Convert the resource to JSON +```powershell +$WorkflowLibraryActionExampleOutput | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowLibraryFormFields.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowLibraryFormFields.md new file mode 100644 index 000000000..dd242e21f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowLibraryFormFields.md @@ -0,0 +1,45 @@ +--- +id: v2024-workflow-library-form-fields +title: WorkflowLibraryFormFields +pagination_label: WorkflowLibraryFormFields +sidebar_label: WorkflowLibraryFormFields +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryFormFields', 'V2024WorkflowLibraryFormFields'] +slug: /tools/sdk/powershell/v2024/models/workflow-library-form-fields +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryFormFields', 'V2024WorkflowLibraryFormFields'] +--- + + +# WorkflowLibraryFormFields + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **String** | Description of the form field | [optional] +**HelpText** | Pointer to **String** | Describes the form field in the UI | [optional] +**Label** | Pointer to **String** | A human readable name for this form field in the UI | [optional] +**Name** | Pointer to **String** | The name of the input attribute | [optional] +**Required** | Pointer to **Boolean** | Denotes if this field is a required attribute | [optional] [default to $false] +**Type** | Pointer to **Enum** [ "text", "textarea", "boolean", "email", "url", "number", "json", "checkbox", "jsonpath", "select", "multiType", "duration", "toggle", "formPicker", "identityPicker", "governanceGroupPicker", "string", "object", "array", "secret", "keyValuePairs", "emailPicker", "advancedToggle", "variableCreator", "htmlEditor" ] | The type of the form field | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowLibraryFormFields = Initialize-PSSailpoint.V2024WorkflowLibraryFormFields -Description First value to compare ` + -HelpText The name to give to this certification campaign. ` + -Label Campaign Name ` + -Name name ` + -Required false ` + -Type text +``` + +- Convert the resource to JSON +```powershell +$WorkflowLibraryFormFields | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowLibraryOperator.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowLibraryOperator.md new file mode 100644 index 000000000..18ab25dbe --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowLibraryOperator.md @@ -0,0 +1,51 @@ +--- +id: v2024-workflow-library-operator +title: WorkflowLibraryOperator +pagination_label: WorkflowLibraryOperator +sidebar_label: WorkflowLibraryOperator +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryOperator', 'V2024WorkflowLibraryOperator'] +slug: /tools/sdk/powershell/v2024/models/workflow-library-operator +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryOperator', 'V2024WorkflowLibraryOperator'] +--- + + +# WorkflowLibraryOperator + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Operator ID. | [optional] +**Name** | Pointer to **String** | Operator friendly name | [optional] +**Type** | Pointer to **String** | Operator type | [optional] +**Description** | Pointer to **String** | Description of the operator | [optional] +**IsDynamicSchema** | Pointer to **Boolean** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**Deprecated** | Pointer to **Boolean** | | [optional] +**DeprecatedBy** | Pointer to **System.DateTime** | | [optional] +**IsSimulationEnabled** | Pointer to **Boolean** | | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the operator accepts | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowLibraryOperator = Initialize-PSSailpoint.V2024WorkflowLibraryOperator -Id sp:compare-boolean ` + -Name Compare Boolean Values ` + -Type OPERATOR ` + -Description Compare two boolean values and decide what happens based on the result. ` + -IsDynamicSchema false ` + -Deprecated null ` + -DeprecatedBy null ` + -IsSimulationEnabled null ` + -FormFields [{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] +``` + +- Convert the resource to JSON +```powershell +$WorkflowLibraryOperator | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowLibraryTrigger.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowLibraryTrigger.md new file mode 100644 index 000000000..e89899e00 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowLibraryTrigger.md @@ -0,0 +1,55 @@ +--- +id: v2024-workflow-library-trigger +title: WorkflowLibraryTrigger +pagination_label: WorkflowLibraryTrigger +sidebar_label: WorkflowLibraryTrigger +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryTrigger', 'V2024WorkflowLibraryTrigger'] +slug: /tools/sdk/powershell/v2024/models/workflow-library-trigger +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryTrigger', 'V2024WorkflowLibraryTrigger'] +--- + + +# WorkflowLibraryTrigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Trigger ID. This is a static namespaced ID for the trigger. | [optional] +**Type** | Pointer to **Enum** [ "EVENT", "SCHEDULED", "EXTERNAL" ] | Trigger type | [optional] +**Deprecated** | Pointer to **Boolean** | | [optional] +**DeprecatedBy** | Pointer to **System.DateTime** | | [optional] +**IsSimulationEnabled** | Pointer to **Boolean** | | [optional] +**OutputSchema** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Example output schema | [optional] +**Name** | Pointer to **String** | Trigger Name | [optional] +**Description** | Pointer to **String** | Trigger Description | [optional] +**IsDynamicSchema** | Pointer to **Boolean** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] [default to $false] +**InputExample** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Example trigger payload if applicable | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the trigger accepts | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowLibraryTrigger = Initialize-PSSailpoint.V2024WorkflowLibraryTrigger -Id idn:identity-attributes-changed ` + -Type EVENT ` + -Deprecated null ` + -DeprecatedBy null ` + -IsSimulationEnabled null ` + -OutputSchema null ` + -Name Identity Attributes Changed ` + -Description One or more identity attributes changed. ` + -IsDynamicSchema false ` + -InputExample {changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} ` + -FormFields [] +``` + +- Convert the resource to JSON +```powershell +$WorkflowLibraryTrigger | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowModifiedBy.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowModifiedBy.md new file mode 100644 index 000000000..7d23a33d0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowModifiedBy.md @@ -0,0 +1,39 @@ +--- +id: v2024-workflow-modified-by +title: WorkflowModifiedBy +pagination_label: WorkflowModifiedBy +sidebar_label: WorkflowModifiedBy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowModifiedBy', 'V2024WorkflowModifiedBy'] +slug: /tools/sdk/powershell/v2024/models/workflow-modified-by +tags: ['SDK', 'Software Development Kit', 'WorkflowModifiedBy', 'V2024WorkflowModifiedBy'] +--- + + +# WorkflowModifiedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | | [optional] +**Id** | Pointer to **String** | Identity ID | [optional] +**Name** | Pointer to **String** | Human-readable display name of identity. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowModifiedBy = Initialize-PSSailpoint.V2024WorkflowModifiedBy -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Thomas Edison +``` + +- Convert the resource to JSON +```powershell +$WorkflowModifiedBy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowOAuthClient.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowOAuthClient.md new file mode 100644 index 000000000..215e163e4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowOAuthClient.md @@ -0,0 +1,39 @@ +--- +id: v2024-workflow-o-auth-client +title: WorkflowOAuthClient +pagination_label: WorkflowOAuthClient +sidebar_label: WorkflowOAuthClient +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowOAuthClient', 'V2024WorkflowOAuthClient'] +slug: /tools/sdk/powershell/v2024/models/workflow-o-auth-client +tags: ['SDK', 'Software Development Kit', 'WorkflowOAuthClient', 'V2024WorkflowOAuthClient'] +--- + + +# WorkflowOAuthClient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | OAuth client ID for the trigger. This is a UUID generated upon creation. | [optional] +**Secret** | Pointer to **String** | OAuthClient secret. | [optional] +**Url** | Pointer to **String** | URL for the external trigger to invoke | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowOAuthClient = Initialize-PSSailpoint.V2024WorkflowOAuthClient -Id 1a58c03a6bf64dc2876f6988c6e2c7b7 ` + -Secret 00cc24a7fe810fe06a7cb38bc168ae104d703c7abb296f9944dc68e69ddb578b ` + -Url https://tenant.api.identitynow.com/beta/workflows/execute/external/c17bea3a-574d-453c-9e04-4365fbf5af0b +``` + +- Convert the resource to JSON +```powershell +$WorkflowOAuthClient | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowTrigger.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowTrigger.md new file mode 100644 index 000000000..397012be4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowTrigger.md @@ -0,0 +1,39 @@ +--- +id: v2024-workflow-trigger +title: WorkflowTrigger +pagination_label: WorkflowTrigger +sidebar_label: WorkflowTrigger +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowTrigger', 'V2024WorkflowTrigger'] +slug: /tools/sdk/powershell/v2024/models/workflow-trigger +tags: ['SDK', 'Software Development Kit', 'WorkflowTrigger', 'V2024WorkflowTrigger'] +--- + + +# WorkflowTrigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "EVENT", "EXTERNAL", "SCHEDULED", "" ] | The trigger type | [required] +**DisplayName** | Pointer to **String** | | [optional] +**Attributes** | [**WorkflowTriggerAttributes**](workflow-trigger-attributes) | | [required] + +## Examples + +- Prepare the resource +```powershell +$WorkflowTrigger = Initialize-PSSailpoint.V2024WorkflowTrigger -Type EVENT ` + -DisplayName null ` + -Attributes null +``` + +- Convert the resource to JSON +```powershell +$WorkflowTrigger | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowTriggerAttributes.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowTriggerAttributes.md new file mode 100644 index 000000000..46ec07164 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkflowTriggerAttributes.md @@ -0,0 +1,57 @@ +--- +id: v2024-workflow-trigger-attributes +title: WorkflowTriggerAttributes +pagination_label: WorkflowTriggerAttributes +sidebar_label: WorkflowTriggerAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowTriggerAttributes', 'V2024WorkflowTriggerAttributes'] +slug: /tools/sdk/powershell/v2024/models/workflow-trigger-attributes +tags: ['SDK', 'Software Development Kit', 'WorkflowTriggerAttributes', 'V2024WorkflowTriggerAttributes'] +--- + + +# WorkflowTriggerAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the trigger | [required] +**VarFilter** | Pointer to **String** | JSON path expression that will limit which events the trigger will fire on | [optional] +**Description** | Pointer to **String** | Additonal context about the external trigger | [optional] +**AttributeToFilter** | Pointer to **String** | The attribute to filter on | [optional] +**Name** | Pointer to **String** | A unique name for the external trigger | [optional] +**ClientId** | Pointer to **String** | OAuth Client ID to authenticate with this trigger | [optional] +**Url** | Pointer to **String** | URL to invoke this workflow | [optional] +**CronString** | Pointer to **String** | A valid CRON expression | [optional] +**Frequency** | **Enum** [ "daily", "weekly", "monthly", "yearly", "cronSchedule" ] | Frequency of execution | [required] +**TimeZone** | Pointer to **String** | Time zone identifier | [optional] +**WeeklyDays** | Pointer to **[]String** | Scheduled days of the week for execution | [optional] +**WeeklyTimes** | Pointer to **[]String** | Scheduled execution times | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowTriggerAttributes = Initialize-PSSailpoint.V2024WorkflowTriggerAttributes -Id idn:identity-attributes-changed ` + -VarFilter $.changes[?(@.attribute == 'manager')] ` + -Description Run a search and notify the results ` + -AttributeToFilter LifecycleState ` + -Name search-and-notify ` + -ClientId 87e239b2-b85b-4bde-b9a7-55bf304ddcdc ` + -Url https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d ` + -CronString 0 9 * * 1 ` + -Frequency null ` + -TimeZone America/Chicago ` + -WeeklyDays Monday ` + -WeeklyTimes Monday +``` + +- Convert the resource to JSON +```powershell +$WorkflowTriggerAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkgroupBulkDeleteRequest.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkgroupBulkDeleteRequest.md new file mode 100644 index 000000000..124277caf --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkgroupBulkDeleteRequest.md @@ -0,0 +1,35 @@ +--- +id: v2024-workgroup-bulk-delete-request +title: WorkgroupBulkDeleteRequest +pagination_label: WorkgroupBulkDeleteRequest +sidebar_label: WorkgroupBulkDeleteRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkgroupBulkDeleteRequest', 'V2024WorkgroupBulkDeleteRequest'] +slug: /tools/sdk/powershell/v2024/models/workgroup-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'WorkgroupBulkDeleteRequest', 'V2024WorkgroupBulkDeleteRequest'] +--- + + +# WorkgroupBulkDeleteRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]String** | List of IDs of Governance Groups to be deleted. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkgroupBulkDeleteRequest = Initialize-PSSailpoint.V2024WorkgroupBulkDeleteRequest -Ids [567a697e-885b-495a-afc5-d55e1c23a302, c7b0f7b2-1e78-4063-b294-a555333dacd2] +``` + +- Convert the resource to JSON +```powershell +$WorkgroupBulkDeleteRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkgroupConnectionDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkgroupConnectionDto.md new file mode 100644 index 000000000..b1ad4211f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkgroupConnectionDto.md @@ -0,0 +1,37 @@ +--- +id: v2024-workgroup-connection-dto +title: WorkgroupConnectionDto +pagination_label: WorkgroupConnectionDto +sidebar_label: WorkgroupConnectionDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkgroupConnectionDto', 'V2024WorkgroupConnectionDto'] +slug: /tools/sdk/powershell/v2024/models/workgroup-connection-dto +tags: ['SDK', 'Software Development Kit', 'WorkgroupConnectionDto', 'V2024WorkgroupConnectionDto'] +--- + + +# WorkgroupConnectionDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Object** | Pointer to [**ConnectedObject**](connected-object) | | [optional] +**ConnectionType** | Pointer to **Enum** [ "AccessRequestReviewer", "Owner", "ManagementWorkgroup" ] | Connection Type. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkgroupConnectionDto = Initialize-PSSailpoint.V2024WorkgroupConnectionDto -Object null ` + -ConnectionType AccessRequestReviewer +``` + +- Convert the resource to JSON +```powershell +$WorkgroupConnectionDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkgroupDeleteItem.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkgroupDeleteItem.md new file mode 100644 index 000000000..5e4c85f75 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkgroupDeleteItem.md @@ -0,0 +1,45 @@ +--- +id: v2024-workgroup-delete-item +title: WorkgroupDeleteItem +pagination_label: WorkgroupDeleteItem +sidebar_label: WorkgroupDeleteItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkgroupDeleteItem', 'V2024WorkgroupDeleteItem'] +slug: /tools/sdk/powershell/v2024/models/workgroup-delete-item +tags: ['SDK', 'Software Development Kit', 'WorkgroupDeleteItem', 'V2024WorkgroupDeleteItem'] +--- + + +# WorkgroupDeleteItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Id of the Governance Group. | [required] +**Status** | **Int32** | The HTTP response status code returned for an individual Governance Group that is requested for deletion during a bulk delete operation. > 204 - Governance Group deleted successfully. > 409 - Governance Group is in use,hence can not be deleted. > 404 - Governance Group not found. | [required] +**Description** | Pointer to **String** | Human readable status description and containing additional context information about success or failures etc. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkgroupDeleteItem = Initialize-PSSailpoint.V2024WorkgroupDeleteItem -Id 464ae7bf791e49fdb74606a2e4a89635 ` + -Status 204 ` + -Description +> Governance Group deleted successfully. + +> Unable to delete Governance Group f80bba83-98c4-4ec2-81c8-373c00e9663b because it is in use. + +> Referenced Governance Group 2b711763-ed35-42a2-a80c-8f1ce0dc4a7f was not found. + +``` + +- Convert the resource to JSON +```powershell +$WorkgroupDeleteItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkgroupDto.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkgroupDto.md new file mode 100644 index 000000000..19ef0e165 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkgroupDto.md @@ -0,0 +1,49 @@ +--- +id: v2024-workgroup-dto +title: WorkgroupDto +pagination_label: WorkgroupDto +sidebar_label: WorkgroupDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkgroupDto', 'V2024WorkgroupDto'] +slug: /tools/sdk/powershell/v2024/models/workgroup-dto +tags: ['SDK', 'Software Development Kit', 'WorkgroupDto', 'V2024WorkgroupDto'] +--- + + +# WorkgroupDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Owner** | Pointer to [**WorkgroupDtoOwner**](workgroup-dto-owner) | | [optional] +**Id** | Pointer to **String** | Governance group ID. | [optional] [readonly] +**Name** | Pointer to **String** | Governance group name. | [optional] +**Description** | Pointer to **String** | Governance group description. | [optional] +**MemberCount** | Pointer to **Int64** | Number of members in the governance group. | [optional] [readonly] +**ConnectionCount** | Pointer to **Int64** | Number of connections in the governance group. | [optional] [readonly] +**Created** | Pointer to **System.DateTime** | | [optional] +**Modified** | Pointer to **System.DateTime** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkgroupDto = Initialize-PSSailpoint.V2024WorkgroupDto -Owner null ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name DB Access Governance Group ` + -Description Description of the Governance Group ` + -MemberCount 1641498673000 ` + -ConnectionCount 1641498673000 ` + -Created 2022-01-06T19:51:13Z ` + -Modified 2022-01-06T19:51:13Z +``` + +- Convert the resource to JSON +```powershell +$WorkgroupDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkgroupDtoOwner.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkgroupDtoOwner.md new file mode 100644 index 000000000..5c8f696b7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkgroupDtoOwner.md @@ -0,0 +1,43 @@ +--- +id: v2024-workgroup-dto-owner +title: WorkgroupDtoOwner +pagination_label: WorkgroupDtoOwner +sidebar_label: WorkgroupDtoOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkgroupDtoOwner', 'V2024WorkgroupDtoOwner'] +slug: /tools/sdk/powershell/v2024/models/workgroup-dto-owner +tags: ['SDK', 'Software Development Kit', 'WorkgroupDtoOwner', 'V2024WorkgroupDtoOwner'] +--- + + +# WorkgroupDtoOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Owner's DTO type. | [optional] +**Id** | Pointer to **String** | Owner's identity ID. | [optional] +**Name** | Pointer to **String** | Owner's name. | [optional] +**DisplayName** | Pointer to **String** | The display name of the identity | [optional] [readonly] +**EmailAddress** | Pointer to **String** | The primary email address of the identity | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$WorkgroupDtoOwner = Initialize-PSSailpoint.V2024WorkgroupDtoOwner -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Support ` + -DisplayName Support ` + -EmailAddress support@sailpoint.com +``` + +- Convert the resource to JSON +```powershell +$WorkgroupDtoOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkgroupMemberAddItem.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkgroupMemberAddItem.md new file mode 100644 index 000000000..df8e2385c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkgroupMemberAddItem.md @@ -0,0 +1,43 @@ +--- +id: v2024-workgroup-member-add-item +title: WorkgroupMemberAddItem +pagination_label: WorkgroupMemberAddItem +sidebar_label: WorkgroupMemberAddItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkgroupMemberAddItem', 'V2024WorkgroupMemberAddItem'] +slug: /tools/sdk/powershell/v2024/models/workgroup-member-add-item +tags: ['SDK', 'Software Development Kit', 'WorkgroupMemberAddItem', 'V2024WorkgroupMemberAddItem'] +--- + + +# WorkgroupMemberAddItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Identifier of identity in bulk member add request. | [required] +**Status** | **Int32** | The HTTP response status code returned for an individual member that is requested for addition during a bulk add operation. The HTTP response status code returned for an individual Governance Group is requested for deletion. > 201 - Identity is added into Governance Group members list. > 409 - Identity is already member of Governance Group. | [required] +**Description** | Pointer to **String** | Human readable status description and containing additional context information about success or failures etc. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkgroupMemberAddItem = Initialize-PSSailpoint.V2024WorkgroupMemberAddItem -Id 464ae7bf791e49fdb74606a2e4a89635 ` + -Status 201 ` + -Description +> Identity is added into Governance Group members list. + +> Unable to set Membership of Identity "3244d5f2d04447498520f54c6789ae33" to Governance Group "f80bba83-98c4-4ec2-81c8-373c00e9663b"; the relationship already exists. + +``` + +- Convert the resource to JSON +```powershell +$WorkgroupMemberAddItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkgroupMemberDeleteItem.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkgroupMemberDeleteItem.md new file mode 100644 index 000000000..ecd84a31e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/WorkgroupMemberDeleteItem.md @@ -0,0 +1,43 @@ +--- +id: v2024-workgroup-member-delete-item +title: WorkgroupMemberDeleteItem +pagination_label: WorkgroupMemberDeleteItem +sidebar_label: WorkgroupMemberDeleteItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkgroupMemberDeleteItem', 'V2024WorkgroupMemberDeleteItem'] +slug: /tools/sdk/powershell/v2024/models/workgroup-member-delete-item +tags: ['SDK', 'Software Development Kit', 'WorkgroupMemberDeleteItem', 'V2024WorkgroupMemberDeleteItem'] +--- + + +# WorkgroupMemberDeleteItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Identifier of identity in bulk member add /remove request. | [required] +**Status** | **Int32** | The HTTP response status code returned for an individual member that is requested for deletion during a bulk delete operation. > 204 - Identity is removed from Governance Group members list. > 404 - Identity is not member of Governance Group. | [required] +**Description** | Pointer to **String** | Human readable status description and containing additional context information about success or failures etc. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkgroupMemberDeleteItem = Initialize-PSSailpoint.V2024WorkgroupMemberDeleteItem -Id 464ae7bf791e49fdb74606a2e4a89635 ` + -Status 204 ` + -Description +> Identity deleted from Governance Group members list. + +> Referenced Governance Group Member with Identity Id "bc3a744678534eb78a8002ee2085df64" was not found. + +``` + +- Convert the resource to JSON +```powershell +$WorkgroupMemberDeleteItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/docs/Models/indices.md b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/indices.md new file mode 100644 index 000000000..aaec40139 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/docs/Models/indices.md @@ -0,0 +1,34 @@ +--- +id: v2024-index +title: Index +pagination_label: Index +sidebar_label: Index +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Index', 'V2024Index'] +slug: /tools/sdk/powershell/v2024/models/index +tags: ['SDK', 'Software Development Kit', 'Index', 'V2024Index'] +--- + + +# Index + +## Enum + + +* `accessprofiles` (value: `"accessprofiles"`) + +* `accountactivities` (value: `"accountactivities"`) + +* `entitlements` (value: `"entitlements"`) + +* `events` (value: `"events"`) + +* `identities` (value: `"identities"`) + +* `roles` (value: `"roles"`) + +* `STAR` (value: `"*"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Examples/code_examples_overlay.yaml b/docs/tools/sdk/powershell/Reference/V3/docs/Examples/code_examples_overlay.yaml new file mode 100644 index 000000000..2cdc18afd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Examples/code_examples_overlay.yaml @@ -0,0 +1,10081 @@ +- path: /access-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessProfile = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "description" : "Collection of entitlements to read/write the employee database", + "source" : { + "name" : "ODS-AD-SOURCE", + "id" : "2c91809773dee3610173fdb0b6061ef4", + "type" : "SOURCE" + }, + "enabled" : true, + "revocationRequestConfig" : { + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ] + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "accessRequestConfig" : { + "commentsRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "name" : "Employee-database-read-write", + "provisioningCriteria" : { + "children" : [ { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, + "modified" : "2021-03-02T20:22:28.104Z", + "id" : "2c91808a7190d06e01719938fcd20792", + "requestable" : true + } + "@ + + # Create Access Profile + + try { + $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile + New-AccessProfile-AccessProfile $Result + + # Below is a request that includes all optional parameters + # New-AccessProfile -AccessProfile $AccessProfile + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete + + # Delete the specified Access Profile + + try { + Remove-AccessProfile-Id $Id + + # Below is a request that includes all optional parameters + # Remove-AccessProfile -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessProfileBulkDeleteRequest = @" + { + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + } + "@ + + # Delete Access Profile(s) + + try { + $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest + Remove-AccessProfilesInBulk-AccessProfileBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-AccessProfilesInBulk -AccessProfileBulkDeleteRequest $AccessProfileBulkDeleteRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-AccessProfilesInBulk" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile + + # Get an Access Profile + + try { + Get-AccessProfile-Id $Id + + # Below is a request that includes all optional parameters + # Get-AccessProfile -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + + # List Access Profile's Entitlements + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessProfileEntitlements" + Write-Host $_.ErrorDetails + } +- path: /access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin. (optional) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Composite operators supported: *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + + # List Access Profiles + + try { + Get-AccessProfiles + + # Below is a request that includes all optional parameters + # Get-AccessProfiles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessProfiles" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Access Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AccessProfile-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AccessProfile -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + } + "@ + + # Approve Access Request Approval + + try { + Approve-AccessRequest-ApprovalId $ApprovalId + + # Below is a request that includes all optional parameters + # Approve-AccessRequest -ApprovalId $ApprovalId -CommentDto $CommentDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $ForwardApprovalDto = @" + { + "newOwnerId" : "2c91808568c529c60168cca6f90c1314", + "comment" : "2c91808568c529c60168cca6f90c1313" + } + "@ + + # Forward Access Request Approval + + try { + $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto + Invoke-ForwardAccessRequest-ApprovalId $ApprovalId -ForwardApprovalDto $Result + + # Below is a request that includes all optional parameters + # Invoke-ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $ForwardApprovalDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ForwardAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/approval-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + + # Get Access Requests Approvals Number + + try { + Get-AccessRequestApprovalSummary + + # Below is a request that includes all optional parameters + # Get-AccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessRequestApprovalSummary" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) + $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Completed Access Request Approvals List + + try { + Get-CompletedApprovals + + # Below is a request that includes all optional parameters + # Get-CompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedApprovals" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/pending + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional) + $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Pending Access Request Approvals List + + try { + Get-PendingApprovals + + # Below is a request that includes all optional parameters + # Get-PendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PendingApprovals" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/reject + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + } + "@ + + # Reject Access Request Approval + + try { + $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto + Deny-AccessRequest-ApprovalId $ApprovalId -CommentDto $Result + + # Below is a request that includes all optional parameters + # Deny-AccessRequest -ApprovalId $ApprovalId -CommentDto $CommentDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-requests/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CancelAccessRequest = @" + { + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + } + "@ + + # Cancel Access Request + + try { + $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest + Suspend-AccessRequest-CancelAccessRequest $Result + + # Below is a request that includes all optional parameters + # Suspend-AccessRequest -CancelAccessRequest $CancelAccessRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessRequest = @" + { + "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + } ] + } + "@ + + # Submit Access Request + + try { + $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest + New-AccessRequest-AccessRequest $Result + + # Below is a request that includes all optional parameters + # New-AccessRequest -AccessRequest $AccessRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Access Request Configuration + + try { + Get-AccessRequestConfig + + # Below is a request that includes all optional parameters + # Get-AccessRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /access-request-status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) + $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) + $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + $Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) + $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + # Access Request Status + + try { + Get-AccessRequestStatus + + # Below is a request that includes all optional parameters + # Get-AccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessRequestStatus" + Write-Host $_.ErrorDetails + } +- path: /access-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessRequestConfig = @" + { + "requestOnBehalfOfConfig" : { + "allowRequestOnBehalfOfEmployeeByManager" : true, + "allowRequestOnBehalfOfAnyoneByAnyone" : true + }, + "approvalReminderAndEscalationConfig" : { + "fallbackApproverRef" : { + "name" : "Alison Ferguso", + "id" : "5168015d32f890ca15812c9180835d2e", + "type" : "IDENTITY", + "email" : "alison.ferguso@identitysoon.com" + }, + "maxReminders" : 1, + "daysUntilEscalation" : 0, + "daysBetweenReminders" : 0 + }, + "autoApprovalEnabled" : true, + "entitlementRequestConfig" : { + "requestCommentsRequired" : false, + "deniedCommentsRequired" : false, + "allowEntitlementRequest" : true, + "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + }, + "reauthorizationEnabled" : true, + "approvalsMustBeExternal" : true + } + "@ + + # Update Access Request Configuration + + try { + $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig + Set-AccessRequestConfig-AccessRequestConfig $Result + + # Below is a request that includes all optional parameters + # Set-AccessRequestConfig -AccessRequestConfig $AccessRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-AccessRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /account-activities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id + + # Get an Account Activity + + try { + Get-AccountActivity-Id $Id + + # Below is a request that includes all optional parameters + # Get-AccountActivity -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountActivity" + Write-Host $_.ErrorDetails + } +- path: /account-activities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "2c91808568c529c60168cca6f90c1313" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c91808568c529c60168cca6f90c1313" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c91808568c529c60168cca6f90c1313" # String | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "type eq "Identity Refresh"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) + + # List Account Activities + + try { + Get-AccountActivities + + # Below is a request that includes all optional parameters + # Get-AccountActivities -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountActivities" + Write-Host $_.ErrorDetails + } +- path: /accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccountAttributesCreate = @" + { + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Create Account + + try { + $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate + New-Account-AccountAttributesCreate $Result + + # Below is a request that includes all optional parameters + # New-Account -AccountAttributesCreate $AccountAttributesCreate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Delete Account + + try { + Remove-Account-Id $Id + + # Below is a request that includes all optional parameters + # Remove-Account -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Disable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Disable-Account-Id $Id -AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Disable-Account -Id $Id -AccountToggleRequest $AccountToggleRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Enable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Enable-Account-Id $Id -AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Enable-Account -Id $Id -AccountToggleRequest $AccountToggleRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Account Details + + try { + Get-Account-Id $Id + + # Below is a request that includes all optional parameters + # Get-Account -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Account Entitlements + + try { + Get-AccountEntitlements-Id $Id + + # Below is a request that includes all optional parameters + # Get-AccountEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountEntitlements" + Write-Host $_.ErrorDetails + } +- path: /accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) + $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + + # Accounts List + + try { + Get-Accounts + + # Below is a request that includes all optional parameters + # Get-Accounts -Limit $Limit -Offset $Offset -Count $Count -DetailLevel $DetailLevel -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Accounts" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $AccountAttributes = @" + { + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Update Account + + try { + $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes + Send-Account-Id $Id -AccountAttributes $Result + + # Below is a request that includes all optional parameters + # Send-Account -Id $Id -AccountAttributes $AccountAttributes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/reload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + + # Reload Account + + try { + Submit-ReloadAccount-Id $Id + + # Below is a request that includes all optional parameters + # Submit-ReloadAccount -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-ReloadAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/unlock + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. + $AccountUnlockRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + } + "@ + + # Unlock Account + + try { + $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest + Unlock-Account-Id $Id -AccountUnlockRequest $Result + + # Below is a request that includes all optional parameters + # Unlock-Account -Id $Id -AccountUnlockRequest $AccountUnlockRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"[{op=remove, path=/identityId}]"@ + + + # Update Account + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-Account-Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-Account -Id $Id -RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Account" + Write-Host $_.ErrorDetails + } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesByAccountId" + Write-Host $_.ErrorDetails + } +- path: /discovered-applications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) + $Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) + + # Get Discovered Applications for Tenant + + try { + Get-DiscoveredApplications + + # Below is a request that includes all optional parameters + # Get-DiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DiscoveredApplications" + Write-Host $_.ErrorDetails + } +- path: /manual-discover-applications-template + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Download CSV Template for Discovery + + try { + Get-ManualDiscoverApplicationsCsvTemplate + + # Below is a request that includes all optional parameters + # Get-ManualDiscoverApplicationsCsvTemplate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } +- path: /manual-discover-applications + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + + # Upload CSV to Discover Applications + + try { + Send-ManualDiscoverApplicationsCsvTemplate-File $File + + # Below is a request that includes all optional parameters + # Send-ManualDiscoverApplicationsCsvTemplate -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } +- path: /auth-users/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + + # Auth User Details + + try { + Get-AuthUser-Id $Id + + # Below is a request that includes all optional parameters + # Get-AuthUser -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthUser" + Write-Host $_.ErrorDetails + } +- path: /auth-users/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Auth User Update + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthUser-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthUser -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthUser" + Write-Host $_.ErrorDetails + } +- path: /brandings + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "MyName" # String | name of branding item + $ProductName = "MyProductName" # String | product name + $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) + $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) + $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) + $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) + $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) + $FileStandard = # System.IO.FileInfo | png file with logo (optional) + + # Create a branding item + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BrandingItem" + Write-Host $_.ErrorDetails + } +- path: /brandings/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "default" # String | The name of the branding item to be deleted + + # Delete a branding item + + try { + Remove-Branding-Name $Name + + # Below is a request that includes all optional parameters + # Remove-Branding -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Branding" + Write-Host $_.ErrorDetails + } +- path: /brandings/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "default" # String | The name of the branding item to be retrieved + + # Get a branding item + + try { + Get-Branding-Name $Name + + # Below is a request that includes all optional parameters + # Get-Branding -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Branding" + Write-Host $_.ErrorDetails + } +- path: /brandings + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List of branding items + + try { + Get-BrandingList + + # Below is a request that includes all optional parameters + # Get-BrandingList + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BrandingList" + Write-Host $_.ErrorDetails + } +- path: /brandings/{name} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "default" # String | The name of the branding item to be retrieved + $Name2 = "Name_example" # String | name of branding item + $ProductName = "MyProductName" # String | product name + $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) + $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) + $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) + $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) + $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) + $FileStandard = # System.IO.FileInfo | png file with logo (optional) + + # Update a branding item + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BrandingItem" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CampaignFilterDetails = @" + { + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + } + "@ + + # Create Campaign Filter + + try { + $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails + New-CampaignFilter-CampaignFilterDetails $Result + + # Below is a request that includes all optional parameters + # New-CampaignFilter -CampaignFilterDetails $CampaignFilterDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CampaignFilter" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters/delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filters to delete. + $RequestBody = @""@ + + + # Deletes Campaign Filters + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-CampaignFilters-RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-CampaignFilters -RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignFilters" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved. + + # Get Campaign Filter by ID + + try { + Get-CampaignFilterById-Id $Id + + # Below is a request that includes all optional parameters + # Get-CampaignFilterById -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignFilterById" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Start = 0 # Int32 | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $IncludeSystemFilters = $true # Boolean | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to $true) + + # List Campaign Filters + + try { + Get-CampaignFilters + + # Below is a request that includes all optional parameters + # Get-CampaignFilters -Limit $Limit -Start $Start -IncludeSystemFilters $IncludeSystemFilters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignFilters" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FilterId = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter being modified. + $CampaignFilterDetails = @" + { + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + } + "@ + + # Updates a Campaign Filter + + try { + $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails + Update-CampaignFilter-FilterId $FilterId -CampaignFilterDetails $Result + + # Below is a request that includes all optional parameters + # Update-CampaignFilter -FilterId $FilterId -CampaignFilterDetails $CampaignFilterDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-CampaignFilter" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/complete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $CampaignCompleteOptions = @" + { + "autoCompleteAction" : "REVOKE" + } + "@ + + # Complete a Campaign + + try { + Complete-Campaign-Id $Id + + # Below is a request that includes all optional parameters + # Complete-Campaign -Id $Id -CampaignCompleteOptions $CampaignCompleteOptions + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Campaign = @" + { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + } + "@ + + # Create a campaign + + try { + $Result = ConvertFrom-JsonToCampaign -Json $Campaign + New-Campaign-Campaign $Result + + # Below is a request that includes all optional parameters + # New-Campaign -Campaign $Campaign + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CampaignTemplate = @" + { + "ownerRef" : { + "name" : "Mister Manager", + "id" : "2c918086676d3e0601677611dbde220f", + "type" : "IDENTITY", + "email" : "mr.manager@example.com" + }, + "deadlineDuration" : "P2W", + "created" : "2020-03-05T22:44:00.364Z", + "scheduled" : false, + "name" : "Manager Campaign Template", + "description" : "Template for the annual manager campaign.", + "modified" : "2020-03-05T22:52:09.969Z", + "campaign" : { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }, + "id" : "2c9079b270a266a60170a277bb960008" + } + "@ + + # Create a Campaign Template + + try { + $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate + New-CampaignTemplate-CampaignTemplate $Result + + # Below is a request that includes all optional parameters + # New-CampaignTemplate -CampaignTemplate $CampaignTemplate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. + + # Delete a Campaign Template + + try { + Remove-CampaignTemplate-Id $Id + + # Below is a request that includes all optional parameters + # Remove-CampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. + + # Delete Campaign Template Schedule + + try { + Remove-CampaignTemplateSchedule-Id $Id + + # Below is a request that includes all optional parameters + # Remove-CampaignTemplateSchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaigns/delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CampaignsDeleteRequest = @" + { + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + } + "@ + + # Delete Campaigns + + try { + $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest + Remove-Campaigns-CampaignsDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-Campaigns -CampaignsDeleteRequest $CampaignsDeleteRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Campaigns" + Write-Host $_.ErrorDetails + } +- path: /campaigns + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Manager Campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) + + # List Campaigns + + try { + Get-ActiveCampaigns + + # Below is a request that includes all optional parameters + # Get-ActiveCampaigns -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ActiveCampaigns" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + + # Get Campaign + + try { + Get-Campaign-Id $Id + + # Below is a request that includes all optional parameters + # Get-Campaign -Id $Id -Detail $Detail + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/reports + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. + + # Get Campaign Reports + + try { + Get-CampaignReports-Id $Id + + # Below is a request that includes all optional parameters + # Get-CampaignReports -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignReports" + Write-Host $_.ErrorDetails + } +- path: /campaigns/reports-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Campaign Reports Configuration + + try { + Get-CampaignReportsConfig + + # Below is a request that includes all optional parameters + # Get-CampaignReportsConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignReportsConfig" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. + + # Get a Campaign Template + + try { + Get-CampaignTemplate-Id $Id + + # Below is a request that includes all optional parameters + # Get-CampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. + + # Get Campaign Template Schedule + + try { + Get-CampaignTemplateSchedule-Id $Id + + # Below is a request that includes all optional parameters + # Get-CampaignTemplateSchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $Filters = "name eq "manager template"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + + # List Campaign Templates + + try { + Get-CampaignTemplates + + # Below is a request that includes all optional parameters + # Get-CampaignTemplates -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplates" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/reassign + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID + $AdminReviewReassign = @" + { + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } + } + "@ + + # Reassign Certifications + + try { + $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign + Move--Id $Id -AdminReviewReassign $Result + + # Below is a request that includes all optional parameters + # Move- -Id $Id -AdminReviewReassign $AdminReviewReassign + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update a Campaign Template + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-CampaignTemplate-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-CampaignTemplate -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaigns/reports-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CampaignReportsConfig = @" + { + "identityAttributeColumns" : [ "firstname", "lastname" ] + } + "@ + + # Set Campaign Reports Configuration + + try { + $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig + Set-CampaignReportsConfig-CampaignReportsConfig $Result + + # Below is a request that includes all optional parameters + # Set-CampaignReportsConfig -CampaignReportsConfig $CampaignReportsConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-CampaignReportsConfig" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template being scheduled. + $Schedule = @" + { + "hours" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "months" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "timeZoneId" : "CST", + "days" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "expiration" : "2000-01-23T04:56:07.000+00:00", + "type" : "WEEKLY" + } + "@ + + # Set Campaign Template Schedule + + try { + Set-CampaignTemplateSchedule-Id $Id + + # Below is a request that includes all optional parameters + # Set-CampaignTemplateSchedule -Id $Id -Schedule $Schedule + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/activate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $ActivateCampaignOptions = @" + { + "timeZone" : "-05:00" + } + "@ + + # Activate a Campaign + + try { + Start-Campaign-Id $Id + + # Below is a request that includes all optional parameters + # Start-Campaign -Id $Id -ActivateCampaignOptions $ActivateCampaignOptions + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/run-remediation-scan + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. + + # Run Campaign Remediation Scan + + try { + Start-CampaignRemediationScan-Id $Id + + # Below is a request that includes all optional parameters + # Start-CampaignRemediationScan -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-CampaignRemediationScan" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/run-report/{type} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. + $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run. + + # Run Campaign Report + + try { + Start-CampaignReport-Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Start-CampaignReport -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-CampaignReport" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/generate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. + + # Generate a Campaign from Template + + try { + Start-GenerateCampaignTemplate-Id $Id + + # Below is a request that includes all optional parameters + # Start-GenerateCampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-GenerateCampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update a Campaign + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Campaign-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-Campaign -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Campaign" + Write-Host $_.ErrorDetails + } +- path: /certification-tasks/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID + + # Certification Task by ID + + try { + Get-CertificationTask-Id $Id + + # Below is a request that includes all optional parameters + # Get-CertificationTask -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CertificationTask" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id + + # Identity Certification by ID + + try { + Get-IdentityCertification-Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentityCertification -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityCertification" + Write-Host $_.ErrorDetails + } +- path: /certifications/{certificationId}/access-review-items/{itemId}/permissions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID + $Filters = "target eq "SYS.OBJAUTH2"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Permissions for Entitlement Certification Item + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityCertificationItemPermissions" + Write-Host $_.ErrorDetails + } +- path: /certification-tasks + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReviewerIdentity = "Ada.1de82e55078344" # String | The ID of reviewer identity. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "type eq "ADMIN_REASSIGN"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) + + # List of Pending Certification Tasks + + try { + Get-PendingCertificationTasks + + # Below is a request that includes all optional parameters + # Get-PendingCertificationTasks -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PendingCertificationTasks" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reviewers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) + + # List of Reviewers for certification + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CertificationReviewers" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/access-review-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name,-accessProfile.sourceName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) + $Entitlements = "identityEntitlement" # String | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) + $AccessProfiles = "accessProfile1" # String | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) + $Roles = "userRole" # String | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) + + # List of Access Review Items + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessReviewItems" + Write-Host $_.ErrorDetails + } +- path: /certifications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReviewerIdentity = "me" # String | Reviewer's identity. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) + $Sorters = "name,due" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) + + # List Identity Campaign Certifications + + try { + Get-IdentityCertifications + + # Below is a request that includes all optional parameters + # Get-IdentityCertifications -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityCertifications" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decide + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campaign certification on which to make decisions + $ReviewDecision = @"{ + "comments" : "This user no longer needs access to this source", + "decision" : "APPROVE", + "proposedEndDate" : "2017-07-11T18:45:37.098Z", + "recommendation" : { + "reasons" : [ "Reason 1", "Reason 2" ], + "recommendation" : "recommendation", + "timestamp" : "2020-06-01T13:49:37.385Z" + }, + "id" : "ef38f94347e94562b5bb8424a56397d8", + "bulk" : true + }"@ + + + # Decide on a Certification Item + + try { + $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision + Select-IdentityDecision-Id $Id -ReviewDecision $Result + + # Below is a request that includes all optional parameters + # Select-IdentityDecision -Id $Id -ReviewDecision $ReviewDecision + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-IdentityDecision" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reassign + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $ReviewReassign = @" + { + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + } + "@ + + # Reassign Identities or Items + + try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Invoke-ReassignIdentityCertifications-Id $Id -ReviewReassign $Result + + # Below is a request that includes all optional parameters + # Invoke-ReassignIdentityCertifications -Id $Id -ReviewReassign $ReviewReassign + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ReassignIdentityCertifications" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/sign-off + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + + # Finalize Identity Certification Decisions + + try { + Invoke-SignOffIdentityCertification-Id $Id + + # Below is a request that includes all optional parameters + # Invoke-SignOffIdentityCertification -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-SignOffIdentityCertification" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reassign-async + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $ReviewReassign = @" + { + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + } + "@ + + # Reassign Certifications Asynchronously + + try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Submit-ReassignCertsAsync-Id $Id -ReviewReassign $Result + + # Below is a request that includes all optional parameters + # Submit-ReassignCertsAsync -Id $Id -ReviewReassign $ReviewReassign + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-ReassignCertsAsync" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + + # Access Summaries + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-IdentityDecisionSummary-Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentityDecisionSummary -Id $Id -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Identity Summaries for Campaign Certification + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-IdentitySummary-Id $Id -IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummary" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingRequest = @" + { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } + "@ + + # Creates an object mapping + + try { + $Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest + New-ObjectMapping-SourceOrg $SourceOrg -ObjectMappingRequest $Result + + # Below is a request that includes all optional parameters + # New-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $ObjectMappingRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ObjectMapping" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-create + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingBulkCreateRequest = @" + { + "newObjectsMappings" : [ { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + }, { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } ] + } + "@ + + # Bulk creates object mappings + + try { + $Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest + New-ObjectMappings-SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result + + # Below is a request that includes all optional parameters + # New-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $ObjectMappingBulkCreateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ObjectMappings" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Name = "MyName" # String | Name that will be assigned to the uploaded configuration file. + + # Upload a Configuration + + try { + New-UploadedConfiguration-Data $Data -Name $Name + + # Below is a request that includes all optional parameters + # New-UploadedConfiguration -Data $Data -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-UploadedConfiguration" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of the object mapping to be deleted. + + # Deletes an object mapping + + try { + Remove-ObjectMapping-SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId + + # Below is a request that includes all optional parameters + # Remove-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ObjectMapping" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. + + # Delete an Uploaded Configuration + + try { + Remove-UploadedConfiguration-Id $Id + + # Below is a request that includes all optional parameters + # Remove-UploadedConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-UploadedConfiguration" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceOrg = "source-org" # String | The name of the source org. + + # Gets list of object mappings + + try { + Get-ObjectMappings-SourceOrg $SourceOrg + + # Below is a request that includes all optional parameters + # Get-ObjectMappings -SourceOrg $SourceOrg + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ObjectMappings" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. + + # Get an Uploaded Configuration + + try { + Get-UploadedConfiguration-Id $Id + + # Below is a request that includes all optional parameters + # Get-UploadedConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UploadedConfiguration" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) + + # List Uploaded Configurations + + try { + Get-UploadedConfigurations + + # Below is a request that includes all optional parameters + # Get-UploadedConfigurations -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UploadedConfigurations" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingBulkPatchRequest = @" + { + "patches" : { + "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : true + } ], + "00bece34-f50d-4227-8878-76f620b5a971" : [ { + "op" : "replace", + "path" : "/targetValue", + "value" : "New Target Value" + } ] + } + } + "@ + + # Bulk updates object mappings + + try { + $Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest + Update-ObjectMappings-SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result + + # Below is a request that includes all optional parameters + # Update-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $ObjectMappingBulkPatchRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ObjectMappings" + Write-Host $_.ErrorDetails + } +- path: /connectors + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $V3CreateConnectorDto = @" + { + "name" : "custom connector", + "directConnect" : true, + "className" : "sailpoint.connector.OpenConnectorAdapter", + "type" : "custom connector type", + "status" : "RELEASED" + } + "@ + + # Create Custom Connector + + try { + $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto + New-CustomConnector-V3CreateConnectorDto $Result + + # Below is a request that includes all optional parameters + # New-CustomConnector -V3CreateConnectorDto $V3CreateConnectorDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CustomConnector" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + # Delete Connector by Script Name + + try { + Remove-CustomConnector-ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Remove-CustomConnector -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CustomConnector" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Get Connector by Script Name + + try { + Get-Connector-ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-Connector -ScriptName $ScriptName -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Connector" + Write-Host $_.ErrorDetails + } +- path: /connectors + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "directConnect eq "true"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Get Connector List + + try { + Get-ConnectorList + + # Below is a request that includes all optional parameters + # Get-ConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorList" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + # Get Connector Source Configuration + + try { + Get-ConnectorSourceConfig-ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-ConnectorSourceConfig -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorSourceConfig" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-template + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + # Get Connector Source Template + + try { + Get-ConnectorSourceTemplate-ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-ConnectorSourceTemplate -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorSourceTemplate" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/translations/{locale} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + + # Get Connector Translations + + try { + Get-ConnectorTranslations-ScriptName $ScriptName -Locale $Locale + + # Below is a request that includes all optional parameters + # Get-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorTranslations" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $File = # System.IO.FileInfo | connector source config xml file + + # Update Connector Source Configuration + + try { + Send-ConnectorSourceConfig-ScriptName $ScriptName -File $File + + # Below is a request that includes all optional parameters + # Send-ConnectorSourceConfig -ScriptName $ScriptName -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorSourceConfig" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-template + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $File = # System.IO.FileInfo | connector source template xml file + + # Update Connector Source Template + + try { + Send-ConnectorSourceTemplate-ScriptName $ScriptName -File $File + + # Below is a request that includes all optional parameters + # Send-ConnectorSourceTemplate -ScriptName $ScriptName -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorSourceTemplate" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/translations/{locale} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + + # Update Connector Translations + + try { + Send-ConnectorTranslations-ScriptName $ScriptName -Locale $Locale + + # Below is a request that includes all optional parameters + # Send-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorTranslations" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Connector by Script Name + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Connector-ScriptName $ScriptName -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-Connector -ScriptName $ScriptName -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Connector" + Write-Host $_.ErrorDetails + } +- path: /auth-org/network-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $NetworkConfiguration = @" + { + "range" : [ "1.3.7.2", "255.255.255.252/30" ], + "whitelisted" : true, + "geolocation" : [ "CA", "FR", "HT" ] + } + "@ + + # Create security network configuration. + + try { + $Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration + New-AuthOrgNetworkConfig-NetworkConfiguration $Result + + # Below is a request that includes all optional parameters + # New-AuthOrgNetworkConfig -NetworkConfiguration $NetworkConfiguration + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/lockout-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Auth Org Lockout Configuration. + + try { + Get-AuthOrgLockoutConfig + + # Below is a request that includes all optional parameters + # Get-AuthOrgLockoutConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/network-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get security network configuration. + + try { + Get-AuthOrgNetworkConfig + + # Below is a request that includes all optional parameters + # Get-AuthOrgNetworkConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/service-provider-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Service Provider Configuration. + + try { + Get-AuthOrgServiceProviderConfig + + # Below is a request that includes all optional parameters + # Get-AuthOrgServiceProviderConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/session-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Auth Org Session Configuration. + + try { + Get-AuthOrgSessionConfig + + # Below is a request that includes all optional parameters + # Get-AuthOrgSessionConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgSessionConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/lockout-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Auth Org Lockout Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthOrgLockoutConfig-JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthOrgLockoutConfig -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/network-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update security network configuration. + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthOrgNetworkConfig-JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthOrgNetworkConfig -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/service-provider-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Service Provider Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthOrgServiceProviderConfig-JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthOrgServiceProviderConfig -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/session-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Auth Org Session Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthOrgSessionConfig-JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthOrgSessionConfig -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgSessionConfig" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfile = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + } + "@ + + # Create an Identity Profile + + try { + $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile + New-IdentityProfile-IdentityProfile $Result + + # Below is a request that includes all optional parameters + # New-IdentityProfile -IdentityProfile $IdentityProfile + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. + + # Delete an Identity Profile + + try { + Remove-IdentityProfile-IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Remove-IdentityProfile -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body. + $RequestBody = @""@ + + + # Delete Identity Profiles + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-IdentityProfiles-RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-IdentityProfiles -RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) + + # Export Identity Profiles + + try { + Export-IdentityProfiles + + # Below is a request that includes all optional parameters + # Export-IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. + + # Get default Identity Attribute Config + + try { + Get-DefaultIdentityAttributeConfig-IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultIdentityAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. + + # Get single Identity Profile + + try { + Get-IdentityProfile-IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-IdentityProfile -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + + + + + $IdentityProfileExportedObject = @"{ + "self" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "version" : 1, + "object" : { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + } + }"@ + + + # Import Identity Profiles + + try { + $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject + Import-IdentityProfiles-IdentityProfileExportedObject $Result + + # Below is a request that includes all optional parameters + # Import-IdentityProfiles -IdentityProfileExportedObject $IdentityProfileExportedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) + + # Identity Profiles List + + try { + Get-IdentityProfiles + + # Below is a request that includes all optional parameters + # Get-IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/identity-preview + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityPreviewRequest = @" + { + "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + } + } + "@ + + # Generate Identity Profile Preview + + try { + $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest + Show-IdentityPreview-IdentityPreviewRequest $Result + + # Below is a request that includes all optional parameters + # Show-IdentityPreview -IdentityPreviewRequest $IdentityPreviewRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-IdentityPreview" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/process-identities + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed + + # Process identities under profile + + try { + Sync-IdentityProfile-IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Sync-IdentityProfile -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update the Identity Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-IdentityProfile-IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleState = @" + { + "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], + "emailNotificationOption" : { + "notifyManagers" : true, + "notifySpecificUsers" : true, + "emailAddressList" : [ "test@test.com", "test2@test.com" ], + "notifyAllAdmins" : true + }, + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Lifecycle description", + "accountActions" : [ { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }, { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } ], + "id" : "id12345", + "identityCount" : 42, + "technicalName" : "Technical Name", + "identityState" : "identityState", + "enabled" : true + } + "@ + + # Create Lifecycle State + + try { + $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState + New-LifecycleState-IdentityProfileId $IdentityProfileId -LifecycleState $Result + + # Below is a request that includes all optional parameters + # New-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $LifecycleState + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + + # Delete Lifecycle State + + try { + Remove-LifecycleState-IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Remove-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + + # Get Lifecycle State + + try { + Get-LifecycleState-IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Get-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Lists LifecycleStates + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-LifecycleStates" + Write-Host $_.ErrorDetails + } +- path: /identities/{identity-id}/set-lifecycle-state + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "2c9180857893f1290178944561990364" # String | ID of the identity to update. + $SetLifecycleStateRequest = @" + + "@ + + # Set Lifecycle State + + try { + $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest + Set-LifecycleState-IdentityId $IdentityId -SetLifecycleStateRequest $Result + + # Below is a request that includes all optional parameters + # Set-LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $SetLifecycleStateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Lifecycle State + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-LifecycleStates" + Write-Host $_.ErrorDetails + } +- path: /managed-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ManagedClientRequest = @" + { + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + } + "@ + + # Create Managed Client + + try { + $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest + New-ManagedClient-ManagedClientRequest $Result + + # Below is a request that includes all optional parameters + # New-ManagedClient -ManagedClientRequest $ManagedClientRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Delete Managed Client + + try { + Remove-ManagedClient-Id $Id + + # Below is a request that includes all optional parameters + # Remove-ManagedClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Get Managed Client + + try { + Get-ManagedClient-Id $Id + + # Below is a request that includes all optional parameters + # Get-ManagedClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "aClientId" # String | Managed client ID to get status for. + $Type = "CCG" # ManagedClientType | Managed client type to get status for. + + # Get Managed Client Status + + try { + Get-ManagedClientStatus-Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-ManagedClientStatus -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + + # Get Managed Clients + + try { + Get-ManagedClients + + # Below is a request that includes all optional parameters + # Get-ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClients" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Client + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ManagedClient-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-ManagedClient -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ManagedClusterRequest = @" + { + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + } + "@ + + # Create Create Managed Cluster + + try { + $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest + New-ManagedCluster-ManagedClusterRequest $Result + + # Below is a request that includes all optional parameters + # New-ManagedCluster -ManagedClusterRequest $ManagedClusterRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) + + # Delete Managed Cluster + + try { + Remove-ManagedCluster-Id $Id + + # Below is a request that includes all optional parameters + # Remove-ManagedCluster -Id $Id -RemoveClients $RemoveClients + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. + + # Get Managed Cluster Log Configuration + + try { + Get-ClientLogConfiguration-Id $Id + + # Below is a request that includes all optional parameters + # Get-ClientLogConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + + # Get Managed Cluster + + try { + Get-ManagedCluster-Id $Id + + # Below is a request that includes all optional parameters + # Get-ManagedCluster -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + + # Get Managed Clusters + + try { + Get-ManagedClusters + + # Below is a request that includes all optional parameters + # Get-ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClusters" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. + $PutClientLogConfigurationRequest = @" + + "@ + + # Update Managed Cluster Log Configuration + + try { + $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest + Send-ClientLogConfiguration-Id $Id -PutClientLogConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $PutClientLogConfigurationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Cluster + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ManagedCluster-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-ManagedCluster -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/delete + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + # Delete MFA method configuration + + try { + Remove-MFAConfig-Method $Method + + # Below is a request that includes all optional parameters + # Remove-MFAConfig -Method $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-MFAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Configuration of Duo MFA method + + try { + Get-MFADuoConfig + + # Below is a request that includes all optional parameters + # Get-MFADuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + # Configuration of KBA MFA method + + try { + Get-MFAKbaConfig + + # Below is a request that includes all optional parameters + # Get-MFAKbaConfig -AllLanguages $AllLanguages + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFAKbaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Configuration of Okta MFA method + + try { + Get-MFAOktaConfig + + # Below is a request that includes all optional parameters + # Get-MFAOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MfaDuoConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Duo MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-MFADuoConfig-MfaDuoConfig $Result + + # Below is a request that includes all optional parameters + # Set-MFADuoConfig -MfaDuoConfig $MfaDuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ + + + # Set MFA KBA configuration + + try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-MFAKBAConfig-KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Set-MFAKBAConfig -KbaAnswerRequestItem $KbaAnswerRequestItem + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAKBAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MfaOktaConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Okta MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-MFAOktaConfig-MfaOktaConfig $Result + + # Below is a request that includes all optional parameters + # Set-MFAOktaConfig -MfaOktaConfig $MfaOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + # MFA method's test configuration + + try { + Test-MFAConfig-Method $Method + + # Below is a request that includes all optional parameters + # Test-MFAConfig -Method $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-MFAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/token/send + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SendTokenRequest = @" + { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK" + } + "@ + + # Create and send user token + + try { + $Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest + New-SendToken-SendTokenRequest $Result + + # Below is a request that includes all optional parameters + # New-SendToken -SendTokenRequest $SendTokenRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SendToken" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/poll + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' + $VerificationPollRequest = @" + { + "requestId" : "089899f13a8f4da7824996191587bab9" + } + "@ + + # Polling MFA method by VerificationPollRequest + + try { + $Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest + Ping-VerificationStatus-Method $Method -VerificationPollRequest $Result + + # Below is a request that includes all optional parameters + # Ping-VerificationStatus -Method $Method -VerificationPollRequest $VerificationPollRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-VerificationStatus" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/verify + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $DuoVerificationRequest = @" + { + "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", + "userId" : "2c9180947f0ef465017f215cbcfd004b" + } + "@ + + # Verifying authentication via Duo method + + try { + $Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest + Send-DuoVerifyRequest-DuoVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-DuoVerifyRequest -DuoVerificationRequest $DuoVerificationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-DuoVerifyRequest" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/authenticate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ + + + # Authenticate KBA provided MFA method + + try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Send-KbaAnswers-KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Send-KbaAnswers -KbaAnswerRequestItem $KbaAnswerRequestItem + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-KbaAnswers" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/verify + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OktaVerificationRequest = @" + { + "userId" : "example@mail.com" + } + "@ + + # Verifying authentication via Okta method + + try { + $Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest + Send-OktaVerifyRequest-OktaVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-OktaVerifyRequest -OktaVerificationRequest $OktaVerificationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-OktaVerifyRequest" + Write-Host $_.ErrorDetails + } +- path: /mfa/token/authenticate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TokenAuthRequest = @" + { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK", + "token" : "12345" + } + "@ + + # Authenticate Token provided MFA method + + try { + $Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest + Send-TokenAuthRequest-TokenAuthRequest $Result + + # Below is a request that includes all optional parameters + # Send-TokenAuthRequest -TokenAuthRequest $TokenAuthRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TokenAuthRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) + $NonEmployeeApprovalDecision = @" + { + "comment" : "Approved by manager" + } + "@ + + # Approve a Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision + Approve-NonEmployeeRequest-Id $Id -NonEmployeeApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $NonEmployeeApprovalDecision + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Create Non-Employee Record + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-NonEmployeeRecord-NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-NonEmployeeRecord -NonEmployeeRequestBody $NonEmployeeRequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Create Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-NonEmployeeRequest-NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-NonEmployeeRequest -NonEmployeeRequestBody $NonEmployeeRequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $NonEmployeeSourceRequestBody = @" + { + "owner" : { + "id" : "2c91808570313110017040b06f344ec9" + }, + "managementWorkgroup" : "123299", + "accountManagers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ], + "name" : "Retail", + "description" : "Source description", + "approvers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ] + } + "@ + + # Create Non-Employee Source + + try { + $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody + New-NonEmployeeSource-NonEmployeeSourceRequestBody $Result + + # Below is a request that includes all optional parameters + # New-NonEmployeeSource -NonEmployeeSourceRequestBody $NonEmployeeSourceRequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + $NonEmployeeSchemaAttributeBody = @" + { + "helpText" : "The unique identifier for the account", + "label" : "Account Name", + "placeholder" : "Enter a unique user name for this account.", + "type" : "TEXT", + "technicalName" : "account.name", + "required" : true + } + "@ + + # Create a new Schema Attribute for Non-Employee Source + + try { + $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody + New-NonEmployeeSourceSchemaAttributes-SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result + + # Below is a request that includes all optional parameters + # New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $NonEmployeeSchemaAttributeBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) + + # Delete Non-Employee Record + + try { + Remove-NonEmployeeRecord-Id $Id + + # Below is a request that includes all optional parameters + # Remove-NonEmployeeRecord -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $DeleteNonEmployeeRecordsInBulkRequest = @" + + "@ + + # Delete Multiple Non-Employee Records + + try { + $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest + Remove-NonEmployeeRecordsInBulk-DeleteNonEmployeeRecordsInBulkRequest $Result + + # Below is a request that includes all optional parameters + # Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $DeleteNonEmployeeRecordsInBulkRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format + + # Delete Non-Employee Request + + try { + Remove-NonEmployeeRequest-Id $Id + + # Below is a request that includes all optional parameters + # Remove-NonEmployeeRequest -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # Delete a Schema Attribute for Non-Employee Source + + try { + Remove-NonEmployeeSchemaAttribute-AttributeId $AttributeId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id + + # Delete Non-Employee Source + + try { + Remove-NonEmployeeSource-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-NonEmployeeSource -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # Delete all custom schema attributes for Non-Employee Source + + try { + Remove-NonEmployeeSourceSchemaAttributes-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-NonEmployeeSourceSchemaAttributes -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employees/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) + + # Exports Non-Employee Records to CSV + + try { + Export-NonEmployeeRecords-Id $Id + + # Below is a request that includes all optional parameters + # Export-NonEmployeeRecords -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-NonEmployeeRecords" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/schema-attributes-template/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID) + + # Exports Source Schema Template + + try { + Export-NonEmployeeSourceSchemaTemplate-Id $Id + + # Below is a request that includes all optional parameters + # Export-NonEmployeeSourceSchemaTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-NonEmployeeSourceSchemaTemplate" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) + $IncludeDetail = $true # Boolean | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) + + # Get a non-employee approval item detail + + try { + Get-NonEmployeeApproval-Id $Id + + # Below is a request that includes all optional parameters + # Get-NonEmployeeApproval -Id $Id -IncludeDetail $IncludeDetail + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApproval" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/summary/{requested-for} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + + # Get Summary of Non-Employee Approval Requests + + try { + Get-NonEmployeeApprovalSummary-RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-NonEmployeeApprovalSummary -RequestedFor $RequestedFor + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApprovalSummary" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source ID (UUID) + + # Obtain the status of bulk upload on the source + + try { + Get-NonEmployeeBulkUploadStatus-Id $Id + + # Below is a request that includes all optional parameters + # Get-NonEmployeeBulkUploadStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeBulkUploadStatus" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) + + # Get a Non-Employee Record + + try { + Get-NonEmployeeRecord-Id $Id + + # Below is a request that includes all optional parameters + # Get-NonEmployeeRecord -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID) + + # Get a Non-Employee Request + + try { + Get-NonEmployeeRequest-Id $Id + + # Below is a request that includes all optional parameters + # Get-NonEmployeeRequest -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/summary/{requested-for} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + + # Get Summary of Non-Employee Requests + + try { + Get-NonEmployeeRequestSummary-RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-NonEmployeeRequestSummary -RequestedFor $RequestedFor + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequestSummary" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # Get Schema Attribute Non-Employee Source + + try { + Get-NonEmployeeSchemaAttribute-AttributeId $AttributeId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id + + # Get a Non-Employee Source + + try { + Get-NonEmployeeSource-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-NonEmployeeSource -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # List Schema Attributes Non-Employee Source + + try { + Get-NonEmployeeSourceSchemaAttributes-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-NonEmployeeSourceSchemaAttributes -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) + $Data = # System.IO.FileInfo | + + # Imports, or Updates, Non-Employee Records + + try { + Import-NonEmployeeRecordsInBulk-Id $Id -Data $Data + + # Below is a request that includes all optional parameters + # Import-NonEmployeeRecordsInBulk -Id $Id -Data $Data + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-NonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity for whom the request was made. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "approvalStatus eq "Pending"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Get List of Non-Employee Approval Requests + + try { + Get-NonEmployeeApprovals + + # Below is a request that includes all optional parameters + # Get-NonEmployeeApprovals -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApprovals" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "accountName,sourceId" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) + $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + + # List Non-Employee Records + + try { + Get-NonEmployeeRecords + + # Below is a request that includes all optional parameters + # Get-NonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRecords" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "e136567de87e4d029e60b3c3c55db56d" # String | The identity for whom the request was made. *me* indicates the current user. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "created,approvalStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) + $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + + # List Non-Employee Requests + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequests" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $NonEmployeeCount = $true # Boolean | The flag to determine whether return a non-employee count associate with source. (optional) + $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) + + # List Non-Employee Sources + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSources" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Non-Employee Record + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-NonEmployeeRecord-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Schema Attribute for Non-Employee Source + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Non-Employee Source + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-NonEmployeeSource-SourceId $SourceId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id}/reject + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) + $NonEmployeeRejectApprovalDecision = @" + { + "comment" : "approved" + } + "@ + + # Reject a Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision + Deny-NonEmployeeRequest-Id $Id -NonEmployeeRejectApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $NonEmployeeRejectApprovalDecision + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Update Non-Employee Record + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + Update-NonEmployeeRecord-Id $Id -NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $NonEmployeeRequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreateOAuthClientRequest = @" + { + "internal" : false, + "businessName" : "Acme-Solar", + "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", + "refreshTokenValiditySeconds" : 86400, + "type" : "CONFIDENTIAL", + "redirectUris" : [ "http://localhost:12345" ], + "enabled" : true, + "accessType" : "OFFLINE", + "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], + "strongAuthSupported" : false, + "homepageUrl" : "http://localhost:12345", + "accessTokenValiditySeconds" : 750, + "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], + "name" : "Demo API Client", + "claimsSupported" : false + } + "@ + + # Create OAuth Client + + try { + $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest + New-OauthClient-CreateOAuthClientRequest $Result + + # Below is a request that includes all optional parameters + # New-OauthClient -CreateOAuthClientRequest $CreateOAuthClientRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-OauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + + # Delete OAuth Client + + try { + Remove-OauthClient-Id $Id + + # Below is a request that includes all optional parameters + # Remove-OauthClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-OauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + + # Get OAuth Client + + try { + Get-OauthClient-Id $Id + + # Below is a request that includes all optional parameters + # Get-OauthClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-OauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + + # List OAuth Clients + + try { + Get-OauthClients + + # Below is a request that includes all optional parameters + # Get-OauthClients -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-OauthClients" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch OAuth Client + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-OauthClient-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-OauthClient -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-OauthClient" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Create Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + New-PasswordOrgConfig-PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # New-PasswordOrgConfig -PasswordOrgConfig $PasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Password Org Config + + try { + Get-PasswordOrgConfig + + # Below is a request that includes all optional parameters + # Get-PasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Update Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + Send-PasswordOrgConfig-PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # Send-PasswordOrgConfig -PasswordOrgConfig $PasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-dictionary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Password Dictionary + + try { + Get-PasswordDictionary + + # Below is a request that includes all optional parameters + # Get-PasswordDictionary + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordDictionary" + Write-Host $_.ErrorDetails + } +- path: /password-dictionary + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $File = # System.IO.FileInfo | (optional) + + # Update Password Dictionary + + try { + Send-PasswordDictionary + + # Below is a request that includes all optional parameters + # Send-PasswordDictionary -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PasswordDictionary" + Write-Host $_.ErrorDetails + } +- path: /password-change-status/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID + + # Get Password Change Request Status + + try { + Get-PasswordChangeStatus-Id $Id + + # Below is a request that includes all optional parameters + # Get-PasswordChangeStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordChangeStatus" + Write-Host $_.ErrorDetails + } +- path: /query-password-info + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordInfoQueryDTO = @" + { + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + } + "@ + + # Query Password Info + + try { + $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO + Search-PasswordInfo-PasswordInfoQueryDTO $Result + + # Below is a request that includes all optional parameters + # Search-PasswordInfo -PasswordInfoQueryDTO $PasswordInfoQueryDTO + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-PasswordInfo" + Write-Host $_.ErrorDetails + } +- path: /set-password + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordChangeRequest = @" + { + "sourceId" : "8a807d4c73c545510173c545d4b60246", + "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "identityId" : "8a807d4c73c545510173c545f0a002ff", + "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" + } + "@ + + # Set Identity's Password + + try { + $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest + Set-Password-PasswordChangeRequest $Result + + # Below is a request that includes all optional parameters + # Set-Password -PasswordChangeRequest $PasswordChangeRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-Password" + Write-Host $_.ErrorDetails + } +- path: /password-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordPolicyV3Dto = @" + { + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + } + "@ + + # Create Password Policy + + try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + New-PasswordPolicy-PasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # New-PasswordPolicy -PasswordPolicyV3Dto $PasswordPolicyV3Dto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. + + # Delete Password Policy by ID + + try { + Remove-PasswordPolicy-Id $Id + + # Below is a request that includes all optional parameters + # Remove-PasswordPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-PasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. + + # Get Password Policy by ID + + try { + Get-PasswordPolicyById-Id $Id + + # Below is a request that includes all optional parameters + # Get-PasswordPolicyById -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordPolicyById" + Write-Host $_.ErrorDetails + } +- path: /password-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Password Policies + + try { + Get-PasswordPolicies + + # Below is a request that includes all optional parameters + # Get-PasswordPolicies -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordPolicies" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update. + $PasswordPolicyV3Dto = @" + { + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + } + "@ + + # Update Password Policy by ID + + try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + Set-PasswordPolicy-Id $Id -PasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # Set-PasswordPolicy -Id $Id -PasswordPolicyV3Dto $PasswordPolicyV3Dto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-PasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordSyncGroup = @" + { + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } + "@ + + # Create Password Sync Group + + try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + New-PasswordSyncGroup-PasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # New-PasswordSyncGroup -PasswordSyncGroup $PasswordSyncGroup + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. + + # Delete Password Sync Group by ID + + try { + Remove-PasswordSyncGroup-Id $Id + + # Below is a request that includes all optional parameters + # Remove-PasswordSyncGroup -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. + + # Get Password Sync Group by ID + + try { + Get-PasswordSyncGroup-Id $Id + + # Below is a request that includes all optional parameters + # Get-PasswordSyncGroup -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Get Password Sync Group List + + try { + Get-PasswordSyncGroups + + # Below is a request that includes all optional parameters + # Get-PasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordSyncGroups" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to update. + $PasswordSyncGroup = @" + { + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } + "@ + + # Update Password Sync Group by ID + + try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + Update-PasswordSyncGroup-Id $Id -PasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # Update-PasswordSyncGroup -Id $Id -PasswordSyncGroup $PasswordSyncGroup + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreatePersonalAccessTokenRequest = @" + { + "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], + "accessTokenValiditySeconds" : 36900, + "name" : "NodeJS Integration" + } + "@ + + # Create Personal Access Token + + try { + $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest + New-PersonalAccessToken-CreatePersonalAccessTokenRequest $Result + + # Below is a request that includes all optional parameters + # New-PersonalAccessToken -CreatePersonalAccessTokenRequest $CreatePersonalAccessTokenRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id + + # Delete Personal Access Token + + try { + Remove-PersonalAccessToken-Id $Id + + # Below is a request that includes all optional parameters + # Remove-PersonalAccessToken -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-PersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "2c9180867b50d088017b554662fb281e" # String | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) + $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + + # List Personal Access Tokens + + try { + Get-PersonalAccessTokens + + # Below is a request that includes all optional parameters + # Get-PersonalAccessTokens -OwnerId $OwnerId -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PersonalAccessTokens" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Personal Access Token + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-PersonalAccessToken-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-PersonalAccessToken -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /public-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "firstname eq "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) + $AddCoreFilters = $false # Boolean | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be ""spadmin"" or ""cloudadmin"". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to $false) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Get list of public identities + + try { + Get-PublicIdentities + + # Below is a request that includes all optional parameters + # Get-PublicIdentities -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -AddCoreFilters $AddCoreFilters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PublicIdentities" + Write-Host $_.ErrorDetails + } +- path: /public-identities-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get the Public Identities Configuration + + try { + Get-PublicIdentityConfig + + # Below is a request that includes all optional parameters + # Get-PublicIdentityConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PublicIdentityConfig" + Write-Host $_.ErrorDetails + } +- path: /public-identities-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PublicIdentityConfig = @" + { + "modified" : "2018-06-25T20:22:28.104Z", + "attributes" : [ { + "name" : "Country", + "key" : "country" + }, { + "name" : "Country", + "key" : "country" + } ], + "modifiedBy" : { + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + } + "@ + + # Update the Public Identities Configuration + + try { + $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig + Update-PublicIdentityConfig-PublicIdentityConfig $Result + + # Below is a request that includes all optional parameters + # Update-PublicIdentityConfig -PublicIdentityConfig $PublicIdentityConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PublicIdentityConfig" + Write-Host $_.ErrorDetails + } +- path: /reports/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel + + # Cancel Report + + try { + Suspend-Report-Id $Id + + # Below is a request that includes all optional parameters + # Suspend-Report -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-Report" + Write-Host $_.ErrorDetails + } +- path: /reports/{taskResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report + $FileFormat = "csv" # String | Output format of the requested report file + $Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional) + $Auditable = $true # Boolean | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to $false) + + # Get Report File + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Report" + Write-Host $_.ErrorDetails + } +- path: /reports/{taskResultId}/result + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report + $Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false) + + # Get Report Result + + try { + Get-ReportResult-TaskResultId $TaskResultId + + # Below is a request that includes all optional parameters + # Get-ReportResult -TaskResultId $TaskResultId -Completed $Completed + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ReportResult" + Write-Host $_.ErrorDetails + } +- path: /reports/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReportDetails = @" + { + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } + } + "@ + + # Run Report + + try { + $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails + Start-Report-ReportDetails $Result + + # Below is a request that includes all optional parameters + # Start-Report -ReportDetails $ReportDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-Report" + Write-Host $_.ErrorDetails + } +- path: /requestable-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) + $Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. (optional) + + $Types = @"ROLE,ACCESS_PROFILE"@ + $Term = "Finance Role" # String | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) + $Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional) + + $Statuses = @"[ASSIGNED, PENDING]"@ + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw "bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Requestable Objects List + + try { + Get-RequestableObjects + + # Below is a request that includes all optional parameters + # Get-RequestableObjects -IdentityId $IdentityId -Types $Types -Term $Term -Statuses $Statuses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-RequestableObjects" + Write-Host $_.ErrorDetails + } +- path: /roles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Role = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "dimensional" : false, + "created" : "2021-03-01T22:32:58.104Z", + "dimensionRefs" : [ { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + }, { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + } ], + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "membership" : { + "identities" : [ { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } ], + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, + "type" : "IDENTITY_LIST" + }, + "enabled" : true, + "revocationRequestConfig" : { + "commentsRequired" : false, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : false + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "legacyMembershipInfo" : { + "type" : "IDENTITY_LIST" + }, + "accessRequestConfig" : { + "commentsRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "name" : "Role 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "accessModelMetadata" : { + "attributes" : [ { + "key" : "iscPrivacy", + "name" : "Privacy", + "multiselect" : false, + "status" : "active", + "type" : "governance", + "objectTypes" : [ "all" ], + "description" : "Specifies the level of privacy associated with an access item.", + "values" : [ { + "value" : "public", + "name" : "Public", + "status" : "active" + } ] + } ] + }, + "id" : "2c918086749d78830174a1a40e121518", + "requestable" : true + } + "@ + + # Create a Role + + try { + $Result = ConvertFrom-JsonToRole -Json $Role + New-Role-Role $Result + + # Below is a request that includes all optional parameters + # New-Role -Role $Role + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Role" + Write-Host $_.ErrorDetails + } +- path: /roles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleBulkDeleteRequest = @" + { + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } + "@ + + # Delete Role(s) + + try { + $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest + Remove-BulkRoles-RoleBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BulkRoles -RoleBulkDeleteRequest $RoleBulkDeleteRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BulkRoles" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + + # Delete a Role + + try { + Remove-Role-Id $Id + + # Below is a request that includes all optional parameters + # Remove-Role -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Role" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + + # Get a Role + + try { + Get-Role-Id $Id + + # Below is a request that includes all optional parameters + # Get-Role -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Role" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/assigned-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role for which the assigned Identities are to be listed + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw Joe" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) + $Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) + + # List Identities assigned a Role + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-RoleAssignedIdentities" + Write-Host $_.ErrorDetails + } +- path: /roles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + + # List Roles + + try { + Get-Roles + + # Below is a request that includes all optional parameters + # Get-Roles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Roles" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Role + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Role-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-Role -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Role" + Write-Host $_.ErrorDetails + } +- path: /saved-searches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreateSavedSearchRequest = @" + + "@ + + # Create a saved search + + try { + $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest + New-SavedSearch-CreateSavedSearchRequest $Result + + # Below is a request that includes all optional parameters + # New-SavedSearch -CreateSavedSearchRequest $CreateSavedSearchRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Delete document by ID + + try { + Remove-SavedSearch-Id $Id + + # Below is a request that includes all optional parameters + # Remove-SavedSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id}/execute + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $SearchArguments = @" + { + "owner" : "", + "recipients" : [ { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" + } + "@ + + # Execute a saved search by ID + + try { + $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments + Invoke-ExecuteSavedSearch-Id $Id -SearchArguments $Result + + # Below is a request that includes all optional parameters + # Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $SearchArguments + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ExecuteSavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Return saved search by ID + + try { + Get-SavedSearch-Id $Id + + # Below is a request that includes all optional parameters + # Get-SavedSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) + + # A list of Saved Searches + + try { + Get-SavedSearches + + # Below is a request that includes all optional parameters + # Get-SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SavedSearches" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $SavedSearch = @" + { + "owner" : { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2018-06-25T20:22:28.104Z", + "columns" : { + "identity" : [ { + "field" : "displayName", + "header" : "Display Name" + }, { + "field" : "e-mail", + "header" : "Work Email" + } ] + }, + "query" : "@accounts(disabled:true)", + "description" : "Disabled accounts", + "orderBy" : { + "identity" : [ "lastName", "firstName" ], + "role" : [ "name" ] + }, + "sort" : [ "displayName" ], + "filters" : { + "terms" : [ "account_count", "account_count" ], + "range" : { + "lower" : { + "inclusive" : false, + "value" : "1" + }, + "upper" : { + "inclusive" : false, + "value" : "1" + } + }, + "exclude" : false, + "type" : "RANGE" + }, + "ownerId" : "2c91808568c529c60168cca6f90c1313", + "indices" : [ "identities" ], + "public" : false, + "name" : "Disabled accounts", + "modified" : "2018-06-25T20:22:28.104Z", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "fields" : [ "disabled" ] + } + "@ + + # Updates an existing saved search + + try { + $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch + Send-SavedSearch-Id $Id -SavedSearch $Result + + # Below is a request that includes all optional parameters + # Send-SavedSearch -Id $Id -SavedSearch $SavedSearch + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreateScheduledSearchRequest = @" + {savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]} + "@ + + # Create a new scheduled search + + try { + $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest + New-ScheduledSearch-CreateScheduledSearchRequest $Result + + # Below is a request that includes all optional parameters + # New-ScheduledSearch -CreateScheduledSearchRequest $CreateScheduledSearchRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Delete a Scheduled Search + + try { + Remove-ScheduledSearch-Id $Id + + # Below is a request that includes all optional parameters + # Remove-ScheduledSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Get a Scheduled Search + + try { + Get-ScheduledSearch-Id $Id + + # Below is a request that includes all optional parameters + # Get-ScheduledSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional) + + # List scheduled searches + + try { + Get-ScheduledSearch + + # Below is a request that includes all optional parameters + # Get-ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id}/unsubscribe + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $TypedReference = @" + { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + "@ + + # Unsubscribe a recipient from Scheduled Search + + try { + $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference + Invoke-UnsubscribeScheduledSearch-Id $Id -TypedReference $Result + + # Below is a request that includes all optional parameters + # Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $TypedReference + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-UnsubscribeScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $ScheduledSearch = @" + { + "owner" : { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "displayQueryDetails" : false, + "created" : "", + "description" : "Daily disabled accounts", + "ownerId" : "2c9180867624cbd7017642d8c8c81f67", + "enabled" : false, + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "recipients" : [ { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + } ], + "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", + "name" : "Daily disabled accounts", + "modified" : "", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "emailEmptyResults" : false + } + "@ + + # Update an existing Scheduled Search + + try { + $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch + Update-ScheduledSearch-Id $Id -ScheduledSearch $Result + + # Below is a request that includes all optional parameters + # Update-ScheduledSearch -Id $Id -ScheduledSearch $ScheduledSearch + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /search/aggregate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + } + "@ + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Perform a Search Query Aggregation + + try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-Aggregate-Search $Result + + # Below is a request that includes all optional parameters + # Search-Aggregate -Search $Search -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Aggregate" + Write-Host $_.ErrorDetails + } +- path: /search/count + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + } + "@ + + # Count Documents Satisfying a Query + + try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-Count-Search $Result + + # Below is a request that includes all optional parameters + # Search-Count -Search $Search + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Count" + Write-Host $_.ErrorDetails + } +- path: /search/{index}/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Get a Document by ID + + try { + Search-Get-Index $Index -Id $Id + + # Below is a request that includes all optional parameters + # Search-Get -Index $Index -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Get" + Write-Host $_.ErrorDetails + } +- path: /search + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + } + "@ + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Perform Search + + try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-Post-Search $Result + + # Below is a request that includes all optional parameters + # Search-Post -Search $Search -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Post" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SearchAttributeConfig = @" + { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } + "@ + + # Create Extended Search Attributes + + try { + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-SearchAttributeConfig-SearchAttributeConfig $Result + + # Below is a request that includes all optional parameters + # New-SearchAttributeConfig -SearchAttributeConfig $SearchAttributeConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. + + # Delete Extended Search Attribute + + try { + Remove-SearchAttributeConfig-Name $Name + + # Below is a request that includes all optional parameters + # Remove-SearchAttributeConfig -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Extended Search Attributes + + try { + Get-SearchAttributeConfig + + # Below is a request that includes all optional parameters + # Get-SearchAttributeConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to retrieve. + + # Get Extended Search Attribute + + try { + Get-SingleSearchAttributeConfig-Name $Name + + # Below is a request that includes all optional parameters + # Get-SingleSearchAttributeConfig -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SingleSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Extended Search Attribute + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-SearchAttributeConfig-Name $Name -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /segments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Segment = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + } + "@ + + # Create Segment + + try { + $Result = ConvertFrom-JsonToSegment -Json $Segment + New-Segment-Segment $Result + + # Below is a request that includes all optional parameters + # New-Segment -Segment $Segment + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Segment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + + # Delete Segment by ID + + try { + Remove-Segment-Id $Id + + # Below is a request that includes all optional parameters + # Remove-Segment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Segment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + + # Get Segment by ID + + try { + Get-Segment-Id $Id + + # Below is a request that includes all optional parameters + # Get-Segment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Segment" + Write-Host $_.ErrorDetails + } +- path: /segments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Segments + + try { + Get-Segments + + # Below is a request that includes all optional parameters + # Get-Segments -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Segments" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. + $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ + + + # Update Segment + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-Segment-Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-Segment -Id $Id -RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Segment" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } + "@ + + # Create new Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-ServiceDeskIntegration-ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # New-ServiceDeskIntegration -ServiceDeskIntegrationDto $ServiceDeskIntegrationDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "anId" # String | ID of Service Desk integration to delete + + # Delete a Service Desk integration + + try { + Remove-ServiceDeskIntegration-Id $Id + + # Below is a request that includes all optional parameters + # Remove-ServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "anId" # String | ID of the Service Desk integration to get + + # Get a Service Desk integration + + try { + Get-ServiceDeskIntegration-Id $Id + + # Below is a request that includes all optional parameters + # Get-ServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + + # Service Desk integration template by scriptName + + try { + Get-ServiceDeskIntegrationTemplate-ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-ServiceDeskIntegrationTemplate -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrationTemplate" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Service Desk integration types + + try { + Get-ServiceDeskIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-ServiceDeskIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrationTypes" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "name eq "John Doe"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List existing Service Desk integrations + + try { + Get-ServiceDeskIntegrations + + # Below is a request that includes all optional parameters + # Get-ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrations" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get the time check configuration + + try { + Get-StatusCheckDetails + + # Below is a request that includes all optional parameters + # Get-StatusCheckDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $PatchServiceDeskIntegrationRequest = @" + + "@ + + # Patch a Service Desk Integration + + try { + $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest + Update-ServiceDeskIntegration-Id $Id -PatchServiceDeskIntegrationRequest $Result + + # Below is a request that includes all optional parameters + # Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $PatchServiceDeskIntegrationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } + "@ + + # Update a Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-ServiceDeskIntegration-Id $Id -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $ServiceDeskIntegrationDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $QueuedCheckConfigDetails = @" + { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } + "@ + + # Update the time check configuration + + try { + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-StatusCheckDetails-QueuedCheckConfigDetails $Result + + # Below is a request that includes all optional parameters + # Update-StatusCheckDetails -QueuedCheckConfigDetails $QueuedCheckConfigDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-StatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Create SOD policy + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-SodPolicy-SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-SodPolicy -SodPolicy $SodPolicy + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-SodPolicy-Id $Id + + # Below is a request that includes all optional parameters + # Remove-SodPolicy -Id $Id -Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-SodPolicySchedule-Id $Id + + # Below is a request that includes all optional parameters + # Remove-SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. + + # Download custom violation report + + try { + Get-CustomViolationReport-ReportResultId $ReportResultId -FileName $FileName + + # Below is a request that includes all optional parameters + # Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CustomViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-DefaultViolationReport-ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-DefaultViolationReport -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get multi-report run task status + + try { + Get-SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-SodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodAllReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + + # Get SOD policy by ID + + try { + Get-SodPolicy-Id $Id + + # Below is a request that includes all optional parameters + # Get-SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + + # Get SOD policy schedule + + try { + Get-SodPolicySchedule-Id $Id + + # Below is a request that includes all optional parameters + # Get-SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + + # Get violation report run status + + try { + Get-SodViolationReportRunStatus-ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-SodViolationReportRunStatus -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + + # Get SOD violation report status + + try { + Get-SodViolationReportStatus-Id $Id + + # Below is a request that includes all optional parameters + # Get-SodViolationReportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + + # List SOD policies + + try { + Get-SodPolicies + + # Below is a request that includes all optional parameters + # Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicies" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch SOD policy by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-SodPolicy-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-SodPolicy -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-PolicySchedule-Id $Id -SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-PolicySchedule -Id $Id -SodPolicySchedule $SodPolicySchedule + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-SodPolicy-Id $Id -SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-SodPolicy -Id $Id -SodPolicy $SodPolicy + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Evaluate one policy by ID + + try { + Start-EvaluateSodPolicy-Id $Id + + # Below is a request that includes all optional parameters + # Start-EvaluateSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-EvaluateSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + } + "@ + + # Runs all policies for org + + try { + Start-SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-SodAllPoliciesForOrg -MultiPolicyRequest $MultiPolicyRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-SodPolicy-Id $Id + + # Below is a request that includes all optional parameters + # Start-SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityWithNewAccess = @" + { + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-PredictSodViolations-IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-PredictSodViolations -IdentityWithNewAccess $IdentityWithNewAccess + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-PredictSodViolations" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityWithNewAccess1 = @" + {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} + "@ + + # Check SOD violations + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-ViolationCheck-IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-ViolationCheck -IdentityWithNewAccess1 $IdentityWithNewAccess1 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-ViolationCheck" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + $ProvisioningPolicyDto = @" + { + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + } + "@ + + # Create Provisioning Policy + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + New-ProvisioningPolicy-SourceId $SourceId -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # New-ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $ProvisioningPolicyDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Source = @" + { + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + } + "@ + $ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) + + # Creates a source in IdentityNow. + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + New-Source-Source $Result + + # Below is a request that includes all optional parameters + # New-Source -Source $Source -ProvisionAsCsv $ProvisionAsCsv + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Create Schema on Source + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + New-SourceSchema-SourceId $SourceId -Schema $Result + + # Below is a request that includes all optional parameters + # New-SourceSchema -SourceId $SourceId -Schema $Schema + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + # Delete Provisioning Policy by UsageType + + try { + Remove-ProvisioningPolicy-SourceId $SourceId -UsageType $UsageType + + # Below is a request that includes all optional parameters + # Remove-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Delete Source by ID + + try { + Remove-Source-Id $Id + + # Below is a request that includes all optional parameters + # Remove-Source -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + + # Delete Source Schema by ID + + try { + Remove-SourceSchema-SourceId $SourceId -SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Remove-SourceSchema -SourceId $SourceId -SchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + + # Downloads source accounts schema template + + try { + Get-AccountsSchema-Id $Id + + # Below is a request that includes all optional parameters + # Get-AccountsSchema -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + + # Downloads source entitlements schema template + + try { + Get-EntitlementsSchema-Id $Id + + # Below is a request that includes all optional parameters + # Get-EntitlementsSchema -Id $Id -SchemaName $SchemaName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-EntitlementsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + # Get Provisioning Policy by UsageType + + try { + Get-ProvisioningPolicy-SourceId $SourceId -UsageType $UsageType + + # Below is a request that includes all optional parameters + # Get-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Get Source by ID + + try { + Get-Source-Id $Id + + # Below is a request that includes all optional parameters + # Get-Source -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connections + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Get Source Connections by ID + + try { + Get-SourceConnections-Id $Id + + # Below is a request that includes all optional parameters + # Get-SourceConnections -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceConnections" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/source-health + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + + # Fetches source health by id + + try { + Get-SourceHealth-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-SourceHealth -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceHealth" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + + # Get Source Schema by ID + + try { + Get-SourceSchema-SourceId $SourceId -SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Get-SourceSchema -SourceId $SourceId -SchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) + $IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional) + + # List Schemas on Source + + try { + Get-SourceSchemas-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-SourceSchemas -SourceId $SourceId -IncludeTypes $IncludeTypes -IncludeNames $IncludeNames + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceSchemas" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $File = # System.IO.FileInfo | (optional) + + # Uploads source accounts schema template + + try { + Import-AccountsSchema-Id $Id + + # Below is a request that includes all optional parameters + # Import-AccountsSchema -Id $Id -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-AccountsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/upload-connector-file + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $File = # System.IO.FileInfo | (optional) + + # Upload connector file to source + + try { + Import-ConnectorFile-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-ConnectorFile -SourceId $SourceId -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-ConnectorFile" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + $File = # System.IO.FileInfo | (optional) + + # Uploads source entitlements schema template + + try { + Import-EntitlementsSchema-Id $Id + + # Below is a request that includes all optional parameters + # Import-EntitlementsSchema -Id $Id -SchemaName $SchemaName -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-EntitlementsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + + # Lists ProvisioningPolicies + + try { + Get-ProvisioningPolicies-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-ProvisioningPolicies -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ProvisioningPolicies" + Write-Host $_.ErrorDetails + } +- path: /sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Employees"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) + $ForSubadmin = "name" # String | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) + $IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false) + + # Lists all sources in IdentityNow. + + try { + Get-Sources + + # Below is a request that includes all optional parameters + # Get-Sources -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSubadmin $ForSubadmin -IncludeIDNSource $IncludeIDNSource + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Sources" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $ProvisioningPolicyDto = @" + { + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + } + "@ + + # Update Provisioning Policy by UsageType + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Source = @" + { + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + } + "@ + + # Update Source (Full) + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + Send-Source-Id $Id -Source $Result + + # Below is a request that includes all optional parameters + # Send-Source -Id $Id -Source $Source + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Update Source Schema (Full) + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ProvisioningPolicyDto = @"{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }"@ + + + # Bulk Update Provisioning Policies + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Update-ProvisioningPoliciesInBulk-SourceId $SourceId -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Update-ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $ProvisioningPolicyDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ProvisioningPoliciesInBulk" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Partial update of Provisioning Policy + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Source-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-Source -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source Schema (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-StatusBySourceId-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-StatusBySourceId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusBySourceId" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns source usage insights + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesBySourceId" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "ACCESS_PROFILE" # String | The type of object to delete tags from. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from. + + # Delete Object Tags + + try { + Remove-TaggedObject-Type $Type -Id $Id + + # Below is a request that includes all optional parameters + # Remove-TaggedObject -Type $Type -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-TaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/bulk-remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $BulkRemoveTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Remove Tags from Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject + Remove-TagsToManyObject-BulkRemoveTaggedObject $Result + + # Below is a request that includes all optional parameters + # Remove-TagsToManyObject -BulkRemoveTaggedObject $BulkRemoveTaggedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-TagsToManyObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + + # Get Tagged Object + + try { + Get-TaggedObject-Type $Type -Id $Id + + # Below is a request that includes all optional parameters + # Get-TaggedObject -Type $Type -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-TaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "tagName eq "BU_FINANCE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + + # List Tagged Objects + + try { + Get-TaggedObjects + + # Below is a request that includes all optional parameters + # Get-TaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-TaggedObjects" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "objectRef.id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + + # List Tagged Objects by Type + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-TaggedObjectsByType" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to update. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to update. + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Update Tagged Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Add Tag to Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Set-TagToObject-TaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-TagToObject -TaggedObject $TaggedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-TagToObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/bulk-add + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $BulkAddTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Tag Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject + Set-TagsToManyObjects-BulkAddTaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-TagsToManyObjects -BulkAddTaggedObject $BulkAddTaggedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-TagsToManyObjects" + Write-Host $_.ErrorDetails + } +- path: /transforms + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Create transform + + try { + $Result = ConvertFrom-JsonToTransform -Json $Transform + New-Transform-Transform $Result + + # Below is a request that includes all optional parameters + # New-Transform -Transform $Transform + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Transform" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete + + # Delete a transform + + try { + Remove-Transform-Id $Id + + # Below is a request that includes all optional parameters + # Remove-Transform -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Transform" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve + + # Transform by ID + + try { + Get-Transform-Id $Id + + # Below is a request that includes all optional parameters + # Get-Transform -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Transform" + Write-Host $_.ErrorDetails + } +- path: /transforms + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional) + $Filters = "name eq "Uppercase"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) + + # List transforms + + try { + Get-Transforms + + # Below is a request that includes all optional parameters + # Get-Transforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Transforms" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Update a transform + + try { + Update-Transform-Id $Id + + # Below is a request that includes all optional parameters + # Update-Transform -Id $Id -Transform $Transform + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Transform" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $VendorConnectorMapping = @" + { + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + } + "@ + + # Create Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + New-VendorConnectorMapping-VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # New-VendorConnectorMapping -VendorConnectorMapping $VendorConnectorMapping + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-VendorConnectorMapping" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $VendorConnectorMapping = @" + { + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + } + "@ + + # Delete Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + Remove-VendorConnectorMapping-VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # Remove-VendorConnectorMapping -VendorConnectorMapping $VendorConnectorMapping + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-VendorConnectorMapping" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Vendor Connector Mappings + + try { + Get-VendorConnectorMappings + + # Below is a request that includes all optional parameters + # Get-VendorConnectorMappings + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-VendorConnectorMappings" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-WorkflowExecution-Id $Id + + # Below is a request that includes all optional parameters + # Suspend-WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $CreateExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + New-ExternalExecuteWorkflow-Id $Id + + # Below is a request that includes all optional parameters + # New-ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $CreateExternalExecuteWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreateWorkflowRequest = @" + {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-Workflow-CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-Workflow -CreateWorkflowRequest $CreateWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + New-WorkflowExternalTrigger-Id $Id + + # Below is a request that includes all optional parameters + # New-WorkflowExternalTrigger -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-WorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-Workflow-Id $Id + + # Below is a request that includes all optional parameters + # Remove-Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Get Workflow By Id + + try { + Get-Workflow-Id $Id + + # Below is a request that includes all optional parameters + # Get-Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-WorkflowExecution-Id $Id + + # Below is a request that includes all optional parameters + # Get-WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + + # Get Workflow Execution History + + try { + Get-WorkflowExecutionHistory-Id $Id + + # Below is a request that includes all optional parameters + # Get-WorkflowExecutionHistory -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Complete Workflow Library + + try { + Get-CompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-CompleteWorkflowLibrary -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Actions + + try { + Get-WorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Workflow Library Operators + + try { + Get-WorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-WorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Triggers + + try { + Get-WorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Workflows + + try { + Get-Workflows + + # Below is a request that includes all optional parameters + # Get-Workflows + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Workflow-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-Workflow -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-Workflow-Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-Workflow -Id $Id -WorkflowBody $WorkflowBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-ExternalExecuteWorkflow-Id $Id + + # Below is a request that includes all optional parameters + # Test-ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $TestExternalExecuteWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-Workflow-Id $Id -TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-Workflow -Id $Id -TestWorkflowRequest $TestWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-Workflow" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Approve an Approval Item + + try { + Approve-ApprovalItem-Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk approve Approval Items + + try { + Approve-ApprovalItemsInBulk-Id $Id + + # Below is a request that includes all optional parameters + # Approve-ApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Complete a Work Item + + try { + Complete-WorkItem-Id $Id + + # Below is a request that includes all optional parameters + # Complete-WorkItem -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Completed Work Items + + try { + Get-CompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # Count Completed Work Items + + try { + Get-CountCompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-CountCompletedWorkItems -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountCompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) + + # Count Work Items + + try { + Get-CountWorkItems + + # Below is a request that includes all optional parameters + # Get-CountWorkItems -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. + + # Get a Work Item + + try { + Get-WorkItem-Id $Id + + # Below is a request that includes all optional parameters + # Get-WorkItem -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # Work Items Summary + + try { + Get-WorkItemsSummary + + # Below is a request that includes all optional parameters + # Get-WorkItemsSummary -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItemsSummary" + Write-Host $_.ErrorDetails + } +- path: /work-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # List Work Items + + try { + Get-WorkItems + + # Below is a request that includes all optional parameters + # Get-WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Reject an Approval Item + + try { + Deny-ApprovalItem-Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk reject Approval Items + + try { + Deny-ApprovalItemsInBulk-Id $Id + + # Below is a request that includes all optional parameters + # Deny-ApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $WorkItemForward = @" + { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } + "@ + + # Forward a Work Item + + try { + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Send-WorkItemForward-Id $Id -WorkItemForward $Result + + # Below is a request that includes all optional parameters + # Send-WorkItemForward -Id $Id -WorkItemForward $WorkItemForward + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-WorkItemForward" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName + + # Submit Account Selections + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-AccountSelection-Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Submit-AccountSelection -Id $Id -RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-AccountSelection" + Write-Host $_.ErrorDetails + } diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/AccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/AccessProfilesApi.md new file mode 100644 index 000000000..aa58d6bb2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/AccessProfilesApi.md @@ -0,0 +1,520 @@ + +--- +id: access-profiles +title: AccessProfiles +pagination_label: AccessProfiles +sidebar_label: AccessProfiles +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfiles', 'AccessProfiles'] +slug: /tools/sdk/powershell/v3/methods/access-profiles +tags: ['SDK', 'Software Development Kit', 'AccessProfiles', 'AccessProfiles'] +--- + +# AccessProfiles + Use this API to implement and customize access profile functionality. +With this functionality in place, administrators can create access profiles and configure them for use throughout Identity Security Cloud, enabling users to get the access they need quickly and securely. + +Access profiles group entitlements, which represent access rights on sources. + +For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +Access profiles are the most important units of access in Identity Security Cloud. Identity Security Cloud uses access profiles in many features, including the following: + +- Provisioning: When you use the Provisioning Service, lifecycle states and roles both grant access to users in the form of access profiles. + +- Certifications: You can approve or revoke access profiles in certification campaigns, just like entitlements. + +- Access Requests: You can assign access profiles to applications, and when a user requests access to the app associated with an access profile and someone approves the request, access is granted to both the application and its associated access profile. + +- Roles: You can group one or more access profiles into a role to quickly assign access items based on an identity's role. + +In Identity Security Cloud, administrators can use the Access drop-down menu and select Access Profiles to view, configure, and delete existing access profiles, as well as create new ones. +Administrators can enable and disable an access profile, and they can also make the following configurations: + +- Manage Entitlements: Manage the profile's access by adding and removing entitlements. + +- Access Requests: Configure access profiles to be requestable and establish an approval process for any requests that the access profile be granted or revoked. +Do not configure an access profile to be requestable without first establishing a secure access request approval process for the access profile. + +- Multiple Account Options: Define the logic Identity Security Cloud uses to provision access to an identity with multiple accounts on the source. + +Refer to [Managing Access Profiles](https://documentation.sailpoint.com/saas/help/access/access-profiles.html) for more information about access profiles. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-AccessProfile**](#create-access-profile) | **POST** `/access-profiles` | Create Access Profile +[**Remove-AccessProfile**](#delete-access-profile) | **DELETE** `/access-profiles/{id}` | Delete the specified Access Profile +[**Remove-AccessProfilesInBulk**](#delete-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-delete` | Delete Access Profile(s) +[**Get-AccessProfile**](#get-access-profile) | **GET** `/access-profiles/{id}` | Get an Access Profile +[**Get-AccessProfileEntitlements**](#get-access-profile-entitlements) | **GET** `/access-profiles/{id}/entitlements` | List Access Profile's Entitlements +[**Get-AccessProfiles**](#list-access-profiles) | **GET** `/access-profiles` | List Access Profiles +[**Update-AccessProfile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified Access Profile + +## create-access-profile +Use this API to create an access profile. +A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source. +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | AccessProfile | [**AccessProfile**](../models/access-profile) | True | + +### Return type +[**AccessProfile**](../models/access-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Access profile created. | AccessProfile +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$AccessProfile = @"{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "description" : "Collection of entitlements to read/write the employee database", + "source" : { + "name" : "ODS-AD-SOURCE", + "id" : "2c91809773dee3610173fdb0b6061ef4", + "type" : "SOURCE" + }, + "enabled" : true, + "revocationRequestConfig" : { + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ] + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "accessRequestConfig" : { + "commentsRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "name" : "Employee-database-read-write", + "provisioningCriteria" : { + "children" : [ { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, + "modified" : "2021-03-02T20:22:28.104Z", + "id" : "2c91808a7190d06e01719938fcd20792", + "requestable" : true +}"@ + +# Create Access Profile + +try { + $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile + New-AccessProfile-AccessProfile $Result + + # Below is a request that includes all optional parameters + # New-AccessProfile -AccessProfile $AccessProfile +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AccessProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-access-profile +This API deletes an existing Access Profile. + +The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. + +A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Access Profile to delete + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Returned when an access profile cannot be deleted as it's being used. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete + +# Delete the specified Access Profile + +try { + Remove-AccessProfile-Id $Id + + # Below is a request that includes all optional parameters + # Remove-AccessProfile -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-AccessProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-access-profiles-in-bulk +This endpoint initiates a bulk deletion of one or more access profiles. +When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. +This endpoint can only bulk delete up to a limit of 50 access profiles per request. +By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. +A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they're able to administer. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | AccessProfileBulkDeleteRequest | [**AccessProfileBulkDeleteRequest**](../models/access-profile-bulk-delete-request) | True | + +### Return type +[**AccessProfileBulkDeleteResponse**](../models/access-profile-bulk-delete-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returned only if **bestEffortOnly** is **false**, and one or more Access Profiles are in use. | AccessProfileBulkDeleteResponse +202 | Returned if at least one deletion will be performed. | AccessProfileBulkDeleteResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$AccessProfileBulkDeleteRequest = @"{ + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true +}"@ + +# Delete Access Profile(s) + +try { + $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest + Remove-AccessProfilesInBulk-AccessProfileBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-AccessProfilesInBulk -AccessProfileBulkDeleteRequest $AccessProfileBulkDeleteRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-AccessProfilesInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-access-profile +This API returns an Access Profile by its ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Access Profile + +### Return type +[**AccessProfile**](../models/access-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An AccessProfile | AccessProfile +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile + +# Get an Access Profile + +try { + Get-AccessProfile-Id $Id + + # Below is a request that includes all optional parameters + # Get-AccessProfile -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-access-profile-entitlements +Use this API to get a list of an access profile's entitlements. +A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile. +>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the access profile containing the entitlements. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** + +### Return type +[**Entitlement[]**](../models/entitlement) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of entitlements. | Entitlement[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements. +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'attribute eq "memberOf"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + +# List Access Profile's Entitlements + +try { + 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 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessProfileEntitlements" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-access-profiles +Use this API to get a list of access profiles. +>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | ForSubadmin | **String** | (optional) | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin. + Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Composite operators supported: *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** + Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. + Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. + +### Return type +[**AccessProfile[]**](../models/access-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of access profiles. | AccessProfile[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin. (optional) +$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'name eq "SailPoint Support"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Composite operators supported: *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) +$ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) +$IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + +# List Access Profiles + +try { + Get-AccessProfiles + + # Below is a request that includes all optional parameters + # Get-AccessProfiles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessProfiles" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-access-profile +This API updates an existing Access Profile. The following fields are patchable: + +**name** + +**description** + +**enabled** + +**owner** + +**requestable** + +**accessRequestConfig** + +**revokeRequestConfig** + +**segments** + +**entitlements** + +**provisioningCriteria** + +**source** (must be updated with entitlements belonging to new source in the same API call) + +If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example "Replace Source" in the examples dropdown. + +A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. +> The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. + +> You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Access Profile to patch + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**AccessProfile**](../models/access-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the Access Profile as updated. | AccessProfile +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | + + +# Patch a specified Access Profile + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AccessProfile-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AccessProfile -Id $Id -JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AccessProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/AccessRequestApprovalsApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/AccessRequestApprovalsApi.md new file mode 100644 index 000000000..4c4a6d993 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/AccessRequestApprovalsApi.md @@ -0,0 +1,348 @@ + +--- +id: access-request-approvals +title: AccessRequestApprovals +pagination_label: AccessRequestApprovals +sidebar_label: AccessRequestApprovals +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestApprovals', 'AccessRequestApprovals'] +slug: /tools/sdk/powershell/v3/methods/access-request-approvals +tags: ['SDK', 'Software Development Kit', 'AccessRequestApprovals', 'AccessRequestApprovals'] +--- + +# AccessRequestApprovals + Use this API to implement and customize access request approval functionality. +With this functionality in place, administrators can delegate qualified users to review users' requests for access or managers' requests to revoke team members' access to applications, entitlements, or roles. +This enables more qualified users to review access requests and the others to spend their time on other tasks. + +In Identity Security Cloud, users can request access to applications, entitlements, and roles, and managers can request that team members' access be revoked. +For applications and entitlements, administrators can set access profiles to require approval from the access profile owner, the application owner, the source owner, the requesting user's manager, or a governance group for access to be granted or revoked. +For roles, administrators can also set roles to allow access requests and require approval from the role owner, the requesting user's manager, or a governance group for access to be granted or revoked. +If the administrator designates a governance group as the required approver, any governance group member can approve the requests. + +When a user submits an access request, Identity Security Cloud sends the first required approver in the queue an email notification, based on the access request configuration's approval and reminder escalation configuration. + +In Approvals in Identity Security Cloud, required approvers can view pending access requests under the Requested tab and approve or deny them, or the approvers can reassign the requests to different reviewers for approval. +If the required approver approves the request and is the only reviewer required, Identity Security Cloud grants or revokes access, based on the request. +If multiple reviewers are required, Identity Security Cloud sends the request to the next reviewer in the queue, based on the access request configuration's approval reminder and escalation configuration. +The required approver can then view any completed access requests under the Reviewed tab. + +Refer to [Access Requests](https://documentation.sailpoint.com/saas/help/requests/index.html) for more information about access request approvals. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Approve-AccessRequest**](#approve-access-request) | **POST** `/access-request-approvals/{approvalId}/approve` | Approve Access Request Approval +[**Invoke-ForwardAccessRequest**](#forward-access-request) | **POST** `/access-request-approvals/{approvalId}/forward` | Forward Access Request Approval +[**Get-AccessRequestApprovalSummary**](#get-access-request-approval-summary) | **GET** `/access-request-approvals/approval-summary` | Get Access Requests Approvals Number +[**Get-CompletedApprovals**](#list-completed-approvals) | **GET** `/access-request-approvals/completed` | Completed Access Request Approvals List +[**Get-PendingApprovals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending Access Request Approvals List +[**Deny-AccessRequest**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval + +## approve-access-request +Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ApprovalId | **String** | True | Approval ID. + Body | CommentDto | [**CommentDto**](../models/comment-dto) | (optional) | Reviewer's comment. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. +$CommentDto = @"{ + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." +}"@ + +# Approve Access Request Approval + +try { + Approve-AccessRequest-ApprovalId $ApprovalId + + # Below is a request that includes all optional parameters + # Approve-AccessRequest -ApprovalId $ApprovalId -CommentDto $CommentDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-AccessRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## forward-access-request +Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ApprovalId | **String** | True | Approval ID. + Body | ForwardApprovalDto | [**ForwardApprovalDto**](../models/forward-approval-dto) | True | Information about the forwarded approval. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. +$ForwardApprovalDto = @"{ + "newOwnerId" : "2c91808568c529c60168cca6f90c1314", + "comment" : "2c91808568c529c60168cca6f90c1313" +}"@ + +# Forward Access Request Approval + +try { + $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto + Invoke-ForwardAccessRequest-ApprovalId $ApprovalId -ForwardApprovalDto $Result + + # Below is a request that includes all optional parameters + # Invoke-ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $ForwardApprovalDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ForwardAccessRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-access-request-approval-summary +Use this API to return the number of pending, approved and rejected access requests approvals. See the "owner-id" query parameter for authorization information. info. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | OwnerId | **String** | (optional) | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. + Query | FromDate | **String** | (optional) | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. + +### Return type +[**ApprovalSummary**](../models/approval-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Number of pending, approved, rejected access request approvals. | ApprovalSummary +400 | Client Error - Returned if the query parameter is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OwnerId = "2c91808568c529c60168cca6f90c1313" # String | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) +$FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + +# Get Access Requests Approvals Number + +try { + Get-AccessRequestApprovalSummary + + # Below is a request that includes all optional parameters + # Get-AccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessRequestApprovalSummary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-completed-approvals +This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | OwnerId | **String** | (optional) | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** + +### Return type +[**CompletedApproval[]**](../models/completed-approval) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Completed Approvals. | CompletedApproval[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) +$Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + +# Completed Access Request Approvals List + +try { + Get-CompletedApprovals + + # Below is a request that includes all optional parameters + # Get-CompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedApprovals" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-pending-approvals +This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | OwnerId | **String** | (optional) | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** + +### Return type +[**PendingApproval[]**](../models/pending-approval) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Pending Approvals. | PendingApproval[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional) +$Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + +# Pending Access Request Approvals List + +try { + Get-PendingApprovals + + # Below is a request that includes all optional parameters + # Get-PendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PendingApprovals" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## reject-access-request +Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ApprovalId | **String** | True | Approval ID. + Body | CommentDto | [**CommentDto**](../models/comment-dto) | True | Reviewer's comment. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. +$CommentDto = @"{ + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." +}"@ + +# Reject Access Request Approval + +try { + $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto + Deny-AccessRequest-ApprovalId $ApprovalId -CommentDto $Result + + # Below is a request that includes all optional parameters + # Deny-AccessRequest -ApprovalId $ApprovalId -CommentDto $CommentDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-AccessRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/AccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/AccessRequestsApi.md new file mode 100644 index 000000000..1acc36955 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/AccessRequestsApi.md @@ -0,0 +1,385 @@ + +--- +id: access-requests +title: AccessRequests +pagination_label: AccessRequests +sidebar_label: AccessRequests +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequests', 'AccessRequests'] +slug: /tools/sdk/powershell/v3/methods/access-requests +tags: ['SDK', 'Software Development Kit', 'AccessRequests', 'AccessRequests'] +--- + +# AccessRequests + Use this API to implement and customize access request functionality. +With this functionality in place, users can request access to applications, entitlements, or roles, and managers can request that team members' access be revoked. +This allows users to get access to the tools they need quickly and securely, and it allows managers to take away access to those tools. + +Identity Security Cloud's Access Request service allows end users to request access that requires approval before it can be granted to users and enables qualified users to review those requests and approve or deny them. + +In the Request Center in Identity Security Cloud, users can view available applications, roles, and entitlements and request access to them. +If the requested tools requires approval, the requests appear as 'Pending' under the My Requests tab until the required approver approves, rejects, or cancels them. + +Users can use My Requests to track and/or cancel the requests. + +In My Team on the Identity Security Cloud Home, managers can submit requests to revoke their team members' access. +They can use the My Requests tab under Request Center to track and/or cancel the requests. + +Refer to [Requesting Access](https://documentation.sailpoint.com/saas/user-help/requests/requesting_access.html) for more information about access requests. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Suspend-AccessRequest**](#cancel-access-request) | **POST** `/access-requests/cancel` | Cancel Access Request +[**New-AccessRequest**](#create-access-request) | **POST** `/access-requests` | Submit Access Request +[**Get-AccessRequestConfig**](#get-access-request-config) | **GET** `/access-request-config` | Get Access Request Configuration +[**Get-AccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status +[**Set-AccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration + +## cancel-access-request +This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. +In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CancelAccessRequest | [**CancelAccessRequest**](../models/cancel-access-request) | True | + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CancelAccessRequest = @"{ + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." +}"@ + +# Cancel Access Request + +try { + $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest + Suspend-AccessRequest-CancelAccessRequest $Result + + # Below is a request that includes all optional parameters + # Suspend-AccessRequest -CancelAccessRequest $CancelAccessRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-AccessRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-access-request +Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. + +Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request +has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn't return an error +if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. + +It's best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can +be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also +use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting +an access request to ensure that you aren't requesting access that is already granted. If you use this API to request access that an identity already has, the API will ignore the request. +These ignored requests do not display when you use the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) API. + +There are two types of access request: + +__GRANT_ACCESS__ +* Can be requested for multiple identities in a single request. +* Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. +* Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. +* Roles, access profiles and entitlements can be requested. +* While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. + +__REVOKE_ACCESS__ +* Can only be requested for a single identity at a time. +* You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. +* Does not support self request. Only manager can request to revoke access for their directly managed employees. +* If a `removeDate` is specified, then the access will be removed on that date and time only for roles, access profiles and entitlements. +* Roles, access profiles, and entitlements can be requested for revocation. +* Revoke requests for entitlements are limited to 1 entitlement per access request currently. +* You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. +* Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | AccessRequest | [**AccessRequest**](../models/access-request) | True | + +### Return type +[**AccessRequestResponse**](../models/access-request-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Access Request Response. | AccessRequestResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$AccessRequest = @"{ + "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + } ] +}"@ + +# Submit Access Request + +try { + $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest + New-AccessRequest-AccessRequest $Result + + # Below is a request that includes all optional parameters + # New-AccessRequest -AccessRequest $AccessRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AccessRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-access-request-config +This endpoint returns the current access-request configuration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**AccessRequestConfig**](../models/access-request-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Access Request Configuration Details. | AccessRequestConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Access Request Configuration + +try { + Get-AccessRequestConfig + + # Below is a request that includes all optional parameters + # Get-AccessRequestConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessRequestConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-access-request-status +Use this API to return a list of access request statuses based on the specified query parameters. +If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. +Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | RequestedFor | **String** | (optional) | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | RequestedBy | **String** | (optional) | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | RegardingIdentity | **String** | (optional) | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. + Query | AssignedTo | **String** | (optional) | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. + Query | Count | **Boolean** | (optional) (default to $false) | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. + Query | Offset | **Int32** | (optional) | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** + Query | RequestState | **String** | (optional) | Filter the results by the state of the request. The only valid value is *EXECUTING*. + +### Return type +[**RequestedItemStatus[]**](../models/requested-item-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of requested item statuses. | RequestedItemStatus[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) +$RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) +$RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) +$AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) +$Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) +$Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) +$Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) +$Filters = 'accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) +$Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) +$RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + +# Access Request Status + +try { + Get-AccessRequestStatus + + # Below is a request that includes all optional parameters + # Get-AccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessRequestStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-access-request-config +This endpoint replaces the current access-request configuration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | AccessRequestConfig | [**AccessRequestConfig**](../models/access-request-config) | True | + +### Return type +[**AccessRequestConfig**](../models/access-request-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Access Request Configuration Details. | AccessRequestConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$AccessRequestConfig = @"{ + "requestOnBehalfOfConfig" : { + "allowRequestOnBehalfOfEmployeeByManager" : true, + "allowRequestOnBehalfOfAnyoneByAnyone" : true + }, + "approvalReminderAndEscalationConfig" : { + "fallbackApproverRef" : { + "name" : "Alison Ferguso", + "id" : "5168015d32f890ca15812c9180835d2e", + "type" : "IDENTITY", + "email" : "alison.ferguso@identitysoon.com" + }, + "maxReminders" : 1, + "daysUntilEscalation" : 0, + "daysBetweenReminders" : 0 + }, + "autoApprovalEnabled" : true, + "entitlementRequestConfig" : { + "requestCommentsRequired" : false, + "deniedCommentsRequired" : false, + "allowEntitlementRequest" : true, + "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + }, + "reauthorizationEnabled" : true, + "approvalsMustBeExternal" : true +}"@ + +# Update Access Request Configuration + +try { + $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig + Set-AccessRequestConfig-AccessRequestConfig $Result + + # Below is a request that includes all optional parameters + # Set-AccessRequestConfig -AccessRequestConfig $AccessRequestConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-AccessRequestConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/AccountActivitiesApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/AccountActivitiesApi.md new file mode 100644 index 000000000..1683321e8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/AccountActivitiesApi.md @@ -0,0 +1,155 @@ + +--- +id: account-activities +title: AccountActivities +pagination_label: AccountActivities +sidebar_label: AccountActivities +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivities', 'AccountActivities'] +slug: /tools/sdk/powershell/v3/methods/account-activities +tags: ['SDK', 'Software Development Kit', 'AccountActivities', 'AccountActivities'] +--- + +# AccountActivities + Use this API to implement account activity tracking functionality. +With this functionality in place, users can track source account activity in Identity Security Cloud, which greatly improves traceability in the system. + +An account activity refers to a log of each action performed on a source account. This is useful for auditing the changes performed on an account throughout its life. +In Identity Security Cloud's Search, users can search for account activities and select the activity's row to get an overview of the activity's account action and view its progress, its involved sources, and its most basic metadata, such as the identity requesting the option and the recipient. + +Account activity includes most actions Identity Security Cloud completes on source accounts. Users can search in Identity Security Cloud for the following account action types: + +- Access Request: These include any access requests the source account is involved in. + +- Account Attribute Updates: These include updates to a single attribute on an account on a source. + +- Account State Update: These include locking or unlocking actions on an account on a source. + +- Certification: These include actions removing an entitlement from an account on a source as a result of the entitlement's revocation during a certification. + +- Cloud Automated `Lifecyclestate`: These include automated lifecycle state changes that result in a source account's correlated identity being assigned to a different lifecycle state. +Identity Security Cloud replaces the `Lifecyclestate` variable with the name of the lifecycle state it has moved the account's identity to. + +- Identity Attribute Update: These include updates to a source account's correlated identity attributes as the result of a provisioning action. +When you update an identity attribute that also updates an identity's lifecycle state, the cloud automated `Lifecyclestate` event also displays. +Account Activity does not include attribute updates that occur as a result of aggregation. + +- Identity Refresh: These include correlated identity refreshes that occur for an account on a source whenever the account's correlated identity profile gets a new role or updates. +These also include refreshes that occur whenever Identity Security Cloud assigns an application to the account's correlated identity based on the application's being assigned to All Users From Source or Specific Users From Source. + +- Lifecycle State Refresh: These include the actions that took place when a lifecycle state changed. This event only occurs after a cloud automated `Lifecyclestate` change or a lifecycle state change. + +- Lifecycle State Change: These include the account activities that result from an identity's manual assignment to a null lifecycle state. + +- Password Change: These include password changes on sources. + +Refer to [Account Activity](https://documentation.sailpoint.com/saas/help/search/index.html#account-activity) for more information about account activities. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-AccountActivity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get an Account Activity +[**Get-AccountActivities**](#list-account-activities) | **GET** `/account-activities` | List Account Activities + +## get-account-activity +This gets a single account activity by its id. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The account activity id + +### Return type +[**AccountActivity**](../models/account-activity) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An account activity object | AccountActivity +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id + +# Get an Account Activity + +try { + Get-AccountActivity-Id $Id + + # Below is a request that includes all optional parameters + # Get-AccountActivity -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountActivity" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-account-activities +This gets a collection of account activities that satisfy the given query parameters. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | RequestedFor | **String** | (optional) | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | RequestedBy | **String** | (optional) | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. + Query | RegardingIdentity | **String** | (optional) | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** + +### Return type +[**AccountActivity[]**](../models/account-activity) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of account activities | AccountActivity[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RequestedFor = "2c91808568c529c60168cca6f90c1313" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) +$RequestedBy = "2c91808568c529c60168cca6f90c1313" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) +$RegardingIdentity = "2c91808568c529c60168cca6f90c1313" # String | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'type eq "Identity Refresh"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) +$Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) + +# List Account Activities + +try { + Get-AccountActivities + + # Below is a request that includes all optional parameters + # Get-AccountActivities -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountActivities" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/AccountUsagesApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/AccountUsagesApi.md new file mode 100644 index 000000000..58735d49d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/AccountUsagesApi.md @@ -0,0 +1,75 @@ + +--- +id: account-usages +title: AccountUsages +pagination_label: AccountUsages +sidebar_label: AccountUsages +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUsages', 'AccountUsages'] +slug: /tools/sdk/powershell/v3/methods/account-usages +tags: ['SDK', 'Software Development Kit', 'AccountUsages', 'AccountUsages'] +--- + +# AccountUsages + Use this API to implement account usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' source accounts are being used. +This allows organizations to get the information they need to start optimizing and securing source account usage. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-UsagesByAccountId**](#get-usages-by-account-id) | **GET** `/account-usages/{accountId}/summaries` | Returns account usage insights + +## get-usages-by-account-id +This API returns a summary of account usage insights for past 12 months. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | AccountId | **String** | True | ID of IDN account + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** + +### Return type +[**AccountUsage[]**](../models/account-usage) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Summary of account usage insights for past 12 months. | AccountUsage[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + +# Returns account usage insights + +try { + 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 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesByAccountId" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/AccountsApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/AccountsApi.md new file mode 100644 index 000000000..62b71d6b7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/AccountsApi.md @@ -0,0 +1,621 @@ + +--- +id: accounts +title: Accounts +pagination_label: Accounts +sidebar_label: Accounts +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Accounts', 'Accounts'] +slug: /tools/sdk/powershell/v3/methods/accounts +tags: ['SDK', 'Software Development Kit', 'Accounts', 'Accounts'] +--- + +# Accounts + Use this API to implement and customize account functionality. +With this functionality in place, administrators can manage users' access across sources in Identity Security Cloud. + +In Identity Security Cloud, an account refers to a user's account on a supported source. +This typically includes a unique identifier for the user, a unique password, a set of permissions associated with the source and a set of attributes. Identity Security Cloud loads accounts through the creation of sources in Identity Security Cloud. + +Administrators can correlate users' identities with the users' accounts on the different sources they use. +This allows Identity Security Cloud to govern the access of identities and all their correlated accounts securely and cohesively. + +To view the accounts on a source and their correlated identities, administrators can use the Connections drop-down menu, select Sources, select the relevant source, and select its Account tab. + +To view and edit source account statuses for an identity in Identity Security Cloud, administrators can use the Identities drop-down menu, select Identity List, select the relevant identity, and select its Accounts tab. +Administrators can toggle an account's Actions to aggregate the account, enable/disable it, unlock it, or remove it from the identity. + +Accounts can have the following statuses: + +- Enabled: The account is enabled. The user can access it. + +- Disabled: The account is disabled, and the user cannot access it, but the identity is not disabled in Identity Security Cloud. This can occur when an administrator disables the account or when the user's lifecycle state changes. + +- Locked: The account is locked. This may occur when someone has entered an incorrect password for the account too many times. + +- Pending: The account is currently updating. This status typically lasts seconds. + +Administrators can select the source account to view its attributes, entitlements, and the last time the account's password was changed. + +Refer to [Managing User Accounts](https://documentation.sailpoint.com/saas/help/common/users/user_access.html#managing-user-accounts) for more information about accounts. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-Account**](#create-account) | **POST** `/accounts` | Create Account +[**Remove-Account**](#delete-account) | **DELETE** `/accounts/{id}` | Delete Account +[**Disable-Account**](#disable-account) | **POST** `/accounts/{id}/disable` | Disable Account +[**Enable-Account**](#enable-account) | **POST** `/accounts/{id}/enable` | Enable Account +[**Get-Account**](#get-account) | **GET** `/accounts/{id}` | Account Details +[**Get-AccountEntitlements**](#get-account-entitlements) | **GET** `/accounts/{id}/entitlements` | Account Entitlements +[**Get-Accounts**](#list-accounts) | **GET** `/accounts` | Accounts List +[**Send-Account**](#put-account) | **PUT** `/accounts/{id}` | Update Account +[**Submit-ReloadAccount**](#submit-reload-account) | **POST** `/accounts/{id}/reload` | Reload Account +[**Unlock-Account**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account +[**Update-Account**](#update-account) | **PATCH** `/accounts/{id}` | Update Account + +## create-account +Submit an account creation task - the API then returns the task ID. + +You must include the `sourceId` where the account will be created in the `attributes` object. + +This endpoint creates an account on the source record in your ISC tenant. +This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. + +However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. +The endpoint doesn't actually provision the account on the target source, which means that if the account doesn't also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. + +By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | AccountAttributesCreate | [**AccountAttributesCreate**](../models/account-attributes-create) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Async task details. | AccountsAsyncResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$AccountAttributesCreate = @"{ + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } +}"@ + +# Create Account + +try { + $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate + New-Account-AccountAttributesCreate $Result + + # Below is a request that includes all optional parameters + # New-Account -AccountAttributesCreate $AccountAttributesCreate +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Account" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-account +Use this API to delete an account. +This endpoint submits an account delete task and returns the task ID. +This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. +>**NOTE: You can only delete accounts from sources of the "DelimitedFile" type.** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Account ID. + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Async task details. | AccountsAsyncResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + +# Delete Account + +try { + Remove-Account-Id $Id + + # Below is a request that includes all optional parameters + # Remove-Account -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Account" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## disable-account +This API submits a task to disable the account and returns the task ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The account id + Body | AccountToggleRequest | [**AccountToggleRequest**](../models/account-toggle-request) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Async task details | AccountsAsyncResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id +$AccountToggleRequest = @"{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" +}"@ + +# Disable Account + +try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Disable-Account-Id $Id -AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Disable-Account -Id $Id -AccountToggleRequest $AccountToggleRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-Account" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## enable-account +This API submits a task to enable account and returns the task ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The account id + Body | AccountToggleRequest | [**AccountToggleRequest**](../models/account-toggle-request) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Async task details | AccountsAsyncResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id +$AccountToggleRequest = @"{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" +}"@ + +# Enable Account + +try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Enable-Account-Id $Id -AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Enable-Account -Id $Id -AccountToggleRequest $AccountToggleRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-Account" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-account +Use this API to return the details for a single account by its ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Account ID. + +### Return type +[**Account**](../models/account) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Account object. | Account +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + +# Account Details + +try { + Get-Account-Id $Id + + # Below is a request that includes all optional parameters + # Get-Account -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Account" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-account-entitlements +This API returns entitlements of the account. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The account id + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**EntitlementDto[]**](../models/entitlement-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An array of account entitlements | EntitlementDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Account Entitlements + +try { + Get-AccountEntitlements-Id $Id + + # Below is a request that includes all optional parameters + # Get-AccountEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountEntitlements" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-accounts +List accounts. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | DetailLevel | **String** | (optional) | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** + +### Return type +[**Account[]**](../models/account) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of account objects. | Account[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) +$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (optional) +$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + +# Accounts List + +try { + Get-Accounts + + # Below is a request that includes all optional parameters + # Get-Accounts -Limit $Limit -Offset $Offset -Count $Count -DetailLevel $DetailLevel -Filters $Filters -Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Accounts" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-account +Use this API to update an account with a PUT request. + +This endpoint submits an account update task and returns the task ID. + +>**Note: You can only use this PUT endpoint to update accounts from flat file sources.** + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Account ID. + Body | AccountAttributes | [**AccountAttributes**](../models/account-attributes) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Async task details. | AccountsAsyncResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. +$AccountAttributes = @"{ + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } +}"@ + +# Update Account + +try { + $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes + Send-Account-Id $Id -AccountAttributes $Result + + # Below is a request that includes all optional parameters + # Send-Account -Id $Id -AccountAttributes $AccountAttributes +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Account" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## submit-reload-account +This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The account id + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Async task details | AccountsAsyncResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + +# Reload Account + +try { + Submit-ReloadAccount-Id $Id + + # Below is a request that includes all optional parameters + # Submit-ReloadAccount -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-ReloadAccount" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## unlock-account +This API submits a task to unlock an account and returns the task ID. +To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The account ID. + Body | AccountUnlockRequest | [**AccountUnlockRequest**](../models/account-unlock-request) | True | + +### Return type +[**AccountsAsyncResult**](../models/accounts-async-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Async task details | AccountsAsyncResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. +$AccountUnlockRequest = @"{ + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false +}"@ + +# Unlock Account + +try { + $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest + Unlock-Account-Id $Id -AccountUnlockRequest $Result + + # Below is a request that includes all optional parameters + # Unlock-Account -Id $Id -AccountUnlockRequest $AccountUnlockRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-Account" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-account +Use this API to update account details. + +This API supports updating an account's correlation by modifying the `identityId` and `manuallyCorrelated` fields. +To reassign an account from one identity to another, replace the current `identityId` with a new value. +If the account you're assigning was provisioned by Identity Security Cloud (ISC), it's possible for ISC to create a new account +for the previous identity as soon as the account is moved. If the account you're assigning is authoritative, +this causes the previous identity to become uncorrelated and can even result in its deletion. +All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. + +>**Note:** The `attributes` field can only be modified for flat file accounts. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Account ID. + Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | True | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. +$RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"[{op=remove, path=/identityId}]"@ # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +# Update Account + +try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-Account-Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-Account -Id $Id -RequestBody $RequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Account" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/ApplicationDiscoveryApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/ApplicationDiscoveryApi.md new file mode 100644 index 000000000..494beee9f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/ApplicationDiscoveryApi.md @@ -0,0 +1,163 @@ + +--- +id: application-discovery +title: ApplicationDiscovery +pagination_label: ApplicationDiscovery +sidebar_label: ApplicationDiscovery +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApplicationDiscovery', 'ApplicationDiscovery'] +slug: /tools/sdk/powershell/v3/methods/application-discovery +tags: ['SDK', 'Software Development Kit', 'ApplicationDiscovery', 'ApplicationDiscovery'] +--- + +# ApplicationDiscovery + Use this API to implement application discovery functionality. +With this functionality in place, you can discover applications within your Okta connector and receive connector recommendations by manually uploading application names. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-DiscoveredApplications**](#get-discovered-applications) | **GET** `/discovered-applications` | Get Discovered Applications for Tenant +[**Get-ManualDiscoverApplicationsCsvTemplate**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download CSV Template for Discovery +[**Send-ManualDiscoverApplicationsCsvTemplate**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload CSV to Discover Applications + +## get-discovered-applications +Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Detail | **String** | (optional) | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. + Query | Filter | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** + +### Return type +[**GetDiscoveredApplications200ResponseInner[]**](../models/get-discovered-applications200-response-inner) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of discovered applications. By default, the API returns a list of SLIM discovered applications. | GetDiscoveredApplications200ResponseInner[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) +$Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) + +# Get Discovered Applications for Tenant + +try { + Get-DiscoveredApplications + + # Below is a request that includes all optional parameters + # Get-DiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DiscoveredApplications" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-manual-discover-applications-csv-template +Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values 'Example Application' and 'Example Description'. + +The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**ManualDiscoverApplicationsTemplate**](../models/manual-discover-applications-template) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A CSV file download was successful. | ManualDiscoverApplicationsTemplate +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: text/csv, application/json + +### Example +```powershell + +# Download CSV Template for Discovery + +try { + Get-ManualDiscoverApplicationsCsvTemplate + + # Below is a request that includes all optional parameters + # Get-ManualDiscoverApplicationsCsvTemplate +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## send-manual-discover-applications-csv-template +Uploading a CSV file with application data for manual correlation to specific ISC connectors. +If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | File | **System.IO.FileInfo** | True | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The CSV has been successfully processed. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + +# Upload CSV to Discover Applications + +try { + Send-ManualDiscoverApplicationsCsvTemplate-File $File + + # Below is a request that includes all optional parameters + # Send-ManualDiscoverApplicationsCsvTemplate -File $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/AuthUsersApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/AuthUsersApi.md new file mode 100644 index 000000000..12b768591 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/AuthUsersApi.md @@ -0,0 +1,126 @@ + +--- +id: auth-users +title: AuthUsers +pagination_label: AuthUsers +sidebar_label: AuthUsers +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AuthUsers', 'AuthUsers'] +slug: /tools/sdk/powershell/v3/methods/auth-users +tags: ['SDK', 'Software Development Kit', 'AuthUsers', 'AuthUsers'] +--- + +# AuthUsers + Use this API to implement user authentication system functionality. +With this functionality in place, users can get a user's authentication system details, including their capabilities, and modify those capabilities. +The user's capabilities refer to their access to different systems, or authorization, within the tenant, like access to certifications (CERT_ADMIN) or reports (REPORT_ADMIN). +These capabilities also determine a user's access to the different APIs. +This API provides users with a way to determine a user's access and make quick and easy changes to that access. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-AuthUser**](#get-auth-user) | **GET** `/auth-users/{id}` | Auth User Details +[**Update-AuthUser**](#patch-auth-user) | **PATCH** `/auth-users/{id}` | Auth User Update + +## get-auth-user +Return the specified user's authentication system details. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Identity ID + +### Return type +[**AuthUser**](../models/auth-user) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The specified user's authentication system details. | AuthUser +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + +# Auth User Details + +try { + Get-AuthUser-Id $Id + + # Below is a request that includes all optional parameters + # Get-AuthUser -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthUser" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-auth-user +Use a PATCH request to update an existing user in the authentication system. +Use this endpoint to modify these fields: + * `capabilities` + +A '400.1.1 Illegal update attempt' detail code indicates that you attempted to PATCH a field that is not allowed. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Identity ID + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**AuthUser**](../models/auth-user) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Auth user updated. | AuthUser +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +# Auth User Update + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthUser-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthUser -Id $Id -JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthUser" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/BrandingApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/BrandingApi.md new file mode 100644 index 000000000..6461eefaa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/BrandingApi.md @@ -0,0 +1,272 @@ + +--- +id: branding +title: Branding +pagination_label: Branding +sidebar_label: Branding +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Branding', 'Branding'] +slug: /tools/sdk/powershell/v3/methods/branding +tags: ['SDK', 'Software Development Kit', 'Branding', 'Branding'] +--- + +# Branding + Use this API to implement and customize branding functionality. +With this functionality in place, administrators can get and manage existing branding items, and they can also create new branding items and configure them for use throughout Identity Security Cloud. +The Branding APIs provide administrators with a way to customize branding items. +This customization includes details like their colors, logos, and other information. +Refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html) for more information about certifications. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-BrandingItem**](#create-branding-item) | **POST** `/brandings` | Create a branding item +[**Remove-Branding**](#delete-branding) | **DELETE** `/brandings/{name}` | Delete a branding item +[**Get-Branding**](#get-branding) | **GET** `/brandings/{name}` | Get a branding item +[**Get-BrandingList**](#get-branding-list) | **GET** `/brandings` | List of branding items +[**Set-BrandingItem**](#set-branding-item) | **PUT** `/brandings/{name}` | Update a branding item + +## create-branding-item +This API endpoint creates a branding item. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | Name | **String** | True | name of branding item + | ProductName | **String** | True | product name + | ActionButtonColor | **String** | (optional) | hex value of color for action button + | ActiveLinkColor | **String** | (optional) | hex value of color for link + | NavigationColor | **String** | (optional) | hex value of color for navigation bar + | EmailFromAddress | **String** | (optional) | email from address + | LoginInformationalMessage | **String** | (optional) | login information message + | FileStandard | **System.IO.FileInfo** | (optional) | png file with logo + +### Return type +[**BrandingItem**](../models/branding-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Branding item created | BrandingItem +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$Name = "MyName" # String | name of branding item +$ProductName = "MyProductName" # String | product name +$ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) +$ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) +$NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) +$EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) +$LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) +$FileStandard = # System.IO.FileInfo | png file with logo (optional) + +# Create a branding item + +try { + 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 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BrandingItem" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-branding +This API endpoint delete information for an existing branding item by name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Name | **String** | True | The name of the branding item to be deleted + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Name = "default" # String | The name of the branding item to be deleted + +# Delete a branding item + +try { + Remove-Branding-Name $Name + + # Below is a request that includes all optional parameters + # Remove-Branding -Name $Name +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Branding" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-branding +This API endpoint retrieves information for an existing branding item by name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Name | **String** | True | The name of the branding item to be retrieved + +### Return type +[**BrandingItem**](../models/branding-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A branding item object | BrandingItem +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Name = "default" # String | The name of the branding item to be retrieved + +# Get a branding item + +try { + Get-Branding-Name $Name + + # Below is a request that includes all optional parameters + # Get-Branding -Name $Name +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Branding" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-branding-list +This API endpoint returns a list of branding items. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**BrandingItem[]**](../models/branding-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of branding items. | BrandingItem[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List of branding items + +try { + Get-BrandingList + + # Below is a request that includes all optional parameters + # Get-BrandingList +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BrandingList" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-branding-item +This API endpoint updates information for an existing branding item. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Name | **String** | True | The name of the branding item to be retrieved + | Name2 | **String** | True | name of branding item + | ProductName | **String** | True | product name + | ActionButtonColor | **String** | (optional) | hex value of color for action button + | ActiveLinkColor | **String** | (optional) | hex value of color for link + | NavigationColor | **String** | (optional) | hex value of color for navigation bar + | EmailFromAddress | **String** | (optional) | email from address + | LoginInformationalMessage | **String** | (optional) | login information message + | FileStandard | **System.IO.FileInfo** | (optional) | png file with logo + +### Return type +[**BrandingItem**](../models/branding-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Branding item updated | BrandingItem +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$Name = "default" # String | The name of the branding item to be retrieved +$Name2 = "Name_example" # String | name of branding item +$ProductName = "MyProductName" # String | product name +$ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) +$ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) +$NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) +$EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) +$LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) +$FileStandard = # System.IO.FileInfo | png file with logo (optional) + +# Update a branding item + +try { + 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 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BrandingItem" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/CertificationCampaignFiltersApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/CertificationCampaignFiltersApi.md new file mode 100644 index 000000000..add9342b2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/CertificationCampaignFiltersApi.md @@ -0,0 +1,310 @@ + +--- +id: certification-campaign-filters +title: CertificationCampaignFilters +pagination_label: CertificationCampaignFilters +sidebar_label: CertificationCampaignFilters +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationCampaignFilters', 'CertificationCampaignFilters'] +slug: /tools/sdk/powershell/v3/methods/certification-campaign-filters +tags: ['SDK', 'Software Development Kit', 'CertificationCampaignFilters', 'CertificationCampaignFilters'] +--- + +# CertificationCampaignFilters + Use this API to implement the certification campaign filter functionality. These filters can be used to create a certification campaign that includes a subset of your entitlements or users to certify. + +For example, if for a certification campaign an organization wants to certify only specific users or entitlements, then those can be included/excluded on the basis of campaign filters. + +For more information about creating a campaign filter, refer to [Creating a Campaign Filter](https://documentation.sailpoint.com/saas/help/certs/campaign_filters.html#creating-a-campaign-filter) + +You can create campaign filters using any of the following criteria types: + +- Access Profile : This criteria type includes or excludes access profiles from a campaign. + +- Account Attribute : This criteria type includes or excludes certification items that match a specified value in an account attribute. + +- Entitlement : This criteria type includes or excludes entitlements from a campaign. + +- Identity : This criteria type includes or excludes specific identities from your campaign. + +- Identity Attribute : This criteria type includes or excludes identities based on whether they have an identity attribute that matches criteria you've chosen. + +- Role : This criteria type includes or excludes roles, as opposed to identities. + +- Source : This criteria type includes or excludes entitlements from a source you select. + +For more information about these criteria types, refer to [Types of Campaign Filters](https://documentation.sailpoint.com/saas/help/certs/campaign_filters.html#types-of-campaign-filters) + +Once the campaign filter is created, it can be linked while creating the campaign. The generated campaign will have the items to review as per the campaign filter. + +For example, An inclusion campaign filter is created with a source of Source 1, an operation of Equals, and an entitlement of Entitlement 1. When this filter is selected, only users who have Entitlement 1 are included in the campaign, and only Entitlement 1 is shown in the certification. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-CampaignFilter**](#create-campaign-filter) | **POST** `/campaign-filters` | Create Campaign Filter +[**Remove-CampaignFilters**](#delete-campaign-filters) | **POST** `/campaign-filters/delete` | Deletes Campaign Filters +[**Get-CampaignFilterById**](#get-campaign-filter-by-id) | **GET** `/campaign-filters/{id}` | Get Campaign Filter by ID +[**Get-CampaignFilters**](#list-campaign-filters) | **GET** `/campaign-filters` | List Campaign Filters +[**Update-CampaignFilter**](#update-campaign-filter) | **POST** `/campaign-filters/{id}` | Updates a Campaign Filter + +## create-campaign-filter +Use this API to create a campaign filter based on filter details and criteria. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CampaignFilterDetails | [**CampaignFilterDetails**](../models/campaign-filter-details) | True | + +### Return type +[**CampaignFilterDetails**](../models/campaign-filter-details) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Created successfully. | CampaignFilterDetails +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CampaignFilterDetails = @"{ + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] +}"@ + +# Create Campaign Filter + +try { + $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails + New-CampaignFilter-CampaignFilterDetails $Result + + # Below is a request that includes all optional parameters + # New-CampaignFilter -CampaignFilterDetails $CampaignFilterDetails +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CampaignFilter" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-campaign-filters +Deletes campaign filters whose Ids are specified in the provided list of campaign filter Ids. Authorized callers must be an ORG_ADMIN or a CERT_ADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | RequestBody | **[]String** | True | A json list of IDs of campaign filters to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filters to delete. + $RequestBody = @""@ # String[] | A json list of IDs of campaign filters to delete. + + +# Deletes Campaign Filters + +try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-CampaignFilters-RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-CampaignFilters -RequestBody $RequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignFilters" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-campaign-filter-by-id +Retrieves information for an existing campaign filter using the filter's ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the campaign filter to be retrieved. + +### Return type +[**CampaignFilterDetails**](../models/campaign-filter-details) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A campaign filter object. | CampaignFilterDetails +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved. + +# Get Campaign Filter by ID + +try { + Get-CampaignFilterById-Id $Id + + # Below is a request that includes all optional parameters + # Get-CampaignFilterById -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignFilterById" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-campaign-filters +Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Start | **Int32** | (optional) (default to 0) | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | IncludeSystemFilters | **Boolean** | (optional) (default to $true) | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. + +### Return type +[**ListCampaignFilters200Response**](../models/list-campaign-filters200-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of campaign filter objects. | ListCampaignFilters200Response +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Start = 0 # Int32 | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$IncludeSystemFilters = $true # Boolean | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to $true) + +# List Campaign Filters + +try { + Get-CampaignFilters + + # Below is a request that includes all optional parameters + # Get-CampaignFilters -Limit $Limit -Start $Start -IncludeSystemFilters $IncludeSystemFilters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignFilters" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-campaign-filter +Updates an existing campaign filter using the filter's ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | FilterId | **String** | True | The ID of the campaign filter being modified. + Body | CampaignFilterDetails | [**CampaignFilterDetails**](../models/campaign-filter-details) | True | A campaign filter details with updated field values. + +### Return type +[**CampaignFilterDetails**](../models/campaign-filter-details) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Created successfully. | CampaignFilterDetails +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$FilterId = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter being modified. +$CampaignFilterDetails = @"{ + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] +}"@ + +# Updates a Campaign Filter + +try { + $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails + Update-CampaignFilter-FilterId $FilterId -CampaignFilterDetails $Result + + # Below is a request that includes all optional parameters + # Update-CampaignFilter -FilterId $FilterId -CampaignFilterDetails $CampaignFilterDetails +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-CampaignFilter" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/CertificationCampaignsApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/CertificationCampaignsApi.md new file mode 100644 index 000000000..d09526d5a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/CertificationCampaignsApi.md @@ -0,0 +1,1404 @@ + +--- +id: certification-campaigns +title: CertificationCampaigns +pagination_label: CertificationCampaigns +sidebar_label: CertificationCampaigns +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationCampaigns', 'CertificationCampaigns'] +slug: /tools/sdk/powershell/v3/methods/certification-campaigns +tags: ['SDK', 'Software Development Kit', 'CertificationCampaigns', 'CertificationCampaigns'] +--- + +# CertificationCampaigns + Use this API to implement certification campaign functionality. +With this functionality in place, administrators can create, customize, and manage certification campaigns for their organizations' use. +Certification campaigns provide Identity Security Cloud users with an interactive review process they can use to identify and verify access to systems. +Campaigns help organizations reduce risk of inappropriate access and satisfy audit requirements. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification campaign as a way of showing that a user's access has been reviewed and approved by multiple managers. +Once this campaign has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Identity Security Cloud provides two simple campaign types users can create without using search queries, Manager and Source Owner campaigns: + +You can create these types of campaigns without using any search queries in Identity Security Cloud: + +- ManagerCampaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access is certified by their managers. +You only need to provide a name and description to create one. + +- Source Owner Campaign: Identity Security Cloud provides this campaign type as a way to ensure that an identity's access to a source is certified by its source owners. +You only need to provide a name and description to create one. +You can specify the sources whose owners you want involved or just run it across all sources. + +For more information about these campaign types, refer to [Starting a Manager or Source Owner Campaign](https://documentation.sailpoint.com/saas/help/certs/starting_campaign.html). + +One useful way to create certification campaigns in Identity Security Cloud is to use a specific search and then run a campaign on the results returned by that search. +This allows you to be much more specific about whom you are certifying in your campaigns and what access you are certifying in your campaigns. +For example, you can search for all identities who are managed by "Amanda.Ross" and also have the access to the "Accounting" role and then run a certification campaign based on that search to ensure that the returned identities are appropriately certified. + +You can use Identity Security Cloud search queries to create these types of campaigns: + +- Identities: Use this campaign type to review and revoke access items for specific identities. +You can either build a search query and create a campaign certifying all identities returned by that query, or you can search for individual identities and add those identities to the certification campaign. + +- Access Items: Use this campaign type to review and revoke a set of roles, access profiles, or entitlements from the identities that have them. +You can either build a search query and create a campaign certifying all access items returned by that query, or you can search for individual access items and add those items to the certification campaign. + +- Role Composition: Use this campaign type to review a role's composition, including its title, description, and membership criteria. +You can either build a search query and create a campaign certifying all roles returned by that query, or you can search for individual roles and add those roles to the certification campaign. + +- Uncorrelated Accounts: Use this campaign type to certify source accounts that aren't linked to an authoritative identity in Identity Security Cloud. +You can use this campaign type to view all the uncorrelated accounts for a source and certify them. + +For more information about search-based campaigns, refer to [Starting a Campaign from Search](https://documentation.sailpoint.com/saas/help/certs/starting_search_campaign.html). + +Once you have generated your campaign, it becomes available for preview. +An administrator can review the campaign and make changes, or if it's ready and accurate, activate it. + +Once the campaign is active, organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers. +Those reviewers can view any of the certifications they either need to review (active) or have already reviewed (completed). + +When a certification campaign is in progress, certification reviewers see the listed active certifications whose involved identities they can review. +Reviewers can then make decisions to grant or revoke access, as well as reassign the certification to another reviewer. If the reviewer chooses this option, they must provide a reason for reassignment in the form of a comment. + +Once a reviewer has made decisions on all the certification's involved access items, he or she must "Sign Off" to complete the review process. +Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. + +Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. +In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. +In this situation, the certification campaign completes once all the remediation requests are completed. + +The end of a certification campaign is determined by its deadline, its completion status, or by an administrator's decision. + +For more information about certifications and certification campaigns, refer to [Certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html). + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Complete-Campaign**](#complete-campaign) | **POST** `/campaigns/{id}/complete` | Complete a Campaign +[**New-Campaign**](#create-campaign) | **POST** `/campaigns` | Create a campaign +[**New-CampaignTemplate**](#create-campaign-template) | **POST** `/campaign-templates` | Create a Campaign Template +[**Remove-CampaignTemplate**](#delete-campaign-template) | **DELETE** `/campaign-templates/{id}` | Delete a Campaign Template +[**Remove-CampaignTemplateSchedule**](#delete-campaign-template-schedule) | **DELETE** `/campaign-templates/{id}/schedule` | Delete Campaign Template Schedule +[**Remove-Campaigns**](#delete-campaigns) | **POST** `/campaigns/delete` | Delete Campaigns +[**Get-ActiveCampaigns**](#get-active-campaigns) | **GET** `/campaigns` | List Campaigns +[**Get-Campaign**](#get-campaign) | **GET** `/campaigns/{id}` | Get Campaign +[**Get-CampaignReports**](#get-campaign-reports) | **GET** `/campaigns/{id}/reports` | Get Campaign Reports +[**Get-CampaignReportsConfig**](#get-campaign-reports-config) | **GET** `/campaigns/reports-configuration` | Get Campaign Reports Configuration +[**Get-CampaignTemplate**](#get-campaign-template) | **GET** `/campaign-templates/{id}` | Get a Campaign Template +[**Get-CampaignTemplateSchedule**](#get-campaign-template-schedule) | **GET** `/campaign-templates/{id}/schedule` | Get Campaign Template Schedule +[**Get-CampaignTemplates**](#get-campaign-templates) | **GET** `/campaign-templates` | List Campaign Templates +[**Move-**](#move) | **POST** `/campaigns/{id}/reassign` | Reassign Certifications +[**Update-CampaignTemplate**](#patch-campaign-template) | **PATCH** `/campaign-templates/{id}` | Update a Campaign Template +[**Set-CampaignReportsConfig**](#set-campaign-reports-config) | **PUT** `/campaigns/reports-configuration` | Set Campaign Reports Configuration +[**Set-CampaignTemplateSchedule**](#set-campaign-template-schedule) | **PUT** `/campaign-templates/{id}/schedule` | Set Campaign Template Schedule +[**Start-Campaign**](#start-campaign) | **POST** `/campaigns/{id}/activate` | Activate a Campaign +[**Start-CampaignRemediationScan**](#start-campaign-remediation-scan) | **POST** `/campaigns/{id}/run-remediation-scan` | Run Campaign Remediation Scan +[**Start-CampaignReport**](#start-campaign-report) | **POST** `/campaigns/{id}/run-report/{type}` | Run Campaign Report +[**Start-GenerateCampaignTemplate**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a Campaign from Template +[**Update-Campaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a Campaign + +## complete-campaign +:::caution + +This endpoint will run successfully for any campaigns that are **past due**. + +This endpoint will return a content error if the campaign is **not past due**. + +::: + +Use this API to complete a certification campaign. This functionality is provided to admins so that they +can complete a certification even if all items have not been completed. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Campaign ID. + Body | CampaignCompleteOptions | [**CampaignCompleteOptions**](../models/campaign-complete-options) | (optional) | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. +$CampaignCompleteOptions = @"{ + "autoCompleteAction" : "REVOKE" +}"@ + +# Complete a Campaign + +try { + Complete-Campaign-Id $Id + + # Below is a request that includes all optional parameters + # Complete-Campaign -Id $Id -CampaignCompleteOptions $CampaignCompleteOptions +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-Campaign" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-campaign +Use this API to create a certification campaign with the information provided in the request body. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Campaign | [**Campaign**](../models/campaign) | True | + +### Return type +[**Campaign**](../models/campaign) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | This response indicates that the requested campaign was successfully created, and the API returns its representation. | Campaign +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Campaign = @"{ + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" +}"@ + +# Create a campaign + +try { + $Result = ConvertFrom-JsonToCampaign -Json $Campaign + New-Campaign-Campaign $Result + + # Below is a request that includes all optional parameters + # New-Campaign -Campaign $Campaign +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Campaign" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-campaign-template +Use this API to create a certification campaign template based on campaign. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CampaignTemplate | [**CampaignTemplate**](../models/campaign-template) | True | + +### Return type +[**CampaignTemplate**](../models/campaign-template) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Created successfully. | CampaignTemplate +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CampaignTemplate = @"{ + "ownerRef" : { + "name" : "Mister Manager", + "id" : "2c918086676d3e0601677611dbde220f", + "type" : "IDENTITY", + "email" : "mr.manager@example.com" + }, + "deadlineDuration" : "P2W", + "created" : "2020-03-05T22:44:00.364Z", + "scheduled" : false, + "name" : "Manager Campaign Template", + "description" : "Template for the annual manager campaign.", + "modified" : "2020-03-05T22:52:09.969Z", + "campaign" : { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }, + "id" : "2c9079b270a266a60170a277bb960008" +}"@ + +# Create a Campaign Template + +try { + $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate + New-CampaignTemplate-CampaignTemplate $Result + + # Below is a request that includes all optional parameters + # New-CampaignTemplate -CampaignTemplate $CampaignTemplate +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CampaignTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-campaign-template +Use this API to delete a certification campaign template by ID. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign template being deleted. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. + +# Delete a Campaign Template + +try { + Remove-CampaignTemplate-Id $Id + + # Below is a request that includes all optional parameters + # Remove-CampaignTemplate -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-campaign-template-schedule +Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign template whose schedule is being deleted. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. + +# Delete Campaign Template Schedule + +try { + Remove-CampaignTemplateSchedule-Id $Id + + # Below is a request that includes all optional parameters + # Remove-CampaignTemplateSchedule -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignTemplateSchedule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-campaigns +Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CampaignsDeleteRequest | [**CampaignsDeleteRequest**](../models/campaigns-delete-request) | True | IDs of the campaigns to delete. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CampaignsDeleteRequest = @"{ + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] +}"@ + +# Delete Campaigns + +try { + $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest + Remove-Campaigns-CampaignsDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-Campaigns -CampaignsDeleteRequest $CampaignsDeleteRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Campaigns" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-active-campaigns +Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Detail | **String** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** + +### Return type +[**GetActiveCampaigns200ResponseInner[]**](../models/get-active-campaigns200-response-inner) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of campaign objects. By default list of SLIM campaigns is returned. | GetActiveCampaigns200ResponseInner[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'name eq "Manager Campaign"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) + +# List Campaigns + +try { + Get-ActiveCampaigns + + # Below is a request that includes all optional parameters + # Get-ActiveCampaigns -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ActiveCampaigns" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-campaign +Use this API to get information for an existing certification campaign by the campaign's ID. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign to be retrieved. + Query | Detail | **String** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. + +### Return type +[**GetActiveCampaigns200ResponseInner**](../models/get-active-campaigns200-response-inner) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Requested campaign object. | GetActiveCampaigns200ResponseInner +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. +$Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + +# Get Campaign + +try { + Get-Campaign-Id $Id + + # Below is a request that includes all optional parameters + # Get-Campaign -Id $Id -Detail $Detail +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Campaign" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-campaign-reports +Use this API to fetch all reports for a certification campaign by campaign ID. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign whose reports are being fetched. + +### Return type +[**CampaignReport[]**](../models/campaign-report) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Array of campaign report objects. | CampaignReport[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. + +# Get Campaign Reports + +try { + Get-CampaignReports-Id $Id + + # Below is a request that includes all optional parameters + # Get-CampaignReports -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignReports" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-campaign-reports-config +Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**CampaignReportsConfig**](../models/campaign-reports-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Campaign report configuration. | CampaignReportsConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Campaign Reports Configuration + +try { + Get-CampaignReportsConfig + + # Below is a request that includes all optional parameters + # Get-CampaignReportsConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignReportsConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-campaign-template +Use this API to fetch a certification campaign template by ID. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Requested campaign template's ID. + +### Return type +[**CampaignTemplate**](../models/campaign-template) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Data for the campaign matching the given ID. | CampaignTemplate +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. + +# Get a Campaign Template + +try { + Get-CampaignTemplate-Id $Id + + # Below is a request that includes all optional parameters + # Get-CampaignTemplate -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-campaign-template-schedule +Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign template whose schedule is being fetched. + +### Return type +[**Schedule**](../models/schedule) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Current schedule for the campaign template. See the [Set Campaign Template Schedule endpoint documentation](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule) for more examples. | Schedule +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. + +# Get Campaign Template Schedule + +try { + Get-CampaignTemplateSchedule-Id $Id + + # Below is a request that includes all optional parameters + # Get-CampaignTemplateSchedule -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplateSchedule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-campaign-templates +Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. + +The API returns all campaign templates matching the query parameters. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* + +### Return type +[**CampaignTemplate[]**](../models/campaign-template) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of campaign template objects. | CampaignTemplate[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) +$Filters = 'name eq "manager template"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + +# List Campaign Templates + +try { + Get-CampaignTemplates + + # Below is a request that includes all optional parameters + # Get-CampaignTemplates -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplates" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## move +This API reassigns the specified certifications from one identity to another. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The certification campaign ID + Body | AdminReviewReassign | [**AdminReviewReassign**](../models/admin-review-reassign) | True | + +### Return type +[**CertificationTask**](../models/certification-task) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | The reassign task that has been submitted. | CertificationTask +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID +$AdminReviewReassign = @"{ + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } +}"@ + +# Reassign Certifications + +try { + $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign + Move--Id $Id -AdminReviewReassign $Result + + # Below is a request that includes all optional parameters + # Move- -Id $Id -AdminReviewReassign $AdminReviewReassign +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-campaign-template +Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign template being modified. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) + +### Return type +[**CampaignTemplate**](../models/campaign-template) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | This response indicates that the PATCH operation succeeded, and the API returns the template's new representation. | CampaignTemplate +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) + + +# Update a Campaign Template + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-CampaignTemplate-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-CampaignTemplate -Id $Id -JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-CampaignTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-campaign-reports-config +Use this API to overwrite the configuration for campaign reports. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CampaignReportsConfig | [**CampaignReportsConfig**](../models/campaign-reports-config) | True | Campaign report configuration. + +### Return type +[**CampaignReportsConfig**](../models/campaign-reports-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The persisted campaign report configuration. | CampaignReportsConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CampaignReportsConfig = @"{ + "identityAttributeColumns" : [ "firstname", "lastname" ] +}"@ + +# Set Campaign Reports Configuration + +try { + $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig + Set-CampaignReportsConfig-CampaignReportsConfig $Result + + # Below is a request that includes all optional parameters + # Set-CampaignReportsConfig -CampaignReportsConfig $CampaignReportsConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-CampaignReportsConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-campaign-template-schedule +Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign template being scheduled. + Body | Schedule | [**Schedule**](../models/schedule) | (optional) | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template being scheduled. +$Schedule = @"{ + "hours" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "months" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "timeZoneId" : "CST", + "days" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "expiration" : "2000-01-23T04:56:07.000+00:00", + "type" : "WEEKLY" +}"@ + +# Set Campaign Template Schedule + +try { + Set-CampaignTemplateSchedule-Id $Id + + # Below is a request that includes all optional parameters + # Set-CampaignTemplateSchedule -Id $Id -Schedule $Schedule +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-CampaignTemplateSchedule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-campaign +Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Campaign ID. + Body | ActivateCampaignOptions | [**ActivateCampaignOptions**](../models/activate-campaign-options) | (optional) | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. +$ActivateCampaignOptions = @"{ + "timeZone" : "-05:00" +}"@ + +# Activate a Campaign + +try { + Start-Campaign-Id $Id + + # Below is a request that includes all optional parameters + # Start-Campaign -Id $Id -ActivateCampaignOptions $ActivateCampaignOptions +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-Campaign" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-campaign-remediation-scan +Use this API to run a remediation scan task for a certification campaign. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign the remediation scan is being run for. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. + +# Run Campaign Remediation Scan + +try { + Start-CampaignRemediationScan-Id $Id + + # Below is a request that includes all optional parameters + # Start-CampaignRemediationScan -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-CampaignRemediationScan" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-campaign-report +Use this API to run a report for a certification campaign. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign the report is being run for. +Path | Type | [**ReportType**](../models/report-type) | True | Type of the report to run. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. +$Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run. + +# Run Campaign Report + +try { + Start-CampaignReport-Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Start-CampaignReport -Id $Id -Type $Type +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-CampaignReport" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-generate-campaign-template +Use this API to generate a new certification campaign from a campaign template. + +The campaign object contained in the template has special formatting applied to its name and description +fields that determine the generated campaign's name/description. Placeholders in those fields are +formatted with the current date and time upon generation. + +Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For +example, "%Y" inserts the current year, and a campaign template named "Campaign for %y" generates a +campaign called "Campaign for 2020" (assuming the year at generation time is 2020). + +Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign template to use for generation. + +### Return type +[**CampaignReference**](../models/campaign-reference) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | This response indicates that a campaign was successfully generated from this template, and the API returns a reference to the new campaign. | CampaignReference +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. + +# Generate a Campaign from Template + +try { + Start-GenerateCampaignTemplate-Id $Id + + # Below is a request that includes all optional parameters + # Start-GenerateCampaignTemplate -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-GenerateCampaignTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-campaign +Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the campaign template being modified. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline + +### Return type +[**SlimCampaign**](../models/slim-campaign) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | This response indicates that the PATCH operation succeeded, and the API returns the campaign's new representation. | SlimCampaign +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline + + +# Update a Campaign + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Campaign-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-Campaign -Id $Id -JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Campaign" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/CertificationSummariesApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/CertificationSummariesApi.md new file mode 100644 index 000000000..d2dbc4862 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/CertificationSummariesApi.md @@ -0,0 +1,237 @@ + +--- +id: certification-summaries +title: CertificationSummaries +pagination_label: CertificationSummaries +sidebar_label: CertificationSummaries +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationSummaries', 'CertificationSummaries'] +slug: /tools/sdk/powershell/v3/methods/certification-summaries +tags: ['SDK', 'Software Development Kit', 'CertificationSummaries', 'CertificationSummaries'] +--- + +# CertificationSummaries + Use this API to implement certification summary functionality. +With this functionality in place, administrators and designated certification reviewers can review summaries of identity certification campaigns and draw conclusions about the campaigns' scope, security, and effectiveness. +Implementing certification summary functionality improves organizations' ability to review their [certifications](https://documentation.sailpoint.com/saas/user-help/certifications.html) and helps them satisfy audit and regulatory requirements by enabling them to trace access changes and the decisions made in their review processes. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These certifications serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. +Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Certification summaries provide information about identity certification campaigns such as the identities involved, the number of decisions made, and the access changed. +For example, an administrator or designated certification reviewer can examine the Manager Certification campaign to get an overview of how many entitlement decisions are made in that campaign as opposed to role decisions, which identities would be affected by changes to the campaign, and how those identities' access would be affected. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-IdentityAccessSummaries**](#get-identity-access-summaries) | **GET** `/certifications/{id}/access-summaries/{type}` | Access Summaries +[**Get-IdentityDecisionSummary**](#get-identity-decision-summary) | **GET** `/certifications/{id}/decision-summary` | Summary of Certification Decisions +[**Get-IdentitySummaries**](#get-identity-summaries) | **GET** `/certifications/{id}/identity-summaries` | Identity Summaries for Campaign Certification +[**Get-IdentitySummary**](#get-identity-summary) | **GET** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for Identity + +## get-identity-access-summaries +This API returns a list of access summaries for the specified identity campaign certification and type. Reviewers for this certification can also call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity campaign certification ID +Path | Type | **String** | True | The type of access review item to retrieve summaries for + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** + +### Return type +[**AccessSummary[]**](../models/access-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of access summaries | AccessSummary[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID +$Type = "ROLE" # String | The type of access review item to retrieve summaries for +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'access.id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) +$Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + +# Access Summaries + +try { + 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 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessSummaries" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-decision-summary +This API returns a summary of the decisions made on an identity campaign certification. The decisions are summarized by type. Reviewers for this certification can also call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The certification ID + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* + +### Return type +[**IdentityCertDecisionSummary**](../models/identity-cert-decision-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Summary of the decisions made | IdentityCertDecisionSummary +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID +$Filters = 'identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + +# Summary of Certification Decisions + +try { + Get-IdentityDecisionSummary-Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentityDecisionSummary -Id $Id -Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityDecisionSummary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-summaries +This API returns a list of the identity summaries for a specific identity campaign certification. Reviewers for this certification can also call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity campaign certification ID + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** + +### Return type +[**CertificationIdentitySummary[]**](../models/certification-identity-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of identity summaries | CertificationIdentitySummary[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + +# Identity Summaries for Campaign Certification + +try { + 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 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummaries" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-summary +This API returns the summary for an identity on a specified identity campaign certification. Reviewers for this certification can also call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity campaign certification ID +Path | IdentitySummaryId | **String** | True | The identity summary ID + +### Return type +[**CertificationIdentitySummary**](../models/certification-identity-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An identity summary | CertificationIdentitySummary +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID +$IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + +# Summary for Identity + +try { + Get-IdentitySummary-Id $Id -IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/CertificationsApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/CertificationsApi.md new file mode 100644 index 000000000..c6897ab12 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/CertificationsApi.md @@ -0,0 +1,627 @@ + +--- +id: certifications +title: Certifications +pagination_label: Certifications +sidebar_label: Certifications +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Certifications', 'Certifications'] +slug: /tools/sdk/powershell/v3/methods/certifications +tags: ['SDK', 'Software Development Kit', 'Certifications', 'Certifications'] +--- + +# Certifications + Use this API to implement certification functionality. +With this functionality in place, administrators and designated certification reviewers can review users' access certifications and decide whether to approve access, revoke it, or reassign the review to another reviewer. +Implementing certifications improves organizations' data security by reducing inappropriate access through a distributed review process and helping them satisfy audit and regulatory requirements. + +A certification refers to Identity Security Cloud's mechanism for reviewing a user's access to entitlements (sets of permissions) and approving or removing that access. +These serve as a way of showing that a user's access has been reviewed and approved. +Multiple certifications by different reviewers are often required to approve a user's access. +A set of multiple certifications is called a certification campaign. + +For example, an organization may use a Manager Certification as a way of showing that a user's access has been reviewed and approved by their manager, or if the certification is part of a campaign, that the user's access has been reviewed and approved by multiple managers. +Once this certification has been completed, Identity Security Cloud would provision all the access the user needs, nothing more. + +Organization administrators or certification administrators can designate other Identity Security Cloud users as certification reviewers. +Those reviewers can select the 'Certifications' tab to view any of the certifications they either need to review or have already reviewed under the 'Active' and 'Completed' tabs, respectively. + +When a certification campaign is in progress, certification reviewers will see certifications listed under 'Active,' where they can review the involved identities. +Under the 'Decision' column on the right, next to each access item, reviewers can select the checkmark to approve access, select the 'X' to revoke access, or they can toggle the 'More Options' menu to reassign the certification to another reviewer and provide a reason for reassignment in the form of a comment. + +Once a reviewer has made decisions on all the certification's involved access items, he or she must select 'Sign Off' to complete the review process. +Doing so converts the certification into read-only status, preventing any further changes to the review decisions and deleting the work item (task) from the reviewer's list of work items. + +Once all the reviewers have signed off, the certification campaign either completes or, if any reviewers decided to revoke access for any of the involved identities, it moves into a remediation phase. In the remediation phase, identities' entitlements are altered to remove any entitlements marked for revocation. +In this situation, the certification campaign completes once all the remediation requests are completed. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-CertificationTask**](#get-certification-task) | **GET** `/certification-tasks/{id}` | Certification Task by ID +[**Get-IdentityCertification**](#get-identity-certification) | **GET** `/certifications/{id}` | Identity Certification by ID +[**Get-IdentityCertificationItemPermissions**](#get-identity-certification-item-permissions) | **GET** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for Entitlement Certification Item +[**Get-PendingCertificationTasks**](#get-pending-certification-tasks) | **GET** `/certification-tasks` | List of Pending Certification Tasks +[**Get-CertificationReviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of Reviewers for certification +[**Get-IdentityAccessReviewItems**](#list-identity-access-review-items) | **GET** `/certifications/{id}/access-review-items` | List of Access Review Items +[**Get-IdentityCertifications**](#list-identity-certifications) | **GET** `/certifications` | List Identity Campaign Certifications +[**Select-IdentityDecision**](#make-identity-decision) | **POST** `/certifications/{id}/decide` | Decide on a Certification Item +[**Invoke-ReassignIdentityCertifications**](#reassign-identity-certifications) | **POST** `/certifications/{id}/reassign` | Reassign Identities or Items +[**Invoke-SignOffIdentityCertification**](#sign-off-identity-certification) | **POST** `/certifications/{id}/sign-off` | Finalize Identity Certification Decisions +[**Submit-ReassignCertsAsync**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously + +## get-certification-task +This API returns the certification task for the specified ID. Reviewers for the specified certification can also call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The task ID + +### Return type +[**CertificationTask**](../models/certification-task) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A certification task | CertificationTask +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID + +# Certification Task by ID + +try { + Get-CertificationTask-Id $Id + + # Below is a request that includes all optional parameters + # Get-CertificationTask -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CertificationTask" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-certification +This API returns a single identity campaign certification by its ID. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The certification id + +### Return type +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An identity campaign certification object | IdentityCertificationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id + +# Identity Certification by ID + +try { + Get-IdentityCertification-Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentityCertification -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityCertification" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-certification-item-permissions +This API returns the permissions associated with an entitlement certification item based on the certification item's ID. Reviewers for this certification can also call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | CertificationId | **String** | True | The certification ID +Path | ItemId | **String** | True | The certification item ID + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**PermissionDto[]**](../models/permission-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of permissions associated with the given itemId | PermissionDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID +$ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID +$Filters = 'target eq "SYS.OBJAUTH2"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Permissions for Entitlement Certification Item + +try { + 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 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityCertificationItemPermissions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-pending-certification-tasks +This API returns a list of pending (`QUEUED` or `IN_PROGRESS`) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | ReviewerIdentity | **String** | (optional) | The ID of reviewer identity. *me* indicates the current user. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* + +### Return type +[**CertificationTask[]**](../models/certification-task) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of pending certification tasks | CertificationTask[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$ReviewerIdentity = "Ada.1de82e55078344" # String | The ID of reviewer identity. *me* indicates the current user. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'type eq "ADMIN_REASSIGN"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) + +# List of Pending Certification Tasks + +try { + Get-PendingCertificationTasks + + # Below is a request that includes all optional parameters + # Get-PendingCertificationTasks -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PendingCertificationTasks" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-certification-reviewers +This API returns a list of reviewers for the certification. Reviewers for this certification can also call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The certification ID + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** + +### Return type +[**IdentityReferenceWithNameAndEmail[]**](../models/identity-reference-with-name-and-email) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of reviewers | IdentityReferenceWithNameAndEmail[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'name eq "Bob"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) + +# List of Reviewers for certification + +try { + 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 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CertificationReviewers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-identity-access-review-items +This API returns a list of access review items for an identity campaign certification. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity campaign certification ID + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** + Query | Entitlements | **String** | (optional) | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. + Query | AccessProfiles | **String** | (optional) | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. + Query | Roles | **String** | (optional) | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. + +### Return type +[**AccessReviewItem[]**](../models/access-review-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of access review items | AccessReviewItem[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) +$Sorters = "access.name,-accessProfile.sourceName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) +$Entitlements = "identityEntitlement" # String | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) +$AccessProfiles = "accessProfile1" # String | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) +$Roles = "userRole" # String | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) + +# List of Access Review Items + +try { + 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 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessReviewItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-identity-certifications +Use this API to get a list of identity campaign certifications for the specified query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned. This API does not support requests for certifications assigned to governance groups. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | ReviewerIdentity | **String** | (optional) | Reviewer's identity. *me* indicates the current user. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** + +### Return type +[**IdentityCertificationDto[]**](../models/identity-certification-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of identity campaign certifications. | IdentityCertificationDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$ReviewerIdentity = "me" # String | Reviewer's identity. *me* indicates the current user. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) +$Sorters = "name,due" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) + +# List Identity Campaign Certifications + +try { + Get-IdentityCertifications + + # Below is a request that includes all optional parameters + # Get-IdentityCertifications -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityCertifications" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## make-identity-decision +The API makes a decision to approve or revoke one or more identity campaign certification items. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the identity campaign certification on which to make decisions + Body | ReviewDecision | [**[]ReviewDecision**](../models/review-decision) | True | A non-empty array of decisions to be made. + +### Return type +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An identity campaign certification object | IdentityCertificationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campaign certification on which to make decisions + $ReviewDecision = @"{ + "comments" : "This user no longer needs access to this source", + "decision" : "APPROVE", + "proposedEndDate" : "2017-07-11T18:45:37.098Z", + "recommendation" : { + "reasons" : [ "Reason 1", "Reason 2" ], + "recommendation" : "recommendation", + "timestamp" : "2020-06-01T13:49:37.385Z" + }, + "id" : "ef38f94347e94562b5bb8424a56397d8", + "bulk" : true +}"@ # ReviewDecision[] | A non-empty array of decisions to be made. + + +# Decide on a Certification Item + +try { + $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision + Select-IdentityDecision-Id $Id -ReviewDecision $Result + + # Below is a request that includes all optional parameters + # Select-IdentityDecision -Id $Id -ReviewDecision $ReviewDecision +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-IdentityDecision" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## reassign-identity-certifications +This API reassigns up to 50 identities or items in an identity campaign certification to another reviewer. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity campaign certification ID + Body | ReviewReassign | [**ReviewReassign**](../models/review-reassign) | True | + +### Return type +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An identity campaign certification details after completing the reassignment. | IdentityCertificationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID +$ReviewReassign = @"{ + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] +}"@ + +# Reassign Identities or Items + +try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Invoke-ReassignIdentityCertifications-Id $Id -ReviewReassign $Result + + # Below is a request that includes all optional parameters + # Invoke-ReassignIdentityCertifications -Id $Id -ReviewReassign $ReviewReassign +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ReassignIdentityCertifications" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## sign-off-identity-certification +This API finalizes all decisions made on an identity campaign certification and initiates any remediations required. Reviewers for this certification can also call this API. This API does not support requests for certifications assigned to Governance Groups. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity campaign certification ID + +### Return type +[**IdentityCertificationDto**](../models/identity-certification-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An identity campaign certification object | IdentityCertificationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + +# Finalize Identity Certification Decisions + +try { + Invoke-SignOffIdentityCertification-Id $Id + + # Below is a request that includes all optional parameters + # Invoke-SignOffIdentityCertification -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-SignOffIdentityCertification" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## submit-reassign-certs-async +This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another +reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the +reassignment is complete. + +Reviewers for this certification can also call this API. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The identity campaign certification ID + Body | ReviewReassign | [**ReviewReassign**](../models/review-reassign) | True | + +### Return type +[**CertificationTask**](../models/certification-task) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A certification task object for the reassignment which can be queried for status. | CertificationTask +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID +$ReviewReassign = @"{ + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] +}"@ + +# Reassign Certifications Asynchronously + +try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Submit-ReassignCertsAsync-Id $Id -ReviewReassign $Result + + # Below is a request that includes all optional parameters + # Submit-ReassignCertsAsync -Id $Id -ReviewReassign $ReviewReassign +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-ReassignCertsAsync" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/ConfigurationHubApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/ConfigurationHubApi.md new file mode 100644 index 000000000..dd85c35ab --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/ConfigurationHubApi.md @@ -0,0 +1,494 @@ + +--- +id: configuration-hub +title: ConfigurationHub +pagination_label: ConfigurationHub +sidebar_label: ConfigurationHub +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigurationHub', 'ConfigurationHub'] +slug: /tools/sdk/powershell/v3/methods/configuration-hub +tags: ['SDK', 'Software Development Kit', 'ConfigurationHub', 'ConfigurationHub'] +--- + +# ConfigurationHub + Upload configurations and manage object mappings between tenants. + +Configuration files can be managed and deployed using Configuration Hub by uploading a JSON file which contains configuration data. + +The function of object mapping allows objects with varying names and IDs to be compared. While objects are compared, a user can replace a value in the source tenant with a new value. Object mapping also helps in locating referenced objects to the source object during the drafting process. + +Refer to [Uploading a Configuration File](https://documentation.sailpoint.com/saas/help/confighub/config_hub.html#uploading-a-configuration-file) for more information about uploading Configuration Files + +Refer to [Mapping Objects](https://documentation.sailpoint.com/saas/help/confighub/config_hub.html#mapping-objects) for more information about object mappings. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-ObjectMapping**](#create-object-mapping) | **POST** `/configuration-hub/object-mappings/{sourceOrg}` | Creates an object mapping +[**New-ObjectMappings**](#create-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-create` | Bulk creates object mappings +[**New-UploadedConfiguration**](#create-uploaded-configuration) | **POST** `/configuration-hub/backups/uploads` | Upload a Configuration +[**Remove-ObjectMapping**](#delete-object-mapping) | **DELETE** `/configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}` | Deletes an object mapping +[**Remove-UploadedConfiguration**](#delete-uploaded-configuration) | **DELETE** `/configuration-hub/backups/uploads/{id}` | Delete an Uploaded Configuration +[**Get-ObjectMappings**](#get-object-mappings) | **GET** `/configuration-hub/object-mappings/{sourceOrg}` | Gets list of object mappings +[**Get-UploadedConfiguration**](#get-uploaded-configuration) | **GET** `/configuration-hub/backups/uploads/{id}` | Get an Uploaded Configuration +[**Get-UploadedConfigurations**](#list-uploaded-configurations) | **GET** `/configuration-hub/backups/uploads` | List Uploaded Configurations +[**Update-ObjectMappings**](#update-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings + +## create-object-mapping +This creates an object mapping between current org and source org. +Source org should be "default" when creating an object mapping that is not to be associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceOrg | **String** | True | The name of the source org. + Body | ObjectMappingRequest | [**ObjectMappingRequest**](../models/object-mapping-request) | True | The object mapping request body. + +### Return type +[**ObjectMappingResponse**](../models/object-mapping-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The created object mapping between current org and source org. | ObjectMappingResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceOrg = "source-org" # String | The name of the source org. +$ObjectMappingRequest = @"{ + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" +}"@ + +# Creates an object mapping + +try { + $Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest + New-ObjectMapping-SourceOrg $SourceOrg -ObjectMappingRequest $Result + + # Below is a request that includes all optional parameters + # New-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $ObjectMappingRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ObjectMapping" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-object-mappings +This creates a set of object mappings (Max 25) between current org and source org. +Source org should be "default" when creating object mappings that are not to be associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceOrg | **String** | True | The name of the source org. + Body | ObjectMappingBulkCreateRequest | [**ObjectMappingBulkCreateRequest**](../models/object-mapping-bulk-create-request) | True | The bulk create object mapping request body. + +### Return type +[**ObjectMappingBulkCreateResponse**](../models/object-mapping-bulk-create-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The created object mapping between current org and source org. | ObjectMappingBulkCreateResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceOrg = "source-org" # String | The name of the source org. +$ObjectMappingBulkCreateRequest = @"{ + "newObjectsMappings" : [ { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + }, { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } ] +}"@ + +# Bulk creates object mappings + +try { + $Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest + New-ObjectMappings-SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result + + # Below is a request that includes all optional parameters + # New-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $ObjectMappingBulkCreateRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ObjectMappings" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-uploaded-configuration +This API uploads a JSON configuration file into a tenant. + +Configuration files can be managed and deployed via Configuration Hub by uploading a json file which contains configuration data. The JSON file should be the same as the one used by our import endpoints. The object types supported by upload configuration file functionality are the same as the ones supported by our regular backup functionality. + +Refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects) for more information about supported objects. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | Data | **System.IO.FileInfo** | True | JSON file containing the objects to be imported. + | Name | **String** | True | Name that will be assigned to the uploaded configuration file. + +### Return type +[**BackupResponse**](../models/backup-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Upload job accepted and queued for processing. | BackupResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$Data = # System.IO.FileInfo | JSON file containing the objects to be imported. +$Name = "MyName" # String | Name that will be assigned to the uploaded configuration file. + +# Upload a Configuration + +try { + New-UploadedConfiguration-Data $Data -Name $Name + + # Below is a request that includes all optional parameters + # New-UploadedConfiguration -Data $Data -Name $Name +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-UploadedConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-object-mapping +This deletes an existing object mapping. +Source org should be "default" when deleting an object mapping that is not associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceOrg | **String** | True | The name of the source org. +Path | ObjectMappingId | **String** | True | The id of the object mapping to be deleted. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceOrg = "source-org" # String | The name of the source org. +$ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of the object mapping to be deleted. + +# Deletes an object mapping + +try { + Remove-ObjectMapping-SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId + + # Below is a request that includes all optional parameters + # Remove-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ObjectMapping" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-uploaded-configuration +This API deletes an uploaded configuration based on Id. + +On success, this endpoint will return an empty response. + +The uploaded configuration id can be obtained from the response after a successful upload, or the list uploaded configurations endpoint. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The id of the uploaded configuration. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. + +# Delete an Uploaded Configuration + +try { + Remove-UploadedConfiguration-Id $Id + + # Below is a request that includes all optional parameters + # Remove-UploadedConfiguration -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-UploadedConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-object-mappings +This gets a list of existing object mappings between current org and source org. +Source org should be "default" when getting object mappings that are not associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:read + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceOrg | **String** | True | The name of the source org. + +### Return type +[**ObjectMappingResponse[]**](../models/object-mapping-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of existing object mappings between current org and source org. | ObjectMappingResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceOrg = "source-org" # String | The name of the source org. + +# Gets list of object mappings + +try { + Get-ObjectMappings-SourceOrg $SourceOrg + + # Below is a request that includes all optional parameters + # Get-ObjectMappings -SourceOrg $SourceOrg +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ObjectMappings" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-uploaded-configuration +This API gets an existing uploaded configuration for the current tenant. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The id of the uploaded configuration. + +### Return type +[**BackupResponse**](../models/backup-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Gets an uploaded configuration details. | BackupResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. + +# Get an Uploaded Configuration + +try { + Get-UploadedConfiguration-Id $Id + + # Below is a request that includes all optional parameters + # Get-UploadedConfiguration -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UploadedConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-uploaded-configurations +This API gets a list of existing uploaded configurations for the current tenant. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* + +### Return type +[**BackupResponse[]**](../models/backup-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of existing uploaded configurations. | BackupResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Filters = 'status eq "COMPLETE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) + +# List Uploaded Configurations + +try { + Get-UploadedConfigurations + + # Below is a request that includes all optional parameters + # Get-UploadedConfigurations -Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UploadedConfigurations" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-object-mappings +This updates a set of object mappings, only enabled and targetValue fields can be updated. +Source org should be "default" when updating object mappings that are not associated to any particular org. +The request will need the following security scope: +- sp:config-object-mapping:manage + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceOrg | **String** | True | The name of the source org. + Body | ObjectMappingBulkPatchRequest | [**ObjectMappingBulkPatchRequest**](../models/object-mapping-bulk-patch-request) | True | The object mapping request body. + +### Return type +[**ObjectMappingBulkPatchResponse**](../models/object-mapping-bulk-patch-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The updated object mappings. | ObjectMappingBulkPatchResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceOrg = "source-org" # String | The name of the source org. +$ObjectMappingBulkPatchRequest = @"{ + "patches" : { + "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : true + } ], + "00bece34-f50d-4227-8878-76f620b5a971" : [ { + "op" : "replace", + "path" : "/targetValue", + "value" : "New Target Value" + } ] + } +}"@ + +# Bulk updates object mappings + +try { + $Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest + Update-ObjectMappings-SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result + + # Below is a request that includes all optional parameters + # Update-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $ObjectMappingBulkPatchRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ObjectMappings" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/ConnectorsApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/ConnectorsApi.md new file mode 100644 index 000000000..06808aef7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/ConnectorsApi.md @@ -0,0 +1,564 @@ + +--- +id: connectors +title: Connectors +pagination_label: Connectors +sidebar_label: Connectors +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Connectors', 'Connectors'] +slug: /tools/sdk/powershell/v3/methods/connectors +tags: ['SDK', 'Software Development Kit', 'Connectors', 'Connectors'] +--- + +# Connectors + Use this API to implement connector functionality. +With this functionality in place, administrators can view available connectors. + +Connectors are the bridges Identity Security Cloud uses to communicate with and aggregate data from sources. +For example, if it is necessary to set up a connection between Identity Security Cloud and the Active Directory source, a connector can bridge the two and enable Identity Security Cloud to synchronize data between the systems. +This ensures account entitlements and states are correct throughout the organization. + +In Identity Security Cloud, administrators can use the Connections drop-down menu and select Sources to view the available source connectors. + +Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about the connectors available in Identity Security Cloud. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/) for more information about the SaaS custom connectors that do not need VAs (virtual appliances) to communicate with their sources. + +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about using connectors in Identity Security Cloud. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-CustomConnector**](#create-custom-connector) | **POST** `/connectors` | Create Custom Connector +[**Remove-CustomConnector**](#delete-custom-connector) | **DELETE** `/connectors/{scriptName}` | Delete Connector by Script Name +[**Get-Connector**](#get-connector) | **GET** `/connectors/{scriptName}` | Get Connector by Script Name +[**Get-ConnectorList**](#get-connector-list) | **GET** `/connectors` | Get Connector List +[**Get-ConnectorSourceConfig**](#get-connector-source-config) | **GET** `/connectors/{scriptName}/source-config` | Get Connector Source Configuration +[**Get-ConnectorSourceTemplate**](#get-connector-source-template) | **GET** `/connectors/{scriptName}/source-template` | Get Connector Source Template +[**Get-ConnectorTranslations**](#get-connector-translations) | **GET** `/connectors/{scriptName}/translations/{locale}` | Get Connector Translations +[**Send-ConnectorSourceConfig**](#put-connector-source-config) | **PUT** `/connectors/{scriptName}/source-config` | Update Connector Source Configuration +[**Send-ConnectorSourceTemplate**](#put-connector-source-template) | **PUT** `/connectors/{scriptName}/source-template` | Update Connector Source Template +[**Send-ConnectorTranslations**](#put-connector-translations) | **PUT** `/connectors/{scriptName}/translations/{locale}` | Update Connector Translations +[**Update-Connector**](#update-connector) | **PATCH** `/connectors/{scriptName}` | Update Connector by Script Name + +## create-custom-connector +Create custom connector. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | V3CreateConnectorDto | [**V3CreateConnectorDto**](../models/v3-create-connector-dto) | True | + +### Return type +[**V3ConnectorDto**](../models/v3-connector-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A Connector Dto object | V3ConnectorDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$V3CreateConnectorDto = @"{ + "name" : "custom connector", + "directConnect" : true, + "className" : "sailpoint.connector.OpenConnectorAdapter", + "type" : "custom connector type", + "status" : "RELEASED" +}"@ + +# Create Custom Connector + +try { + $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto + New-CustomConnector-V3CreateConnectorDto $Result + + # Below is a request that includes all optional parameters + # New-CustomConnector -V3CreateConnectorDto $V3CreateConnectorDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CustomConnector" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-custom-connector +Delete a custom connector that using its script name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ScriptName | **String** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + +# Delete Connector by Script Name + +try { + Remove-CustomConnector-ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Remove-CustomConnector -ScriptName $ScriptName +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CustomConnector" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-connector +Fetches a connector that using its script name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ScriptName | **String** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + Query | Locale | **String** | (optional) | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + +### Return type +[**ConnectorDetail**](../models/connector-detail) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A Connector Dto object | ConnectorDetail +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. +$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + +# Get Connector by Script Name + +try { + Get-Connector-ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-Connector -ScriptName $ScriptName -Locale $Locale +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Connector" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-connector-list +Fetches list of connectors that have 'RELEASED' status using filtering and pagination. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Locale | **String** | (optional) | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + +### Return type +[**V3ConnectorDto[]**](../models/v3-connector-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A Connector Dto object | V3ConnectorDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Filters = 'directConnect eq "true"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + +# Get Connector List + +try { + Get-ConnectorList + + # Below is a request that includes all optional parameters + # Get-ConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorList" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-connector-source-config +Fetches a connector's source config using its script name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ScriptName | **String** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + +### Return type +**String** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The connector's source template | String +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + +### Example +```powershell +$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + +# Get Connector Source Configuration + +try { + Get-ConnectorSourceConfig-ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-ConnectorSourceConfig -ScriptName $ScriptName +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorSourceConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-connector-source-template +Fetches a connector's source template using its script name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ScriptName | **String** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + +### Return type +**String** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The connector's source template | String +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + +### Example +```powershell +$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + +# Get Connector Source Template + +try { + Get-ConnectorSourceTemplate-ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-ConnectorSourceTemplate -ScriptName $ScriptName +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorSourceTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-connector-translations +Fetches a connector's translations using its script name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ScriptName | **String** | True | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. +Path | Locale | **String** | True | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + +### Return type +**String** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The connector's translations | String +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: text/plain, application/json + +### Example +```powershell +$ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. +$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + +# Get Connector Translations + +try { + Get-ConnectorTranslations-ScriptName $ScriptName -Locale $Locale + + # Below is a request that includes all optional parameters + # Get-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorTranslations" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-connector-source-config +Update a connector's source config using its script name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ScriptName | **String** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + | File | **System.IO.FileInfo** | True | connector source config xml file + +### Return type +[**UpdateDetail**](../models/update-detail) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The connector's update detail | UpdateDetail +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. +$File = # System.IO.FileInfo | connector source config xml file + +# Update Connector Source Configuration + +try { + Send-ConnectorSourceConfig-ScriptName $ScriptName -File $File + + # Below is a request that includes all optional parameters + # Send-ConnectorSourceConfig -ScriptName $ScriptName -File $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorSourceConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-connector-source-template +Update a connector's source template using its script name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ScriptName | **String** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + | File | **System.IO.FileInfo** | True | connector source template xml file + +### Return type +[**UpdateDetail**](../models/update-detail) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The connector's update detail | UpdateDetail +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. +$File = # System.IO.FileInfo | connector source template xml file + +# Update Connector Source Template + +try { + Send-ConnectorSourceTemplate-ScriptName $ScriptName -File $File + + # Below is a request that includes all optional parameters + # Send-ConnectorSourceTemplate -ScriptName $ScriptName -File $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorSourceTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-connector-translations +Update a connector's translations using its script name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ScriptName | **String** | True | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. +Path | Locale | **String** | True | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + +### Return type +[**UpdateDetail**](../models/update-detail) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The connector's update detail | UpdateDetail +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. +$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + +# Update Connector Translations + +try { + Send-ConnectorTranslations-ScriptName $ScriptName -Locale $Locale + + # Below is a request that includes all optional parameters + # Send-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorTranslations" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-connector +This API updates a custom connector by script name using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +The following fields are patchable: + + +* connectorMetadata + +* applicationXml + +* correlationConfigXml + +* sourceConfigXml + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ScriptName | **String** | True | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of connector detail update operations + +### Return type +[**ConnectorDetail**](../models/connector-detail) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A updated Connector Dto object | ConnectorDetail +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of connector detail update operations + + +# Update Connector by Script Name + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Connector-ScriptName $ScriptName -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-Connector -ScriptName $ScriptName -JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Connector" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/GlobalTenantSecuritySettingsApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/GlobalTenantSecuritySettingsApi.md new file mode 100644 index 000000000..7aaf52adb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/GlobalTenantSecuritySettingsApi.md @@ -0,0 +1,443 @@ + +--- +id: global-tenant-security-settings +title: GlobalTenantSecuritySettings +pagination_label: GlobalTenantSecuritySettings +sidebar_label: GlobalTenantSecuritySettings +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GlobalTenantSecuritySettings', 'GlobalTenantSecuritySettings'] +slug: /tools/sdk/powershell/v3/methods/global-tenant-security-settings +tags: ['SDK', 'Software Development Kit', 'GlobalTenantSecuritySettings', 'GlobalTenantSecuritySettings'] +--- + +# GlobalTenantSecuritySettings + Use this API to implement and customize global tenant security settings. +With this functionality in place, administrators can manage the global security settings that a tenant/org has. +This API can be used to configure the networks and Geographies allowed to access Identity Security Cloud URLs. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-AuthOrgNetworkConfig**](#create-auth-org-network-config) | **POST** `/auth-org/network-config` | Create security network configuration. +[**Get-AuthOrgLockoutConfig**](#get-auth-org-lockout-config) | **GET** `/auth-org/lockout-config` | Get Auth Org Lockout Configuration. +[**Get-AuthOrgNetworkConfig**](#get-auth-org-network-config) | **GET** `/auth-org/network-config` | Get security network configuration. +[**Get-AuthOrgServiceProviderConfig**](#get-auth-org-service-provider-config) | **GET** `/auth-org/service-provider-config` | Get Service Provider Configuration. +[**Get-AuthOrgSessionConfig**](#get-auth-org-session-config) | **GET** `/auth-org/session-config` | Get Auth Org Session Configuration. +[**Update-AuthOrgLockoutConfig**](#patch-auth-org-lockout-config) | **PATCH** `/auth-org/lockout-config` | Update Auth Org Lockout Configuration +[**Update-AuthOrgNetworkConfig**](#patch-auth-org-network-config) | **PATCH** `/auth-org/network-config` | Update security network configuration. +[**Update-AuthOrgServiceProviderConfig**](#patch-auth-org-service-provider-config) | **PATCH** `/auth-org/service-provider-config` | Update Service Provider Configuration +[**Update-AuthOrgSessionConfig**](#patch-auth-org-session-config) | **PATCH** `/auth-org/session-config` | Update Auth Org Session Configuration + +## create-auth-org-network-config +This API returns the details of an org's network auth configuration. Requires security scope of: 'sp:auth-org:manage' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | NetworkConfiguration | [**NetworkConfiguration**](../models/network-configuration) | True | Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + +### Return type +[**NetworkConfiguration**](../models/network-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Network configuration for the tenant. | NetworkConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$NetworkConfiguration = @"{ + "range" : [ "1.3.7.2", "255.255.255.252/30" ], + "whitelisted" : true, + "geolocation" : [ "CA", "FR", "HT" ] +}"@ + +# Create security network configuration. + +try { + $Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration + New-AuthOrgNetworkConfig-NetworkConfiguration $Result + + # Below is a request that includes all optional parameters + # New-AuthOrgNetworkConfig -NetworkConfiguration $NetworkConfiguration +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-auth-org-lockout-config +This API returns the details of an org's lockout auth configuration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**LockoutConfiguration**](../models/lockout-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Lockout configuration for the tenant's auth org. | LockoutConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Auth Org Lockout Configuration. + +try { + Get-AuthOrgLockoutConfig + + # Below is a request that includes all optional parameters + # Get-AuthOrgLockoutConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-auth-org-network-config +This API returns the details of an org's network auth configuration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**NetworkConfiguration**](../models/network-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Network configuration for the tenant's auth org. | NetworkConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get security network configuration. + +try { + Get-AuthOrgNetworkConfig + + # Below is a request that includes all optional parameters + # Get-AuthOrgNetworkConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-auth-org-service-provider-config +This API returns the details of an org's service provider auth configuration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Service provider configuration for the tenant. | ServiceProviderConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Service Provider Configuration. + +try { + Get-AuthOrgServiceProviderConfig + + # Below is a request that includes all optional parameters + # Get-AuthOrgServiceProviderConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-auth-org-session-config +This API returns the details of an org's session auth configuration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**SessionConfiguration**](../models/session-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Session configuration for the tenant's auth org. | SessionConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Auth Org Session Configuration. + +try { + Get-AuthOrgSessionConfig + + # Below is a request that includes all optional parameters + # Get-AuthOrgSessionConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgSessionConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-auth-org-lockout-config +This API updates an existing lockout configuration for an org using PATCH + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + +### Return type +[**LockoutConfiguration**](../models/lockout-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated Auth Org lockout configuration. | LockoutConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + + +# Update Auth Org Lockout Configuration + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthOrgLockoutConfig-JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthOrgLockoutConfig -JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-auth-org-network-config +This API updates an existing network configuration for an org using PATCH + Requires security scope of: 'sp:auth-org:manage' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + +### Return type +[**NetworkConfiguration**](../models/network-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated Auth Org network configuration. | NetworkConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters. + + +# Update security network configuration. + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthOrgNetworkConfig-JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthOrgNetworkConfig -JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-auth-org-service-provider-config +This API updates an existing service provider configuration for an org using PATCH. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + +### Return type +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Auth Org Service Provider configuration updated. | ServiceProviderConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + + +# Update Service Provider Configuration + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthOrgServiceProviderConfig-JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthOrgServiceProviderConfig -JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-auth-org-session-config +This API updates an existing session configuration for an org using PATCH. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + +### Return type +[**SessionConfiguration**](../models/session-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated Auth Org session configuration. | SessionConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + + +# Update Auth Org Session Configuration + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthOrgSessionConfig-JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthOrgSessionConfig -JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgSessionConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/IdentityProfilesApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/IdentityProfilesApi.md new file mode 100644 index 000000000..921b4e6b5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/IdentityProfilesApi.md @@ -0,0 +1,699 @@ + +--- +id: identity-profiles +title: IdentityProfiles +pagination_label: IdentityProfiles +sidebar_label: IdentityProfiles +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfiles', 'IdentityProfiles'] +slug: /tools/sdk/powershell/v3/methods/identity-profiles +tags: ['SDK', 'Software Development Kit', 'IdentityProfiles', 'IdentityProfiles'] +--- + +# IdentityProfiles + Use this API to implement identity profile functionality. +With this functionality in place, administrators can view identity profiles and their configurations. + +Identity profiles represent the configurations that can be applied to identities as a way of granting them a set of security and access, as well as defining the mappings between their identity attributes and their source attributes. + +In Identity Security Cloud, administrators can use the Identities drop-down menu and select Identity Profiles to view the list of identity profiles. +This list shows some details about each identity profile, along with its status. +They can select an identity profile to view its settings, its mappings between identity attributes and correlating source account attributes, and its provisioning settings. + +Refer to [Creating Identity Profiles](https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html) for more information about identity profiles. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-IdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create an Identity Profile +[**Remove-IdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete an Identity Profile +[**Remove-IdentityProfiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete Identity Profiles +[**Export-IdentityProfiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export Identity Profiles +[**Get-DefaultIdentityAttributeConfig**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default Identity Attribute Config +[**Get-IdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get single Identity Profile +[**Import-IdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles +[**Get-IdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | Identity Profiles List +[**Show-IdentityPreview**](#show-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview +[**Sync-IdentityProfile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile +[**Update-IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update the Identity Profile + +## create-identity-profile +This creates an Identity Profile. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | IdentityProfile | [**IdentityProfile**](../models/identity-profile) | True | + +### Return type +[**IdentityProfile**](../models/identity-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | The created Identity Profile | IdentityProfile +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$IdentityProfile = @"{ + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" +}"@ + +# Create an Identity Profile + +try { + $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile + New-IdentityProfile-IdentityProfile $Result + + # Below is a request that includes all optional parameters + # New-IdentityProfile -IdentityProfile $IdentityProfile +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-IdentityProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-identity-profile +This deletes an Identity Profile based on ID. + +On success, this endpoint will return a reference to the bulk delete task result. + + +The following rights are required to access this endpoint: idn:identity-profile:delete + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | The Identity Profile ID. + +### Return type +[**TaskResultSimplified**](../models/task-result-simplified) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returns a TaskResult object referencing the bulk delete job created. | TaskResultSimplified +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. + +# Delete an Identity Profile + +try { + Remove-IdentityProfile-IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Remove-IdentityProfile -IdentityProfileId $IdentityProfileId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-IdentityProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-identity-profiles +This deletes multiple Identity Profiles via a list of supplied IDs. + +On success, this endpoint will return a reference to the bulk delete task result. + +The following rights are required to access this endpoint: idn:identity-profile:delete + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | RequestBody | **[]String** | True | Identity Profile bulk delete request body. + +### Return type +[**TaskResultSimplified**](../models/task-result-simplified) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returns a TaskResult object referencing the bulk delete job created. | TaskResultSimplified +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body. + $RequestBody = @""@ # String[] | Identity Profile bulk delete request body. + + +# Delete Identity Profiles + +try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-IdentityProfiles-RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-IdentityProfiles -RequestBody $RequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-IdentityProfiles" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## export-identity-profiles +This exports existing identity profiles in the format specified by the sp-config service. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** + +### Return type +[**IdentityProfileExportedObject[]**](../models/identity-profile-exported-object) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of export objects with identity profiles. | IdentityProfileExportedObject[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) +$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) + +# Export Identity Profiles + +try { + Export-IdentityProfiles + + # Below is a request that includes all optional parameters + # Export-IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-IdentityProfiles" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-default-identity-attribute-config +This returns the default identity attribute config. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | The Identity Profile ID. + +### Return type +[**IdentityAttributeConfig**](../models/identity-attribute-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An Identity Attribute Config object. | IdentityAttributeConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. + +# Get default Identity Attribute Config + +try { + Get-DefaultIdentityAttributeConfig-IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultIdentityAttributeConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-identity-profile +This returns a single Identity Profile based on ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | The Identity Profile ID. + +### Return type +[**IdentityProfile**](../models/identity-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An Identity Profile object. | IdentityProfile +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. + +# Get single Identity Profile + +try { + Get-IdentityProfile-IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-IdentityProfile -IdentityProfileId $IdentityProfileId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-identity-profiles +This imports previously exported identity profiles. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | IdentityProfileExportedObject | [**[]IdentityProfileExportedObject**](../models/identity-profile-exported-object) | True | Previously exported Identity Profiles. + +### Return type +[**ObjectImportResult**](../models/object-import-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The result of importing Identity Profiles. | ObjectImportResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell + + + + + + $IdentityProfileExportedObject = @"{ + "self" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "version" : 1, + "object" : { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + } +}"@ # IdentityProfileExportedObject[] | Previously exported Identity Profiles. + + +# Import Identity Profiles + +try { + $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject + Import-IdentityProfiles-IdentityProfileExportedObject $Result + + # Below is a request that includes all optional parameters + # Import-IdentityProfiles -IdentityProfileExportedObject $IdentityProfileExportedObject +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-IdentityProfiles" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-identity-profiles +This returns a list of Identity Profiles based on the specified query parameters. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** + +### Return type +[**IdentityProfile[]**](../models/identity-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of identityProfiles. | IdentityProfile[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional) +$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) + +# Identity Profiles List + +try { + Get-IdentityProfiles + + # Below is a request that includes all optional parameters + # Get-IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityProfiles" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## show-identity-preview +Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body. +This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | IdentityPreviewRequest | [**IdentityPreviewRequest**](../models/identity-preview-request) | True | Identity Preview request body. + +### Return type +[**IdentityPreviewResponse**](../models/identity-preview-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A preview of the identity attributes after applying identity attributes config sent in request body. | IdentityPreviewResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$IdentityPreviewRequest = @"{ + "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + } +}"@ + +# Generate Identity Profile Preview + +try { + $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest + Show-IdentityPreview-IdentityPreviewRequest $Result + + # Below is a request that includes all optional parameters + # Show-IdentityPreview -IdentityPreviewRequest $IdentityPreviewRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-IdentityPreview" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## sync-identity-profile +Process identities under the profile +This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. +This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. +This operation will perform the following activities on all identities under the identity profile. +1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity's correct manager through manager correlation. 3. Updates the identity's access according to their assigned lifecycle state. 4. Updates the identity's access based on role assignment criteria. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | The Identity Profile ID to be processed + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed + +# Process identities under profile + +try { + Sync-IdentityProfile-IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Sync-IdentityProfile -IdentityProfileId $IdentityProfileId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-IdentityProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-identity-profile +This updates the specified Identity Profile. + + +Some fields of the Schema cannot be updated. These fields are listed below: +* id +* name +* created +* modified +* identityCount +* identityRefreshRequired +* Authoritative Source and Identity Attribute Configuration cannot be modified at once. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | The Identity Profile ID + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**IdentityProfile**](../models/identity-profile) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The updated Identity Profile. | IdentityProfile +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +# Update the Identity Profile + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-IdentityProfile-IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-IdentityProfile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/LifecycleStatesApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/LifecycleStatesApi.md new file mode 100644 index 000000000..0cb36dd4e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/LifecycleStatesApi.md @@ -0,0 +1,373 @@ + +--- +id: lifecycle-states +title: LifecycleStates +pagination_label: LifecycleStates +sidebar_label: LifecycleStates +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LifecycleStates', 'LifecycleStates'] +slug: /tools/sdk/powershell/v3/methods/lifecycle-states +tags: ['SDK', 'Software Development Kit', 'LifecycleStates', 'LifecycleStates'] +--- + +# LifecycleStates + Use this API to implement and customize lifecycle state functionality. +With this functionality in place, administrators can create and configure custom lifecycle states for use across their organizations, which is key to controlling which users have access, when they have access, and the access they have. + +A lifecycle state describes a user's status in a company. For example, two lifecycle states come by default with Identity Security Cloud: 'Active' and 'Inactive.' +When an active employee takes an extended leave of absence from a company, his or her lifecycle state may change to 'Inactive,' for security purposes. +The inactive employee would lose access to all the applications, sources, and sensitive data during the leave of absence, but when the employee returns and becomes active again, all that access would be restored. +This saves administrators the time that would otherwise be spent provisioning the employee's access to each individual tool, reviewing the employee's certification history, etc. + +Administrators can create a variety of custom lifecycle states. Refer to [Planning New Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#planning-new-lifecycle-states) for some custom lifecycle state ideas. + +Administrators must define the criteria for being in each lifecycle state, and they must define how Identity Security Cloud manages users' access to apps and sources for each lifecycle state. + +In Identity Security Cloud, administrators can manage lifecycle states by going to Admin > Identities > Identity Profile, selecting the identity profile whose lifecycle states they want to manage, selecting the 'Provisioning' tab, and using the left panel to either select the lifecycle state they want to modify or create a new lifecycle state. + +In the 'Provisioning' tab, administrators can make the following access changes to an identity profile's lifecycle state: + +- Enable/disable the lifecycle state for the identity profile. + +- Enable/disable source accounts for the identity profile's lifecycle state. + +- Add existing access profiles to grant to the identity profiles in that lifecycle state. + +- Create a new access profile to grant to the identity profile in that lifecycle state. + +Access profiles granted in a previous lifecycle state are automatically revoked when the identity moves to a new lifecycle state. +To maintain access across multiple lifecycle states, administrators must grant the access profiles in each lifecycle state. +For example, if an administrator wants users with the 'HR Employee' identity profile to maintain their building access in both the 'Active' and 'Leave of Absence' lifecycle states, the administrator must grant the access profile for that building access to both lifecycle states. + +During scheduled refreshes, Identity Security Cloud evaluates lifecycle states to determine whether their assigned identities have the access defined in the lifecycle states' access profiles. +If the identities are missing access, Identity Security Cloud provisions that access. + +Administrators can also use the 'Provisioning' tab to configure email notifications for Identity Security Cloud to send whenever an identity with that identity profile has a lifecycle state change. +Refer to [Configuring Lifecycle State Notifications](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#configuring-lifecycle-state-notifications) for more information on how to do so. + +An identity's lifecycle state can have four different statuses: the lifecycle state's status can be 'Active,' it can be 'Not Set,' it can be 'Not Valid,' or it 'Does Not Match Technical Name Case.' +Refer to [Moving Identities into Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html#moving-identities-into-lifecycle-states) for more information about these different lifecycle state statuses. + +Refer to [Setting Up Lifecycle States](https://documentation.sailpoint.com/saas/help/provisioning/lifecycle.html) for more information about lifecycle states. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-LifecycleState**](#create-lifecycle-state) | **POST** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Create Lifecycle State +[**Remove-LifecycleState**](#delete-lifecycle-state) | **DELETE** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Delete Lifecycle State +[**Get-LifecycleState**](#get-lifecycle-state) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State +[**Get-LifecycleStates**](#get-lifecycle-states) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Lists LifecycleStates +[**Set-LifecycleState**](#set-lifecycle-state) | **POST** `/identities/{identity-id}/set-lifecycle-state` | Set Lifecycle State +[**Update-LifecycleStates**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State + +## create-lifecycle-state +Use this endpoint to create a lifecycle state. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | Identity profile ID. + Body | LifecycleState | [**LifecycleState**](../models/lifecycle-state) | True | Lifecycle state to be created. + +### Return type +[**LifecycleState**](../models/lifecycle-state) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Created LifecycleState object. | LifecycleState +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. +$LifecycleState = @"{ + "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], + "emailNotificationOption" : { + "notifyManagers" : true, + "notifySpecificUsers" : true, + "emailAddressList" : [ "test@test.com", "test2@test.com" ], + "notifyAllAdmins" : true + }, + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Lifecycle description", + "accountActions" : [ { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }, { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } ], + "id" : "id12345", + "identityCount" : 42, + "technicalName" : "Technical Name", + "identityState" : "identityState", + "enabled" : true +}"@ + +# Create Lifecycle State + +try { + $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState + New-LifecycleState-IdentityProfileId $IdentityProfileId -LifecycleState $Result + + # Below is a request that includes all optional parameters + # New-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $LifecycleState +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-LifecycleState" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-lifecycle-state +Use this endpoint to delete the lifecycle state by its ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | Identity profile ID. +Path | LifecycleStateId | **String** | True | Lifecycle state ID. + +### Return type +[**LifecyclestateDeleted**](../models/lifecyclestate-deleted) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | The request was successfully accepted into the system. | LifecyclestateDeleted +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. +$LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + +# Delete Lifecycle State + +try { + Remove-LifecycleState-IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Remove-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-LifecycleState" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-lifecycle-state +Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | Identity profile ID. +Path | LifecycleStateId | **String** | True | Lifecycle state ID. + +### Return type +[**LifecycleState**](../models/lifecycle-state) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The requested LifecycleState was successfully retrieved. | LifecycleState +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. +$LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + +# Get Lifecycle State + +try { + Get-LifecycleState-IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Get-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-LifecycleState" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-lifecycle-states +Use this endpoint to list all lifecycle states by their associated identity profiles. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | Identity profile ID. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** + +### Return type +[**LifecycleState[]**](../models/lifecycle-state) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of LifecycleState objects. | LifecycleState[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + +# Lists LifecycleStates + +try { + 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 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-LifecycleStates" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-lifecycle-state +Use this API to set/update an identity's lifecycle state to the one provided and update the corresponding identity profile. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityId | **String** | True | ID of the identity to update. + Body | SetLifecycleStateRequest | [**SetLifecycleStateRequest**](../models/set-lifecycle-state-request) | True | + +### Return type +[**SetLifecycleState200Response**](../models/set-lifecycle-state200-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The request was successfully accepted into the system. | SetLifecycleState200Response +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "2c9180857893f1290178944561990364" # String | ID of the identity to update. +$SetLifecycleStateRequest = @""@ + +# Set Lifecycle State + +try { + $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest + Set-LifecycleState-IdentityId $IdentityId -SetLifecycleStateRequest $Result + + # Below is a request that includes all optional parameters + # Set-LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $SetLifecycleStateRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-LifecycleState" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-lifecycle-states +Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | IdentityProfileId | **String** | True | Identity profile ID. +Path | LifecycleStateId | **String** | True | Lifecycle state ID. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption + +### Return type +[**LifecycleState**](../models/lifecycle-state) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The LifecycleState was successfully updated. | LifecycleState +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. +$LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption + + +# Update Lifecycle State + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + 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 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-LifecycleStates" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/MFAConfigurationApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/MFAConfigurationApi.md new file mode 100644 index 000000000..a20f3a99b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/MFAConfigurationApi.md @@ -0,0 +1,384 @@ + +--- +id: mfa-configuration +title: MFAConfiguration +pagination_label: MFAConfiguration +sidebar_label: MFAConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MFAConfiguration', 'MFAConfiguration'] +slug: /tools/sdk/powershell/v3/methods/mfa-configuration +tags: ['SDK', 'Software Development Kit', 'MFAConfiguration', 'MFAConfiguration'] +--- + +# MFAConfiguration + Configure and test multifactor authentication (MFA) methods + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Remove-MFAConfig**](#delete-mfa-config) | **DELETE** `/mfa/{method}/delete` | Delete MFA method configuration +[**Get-MFADuoConfig**](#get-mfa-duo-config) | **GET** `/mfa/duo-web/config` | Configuration of Duo MFA method +[**Get-MFAKbaConfig**](#get-mfa-kba-config) | **GET** `/mfa/kba/config` | Configuration of KBA MFA method +[**Get-MFAOktaConfig**](#get-mfa-okta-config) | **GET** `/mfa/okta-verify/config` | Configuration of Okta MFA method +[**Set-MFADuoConfig**](#set-mfa-duo-config) | **PUT** `/mfa/duo-web/config` | Set Duo MFA configuration +[**Set-MFAKBAConfig**](#set-mfakba-config) | **POST** `/mfa/kba/config/answers` | Set MFA KBA configuration +[**Set-MFAOktaConfig**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set Okta MFA configuration +[**Test-MFAConfig**](#test-mfa-config) | **GET** `/mfa/{method}/test` | MFA method's test configuration + +## delete-mfa-config +This API removes the configuration for the specified MFA method. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Method | **String** | True | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + +### Return type +[**MfaOktaConfig**](../models/mfa-okta-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | MFA configuration of an MFA method. | MfaOktaConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + +# Delete MFA method configuration + +try { + Remove-MFAConfig-Method $Method + + # Below is a request that includes all optional parameters + # Remove-MFAConfig -Method $Method +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-MFAConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-mfa-duo-config +This API returns the configuration of an Duo MFA method. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**MfaDuoConfig**](../models/mfa-duo-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The configuration of an Duo MFA method. | MfaDuoConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Configuration of Duo MFA method + +try { + Get-MFADuoConfig + + # Below is a request that includes all optional parameters + # Get-MFADuoConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFADuoConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-mfa-kba-config +This API returns the KBA configuration for MFA. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | AllLanguages | **Boolean** | (optional) | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false + +### Return type +[**KbaQuestion[]**](../models/kba-question) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The configuration for KBA MFA method. | KbaQuestion[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + +# Configuration of KBA MFA method + +try { + Get-MFAKbaConfig + + # Below is a request that includes all optional parameters + # Get-MFAKbaConfig -AllLanguages $AllLanguages +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFAKbaConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-mfa-okta-config +This API returns the configuration of an Okta MFA method. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**MfaOktaConfig**](../models/mfa-okta-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The configuration of an Okta MFA method. | MfaOktaConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Configuration of Okta MFA method + +try { + Get-MFAOktaConfig + + # Below is a request that includes all optional parameters + # Get-MFAOktaConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFAOktaConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-mfa-duo-config +This API sets the configuration of an Duo MFA method. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | MfaDuoConfig | [**MfaDuoConfig**](../models/mfa-duo-config) | True | + +### Return type +[**MfaDuoConfig**](../models/mfa-duo-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | MFA configuration of an Duo MFA method. | MfaDuoConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$MfaDuoConfig = @"{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" +}"@ + +# Set Duo MFA configuration + +try { + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-MFADuoConfig-MfaDuoConfig $Result + + # Below is a request that includes all optional parameters + # Set-MFADuoConfig -MfaDuoConfig $MfaDuoConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFADuoConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-mfakba-config +This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | KbaAnswerRequestItem | [**[]KbaAnswerRequestItem**](../models/kba-answer-request-item) | True | + +### Return type +[**KbaAnswerResponseItem[]**](../models/kba-answer-response-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The new KBA configuration for the user. | KbaAnswerResponseItem[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" +}"@ # KbaAnswerRequestItem[] | + + +# Set MFA KBA configuration + +try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-MFAKBAConfig-KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Set-MFAKBAConfig -KbaAnswerRequestItem $KbaAnswerRequestItem +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAKBAConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-mfa-okta-config +This API sets the configuration of an Okta MFA method. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | MfaOktaConfig | [**MfaOktaConfig**](../models/mfa-okta-config) | True | + +### Return type +[**MfaOktaConfig**](../models/mfa-okta-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | MFA configuration of an Okta MFA method. | MfaOktaConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$MfaOktaConfig = @"{ + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" +}"@ + +# Set Okta MFA configuration + +try { + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-MFAOktaConfig-MfaOktaConfig $Result + + # Below is a request that includes all optional parameters + # Set-MFAOktaConfig -MfaOktaConfig $MfaOktaConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAOktaConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## test-mfa-config +This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Method | **String** | True | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + +### Return type +[**MfaConfigTestResponse**](../models/mfa-config-test-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The result of configuration test for the MFA provider. | MfaConfigTestResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + +# MFA method's test configuration + +try { + Test-MFAConfig-Method $Method + + # Below is a request that includes all optional parameters + # Test-MFAConfig -Method $Method +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-MFAConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/MFAControllerApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/MFAControllerApi.md new file mode 100644 index 000000000..62f4d2e2b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/MFAControllerApi.md @@ -0,0 +1,305 @@ + +--- +id: mfa-controller +title: MFAController +pagination_label: MFAController +sidebar_label: MFAController +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MFAController', 'MFAController'] +slug: /tools/sdk/powershell/v3/methods/mfa-controller +tags: ['SDK', 'Software Development Kit', 'MFAController', 'MFAController'] +--- + +# MFAController + This API used for multifactor authentication functionality belong to gov-multi-auth service. This controller allow you to verify authentication by specified method + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-SendToken**](#create-send-token) | **POST** `/mfa/token/send` | Create and send user token +[**Ping-VerificationStatus**](#ping-verification-status) | **POST** `/mfa/{method}/poll` | Polling MFA method by VerificationPollRequest +[**Send-DuoVerifyRequest**](#send-duo-verify-request) | **POST** `/mfa/duo-web/verify` | Verifying authentication via Duo method +[**Send-KbaAnswers**](#send-kba-answers) | **POST** `/mfa/kba/authenticate` | Authenticate KBA provided MFA method +[**Send-OktaVerifyRequest**](#send-okta-verify-request) | **POST** `/mfa/okta-verify/verify` | Verifying authentication via Okta method +[**Send-TokenAuthRequest**](#send-token-auth-request) | **POST** `/mfa/token/authenticate` | Authenticate Token provided MFA method + +## create-send-token +This API send token request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | SendTokenRequest | [**SendTokenRequest**](../models/send-token-request) | True | + +### Return type +[**SendTokenResponse**](../models/send-token-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Token send status. | SendTokenResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SendTokenRequest = @"{ + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK" +}"@ + +# Create and send user token + +try { + $Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest + New-SendToken-SendTokenRequest $Result + + # Below is a request that includes all optional parameters + # New-SendToken -SendTokenRequest $SendTokenRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SendToken" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## ping-verification-status +This API poll the VerificationPollRequest for the specified MFA method. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Method | **String** | True | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' + Body | VerificationPollRequest | [**VerificationPollRequest**](../models/verification-poll-request) | True | + +### Return type +[**VerificationResponse**](../models/verification-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | MFA VerificationPollRequest status an MFA method. | VerificationResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' +$VerificationPollRequest = @"{ + "requestId" : "089899f13a8f4da7824996191587bab9" +}"@ + +# Polling MFA method by VerificationPollRequest + +try { + $Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest + Ping-VerificationStatus-Method $Method -VerificationPollRequest $Result + + # Below is a request that includes all optional parameters + # Ping-VerificationStatus -Method $Method -VerificationPollRequest $VerificationPollRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-VerificationStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## send-duo-verify-request +This API Authenticates the user via Duo-Web MFA method. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | DuoVerificationRequest | [**DuoVerificationRequest**](../models/duo-verification-request) | True | + +### Return type +[**VerificationResponse**](../models/verification-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The status of verification request. | VerificationResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$DuoVerificationRequest = @"{ + "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", + "userId" : "2c9180947f0ef465017f215cbcfd004b" +}"@ + +# Verifying authentication via Duo method + +try { + $Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest + Send-DuoVerifyRequest-DuoVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-DuoVerifyRequest -DuoVerificationRequest $DuoVerificationRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-DuoVerifyRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## send-kba-answers +This API Authenticate user in KBA MFA method. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | KbaAnswerRequestItem | [**[]KbaAnswerRequestItem**](../models/kba-answer-request-item) | True | + +### Return type +[**KbaAuthResponse**](../models/kba-auth-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | KBA authenticated status. | KbaAuthResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" +}"@ # KbaAnswerRequestItem[] | + + +# Authenticate KBA provided MFA method + +try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Send-KbaAnswers-KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Send-KbaAnswers -KbaAnswerRequestItem $KbaAnswerRequestItem +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-KbaAnswers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## send-okta-verify-request +This API Authenticates the user via Okta-Verify MFA method. Request requires a header called 'slpt-forwarding', and it must contain a remote IP Address of caller. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | OktaVerificationRequest | [**OktaVerificationRequest**](../models/okta-verification-request) | True | + +### Return type +[**VerificationResponse**](../models/verification-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The status of verification request. | VerificationResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$OktaVerificationRequest = @"{ + "userId" : "example@mail.com" +}"@ + +# Verifying authentication via Okta method + +try { + $Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest + Send-OktaVerifyRequest-OktaVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-OktaVerifyRequest -OktaVerificationRequest $OktaVerificationRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-OktaVerifyRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## send-token-auth-request +This API Authenticate user in Token MFA method. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | TokenAuthRequest | [**TokenAuthRequest**](../models/token-auth-request) | True | + +### Return type +[**TokenAuthResponse**](../models/token-auth-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Token authenticated status. | TokenAuthResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$TokenAuthRequest = @"{ + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK", + "token" : "12345" +}"@ + +# Authenticate Token provided MFA method + +try { + $Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest + Send-TokenAuthRequest-TokenAuthRequest $Result + + # Below is a request that includes all optional parameters + # Send-TokenAuthRequest -TokenAuthRequest $TokenAuthRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TokenAuthRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/ManagedClientsApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/ManagedClientsApi.md new file mode 100644 index 000000000..59c98423d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/ManagedClientsApi.md @@ -0,0 +1,307 @@ + +--- +id: managed-clients +title: ManagedClients +pagination_label: ManagedClients +sidebar_label: ManagedClients +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClients', 'ManagedClients'] +slug: /tools/sdk/powershell/v3/methods/managed-clients +tags: ['SDK', 'Software Development Kit', 'ManagedClients', 'ManagedClients'] +--- + +# ManagedClients + Use this API to implement managed client functionality. +With this functionality in place, administrators can modify and delete existing managed clients, create new ones, and view and make changes to their log configurations. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-ManagedClient**](#create-managed-client) | **POST** `/managed-clients` | Create Managed Client +[**Remove-ManagedClient**](#delete-managed-client) | **DELETE** `/managed-clients/{id}` | Delete Managed Client +[**Get-ManagedClient**](#get-managed-client) | **GET** `/managed-clients/{id}` | Get Managed Client +[**Get-ManagedClientStatus**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Get Managed Client Status +[**Get-ManagedClients**](#get-managed-clients) | **GET** `/managed-clients` | Get Managed Clients +[**Update-ManagedClient**](#update-managed-client) | **PATCH** `/managed-clients/{id}` | Update Managed Client + +## create-managed-client +Create a new managed client. +The API returns a result that includes the managed client ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | ManagedClientRequest | [**ManagedClientRequest**](../models/managed-client-request) | True | + +### Return type +[**ManagedClient**](../models/managed-client) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Created managed client. | ManagedClient +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$ManagedClientRequest = @"{ + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" +}"@ + +# Create Managed Client + +try { + $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest + New-ManagedClient-ManagedClientRequest $Result + + # Below is a request that includes all optional parameters + # New-ManagedClient -ManagedClientRequest $ManagedClientRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedClient" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-managed-client +Delete an existing managed client. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Managed client ID. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + +# Delete Managed Client + +try { + Remove-ManagedClient-Id $Id + + # Below is a request that includes all optional parameters + # Remove-ManagedClient -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedClient" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-managed-client +Get managed client by ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Managed client ID. + +### Return type +[**ManagedClient**](../models/managed-client) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Managed client response. | ManagedClient +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + +# Get Managed Client + +try { + Get-ManagedClient-Id $Id + + # Below is a request that includes all optional parameters + # Get-ManagedClient -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClient" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-managed-client-status +Get a managed client's status, using its ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Managed client ID to get status for. + Query | Type | [**ManagedClientType**](../models/managed-client-type) | True | Managed client type to get status for. + +### Return type +[**ManagedClientStatus**](../models/managed-client-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Response with the managed client status, with the given ID and type. | ManagedClientStatus +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "aClientId" # String | Managed client ID to get status for. +$Type = "CCG" # ManagedClientType | Managed client type to get status for. + +# Get Managed Client Status + +try { + Get-ManagedClientStatus-Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-ManagedClientStatus -Id $Id -Type $Type +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClientStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-managed-clients +List managed clients. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* + +### Return type +[**ManagedClient[]**](../models/managed-client) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Response with a list of managed clients, based on the specified query parameters. | ManagedClient[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'name eq "client name"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + +# Get Managed Clients + +try { + Get-ManagedClients + + # Below is a request that includes all optional parameters + # Get-ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClients" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-managed-client +Update an existing managed client. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Managed client ID. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | JSONPatch payload used to update the object. + +### Return type +[**ManagedClient**](../models/managed-client) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated managed client. | ManagedClient +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | JSONPatch payload used to update the object. + + +# Update Managed Client + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ManagedClient-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-ManagedClient -Id $Id -JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedClient" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/ManagedClustersApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/ManagedClustersApi.md new file mode 100644 index 000000000..5f380e814 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/ManagedClustersApi.md @@ -0,0 +1,358 @@ + +--- +id: managed-clusters +title: ManagedClusters +pagination_label: ManagedClusters +sidebar_label: ManagedClusters +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusters', 'ManagedClusters'] +slug: /tools/sdk/powershell/v3/methods/managed-clusters +tags: ['SDK', 'Software Development Kit', 'ManagedClusters', 'ManagedClusters'] +--- + +# ManagedClusters + Use this API to implement managed cluster functionality. +With this functionality in place, administrators can modify and delete existing managed clients, get their statuses, and create new ones. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-ManagedCluster**](#create-managed-cluster) | **POST** `/managed-clusters` | Create Create Managed Cluster +[**Remove-ManagedCluster**](#delete-managed-cluster) | **DELETE** `/managed-clusters/{id}` | Delete Managed Cluster +[**Get-ClientLogConfiguration**](#get-client-log-configuration) | **GET** `/managed-clusters/{id}/log-config` | Get Managed Cluster Log Configuration +[**Get-ManagedCluster**](#get-managed-cluster) | **GET** `/managed-clusters/{id}` | Get Managed Cluster +[**Get-ManagedClusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Get Managed Clusters +[**Send-ClientLogConfiguration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update Managed Cluster Log Configuration +[**Update-ManagedCluster**](#update-managed-cluster) | **PATCH** `/managed-clusters/{id}` | Update Managed Cluster + +## create-managed-cluster +Create a new Managed Cluster. +The API returns a result that includes the managed cluster ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | ManagedClusterRequest | [**ManagedClusterRequest**](../models/managed-cluster-request) | True | + +### Return type +[**ManagedCluster**](../models/managed-cluster) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Created managed cluster. | ManagedCluster +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$ManagedClusterRequest = @"{ + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" +}"@ + +# Create Create Managed Cluster + +try { + $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest + New-ManagedCluster-ManagedClusterRequest $Result + + # Below is a request that includes all optional parameters + # New-ManagedCluster -ManagedClusterRequest $ManagedClusterRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-managed-cluster +Delete an existing managed cluster. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Managed cluster ID. + Query | RemoveClients | **Boolean** | (optional) (default to $false) | Flag to determine the need to delete a cluster with clients. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. +$RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) + +# Delete Managed Cluster + +try { + Remove-ManagedCluster-Id $Id + + # Below is a request that includes all optional parameters + # Remove-ManagedCluster -Id $Id -RemoveClients $RemoveClients +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedCluster" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-client-log-configuration +Get a managed cluster's log configuration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of managed cluster to get log configuration for. + +### Return type +[**ClientLogConfiguration**](../models/client-log-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Log configuration of managed cluster for given cluster ID. | ClientLogConfiguration +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. + +# Get Managed Cluster Log Configuration + +try { + Get-ClientLogConfiguration-Id $Id + + # Below is a request that includes all optional parameters + # Get-ClientLogConfiguration -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ClientLogConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-managed-cluster +Get a managed cluster by ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Managed cluster ID. + +### Return type +[**ManagedCluster**](../models/managed-cluster) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Response with managed cluster for the given ID. | ManagedCluster +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + +# Get Managed Cluster + +try { + Get-ManagedCluster-Id $Id + + # Below is a request that includes all optional parameters + # Get-ManagedCluster -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedCluster" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-managed-clusters +List current organization's managed clusters, based on request context. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* + +### Return type +[**ManagedCluster[]**](../models/managed-cluster) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Response with a list of managed clusters. | ManagedCluster[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'operational eq "operation"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + +# Get Managed Clusters + +try { + Get-ManagedClusters + + # Below is a request that includes all optional parameters + # Get-ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClusters" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-client-log-configuration +Update a managed cluster's log configuration. You may only specify one of `durationMinutes` or `expiration`, up to 1440 minutes (24 hours) in the future. If neither is specified, the default value for `durationMinutes` is 240. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the managed cluster to update the log configuration for. + Body | PutClientLogConfigurationRequest | [**PutClientLogConfigurationRequest**](../models/put-client-log-configuration-request) | True | Client log configuration for the given managed cluster. + +### Return type +[**ClientLogConfiguration**](../models/client-log-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Response with updated client log configuration for the given managed cluster. | ClientLogConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. +$PutClientLogConfigurationRequest = @""@ + +# Update Managed Cluster Log Configuration + +try { + $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest + Send-ClientLogConfiguration-Id $Id -PutClientLogConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $PutClientLogConfigurationRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-managed-cluster +Update an existing managed cluster. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Managed cluster ID. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | JSONPatch payload used to update the object. + +### Return type +[**ManagedCluster**](../models/managed-cluster) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated managed cluster. | ManagedCluster +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | JSONPatch payload used to update the object. + + +# Update Managed Cluster + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ManagedCluster-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-ManagedCluster -Id $Id -JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/NonEmployeeLifecycleManagementApi.md new file mode 100644 index 000000000..c9b66b176 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/NonEmployeeLifecycleManagementApi.md @@ -0,0 +1,1653 @@ + +--- +id: non-employee-lifecycle-management +title: NonEmployeeLifecycleManagement +pagination_label: NonEmployeeLifecycleManagement +sidebar_label: NonEmployeeLifecycleManagement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeLifecycleManagement', 'NonEmployeeLifecycleManagement'] +slug: /tools/sdk/powershell/v3/methods/non-employee-lifecycle-management +tags: ['SDK', 'Software Development Kit', 'NonEmployeeLifecycleManagement', 'NonEmployeeLifecycleManagement'] +--- + +# NonEmployeeLifecycleManagement + Use this API to implement non-employee lifecycle management functionality. +With this functionality in place, administrators can create non-employee records and configure them for use in their organizations. +This allows organizations to provide secure access to non-employees and control that access. + +The 'non-employee' term refers to any consultant, contractor, intern, or other user in an organization who is not a full-time permanent employee. +Organizations can track non-employees' access and activity in Identity Security Cloud by creating and maintaining non-employee sources. +Organizations can have a maximum of 50 non-employee sources. + +By using SailPoint's Non-Employee Lifecycle Management functionality, you agree to the following: + +- SailPoint is not responsible for storing sensitive data. +You may only add account attributes to non-employee identities that are necessary for business operations and are consistent with your contractual limitations on data that may be sent or stored in Identity Security Cloud. + +- You are responsible for regularly downloading your list of non-employee accounts for all the sources you create and storing this list of accounts in a managed location to maintain an authoritative system of record and backup data for these accounts. + +To manage non-employees in Identity Security Cloud, administrators must create a non-employee source and add accounts to the source. + +To create a non-employee source in Identity Security Cloud, administrators must use the Admin panel to go to Connections > Sources. +They must then specify 'Non-Employee' in the 'Source Type' field. +Refer to [Creating a Non-Employee Source](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#creating-a-non-employee-source) for more details about how to create non-employee sources. + +To add accounts to a non-employee source in Identity Security Cloud, administrators can select the non-employee source and add the accounts. +They can also use the 'Manage Non-Employees' widget on their user dashboards to reach the list of sources and then select the non-employee source they want to add the accounts to. + +Administrators can either add accounts individually or in bulk. Each non-employee source can have a maximum of 20,000 accounts. +To add accounts in bulk, they must select the 'Bulk Upload' option and upload a CSV file. +Refer to [Adding Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html#adding-accounts) for more details about how to add accounts to non-employee sources. + +Once administrators have created the non-employee source and added accounts to it, they can create identity profiles to generate identities for the non-employee accounts and manage the non-employee identities the same way they would any other identities. + +Refer to [Managing Non-Employee Sources and Accounts](https://documentation.sailpoint.com/saas/help/common/non-employee-mgmt.html) for more information about non-employee lifecycle management. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Approve-NonEmployeeRequest**](#approve-non-employee-request) | **POST** `/non-employee-approvals/{id}/approve` | Approve a Non-Employee Request +[**New-NonEmployeeRecord**](#create-non-employee-record) | **POST** `/non-employee-records` | Create Non-Employee Record +[**New-NonEmployeeRequest**](#create-non-employee-request) | **POST** `/non-employee-requests` | Create Non-Employee Request +[**New-NonEmployeeSource**](#create-non-employee-source) | **POST** `/non-employee-sources` | Create Non-Employee Source +[**New-NonEmployeeSourceSchemaAttributes**](#create-non-employee-source-schema-attributes) | **POST** `/non-employee-sources/{sourceId}/schema-attributes` | Create a new Schema Attribute for Non-Employee Source +[**Remove-NonEmployeeRecord**](#delete-non-employee-record) | **DELETE** `/non-employee-records/{id}` | Delete Non-Employee Record +[**Remove-NonEmployeeRecordsInBulk**](#delete-non-employee-records-in-bulk) | **POST** `/non-employee-records/bulk-delete` | Delete Multiple Non-Employee Records +[**Remove-NonEmployeeRequest**](#delete-non-employee-request) | **DELETE** `/non-employee-requests/{id}` | Delete Non-Employee Request +[**Remove-NonEmployeeSchemaAttribute**](#delete-non-employee-schema-attribute) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete a Schema Attribute for Non-Employee Source +[**Remove-NonEmployeeSource**](#delete-non-employee-source) | **DELETE** `/non-employee-sources/{sourceId}` | Delete Non-Employee Source +[**Remove-NonEmployeeSourceSchemaAttributes**](#delete-non-employee-source-schema-attributes) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes for Non-Employee Source +[**Export-NonEmployeeRecords**](#export-non-employee-records) | **GET** `/non-employee-sources/{id}/non-employees/download` | Exports Non-Employee Records to CSV +[**Export-NonEmployeeSourceSchemaTemplate**](#export-non-employee-source-schema-template) | **GET** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports Source Schema Template +[**Get-NonEmployeeApproval**](#get-non-employee-approval) | **GET** `/non-employee-approvals/{id}` | Get a non-employee approval item detail +[**Get-NonEmployeeApprovalSummary**](#get-non-employee-approval-summary) | **GET** `/non-employee-approvals/summary/{requested-for}` | Get Summary of Non-Employee Approval Requests +[**Get-NonEmployeeBulkUploadStatus**](#get-non-employee-bulk-upload-status) | **GET** `/non-employee-sources/{id}/non-employee-bulk-upload/status` | Obtain the status of bulk upload on the source +[**Get-NonEmployeeRecord**](#get-non-employee-record) | **GET** `/non-employee-records/{id}` | Get a Non-Employee Record +[**Get-NonEmployeeRequest**](#get-non-employee-request) | **GET** `/non-employee-requests/{id}` | Get a Non-Employee Request +[**Get-NonEmployeeRequestSummary**](#get-non-employee-request-summary) | **GET** `/non-employee-requests/summary/{requested-for}` | Get Summary of Non-Employee Requests +[**Get-NonEmployeeSchemaAttribute**](#get-non-employee-schema-attribute) | **GET** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get Schema Attribute Non-Employee Source +[**Get-NonEmployeeSource**](#get-non-employee-source) | **GET** `/non-employee-sources/{sourceId}` | Get a Non-Employee Source +[**Get-NonEmployeeSourceSchemaAttributes**](#get-non-employee-source-schema-attributes) | **GET** `/non-employee-sources/{sourceId}/schema-attributes` | List Schema Attributes Non-Employee Source +[**Import-NonEmployeeRecordsInBulk**](#import-non-employee-records-in-bulk) | **POST** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or Updates, Non-Employee Records +[**Get-NonEmployeeApprovals**](#list-non-employee-approvals) | **GET** `/non-employee-approvals` | Get List of Non-Employee Approval Requests +[**Get-NonEmployeeRecords**](#list-non-employee-records) | **GET** `/non-employee-records` | List Non-Employee Records +[**Get-NonEmployeeRequests**](#list-non-employee-requests) | **GET** `/non-employee-requests` | List Non-Employee Requests +[**Get-NonEmployeeSources**](#list-non-employee-sources) | **GET** `/non-employee-sources` | List Non-Employee Sources +[**Update-NonEmployeeRecord**](#patch-non-employee-record) | **PATCH** `/non-employee-records/{id}` | Patch Non-Employee Record +[**Update-NonEmployeeSchemaAttribute**](#patch-non-employee-schema-attribute) | **PATCH** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch a Schema Attribute for Non-Employee Source +[**Update-NonEmployeeSource**](#patch-non-employee-source) | **PATCH** `/non-employee-sources/{sourceId}` | Patch a Non-Employee Source +[**Deny-NonEmployeeRequest**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request +[**Update-NonEmployeeRecord**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update Non-Employee Record + +## approve-non-employee-request +Approves a non-employee approval request and notifies the next approver. The current user must be the requested approver. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-Employee approval item id (UUID) + Body | NonEmployeeApprovalDecision | [**NonEmployeeApprovalDecision**](../models/non-employee-approval-decision) | True | + +### Return type +[**NonEmployeeApprovalItem**](../models/non-employee-approval-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee approval item object. | NonEmployeeApprovalItem +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) +$NonEmployeeApprovalDecision = @"{ + "comment" : "Approved by manager" +}"@ + +# Approve a Non-Employee Request + +try { + $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision + Approve-NonEmployeeRequest-Id $Id -NonEmployeeApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $NonEmployeeApprovalDecision +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-NonEmployeeRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-non-employee-record +This request will create a non-employee record. +Requires role context of `idn:nesr:create` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | NonEmployeeRequestBody | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | True | Non-Employee record creation request body. + +### Return type +[**NonEmployeeRecord**](../models/non-employee-record) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Created non-employee record. | NonEmployeeRecord +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$NonEmployeeRequestBody = @"{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" +}"@ + +# Create Non-Employee Record + +try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-NonEmployeeRecord-NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-NonEmployeeRecord -NonEmployeeRequestBody $NonEmployeeRequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeRecord" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-non-employee-request +This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | NonEmployeeRequestBody | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | True | Non-Employee creation request body + +### Return type +[**NonEmployeeRequest**](../models/non-employee-request) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee request creation object | NonEmployeeRequest +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$NonEmployeeRequestBody = @"{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" +}"@ + +# Create Non-Employee Request + +try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-NonEmployeeRequest-NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-NonEmployeeRequest -NonEmployeeRequestBody $NonEmployeeRequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-non-employee-source +This request will create a non-employee source. Requires role context of `idn:nesr:create` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | NonEmployeeSourceRequestBody | [**NonEmployeeSourceRequestBody**](../models/non-employee-source-request-body) | True | Non-Employee source creation request body. + +### Return type +[**NonEmployeeSourceWithCloudExternalId**](../models/non-employee-source-with-cloud-external-id) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Created non-employee source. | NonEmployeeSourceWithCloudExternalId +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$NonEmployeeSourceRequestBody = @"{ + "owner" : { + "id" : "2c91808570313110017040b06f344ec9" + }, + "managementWorkgroup" : "123299", + "accountManagers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ], + "name" : "Retail", + "description" : "Source description", + "approvers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ] +}"@ + +# Create Non-Employee Source + +try { + $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody + New-NonEmployeeSource-NonEmployeeSourceRequestBody $Result + + # Below is a request that includes all optional parameters + # New-NonEmployeeSource -NonEmployeeSourceRequestBody $NonEmployeeSourceRequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeSource" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-non-employee-source-schema-attributes +This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response. +Requires role context of `idn:nesr:create` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id + Body | NonEmployeeSchemaAttributeBody | [**NonEmployeeSchemaAttributeBody**](../models/non-employee-schema-attribute-body) | True | + +### Return type +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Schema Attribute created. | NonEmployeeSchemaAttribute +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id +$NonEmployeeSchemaAttributeBody = @"{ + "helpText" : "The unique identifier for the account", + "label" : "Account Name", + "placeholder" : "Enter a unique user name for this account.", + "type" : "TEXT", + "technicalName" : "account.name", + "required" : true +}"@ + +# Create a new Schema Attribute for Non-Employee Source + +try { + $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody + New-NonEmployeeSourceSchemaAttributes-SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result + + # Below is a request that includes all optional parameters + # New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $NonEmployeeSchemaAttributeBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-non-employee-record +This request will delete a non-employee record. +Requires role context of `idn:nesr:delete` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-Employee record id (UUID) + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) + +# Delete Non-Employee Record + +try { + Remove-NonEmployeeRecord-Id $Id + + # Below is a request that includes all optional parameters + # Remove-NonEmployeeRecord -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRecord" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-non-employee-records-in-bulk +This request will delete multiple non-employee records based on the non-employee ids provided. Requires role context of `idn:nesr:delete` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | DeleteNonEmployeeRecordsInBulkRequest | [**DeleteNonEmployeeRecordsInBulkRequest**](../models/delete-non-employee-records-in-bulk-request) | True | Non-Employee bulk delete request body. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$DeleteNonEmployeeRecordsInBulkRequest = @""@ + +# Delete Multiple Non-Employee Records + +try { + $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest + Remove-NonEmployeeRecordsInBulk-DeleteNonEmployeeRecordsInBulkRequest $Result + + # Below is a request that includes all optional parameters + # Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $DeleteNonEmployeeRecordsInBulkRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-non-employee-request +This request will delete a non-employee request. +Requires role context of `idn:nesr:delete` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-Employee request id in the UUID format + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format + +# Delete Non-Employee Request + +try { + Remove-NonEmployeeRequest-Id $Id + + # Below is a request that includes all optional parameters + # Remove-NonEmployeeRequest -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-non-employee-schema-attribute +This end-point deletes a specific schema attribute for a non-employee source. +Requires role context of `idn:nesr:delete` + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | AttributeId | **String** | True | The Schema Attribute Id (UUID) +Path | SourceId | **String** | True | The Source id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) +$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + +# Delete a Schema Attribute for Non-Employee Source + +try { + Remove-NonEmployeeSchemaAttribute-AttributeId $AttributeId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-non-employee-source +This request will delete a non-employee source. Requires role context of `idn:nesr:delete`. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | Source Id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id + +# Delete Non-Employee Source + +try { + Remove-NonEmployeeSource-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-NonEmployeeSource -SourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSource" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-non-employee-source-schema-attributes +This end-point deletes all custom schema attributes for a non-employee source. Requires role context of `idn:nesr:delete` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + +# Delete all custom schema attributes for Non-Employee Source + +try { + Remove-NonEmployeeSourceSchemaAttributes-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-NonEmployeeSourceSchemaAttributes -SourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## export-non-employee-records +This requests a CSV download for all non-employees from a provided source. Requires role context of `idn:nesr:read` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source Id (UUID) + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Exported CSV | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: text/csv, application/json + +### Example +```powershell +$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) + +# Exports Non-Employee Records to CSV + +try { + Export-NonEmployeeRecords-Id $Id + + # Below is a request that includes all optional parameters + # Export-NonEmployeeRecords -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-NonEmployeeRecords" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## export-non-employee-source-schema-template +This requests a download for the Source Schema Template for a provided source. Requires role context of `idn:nesr:read` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source Id (UUID) + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Exported Source Schema Template | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: text/csv, application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID) + +# Exports Source Schema Template + +try { + Export-NonEmployeeSourceSchemaTemplate-Id $Id + + # Below is a request that includes all optional parameters + # Export-NonEmployeeSourceSchemaTemplate -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-NonEmployeeSourceSchemaTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-approval +Gets a non-employee approval item detail. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in which case they +can get any approval. + 2. The user owns the requested approval. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-Employee approval item id (UUID) + Query | IncludeDetail | **Boolean** | (optional) | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* + +### Return type +[**NonEmployeeApprovalItemDetail**](../models/non-employee-approval-item-detail) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee approval item object. | NonEmployeeApprovalItemDetail +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) +$IncludeDetail = $true # Boolean | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) + +# Get a non-employee approval item detail + +try { + Get-NonEmployeeApproval-Id $Id + + # Below is a request that includes all optional parameters + # Get-NonEmployeeApproval -Id $Id -IncludeDetail $IncludeDetail +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApproval" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-approval-summary +This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id. + 2. The current user is an approver, in which case "me" should be provided +as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | RequestedFor | **String** | True | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + +### Return type +[**NonEmployeeApprovalSummary**](../models/non-employee-approval-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | summary of non-employee approval requests | NonEmployeeApprovalSummary +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + +# Get Summary of Non-Employee Approval Requests + +try { + Get-NonEmployeeApprovalSummary-RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-NonEmployeeApprovalSummary -RequestedFor $RequestedFor +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApprovalSummary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-bulk-upload-status +The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. +Requires role context of `idn:nesr:read` + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source ID (UUID) + +### Return type +[**NonEmployeeBulkUploadStatus**](../models/non-employee-bulk-upload-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Status of the newest bulk-upload job, if any. | NonEmployeeBulkUploadStatus +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source ID (UUID) + +# Obtain the status of bulk upload on the source + +try { + Get-NonEmployeeBulkUploadStatus-Id $Id + + # Below is a request that includes all optional parameters + # Get-NonEmployeeBulkUploadStatus -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeBulkUploadStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-record +This gets a non-employee record. +Requires role context of `idn:nesr:read` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-Employee record id (UUID) + +### Return type +[**NonEmployeeRecord**](../models/non-employee-record) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee record object | NonEmployeeRecord +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) + +# Get a Non-Employee Record + +try { + Get-NonEmployeeRecord-Id $Id + + # Below is a request that includes all optional parameters + # Get-NonEmployeeRecord -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRecord" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-request +This gets a non-employee request. +There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in this case the user +can get the non-employee request for any user. + 2. The user must be the owner of the non-employee request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-Employee request id (UUID) + +### Return type +[**NonEmployeeRequest**](../models/non-employee-request) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee request object. | NonEmployeeRequest +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID) + +# Get a Non-Employee Request + +try { + Get-NonEmployeeRequest-Id $Id + + # Below is a request that includes all optional parameters + # Get-NonEmployeeRequest -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-request-summary +This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id. + 2. The current user is an account manager, in which case "me" should be +provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | RequestedFor | **String** | True | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + +### Return type +[**NonEmployeeRequestSummary**](../models/non-employee-request-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee request summary object. | NonEmployeeRequestSummary +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + +# Get Summary of Non-Employee Requests + +try { + Get-NonEmployeeRequestSummary-RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-NonEmployeeRequestSummary -RequestedFor $RequestedFor +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequestSummary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-schema-attribute +This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | AttributeId | **String** | True | The Schema Attribute Id (UUID) +Path | SourceId | **String** | True | The Source id + +### Return type +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Schema Attribute | NonEmployeeSchemaAttribute +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) +$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + +# Get Schema Attribute Non-Employee Source + +try { + Get-NonEmployeeSchemaAttribute-AttributeId $AttributeId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-source +This gets a non-employee source. There are two contextual uses for the requested-for path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request any source. + 2. The current user is an account manager, in which case the user can only +request sources that they own. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | Source Id + +### Return type +[**NonEmployeeSource**](../models/non-employee-source) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee source object. | NonEmployeeSource +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id + +# Get a Non-Employee Source + +try { + Get-NonEmployeeSource-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-NonEmployeeSource -SourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSource" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-non-employee-source-schema-attributes +This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. +Requires role context of `idn:nesr:read` or the user must be an account manager of the source. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id + +### Return type +[**NonEmployeeSchemaAttribute[]**](../models/non-employee-schema-attribute) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of Schema Attributes | NonEmployeeSchemaAttribute[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + +# List Schema Attributes Non-Employee Source + +try { + Get-NonEmployeeSourceSchemaAttributes-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-NonEmployeeSourceSchemaAttributes -SourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-non-employee-records-in-bulk +This post will import, or update, Non-Employee records found in the CSV. Requires role context of `idn:nesr:create` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source Id (UUID) + | Data | **System.IO.FileInfo** | True | + +### Return type +[**NonEmployeeBulkUploadJob**](../models/non-employee-bulk-upload-job) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | The CSV was accepted to be bulk inserted now or at a later time. | NonEmployeeBulkUploadJob +400 | Client Error - Returned if the request body is invalid. The response body will contain the list of specific errors with one on each line. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) +$Data = # System.IO.FileInfo | + +# Imports, or Updates, Non-Employee Records + +try { + Import-NonEmployeeRecordsInBulk-Id $Id -Data $Data + + # Below is a request that includes all optional parameters + # Import-NonEmployeeRecordsInBulk -Id $Id -Data $Data +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-NonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-non-employee-approvals +This gets a list of non-employee approval requests. +There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in which case they +can list the approvals for any approver. + 2. The user owns the requested approval. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | RequestedFor | **String** | (optional) | The identity for whom the request was made. *me* indicates the current user. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** + +### Return type +[**NonEmployeeApprovalItem[]**](../models/non-employee-approval-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of approval items. | NonEmployeeApprovalItem[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity for whom the request was made. *me* indicates the current user. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'approvalStatus eq "Pending"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) +$Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + +# Get List of Non-Employee Approval Requests + +try { + Get-NonEmployeeApprovals + + # Below is a request that includes all optional parameters + # Get-NonEmployeeApprovals -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApprovals" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-non-employee-records +This gets a list of non-employee records. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:read`, in which case they can get a list of all of the non-employees. + 2. The user is an account manager, in which case they can get a list of the non-employees that they manage. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* + +### Return type +[**NonEmployeeRecord[]**](../models/non-employee-record) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee record objects | NonEmployeeRecord[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "accountName,sourceId" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) +$Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + +# List Non-Employee Records + +try { + Get-NonEmployeeRecords + + # Below is a request that includes all optional parameters + # Get-NonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRecords" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-non-employee-requests +This gets a list of non-employee requests. There are two contextual uses for the `requested-for` path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request a list non-employee requests assigned to a particular account manager by passing in that manager's id. + 2. The current user is an account manager, in which case "me" should be +provided as the `requested-for` value. This will provide the user with a list of the non-employee requests in the source(s) he or she manages. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | RequestedFor | **String** | True | The identity for whom the request was made. *me* indicates the current user. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* + +### Return type +[**NonEmployeeRequest[]**](../models/non-employee-request) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of non-employee request objects. | NonEmployeeRequest[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RequestedFor = "e136567de87e4d029e60b3c3c55db56d" # String | The identity for whom the request was made. *me* indicates the current user. +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "created,approvalStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) +$Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + +# List Non-Employee Requests + +try { + 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 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequests" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-non-employee-sources +This gets a list of non-employee sources. There are two contextual uses for the requested-for path parameter: + 1. The user has the role context of `idn:nesr:read`, in which case he or +she may request a list sources assigned to a particular account manager by passing in that manager's id. + 2. The current user is an account manager, in which case "me" should be +provided as the `requested-for` value. This will provide the user with a list of the sources that he or she owns. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | RequestedFor | **String** | True | The identity for whom the request was made. *me* indicates the current user. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | NonEmployeeCount | **Boolean** | (optional) | The flag to determine whether return a non-employee count associate with source. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** + +### Return type +[**NonEmployeeSourceWithNECount[]**](../models/non-employee-source-with-ne-count) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of non-employee sources objects. | NonEmployeeSourceWithNECount[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$NonEmployeeCount = $true # Boolean | The flag to determine whether return a non-employee count associate with source. (optional) +$Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) + +# List Non-Employee Sources + +try { + 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 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSources" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-non-employee-record +This request will patch a non-employee record. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:update`, in which case they +update all available fields. + 2. The user is owner of the source, in this case they can only update the +end date. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-employee record id (UUID) + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + +### Return type +[**NonEmployeeRecord**](../models/non-employee-record) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A patched non-employee record. | NonEmployeeRecord +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + + +# Patch Non-Employee Record + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-NonEmployeeRecord-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeRecord" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-non-employee-schema-attribute +This end-point patches a specific schema attribute for a non-employee SourceId. +Requires role context of `idn:nesr:update` + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | AttributeId | **String** | True | The Schema Attribute Id (UUID) +Path | SourceId | **String** | True | The Source id + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. + +### Return type +[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Schema Attribute was successfully patched. | NonEmployeeSchemaAttribute +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) +$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. + + +# Patch a Schema Attribute for Non-Employee Source + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + 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 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-non-employee-source +patch a non-employee source. (partial update)
Patchable field: **name, description, approvers, accountManagers** Requires role context of `idn:nesr:update`. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | Source Id + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +### Return type +[**NonEmployeeSource**](../models/non-employee-source) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A patched non-employee source object. | NonEmployeeSource +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + + +# Patch a Non-Employee Source + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-NonEmployeeSource-SourceId $SourceId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeSource" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## reject-non-employee-request +This endpoint will reject an approval item request and notify user. The current user must be the requested approver. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-Employee approval item id (UUID) + Body | NonEmployeeRejectApprovalDecision | [**NonEmployeeRejectApprovalDecision**](../models/non-employee-reject-approval-decision) | True | + +### Return type +[**NonEmployeeApprovalItem**](../models/non-employee-approval-item) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Non-Employee approval item object. | NonEmployeeApprovalItem +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) +$NonEmployeeRejectApprovalDecision = @"{ + "comment" : "approved" +}"@ + +# Reject a Non-Employee Request + +try { + $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision + Deny-NonEmployeeRequest-Id $Id -NonEmployeeRejectApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $NonEmployeeRejectApprovalDecision +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-NonEmployeeRequest" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-non-employee-record +This request will update a non-employee record. There are two contextual uses for this endpoint: + 1. The user has the role context of `idn:nesr:update`, in which case they +update all available fields. + 2. The user is owner of the source, in this case they can only update the +end date. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Non-employee record id (UUID) + Body | NonEmployeeRequestBody | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | True | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. + +### Return type +[**NonEmployeeRecord**](../models/non-employee-record) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | An updated non-employee record. | NonEmployeeRecord +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) +$NonEmployeeRequestBody = @"{ + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" +}"@ + +# Update Non-Employee Record + +try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + Update-NonEmployeeRecord-Id $Id -NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $NonEmployeeRequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeRecord" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/OAuthClientsApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/OAuthClientsApi.md new file mode 100644 index 000000000..e1d8d5586 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/OAuthClientsApi.md @@ -0,0 +1,267 @@ + +--- +id: o-auth-clients +title: OAuthClients +pagination_label: OAuthClients +sidebar_label: OAuthClients +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OAuthClients', 'OAuthClients'] +slug: /tools/sdk/powershell/v3/methods/o-auth-clients +tags: ['SDK', 'Software Development Kit', 'OAuthClients', 'OAuthClients'] +--- + +# OAuthClients + Use this API to implement OAuth client functionality. +With this functionality in place, users with the appropriate security scopes can create and configure OAuth clients to use as a way to obtain authorization to use the Identity Security Cloud REST API. +Refer to [Authentication](https://developer.sailpoint.com/docs/api/authentication/) for more information about OAuth and how it works with the Identity Security Cloud REST API. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-OauthClient**](#create-oauth-client) | **POST** `/oauth-clients` | Create OAuth Client +[**Remove-OauthClient**](#delete-oauth-client) | **DELETE** `/oauth-clients/{id}` | Delete OAuth Client +[**Get-OauthClient**](#get-oauth-client) | **GET** `/oauth-clients/{id}` | Get OAuth Client +[**Get-OauthClients**](#list-oauth-clients) | **GET** `/oauth-clients` | List OAuth Clients +[**Update-OauthClient**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch OAuth Client + +## create-oauth-client +This creates an OAuth client. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CreateOAuthClientRequest | [**CreateOAuthClientRequest**](../models/create-o-auth-client-request) | True | + +### Return type +[**CreateOAuthClientResponse**](../models/create-o-auth-client-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Request succeeded. | CreateOAuthClientResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CreateOAuthClientRequest = @"{ + "internal" : false, + "businessName" : "Acme-Solar", + "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", + "refreshTokenValiditySeconds" : 86400, + "type" : "CONFIDENTIAL", + "redirectUris" : [ "http://localhost:12345" ], + "enabled" : true, + "accessType" : "OFFLINE", + "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], + "strongAuthSupported" : false, + "homepageUrl" : "http://localhost:12345", + "accessTokenValiditySeconds" : 750, + "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], + "name" : "Demo API Client", + "claimsSupported" : false +}"@ + +# Create OAuth Client + +try { + $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest + New-OauthClient-CreateOAuthClientRequest $Result + + # Below is a request that includes all optional parameters + # New-OauthClient -CreateOAuthClientRequest $CreateOAuthClientRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-OauthClient" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-oauth-client +This deletes an OAuth client. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The OAuth client id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + +# Delete OAuth Client + +try { + Remove-OauthClient-Id $Id + + # Below is a request that includes all optional parameters + # Remove-OauthClient -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-OauthClient" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-oauth-client +This gets details of an OAuth client. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The OAuth client id + +### Return type +[**GetOAuthClientResponse**](../models/get-o-auth-client-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Request succeeded. | GetOAuthClientResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + +# Get OAuth Client + +try { + Get-OauthClient-Id $Id + + # Below is a request that includes all optional parameters + # Get-OauthClient -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-OauthClient" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-oauth-clients +This gets a list of OAuth clients. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* + +### Return type +[**GetOAuthClientResponse[]**](../models/get-o-auth-client-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of OAuth clients. | GetOAuthClientResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + +# List OAuth Clients + +try { + Get-OauthClients + + # Below is a request that includes all optional parameters + # Get-OauthClients -Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-OauthClients" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-oauth-client +This performs a targeted update to the field(s) of an OAuth client. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The OAuth client id + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported + +### Return type +[**GetOAuthClientResponse**](../models/get-o-auth-client-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Indicates the PATCH operation succeeded, and returns the OAuth client's new representation. | GetOAuthClientResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported + + +# Patch OAuth Client + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-OauthClient-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-OauthClient -Id $Id -JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-OauthClient" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/PasswordConfigurationApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/PasswordConfigurationApi.md new file mode 100644 index 000000000..9e9c5f220 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/PasswordConfigurationApi.md @@ -0,0 +1,170 @@ + +--- +id: password-configuration +title: PasswordConfiguration +pagination_label: PasswordConfiguration +sidebar_label: PasswordConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordConfiguration', 'PasswordConfiguration'] +slug: /tools/sdk/powershell/v3/methods/password-configuration +tags: ['SDK', 'Software Development Kit', 'PasswordConfiguration', 'PasswordConfiguration'] +--- + +# PasswordConfiguration + Use this API to implement organization password configuration functionality. +With this functionality in place, organization administrators can create organization-specific password configurations. + +These configurations include details like custom password instructions, as well as digit token length and duration. + +Refer to [Configuring User Authentication for Password Resets](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html) for more information about organization password configuration functionality. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-PasswordOrgConfig**](#create-password-org-config) | **POST** `/password-org-config` | Create Password Org Config +[**Get-PasswordOrgConfig**](#get-password-org-config) | **GET** `/password-org-config` | Get Password Org Config +[**Send-PasswordOrgConfig**](#put-password-org-config) | **PUT** `/password-org-config` | Update Password Org Config + +## create-password-org-config +This API creates the password org config. Unspecified fields will use default value. +To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true". +Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | PasswordOrgConfig | [**PasswordOrgConfig**](../models/password-org-config) | True | + +### Return type +[**PasswordOrgConfig**](../models/password-org-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password org config. | PasswordOrgConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$PasswordOrgConfig = @"{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true +}"@ + +# Create Password Org Config + +try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + New-PasswordOrgConfig-PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # New-PasswordOrgConfig -PasswordOrgConfig $PasswordOrgConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordOrgConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-password-org-config +This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**PasswordOrgConfig**](../models/password-org-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password org config. | PasswordOrgConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Password Org Config + +try { + Get-PasswordOrgConfig + + # Below is a request that includes all optional parameters + # Get-PasswordOrgConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordOrgConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-password-org-config +This API updates the password org config for specified fields. Other fields will keep original value. +You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions. +Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | PasswordOrgConfig | [**PasswordOrgConfig**](../models/password-org-config) | True | + +### Return type +[**PasswordOrgConfig**](../models/password-org-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password org config. | PasswordOrgConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$PasswordOrgConfig = @"{ + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true +}"@ + +# Update Password Org Config + +try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + Send-PasswordOrgConfig-PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # Send-PasswordOrgConfig -PasswordOrgConfig $PasswordOrgConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PasswordOrgConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/PasswordDictionaryApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/PasswordDictionaryApi.md new file mode 100644 index 000000000..58ab74cf6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/PasswordDictionaryApi.md @@ -0,0 +1,211 @@ + +--- +id: password-dictionary +title: PasswordDictionary +pagination_label: PasswordDictionary +sidebar_label: PasswordDictionary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordDictionary', 'PasswordDictionary'] +slug: /tools/sdk/powershell/v3/methods/password-dictionary +tags: ['SDK', 'Software Development Kit', 'PasswordDictionary', 'PasswordDictionary'] +--- + +# PasswordDictionary + Use this API to implement password dictionary functionality. +With this functionality in place, administrators can create password dictionaries to prevent users from using certain words or characters in their passwords. + +A password dictionary is a list of words or characters that users are prevented from including in their passwords. +This can help protect users from themselves and force them to create passwords that are not easy to break. + +A password dictionary must meet the following requirements to for the API to handle them correctly: + +- It must be in .txt format. + +- All characters must be UTF-8 characters. + +- Each line must contain a single word or character with no spaces or whitespace characters. + +- It must contain at least one line other than the locale string. + +- Each line must not exceed 128 characters. + +- The file must not exceed 2500 lines. + +Administrators should also consider the following when they create their dictionaries: + +- Lines starting with a # represent comments. + +- All words in the password dictionary are case-insensitive. +For example, adding the word "password" to the dictionary also disallows the following: PASSWORD, Password, and PassWord. + +- The dictionary uses substring matching. +For example, adding the word "spring" to the dictionary also disallows the following: Spring124, 345SprinG, and 8spring. +Users can then select 'Change Password' to update their passwords. + +Administrators must do the following to create a password dictionary: + +- Create the text file that will contain the prohibited password values. + +- If the dictionary is not in English, they must add a locale string to the top line: locale:`languageCode`_`countryCode` + +The languageCode value refers to the language's 2-letter ISO 639-1 code. +The countryCode value refers to the country's 2-letter ISO 3166-1 code. + +Refer to this list https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html to see all the available ISO 639-1 language codes and ISO 3166-1 country codes. + +- Upload the .txt file to Identity Security Cloud with [Update Password Dictionary](https://developer.sailpoint.com/docs/api/v3/put-password-dictionary). Uploading a new file always overwrites the previous dictionary file. + +Administrators can then specify which password policies check new passwords against the password dictionary by doing the following: In the Admin panel, they can use the Password Mgmt dropdown menu to select Policies, select the policy, and select the 'Prevent use of words in this site's password dictionary' checkbox beside it. + +Refer to [Configuring Advanced Password Management Options](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html) for more information about password dictionaries. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-PasswordDictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get Password Dictionary +[**Send-PasswordDictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update Password Dictionary + +## get-password-dictionary +This gets password dictionary for the organization. +The password dictionary file can contain lines that are: +1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing +2. empty lines +3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines +4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + +Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + +# Sample password text file + +``` + +# Password dictionary small test file + +locale=en_US + +# Password dictionary prohibited words + +qwerty +abcd +aaaaa +password +qazxsws + +``` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +**String** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A password dictionary response | String +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: text/plain, application/json + +### Example +```powershell + +# Get Password Dictionary + +try { + Get-PasswordDictionary + + # Below is a request that includes all optional parameters + # Get-PasswordDictionary +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordDictionary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-password-dictionary +This updates password dictionary for the organization. +The password dictionary file can contain lines that are: +1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing +2. empty lines +3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines +4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; + maximum length of the line is 128 Unicode codepoints + + +Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). + Password dict file must contain UTF-8 characters only. + +# Sample password text file + +``` + +# Password dictionary small test file + +locale=en_US + +# Password dictionary prohibited words + +qwerty +abcd +aaaaa +password +qazxsws + +``` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | File | **System.IO.FileInfo** | (optional) | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully updated. | +201 | Created. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$File = # System.IO.FileInfo | (optional) + +# Update Password Dictionary + +try { + Send-PasswordDictionary + + # Below is a request that includes all optional parameters + # Send-PasswordDictionary -File $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PasswordDictionary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/PasswordManagementApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/PasswordManagementApi.md new file mode 100644 index 000000000..fbcb0c176 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/PasswordManagementApi.md @@ -0,0 +1,206 @@ + +--- +id: password-management +title: PasswordManagement +pagination_label: PasswordManagement +sidebar_label: PasswordManagement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordManagement', 'PasswordManagement'] +slug: /tools/sdk/powershell/v3/methods/password-management +tags: ['SDK', 'Software Development Kit', 'PasswordManagement', 'PasswordManagement'] +--- + +# PasswordManagement + Use this API to implement password management functionality. +With this functionality in place, users can manage their identity passwords for all their applications. + +In Identity Security Cloud, users can select their names in the upper right corner of the page and use the drop-down menu to select Password Manager. +Password Manager lists the user's identity's applications, possibly grouped to share passwords. +Users can then select 'Change Password' to update their passwords. + +Grouping passwords allows users to update their passwords more broadly, rather than requiring them to update each password individually. +Password Manager may list the applications and sources in the following groups: + +- Password Group: This refers to a group of applications that share a password. +For example, a user can use the same password for Google Drive, Google Mail, and YouTube. +Updating the password for the password group updates the password for all its included applications. + +- Multi-Application Source: This refers to a source with multiple applications that share a password. +For example, a user can have a source, G Suite, that includes the Google Calendar, Google Drive, and Google Mail applications. +Updating the password for the multi-application source updates the password for all its included applications. + +- Applications: These are applications that do not share passwords with other applications. + +An organization may require some authentication for users to update their passwords. +Users may be required to answer security questions or use a third-party authenticator before they can confirm their updates. + +Refer to [Managing Passwords](https://documentation.sailpoint.com/saas/user-help/accounts/passwords.html) for more information about password management. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-PasswordChangeStatus**](#get-password-change-status) | **GET** `/password-change-status/{id}` | Get Password Change Request Status +[**Search-PasswordInfo**](#query-password-info) | **POST** `/query-password-info` | Query Password Info +[**Set-Password**](#set-password) | **POST** `/set-password` | Set Identity's Password + +## get-password-change-status +This API returns the status of a password change request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Password change request ID + +### Return type +[**PasswordStatus**](../models/password-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Status of the password change request | PasswordStatus +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID + +# Get Password Change Request Status + +try { + Get-PasswordChangeStatus-Id $Id + + # Below is a request that includes all optional parameters + # Get-PasswordChangeStatus -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordChangeStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## query-password-info +This API is used to query password related information. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | PasswordInfoQueryDTO | [**PasswordInfoQueryDTO**](../models/password-info-query-dto) | True | + +### Return type +[**PasswordInfo**](../models/password-info) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password info. | PasswordInfo +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$PasswordInfoQueryDTO = @"{ + "sourceName" : "My-AD", + "userName" : "Abby.Smith" +}"@ + +# Query Password Info + +try { + $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO + Search-PasswordInfo-PasswordInfoQueryDTO $Result + + # Below is a request that includes all optional parameters + # Search-PasswordInfo -PasswordInfoQueryDTO $PasswordInfoQueryDTO +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-PasswordInfo" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-password +This API is used to set a password for an identity. + +An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). + +>**Note: If you want to set an identity's source account password, you must enable `PASSWORD` as one of the source's features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** + +To generate the encryptedPassword (RSA encrypted using publicKey) for the request body, run the following command: + +```bash +echo -n "myPassword" | openssl pkeyutl -encrypt -inkey public_key.pem -pubin | base64 +``` + +In this example, myPassword is the plain text password being set and encrypted, and public_key.pem is the path to the public key file. You can retrieve the required publicKey, along with other information like identityId, sourceId, publicKeyId, accounts, and policies, using the Query Password Info endpoint. + +To successfully run this command, you must have OpenSSL installed on your machine. If OpenSSL is unavailable, consider using the Virtual Appliance (VA), which has OpenSSL pre-installed and configured. + +If you are using a Windows machine, refer to this [guide](https://tecadmin.net/install-openssl-on-windows/) for instructions on installing OpenSSL. + +You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | PasswordChangeRequest | [**PasswordChangeRequest**](../models/password-change-request) | True | + +### Return type +[**PasswordChangeResponse**](../models/password-change-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Reference to the password change. | PasswordChangeResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$PasswordChangeRequest = @"{ + "sourceId" : "8a807d4c73c545510173c545d4b60246", + "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "identityId" : "8a807d4c73c545510173c545f0a002ff", + "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" +}"@ + +# Set Identity's Password + +try { + $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest + Set-Password-PasswordChangeRequest $Result + + # Below is a request that includes all optional parameters + # Set-Password -PasswordChangeRequest $PasswordChangeRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-Password" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/PasswordPoliciesApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/PasswordPoliciesApi.md new file mode 100644 index 000000000..13a871478 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/PasswordPoliciesApi.md @@ -0,0 +1,321 @@ + +--- +id: password-policies +title: PasswordPolicies +pagination_label: PasswordPolicies +sidebar_label: PasswordPolicies +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordPolicies', 'PasswordPolicies'] +slug: /tools/sdk/powershell/v3/methods/password-policies +tags: ['SDK', 'Software Development Kit', 'PasswordPolicies', 'PasswordPolicies'] +--- + +# PasswordPolicies + Use these APIs to implement password policies functionality. +These APIs allow you to define the policy parameters for choosing passwords. + +IdentityNow comes with a default policy that you can modify to define the password requirements your users must meet to log in to IdentityNow, such as requiring a minimum password length, including special characters, and disallowing certain patterns. +If you have licensed Password Management, you can create additional password policies beyond the default one to manage passwords for supported sources in your org. + +In the Identity Security Cloud Admin panel, administrators can use the Password Mgmt dropdown menu to select Sync Groups. +Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/pwd_policies/pwd_policies.html) for more information about password policies. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-PasswordPolicy**](#create-password-policy) | **POST** `/password-policies` | Create Password Policy +[**Remove-PasswordPolicy**](#delete-password-policy) | **DELETE** `/password-policies/{id}` | Delete Password Policy by ID +[**Get-PasswordPolicyById**](#get-password-policy-by-id) | **GET** `/password-policies/{id}` | Get Password Policy by ID +[**Get-PasswordPolicies**](#list-password-policies) | **GET** `/password-policies` | List Password Policies +[**Set-PasswordPolicy**](#set-password-policy) | **PUT** `/password-policies/{id}` | Update Password Policy by ID + +## create-password-policy +This API creates the specified password policy. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | PasswordPolicyV3Dto | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | True | + +### Return type +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password policy. | PasswordPolicyV3Dto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$PasswordPolicyV3Dto = @"{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 +}"@ + +# Create Password Policy + +try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + New-PasswordPolicy-PasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # New-PasswordPolicy -PasswordPolicyV3Dto $PasswordPolicyV3Dto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-password-policy +This API deletes the specified password policy. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of password policy to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. + +# Delete Password Policy by ID + +try { + Remove-PasswordPolicy-Id $Id + + # Below is a request that includes all optional parameters + # Remove-PasswordPolicy -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-PasswordPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-password-policy-by-id +This API returns the password policy for the specified ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of password policy to retrieve. + +### Return type +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password policy. | PasswordPolicyV3Dto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. + +# Get Password Policy by ID + +try { + Get-PasswordPolicyById-Id $Id + + # Below is a request that includes all optional parameters + # Get-PasswordPolicyById -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordPolicyById" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-password-policies +This gets list of all Password Policies. +Requires role of ORG_ADMIN + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**PasswordPolicyV3Dto[]**](../models/password-policy-v3-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of all Password Policies. | PasswordPolicyV3Dto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# List Password Policies + +try { + Get-PasswordPolicies + + # Below is a request that includes all optional parameters + # Get-PasswordPolicies -Limit $Limit -Offset $Offset -Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordPolicies" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-password-policy +This API updates the specified password policy. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of password policy to update. + Body | PasswordPolicyV3Dto | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | True | + +### Return type +[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password policy. | PasswordPolicyV3Dto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update. +$PasswordPolicyV3Dto = @"{ + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 +}"@ + +# Update Password Policy by ID + +try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + Set-PasswordPolicy-Id $Id -PasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # Set-PasswordPolicy -Id $Id -PasswordPolicyV3Dto $PasswordPolicyV3Dto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-PasswordPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/PasswordSyncGroupsApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/PasswordSyncGroupsApi.md new file mode 100644 index 000000000..0f1c68ded --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/PasswordSyncGroupsApi.md @@ -0,0 +1,292 @@ + +--- +id: password-sync-groups +title: PasswordSyncGroups +pagination_label: PasswordSyncGroups +sidebar_label: PasswordSyncGroups +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordSyncGroups', 'PasswordSyncGroups'] +slug: /tools/sdk/powershell/v3/methods/password-sync-groups +tags: ['SDK', 'Software Development Kit', 'PasswordSyncGroups', 'PasswordSyncGroups'] +--- + +# PasswordSyncGroups + Use this API to implement password sync group functionality. +With this functionality in place, administrators can group sources into password sync groups so that all their applications share the same password. +This allows users to update the password for all the applications in a sync group if they want, rather than updating each password individually. + +A password sync group is a group of applications that shares a password. +Administrators create these groups by grouping the applications' sources. +For example, an administrator can group the ActiveDirectory, GitHub, and G Suite sources together so that all those sources' applications can also be grouped to share a password. +A user can then update his or her password for ActiveDirectory, GitHub, Gmail, Google Drive, and Google Calendar all at once, rather then updating each one individually. + +The following are required for administrators to create a password sync group in Identity Security Cloud: + +- At least two direct connect sources connected to Identity Security Cloud and configured for Password Management. + +- Each authentication source in a sync group must have at least one application. Refer to [Adding and Resetting Application Passwords](https://documentation.sailpoint.com/saas/help/pwd/adv_config.html#adding-and-resetting-application-passwords) for more information about adding applications to sources. + +- At least one password policy. Refer to [Managing Password Policies](https://documentation.sailpoint.com/saas/help/pwd/policies.html) for more information about password policies. + +In the Admin panel in Identity Security Cloud, administrators can use the Password Mgmt dropdown menu to select Sync Groups. +To create a sync group, administrators must provide a name, choose a password policy to be enforced across the sources in the sync group, and select the sources to include in the sync group. + +Administrators can also delete sync groups in Identity Security Cloud, but they should know the following before they do: + +- Passwords related to the associated sources will become independent, so changing one will not change the others anymore. + +- Passwords for the sources' connected applications will also become independent. + +- Password policies assigned to the sync group are then assigned directly to the associated sources. +To change the password policy for a source, administrators must edit it directly. + +Once the password sync group has been created, users can update the password for the group in Password Manager. + +Refer to [Managing Password Sync Groups](https://documentation.sailpoint.com/saas/help/pwd/sync_grps.html) for more information about password sync groups. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-PasswordSyncGroup**](#create-password-sync-group) | **POST** `/password-sync-groups` | Create Password Sync Group +[**Remove-PasswordSyncGroup**](#delete-password-sync-group) | **DELETE** `/password-sync-groups/{id}` | Delete Password Sync Group by ID +[**Get-PasswordSyncGroup**](#get-password-sync-group) | **GET** `/password-sync-groups/{id}` | Get Password Sync Group by ID +[**Get-PasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get Password Sync Group List +[**Update-PasswordSyncGroup**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update Password Sync Group by ID + +## create-password-sync-group +This API creates a password sync group based on the specifications provided. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | PasswordSyncGroup | [**PasswordSyncGroup**](../models/password-sync-group) | True | + +### Return type +[**PasswordSyncGroup**](../models/password-sync-group) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password sync group. | PasswordSyncGroup +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$PasswordSyncGroup = @"{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] +}"@ + +# Create Password Sync Group + +try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + New-PasswordSyncGroup-PasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # New-PasswordSyncGroup -PasswordSyncGroup $PasswordSyncGroup +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordSyncGroup" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-password-sync-group +This API deletes the specified password sync group. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of password sync group to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. + +# Delete Password Sync Group by ID + +try { + Remove-PasswordSyncGroup-Id $Id + + # Below is a request that includes all optional parameters + # Remove-PasswordSyncGroup -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-PasswordSyncGroup" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-password-sync-group +This API returns the sync group for the specified ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of password sync group to retrieve. + +### Return type +[**PasswordSyncGroup**](../models/password-sync-group) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password sync group. | PasswordSyncGroup +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. + +# Get Password Sync Group by ID + +try { + Get-PasswordSyncGroup-Id $Id + + # Below is a request that includes all optional parameters + # Get-PasswordSyncGroup -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordSyncGroup" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-password-sync-groups +This API returns a list of password sync groups. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**PasswordSyncGroup[]**](../models/password-sync-group) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of password sync groups. | PasswordSyncGroup[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Get Password Sync Group List + +try { + Get-PasswordSyncGroups + + # Below is a request that includes all optional parameters + # Get-PasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordSyncGroups" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-password-sync-group +This API updates the specified password sync group. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of password sync group to update. + Body | PasswordSyncGroup | [**PasswordSyncGroup**](../models/password-sync-group) | True | + +### Return type +[**PasswordSyncGroup**](../models/password-sync-group) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the password sync group. | PasswordSyncGroup +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to update. +$PasswordSyncGroup = @"{ + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] +}"@ + +# Update Password Sync Group by ID + +try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + Update-PasswordSyncGroup-Id $Id -PasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # Update-PasswordSyncGroup -Id $Id -PasswordSyncGroup $PasswordSyncGroup +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PasswordSyncGroup" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/PersonalAccessTokensApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/PersonalAccessTokensApi.md new file mode 100644 index 000000000..bdb5c8692 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/PersonalAccessTokensApi.md @@ -0,0 +1,222 @@ + +--- +id: personal-access-tokens +title: PersonalAccessTokens +pagination_label: PersonalAccessTokens +sidebar_label: PersonalAccessTokens +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PersonalAccessTokens', 'PersonalAccessTokens'] +slug: /tools/sdk/powershell/v3/methods/personal-access-tokens +tags: ['SDK', 'Software Development Kit', 'PersonalAccessTokens', 'PersonalAccessTokens'] +--- + +# PersonalAccessTokens + Use this API to implement personal access token (PAT) functionality. +With this functionality in place, users can use PATs as an alternative to passwords for authentication in Identity Security Cloud. + +PATs embed user information into the client ID and secret. +This replaces the API clients' need to store and provide a username and password to establish a connection, improving Identity Security Cloud organizations' integration security. + +In Identity Security Cloud, users can do the following to create and manage their PATs: Select the dropdown menu under their names, select Preferences, and then select Personal Access Tokens. +They must then provide a description about the token's purpose. +They can then select 'Create Token' at the bottom of the page to generate and view the Secret and Client ID. + +Refer to [Managing Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/generate_tokens.html) for more information about PATs. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-PersonalAccessToken**](#create-personal-access-token) | **POST** `/personal-access-tokens` | Create Personal Access Token +[**Remove-PersonalAccessToken**](#delete-personal-access-token) | **DELETE** `/personal-access-tokens/{id}` | Delete Personal Access Token +[**Get-PersonalAccessTokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List Personal Access Tokens +[**Update-PersonalAccessToken**](#patch-personal-access-token) | **PATCH** `/personal-access-tokens/{id}` | Patch Personal Access Token + +## create-personal-access-token +This creates a personal access token. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CreatePersonalAccessTokenRequest | [**CreatePersonalAccessTokenRequest**](../models/create-personal-access-token-request) | True | Name and scope of personal access token. + +### Return type +[**CreatePersonalAccessTokenResponse**](../models/create-personal-access-token-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Created. Note - this is the only time Personal Access Tokens' secret attribute will be displayed. | CreatePersonalAccessTokenResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CreatePersonalAccessTokenRequest = @"{ + "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], + "accessTokenValiditySeconds" : 36900, + "name" : "NodeJS Integration" +}"@ + +# Create Personal Access Token + +try { + $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest + New-PersonalAccessToken-CreatePersonalAccessTokenRequest $Result + + # Below is a request that includes all optional parameters + # New-PersonalAccessToken -CreatePersonalAccessTokenRequest $CreatePersonalAccessTokenRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PersonalAccessToken" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-personal-access-token +This deletes a personal access token. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The personal access token id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id + +# Delete Personal Access Token + +try { + Remove-PersonalAccessToken-Id $Id + + # Below is a request that includes all optional parameters + # Remove-PersonalAccessToken -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-PersonalAccessToken" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-personal-access-tokens +This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | OwnerId | **String** | (optional) | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* + +### Return type +[**GetPersonalAccessTokenResponse[]**](../models/get-personal-access-token-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of personal access tokens. | GetPersonalAccessTokenResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OwnerId = "2c9180867b50d088017b554662fb281e" # String | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) +$Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + +# List Personal Access Tokens + +try { + Get-PersonalAccessTokens + + # Below is a request that includes all optional parameters + # Get-PersonalAccessTokens -OwnerId $OwnerId -Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PersonalAccessTokens" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-personal-access-token +This performs a targeted update to the field(s) of a Personal Access Token. +Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The Personal Access Token id + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope + +### Return type +[**GetPersonalAccessTokenResponse**](../models/get-personal-access-token-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Indicates the PATCH operation succeeded, and returns the PAT's new representation. | GetPersonalAccessTokenResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope + + +# Patch Personal Access Token + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-PersonalAccessToken-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-PersonalAccessToken -Id $Id -JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PersonalAccessToken" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/PublicIdentitiesApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/PublicIdentitiesApi.md new file mode 100644 index 000000000..aa637b990 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/PublicIdentitiesApi.md @@ -0,0 +1,77 @@ + +--- +id: public-identities +title: PublicIdentities +pagination_label: PublicIdentities +sidebar_label: PublicIdentities +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PublicIdentities', 'PublicIdentities'] +slug: /tools/sdk/powershell/v3/methods/public-identities +tags: ['SDK', 'Software Development Kit', 'PublicIdentities', 'PublicIdentities'] +--- + +# PublicIdentities + Use this API in conjunction with [Public Identites Config](https://developer.sailpoint.com/docs/api/v3/public-identities-config/) to enable non-administrators to view identities' publicly visible attributes. +With this functionality in place, non-administrators can view identity attributes other than the default attributes (email, lifecycle state, and manager), depending on which identity attributes their organization administrators have made public. +This can be helpful for access approvers, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-PublicIdentities**](#get-public-identities) | **GET** `/public-identities` | Get list of public identities + +## get-public-identities +Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* + Query | AddCoreFilters | **Boolean** | (optional) (default to $false) | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be ""spadmin"" or ""cloudadmin"". - uid should not be null. - lastname should not be null. - email should not be null. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** + +### Return type +[**PublicIdentity[]**](../models/public-identity) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of public identity objects. | PublicIdentity[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'firstname eq "John"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) +$AddCoreFilters = $false # Boolean | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be ""spadmin"" or ""cloudadmin"". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to $false) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + +# Get list of public identities + +try { + Get-PublicIdentities + + # Below is a request that includes all optional parameters + # Get-PublicIdentities -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -AddCoreFilters $AddCoreFilters -Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PublicIdentities" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/PublicIdentitiesConfigApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/PublicIdentitiesConfigApi.md new file mode 100644 index 000000000..7be2e353e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/PublicIdentitiesConfigApi.md @@ -0,0 +1,130 @@ + +--- +id: public-identities-config +title: PublicIdentitiesConfig +pagination_label: PublicIdentitiesConfig +sidebar_label: PublicIdentitiesConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PublicIdentitiesConfig', 'PublicIdentitiesConfig'] +slug: /tools/sdk/powershell/v3/methods/public-identities-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentitiesConfig', 'PublicIdentitiesConfig'] +--- + +# PublicIdentitiesConfig + Use this API to implement public identity configuration functionality. +With this functionality in place, administrators can make up to 5 identity attributes publicly visible so other non-administrator users can see the relevant information they need to make decisions. +This can be helpful for approvers making approvals, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks. + +By default, non-administrators can select an identity and view the following attributes: email, lifecycle state, and manager. +However, it may be helpful for a non-administrator reviewer to see other identity attributes like department, region, title, etc. +Administrators can use this API to make those necessary identity attributes public to non-administrators. + +For example, a non-administrator deciding whether to approve another identity's request for access to the Workday application, whose access may be restricted to members of the HR department, would want to know whether the identity is a member of the HR department. +If an administrator has used [Update Public Identity Config](https://developer.sailpoint.com/docs/api/v3/update-public-identity-config/) to make the "department" attribute public, the approver can see the department and make a decision without requesting any more information. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-PublicIdentityConfig**](#get-public-identity-config) | **GET** `/public-identities-config` | Get the Public Identities Configuration +[**Update-PublicIdentityConfig**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update the Public Identities Configuration + +## get-public-identity-config +Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**PublicIdentityConfig**](../models/public-identity-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Request succeeded. | PublicIdentityConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get the Public Identities Configuration + +try { + Get-PublicIdentityConfig + + # Below is a request that includes all optional parameters + # Get-PublicIdentityConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PublicIdentityConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-public-identity-config +Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | PublicIdentityConfig | [**PublicIdentityConfig**](../models/public-identity-config) | True | + +### Return type +[**PublicIdentityConfig**](../models/public-identity-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Request succeeded. | PublicIdentityConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$PublicIdentityConfig = @"{ + "modified" : "2018-06-25T20:22:28.104Z", + "attributes" : [ { + "name" : "Country", + "key" : "country" + }, { + "name" : "Country", + "key" : "country" + } ], + "modifiedBy" : { + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } +}"@ + +# Update the Public Identities Configuration + +try { + $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig + Update-PublicIdentityConfig-PublicIdentityConfig $Result + + # Below is a request that includes all optional parameters + # Update-PublicIdentityConfig -PublicIdentityConfig $PublicIdentityConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PublicIdentityConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/ReportsDataExtractionApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/ReportsDataExtractionApi.md new file mode 100644 index 000000000..b61767914 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/ReportsDataExtractionApi.md @@ -0,0 +1,212 @@ + +--- +id: reports-data-extraction +title: ReportsDataExtraction +pagination_label: ReportsDataExtraction +sidebar_label: ReportsDataExtraction +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReportsDataExtraction', 'ReportsDataExtraction'] +slug: /tools/sdk/powershell/v3/methods/reports-data-extraction +tags: ['SDK', 'Software Development Kit', 'ReportsDataExtraction', 'ReportsDataExtraction'] +--- + +# ReportsDataExtraction + Use this API to implement reports lifecycle managing and monitoring. +With this functionality in place, users can run reports, view their results, and cancel reports in progress. +This can be potentially helpful for auditing purposes. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Suspend-Report**](#cancel-report) | **POST** `/reports/{id}/cancel` | Cancel Report +[**Get-Report**](#get-report) | **GET** `/reports/{taskResultId}` | Get Report File +[**Get-ReportResult**](#get-report-result) | **GET** `/reports/{taskResultId}/result` | Get Report Result +[**Start-Report**](#start-report) | **POST** `/reports/run` | Run Report + +## cancel-report +Cancels a running report. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the running Report to cancel + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel + +# Cancel Report + +try { + Suspend-Report-Id $Id + + # Below is a request that includes all optional parameters + # Suspend-Report -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-Report" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-report +Gets a report in file format. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | TaskResultId | **String** | True | Unique identifier of the task result which handled report + Query | FileFormat | **String** | True | Output format of the requested report file + Query | Name | **String** | (optional) | preferred Report file name, by default will be used report name from task result. + Query | Auditable | **Boolean** | (optional) (default to $false) | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. + +### Return type +**System.IO.FileInfo** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Report file in selected format. CSV by default. | System.IO.FileInfo +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/csv, application/pdf, application/json + +### Example +```powershell +$TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report +$FileFormat = "csv" # String | Output format of the requested report file +$Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional) +$Auditable = $true # Boolean | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to $false) + +# Get Report File + +try { + 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 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Report" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-report-result +Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | TaskResultId | **String** | True | Unique identifier of the task result which handled report + Query | Completed | **Boolean** | (optional) (default to $false) | state of task result to apply ordering when results are fetching from the DB + +### Return type +[**ReportResults**](../models/report-results) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Details about report that was run or is running. | ReportResults +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report +$Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false) + +# Get Report Result + +try { + Get-ReportResult-TaskResultId $TaskResultId + + # Below is a request that includes all optional parameters + # Get-ReportResult -TaskResultId $TaskResultId -Completed $Completed +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ReportResult" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-report +Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | ReportDetails | [**ReportDetails**](../models/report-details) | True | + +### Return type +[**TaskResultDetails**](../models/task-result-details) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Details about running report task. | TaskResultDetails +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$ReportDetails = @"{ + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } +}"@ + +# Run Report + +try { + $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails + Start-Report-ReportDetails $Result + + # Below is a request that includes all optional parameters + # Start-Report -ReportDetails $ReportDetails +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-Report" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/RequestableObjectsApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/RequestableObjectsApi.md new file mode 100644 index 000000000..0c4965c32 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/RequestableObjectsApi.md @@ -0,0 +1,88 @@ + +--- +id: requestable-objects +title: RequestableObjects +pagination_label: RequestableObjects +sidebar_label: RequestableObjects +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestableObjects', 'RequestableObjects'] +slug: /tools/sdk/powershell/v3/methods/requestable-objects +tags: ['SDK', 'Software Development Kit', 'RequestableObjects', 'RequestableObjects'] +--- + +# RequestableObjects + Use this API to implement requestable object functionality. +With this functionality in place, administrators can determine which access items can be requested with the [Access Request APIs](https://developer.sailpoint.com/docs/api/v3/access-requests/), along with their statuses. +This can be helpful for administrators who are implementing and customizing access request functionality as a way of checking which items are requestable as they are created, assigned, and made available. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-RequestableObjects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable Objects List + +## list-requestable-objects +This endpoint returns a list of acccess items that that can be requested through the Access Request endpoints. Access items are marked with AVAILABLE, PENDING or ASSIGNED with respect to the identity provided using *identity-id* query param. +Any authenticated token can call this endpoint to see their requestable access items. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | IdentityId | **String** | (optional) | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. + Query | Types | [**[]RequestableObjectType**](../models/requestable-object-type) | (optional) | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. + Query | Term | **String** | (optional) | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. + Query | Statuses | [**[]RequestableObjectRequestStatus**](../models/requestable-object-request-status) | (optional) | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** + +### Return type +[**RequestableObject[]**](../models/requestable-object) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of requestable objects | RequestableObject[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) +$Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. (optional) + +$Types = @"ROLE,ACCESS_PROFILE"@ # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. (optional) +$Term = "Finance Role" # String | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) +$Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional) + +$Statuses = @"[ASSIGNED, PENDING]"@ # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'name sw "bob"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + +# Requestable Objects List + +try { + Get-RequestableObjects + + # Below is a request that includes all optional parameters + # Get-RequestableObjects -IdentityId $IdentityId -Types $Types -Term $Term -Statuses $Statuses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-RequestableObjects" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/RolesApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/RolesApi.md new file mode 100644 index 000000000..2a51e46f5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/RolesApi.md @@ -0,0 +1,580 @@ + +--- +id: roles +title: Roles +pagination_label: Roles +sidebar_label: Roles +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Roles', 'Roles'] +slug: /tools/sdk/powershell/v3/methods/roles +tags: ['SDK', 'Software Development Kit', 'Roles', 'Roles'] +--- + +# Roles + Use this API to implement and customize role functionality. +With this functionality in place, administrators can create roles and configure them for use throughout Identity Security Cloud. +Identity Security Cloud can use established criteria to automatically assign the roles to qualified users. This enables users to get all the access they need quickly and securely and administrators to spend their time on other tasks. + +Entitlements represent the most granular level of access in Identity Security Cloud. +Access profiles represent the next level and often group entitlements. +Roles represent the broadest level of access and often group access profiles. + +For example, an Active Directory source in Identity Security Cloud can have multiple entitlements: the first, 'Employees,' may represent the access all employees have at the organization, and a second, 'Developers,' may represent the access all developers have at the organization. + +An administrator can then create a broader set of access in the form of an access profile, 'AD Developers' grouping the 'Employees' entitlement with the 'Developers' entitlement. + +An administrator can then create an even broader set of access in the form of a role grouping the 'AD Developers' access profile with another profile, 'GitHub Developers,' grouping entitlements for the GitHub source. + +When users only need Active Directory employee access, they can request access to the 'Employees' entitlement. + +When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile. + +When users need both the 'AD Developers' access profile and the 'GitHub Developers' access profile, they can request access to the role grouping both. + +Roles often represent positions within organizations. +For example, an organization's accountant can access all the tools the organization's accountants need with the 'Accountant' role. +If the accountant switches to engineering, a qualified member of the organization can quickly revoke the accountant's 'Accountant' access and grant access to the 'Engineer' role instead, granting access to all the tools the organization's engineers need. + +In Identity Security Cloud, adminstrators can use the Access drop-down menu and select Roles to view, configure, and delete existing roles, as well as create new ones. +Administrators can enable and disable the role, and they can also make the following configurations: + +- Manage Access: Manage the role's access by adding or removing access profiles. + +- Define Assignment: Define the criteria Identity Security Cloud uses to assign the role to identities. +Use the first option, 'Standard Criteria,' to provide specific criteria for assignment like specific account attributes, entitlements, or identity attributes. +Use the second, 'Identity List,' to specify the identities for assignment. + +- Access Requests: Configure roles to be requestable and establish an approval process for any requests that the role be granted or revoked. +Do not configure a role to be requestable without establishing a secure access request approval process for that role first. + +Refer to [Working with Roles](https://documentation.sailpoint.com/saas/help/access/roles.html) for more information about roles. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-Role**](#create-role) | **POST** `/roles` | Create a Role +[**Remove-BulkRoles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete Role(s) +[**Remove-Role**](#delete-role) | **DELETE** `/roles/{id}` | Delete a Role +[**Get-Role**](#get-role) | **GET** `/roles/{id}` | Get a Role +[**Get-RoleAssignedIdentities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | List Identities assigned a Role +[**Get-Roles**](#list-roles) | **GET** `/roles` | List Roles +[**Update-Role**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified Role + +## create-role +This API creates a role. +In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. + +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Role | [**Role**](../models/role) | True | + +### Return type +[**Role**](../models/role) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Role created | Role +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Role = @"{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "dimensional" : false, + "created" : "2021-03-01T22:32:58.104Z", + "dimensionRefs" : [ { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + }, { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + } ], + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "membership" : { + "identities" : [ { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } ], + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, + "type" : "IDENTITY_LIST" + }, + "enabled" : true, + "revocationRequestConfig" : { + "commentsRequired" : false, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : false + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "legacyMembershipInfo" : { + "type" : "IDENTITY_LIST" + }, + "accessRequestConfig" : { + "commentsRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "name" : "Role 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "accessModelMetadata" : { + "attributes" : [ { + "key" : "iscPrivacy", + "name" : "Privacy", + "multiselect" : false, + "status" : "active", + "type" : "governance", + "objectTypes" : [ "all" ], + "description" : "Specifies the level of privacy associated with an access item.", + "values" : [ { + "value" : "public", + "name" : "Public", + "status" : "active" + } ] + } ] + }, + "id" : "2c918086749d78830174a1a40e121518", + "requestable" : true +}"@ + +# Create a Role + +try { + $Result = ConvertFrom-JsonToRole -Json $Role + New-Role-Role $Result + + # Below is a request that includes all optional parameters + # New-Role -Role $Role +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Role" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-bulk-roles +This endpoint initiates a bulk deletion of one or more roles. +When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. +This endpoint can only bulk delete up to a limit of 50 roles per request. +A user with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | RoleBulkDeleteRequest | [**RoleBulkDeleteRequest**](../models/role-bulk-delete-request) | True | + +### Return type +[**TaskResultDto**](../models/task-result-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Returns an object with the id of the task performing the delete operation. | TaskResultDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$RoleBulkDeleteRequest = @"{ + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] +}"@ + +# Delete Role(s) + +try { + $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest + Remove-BulkRoles-RoleBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BulkRoles -RoleBulkDeleteRequest $RoleBulkDeleteRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BulkRoles" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-role +This API deletes a Role by its ID. + +A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Role + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + +# Delete a Role + +try { + Remove-Role-Id $Id + + # Below is a request that includes all optional parameters + # Remove-Role -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Role" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role +This API returns a Role by its ID. +A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Role + +### Return type +[**Role**](../models/role) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of all Roles | Role +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + +# Get a Role + +try { + Get-Role-Id $Id + + # Below is a request that includes all optional parameters + # Get-Role -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Role" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-role-assigned-identities + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Role for which the assigned Identities are to be listed + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** + +### Return type +[**RoleIdentity[]**](../models/role-identity) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Identities assigned the Role | RoleIdentity[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role for which the assigned Identities are to be listed +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'name sw Joe' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) +$Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) + +# List Identities assigned a Role + +try { + 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 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-RoleAssignedIdentities" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-roles +This API returns a list of Roles. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | ForSubadmin | **String** | (optional) | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. + Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** + Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. + Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. + +### Return type +[**Role[]**](../models/role) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Roles | Role[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) +$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'requestable eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) +$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) +$ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) +$IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + +# List Roles + +try { + Get-Roles + + # Below is a request that includes all optional parameters + # Get-Roles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Roles" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-role +This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +The following fields are patchable: +* name +* description +* enabled +* owner +* accessProfiles +* entitlements +* membership +* requestable +* accessRequestConfig +* revokeRequestConfig +* segments +* accessModelMetadata + +A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + +The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + +When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Role to patch + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**Role**](../models/role) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the Role as updated. | Role +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | + + +# Patch a specified Role + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Role-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-Role -Id $Id -JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Role" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/SODPoliciesApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/SODPoliciesApi.md new file mode 100644 index 000000000..3c75368ee --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/SODPoliciesApi.md @@ -0,0 +1,969 @@ + +--- +id: sod-policies +title: SODPolicies +pagination_label: SODPolicies +sidebar_label: SODPolicies +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SODPolicies', 'SODPolicies'] +slug: /tools/sdk/powershell/v3/methods/sod-policies +tags: ['SDK', 'Software Development Kit', 'SODPolicies', 'SODPolicies'] +--- + +# SODPolicies + Use this API to implement and manage "separation of duties" (SOD) policies. +With SOD policy functionality in place, administrators can organize the access in their tenants to prevent individuals from gaining conflicting or excessive access. + +"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. +For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. +Any changes to major system configurations should be approved by someone other than the person requesting the change. + +Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. +These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + +To create SOD policies in Identity Security Cloud, administrators use 'Search' and then access 'Policies'. +To create a policy, they must configure two lists of access items. Each access item can only be added to one of the two lists. +They can search for the entitlements they want to add to these access lists. + +>Note: You can have a maximum of 500 policies of any type (including general policies) in your organization. In each access-based SOD policy, you can have a maximum of 50 entitlements in each access list. + +Once a SOD policy is in place, if an identity has access items on both lists, a SOD violation will trigger. +These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. +The other users can then better help to enforce these SOD policies. + +To create a subscription to a SOD policy in Identity Security Cloud, administrators use 'Search' and then access 'Layers'. +They can create a subscription to the policy and schedule it to run at a regular interval. + +Refer to [Managing Policies](https://documentation.sailpoint.com/saas/help/sod/manage-policies.html) for more information about SOD policies. + +Refer to [Subscribe to a SOD Policy](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html#subscribe-to-an-sod-policy) for more information about SOD policy subscriptions. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-SodPolicy**](#create-sod-policy) | **POST** `/sod-policies` | Create SOD policy +[**Remove-SodPolicy**](#delete-sod-policy) | **DELETE** `/sod-policies/{id}` | Delete SOD policy by ID +[**Remove-SodPolicySchedule**](#delete-sod-policy-schedule) | **DELETE** `/sod-policies/{id}/schedule` | Delete SOD policy schedule +[**Get-CustomViolationReport**](#get-custom-violation-report) | **GET** `/sod-violation-report/{reportResultId}/download/{fileName}` | Download custom violation report +[**Get-DefaultViolationReport**](#get-default-violation-report) | **GET** `/sod-violation-report/{reportResultId}/download` | Download violation report +[**Get-SodAllReportRunStatus**](#get-sod-all-report-run-status) | **GET** `/sod-violation-report` | Get multi-report run task status +[**Get-SodPolicy**](#get-sod-policy) | **GET** `/sod-policies/{id}` | Get SOD policy by ID +[**Get-SodPolicySchedule**](#get-sod-policy-schedule) | **GET** `/sod-policies/{id}/schedule` | Get SOD policy schedule +[**Get-SodViolationReportRunStatus**](#get-sod-violation-report-run-status) | **GET** `/sod-policies/sod-violation-report-status/{reportResultId}` | Get violation report run status +[**Get-SodViolationReportStatus**](#get-sod-violation-report-status) | **GET** `/sod-policies/{id}/violation-report` | Get SOD violation report status +[**Get-SodPolicies**](#list-sod-policies) | **GET** `/sod-policies` | List SOD policies +[**Update-SodPolicy**](#patch-sod-policy) | **PATCH** `/sod-policies/{id}` | Patch SOD policy by ID +[**Send-PolicySchedule**](#put-policy-schedule) | **PUT** `/sod-policies/{id}/schedule` | Update SOD Policy schedule +[**Send-SodPolicy**](#put-sod-policy) | **PUT** `/sod-policies/{id}` | Update SOD policy by ID +[**Start-EvaluateSodPolicy**](#start-evaluate-sod-policy) | **POST** `/sod-policies/{id}/evaluate` | Evaluate one policy by ID +[**Start-SodAllPoliciesForOrg**](#start-sod-all-policies-for-org) | **POST** `/sod-violation-report/run` | Runs all policies for org +[**Start-SodPolicy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report + +## create-sod-policy +This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. +Requires role of ORG_ADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | SodPolicy | [**SodPolicy**](../models/sod-policy) | True | + +### Return type +[**SodPolicy**](../models/sod-policy) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | SOD policy created | SodPolicy +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SodPolicy = @"{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" +}"@ + +# Create SOD policy + +try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-SodPolicy-SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-SodPolicy -SodPolicy $SodPolicy +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-sod-policy +This deletes a specified SOD policy. +Requires role of ORG_ADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the SOD Policy to delete. + Query | Logical | **Boolean** | (optional) (default to $true) | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. +$Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) + +# Delete SOD policy by ID + +try { + Remove-SodPolicy-Id $Id + + # Below is a request that includes all optional parameters + # Remove-SodPolicy -Id $Id -Logical $Logical +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-sod-policy-schedule +This deletes schedule for a specified SOD policy by ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the SOD policy the schedule must be deleted for. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + +# Delete SOD policy schedule + +try { + Remove-SodPolicySchedule-Id $Id + + # Below is a request that includes all optional parameters + # Remove-SodPolicySchedule -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicySchedule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-custom-violation-report +This allows to download a specified named violation report for a given report reference. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ReportResultId | **String** | True | The ID of the report reference to download. +Path | FileName | **String** | True | Custom Name for the file. + +### Return type +**System.IO.FileInfo** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns the zip file with given custom name that contains the violation report file. | System.IO.FileInfo +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example +```powershell +$ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. +$FileName = "custom-name" # String | Custom Name for the file. + +# Download custom violation report + +try { + Get-CustomViolationReport-ReportResultId $ReportResultId -FileName $FileName + + # Below is a request that includes all optional parameters + # Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CustomViolationReport" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-default-violation-report +This allows to download a violation report for a given report reference. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ReportResultId | **String** | True | The ID of the report reference to download. + +### Return type +**System.IO.FileInfo** + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Returns the PolicyReport.zip that contains the violation report file. | System.IO.FileInfo +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/zip, application/json + +### Example +```powershell +$ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + +# Download violation report + +try { + Get-DefaultViolationReport-ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-DefaultViolationReport -ReportResultId $ReportResultId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultViolationReport" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sod-all-report-run-status +This endpoint gets the status for a violation report for all policy run. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Status of the violation report run task for all policy run. | ReportResultReference +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get multi-report run task status + +try { + Get-SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-SodAllReportRunStatus +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodAllReportRunStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sod-policy +This gets specified SOD policy. +Requires role of ORG_ADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the SOD Policy to retrieve. + +### Return type +[**SodPolicy**](../models/sod-policy) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | SOD policy ID. | SodPolicy +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + +# Get SOD policy by ID + +try { + Get-SodPolicy-Id $Id + + # Below is a request that includes all optional parameters + # Get-SodPolicy -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sod-policy-schedule +This endpoint gets a specified SOD policy's schedule. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the SOD policy schedule to retrieve. + +### Return type +[**SodPolicySchedule**](../models/sod-policy-schedule) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | SOD policy schedule. | SodPolicySchedule +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + +# Get SOD policy schedule + +try { + Get-SodPolicySchedule-Id $Id + + # Below is a request that includes all optional parameters + # Get-SodPolicySchedule -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicySchedule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sod-violation-report-run-status +This gets the status for a violation report run task that has already been invoked. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ReportResultId | **String** | True | The ID of the report reference to retrieve. + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Status of the violation report run task. | ReportResultReference +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + +# Get violation report run status + +try { + Get-SodViolationReportRunStatus-ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-SodViolationReportRunStatus -ReportResultId $ReportResultId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportRunStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-sod-violation-report-status +This gets the status for a violation report run task that has already been invoked. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the violation report to retrieve status for. + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Status of the violation report run task. | ReportResultReference +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + +# Get SOD violation report status + +try { + Get-SodViolationReportStatus-Id $Id + + # Below is a request that includes all optional parameters + # Get-SodViolationReportStatus -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportStatus" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-sod-policies +This gets list of all SOD policies. +Requires role of ORG_ADMIN + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** + +### Return type +[**SodPolicy[]**](../models/sod-policy) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of all SOD policies. | SodPolicy[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'id eq "bc693f07e7b645539626c25954c58554"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) +$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + +# List SOD policies + +try { + Get-SodPolicies + + # Below is a request that includes all optional parameters + # Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicies" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-sod-policy +Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +Requires role of ORG_ADMIN. +This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the SOD policy being modified. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + +### Return type +[**SodPolicy**](../models/sod-policy) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Indicates the PATCH operation succeeded, and returns the SOD policy's new representation. | SodPolicy +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + + +# Patch SOD policy by ID + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-SodPolicy-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-SodPolicy -Id $Id -JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-policy-schedule +This updates schedule for a specified SOD policy. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the SOD policy to update its schedule. + Body | SodPolicySchedule | [**SodPolicySchedule**](../models/sod-policy-schedule) | True | + +### Return type +[**SodPolicySchedule**](../models/sod-policy-schedule) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Created or updated SOD policy schedule. | SodPolicySchedule +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. +$SodPolicySchedule = @"{ + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false +}"@ + +# Update SOD Policy schedule + +try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-PolicySchedule-Id $Id -SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-PolicySchedule -Id $Id -SodPolicySchedule $SodPolicySchedule +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-sod-policy +This updates a specified SOD policy. +Requires role of ORG_ADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the SOD policy to update. + Body | SodPolicy | [**SodPolicy**](../models/sod-policy) | True | + +### Return type +[**SodPolicy**](../models/sod-policy) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | SOD Policy by ID | SodPolicy +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. +$SodPolicy = @"{ + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" +}"@ + +# Update SOD policy by ID + +try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-SodPolicy-Id $Id -SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-SodPolicy -Id $Id -SodPolicy $SodPolicy +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SodPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-evaluate-sod-policy +Runs the scheduled report for the policy retrieved by passed policy ID. The report schedule is fetched from the policy retrieved by ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The SOD policy ID to run. + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the violation report run task. | ReportResultReference +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + +# Evaluate one policy by ID + +try { + Start-EvaluateSodPolicy-Id $Id + + # Below is a request that includes all optional parameters + # Start-EvaluateSodPolicy -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-EvaluateSodPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-sod-all-policies-for-org +Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | MultiPolicyRequest | [**MultiPolicyRequest**](../models/multi-policy-request) | (optional) | + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the violation report run task. | ReportResultReference +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$MultiPolicyRequest = @"{ + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] +}"@ + +# Runs all policies for org + +try { + Start-SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-SodAllPoliciesForOrg -MultiPolicyRequest $MultiPolicyRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-sod-policy +This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The SOD policy ID to run. + +### Return type +[**ReportResultReference**](../models/report-result-reference) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Reference to the violation report run task. | ReportResultReference +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + +# Runs SOD policy violation report + +try { + Start-SodPolicy-Id $Id + + # Below is a request that includes all optional parameters + # Start-SodPolicy -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/SODViolationsApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/SODViolationsApi.md new file mode 100644 index 000000000..2a0a62b7c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/SODViolationsApi.md @@ -0,0 +1,140 @@ + +--- +id: sod-violations +title: SODViolations +pagination_label: SODViolations +sidebar_label: SODViolations +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SODViolations', 'SODViolations'] +slug: /tools/sdk/powershell/v3/methods/sod-violations +tags: ['SDK', 'Software Development Kit', 'SODViolations', 'SODViolations'] +--- + +# SODViolations + Use this API to check for current "separation of duties" (SOD) policy violations as well as potential future SOD policy violations. +With SOD violation functionality in place, administrators can get information about current SOD policy violations and predict whether an access change will trigger new violations, which helps to prevent them from occurring at all. + +"Separation of duties" refers to the concept that people shouldn't have conflicting sets of access - all their access should be configured in a way that protects your organization's assets and data. +For example, people who record monetary transactions shouldn't be able to issue payment for those transactions. +Any changes to major system configurations should be approved by someone other than the person requesting the change. + +Organizations can use "separation of duties" (SOD) policies to enforce and track their internal security rules throughout their tenants. +These SOD policies limit each user's involvement in important processes and protects the organization from individuals gaining excessive access. + +Once a SOD policy is in place, if an identity has conflicting access items, a SOD violation will trigger. +These violations are included in SOD violation reports that other users will see in emails at regular intervals if they're subscribed to the SOD policy. +The other users can then better help to enforce these SOD policies. + +Administrators can use the SOD violations APIs to check a set of identities for any current SOD violations, and they can use them to check whether adding an access item would potentially trigger a SOD violation. +This second option is a good way to prevent SOD violations from triggering at all. + +Refer to [Handling Policy Violations](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html) for more information about SOD policy violations. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Start-PredictSodViolations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict SOD violations for identity. +[**Start-ViolationCheck**](#start-violation-check) | **POST** `/sod-violations/check` | Check SOD violations + +## start-predict-sod-violations +This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | IdentityWithNewAccess | [**IdentityWithNewAccess**](../models/identity-with-new-access) | True | + +### Return type +[**ViolationPrediction**](../models/violation-prediction) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Violation Contexts | ViolationPrediction +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$IdentityWithNewAccess = @"{ + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] +}"@ + +# Predict SOD violations for identity. + +try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-PredictSodViolations-IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-PredictSodViolations -IdentityWithNewAccess $IdentityWithNewAccess +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-PredictSodViolations" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## start-violation-check +This API initiates a SOD policy verification asynchronously. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | IdentityWithNewAccess1 | [**IdentityWithNewAccess1**](../models/identity-with-new-access1) | True | + +### Return type +[**SodViolationCheck**](../models/sod-violation-check) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Request ID with a timestamp. | SodViolationCheck +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$IdentityWithNewAccess1 = @"{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}"@ + +# Check SOD violations + +try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-ViolationCheck-IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-ViolationCheck -IdentityWithNewAccess1 $IdentityWithNewAccess1 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-ViolationCheck" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/SavedSearchApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/SavedSearchApi.md new file mode 100644 index 000000000..188e210de --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/SavedSearchApi.md @@ -0,0 +1,367 @@ + +--- +id: saved-search +title: SavedSearch +pagination_label: SavedSearch +sidebar_label: SavedSearch +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearch', 'SavedSearch'] +slug: /tools/sdk/powershell/v3/methods/saved-search +tags: ['SDK', 'Software Development Kit', 'SavedSearch', 'SavedSearch'] +--- + +# SavedSearch + Use this API to implement saved search functionality. +With saved search functionality in place, users can save search queries and then view those saved searches, as well as rerun them. + +Search queries in Identity Security Cloud can grow very long and specific, which can make reconstructing them difficult or tedious, so it can be especially helpful to save search queries. +It also opens the possibility to configure Identity Security Cloud to run the saved queries on a schedule, which is essential to detecting user information and access changes throughout an organization's tenant and across all its sources. +Refer to [Scheduled Search](https://developer.sailpoint.com/docs/api/v3/scheduled-search/) for more information about running saved searches on a schedule. + +In Identity Security Cloud, users can save searches under a name, and then they can access that saved search and run it again when they want. + +Refer to [Managing Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html) for more information about saving searches and using them. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-SavedSearch**](#create-saved-search) | **POST** `/saved-searches` | Create a saved search +[**Remove-SavedSearch**](#delete-saved-search) | **DELETE** `/saved-searches/{id}` | Delete document by ID +[**Invoke-ExecuteSavedSearch**](#execute-saved-search) | **POST** `/saved-searches/{id}/execute` | Execute a saved search by ID +[**Get-SavedSearch**](#get-saved-search) | **GET** `/saved-searches/{id}` | Return saved search by ID +[**Get-SavedSearches**](#list-saved-searches) | **GET** `/saved-searches` | A list of Saved Searches +[**Send-SavedSearch**](#put-saved-search) | **PUT** `/saved-searches/{id}` | Updates an existing saved search + +## create-saved-search +Creates a new saved search. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CreateSavedSearchRequest | [**CreateSavedSearchRequest**](../models/create-saved-search-request) | True | The saved search to persist. + +### Return type +[**SavedSearch**](../models/saved-search) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | The persisted saved search. | SavedSearch +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CreateSavedSearchRequest = @""@ + +# Create a saved search + +try { + $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest + New-SavedSearch-CreateSavedSearchRequest $Result + + # Below is a request that includes all optional parameters + # New-SavedSearch -CreateSavedSearchRequest $CreateSavedSearchRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SavedSearch" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-saved-search +Deletes the specified saved search. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the requested document. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No Content - Indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + +# Delete document by ID + +try { + Remove-SavedSearch-Id $Id + + # Below is a request that includes all optional parameters + # Remove-SavedSearch -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SavedSearch" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## execute-saved-search +Executes the specified saved search. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the requested document. + Body | SearchArguments | [**SearchArguments**](../models/search-arguments) | True | When saved search execution is triggered by a scheduled search, *scheduleId* will specify the ID of the triggering scheduled search. If *scheduleId* is not specified (when execution is triggered by a UI test), the *owner* and *recipients* arguments must be provided. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. +$SearchArguments = @"{ + "owner" : "", + "recipients" : [ { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" +}"@ + +# Execute a saved search by ID + +try { + $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments + Invoke-ExecuteSavedSearch-Id $Id -SearchArguments $Result + + # Below is a request that includes all optional parameters + # Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $SearchArguments +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ExecuteSavedSearch" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-saved-search +Returns the specified saved search. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the requested document. + +### Return type +[**SavedSearch**](../models/saved-search) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The requested saved search. | SavedSearch +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + +# Return saved search by ID + +try { + Get-SavedSearch-Id $Id + + # Below is a request that includes all optional parameters + # Get-SavedSearch -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SavedSearch" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-saved-searches +Returns a list of saved searches. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* + +### Return type +[**SavedSearch[]**](../models/saved-search) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The list of requested saved searches. | SavedSearch[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) + +# A list of Saved Searches + +try { + Get-SavedSearches + + # Below is a request that includes all optional parameters + # Get-SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SavedSearches" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-saved-search +Updates an existing saved search. + +>**NOTE: You cannot update the `owner` of the saved search.** + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the requested document. + Body | SavedSearch | [**SavedSearch**](../models/saved-search) | True | The saved search to persist. + +### Return type +[**SavedSearch**](../models/saved-search) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The persisted saved search. | SavedSearch +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. +$SavedSearch = @"{ + "owner" : { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2018-06-25T20:22:28.104Z", + "columns" : { + "identity" : [ { + "field" : "displayName", + "header" : "Display Name" + }, { + "field" : "e-mail", + "header" : "Work Email" + } ] + }, + "query" : "@accounts(disabled:true)", + "description" : "Disabled accounts", + "orderBy" : { + "identity" : [ "lastName", "firstName" ], + "role" : [ "name" ] + }, + "sort" : [ "displayName" ], + "filters" : { + "terms" : [ "account_count", "account_count" ], + "range" : { + "lower" : { + "inclusive" : false, + "value" : "1" + }, + "upper" : { + "inclusive" : false, + "value" : "1" + } + }, + "exclude" : false, + "type" : "RANGE" + }, + "ownerId" : "2c91808568c529c60168cca6f90c1313", + "indices" : [ "identities" ], + "public" : false, + "name" : "Disabled accounts", + "modified" : "2018-06-25T20:22:28.104Z", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "fields" : [ "disabled" ] +}"@ + +# Updates an existing saved search + +try { + $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch + Send-SavedSearch-Id $Id -SavedSearch $Result + + # Below is a request that includes all optional parameters + # Send-SavedSearch -Id $Id -SavedSearch $SavedSearch +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SavedSearch" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/ScheduledSearchApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/ScheduledSearchApi.md new file mode 100644 index 000000000..200843f80 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/ScheduledSearchApi.md @@ -0,0 +1,371 @@ + +--- +id: scheduled-search +title: ScheduledSearch +pagination_label: ScheduledSearch +sidebar_label: ScheduledSearch +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledSearch', 'ScheduledSearch'] +slug: /tools/sdk/powershell/v3/methods/scheduled-search +tags: ['SDK', 'Software Development Kit', 'ScheduledSearch', 'ScheduledSearch'] +--- + +# ScheduledSearch + Use this API to implement scheduled search functionality. +With scheduled search functionality in place, users can run saved search queries on their tenants on a schedule, and Identity Security Cloud emails them the search results. +Users can also share these search results with other users by email by adding those users as subscribers, or those users can subscribe themselves. + +One of the greatest benefits of saving searches is the ability to run those searches on a schedule. +This is essential for organizations to constantly detect any changes to user information or access throughout their tenants and across all their sources. +For example, the manager Amanda Ross can schedule a saved search "manager.name:amanda.ross AND attributes.location:austin" on a schedule to regularly stay aware of changes with the Austin employees reporting to her. +Identity Security Cloud emails her the search results when the search runs, so she can work on other tasks instead of actively running this search. + +In Identity Security Cloud, scheduling a search involves a subscription. +Users can create a subscription for a saved search and schedule it to run daily, weekly, or monthly (you can only use one schedule option at a time). +The user can add other identities as subscribers so when the scheduled search runs, the subscribers and the user all receive emails. + +By default, subscriptions exclude detailed results from the emails, for security purposes. +Including detailed results about user access in an email may expose sensitive information. +However, the subscription creator can choose to include the information in the emails. + +By default, Identity Security Cloud sends emails to the subscribers even when the searches do not return new results. +However, the subscription creator can choose to suppress these empty emails. + +Users can also subscribe to saved searches that already have existing subscriptions so they receive emails when the searches run. +A saved search can have up to 10 subscriptions configured at a time. + +The subscription creator can enable, disable, or delete the subscription. + +Refer to [Subscribing to Saved Searches](https://documentation.sailpoint.com/saas/help/search/saved-searches.html#subscribing-to-saved-searches) for more information about scheduling searches and subscribing to them. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-ScheduledSearch**](#create-scheduled-search) | **POST** `/scheduled-searches` | Create a new scheduled search +[**Remove-ScheduledSearch**](#delete-scheduled-search) | **DELETE** `/scheduled-searches/{id}` | Delete a Scheduled Search +[**Get-ScheduledSearch**](#get-scheduled-search) | **GET** `/scheduled-searches/{id}` | Get a Scheduled Search +[**Get-ScheduledSearch**](#list-scheduled-search) | **GET** `/scheduled-searches` | List scheduled searches +[**Invoke-UnsubscribeScheduledSearch**](#unsubscribe-scheduled-search) | **POST** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from Scheduled Search +[**Update-ScheduledSearch**](#update-scheduled-search) | **PUT** `/scheduled-searches/{id}` | Update an existing Scheduled Search + +## create-scheduled-search +Creates a new scheduled search. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CreateScheduledSearchRequest | [**CreateScheduledSearchRequest**](../models/create-scheduled-search-request) | True | The scheduled search to persist. + +### Return type +[**ScheduledSearch**](../models/scheduled-search) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | The persisted scheduled search. | ScheduledSearch +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CreateScheduledSearchRequest = @"{savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]}"@ + +# Create a new scheduled search + +try { + $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest + New-ScheduledSearch-CreateScheduledSearchRequest $Result + + # Below is a request that includes all optional parameters + # New-ScheduledSearch -CreateScheduledSearchRequest $CreateScheduledSearchRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ScheduledSearch" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-scheduled-search +Deletes the specified scheduled search. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the requested document. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No Content - Indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + +# Delete a Scheduled Search + +try { + Remove-ScheduledSearch-Id $Id + + # Below is a request that includes all optional parameters + # Remove-ScheduledSearch -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ScheduledSearch" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-scheduled-search +Returns the specified scheduled search. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the requested document. + +### Return type +[**ScheduledSearch**](../models/scheduled-search) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The requested scheduled search. | ScheduledSearch +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + +# Get a Scheduled Search + +try { + Get-ScheduledSearch-Id $Id + + # Below is a request that includes all optional parameters + # Get-ScheduledSearch -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ScheduledSearch" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-scheduled-search +Returns a list of scheduled searches. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* + +### Return type +[**ScheduledSearch[]**](../models/scheduled-search) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The list of requested scheduled searches. | ScheduledSearch[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional) + +# List scheduled searches + +try { + Get-ScheduledSearch + + # Below is a request that includes all optional parameters + # Get-ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ScheduledSearch" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## unsubscribe-scheduled-search +Unsubscribes a recipient from the specified scheduled search. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the requested document. + Body | TypedReference | [**TypedReference**](../models/typed-reference) | True | The recipient to be removed from the scheduled search. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No Content - Indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. +$TypedReference = @"{ + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" +}"@ + +# Unsubscribe a recipient from Scheduled Search + +try { + $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference + Invoke-UnsubscribeScheduledSearch-Id $Id -TypedReference $Result + + # Below is a request that includes all optional parameters + # Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $TypedReference +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-UnsubscribeScheduledSearch" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-scheduled-search +Updates an existing scheduled search. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the requested document. + Body | ScheduledSearch | [**ScheduledSearch**](../models/scheduled-search) | True | The scheduled search to persist. + +### Return type +[**ScheduledSearch**](../models/scheduled-search) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The persisted scheduled search. | ScheduledSearch +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. +$ScheduledSearch = @"{ + "owner" : { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "displayQueryDetails" : false, + "created" : "", + "description" : "Daily disabled accounts", + "ownerId" : "2c9180867624cbd7017642d8c8c81f67", + "enabled" : false, + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "recipients" : [ { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + } ], + "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", + "name" : "Daily disabled accounts", + "modified" : "", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "emailEmptyResults" : false +}"@ + +# Update an existing Scheduled Search + +try { + $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch + Update-ScheduledSearch-Id $Id -ScheduledSearch $Result + + # Below is a request that includes all optional parameters + # Update-ScheduledSearch -Id $Id -ScheduledSearch $ScheduledSearch +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ScheduledSearch" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/SearchApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/SearchApi.md new file mode 100644 index 000000000..989337a51 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/SearchApi.md @@ -0,0 +1,582 @@ + +--- +id: search +title: Search +pagination_label: Search +sidebar_label: Search +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Search', 'Search'] +slug: /tools/sdk/powershell/v3/methods/search +tags: ['SDK', 'Software Development Kit', 'Search', 'Search'] +--- + +# Search + Use this API to implement search functionality. +With search functionality in place, users can search their tenants for nearly any information from throughout their organizations. + +Identity Security Cloud enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential. +Its search goes through all those sources and finds the results quickly and specifically. + +The search query is flexible - it can be very broad or very narrow. +The search only returns results for searchable objects it is filtering for. +The following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities. +By default, no filter is applied, so a search for "Ad" returns both the identity "Adam.Archer" as well as the role "Administrator." + +Users can further narrow their results by using Identity Security Cloud's specific syntax and punctuation to structure their queries. +For example, the query "attributes.location:austin AND NOT manager.name:amanda.ross" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross. +Refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries. + +Refer to [Using Search](https://documentation.sailpoint.com/saas/help/search/index.html) for more information about Identity Security Cloud's search and its different possibilities. + +The search feature uses Elasticsearch as a datastore and query engine. +The power of Elasticsearch makes this feature suitable for ad-hoc reporting. +However, data from the operational databases (ex. identities, roles, events, etc) has to be ingested into Elasticsearch. +This ingestion process introduces a latency from when the operational data is created to when it is available in search. +Depending on the system load, this can take a few seconds to a few minutes. +Please keep this latency in mind when you use search. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Search-Aggregate**](#search-aggregate) | **POST** `/search/aggregate` | Perform a Search Query Aggregation +[**Search-Count**](#search-count) | **POST** `/search/count` | Count Documents Satisfying a Query +[**Search-Get**](#search-get) | **GET** `/search/{index}/{id}` | Get a Document by ID +[**Search-Post**](#search-post) | **POST** `/search` | Perform Search + +## search-aggregate +Performs a search query aggregation and returns the aggregation result. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement searchAfter paging. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Search | [**Search**](../models/search) | True | + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**AggregationResult**](../models/aggregation-result) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Aggregation results. | AggregationResult +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json, text/csv + +### Example +```powershell +$Search = @"{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } +}"@ +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Perform a Search Query Aggregation + +try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-Aggregate-Search $Result + + # Below is a request that includes all optional parameters + # Search-Aggregate -Search $Search -Offset $Offset -Limit $Limit -Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Aggregate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## search-count +Performs a search with a provided query and returns the count of results in the X-Total-Count header. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Search | [**Search**](../models/search) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Search = @"{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } +}"@ + +# Count Documents Satisfying a Query + +try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-Count-Search $Result + + # Below is a request that includes all optional parameters + # Search-Count -Search $Search +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Count" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## search-get +Fetches a single document from the specified index, using the specified document ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Index | **String** | True | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. +Path | Id | **String** | True | ID of the requested document. + +### Return type +[**SearchDocument**](../models/search-document) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The requested document. | SearchDocument +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. +$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + +# Get a Document by ID + +try { + Search-Get-Index $Index -Id $Id + + # Below is a request that includes all optional parameters + # Search-Get -Index $Index -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Get" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## search-post +Perform a search with the provided query and return a matching result collection. To page past 10,000 records, you can use `searchAfter` paging. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Search | [**Search**](../models/search) | True | + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**SearchDocument[]**](../models/search-document) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of matching documents. | SearchDocument[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Search = @"{ + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } +}"@ +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Perform Search + +try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-Post-Search $Result + + # Below is a request that includes all optional parameters + # Search-Post -Search $Search -Offset $Offset -Limit $Limit -Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Post" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/SearchAttributeConfigurationApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/SearchAttributeConfigurationApi.md new file mode 100644 index 000000000..02d3d4b71 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/SearchAttributeConfigurationApi.md @@ -0,0 +1,275 @@ + +--- +id: search-attribute-configuration +title: SearchAttributeConfiguration +pagination_label: SearchAttributeConfiguration +sidebar_label: SearchAttributeConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchAttributeConfiguration', 'SearchAttributeConfiguration'] +slug: /tools/sdk/powershell/v3/methods/search-attribute-configuration +tags: ['SDK', 'Software Development Kit', 'SearchAttributeConfiguration', 'SearchAttributeConfiguration'] +--- + +# SearchAttributeConfiguration + Use this API to implement search attribute configuration functionality, along with [Search](https://developer.sailpoint.com/docs/api/v3/search). +With this functionality in place, administrators can create custom search attributes that and run extended searches based on those attributes to further narrow down their searches and get the information and insights they want. + +Identity Security Cloud (ISC) enables organizations to store user data from across all their connected sources and manage the users' access, so the ability to query and filter that data is essential. +Its search goes through all those sources and finds the results quickly and specifically. + +The search query is flexible - it can be very broad or very narrow. +The search only returns results for searchable objects it is filtering for. +The following objects are searchable: identities, roles, access profiles, entitlements, events, and account activities. +By default, no filter is applied, so a search for "Ad" returns both the identity "Adam.Archer" as well as the role "Administrator." + +Users can further narrow their results by using ISC's specific syntax and punctuation to structure their queries. +For example, the query "attributes.location:austin AND NOT manager.name:amanda.ross" returns all results associated with the Austin location, but it excludes those associated with the manager Amanda Ross. +Refer to [Building a Search Query](https://documentation.sailpoint.com/saas/help/search/building-query.html) for more information about how to construct specific search queries. + +Refer to [Using Search](https://documentation.sailpoint.com/saas/help/search/index.html) for more information about ISC's search and its different possibilities. + +With Search Attribute Configuration, administrators can create, manage, and run searches based on the attributes they want to search. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-SearchAttributeConfig**](#create-search-attribute-config) | **POST** `/accounts/search-attribute-config` | Create Extended Search Attributes +[**Remove-SearchAttributeConfig**](#delete-search-attribute-config) | **DELETE** `/accounts/search-attribute-config/{name}` | Delete Extended Search Attribute +[**Get-SearchAttributeConfig**](#get-search-attribute-config) | **GET** `/accounts/search-attribute-config` | List Extended Search Attributes +[**Get-SingleSearchAttributeConfig**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute +[**Update-SearchAttributeConfig**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute + +## create-search-attribute-config +Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create and attribute promotion configuration in the Link ObjectConfig. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | SearchAttributeConfig | [**SearchAttributeConfig**](../models/search-attribute-config) | True | + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SearchAttributeConfig = @"{ + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } +}"@ + +# Create Extended Search Attributes + +try { + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-SearchAttributeConfig-SearchAttributeConfig $Result + + # Below is a request that includes all optional parameters + # New-SearchAttributeConfig -SearchAttributeConfig $SearchAttributeConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SearchAttributeConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-search-attribute-config +Delete an extended attribute configuration by name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Name | **String** | True | Name of the extended search attribute configuration to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. + +# Delete Extended Search Attribute + +try { + Remove-SearchAttributeConfig-Name $Name + + # Below is a request that includes all optional parameters + # Remove-SearchAttributeConfig -Name $Name +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SearchAttributeConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-search-attribute-config +Get a list of attribute/application associates currently configured in Identity Security Cloud (ISC). + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**SearchAttributeConfig[]**](../models/search-attribute-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of attribute configurations in IdentityNow. | SearchAttributeConfig[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List Extended Search Attributes + +try { + Get-SearchAttributeConfig + + # Below is a request that includes all optional parameters + # Get-SearchAttributeConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SearchAttributeConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-single-search-attribute-config +Get an extended attribute configuration by name. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Name | **String** | True | Name of the extended search attribute configuration to retrieve. + +### Return type +[**SearchAttributeConfig[]**](../models/search-attribute-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Specific attribute configuration in ISC. | SearchAttributeConfig[] +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to retrieve. + +# Get Extended Search Attribute + +try { + Get-SingleSearchAttributeConfig-Name $Name + + # Below is a request that includes all optional parameters + # Get-SingleSearchAttributeConfig -Name $Name +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SingleSearchAttributeConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-search-attribute-config +Update an existing search attribute configuration. +You can patch these fields: +* name * displayName * applicationAttributes + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Name | **String** | True | Name of the search attribute configuration to patch. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**SearchAttributeConfig**](../models/search-attribute-config) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The updated search attribute configuration. | SearchAttributeConfig +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | + + +# Update Extended Search Attribute + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-SearchAttributeConfig-Name $Name -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SearchAttributeConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/SegmentsApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/SegmentsApi.md new file mode 100644 index 000000000..a5edd1ac1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/SegmentsApi.md @@ -0,0 +1,292 @@ + +--- +id: segments +title: Segments +pagination_label: Segments +sidebar_label: Segments +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Segments', 'Segments'] +slug: /tools/sdk/powershell/v3/methods/segments +tags: ['SDK', 'Software Development Kit', 'Segments', 'Segments'] +--- + +# Segments + Use this API to implement and customize access request segment functionality. +With this functionality in place, administrators can create and manage access request segments. +Segments provide organizations with a way to make the access their users have even more granular - this can simply the access request process for the organization's users and improves security by reducing the risk of overprovisoning access. + +Segments represent sets of identities, all grouped by specified identity attributes, who are only able to see and access the access items associated with their segments. +For example, administrators could group all their organization's London office employees into one segment, "London Office Employees," by their shared location. +The administrators could then define the access items the London employees would need, and the identities in the "London Office Employees" would then only be able to see and access those items. + +In Identity Security Cloud, administrators can use the 'Access' drop-down menu and select 'Segments' to reach the 'Access Requests Segments' page. +This page lists all the existing access request segments, along with their statuses, enabled or disabled. +Administrators can use this page to create, edit, enable, disable, and delete segments. +To create a segment, an administrator must provide a name, define the identities grouped in the segment, and define the items the identities in the segment can access. +These items can be access profiles, roles, or entitlements. + +When administrators use the API to create and manage segments, they use a JSON expression in the `visibilityCriteria` object to define the segment's identities and access items. + +Refer to [Managing Access Request Segments](https://documentation.sailpoint.com/saas/help/requests/segments.html) for more information about segments in Identity Security Cloud. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-Segment**](#create-segment) | **POST** `/segments` | Create Segment +[**Remove-Segment**](#delete-segment) | **DELETE** `/segments/{id}` | Delete Segment by ID +[**Get-Segment**](#get-segment) | **GET** `/segments/{id}` | Get Segment by ID +[**Get-Segments**](#list-segments) | **GET** `/segments` | List Segments +[**Update-Segment**](#patch-segment) | **PATCH** `/segments/{id}` | Update Segment + +## create-segment +This API creates a segment. +>**Note:** Segment definitions may take time to propagate to all identities. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Segment | [**Segment**](../models/segment) | True | + +### Return type +[**Segment**](../models/segment) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Segment created | Segment +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Segment = @"{ + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" +}"@ + +# Create Segment + +try { + $Result = ConvertFrom-JsonToSegment -Json $Segment + New-Segment-Segment $Result + + # Below is a request that includes all optional parameters + # New-Segment -Segment $Segment +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Segment" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-segment +This API deletes the segment specified by the given ID. +>**Note:** that segment deletion may take some time to become effective. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The segment ID to delete. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + +# Delete Segment by ID + +try { + Remove-Segment-Id $Id + + # Below is a request that includes all optional parameters + # Remove-Segment -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Segment" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-segment +This API returns the segment specified by the given ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The segment ID to retrieve. + +### Return type +[**Segment**](../models/segment) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Segment | Segment +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + +# Get Segment by ID + +try { + Get-Segment-Id $Id + + # Below is a request that includes all optional parameters + # Get-Segment -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Segment" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-segments +This API returns a list of all segments. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**Segment[]**](../models/segment) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of all segments | Segment[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# List Segments + +try { + Get-Segments + + # Below is a request that includes all optional parameters + # Get-Segments -Limit $Limit -Offset $Offset -Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Segments" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-segment +Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +>**Note:** Changes to a segment may take some time to propagate to all identities. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The segment ID to modify. + Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | True | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + +### Return type +[**Segment**](../models/segment) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Indicates the PATCH operation succeeded, and returns the segment's new representation. | Segment +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. +$RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + + +# Update Segment + +try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-Segment-Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-Segment -Id $Id -RequestBody $RequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Segment" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/ServiceDeskIntegrationApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/ServiceDeskIntegrationApi.md new file mode 100644 index 000000000..cbff84fe5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/ServiceDeskIntegrationApi.md @@ -0,0 +1,566 @@ + +--- +id: service-desk-integration +title: ServiceDeskIntegration +pagination_label: ServiceDeskIntegration +sidebar_label: ServiceDeskIntegration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskIntegration', 'ServiceDeskIntegration'] +slug: /tools/sdk/powershell/v3/methods/service-desk-integration +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegration', 'ServiceDeskIntegration'] +--- + +# ServiceDeskIntegration + Use this API to build an integration between Identity Security Cloud and a service desk ITSM (IT service management) solution. +Once an administrator builds this integration between Identity Security Cloud and a service desk, users can use Identity Security Cloud to raise and track tickets that are synchronized between Identity Security Cloud and the service desk. + +In Identity Security Cloud, administrators can create a service desk integration (sometimes also called an SDIM, or Service Desk Integration Module) by going to Admin > Connections > Service Desk and selecting 'Create.' + +To create a Generic Service Desk integration, for example, administrators must provide the required information on the General Settings page, the Connectivity and Authentication information, Ticket Creation information, Status Mapping information, and Requester Source information on the Configure page. +Refer to [Integrating SailPoint with Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) for more information about the process of setting up a Generic Service Desk in Identity Security Cloud. + +Administrators can create various service desk integrations, all with their own nuances. +The following service desk integrations are available: + +- [Atlassian Cloud Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_cloud/help/integrating_jira_cloud_sd/introduction.html) + +- [Atlassian Server Jira Service Management](https://documentation.sailpoint.com/connectors/atlassian/jira_server/help/integrating_jira_server_sd/introduction.html) + +- [BMC Helix ITSM Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_ITSM_sd/help/integrating_bmc_helix_itsm_sd/intro.html) + +- [BMC Helix Remedyforce Service Desk](https://documentation.sailpoint.com/connectors/bmc/helix_remedyforce_sd/help/integrating_bmc_helix_remedyforce_sd/intro.html) + +- [Generic Service Desk](https://documentation.sailpoint.com/connectors/generic_sd/help/integrating_generic_service_desk/intro.html) + +- [ServiceNow Service Desk](https://documentation.sailpoint.com/connectors/servicenow/sdim/help/integrating_servicenow_sdim/intro.html) + +- [Zendesk Service Desk](https://documentation.sailpoint.com/connectors/zendesk/help/integrating_zendesk_sd/introduction.html) + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-ServiceDeskIntegration**](#create-service-desk-integration) | **POST** `/service-desk-integrations` | Create new Service Desk integration +[**Remove-ServiceDeskIntegration**](#delete-service-desk-integration) | **DELETE** `/service-desk-integrations/{id}` | Delete a Service Desk integration +[**Get-ServiceDeskIntegration**](#get-service-desk-integration) | **GET** `/service-desk-integrations/{id}` | Get a Service Desk integration +[**Get-ServiceDeskIntegrationTemplate**](#get-service-desk-integration-template) | **GET** `/service-desk-integrations/templates/{scriptName}` | Service Desk integration template by scriptName +[**Get-ServiceDeskIntegrationTypes**](#get-service-desk-integration-types) | **GET** `/service-desk-integrations/types` | List Service Desk integration types +[**Get-ServiceDeskIntegrations**](#get-service-desk-integrations) | **GET** `/service-desk-integrations` | List existing Service Desk integrations +[**Get-StatusCheckDetails**](#get-status-check-details) | **GET** `/service-desk-integrations/status-check-configuration` | Get the time check configuration +[**Update-ServiceDeskIntegration**](#patch-service-desk-integration) | **PATCH** `/service-desk-integrations/{id}` | Patch a Service Desk Integration +[**Send-ServiceDeskIntegration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a Service Desk integration +[**Update-StatusCheckDetails**](#update-status-check-details) | **PUT** `/service-desk-integrations/status-check-configuration` | Update the time check configuration + +## create-service-desk-integration +Create a new Service Desk integration. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | ServiceDeskIntegrationDto | [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) | True | The specifics of a new integration to create + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Details of the created integration | ServiceDeskIntegrationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$ServiceDeskIntegrationDto = @"{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" +}"@ + +# Create new Service Desk integration + +try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-ServiceDeskIntegration-ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # New-ServiceDeskIntegration -ServiceDeskIntegrationDto $ServiceDeskIntegrationDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ServiceDeskIntegration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-service-desk-integration +Delete an existing Service Desk integration by ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of Service Desk integration to delete + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | Service Desk integration with the given ID successfully deleted | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "anId" # String | ID of Service Desk integration to delete + +# Delete a Service Desk integration + +try { + Remove-ServiceDeskIntegration-Id $Id + + # Below is a request that includes all optional parameters + # Remove-ServiceDeskIntegration -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ServiceDeskIntegration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-service-desk-integration +Get an existing Service Desk integration by ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Service Desk integration to get + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | ServiceDeskIntegrationDto with the given ID | ServiceDeskIntegrationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "anId" # String | ID of the Service Desk integration to get + +# Get a Service Desk integration + +try { + Get-ServiceDeskIntegration-Id $Id + + # Below is a request that includes all optional parameters + # Get-ServiceDeskIntegration -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-service-desk-integration-template +This API endpoint returns an existing Service Desk integration template by scriptName. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | ScriptName | **String** | True | The scriptName value of the Service Desk integration template to get + +### Return type +[**ServiceDeskIntegrationTemplateDto**](../models/service-desk-integration-template-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName. | ServiceDeskIntegrationTemplateDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + +# Service Desk integration template by scriptName + +try { + Get-ServiceDeskIntegrationTemplate-ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-ServiceDeskIntegrationTemplate -ScriptName $ScriptName +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrationTemplate" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-service-desk-integration-types +This API endpoint returns the current list of supported Service Desk integration types. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**ServiceDeskIntegrationTemplateType[]**](../models/service-desk-integration-template-type) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with an array of the currently supported Service Desk integration types. | ServiceDeskIntegrationTemplateType[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List Service Desk integration types + +try { + Get-ServiceDeskIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-ServiceDeskIntegrationTypes +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrationTypes" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-service-desk-integrations +Get a list of Service Desk integration objects. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**ServiceDeskIntegrationDto[]**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of ServiceDeskIntegrationDto | ServiceDeskIntegrationDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) +$Filters = 'name eq "John Doe"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# List existing Service Desk integrations + +try { + Get-ServiceDeskIntegrations + + # Below is a request that includes all optional parameters + # Get-ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrations" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-status-check-details +Get the time check configuration of queued SDIM tickets. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**QueuedCheckConfigDetails**](../models/queued-check-config-details) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | QueuedCheckConfigDetails containing the configured values | QueuedCheckConfigDetails +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get the time check configuration + +try { + Get-StatusCheckDetails + + # Below is a request that includes all optional parameters + # Get-StatusCheckDetails +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusCheckDetails" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-service-desk-integration +Update an existing Service Desk integration by ID with a PATCH request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Service Desk integration to update + Body | PatchServiceDeskIntegrationRequest | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | ServiceDeskIntegrationDto as updated | ServiceDeskIntegrationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "anId" # String | ID of the Service Desk integration to update +$PatchServiceDeskIntegrationRequest = @""@ + +# Patch a Service Desk Integration + +try { + $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest + Update-ServiceDeskIntegration-Id $Id -PatchServiceDeskIntegrationRequest $Result + + # Below is a request that includes all optional parameters + # Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $PatchServiceDeskIntegrationRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ServiceDeskIntegration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-service-desk-integration +Update an existing Service Desk integration by ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the Service Desk integration to update + Body | ServiceDeskIntegrationDto | [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) | True | The specifics of the integration to update + +### Return type +[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | ServiceDeskIntegrationDto as updated | ServiceDeskIntegrationDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "anId" # String | ID of the Service Desk integration to update +$ServiceDeskIntegrationDto = @"{ + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" +}"@ + +# Update a Service Desk integration + +try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-ServiceDeskIntegration-Id $Id -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $ServiceDeskIntegrationDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ServiceDeskIntegration" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-status-check-details +Update the time check configuration of queued SDIM tickets. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | QueuedCheckConfigDetails | [**QueuedCheckConfigDetails**](../models/queued-check-config-details) | True | The modified time check configuration + +### Return type +[**QueuedCheckConfigDetails**](../models/queued-check-config-details) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | QueuedCheckConfigDetails as updated | QueuedCheckConfigDetails +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$QueuedCheckConfigDetails = @"{ + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" +}"@ + +# Update the time check configuration + +try { + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-StatusCheckDetails-QueuedCheckConfigDetails $Result + + # Below is a request that includes all optional parameters + # Update-StatusCheckDetails -QueuedCheckConfigDetails $QueuedCheckConfigDetails +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-StatusCheckDetails" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/SourceUsagesApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/SourceUsagesApi.md new file mode 100644 index 000000000..ba8b290f6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/SourceUsagesApi.md @@ -0,0 +1,118 @@ + +--- +id: source-usages +title: SourceUsages +pagination_label: SourceUsages +sidebar_label: SourceUsages +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceUsages', 'SourceUsages'] +slug: /tools/sdk/powershell/v3/methods/source-usages +tags: ['SDK', 'Software Development Kit', 'SourceUsages', 'SourceUsages'] +--- + +# SourceUsages + Use this API to implement source usage insight functionality. +With this functionality in place, administrators can gather information and insights about how their tenants' sources are being used. +This allows organizations to get the information they need to start optimizing and securing source usage. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Get-StatusBySourceId**](#get-status-by-source-id) | **GET** `/source-usages/{sourceId}/status` | Finds status of source usage +[**Get-UsagesBySourceId**](#get-usages-by-source-id) | **GET** `/source-usages/{sourceId}/summaries` | Returns source usage insights + +## get-status-by-source-id +This API returns the status of the source usage insights setup by IDN source ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | ID of IDN source + +### Return type +[**SourceUsageStatus**](../models/source-usage-status) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Status of the source usage insights setup by IDN source ID. | SourceUsageStatus +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + +# Finds status of source usage + +try { + Get-StatusBySourceId-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-StatusBySourceId -SourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusBySourceId" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-usages-by-source-id +This API returns a summary of source usage insights for past 12 months. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | ID of IDN source + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** + +### Return type +[**SourceUsage[]**](../models/source-usage) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Summary of source usage insights for past 12 months. | SourceUsage[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + +# Returns source usage insights + +try { + 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 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesBySourceId" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/SourcesApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/SourcesApi.md new file mode 100644 index 000000000..455b4dcac --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/SourcesApi.md @@ -0,0 +1,1742 @@ + +--- +id: sources +title: Sources +pagination_label: Sources +sidebar_label: Sources +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Sources', 'Sources'] +slug: /tools/sdk/powershell/v3/methods/sources +tags: ['SDK', 'Software Development Kit', 'Sources', 'Sources'] +--- + +# Sources + Use this API to implement and customize source functionality. +With source functionality in place, organizations can use Identity Security Cloud to connect their various sources and user data sets and manage access across all those different sources in a secure, scalable way. + +[Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) refer to the Identity Security Cloud representations for external applications, databases, and directory management systems that maintain their own sets of users, like Dropbox, GitHub, and Workday, for example. +Organizations may use hundreds, if not thousands, of different source systems, and any one employee within an organization likely has a different user record on each source, often with different permissions on many of those records. +Connecting these sources to Identity Security Cloud makes it possible to manage user access across them all. +Then, if a new hire starts at an organization, Identity Security Cloud can grant the new hire access to all the sources they need. +If an employee moves to a new department and needs access to new sources but no longer needs access to others, Identity Security Cloud can grant the necessary access and revoke the unnecessary access for all the employee's various sources. +If an employee leaves the company, Identity Security Cloud can revoke access to all the employee's various source accounts immediately. +These are just a few examples of the many ways that source functionality makes identity governance easier, more efficient, and more secure. + +In Identity Security Cloud, administrators can create configure, manage, and edit sources, and they can designate other users as source admins to be able to do so. +They can also designate users as source sub-admins, who can perform the same source actions but only on sources associated with their governance groups. +Admins go to Connections > Sources to see a list of the existing source representations in their organizations. +They can create new sources or select existing ones. + +To create a new source, the following must be specified: Source Name, Description, Source Owner, and Connection Type. +Refer to [Configuring a Source](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html#configuring-a-source) for more information about the source configuration process. + +Identity Security Cloud connects with its sources either by a direct communication with the source server (connection information specific to the source must be provided) or a flat file feed, a CSV file containing all the relevant information about the accounts to be loaded in. +Different sources use different connectors to share data with Identity Security Cloud, and each connector's setup process is specific to that connector. +SailPoint has built a number of connectors to come out of the box and connect to the most common sources, and SailPoint actively maintains these connectors. +Refer to [Identity Security Cloud Connectors](https://documentation.sailpoint.com/connectors/identitynow/landingpages/help/landingpages/identitynow_connectivity_landing.html) for more information about these SailPoint supported connectors. +Refer to the following links for more information about two useful connectors: + +- [JDBC Connector](https://documentation.sailpoint.com/connectors/jdbc/help/integrating_jdbc/introduction.html): This customizable connector an directly connect to databases that support JDBC (Java Database Connectivity). + +- [Web Services Connector](https://documentation.sailpoint.com/connectors/webservices/help/integrating_webservices/introduction.html): This connector can directly connect to databases that support Web Services. + +Refer to [SaaS Connectivity](https://developer.sailpoint.com/docs/connectivity/saas-connectivity/) for more information about SailPoint's new connectivity framework that makes it easy to build and manage custom connectors to SaaS sources. + +When admins select existing sources, they can view the following information about the source: + +- Associated connections (any associated identity profiles, apps, or references to the source in a transform). + +- Associated user accounts. These accounts are linked to their identities - this provides a more complete picture of each user's access across sources. + +- Associated entitlements (sets of access rights on sources). + +- Associated access profiles (groupings of entitlements). + +The user account data and the entitlements update with each data aggregation from the source. +Organizations generally run scheduled, automated data aggregations to ensure that their data is always in sync between their sources and their Identity Security Cloud tenants so an access change on a source is detected quickly in Identity Security Cloud. +Admins can view a history of these aggregations, and they can also run manual imports. +Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about manual and scheduled aggregations. + +Admins can also make changes to determine which user account data Identity Security Cloud collects from the source and how it correlates that account data with identity data. +To define which account attributes the source shares with Identity Security Cloud, admins can edit the account schema on the source. +Refer to [Managing Source Account Schemas](https://documentation.sailpoint.com/saas/help/accounts/schema.html) for more information about source account schemas and how to edit them. +To define the mapping between the source account attributes and their correlating identity attributes, admins can edit the correlation configuration on the source. +Refer to [Assigning Source Accounts to Identities](https://documentation.sailpoint.com/saas/help/accounts/correlation.html) for more information about this correlation process between source accounts and identities. + +Admins can also delete sources, but they must first ensure that the sources no longer have any active connections: the source must not be associated with any identity profile or any app, and it must not be referenced by any transform. +Refer to [Deleting Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html#deleting-sources) for more information about deleting sources. + +Well organized, mapped out connections between sources and Identity Security Cloud are essential to achieving comprehensive identity access governance across all the source systems organizations need. +Refer to [Managing Sources](https://documentation.sailpoint.com/saas/help/sources/managing_sources.html) for more information about all the different things admins can do with sources once they are connected. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-ProvisioningPolicy**](#create-provisioning-policy) | **POST** `/sources/{sourceId}/provisioning-policies` | Create Provisioning Policy +[**New-Source**](#create-source) | **POST** `/sources` | Creates a source in IdentityNow. +[**New-SourceSchema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create Schema on Source +[**Remove-ProvisioningPolicy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete Provisioning Policy by UsageType +[**Remove-Source**](#delete-source) | **DELETE** `/sources/{id}` | Delete Source by ID +[**Remove-SourceSchema**](#delete-source-schema) | **DELETE** `/sources/{sourceId}/schemas/{schemaId}` | Delete Source Schema by ID +[**Get-AccountsSchema**](#get-accounts-schema) | **GET** `/sources/{id}/schemas/accounts` | Downloads source accounts schema template +[**Get-EntitlementsSchema**](#get-entitlements-schema) | **GET** `/sources/{id}/schemas/entitlements` | Downloads source entitlements schema template +[**Get-ProvisioningPolicy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType +[**Get-Source**](#get-source) | **GET** `/sources/{id}` | Get Source by ID +[**Get-SourceConnections**](#get-source-connections) | **GET** `/sources/{sourceId}/connections` | Get Source Connections by ID +[**Get-SourceHealth**](#get-source-health) | **GET** `/sources/{sourceId}/source-health` | Fetches source health by id +[**Get-SourceSchema**](#get-source-schema) | **GET** `/sources/{sourceId}/schemas/{schemaId}` | Get Source Schema by ID +[**Get-SourceSchemas**](#get-source-schemas) | **GET** `/sources/{sourceId}/schemas` | List Schemas on Source +[**Import-AccountsSchema**](#import-accounts-schema) | **POST** `/sources/{id}/schemas/accounts` | Uploads source accounts schema template +[**Import-ConnectorFile**](#import-connector-file) | **POST** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source +[**Import-EntitlementsSchema**](#import-entitlements-schema) | **POST** `/sources/{id}/schemas/entitlements` | Uploads source entitlements schema template +[**Get-ProvisioningPolicies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies +[**Get-Sources**](#list-sources) | **GET** `/sources` | Lists all sources in IdentityNow. +[**Send-ProvisioningPolicy**](#put-provisioning-policy) | **PUT** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update Provisioning Policy by UsageType +[**Send-Source**](#put-source) | **PUT** `/sources/{id}` | Update Source (Full) +[**Send-SourceSchema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full) +[**Update-ProvisioningPoliciesInBulk**](#update-provisioning-policies-in-bulk) | **POST** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk Update Provisioning Policies +[**Update-ProvisioningPolicy**](#update-provisioning-policy) | **PATCH** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of Provisioning Policy +[**Update-Source**](#update-source) | **PATCH** `/sources/{id}` | Update Source (Partial) +[**Update-SourceSchema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial) + +## create-provisioning-policy +This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id + Body | ProvisioningPolicyDto | [**ProvisioningPolicyDto**](../models/provisioning-policy-dto) | True | + +### Return type +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Created ProvisioningPolicyDto object | ProvisioningPolicyDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id +$ProvisioningPolicyDto = @"{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" +}"@ + +# Create Provisioning Policy + +try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + New-ProvisioningPolicy-SourceId $SourceId -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # New-ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $ProvisioningPolicyDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ProvisioningPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-source +This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Source | [**Source**](../models/source) | True | + Query | ProvisionAsCsv | **Boolean** | (optional) | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Created Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design. | Source +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Source = @"{ + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" +}"@ +$ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) + +# Creates a source in IdentityNow. + +try { + $Result = ConvertFrom-JsonToSource -Json $Source + New-Source-Source $Result + + # Below is a request that includes all optional parameters + # New-Source -Source $Source -ProvisionAsCsv $ProvisionAsCsv +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Source" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-source-schema +Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | Source ID. + Body | Schema | [**Schema**](../models/schema) | True | + +### Return type +[**Schema**](../models/schema) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | The schema was successfully created on the specified source. | Schema +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. +$Schema = @"{ + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" +}"@ + +# Create Schema on Source + +try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + New-SourceSchema-SourceId $SourceId -Schema $Result + + # Below is a request that includes all optional parameters + # New-SourceSchema -SourceId $SourceId -Schema $Schema +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SourceSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-provisioning-policy +Deletes the provisioning policy with the specified usage on an application. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source ID. +Path | UsageType | [**UsageType**](../models/usage-type) | True | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. +$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + +# Delete Provisioning Policy by UsageType + +try { + Remove-ProvisioningPolicy-SourceId $SourceId -UsageType $UsageType + + # Below is a request that includes all optional parameters + # Remove-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ProvisioningPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-source +Use this API to delete a specific source in Identity Security Cloud (ISC). +The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source ID. + +### Return type +[**DeleteSource202Response**](../models/delete-source202-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +202 | Accepted - Returned if the request was successfully accepted into the system. | DeleteSource202Response +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + +# Delete Source by ID + +try { + Remove-Source-Id $Id + + # Below is a request that includes all optional parameters + # Remove-Source -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Source" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-source-schema + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id. +Path | SchemaId | **String** | True | The Schema id. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. +$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + +# Delete Source Schema by ID + +try { + Remove-SourceSchema-SourceId $SourceId -SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Remove-SourceSchema -SourceId $SourceId -SchemaId $SchemaId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SourceSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-accounts-schema +This API downloads the CSV schema that defines the account attributes on a source. +>**NOTE: This API is designated only for Delimited File sources.** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The Source id + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully downloaded the file | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: text/csv, application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + +# Downloads source accounts schema template + +try { + Get-AccountsSchema-Id $Id + + # Below is a request that includes all optional parameters + # Get-AccountsSchema -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountsSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-entitlements-schema +This API downloads the CSV schema that defines the entitlement attributes on a source. + +>**NOTE: This API is designated only for Delimited File sources.** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The Source id + Query | SchemaName | **String** | (optional) | Name of entitlement schema + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully downloaded the file | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: text/csv, application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id +$SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + +# Downloads source entitlements schema template + +try { + Get-EntitlementsSchema-Id $Id + + # Below is a request that includes all optional parameters + # Get-EntitlementsSchema -Id $Id -SchemaName $SchemaName +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-EntitlementsSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-provisioning-policy +This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source ID. +Path | UsageType | [**UsageType**](../models/usage-type) | True | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + +### Return type +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The requested ProvisioningPolicyDto was successfully retrieved. | ProvisioningPolicyDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. +$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + +# Get Provisioning Policy by UsageType + +try { + Get-ProvisioningPolicy-SourceId $SourceId -UsageType $UsageType + + # Below is a request that includes all optional parameters + # Get-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ProvisioningPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-source +Use this API to get a source by a specified ID in Identity Security Cloud (ISC). + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source ID. + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Source object. | Source +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + +# Get Source by ID + +try { + Get-Source-Id $Id + + # Below is a request that includes all optional parameters + # Get-Source -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Source" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-source-connections +Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC). + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source ID. + +### Return type +[**SourceConnectionsDto**](../models/source-connections-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Source Connections object. | SourceConnectionsDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + +# Get Source Connections by ID + +try { + Get-SourceConnections-Id $Id + + # Below is a request that includes all optional parameters + # Get-SourceConnections -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceConnections" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-source-health +This endpoint fetches source health by source's id + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id. + +### Return type +[**SourceHealthDto**](../models/source-health-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Fetched source health successfully | SourceHealthDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + +# Fetches source health by id + +try { + Get-SourceHealth-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-SourceHealth -SourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceHealth" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-source-schema +Get the Source Schema by ID in IdentityNow. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id. +Path | SchemaId | **String** | True | The Schema id. + +### Return type +[**Schema**](../models/schema) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The requested Schema was successfully retrieved. | Schema +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. +$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + +# Get Source Schema by ID + +try { + Get-SourceSchema-SourceId $SourceId -SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Get-SourceSchema -SourceId $SourceId -SchemaId $SchemaId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-source-schemas +Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | Source ID. + Query | IncludeTypes | **String** | (optional) | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. + Query | IncludeNames | **String** | (optional) | A comma-separated list of schema names to filter result. + +### Return type +[**Schema[]**](../models/schema) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The schemas were successfully retrieved. | Schema[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. +$IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) +$IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional) + +# List Schemas on Source + +try { + Get-SourceSchemas-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-SourceSchemas -SourceId $SourceId -IncludeTypes $IncludeTypes -IncludeNames $IncludeNames +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceSchemas" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-accounts-schema +This API uploads a source schema template file to configure a source's account attributes. + +To retrieve the file to modify and upload, log into Identity Now. + +Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Account Schema** -> **Options** -> **Download Schema** + +>**NOTE: This API is designated only for Delimited File sources.** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The Source id + | File | **System.IO.FileInfo** | (optional) | + +### Return type +[**Schema**](../models/schema) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully uploaded the file | Schema +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id +$File = # System.IO.FileInfo | (optional) + +# Uploads source accounts schema template + +try { + Import-AccountsSchema-Id $Id + + # Below is a request that includes all optional parameters + # Import-AccountsSchema -Id $Id -File $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-AccountsSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-connector-file +This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id. + | File | **System.IO.FileInfo** | (optional) | + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Uploaded the file successfully and sent all post-upload events | Source +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. +$File = # System.IO.FileInfo | (optional) + +# Upload connector file to source + +try { + Import-ConnectorFile-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-ConnectorFile -SourceId $SourceId -File $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-ConnectorFile" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## import-entitlements-schema +This API uploads a source schema template file to configure a source's entitlement attributes. + +To retrieve the file to modify and upload, log into Identity Now. + +Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Import Data** -> **Import Entitlements** -> **Download** + +>**NOTE: This API is designated only for Delimited File sources.** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The Source id + Query | SchemaName | **String** | (optional) | Name of entitlement schema + | File | **System.IO.FileInfo** | (optional) | + +### Return type +[**Schema**](../models/schema) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully uploaded the file | Schema +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: multipart/form-data +- **Accept**: application/json + +### Example +```powershell +$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id +$SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) +$File = # System.IO.FileInfo | (optional) + +# Uploads source entitlements schema template + +try { + Import-EntitlementsSchema-Id $Id + + # Below is a request that includes all optional parameters + # Import-EntitlementsSchema -Id $Id -SchemaName $SchemaName -File $File +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-EntitlementsSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-provisioning-policies +This end-point lists all the ProvisioningPolicies in IdentityNow. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id + +### Return type +[**ProvisioningPolicyDto[]**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of ProvisioningPolicyDto objects | ProvisioningPolicyDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + +# Lists ProvisioningPolicies + +try { + Get-ProvisioningPolicies-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-ProvisioningPolicies -SourceId $SourceId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ProvisioningPolicies" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-sources +This end-point lists all the sources in IdentityNow. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* + Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** + Query | ForSubadmin | **String** | (optional) | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. + Query | IncludeIDNSource | **Boolean** | (optional) (default to $false) | Include the IdentityNow source in the response. + +### Return type +[**Source[]**](../models/source) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of Source objects | Source[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'name eq "Employees"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) +$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) +$ForSubadmin = "name" # String | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) +$IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false) + +# Lists all sources in IdentityNow. + +try { + Get-Sources + + # Below is a request that includes all optional parameters + # Get-Sources -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSubadmin $ForSubadmin -IncludeIDNSource $IncludeIDNSource +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Sources" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-provisioning-policy +This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source ID. +Path | UsageType | [**UsageType**](../models/usage-type) | True | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + Body | ProvisioningPolicyDto | [**ProvisioningPolicyDto**](../models/provisioning-policy-dto) | True | + +### Return type +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The ProvisioningPolicyDto was successfully replaced. | ProvisioningPolicyDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. +$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. +$ProvisioningPolicyDto = @"{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" +}"@ + +# Update Provisioning Policy by UsageType + +try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + 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 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ProvisioningPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-source +Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. + +These fields are immutable, so they cannot be changed: + +* id +* type +* authoritative +* connector +* connectorClass +* passwordPolicies + +Attempts to modify these fields will result in a 400 error. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source ID. + Body | Source | [**Source**](../models/source) | True | + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated Source object. Any passwords will only show the the encrypted cipher-text so that they aren't decryptable in Identity Security Cloud (ISC) cloud-based services, per ISC security design. | Source +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. +$Source = @"{ + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" +}"@ + +# Update Source (Full) + +try { + $Result = ConvertFrom-JsonToSource -Json $Source + Send-Source-Id $Id -Source $Result + + # Below is a request that includes all optional parameters + # Send-Source -Id $Id -Source $Source +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Source" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-source-schema +This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. + +* id +* name +* created +* modified + +Any attempt to modify these fields will result in an error response with a status code of 400. + +> `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id. +Path | SchemaId | **String** | True | The Schema id. + Body | Schema | [**Schema**](../models/schema) | True | + +### Return type +[**Schema**](../models/schema) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Schema was successfully replaced. | Schema +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. +$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. +$Schema = @"{ + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" +}"@ + +# Update Source Schema (Full) + +try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + 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 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SourceSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-provisioning-policies-in-bulk +This end-point updates a list of provisioning policies on the specified source in IdentityNow. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id. + Body | ProvisioningPolicyDto | [**[]ProvisioningPolicyDto**](../models/provisioning-policy-dto) | True | + +### Return type +[**ProvisioningPolicyDto[]**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of the ProvisioningPolicyDto was successfully replaced. | ProvisioningPolicyDto[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ProvisioningPolicyDto = @"{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" +}"@ # ProvisioningPolicyDto[] | + + +# Bulk Update Provisioning Policies + +try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Update-ProvisioningPoliciesInBulk-SourceId $SourceId -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Update-ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $ProvisioningPolicyDto +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ProvisioningPoliciesInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-provisioning-policy +This API selectively updates an existing Provisioning Policy using a JSONPatch payload. +Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. +Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id. +Path | UsageType | [**UsageType**](../models/usage-type) | True | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the schema. + +### Return type +[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The ProvisioningPolicyDto was successfully updated. | ProvisioningPolicyDto +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. +$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | The JSONPatch payload used to update the schema. + + +# Partial update of Provisioning Policy + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + 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 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ProvisioningPolicy" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-source +Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the +[JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + +These fields are immutable, so they cannot be changed: + +* id +* type +* authoritative +* created +* modified +* connector +* connectorClass +* passwordPolicies + +Attempts to modify these fields will result in a 400 error. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Source ID. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). + +### Return type +[**Source**](../models/source) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated Source object. Any passwords will only show the the encrypted cipher-text so that they aren't decryptable in Identity Security Cloud (ISC) cloud-based services, per ISC security design. | Source +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). + + +# Update Source (Partial) + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Source-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-Source -Id $Id -JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Source" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-source-schema +Use this API to selectively update an existing Schema using a JSONPatch payload. + +The following schema fields are immutable and cannot be updated: + +- id +- name +- created +- modified + + +To switch an account attribute to a group entitlement, you need to have the following in place: + +- `isEntitlement: true` +- Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/v3/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: +```json +{ + "name": "groups", + "type": "STRING", + "schema": { + "type": "CONNECTOR_SCHEMA", + "id": "2c9180887671ff8c01767b4671fc7d60", + "name": "group" + }, + "description": "The groups, roles etc. that reference account group objects", + "isMulti": true, + "isEntitlement": true, + "isGroup": true +} +``` + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | SourceId | **String** | True | The Source id. +Path | SchemaId | **String** | True | The Schema id. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the schema. + +### Return type +[**Schema**](../models/schema) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Schema was successfully updated. | Schema +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. +$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | The JSONPatch payload used to update the schema. + + +# Update Source Schema (Partial) + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + 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 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SourceSchema" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/TaggedObjectsApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/TaggedObjectsApi.md new file mode 100644 index 000000000..572f687d1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/TaggedObjectsApi.md @@ -0,0 +1,487 @@ + +--- +id: tagged-objects +title: TaggedObjects +pagination_label: TaggedObjects +sidebar_label: TaggedObjects +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaggedObjects', 'TaggedObjects'] +slug: /tools/sdk/powershell/v3/methods/tagged-objects +tags: ['SDK', 'Software Development Kit', 'TaggedObjects', 'TaggedObjects'] +--- + +# TaggedObjects + Use this API to implement object tagging functionality. +With object tagging functionality in place, any user in an organization can use tags as a way to group objects together and find them more quickly when the user searches Identity Security Cloud. + +In Identity Security Cloud, users can search their tenants for information and add tags objects they find. +Tagging an object provides users with a way of grouping objects together and makes it easier to find these objects in the future. + +For example, if a user is searching for an entitlement that grants a risky level of access to Active Directory, it's possible that the user may have to search through hundreds of entitlements to find the correct one. +Once the user finds that entitlement, the user can add a tag to the entitlement, "AD_RISKY" to make it easier to find the entitlement again. +The user can add the same tag to multiple objects the user wants to group together for an easy future search, and the user can also do so in bulk. +When the user wants to find that tagged entitlement again, the user can search for "tags:AD_RISKY" to find all objects with that tag. + +With the API, you can tag even more different object types than you can in Identity Security Cloud (access profiles, entitlements, identities, and roles). +You can use the API to tag all these objects: + +- Access profiles + +- Applications + +- Certification campaigns + +- Entitlements + +- Identities + +- Roles + +- SOD (separation of duties) policies + +- Sources + +You can also use the API to directly find, create, and manage tagged objects without using search queries. + +There are limits to tags: + +- You can have up to 500 different tags in your tenant. + +- You can apply up to 30 tags to one object. + +- You can have up to 10,000 tag associations, pairings of 1 tag to 1 object, in your tenant. + +Because of these limits, it is recommended that you work with your governance experts and security teams to establish a list of tags that are most expressive of governance objects and access managed by Identity Security Cloud. + +These are the types of information often expressed in tags: + +- Affected departments + +- Compliance and regulatory categories + +- Remediation urgency levels + +- Risk levels + +Refer to [Tagging Items in Search](https://documentation.sailpoint.com/saas/help/search/index.html?h=tags#tagging-items-in-search) for more information about tagging objects in Identity Security Cloud. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Remove-TaggedObject**](#delete-tagged-object) | **DELETE** `/tagged-objects/{type}/{id}` | Delete Object Tags +[**Remove-TagsToManyObject**](#delete-tags-to-many-object) | **POST** `/tagged-objects/bulk-remove` | Remove Tags from Multiple Objects +[**Get-TaggedObject**](#get-tagged-object) | **GET** `/tagged-objects/{type}/{id}` | Get Tagged Object +[**Get-TaggedObjects**](#list-tagged-objects) | **GET** `/tagged-objects` | List Tagged Objects +[**Get-TaggedObjectsByType**](#list-tagged-objects-by-type) | **GET** `/tagged-objects/{type}` | List Tagged Objects by Type +[**Send-TaggedObject**](#put-tagged-object) | **PUT** `/tagged-objects/{type}/{id}` | Update Tagged Object +[**Set-TagToObject**](#set-tag-to-object) | **POST** `/tagged-objects` | Add Tag to Object +[**Set-TagsToManyObjects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag Multiple Objects + +## delete-tagged-object +Delete all tags from a tagged object. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Type | **String** | True | The type of object to delete tags from. +Path | Id | **String** | True | The ID of the object to delete tags from. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Type = "ACCESS_PROFILE" # String | The type of object to delete tags from. +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from. + +# Delete Object Tags + +try { + Remove-TaggedObject-Type $Type -Id $Id + + # Below is a request that includes all optional parameters + # Remove-TaggedObject -Type $Type -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-TaggedObject" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-tags-to-many-object +This API removes tags from multiple objects. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | BulkRemoveTaggedObject | [**BulkRemoveTaggedObject**](../models/bulk-remove-tagged-object) | True | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$BulkRemoveTaggedObject = @"{ + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "tags" : [ "BU_FINANCE", "PCI" ] +}"@ + +# Remove Tags from Multiple Objects + +try { + $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject + Remove-TagsToManyObject-BulkRemoveTaggedObject $Result + + # Below is a request that includes all optional parameters + # Remove-TagsToManyObject -BulkRemoveTaggedObject $BulkRemoveTaggedObject +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-TagsToManyObject" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-tagged-object +This gets a tagged object for the specified type. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Type | **String** | True | The type of tagged object to retrieve. +Path | Id | **String** | True | The ID of the object reference to retrieve. + +### Return type +[**TaggedObject**](../models/tagged-object) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Tagged object by type and ID. | TaggedObject +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + +# Get Tagged Object + +try { + Get-TaggedObject-Type $Type -Id $Id + + # Below is a request that includes all optional parameters + # Get-TaggedObject -Type $Type -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-TaggedObject" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-tagged-objects +This API returns a list of all tagged objects. + +Any authenticated token may be used to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* + +### Return type +[**TaggedObject[]**](../models/tagged-object) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of all tagged objects. | TaggedObject[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'tagName eq "BU_FINANCE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + +# List Tagged Objects + +try { + Get-TaggedObjects + + # Below is a request that includes all optional parameters + # Get-TaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-TaggedObjects" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-tagged-objects-by-type +This API returns a list of all tagged objects by type. + +Any authenticated token may be used to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Type | **String** | True | The type of tagged object to retrieve. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* + +### Return type +[**TaggedObject[]**](../models/tagged-object) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of all tagged objects for specified type. | TaggedObject[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'objectRef.id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + +# List Tagged Objects by Type + +try { + 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 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-TaggedObjectsByType" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-tagged-object +This updates a tagged object for the specified type. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Type | **String** | True | The type of tagged object to update. +Path | Id | **String** | True | The ID of the object reference to update. + Body | TaggedObject | [**TaggedObject**](../models/tagged-object) | True | + +### Return type +[**TaggedObject**](../models/tagged-object) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Tagged object by type and ID. | TaggedObject +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Type = "ACCESS_PROFILE" # String | The type of tagged object to update. +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to update. +$TaggedObject = @"{ + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] +}"@ + +# Update Tagged Object + +try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + 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 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TaggedObject" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-tag-to-object +This adds a tag to an object. + +Any authenticated token may be used to call this API. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | TaggedObject | [**TaggedObject**](../models/tagged-object) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Created. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$TaggedObject = @"{ + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] +}"@ + +# Add Tag to Object + +try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Set-TagToObject-TaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-TagToObject -TaggedObject $TaggedObject +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-TagToObject" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## set-tags-to-many-objects +This API adds tags to multiple objects. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | BulkAddTaggedObject | [**BulkAddTaggedObject**](../models/bulk-add-tagged-object) | True | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. + +### Return type +[**BulkTaggedObjectResponse[]**](../models/bulk-tagged-object-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Request succeeded. | BulkTaggedObjectResponse[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$BulkAddTaggedObject = @"{ + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] +}"@ + +# Tag Multiple Objects + +try { + $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject + Set-TagsToManyObjects-BulkAddTaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-TagsToManyObjects -BulkAddTaggedObject $BulkAddTaggedObject +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-TagsToManyObjects" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/TransformsApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/TransformsApi.md new file mode 100644 index 000000000..1b1318993 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/TransformsApi.md @@ -0,0 +1,298 @@ + +--- +id: transforms +title: Transforms +pagination_label: Transforms +sidebar_label: Transforms +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Transforms', 'Transforms'] +slug: /tools/sdk/powershell/v3/methods/transforms +tags: ['SDK', 'Software Development Kit', 'Transforms', 'Transforms'] +--- + +# Transforms + The purpose of this API is to expose functionality for the manipulation of Transform objects. +Transforms are a form of configurable objects which define an easy way to manipulate attribute data without having +to write code. These endpoints don't require API calls to other resources, audit service is used for keeping track +of which users have made changes to the Transforms. + +Refer to [Transforms](https://developer.sailpoint.com/docs/extensibility/transforms/) for more information about transforms. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-Transform**](#create-transform) | **POST** `/transforms` | Create transform +[**Remove-Transform**](#delete-transform) | **DELETE** `/transforms/{id}` | Delete a transform +[**Get-Transform**](#get-transform) | **GET** `/transforms/{id}` | Transform by ID +[**Get-Transforms**](#list-transforms) | **GET** `/transforms` | List transforms +[**Update-Transform**](#update-transform) | **PUT** `/transforms/{id}` | Update a transform + +## create-transform +Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | Transform | [**Transform**](../models/transform) | True | The transform to be created. + +### Return type +[**TransformRead**](../models/transform-read) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +201 | Indicates the transform was successfully created and returns its representation. | TransformRead +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Transform = @"{ + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" +}"@ + +# Create transform + +try { + $Result = ConvertFrom-JsonToTransform -Json $Transform + New-Transform-Transform $Result + + # Below is a request that includes all optional parameters + # New-Transform -Transform $Transform +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Transform" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-transform +Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the transform to delete + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete + +# Delete a transform + +try { + Remove-Transform-Id $Id + + # Below is a request that includes all optional parameters + # Remove-Transform -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Transform" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-transform +This API returns the transform specified by the given ID. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the transform to retrieve + +### Return type +[**TransformRead**](../models/transform-read) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Transform with the given ID | TransformRead +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve + +# Transform by ID + +try { + Get-Transform-Id $Id + + # Below is a request that includes all optional parameters + # Get-Transform -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Transform" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-transforms +Gets a list of all saved transform objects. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Name | **String** | (optional) | Name of the transform to retrieve from the list. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* + +### Return type +[**TransformRead[]**](../models/transform-read) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A list of transforms matching the given criteria. | TransformRead[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional) +$Filters = 'name eq "Uppercase"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) + +# List transforms + +try { + Get-Transforms + + # Below is a request that includes all optional parameters + # Get-Transforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Transforms" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## update-transform +Replaces the transform specified by the given ID with the transform provided in the request body. Only the "attributes" field is mutable. Attempting to change other properties (ex. "name" and "type") will result in an error. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the transform to update + Body | Transform | [**Transform**](../models/transform) | (optional) | The updated transform object. Must include ""name"", ""type"", and ""attributes"" fields, but ""name"" and ""type"" must not be modified. + +### Return type +[**TransformRead**](../models/transform-read) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Indicates the transform was successfully updated and returns its new representation. | TransformRead +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update +$Transform = @"{ + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" +}"@ + +# Update a transform + +try { + Update-Transform-Id $Id + + # Below is a request that includes all optional parameters + # Update-Transform -Id $Id -Transform $Transform +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Transform" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/VendorConnectorMappingsApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/VendorConnectorMappingsApi.md new file mode 100644 index 000000000..825137200 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/VendorConnectorMappingsApi.md @@ -0,0 +1,200 @@ + +--- +id: vendor-connector-mappings +title: VendorConnectorMappings +pagination_label: VendorConnectorMappings +sidebar_label: VendorConnectorMappings +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMappings', 'VendorConnectorMappings'] +slug: /tools/sdk/powershell/v3/methods/vendor-connector-mappings +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappings', 'VendorConnectorMappings'] +--- + +# VendorConnectorMappings + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**New-VendorConnectorMapping**](#create-vendor-connector-mapping) | **POST** `/vendor-connector-mappings` | Create Vendor Connector Mapping +[**Remove-VendorConnectorMapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete Vendor Connector Mapping +[**Get-VendorConnectorMappings**](#get-vendor-connector-mappings) | **GET** `/vendor-connector-mappings` | List Vendor Connector Mappings + +## create-vendor-connector-mapping +Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | VendorConnectorMapping | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | True | + +### Return type +[**VendorConnectorMapping**](../models/vendor-connector-mapping) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully created a new vendor connector mapping. | VendorConnectorMapping +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +405 | Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method. | GetVendorConnectorMappings405Response +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$VendorConnectorMapping = @"{ + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } +}"@ + +# Create Vendor Connector Mapping + +try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + New-VendorConnectorMapping-VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # New-VendorConnectorMapping -VendorConnectorMapping $VendorConnectorMapping +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-VendorConnectorMapping" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-vendor-connector-mapping +Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | VendorConnectorMapping | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | True | + +### Return type +[**DeleteVendorConnectorMapping200Response**](../models/delete-vendor-connector-mapping200-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully deleted the specified vendor connector mapping. | DeleteVendorConnectorMapping200Response +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$VendorConnectorMapping = @"{ + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } +}"@ + +# Delete Vendor Connector Mapping + +try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + Remove-VendorConnectorMapping-VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # Remove-VendorConnectorMapping -VendorConnectorMapping $VendorConnectorMapping +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-VendorConnectorMapping" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-vendor-connector-mappings +Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation. + + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**VendorConnectorMapping[]**](../models/vendor-connector-mapping) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Successfully retrieved list. | VendorConnectorMapping[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +405 | Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method. | GetVendorConnectorMappings405Response +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List Vendor Connector Mappings + +try { + Get-VendorConnectorMappings + + # Below is a request that includes all optional parameters + # Get-VendorConnectorMappings +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-VendorConnectorMappings" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/WorkItemsApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/WorkItemsApi.md new file mode 100644 index 000000000..72b4784c7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/WorkItemsApi.md @@ -0,0 +1,626 @@ + +--- +id: work-items +title: WorkItems +pagination_label: WorkItems +sidebar_label: WorkItems +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItems', 'WorkItems'] +slug: /tools/sdk/powershell/v3/methods/work-items +tags: ['SDK', 'Software Development Kit', 'WorkItems', 'WorkItems'] +--- + +# WorkItems + Use this API to implement work item functionality. +With this functionality in place, users can manage their work items (tasks). + +Work items refer to the tasks users see in Identity Security Cloud's Task Manager. +They can see the pending work items they need to complete, as well as the work items they have already completed. +Task Manager lists the work items along with the involved sources, identities, accounts, and the timestamp when the work item was created. +For example, a user may see a pending 'Create an Account' work item for the identity Fred.Astaire in GitHub for Fred's GitHub account, fred-astaire-sp. +Once the user completes the work item, the work item will be listed with his or her other completed work items. + +To complete work items, users can use their dashboards and select the 'My Tasks' widget. +The widget will list any work items they need to complete, and they can select the work item from the list to review its details. +When they complete the work item, they can select 'Mark Complete' to add it to their list of completed work items. + +Refer to [Task Manager](https://documentation.sailpoint.com/saas/user-help/task_manager.html) for more information about work items, including the different types of work items users may need to complete. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Approve-ApprovalItem**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item +[**Approve-ApprovalItemsInBulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items +[**Complete-WorkItem**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a Work Item +[**Get-CompletedWorkItems**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed Work Items +[**Get-CountCompletedWorkItems**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count Completed Work Items +[**Get-CountWorkItems**](#get-count-work-items) | **GET** `/work-items/count` | Count Work Items +[**Get-WorkItem**](#get-work-item) | **GET** `/work-items/{id}` | Get a Work Item +[**Get-WorkItemsSummary**](#get-work-items-summary) | **GET** `/work-items/summary` | Work Items Summary +[**Get-WorkItems**](#list-work-items) | **GET** `/work-items` | List Work Items +[**Deny-ApprovalItem**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item +[**Deny-ApprovalItemsInBulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items +[**Send-WorkItemForward**](#send-work-item-forward) | **POST** `/work-items/{id}/forward` | Forward a Work Item +[**Submit-AccountSelection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections + +## approve-approval-item +This API approves an Approval Item. Either an admin, or the owning/current user must make this request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the work item +Path | ApprovalItemId | **String** | True | The ID of the approval item. + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A work items details object. | WorkItems +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item +$ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + +# Approve an Approval Item + +try { + Approve-ApprovalItem-Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItem" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## approve-approval-items-in-bulk +This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the work item + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A work items details object. | WorkItems +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + +# Bulk approve Approval Items + +try { + Approve-ApprovalItemsInBulk-Id $Id + + # Below is a request that includes all optional parameters + # Approve-ApprovalItemsInBulk -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItemsInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## complete-work-item +This API completes a work item. Either an admin, or the owning/current user must make this request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the work item + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A WorkItems object | WorkItems +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + +# Complete a Work Item + +try { + Complete-WorkItem-Id $Id + + # Below is a request that includes all optional parameters + # Complete-WorkItem -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-completed-work-items +This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | OwnerId | **String** | (optional) | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**WorkItems[]**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of completed work items. | WorkItems[] +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + +# Completed Work Items + +try { + Get-CompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedWorkItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-count-completed-work-items +This gets a count of completed work items belonging to either the specified user(admin required), or the current user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | OwnerId | **String** | (optional) | ID of the work item owner. + +### Return type +[**WorkItemsCount**](../models/work-items-count) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of work items | WorkItemsCount +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + +# Count Completed Work Items + +try { + Get-CountCompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-CountCompletedWorkItems -OwnerId $OwnerId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountCompletedWorkItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-count-work-items +This gets a count of work items belonging to either the specified user(admin required), or the current user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | OwnerId | **String** | (optional) | ID of the work item owner. + +### Return type +[**WorkItemsCount**](../models/work-items-count) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of work items | WorkItemsCount +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) + +# Count Work Items + +try { + Get-CountWorkItems + + # Below is a request that includes all optional parameters + # Get-CountWorkItems -OwnerId $OwnerId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountWorkItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-work-item +This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | ID of the work item. + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The work item with the given ID. | WorkItems +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. + +# Get a Work Item + +try { + Get-WorkItem-Id $Id + + # Below is a request that includes all optional parameters + # Get-WorkItem -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItem" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-work-items-summary +This gets a summary of work items belonging to either the specified user(admin required), or the current user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | OwnerId | **String** | (optional) | ID of the work item owner. + +### Return type +[**WorkItemsSummary**](../models/work-items-summary) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of work items | WorkItemsSummary +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + +# Work Items Summary + +try { + Get-WorkItemsSummary + + # Below is a request that includes all optional parameters + # Get-WorkItemsSummary -OwnerId $OwnerId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItemsSummary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-work-items +This gets a collection of work items belonging to either the specified user(admin required), or the current user. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | OwnerId | **String** | (optional) | ID of the work item owner. + +### Return type +[**WorkItems[]**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of work items | WorkItems[] +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + +# List Work Items + +try { + Get-WorkItems + + # Below is a request that includes all optional parameters + # Get-WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItems" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## reject-approval-item +This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the work item +Path | ApprovalItemId | **String** | True | The ID of the approval item. + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A work items details object. | WorkItems +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item +$ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + +# Reject an Approval Item + +try { + Deny-ApprovalItem-Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItem" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## reject-approval-items-in-bulk +This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the work item + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A work items details object. | WorkItems +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + +# Bulk reject Approval Items + +try { + Deny-ApprovalItemsInBulk-Id $Id + + # Below is a request that includes all optional parameters + # Deny-ApprovalItemsInBulk -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItemsInBulk" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## send-work-item-forward +This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. Accessible to work-item Owner, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the work item + Body | WorkItemForward | [**WorkItemForward**](../models/work-item-forward) | True | + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Success, but no data is returned. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item +$WorkItemForward = @"{ + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true +}"@ + +# Forward a Work Item + +try { + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Send-WorkItemForward-Id $Id -WorkItemForward $Result + + # Below is a request that includes all optional parameters + # Send-WorkItemForward -Id $Id -WorkItemForward $WorkItemForward +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-WorkItemForward" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## submit-account-selection +This API submits account selections. Either an admin, or the owning/current user must make this request. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The ID of the work item + Body | RequestBody | [**map[string]AnyType**](https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4) | True | Account Selection Data map, keyed on fieldName + +### Return type +[**WorkItems**](../models/work-items) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | A work items details object. | WorkItems +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item +$RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName + +# Submit Account Selections + +try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-AccountSelection-Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Submit-AccountSelection -Id $Id -RequestBody $RequestBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-AccountSelection" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Methods/WorkflowsApi.md b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/WorkflowsApi.md new file mode 100644 index 000000000..affdf3b37 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Methods/WorkflowsApi.md @@ -0,0 +1,883 @@ + +--- +id: workflows +title: Workflows +pagination_label: Workflows +sidebar_label: Workflows +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Workflows', 'Workflows'] +slug: /tools/sdk/powershell/v3/methods/workflows +tags: ['SDK', 'Software Development Kit', 'Workflows', 'Workflows'] +--- + +# Workflows + Workflows allow administrators to create custom automation scripts directly within Identity Security Cloud. These automation scripts respond to [event triggers](https://developer.sailpoint.com/docs/extensibility/event-triggers/#how-to-get-started-with-event-triggers) and perform a series of actions to perform tasks that are either too cumbersome or not available in the Identity Security Cloud UI. Workflows can be configured via a graphical user interface within Identity Security Cloud, or by creating and uploading a JSON formatted script to the Workflow service. The Workflows API collection provides the necessary functionality to create, manage, and test your workflows via REST. + + + +All URIs are relative to *https://sailpoint.api.identitynow.com/v3* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**Suspend-WorkflowExecution**](#cancel-workflow-execution) | **POST** `/workflow-executions/{id}/cancel` | Cancel Workflow Execution by ID +[**New-ExternalExecuteWorkflow**](#create-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger +[**New-Workflow**](#create-workflow) | **POST** `/workflows` | Create Workflow +[**New-WorkflowExternalTrigger**](#create-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client +[**Remove-Workflow**](#delete-workflow) | **DELETE** `/workflows/{id}` | Delete Workflow By Id +[**Get-Workflow**](#get-workflow) | **GET** `/workflows/{id}` | Get Workflow By Id +[**Get-WorkflowExecution**](#get-workflow-execution) | **GET** `/workflow-executions/{id}` | Get Workflow Execution +[**Get-WorkflowExecutionHistory**](#get-workflow-execution-history) | **GET** `/workflow-executions/{id}/history` | Get Workflow Execution History +[**Get-WorkflowExecutions**](#get-workflow-executions) | **GET** `/workflows/{id}/executions` | List Workflow Executions +[**Get-CompleteWorkflowLibrary**](#list-complete-workflow-library) | **GET** `/workflow-library` | List Complete Workflow Library +[**Get-WorkflowLibraryActions**](#list-workflow-library-actions) | **GET** `/workflow-library/actions` | List Workflow Library Actions +[**Get-WorkflowLibraryOperators**](#list-workflow-library-operators) | **GET** `/workflow-library/operators` | List Workflow Library Operators +[**Get-WorkflowLibraryTriggers**](#list-workflow-library-triggers) | **GET** `/workflow-library/triggers` | List Workflow Library Triggers +[**Get-Workflows**](#list-workflows) | **GET** `/workflows` | List Workflows +[**Update-Workflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch Workflow +[**Send-Workflow**](#put-workflow) | **PUT** `/workflows/{id}` | Update Workflow +[**Test-ExternalExecuteWorkflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger +[**Test-Workflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id + +## cancel-workflow-execution +Use this API to cancel a running workflow execution. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | The workflow execution ID + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + +# Cancel Workflow Execution by ID + +try { + Suspend-WorkflowExecution-Id $Id + + # Below is a request that includes all optional parameters + # Suspend-WorkflowExecution -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-WorkflowExecution" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-external-execute-workflow +This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the workflow + Body | CreateExternalExecuteWorkflowRequest | [**CreateExternalExecuteWorkflowRequest**](../models/create-external-execute-workflow-request) | (optional) | + +### Return type +[**CreateExternalExecuteWorkflow200Response**](../models/create-external-execute-workflow200-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Workflow object | CreateExternalExecuteWorkflow200Response +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow +$CreateExternalExecuteWorkflowRequest = @""@ + +# Execute Workflow via External Trigger + +try { + New-ExternalExecuteWorkflow-Id $Id + + # Below is a request that includes all optional parameters + # New-ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $CreateExternalExecuteWorkflowRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-workflow +Create a new workflow with the desired trigger and steps specified in the request body. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | CreateWorkflowRequest | [**CreateWorkflowRequest**](../models/create-workflow-request) | True | + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Workflow object | Workflow +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$CreateWorkflowRequest = @"{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}"@ + +# Create Workflow + +try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-Workflow-CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-Workflow -CreateWorkflowRequest $CreateWorkflowRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Workflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## create-workflow-external-trigger +Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the workflow + +### Return type +[**WorkflowOAuthClient**](../models/workflow-o-auth-client) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The OAuth Client object | WorkflowOAuthClient +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + +# Generate External Trigger OAuth Client + +try { + New-WorkflowExternalTrigger-Id $Id + + # Below is a request that includes all optional parameters + # New-WorkflowExternalTrigger -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-WorkflowExternalTrigger" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## delete-workflow +Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the Workflow + +### Return type + (empty response body) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +204 | No content - indicates the request was successful but there is no content to be returned in the response. | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + +# Delete Workflow By Id + +try { + Remove-Workflow-Id $Id + + # Below is a request that includes all optional parameters + # Remove-Workflow -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Workflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-workflow +Get a single workflow by id. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the workflow + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The workflow object | Workflow +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + +# Get Workflow By Id + +try { + Get-Workflow-Id $Id + + # Below is a request that includes all optional parameters + # Get-Workflow -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-workflow-execution +Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Workflow execution ID. + +### Return type +[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Workflow execution. | SystemCollectionsHashtable +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + +# Get Workflow Execution + +try { + Get-WorkflowExecution-Id $Id + + # Below is a request that includes all optional parameters + # Get-WorkflowExecution -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecution" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-workflow-execution-history +Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the workflow execution + +### Return type +[**WorkflowExecutionEvent[]**](../models/workflow-execution-event) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of workflow execution events for the given workflow execution | WorkflowExecutionEvent[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + +# Get Workflow Execution History + +try { + Get-WorkflowExecutionHistory-Id $Id + + # Below is a request that includes all optional parameters + # Get-WorkflowExecutionHistory -Id $Id +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutionHistory" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## get-workflow-executions +Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: +1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. +2. Get your workflow ID from the response. +3. You can then do either of the following: + + - Filter to find relevant workflow executions. + For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq "Failed"` + + - Paginate through results with the `offset` parameter. + For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. + Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Workflow ID. + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* + +### Return type +[**WorkflowExecution[]**](../models/workflow-execution) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of workflow executions for the specified workflow. | WorkflowExecution[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$Filters = 'status eq "Failed"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + +# List Workflow Executions + +try { + 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 +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-complete-workflow-library +This lists all triggers, actions, and operators in the library + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + +### Return type +[**ListCompleteWorkflowLibrary200ResponseInner[]**](../models/list-complete-workflow-library200-response-inner) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of workflow steps | ListCompleteWorkflowLibrary200ResponseInner[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + +# List Complete Workflow Library + +try { + Get-CompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-CompleteWorkflowLibrary -Limit $Limit -Offset $Offset +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompleteWorkflowLibrary" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-workflow-library-actions +This lists the workflow actions available to you. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* + +### Return type +[**WorkflowLibraryAction[]**](../models/workflow-library-action) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of workflow actions | WorkflowLibraryAction[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Filters = 'id eq "sp:create-campaign"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + +# List Workflow Library Actions + +try { + Get-WorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryActions" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-workflow-library-operators +This lists the workflow operators available to you + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**WorkflowLibraryOperator[]**](../models/workflow-library-operator) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of workflow operators | WorkflowLibraryOperator[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List Workflow Library Operators + +try { + Get-WorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-WorkflowLibraryOperators +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryOperators" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-workflow-library-triggers +This lists the workflow triggers available to you + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* + +### Return type +[**WorkflowLibraryTrigger[]**](../models/workflow-library-trigger) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of workflow triggers | WorkflowLibraryTrigger[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$Filters = 'id eq "idn:identity-attributes-changed"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + +# List Workflow Library Triggers + +try { + Get-WorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryTriggers" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## list-workflows +List all workflows in the tenant. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**Workflow[]**](../models/workflow) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | List of workflows | Workflow[] +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# List Workflows + +try { + Get-Workflows + + # Below is a request that includes all optional parameters + # Get-Workflows +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflows" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## patch-workflow +Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the Workflow + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Workflow object | Workflow +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | + + +# Patch Workflow + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Workflow-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-Workflow -Id $Id -JsonPatchOperation $JsonPatchOperation +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Workflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## put-workflow +Perform a full update of a workflow. The updated workflow object is returned in the response. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the Workflow + Body | WorkflowBody | [**WorkflowBody**](../models/workflow-body) | True | + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Workflow object | Workflow +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow +$WorkflowBody = @"{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false +}"@ + +# Update Workflow + +try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-Workflow-Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-Workflow -Id $Id -WorkflowBody $WorkflowBody +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Workflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## test-external-execute-workflow +Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the workflow + Body | TestExternalExecuteWorkflowRequest | [**TestExternalExecuteWorkflowRequest**](../models/test-external-execute-workflow-request) | (optional) | + +### Return type +[**TestExternalExecuteWorkflow200Response**](../models/test-external-execute-workflow200-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Responds with the test input | TestExternalExecuteWorkflow200Response +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow +$TestExternalExecuteWorkflowRequest = @""@ + +# Test Workflow via External Trigger + +try { + Test-ExternalExecuteWorkflow-Id $Id + + # Below is a request that includes all optional parameters + # Test-ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $TestExternalExecuteWorkflowRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) +## test-workflow +Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow. +This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. +**This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the workflow + Body | TestWorkflowRequest | [**TestWorkflowRequest**](../models/test-workflow-request) | True | + +### Return type +[**TestWorkflow200Response**](../models/test-workflow200-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Workflow object | TestWorkflow200Response +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow +$TestWorkflowRequest = @"{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}"@ + +# Test Workflow By Id + +try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-Workflow-Id $Id -TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-Workflow -Id $Id -TestWorkflowRequest $TestWorkflowRequest +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-Workflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Access.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Access.md new file mode 100644 index 000000000..7f53b2a9f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Access.md @@ -0,0 +1,43 @@ +--- +id: access +title: Access +pagination_label: Access +sidebar_label: Access +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Access', 'Access'] +slug: /tools/sdk/powershell/v3/models/access +tags: ['SDK', 'Software Development Kit', 'Access', 'Access'] +--- + + +# Access + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$Access = Initialize-PSSailpoint.V3Access -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -DisplayName John Q. Doe ` + -Type null ` + -Description null +``` + +- Convert the resource to JSON +```powershell +$Access | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessConstraint.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessConstraint.md new file mode 100644 index 000000000..d13dc713f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessConstraint.md @@ -0,0 +1,39 @@ +--- +id: access-constraint +title: AccessConstraint +pagination_label: AccessConstraint +sidebar_label: AccessConstraint +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessConstraint', 'AccessConstraint'] +slug: /tools/sdk/powershell/v3/models/access-constraint +tags: ['SDK', 'Software Development Kit', 'AccessConstraint', 'AccessConstraint'] +--- + + +# AccessConstraint + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessConstraint = Initialize-PSSailpoint.V3AccessConstraint -Type ENTITLEMENT ` + -Ids [2c90ad2a70ace7d50170acf22ca90010] ` + -Operator SELECTED +``` + +- Convert the resource to JSON +```powershell +$AccessConstraint | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessCriteria.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessCriteria.md new file mode 100644 index 000000000..26d50da6d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessCriteria.md @@ -0,0 +1,37 @@ +--- +id: access-criteria +title: AccessCriteria +pagination_label: AccessCriteria +sidebar_label: AccessCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessCriteria', 'AccessCriteria'] +slug: /tools/sdk/powershell/v3/models/access-criteria +tags: ['SDK', 'Software Development Kit', 'AccessCriteria', 'AccessCriteria'] +--- + + +# AccessCriteria + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessCriteria = Initialize-PSSailpoint.V3AccessCriteria -Name money-in ` + -CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}] +``` + +- Convert the resource to JSON +```powershell +$AccessCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessCriteriaCriteriaListInner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessCriteriaCriteriaListInner.md new file mode 100644 index 000000000..83705e9a3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessCriteriaCriteriaListInner.md @@ -0,0 +1,39 @@ +--- +id: access-criteria-criteria-list-inner +title: AccessCriteriaCriteriaListInner +pagination_label: AccessCriteriaCriteriaListInner +sidebar_label: AccessCriteriaCriteriaListInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessCriteriaCriteriaListInner', 'AccessCriteriaCriteriaListInner'] +slug: /tools/sdk/powershell/v3/models/access-criteria-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'AccessCriteriaCriteriaListInner', 'AccessCriteriaCriteriaListInner'] +--- + + +# AccessCriteriaCriteriaListInner + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessCriteriaCriteriaListInner = Initialize-PSSailpoint.V3AccessCriteriaCriteriaListInner -Type ENTITLEMENT ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name Administrator +``` + +- Convert the resource to JSON +```powershell +$AccessCriteriaCriteriaListInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessItemRequestedFor.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessItemRequestedFor.md new file mode 100644 index 000000000..1c4780e7f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessItemRequestedFor.md @@ -0,0 +1,39 @@ +--- +id: access-item-requested-for +title: AccessItemRequestedFor +pagination_label: AccessItemRequestedFor +sidebar_label: AccessItemRequestedFor +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRequestedFor', 'AccessItemRequestedFor'] +slug: /tools/sdk/powershell/v3/models/access-item-requested-for +tags: ['SDK', 'Software Development Kit', 'AccessItemRequestedFor', 'AccessItemRequestedFor'] +--- + + +# AccessItemRequestedFor + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessItemRequestedFor = Initialize-PSSailpoint.V3AccessItemRequestedFor -Type IDENTITY ` + -Id 2c4180a46faadee4016fb4e018c20626 ` + -Name Robert Robinson +``` + +- Convert the resource to JSON +```powershell +$AccessItemRequestedFor | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessItemRequester.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessItemRequester.md new file mode 100644 index 000000000..711077fa9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessItemRequester.md @@ -0,0 +1,39 @@ +--- +id: access-item-requester +title: AccessItemRequester +pagination_label: AccessItemRequester +sidebar_label: AccessItemRequester +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRequester', 'AccessItemRequester'] +slug: /tools/sdk/powershell/v3/models/access-item-requester +tags: ['SDK', 'Software Development Kit', 'AccessItemRequester', 'AccessItemRequester'] +--- + + +# AccessItemRequester + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessItemRequester = Initialize-PSSailpoint.V3AccessItemRequester -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20648 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$AccessItemRequester | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessItemReviewedBy.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessItemReviewedBy.md new file mode 100644 index 000000000..91a1d5606 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessItemReviewedBy.md @@ -0,0 +1,39 @@ +--- +id: access-item-reviewed-by +title: AccessItemReviewedBy +pagination_label: AccessItemReviewedBy +sidebar_label: AccessItemReviewedBy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemReviewedBy', 'AccessItemReviewedBy'] +slug: /tools/sdk/powershell/v3/models/access-item-reviewed-by +tags: ['SDK', 'Software Development Kit', 'AccessItemReviewedBy', 'AccessItemReviewedBy'] +--- + + +# AccessItemReviewedBy + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessItemReviewedBy = Initialize-PSSailpoint.V3AccessItemReviewedBy -Type IDENTITY ` + -Id 2c3780a46faadee4016fb4e018c20652 ` + -Name Allen Albertson +``` + +- Convert the resource to JSON +```powershell +$AccessItemReviewedBy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfile.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfile.md new file mode 100644 index 000000000..4a40825ad --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfile.md @@ -0,0 +1,61 @@ +--- +id: access-profile +title: AccessProfile +pagination_label: AccessProfile +sidebar_label: AccessProfile +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfile', 'AccessProfile'] +slug: /tools/sdk/powershell/v3/models/access-profile +tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'AccessProfile'] +--- + + +# AccessProfile + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfile = Initialize-PSSailpoint.V3AccessProfile -Id 2c91808a7190d06e01719938fcd20792 ` + -Name Employee-database-read-write ` + -Description Collection of entitlements to read/write the employee database ` + -Created 2021-03-01T22:32:58.104Z ` + -Modified 2021-03-02T20:22:28.104Z ` + -Enabled true ` + -Owner null ` + -Source null ` + -Entitlements null ` + -Requestable true ` + -AccessRequestConfig null ` + -RevocationRequestConfig null ` + -Segments [f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a] ` + -ProvisioningCriteria null +``` + +- Convert the resource to JSON +```powershell +$AccessProfile | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileApprovalScheme.md new file mode 100644 index 000000000..9233420a2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileApprovalScheme.md @@ -0,0 +1,37 @@ +--- +id: access-profile-approval-scheme +title: AccessProfileApprovalScheme +pagination_label: AccessProfileApprovalScheme +sidebar_label: AccessProfileApprovalScheme +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileApprovalScheme', 'AccessProfileApprovalScheme'] +slug: /tools/sdk/powershell/v3/models/access-profile-approval-scheme +tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'AccessProfileApprovalScheme'] +--- + + +# AccessProfileApprovalScheme + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileApprovalScheme = Initialize-PSSailpoint.V3AccessProfileApprovalScheme -ApproverType GOVERNANCE_GROUP ` + -ApproverId 46c79819-a69f-49a2-becb-12c971ae66c6 +``` + +- Convert the resource to JSON +```powershell +$AccessProfileApprovalScheme | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileBulkDeleteRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileBulkDeleteRequest.md new file mode 100644 index 000000000..4eee904c6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileBulkDeleteRequest.md @@ -0,0 +1,37 @@ +--- +id: access-profile-bulk-delete-request +title: AccessProfileBulkDeleteRequest +pagination_label: AccessProfileBulkDeleteRequest +sidebar_label: AccessProfileBulkDeleteRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileBulkDeleteRequest', 'AccessProfileBulkDeleteRequest'] +slug: /tools/sdk/powershell/v3/models/access-profile-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteRequest', 'AccessProfileBulkDeleteRequest'] +--- + + +# AccessProfileBulkDeleteRequest + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileBulkDeleteRequest = Initialize-PSSailpoint.V3AccessProfileBulkDeleteRequest -AccessProfileIds [2c9180847812e0b1017817051919ecca, 2c9180887812e0b201781e129f151816] ` + -BestEffortOnly true +``` + +- Convert the resource to JSON +```powershell +$AccessProfileBulkDeleteRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileBulkDeleteResponse.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileBulkDeleteResponse.md new file mode 100644 index 000000000..21e7601b1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileBulkDeleteResponse.md @@ -0,0 +1,39 @@ +--- +id: access-profile-bulk-delete-response +title: AccessProfileBulkDeleteResponse +pagination_label: AccessProfileBulkDeleteResponse +sidebar_label: AccessProfileBulkDeleteResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileBulkDeleteResponse', 'AccessProfileBulkDeleteResponse'] +slug: /tools/sdk/powershell/v3/models/access-profile-bulk-delete-response +tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteResponse', 'AccessProfileBulkDeleteResponse'] +--- + + +# AccessProfileBulkDeleteResponse + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileBulkDeleteResponse = Initialize-PSSailpoint.V3AccessProfileBulkDeleteResponse -TaskId 2c9180867817ac4d017817c491119a20 ` + -Pending [2c91808876438bbb017668c21919ecca, 2c91808876438bb201766e129f151816] ` + -InUse null +``` + +- Convert the resource to JSON +```powershell +$AccessProfileBulkDeleteResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileDocument.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileDocument.md new file mode 100644 index 000000000..07335117c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileDocument.md @@ -0,0 +1,63 @@ +--- +id: access-profile-document +title: AccessProfileDocument +pagination_label: AccessProfileDocument +sidebar_label: AccessProfileDocument +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileDocument', 'AccessProfileDocument'] +slug: /tools/sdk/powershell/v3/models/access-profile-document +tags: ['SDK', 'Software Development Kit', 'AccessProfileDocument', 'AccessProfileDocument'] +--- + + +# AccessProfileDocument + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileDocument = Initialize-PSSailpoint.V3AccessProfileDocument -Id 2c9180825a6c1adc015a71c9023f0818 ` + -Name Cloud Eng ` + -Description The admin role ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Synced 2018-06-25T20:22:33.104Z ` + -Enabled true ` + -Requestable true ` + -RequestCommentsRequired false ` + -Owner null ` + -Type accessprofile ` + -Source null ` + -Entitlements null ` + -EntitlementCount 5 ` + -Tags [TAG_1, TAG_2] +``` + +- Convert the resource to JSON +```powershell +$AccessProfileDocument | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileDocumentAllOfSource.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileDocumentAllOfSource.md new file mode 100644 index 000000000..eb240bcea --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileDocumentAllOfSource.md @@ -0,0 +1,37 @@ +--- +id: access-profile-document-all-of-source +title: AccessProfileDocumentAllOfSource +pagination_label: AccessProfileDocumentAllOfSource +sidebar_label: AccessProfileDocumentAllOfSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileDocumentAllOfSource', 'AccessProfileDocumentAllOfSource'] +slug: /tools/sdk/powershell/v3/models/access-profile-document-all-of-source +tags: ['SDK', 'Software Development Kit', 'AccessProfileDocumentAllOfSource', 'AccessProfileDocumentAllOfSource'] +--- + + +# AccessProfileDocumentAllOfSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Source's ID. | [optional] +**Name** | Pointer to **String** | Source's name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileDocumentAllOfSource = Initialize-PSSailpoint.V3AccessProfileDocumentAllOfSource -Id ff8081815757d4fb0157588f3d9d008f ` + -Name Employees +``` + +- Convert the resource to JSON +```powershell +$AccessProfileDocumentAllOfSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileEntitlement.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileEntitlement.md new file mode 100644 index 000000000..bb647245a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileEntitlement.md @@ -0,0 +1,53 @@ +--- +id: access-profile-entitlement +title: AccessProfileEntitlement +pagination_label: AccessProfileEntitlement +sidebar_label: AccessProfileEntitlement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileEntitlement', 'AccessProfileEntitlement'] +slug: /tools/sdk/powershell/v3/models/access-profile-entitlement +tags: ['SDK', 'Software Development Kit', 'AccessProfileEntitlement', 'AccessProfileEntitlement'] +--- + + +# AccessProfileEntitlement + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileEntitlement = Initialize-PSSailpoint.V3AccessProfileEntitlement -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -DisplayName John Q. Doe ` + -Type null ` + -Description null ` + -Source null ` + -Privileged false ` + -Attribute memberOf ` + -Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com ` + -Standalone false +``` + +- Convert the resource to JSON +```powershell +$AccessProfileEntitlement | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileRef.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileRef.md new file mode 100644 index 000000000..fbb75caa4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileRef.md @@ -0,0 +1,39 @@ +--- +id: access-profile-ref +title: AccessProfileRef +pagination_label: AccessProfileRef +sidebar_label: AccessProfileRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileRef', 'AccessProfileRef'] +slug: /tools/sdk/powershell/v3/models/access-profile-ref +tags: ['SDK', 'Software Development Kit', 'AccessProfileRef', 'AccessProfileRef'] +--- + + +# AccessProfileRef + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileRef = Initialize-PSSailpoint.V3AccessProfileRef -Id ff808081751e6e129f1518161919ecca ` + -Type ACCESS_PROFILE ` + -Name Access Profile 2567 +``` + +- Convert the resource to JSON +```powershell +$AccessProfileRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileRole.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileRole.md new file mode 100644 index 000000000..23b3f99f2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileRole.md @@ -0,0 +1,49 @@ +--- +id: access-profile-role +title: AccessProfileRole +pagination_label: AccessProfileRole +sidebar_label: AccessProfileRole +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileRole', 'AccessProfileRole'] +slug: /tools/sdk/powershell/v3/models/access-profile-role +tags: ['SDK', 'Software Development Kit', 'AccessProfileRole', 'AccessProfileRole'] +--- + + +# AccessProfileRole + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileRole = Initialize-PSSailpoint.V3AccessProfileRole -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -DisplayName John Q. Doe ` + -Type null ` + -Description null ` + -Owner null ` + -Disabled null ` + -Revocable null +``` + +- Convert the resource to JSON +```powershell +$AccessProfileRole | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileSourceRef.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileSourceRef.md new file mode 100644 index 000000000..610f971d9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileSourceRef.md @@ -0,0 +1,39 @@ +--- +id: access-profile-source-ref +title: AccessProfileSourceRef +pagination_label: AccessProfileSourceRef +sidebar_label: AccessProfileSourceRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileSourceRef', 'AccessProfileSourceRef'] +slug: /tools/sdk/powershell/v3/models/access-profile-source-ref +tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'AccessProfileSourceRef'] +--- + + +# AccessProfileSourceRef + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileSourceRef = Initialize-PSSailpoint.V3AccessProfileSourceRef -Id 2c91809773dee3610173fdb0b6061ef4 ` + -Type SOURCE ` + -Name ODS-AD-SOURCE +``` + +- Convert the resource to JSON +```powershell +$AccessProfileSourceRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileSummary.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileSummary.md new file mode 100644 index 000000000..4580f8a39 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileSummary.md @@ -0,0 +1,49 @@ +--- +id: access-profile-summary +title: AccessProfileSummary +pagination_label: AccessProfileSummary +sidebar_label: AccessProfileSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileSummary', 'AccessProfileSummary'] +slug: /tools/sdk/powershell/v3/models/access-profile-summary +tags: ['SDK', 'Software Development Kit', 'AccessProfileSummary', 'AccessProfileSummary'] +--- + + +# AccessProfileSummary + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileSummary = Initialize-PSSailpoint.V3AccessProfileSummary -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -DisplayName John Q. Doe ` + -Type null ` + -Description null ` + -Source null ` + -Owner null ` + -Revocable true +``` + +- Convert the resource to JSON +```powershell +$AccessProfileSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileUsage.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileUsage.md new file mode 100644 index 000000000..ea6cf2548 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileUsage.md @@ -0,0 +1,37 @@ +--- +id: access-profile-usage +title: AccessProfileUsage +pagination_label: AccessProfileUsage +sidebar_label: AccessProfileUsage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileUsage', 'AccessProfileUsage'] +slug: /tools/sdk/powershell/v3/models/access-profile-usage +tags: ['SDK', 'Software Development Kit', 'AccessProfileUsage', 'AccessProfileUsage'] +--- + + +# AccessProfileUsage + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileUsage = Initialize-PSSailpoint.V3AccessProfileUsage -AccessProfileId 2c91808876438bbb017668c21919ecca ` + -UsedBy null +``` + +- Convert the resource to JSON +```powershell +$AccessProfileUsage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileUsageUsedByInner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileUsageUsedByInner.md new file mode 100644 index 000000000..f7ceb88ca --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessProfileUsageUsedByInner.md @@ -0,0 +1,39 @@ +--- +id: access-profile-usage-used-by-inner +title: AccessProfileUsageUsedByInner +pagination_label: AccessProfileUsageUsedByInner +sidebar_label: AccessProfileUsageUsedByInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileUsageUsedByInner', 'AccessProfileUsageUsedByInner'] +slug: /tools/sdk/powershell/v3/models/access-profile-usage-used-by-inner +tags: ['SDK', 'Software Development Kit', 'AccessProfileUsageUsedByInner', 'AccessProfileUsageUsedByInner'] +--- + + +# AccessProfileUsageUsedByInner + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessProfileUsageUsedByInner = Initialize-PSSailpoint.V3AccessProfileUsageUsedByInner -Type ROLE ` + -Id 2c8180857a9b3da0017aa03418480f9d ` + -Name Manager Role +``` + +- Convert the resource to JSON +```powershell +$AccessProfileUsageUsedByInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessRequest.md new file mode 100644 index 000000000..a06fa645d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessRequest.md @@ -0,0 +1,41 @@ +--- +id: access-request +title: AccessRequest +pagination_label: AccessRequest +sidebar_label: AccessRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequest', 'AccessRequest'] +slug: /tools/sdk/powershell/v3/models/access-request +tags: ['SDK', 'Software Development Kit', 'AccessRequest', 'AccessRequest'] +--- + + +# AccessRequest + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessRequest = Initialize-PSSailpoint.V3AccessRequest -RequestedFor null ` + -RequestType null ` + -RequestedItems null ` + -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} +``` + +- Convert the resource to JSON +```powershell +$AccessRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessRequestConfig.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessRequestConfig.md new file mode 100644 index 000000000..9b33f2181 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessRequestConfig.md @@ -0,0 +1,45 @@ +--- +id: access-request-config +title: AccessRequestConfig +pagination_label: AccessRequestConfig +sidebar_label: AccessRequestConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestConfig', 'AccessRequestConfig'] +slug: /tools/sdk/powershell/v3/models/access-request-config +tags: ['SDK', 'Software Development Kit', 'AccessRequestConfig', 'AccessRequestConfig'] +--- + + +# AccessRequestConfig + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestConfig = Initialize-PSSailpoint.V3AccessRequestConfig -ApprovalsMustBeExternal true ` + -AutoApprovalEnabled true ` + -ReauthorizationEnabled true ` + -RequestOnBehalfOfConfig null ` + -ApprovalReminderAndEscalationConfig null ` + -EntitlementRequestConfig null +``` + +- Convert the resource to JSON +```powershell +$AccessRequestConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessRequestItem.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessRequestItem.md new file mode 100644 index 000000000..423317111 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessRequestItem.md @@ -0,0 +1,43 @@ +--- +id: access-request-item +title: AccessRequestItem +pagination_label: AccessRequestItem +sidebar_label: AccessRequestItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestItem', 'AccessRequestItem'] +slug: /tools/sdk/powershell/v3/models/access-request-item +tags: ['SDK', 'Software Development Kit', 'AccessRequestItem', 'AccessRequestItem'] +--- + + +# AccessRequestItem + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestItem = Initialize-PSSailpoint.V3AccessRequestItem -Type ACCESS_PROFILE ` + -Id 2c9180835d2e5168015d32f890ca1581 ` + -Comment Requesting access profile for John Doe ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -RemoveDate 2020-07-11T21:23:15Z +``` + +- Convert the resource to JSON +```powershell +$AccessRequestItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessRequestPhases.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessRequestPhases.md new file mode 100644 index 000000000..df53138ec --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessRequestPhases.md @@ -0,0 +1,45 @@ +--- +id: access-request-phases +title: AccessRequestPhases +pagination_label: AccessRequestPhases +sidebar_label: AccessRequestPhases +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPhases', 'AccessRequestPhases'] +slug: /tools/sdk/powershell/v3/models/access-request-phases +tags: ['SDK', 'Software Development Kit', 'AccessRequestPhases', 'AccessRequestPhases'] +--- + + +# AccessRequestPhases + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestPhases = Initialize-PSSailpoint.V3AccessRequestPhases -Started 2020-07-11T00:00Z ` + -Finished 2020-07-12T00:00Z ` + -Name APPROVAL_PHASE ` + -State COMPLETED ` + -Result SUCCESSFUL ` + -PhaseReference approvalDetails +``` + +- Convert the resource to JSON +```powershell +$AccessRequestPhases | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessRequestResponse.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessRequestResponse.md new file mode 100644 index 000000000..38f48f09a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessRequestResponse.md @@ -0,0 +1,37 @@ +--- +id: access-request-response +title: AccessRequestResponse +pagination_label: AccessRequestResponse +sidebar_label: AccessRequestResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestResponse', 'AccessRequestResponse'] +slug: /tools/sdk/powershell/v3/models/access-request-response +tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse', 'AccessRequestResponse'] +--- + + +# AccessRequestResponse + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestResponse = Initialize-PSSailpoint.V3AccessRequestResponse -NewRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ENTITLEMENT, id=779c6fd7171540bba1184e5946112c28}], attributesHash=-1928438224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdb]}] ` + -ExistingRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ROLE, id=779c6fd7171540bbc1184e5946112c28}], attributesHash=2843118224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdc]}] +``` + +- Convert the resource to JSON +```powershell +$AccessRequestResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessRequestTracking.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessRequestTracking.md new file mode 100644 index 000000000..754c0e8de --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessRequestTracking.md @@ -0,0 +1,44 @@ +--- +id: access-request-tracking +title: AccessRequestTracking +pagination_label: AccessRequestTracking +sidebar_label: AccessRequestTracking +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestTracking', 'AccessRequestTracking'] +slug: /tools/sdk/powershell/v3/models/access-request-tracking +tags: ['SDK', 'Software Development Kit', 'AccessRequestTracking', 'AccessRequestTracking'] +--- + + +# AccessRequestTracking + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestTracking = Initialize-PSSailpoint.V3AccessRequestTracking -RequestedFor 2c918084660f45d6016617daa9210584 ` + -RequestedItemsDetails { +"type": "ENTITLEMENT", +"id": "779c6fd7171540bba1184e5946112c28" + } ` + -AttributesHash -1928438224 ` + -AccessRequestIds [5d3118c518a44ec7805450d53479ccdb] +``` + +- Convert the resource to JSON +```powershell +$AccessRequestTracking | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessRequestType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessRequestType.md new file mode 100644 index 000000000..a1b1e47fa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessRequestType.md @@ -0,0 +1,24 @@ +--- +id: access-request-type +title: AccessRequestType +pagination_label: AccessRequestType +sidebar_label: AccessRequestType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestType', 'AccessRequestType'] +slug: /tools/sdk/powershell/v3/models/access-request-type +tags: ['SDK', 'Software Development Kit', 'AccessRequestType', 'AccessRequestType'] +--- + + +# AccessRequestType + +## Enum + + +* `GRANT_ACCESS` (value: `"GRANT_ACCESS"`) + +* `REVOKE_ACCESS` (value: `"REVOKE_ACCESS"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessReviewItem.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessReviewItem.md new file mode 100644 index 000000000..2f5571cf0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessReviewItem.md @@ -0,0 +1,47 @@ +--- +id: access-review-item +title: AccessReviewItem +pagination_label: AccessReviewItem +sidebar_label: AccessReviewItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessReviewItem', 'AccessReviewItem'] +slug: /tools/sdk/powershell/v3/models/access-review-item +tags: ['SDK', 'Software Development Kit', 'AccessReviewItem', 'AccessReviewItem'] +--- + + +# AccessReviewItem + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessReviewItem = Initialize-PSSailpoint.V3AccessReviewItem -AccessSummary null ` + -IdentitySummary null ` + -Id ef38f94347e94562b5bb8424a56397d8 ` + -Completed false ` + -NewAccess false ` + -Decision null ` + -Comments This user still needs access to this source +``` + +- Convert the resource to JSON +```powershell +$AccessReviewItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessReviewReassignment.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessReviewReassignment.md new file mode 100644 index 000000000..7ca5f5663 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessReviewReassignment.md @@ -0,0 +1,39 @@ +--- +id: access-review-reassignment +title: AccessReviewReassignment +pagination_label: AccessReviewReassignment +sidebar_label: AccessReviewReassignment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessReviewReassignment', 'AccessReviewReassignment'] +slug: /tools/sdk/powershell/v3/models/access-review-reassignment +tags: ['SDK', 'Software Development Kit', 'AccessReviewReassignment', 'AccessReviewReassignment'] +--- + + +# AccessReviewReassignment + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessReviewReassignment = Initialize-PSSailpoint.V3AccessReviewReassignment -Reassign null ` + -ReassignTo ef38f94347e94562b5bb8424a56397d8 ` + -Reason reassigned for some reason +``` + +- Convert the resource to JSON +```powershell +$AccessReviewReassignment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessSummary.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessSummary.md new file mode 100644 index 000000000..9fb8acc7a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessSummary.md @@ -0,0 +1,41 @@ +--- +id: access-summary +title: AccessSummary +pagination_label: AccessSummary +sidebar_label: AccessSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessSummary', 'AccessSummary'] +slug: /tools/sdk/powershell/v3/models/access-summary +tags: ['SDK', 'Software Development Kit', 'AccessSummary', 'AccessSummary'] +--- + + +# AccessSummary + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessSummary = Initialize-PSSailpoint.V3AccessSummary -Access null ` + -Entitlement null ` + -AccessProfile null ` + -Role null +``` + +- Convert the resource to JSON +```powershell +$AccessSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessSummaryAccess.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessSummaryAccess.md new file mode 100644 index 000000000..be9454efd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessSummaryAccess.md @@ -0,0 +1,39 @@ +--- +id: access-summary-access +title: AccessSummaryAccess +pagination_label: AccessSummaryAccess +sidebar_label: AccessSummaryAccess +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessSummaryAccess', 'AccessSummaryAccess'] +slug: /tools/sdk/powershell/v3/models/access-summary-access +tags: ['SDK', 'Software Development Kit', 'AccessSummaryAccess', 'AccessSummaryAccess'] +--- + + +# AccessSummaryAccess + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccessSummaryAccess = Initialize-PSSailpoint.V3AccessSummaryAccess -Type null ` + -Id 2c9180867160846801719932c5153fb7 ` + -Name Entitlement for Company Database +``` + +- Convert the resource to JSON +```powershell +$AccessSummaryAccess | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessType.md new file mode 100644 index 000000000..35640cfa0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccessType.md @@ -0,0 +1,24 @@ +--- +id: access-type +title: AccessType +pagination_label: AccessType +sidebar_label: AccessType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessType', 'AccessType'] +slug: /tools/sdk/powershell/v3/models/access-type +tags: ['SDK', 'Software Development Kit', 'AccessType', 'AccessType'] +--- + + +# AccessType + +## Enum + + +* `ONLINE` (value: `"ONLINE"`) + +* `OFFLINE` (value: `"OFFLINE"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Account.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Account.md new file mode 100644 index 000000000..b9f7d8bf9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Account.md @@ -0,0 +1,89 @@ +--- +id: account +title: Account +pagination_label: Account +sidebar_label: Account +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Account', 'Account'] +slug: /tools/sdk/powershell/v3/models/account +tags: ['SDK', 'Software Development Kit', 'Account', 'Account'] +--- + + +# Account + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$Account = Initialize-PSSailpoint.V3Account -Id id12345 ` + -Name aName ` + -Created 2015-05-28T14:07:17Z ` + -Modified 2015-05-28T14:07:17Z ` + -SourceId 2c9180835d2e5168015d32f890ca1581 ` + -SourceName Employees ` + -IdentityId 2c9180835d2e5168015d32f890ca1581 ` + -CloudLifecycleState active ` + -IdentityState ACTIVE ` + -ConnectionType direct ` + -IsMachine true ` + -Recommendation null ` + -Attributes {firstName=SailPoint, lastName=Support, displayName=SailPoint Support} ` + -Authoritative false ` + -Description null ` + -Disabled false ` + -Locked false ` + -NativeIdentity 552775 ` + -SystemAccount false ` + -Uncorrelated false ` + -Uuid {b0dce506-d6d4-44d2-8a32-d9a5b21fb175} ` + -ManuallyCorrelated false ` + -HasEntitlements true ` + -Identity null ` + -SourceOwner null ` + -Features ENABLE ` + -Origin AGGREGATED ` + -OwnerIdentity null +``` + +- Convert the resource to JSON +```powershell +$Account | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountAction.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountAction.md new file mode 100644 index 000000000..c83d598a9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountAction.md @@ -0,0 +1,37 @@ +--- +id: account-action +title: AccountAction +pagination_label: AccountAction +sidebar_label: AccountAction +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAction', 'AccountAction'] +slug: /tools/sdk/powershell/v3/models/account-action +tags: ['SDK', 'Software Development Kit', 'AccountAction', 'AccountAction'] +--- + + +# AccountAction + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountAction = Initialize-PSSailpoint.V3AccountAction -Action ENABLE ` + -SourceIds [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500] +``` + +- Convert the resource to JSON +```powershell +$AccountAction | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountActivity.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountActivity.md new file mode 100644 index 000000000..6e14b1774 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountActivity.md @@ -0,0 +1,61 @@ +--- +id: account-activity +title: AccountActivity +pagination_label: AccountActivity +sidebar_label: AccountActivity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivity', 'AccountActivity'] +slug: /tools/sdk/powershell/v3/models/account-activity +tags: ['SDK', 'Software Development Kit', 'AccountActivity', 'AccountActivity'] +--- + + +# AccountActivity + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountActivity = Initialize-PSSailpoint.V3AccountActivity -Id 2c9180835d2e5168015d32f890ca1581 ` + -Name 2c9180835d2e5168015d32f890ca1581 ` + -Created 2017-07-11T18:45:37.098Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Completed 2018-10-19T13:49:37.385Z ` + -CompletionStatus null ` + -Type appRequest ` + -RequesterIdentitySummary null ` + -TargetIdentitySummary null ` + -Errors [sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds.] ` + -Warnings [Some warning, another warning] ` + -Items null ` + -ExecutionStatus null ` + -ClientMetadata {customKey1=custom value 1, customKey2=custom value 2} +``` + +- Convert the resource to JSON +```powershell +$AccountActivity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountActivityApprovalStatus.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountActivityApprovalStatus.md new file mode 100644 index 000000000..506b90b66 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountActivityApprovalStatus.md @@ -0,0 +1,32 @@ +--- +id: account-activity-approval-status +title: AccountActivityApprovalStatus +pagination_label: AccountActivityApprovalStatus +sidebar_label: AccountActivityApprovalStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivityApprovalStatus', 'AccountActivityApprovalStatus'] +slug: /tools/sdk/powershell/v3/models/account-activity-approval-status +tags: ['SDK', 'Software Development Kit', 'AccountActivityApprovalStatus', 'AccountActivityApprovalStatus'] +--- + + +# AccountActivityApprovalStatus + +## Enum + + +* `FINISHED` (value: `"FINISHED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `RETURNED` (value: `"RETURNED"`) + +* `EXPIRED` (value: `"EXPIRED"`) + +* `PENDING` (value: `"PENDING"`) + +* `CANCELED` (value: `"CANCELED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountActivityDocument.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountActivityDocument.md new file mode 100644 index 000000000..8aac037b4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountActivityDocument.md @@ -0,0 +1,71 @@ +--- +id: account-activity-document +title: AccountActivityDocument +pagination_label: AccountActivityDocument +sidebar_label: AccountActivityDocument +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivityDocument', 'AccountActivityDocument'] +slug: /tools/sdk/powershell/v3/models/account-activity-document +tags: ['SDK', 'Software Development Kit', 'AccountActivityDocument', 'AccountActivityDocument'] +--- + + +# AccountActivityDocument + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountActivityDocument = Initialize-PSSailpoint.V3AccountActivityDocument -Id 2c91808375d8e80a0175e1f88a575222 ` + -Name john.doe ` + -Type null ` + -Action Identity Refresh. ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Stage Completed ` + -Origin null ` + -Status Complete ` + -Requester null ` + -Recipient null ` + -TrackingNumber 61aad0c9e8134eca89e76a35e0cabe3f ` + -Errors null ` + -Warnings null ` + -Approvals null ` + -OriginalRequests null ` + -ExpansionItems null ` + -AccountRequests null ` + -Sources smartsheet-test, airtable-v4, IdentityNow +``` + +- Convert the resource to JSON +```powershell +$AccountActivityDocument | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountActivityItem.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountActivityItem.md new file mode 100644 index 000000000..d3548f185 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountActivityItem.md @@ -0,0 +1,65 @@ +--- +id: account-activity-item +title: AccountActivityItem +pagination_label: AccountActivityItem +sidebar_label: AccountActivityItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivityItem', 'AccountActivityItem'] +slug: /tools/sdk/powershell/v3/models/account-activity-item +tags: ['SDK', 'Software Development Kit', 'AccountActivityItem', 'AccountActivityItem'] +--- + + +# AccountActivityItem + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountActivityItem = Initialize-PSSailpoint.V3AccountActivityItem -Id 48c545831b264409a81befcabb0e3c5a ` + -Name 48c545831b264409a81befcabb0e3c5a ` + -Requested 2017-07-11T18:45:37.098Z ` + -ApprovalStatus null ` + -ProvisioningStatus null ` + -RequesterComment null ` + -ReviewerIdentitySummary null ` + -ReviewerComment null ` + -Operation null ` + -Attribute detectedRoles ` + -Value Treasury Analyst [AccessProfile-1529010191212] ` + -NativeIdentity Sandie.Camero ` + -SourceId 2c91808363ef85290164000587130c0c ` + -AccountRequestInfo null ` + -ClientMetadata {customKey1=custom value 1, customKey2=custom value 2} ` + -RemoveDate 2020-07-11T00:00Z +``` + +- Convert the resource to JSON +```powershell +$AccountActivityItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountActivityItemOperation.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountActivityItemOperation.md new file mode 100644 index 000000000..b14a19c2a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountActivityItemOperation.md @@ -0,0 +1,40 @@ +--- +id: account-activity-item-operation +title: AccountActivityItemOperation +pagination_label: AccountActivityItemOperation +sidebar_label: AccountActivityItemOperation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivityItemOperation', 'AccountActivityItemOperation'] +slug: /tools/sdk/powershell/v3/models/account-activity-item-operation +tags: ['SDK', 'Software Development Kit', 'AccountActivityItemOperation', 'AccountActivityItemOperation'] +--- + + +# AccountActivityItemOperation + +## Enum + + +* `ADD` (value: `"ADD"`) + +* `CREATE` (value: `"CREATE"`) + +* `MODIFY` (value: `"MODIFY"`) + +* `DELETE` (value: `"DELETE"`) + +* `DISABLE` (value: `"DISABLE"`) + +* `ENABLE` (value: `"ENABLE"`) + +* `UNLOCK` (value: `"UNLOCK"`) + +* `LOCK` (value: `"LOCK"`) + +* `REMOVE` (value: `"REMOVE"`) + +* `SET` (value: `"SET"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountActivitySearchedItem.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountActivitySearchedItem.md new file mode 100644 index 000000000..4aab64322 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountActivitySearchedItem.md @@ -0,0 +1,71 @@ +--- +id: account-activity-searched-item +title: AccountActivitySearchedItem +pagination_label: AccountActivitySearchedItem +sidebar_label: AccountActivitySearchedItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivitySearchedItem', 'AccountActivitySearchedItem'] +slug: /tools/sdk/powershell/v3/models/account-activity-searched-item +tags: ['SDK', 'Software Development Kit', 'AccountActivitySearchedItem', 'AccountActivitySearchedItem'] +--- + + +# AccountActivitySearchedItem + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountActivitySearchedItem = Initialize-PSSailpoint.V3AccountActivitySearchedItem -Id 2c91808375d8e80a0175e1f88a575222 ` + -Name john.doe ` + -Type null ` + -Action Identity Refresh. ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Stage Completed ` + -Origin null ` + -Status Complete ` + -Requester null ` + -Recipient null ` + -TrackingNumber 61aad0c9e8134eca89e76a35e0cabe3f ` + -Errors null ` + -Warnings null ` + -Approvals null ` + -OriginalRequests null ` + -ExpansionItems null ` + -AccountRequests null ` + -Sources smartsheet-test, airtable-v4, IdentityNow +``` + +- Convert the resource to JSON +```powershell +$AccountActivitySearchedItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountAttribute.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountAttribute.md new file mode 100644 index 000000000..118600b10 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountAttribute.md @@ -0,0 +1,51 @@ +--- +id: account-attribute +title: AccountAttribute +pagination_label: AccountAttribute +sidebar_label: AccountAttribute +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttribute', 'AccountAttribute'] +slug: /tools/sdk/powershell/v3/models/account-attribute +tags: ['SDK', 'Software Development Kit', 'AccountAttribute', 'AccountAttribute'] +--- + + +# AccountAttribute + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountAttribute = Initialize-PSSailpoint.V3AccountAttribute -SourceName Workday ` + -AttributeName DEPARTMENT ` + -AccountSortAttribute created ` + -AccountSortDescending false ` + -AccountReturnFirstLink false ` + -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` + -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$AccountAttribute | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountAttributes.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountAttributes.md new file mode 100644 index 000000000..fd345f940 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountAttributes.md @@ -0,0 +1,35 @@ +--- +id: account-attributes +title: AccountAttributes +pagination_label: AccountAttributes +sidebar_label: AccountAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributes', 'AccountAttributes'] +slug: /tools/sdk/powershell/v3/models/account-attributes +tags: ['SDK', 'Software Development Kit', 'AccountAttributes', 'AccountAttributes'] +--- + + +# AccountAttributes + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountAttributes = Initialize-PSSailpoint.V3AccountAttributes -Attributes {city=Austin, displayName=John Doe, userName=jdoe, sAMAccountName=jDoe, mail=john.doe@sailpoint.com} +``` + +- Convert the resource to JSON +```powershell +$AccountAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountAttributesCreate.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountAttributesCreate.md new file mode 100644 index 000000000..52f9e7cdb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountAttributesCreate.md @@ -0,0 +1,35 @@ +--- +id: account-attributes-create +title: AccountAttributesCreate +pagination_label: AccountAttributesCreate +sidebar_label: AccountAttributesCreate +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesCreate', 'AccountAttributesCreate'] +slug: /tools/sdk/powershell/v3/models/account-attributes-create +tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreate', 'AccountAttributesCreate'] +--- + + +# AccountAttributesCreate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | [**AccountAttributesCreateAttributes**](account-attributes-create-attributes) | | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountAttributesCreate = Initialize-PSSailpoint.V3AccountAttributesCreate -Attributes null +``` + +- Convert the resource to JSON +```powershell +$AccountAttributesCreate | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountAttributesCreateAttributes.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountAttributesCreateAttributes.md new file mode 100644 index 000000000..1aab4f491 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountAttributesCreateAttributes.md @@ -0,0 +1,35 @@ +--- +id: account-attributes-create-attributes +title: AccountAttributesCreateAttributes +pagination_label: AccountAttributesCreateAttributes +sidebar_label: AccountAttributesCreateAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesCreateAttributes', 'AccountAttributesCreateAttributes'] +slug: /tools/sdk/powershell/v3/models/account-attributes-create-attributes +tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreateAttributes', 'AccountAttributesCreateAttributes'] +--- + + +# AccountAttributesCreateAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceId** | **String** | Target source to create an account | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountAttributesCreateAttributes = Initialize-PSSailpoint.V3AccountAttributesCreateAttributes -SourceId 34bfcbe116c9407464af37acbaf7a4dc +``` + +- Convert the resource to JSON +```powershell +$AccountAttributesCreateAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountRequest.md new file mode 100644 index 000000000..3cc8c3f06 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountRequest.md @@ -0,0 +1,45 @@ +--- +id: account-request +title: AccountRequest +pagination_label: AccountRequest +sidebar_label: AccountRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountRequest', 'AccountRequest'] +slug: /tools/sdk/powershell/v3/models/account-request +tags: ['SDK', 'Software Development Kit', 'AccountRequest', 'AccountRequest'] +--- + + +# AccountRequest + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountRequest = Initialize-PSSailpoint.V3AccountRequest -AccountId John.Doe ` + -AttributeRequests null ` + -Op Modify ` + -ProvisioningTarget null ` + -Result null ` + -Source null +``` + +- Convert the resource to JSON +```powershell +$AccountRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountRequestInfo.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountRequestInfo.md new file mode 100644 index 000000000..d394fcae3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountRequestInfo.md @@ -0,0 +1,39 @@ +--- +id: account-request-info +title: AccountRequestInfo +pagination_label: AccountRequestInfo +sidebar_label: AccountRequestInfo +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountRequestInfo', 'AccountRequestInfo'] +slug: /tools/sdk/powershell/v3/models/account-request-info +tags: ['SDK', 'Software Development Kit', 'AccountRequestInfo', 'AccountRequestInfo'] +--- + + +# AccountRequestInfo + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountRequestInfo = Initialize-PSSailpoint.V3AccountRequestInfo -RequestedObjectId 2c91808563ef85690164001c31140c0c ` + -RequestedObjectName Treasury Analyst ` + -RequestedObjectType null +``` + +- Convert the resource to JSON +```powershell +$AccountRequestInfo | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountRequestResult.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountRequestResult.md new file mode 100644 index 000000000..8b0e02989 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountRequestResult.md @@ -0,0 +1,39 @@ +--- +id: account-request-result +title: AccountRequestResult +pagination_label: AccountRequestResult +sidebar_label: AccountRequestResult +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountRequestResult', 'AccountRequestResult'] +slug: /tools/sdk/powershell/v3/models/account-request-result +tags: ['SDK', 'Software Development Kit', 'AccountRequestResult', 'AccountRequestResult'] +--- + + +# AccountRequestResult + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountRequestResult = Initialize-PSSailpoint.V3AccountRequestResult -Errors null ` + -Status failed ` + -TicketId null +``` + +- Convert the resource to JSON +```powershell +$AccountRequestResult | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountSource.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountSource.md new file mode 100644 index 000000000..c696ceedc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountSource.md @@ -0,0 +1,39 @@ +--- +id: account-source +title: AccountSource +pagination_label: AccountSource +sidebar_label: AccountSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountSource', 'AccountSource'] +slug: /tools/sdk/powershell/v3/models/account-source +tags: ['SDK', 'Software Development Kit', 'AccountSource', 'AccountSource'] +--- + + +# AccountSource + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountSource = Initialize-PSSailpoint.V3AccountSource -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -Type Delimited File +``` + +- Convert the resource to JSON +```powershell +$AccountSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountToggleRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountToggleRequest.md new file mode 100644 index 000000000..362e03432 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountToggleRequest.md @@ -0,0 +1,37 @@ +--- +id: account-toggle-request +title: AccountToggleRequest +pagination_label: AccountToggleRequest +sidebar_label: AccountToggleRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountToggleRequest', 'AccountToggleRequest'] +slug: /tools/sdk/powershell/v3/models/account-toggle-request +tags: ['SDK', 'Software Development Kit', 'AccountToggleRequest', 'AccountToggleRequest'] +--- + + +# AccountToggleRequest + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountToggleRequest = Initialize-PSSailpoint.V3AccountToggleRequest -ExternalVerificationId 3f9180835d2e5168015d32f890ca1581 ` + -ForceProvisioning false +``` + +- Convert the resource to JSON +```powershell +$AccountToggleRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountUnlockRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountUnlockRequest.md new file mode 100644 index 000000000..5a58ee8a1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountUnlockRequest.md @@ -0,0 +1,39 @@ +--- +id: account-unlock-request +title: AccountUnlockRequest +pagination_label: AccountUnlockRequest +sidebar_label: AccountUnlockRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUnlockRequest', 'AccountUnlockRequest'] +slug: /tools/sdk/powershell/v3/models/account-unlock-request +tags: ['SDK', 'Software Development Kit', 'AccountUnlockRequest', 'AccountUnlockRequest'] +--- + + +# AccountUnlockRequest + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountUnlockRequest = Initialize-PSSailpoint.V3AccountUnlockRequest -ExternalVerificationId 3f9180835d2e5168015d32f890ca1581 ` + -UnlockIDNAccount false ` + -ForceProvisioning false +``` + +- Convert the resource to JSON +```powershell +$AccountUnlockRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountUsage.md new file mode 100644 index 000000000..9bc93a708 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountUsage.md @@ -0,0 +1,37 @@ +--- +id: account-usage +title: AccountUsage +pagination_label: AccountUsage +sidebar_label: AccountUsage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUsage', 'AccountUsage'] +slug: /tools/sdk/powershell/v3/models/account-usage +tags: ['SDK', 'Software Development Kit', 'AccountUsage', 'AccountUsage'] +--- + + +# AccountUsage + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$AccountUsage = Initialize-PSSailpoint.V3AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` + -Count 10 +``` + +- Convert the resource to JSON +```powershell +$AccountUsage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountsAsyncResult.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountsAsyncResult.md new file mode 100644 index 000000000..c50fd3753 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountsAsyncResult.md @@ -0,0 +1,35 @@ +--- +id: accounts-async-result +title: AccountsAsyncResult +pagination_label: AccountsAsyncResult +sidebar_label: AccountsAsyncResult +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsAsyncResult', 'AccountsAsyncResult'] +slug: /tools/sdk/powershell/v3/models/accounts-async-result +tags: ['SDK', 'Software Development Kit', 'AccountsAsyncResult', 'AccountsAsyncResult'] +--- + + +# AccountsAsyncResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | id of the task | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountsAsyncResult = Initialize-PSSailpoint.V3AccountsAsyncResult -Id 2c91808474683da6017468693c260195 +``` + +- Convert the resource to JSON +```powershell +$AccountsAsyncResult | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountsExportReportArguments.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountsExportReportArguments.md new file mode 100644 index 000000000..e30953fc3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AccountsExportReportArguments.md @@ -0,0 +1,37 @@ +--- +id: accounts-export-report-arguments +title: AccountsExportReportArguments +pagination_label: AccountsExportReportArguments +sidebar_label: AccountsExportReportArguments +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsExportReportArguments', 'AccountsExportReportArguments'] +slug: /tools/sdk/powershell/v3/models/accounts-export-report-arguments +tags: ['SDK', 'Software Development Kit', 'AccountsExportReportArguments', 'AccountsExportReportArguments'] +--- + + +# AccountsExportReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Application** | **String** | Source ID. | [required] +**SourceName** | **String** | Source name. | [required] + +## Examples + +- Prepare the resource +```powershell +$AccountsExportReportArguments = Initialize-PSSailpoint.V3AccountsExportReportArguments -Application 2c9180897eSourceIde781782f705b9 ` + -SourceName Active Directory +``` + +- Convert the resource to JSON +```powershell +$AccountsExportReportArguments | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ActivateCampaignOptions.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ActivateCampaignOptions.md new file mode 100644 index 000000000..93ae31e03 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ActivateCampaignOptions.md @@ -0,0 +1,35 @@ +--- +id: activate-campaign-options +title: ActivateCampaignOptions +pagination_label: ActivateCampaignOptions +sidebar_label: ActivateCampaignOptions +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ActivateCampaignOptions', 'ActivateCampaignOptions'] +slug: /tools/sdk/powershell/v3/models/activate-campaign-options +tags: ['SDK', 'Software Development Kit', 'ActivateCampaignOptions', 'ActivateCampaignOptions'] +--- + + +# ActivateCampaignOptions + +## Properties + +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"] + +## Examples + +- Prepare the resource +```powershell +$ActivateCampaignOptions = Initialize-PSSailpoint.V3ActivateCampaignOptions -TimeZone -05:00 +``` + +- Convert the resource to JSON +```powershell +$ActivateCampaignOptions | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ActivityInsights.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ActivityInsights.md new file mode 100644 index 000000000..bdcb355c7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ActivityInsights.md @@ -0,0 +1,39 @@ +--- +id: activity-insights +title: ActivityInsights +pagination_label: ActivityInsights +sidebar_label: ActivityInsights +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ActivityInsights', 'ActivityInsights'] +slug: /tools/sdk/powershell/v3/models/activity-insights +tags: ['SDK', 'Software Development Kit', 'ActivityInsights', 'ActivityInsights'] +--- + + +# ActivityInsights + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountID** | Pointer to **String** | UUID of the account | [optional] +**UsageDays** | Pointer to **Int32** | The number of days of activity | [optional] +**UsageDaysState** | Pointer to **Enum** [ "COMPLETE", "UNKNOWN" ] | Status indicating if the activity is complete or unknown | [optional] + +## Examples + +- Prepare the resource +```powershell +$ActivityInsights = Initialize-PSSailpoint.V3ActivityInsights -AccountID c4ddd5421d8549f0abd309162cafd3b1 ` + -UsageDays 45 ` + -UsageDaysState COMPLETE +``` + +- Convert the resource to JSON +```powershell +$ActivityInsights | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AdminReviewReassign.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AdminReviewReassign.md new file mode 100644 index 000000000..ec2391782 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AdminReviewReassign.md @@ -0,0 +1,39 @@ +--- +id: admin-review-reassign +title: AdminReviewReassign +pagination_label: AdminReviewReassign +sidebar_label: AdminReviewReassign +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AdminReviewReassign', 'AdminReviewReassign'] +slug: /tools/sdk/powershell/v3/models/admin-review-reassign +tags: ['SDK', 'Software Development Kit', 'AdminReviewReassign', 'AdminReviewReassign'] +--- + + +# AdminReviewReassign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CertificationIds** | Pointer to **[]String** | List of certification IDs to reassign | [optional] +**ReassignTo** | Pointer to [**AdminReviewReassignReassignTo**](admin-review-reassign-reassign-to) | | [optional] +**Reason** | Pointer to **String** | Comment to explain why the certification was reassigned | [optional] + +## Examples + +- Prepare the resource +```powershell +$AdminReviewReassign = Initialize-PSSailpoint.V3AdminReviewReassign -CertificationIds [af3859464779471211bb8424a563abc1, af3859464779471211bb8424a563abc2, af3859464779471211bb8424a563abc3] ` + -ReassignTo null ` + -Reason reassigned for some reason +``` + +- Convert the resource to JSON +```powershell +$AdminReviewReassign | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AdminReviewReassignReassignTo.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AdminReviewReassignReassignTo.md new file mode 100644 index 000000000..a0330cfc1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AdminReviewReassignReassignTo.md @@ -0,0 +1,37 @@ +--- +id: admin-review-reassign-reassign-to +title: AdminReviewReassignReassignTo +pagination_label: AdminReviewReassignReassignTo +sidebar_label: AdminReviewReassignReassignTo +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AdminReviewReassignReassignTo', 'AdminReviewReassignReassignTo'] +slug: /tools/sdk/powershell/v3/models/admin-review-reassign-reassign-to +tags: ['SDK', 'Software Development Kit', 'AdminReviewReassignReassignTo', 'AdminReviewReassignReassignTo'] +--- + + +# AdminReviewReassignReassignTo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The identity ID to which the review is being assigned. | [optional] +**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of the ID provided. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AdminReviewReassignReassignTo = Initialize-PSSailpoint.V3AdminReviewReassignReassignTo -Id ef38f94347e94562b5bb8424a56397d8 ` + -Type IDENTITY +``` + +- Convert the resource to JSON +```powershell +$AdminReviewReassignReassignTo | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AggregationResult.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AggregationResult.md new file mode 100644 index 000000000..d14239688 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AggregationResult.md @@ -0,0 +1,37 @@ +--- +id: aggregation-result +title: AggregationResult +pagination_label: AggregationResult +sidebar_label: AggregationResult +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AggregationResult', 'AggregationResult'] +slug: /tools/sdk/powershell/v3/models/aggregation-result +tags: ['SDK', 'Software Development Kit', 'AggregationResult', 'AggregationResult'] +--- + + +# AggregationResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Aggregations** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run. See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information. | [optional] +**Hits** | Pointer to [**[]SearchDocument**](search-document) | The results of the aggregation search query. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AggregationResult = Initialize-PSSailpoint.V3AggregationResult -Aggregations {Identity Locations={buckets=[{key=Austin, doc_count=109}, {key=London, doc_count=64}, {key=San Jose, doc_count=27}, {key=Brussels, doc_count=26}, {key=Sao Paulo, doc_count=24}, {key=Munich, doc_count=23}, {key=Singapore, doc_count=22}, {key=Tokyo, doc_count=20}, {key=Taipei, doc_count=16}]}} ` + -Hits null +``` + +- Convert the resource to JSON +```powershell +$AggregationResult | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AggregationType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AggregationType.md new file mode 100644 index 000000000..86e1eb947 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AggregationType.md @@ -0,0 +1,24 @@ +--- +id: aggregation-type +title: AggregationType +pagination_label: AggregationType +sidebar_label: AggregationType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AggregationType', 'AggregationType'] +slug: /tools/sdk/powershell/v3/models/aggregation-type +tags: ['SDK', 'Software Development Kit', 'AggregationType', 'AggregationType'] +--- + + +# AggregationType + +## Enum + + +* `DSL` (value: `"DSL"`) + +* `SAILPOINT` (value: `"SAILPOINT"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Aggregations.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Aggregations.md new file mode 100644 index 000000000..878d82626 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Aggregations.md @@ -0,0 +1,41 @@ +--- +id: aggregations +title: Aggregations +pagination_label: Aggregations +sidebar_label: Aggregations +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Aggregations', 'Aggregations'] +slug: /tools/sdk/powershell/v3/models/aggregations +tags: ['SDK', 'Software Development Kit', 'Aggregations', 'Aggregations'] +--- + + +# Aggregations + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Nested** | Pointer to [**NestedAggregation**](nested-aggregation) | | [optional] +**Metric** | Pointer to [**MetricAggregation**](metric-aggregation) | | [optional] +**VarFilter** | Pointer to [**FilterAggregation**](filter-aggregation) | | [optional] +**Bucket** | Pointer to [**BucketAggregation**](bucket-aggregation) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Aggregations = Initialize-PSSailpoint.V3Aggregations -Nested null ` + -Metric null ` + -VarFilter null ` + -Bucket null +``` + +- Convert the resource to JSON +```powershell +$Aggregations | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/App.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/App.md new file mode 100644 index 000000000..bb095b312 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/App.md @@ -0,0 +1,41 @@ +--- +id: app +title: App +pagination_label: App +sidebar_label: App +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'App', 'App'] +slug: /tools/sdk/powershell/v3/models/app +tags: ['SDK', 'Software Development Kit', 'App', 'App'] +--- + + +# App + +## Properties + +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] +**Source** | Pointer to [**Reference1**](reference1) | | [optional] +**Account** | Pointer to [**AppAllOfAccount**](app-all-of-account) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$App = Initialize-PSSailpoint.V3App -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -Source null ` + -Account null +``` + +- Convert the resource to JSON +```powershell +$App | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AppAllOfAccount.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AppAllOfAccount.md new file mode 100644 index 000000000..569916d9f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AppAllOfAccount.md @@ -0,0 +1,37 @@ +--- +id: app-all-of-account +title: AppAllOfAccount +pagination_label: AppAllOfAccount +sidebar_label: AppAllOfAccount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AppAllOfAccount', 'AppAllOfAccount'] +slug: /tools/sdk/powershell/v3/models/app-all-of-account +tags: ['SDK', 'Software Development Kit', 'AppAllOfAccount', 'AppAllOfAccount'] +--- + + +# AppAllOfAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The SailPoint generated unique ID | [optional] +**AccountId** | Pointer to **String** | The account ID generated by the source | [optional] + +## Examples + +- Prepare the resource +```powershell +$AppAllOfAccount = Initialize-PSSailpoint.V3AppAllOfAccount -Id 2c9180837dfe6949017e21f3d8cd6d49 ` + -AccountId CN=Carol Adams,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=sailpointdemo,DC=com +``` + +- Convert the resource to JSON +```powershell +$AppAllOfAccount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Approval.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Approval.md new file mode 100644 index 000000000..9d0fa9d7d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Approval.md @@ -0,0 +1,45 @@ +--- +id: approval +title: Approval +pagination_label: Approval +sidebar_label: Approval +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Approval', 'Approval'] +slug: /tools/sdk/powershell/v3/models/approval +tags: ['SDK', 'Software Development Kit', 'Approval', 'Approval'] +--- + + +# Approval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comments** | Pointer to [**[]ApprovalComment**](approval-comment) | | [optional] +**Created** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] +**Modified** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] +**Owner** | Pointer to [**AccountSource**](account-source) | | [optional] +**Result** | Pointer to **String** | The result of the approval | [optional] +**Type** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Approval = Initialize-PSSailpoint.V3Approval -Comments null ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Owner null ` + -Result Finished ` + -Type null +``` + +- Convert the resource to JSON +```powershell +$Approval | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalComment.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalComment.md new file mode 100644 index 000000000..dfcdf3a1c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalComment.md @@ -0,0 +1,39 @@ +--- +id: approval-comment +title: ApprovalComment +pagination_label: ApprovalComment +sidebar_label: ApprovalComment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalComment', 'ApprovalComment'] +slug: /tools/sdk/powershell/v3/models/approval-comment +tags: ['SDK', 'Software Development Kit', 'ApprovalComment', 'ApprovalComment'] +--- + + +# ApprovalComment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | The comment text | [optional] +**Commenter** | Pointer to **String** | The name of the commenter | [optional] +**Date** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalComment = Initialize-PSSailpoint.V3ApprovalComment -Comment This request was autoapproved by our automated ETS subscriber. ` + -Commenter Automated AR Approval ` + -Date 2018-06-25T20:22:28.104Z +``` + +- Convert the resource to JSON +```powershell +$ApprovalComment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalForwardHistory.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalForwardHistory.md new file mode 100644 index 000000000..b3721a8c7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalForwardHistory.md @@ -0,0 +1,45 @@ +--- +id: approval-forward-history +title: ApprovalForwardHistory +pagination_label: ApprovalForwardHistory +sidebar_label: ApprovalForwardHistory +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalForwardHistory', 'ApprovalForwardHistory'] +slug: /tools/sdk/powershell/v3/models/approval-forward-history +tags: ['SDK', 'Software Development Kit', 'ApprovalForwardHistory', 'ApprovalForwardHistory'] +--- + + +# ApprovalForwardHistory + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OldApproverName** | Pointer to **String** | Display name of approver from whom the approval was forwarded. | [optional] +**NewApproverName** | Pointer to **String** | Display name of approver to whom the approval was forwarded. | [optional] +**Comment** | Pointer to **String** | Comment made while forwarding. | [optional] +**Modified** | Pointer to **System.DateTime** | Time at which approval was forwarded. | [optional] +**ForwarderName** | Pointer to **String** | Display name of forwarder who forwarded the approval. | [optional] +**ReassignmentType** | Pointer to [**ReassignmentType**](reassignment-type) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalForwardHistory = Initialize-PSSailpoint.V3ApprovalForwardHistory -OldApproverName Frank Mir ` + -NewApproverName Al Volta ` + -Comment Forwarding from Frank to Al ` + -Modified 2019-08-23T18:52:57.398Z ` + -ForwarderName William Wilson ` + -ReassignmentType null +``` + +- Convert the resource to JSON +```powershell +$ApprovalForwardHistory | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalItemDetails.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalItemDetails.md new file mode 100644 index 000000000..575e509bf --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalItemDetails.md @@ -0,0 +1,47 @@ +--- +id: approval-item-details +title: ApprovalItemDetails +pagination_label: ApprovalItemDetails +sidebar_label: ApprovalItemDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalItemDetails', 'ApprovalItemDetails'] +slug: /tools/sdk/powershell/v3/models/approval-item-details +tags: ['SDK', 'Software Development Kit', 'ApprovalItemDetails', 'ApprovalItemDetails'] +--- + + +# ApprovalItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The approval item's ID | [optional] +**Account** | Pointer to **String** | The account referenced by the approval item | [optional] +**Application** | Pointer to **String** | The name of the application/source | [optional] +**Name** | Pointer to **String** | The attribute's name | [optional] +**Operation** | Pointer to **String** | The attribute's operation | [optional] +**Value** | Pointer to **String** | The attribute's value | [optional] +**State** | Pointer to [**WorkItemState**](work-item-state) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalItemDetails = Initialize-PSSailpoint.V3ApprovalItemDetails -Id 2c9180835d2e5168015d32f890ca1581 ` + -Account john.smith ` + -Application Active Directory ` + -Name emailAddress ` + -Operation update ` + -Value a@b.com ` + -State null +``` + +- Convert the resource to JSON +```powershell +$ApprovalItemDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalItems.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalItems.md new file mode 100644 index 000000000..15f5d57b7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalItems.md @@ -0,0 +1,47 @@ +--- +id: approval-items +title: ApprovalItems +pagination_label: ApprovalItems +sidebar_label: ApprovalItems +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalItems', 'ApprovalItems'] +slug: /tools/sdk/powershell/v3/models/approval-items +tags: ['SDK', 'Software Development Kit', 'ApprovalItems', 'ApprovalItems'] +--- + + +# ApprovalItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The approval item's ID | [optional] +**Account** | Pointer to **String** | The account referenced by the approval item | [optional] +**Application** | Pointer to **String** | The name of the application/source | [optional] +**Name** | Pointer to **String** | The attribute's name | [optional] +**Operation** | Pointer to **String** | The attribute's operation | [optional] +**Value** | Pointer to **String** | The attribute's value | [optional] +**State** | Pointer to [**WorkItemState**](work-item-state) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalItems = Initialize-PSSailpoint.V3ApprovalItems -Id 2c9180835d2e5168015d32f890ca1581 ` + -Account john.smith ` + -Application Active Directory ` + -Name emailAddress ` + -Operation update ` + -Value a@b.com ` + -State null +``` + +- Convert the resource to JSON +```powershell +$ApprovalItems | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalReminderAndEscalationConfig.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalReminderAndEscalationConfig.md new file mode 100644 index 000000000..89589e56f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalReminderAndEscalationConfig.md @@ -0,0 +1,41 @@ +--- +id: approval-reminder-and-escalation-config +title: ApprovalReminderAndEscalationConfig +pagination_label: ApprovalReminderAndEscalationConfig +sidebar_label: ApprovalReminderAndEscalationConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalReminderAndEscalationConfig', 'ApprovalReminderAndEscalationConfig'] +slug: /tools/sdk/powershell/v3/models/approval-reminder-and-escalation-config +tags: ['SDK', 'Software Development Kit', 'ApprovalReminderAndEscalationConfig', 'ApprovalReminderAndEscalationConfig'] +--- + + +# ApprovalReminderAndEscalationConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DaysUntilEscalation** | Pointer to **Int32** | Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation. | [optional] +**DaysBetweenReminders** | Pointer to **Int32** | Number of days to wait between reminder notifications. | [optional] +**MaxReminders** | Pointer to **Int32** | Maximum number of reminder notification to send to the reviewer before approval escalation. | [optional] +**FallbackApproverRef** | Pointer to [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalReminderAndEscalationConfig = Initialize-PSSailpoint.V3ApprovalReminderAndEscalationConfig -DaysUntilEscalation 0 ` + -DaysBetweenReminders 0 ` + -MaxReminders 1 ` + -FallbackApproverRef null +``` + +- Convert the resource to JSON +```powershell +$ApprovalReminderAndEscalationConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalScheme.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalScheme.md new file mode 100644 index 000000000..530687555 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalScheme.md @@ -0,0 +1,34 @@ +--- +id: approval-scheme +title: ApprovalScheme +pagination_label: ApprovalScheme +sidebar_label: ApprovalScheme +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalScheme', 'ApprovalScheme'] +slug: /tools/sdk/powershell/v3/models/approval-scheme +tags: ['SDK', 'Software Development Kit', 'ApprovalScheme', 'ApprovalScheme'] +--- + + +# ApprovalScheme + +## Enum + + +* `APP_OWNER` (value: `"APP_OWNER"`) + +* `SOURCE_OWNER` (value: `"SOURCE_OWNER"`) + +* `MANAGER` (value: `"MANAGER"`) + +* `ROLE_OWNER` (value: `"ROLE_OWNER"`) + +* `ACCESS_PROFILE_OWNER` (value: `"ACCESS_PROFILE_OWNER"`) + +* `ENTITLEMENT_OWNER` (value: `"ENTITLEMENT_OWNER"`) + +* `GOVERNANCE_GROUP` (value: `"GOVERNANCE_GROUP"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalSchemeForRole.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalSchemeForRole.md new file mode 100644 index 000000000..47e3ce060 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalSchemeForRole.md @@ -0,0 +1,37 @@ +--- +id: approval-scheme-for-role +title: ApprovalSchemeForRole +pagination_label: ApprovalSchemeForRole +sidebar_label: ApprovalSchemeForRole +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalSchemeForRole', 'ApprovalSchemeForRole'] +slug: /tools/sdk/powershell/v3/models/approval-scheme-for-role +tags: ['SDK', 'Software Development Kit', 'ApprovalSchemeForRole', 'ApprovalSchemeForRole'] +--- + + +# ApprovalSchemeForRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApproverType** | Pointer to **Enum** [ "OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **OWNER**: Owner of the associated Role **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] + +## Examples + +- Prepare the resource +```powershell +$ApprovalSchemeForRole = Initialize-PSSailpoint.V3ApprovalSchemeForRole -ApproverType GOVERNANCE_GROUP ` + -ApproverId 46c79819-a69f-49a2-becb-12c971ae66c6 +``` + +- Convert the resource to JSON +```powershell +$ApprovalSchemeForRole | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalStatus.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalStatus.md new file mode 100644 index 000000000..bc40f3318 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalStatus.md @@ -0,0 +1,30 @@ +--- +id: approval-status +title: ApprovalStatus +pagination_label: ApprovalStatus +sidebar_label: ApprovalStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalStatus', 'ApprovalStatus'] +slug: /tools/sdk/powershell/v3/models/approval-status +tags: ['SDK', 'Software Development Kit', 'ApprovalStatus', 'ApprovalStatus'] +--- + + +# ApprovalStatus + +## Enum + + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `PENDING` (value: `"PENDING"`) + +* `NOT_READY` (value: `"NOT_READY"`) + +* `CANCELLED` (value: `"CANCELLED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalStatusDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalStatusDto.md new file mode 100644 index 000000000..912e3bb21 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalStatusDto.md @@ -0,0 +1,53 @@ +--- +id: approval-status-dto +title: ApprovalStatusDto +pagination_label: ApprovalStatusDto +sidebar_label: ApprovalStatusDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalStatusDto', 'ApprovalStatusDto'] +slug: /tools/sdk/powershell/v3/models/approval-status-dto +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDto', 'ApprovalStatusDto'] +--- + + +# ApprovalStatusDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalId** | Pointer to **String** | Unique identifier for the approval. | [optional] +**Forwarded** | Pointer to **Boolean** | True if the request for this item was forwarded from one owner to another. | [optional] [default to $false] +**OriginalOwner** | Pointer to [**ApprovalStatusDtoOriginalOwner**](approval-status-dto-original-owner) | | [optional] +**CurrentOwner** | Pointer to [**ApprovalStatusDtoCurrentOwner**](approval-status-dto-current-owner) | | [optional] +**Modified** | Pointer to **System.DateTime** | Time at which item was modified. | [optional] +**Status** | Pointer to [**ManualWorkItemState**](manual-work-item-state) | | [optional] +**Scheme** | Pointer to [**ApprovalScheme**](approval-scheme) | | [optional] +**ErrorMessages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | If the request failed, includes any error messages that were generated. | [optional] +**Comment** | Pointer to **String** | Comment, if any, provided by the approver. | [optional] +**RemoveDate** | Pointer to **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalStatusDto = Initialize-PSSailpoint.V3ApprovalStatusDto -ApprovalId 2c9180877b2b6ea4017b2c545f971429 ` + -Forwarded false ` + -OriginalOwner null ` + -CurrentOwner null ` + -Modified 2019-08-23T18:52:57.398Z ` + -Status null ` + -Scheme null ` + -ErrorMessages null ` + -Comment I approve this request ` + -RemoveDate 2020-07-11T00:00Z +``` + +- Convert the resource to JSON +```powershell +$ApprovalStatusDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalStatusDtoCurrentOwner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalStatusDtoCurrentOwner.md new file mode 100644 index 000000000..932d2a416 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalStatusDtoCurrentOwner.md @@ -0,0 +1,39 @@ +--- +id: approval-status-dto-current-owner +title: ApprovalStatusDtoCurrentOwner +pagination_label: ApprovalStatusDtoCurrentOwner +sidebar_label: ApprovalStatusDtoCurrentOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalStatusDtoCurrentOwner', 'ApprovalStatusDtoCurrentOwner'] +slug: /tools/sdk/powershell/v3/models/approval-status-dto-current-owner +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoCurrentOwner', 'ApprovalStatusDtoCurrentOwner'] +--- + + +# ApprovalStatusDtoCurrentOwner + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$ApprovalStatusDtoCurrentOwner = Initialize-PSSailpoint.V3ApprovalStatusDtoCurrentOwner -Type IDENTITY ` + -Id 2c3780a46faadee4016fb4e018c20652 ` + -Name Allen Albertson +``` + +- Convert the resource to JSON +```powershell +$ApprovalStatusDtoCurrentOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalStatusDtoOriginalOwner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalStatusDtoOriginalOwner.md new file mode 100644 index 000000000..9e2162bd9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalStatusDtoOriginalOwner.md @@ -0,0 +1,39 @@ +--- +id: approval-status-dto-original-owner +title: ApprovalStatusDtoOriginalOwner +pagination_label: ApprovalStatusDtoOriginalOwner +sidebar_label: ApprovalStatusDtoOriginalOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalStatusDtoOriginalOwner', 'ApprovalStatusDtoOriginalOwner'] +slug: /tools/sdk/powershell/v3/models/approval-status-dto-original-owner +tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoOriginalOwner', 'ApprovalStatusDtoOriginalOwner'] +--- + + +# ApprovalStatusDtoOriginalOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP", "IDENTITY" ] | DTO type of original approval owner's identity. | [optional] +**Id** | Pointer to **String** | ID of original approval owner's identity. | [optional] +**Name** | Pointer to **String** | Display name of original approval owner. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalStatusDtoOriginalOwner = Initialize-PSSailpoint.V3ApprovalStatusDtoOriginalOwner -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$ApprovalStatusDtoOriginalOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalSummary.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalSummary.md new file mode 100644 index 000000000..cd14c7166 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ApprovalSummary.md @@ -0,0 +1,39 @@ +--- +id: approval-summary +title: ApprovalSummary +pagination_label: ApprovalSummary +sidebar_label: ApprovalSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalSummary', 'ApprovalSummary'] +slug: /tools/sdk/powershell/v3/models/approval-summary +tags: ['SDK', 'Software Development Kit', 'ApprovalSummary', 'ApprovalSummary'] +--- + + +# ApprovalSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Pending** | Pointer to **Int32** | The number of pending access requests approvals. | [optional] +**Approved** | Pointer to **Int32** | The number of approved access requests approvals. | [optional] +**Rejected** | Pointer to **Int32** | The number of rejected access requests approvals. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ApprovalSummary = Initialize-PSSailpoint.V3ApprovalSummary -Pending 0 ` + -Approved 0 ` + -Rejected 0 +``` + +- Convert the resource to JSON +```powershell +$ApprovalSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ArrayInner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ArrayInner.md new file mode 100644 index 000000000..8af2c14fe --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ArrayInner.md @@ -0,0 +1,34 @@ +--- +id: array-inner +title: ArrayInner +pagination_label: ArrayInner +sidebar_label: ArrayInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ArrayInner', 'ArrayInner'] +slug: /tools/sdk/powershell/v3/models/array-inner +tags: ['SDK', 'Software Development Kit', 'ArrayInner', 'ArrayInner'] +--- + + +# ArrayInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$ArrayInner = Initialize-PSSailpoint.V3ArrayInner +``` + +- Convert the resource to JSON +```powershell +$ArrayInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AttributeDTO.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AttributeDTO.md new file mode 100644 index 000000000..679eefaea --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AttributeDTO.md @@ -0,0 +1,49 @@ +--- +id: attribute-dto +title: AttributeDTO +pagination_label: AttributeDTO +sidebar_label: AttributeDTO +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDTO', 'AttributeDTO'] +slug: /tools/sdk/powershell/v3/models/attribute-dto +tags: ['SDK', 'Software Development Kit', 'AttributeDTO', 'AttributeDTO'] +--- + + +# AttributeDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **String** | Technical name of the Attribute. This is unique and cannot be changed after creation. | [optional] +**Name** | Pointer to **String** | The display name of the key. | [optional] +**Multiselect** | Pointer to **Boolean** | Indicates whether the attribute can have multiple values. | [optional] [default to $false] +**Status** | Pointer to **String** | The status of the Attribute. | [optional] +**Type** | Pointer to **String** | The type of the Attribute. This can be either ""custom"" or ""governance"". | [optional] +**ObjectTypes** | Pointer to **[]String** | An array of object types this attributes values can be applied to. Possible values are ""all"" or ""entitlement"". Value ""all"" means this attribute can be used with all object types that are supported. | [optional] +**Description** | Pointer to **String** | The description of the Attribute. | [optional] +**Values** | Pointer to [**[]AttributeValueDTO**](attribute-value-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AttributeDTO = Initialize-PSSailpoint.V3AttributeDTO -Key iscPrivacy ` + -Name Privacy ` + -Multiselect false ` + -Status active ` + -Type governance ` + -ObjectTypes [entitlement] ` + -Description Specifies the level of privacy associated with an access item. ` + -Values null +``` + +- Convert the resource to JSON +```powershell +$AttributeDTO | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AttributeDTOList.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AttributeDTOList.md new file mode 100644 index 000000000..d0881a662 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AttributeDTOList.md @@ -0,0 +1,35 @@ +--- +id: attribute-dto-list +title: AttributeDTOList +pagination_label: AttributeDTOList +sidebar_label: AttributeDTOList +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDTOList', 'AttributeDTOList'] +slug: /tools/sdk/powershell/v3/models/attribute-dto-list +tags: ['SDK', 'Software Development Kit', 'AttributeDTOList', 'AttributeDTOList'] +--- + + +# AttributeDTOList + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**[]AttributeDTO**](attribute-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$AttributeDTOList = Initialize-PSSailpoint.V3AttributeDTOList -Attributes [{key=iscPrivacy, name=Privacy, multiselect=false, status=active, type=governance, objectTypes=[all], description=Specifies the level of privacy associated with an access item., values=[{value=public, name=Public, status=active}]}] +``` + +- Convert the resource to JSON +```powershell +$AttributeDTOList | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AttributeDefinition.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AttributeDefinition.md new file mode 100644 index 000000000..b2576091a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AttributeDefinition.md @@ -0,0 +1,47 @@ +--- +id: attribute-definition +title: AttributeDefinition +pagination_label: AttributeDefinition +sidebar_label: AttributeDefinition +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDefinition', 'AttributeDefinition'] +slug: /tools/sdk/powershell/v3/models/attribute-definition +tags: ['SDK', 'Software Development Kit', 'AttributeDefinition', 'AttributeDefinition'] +--- + + +# AttributeDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the attribute. | [optional] +**Type** | Pointer to [**AttributeDefinitionType**](attribute-definition-type) | | [optional] +**Schema** | Pointer to [**AttributeDefinitionSchema**](attribute-definition-schema) | | [optional] +**Description** | Pointer to **String** | A human-readable description of the attribute. | [optional] +**IsMulti** | Pointer to **Boolean** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to $false] +**IsEntitlement** | Pointer to **Boolean** | Flag indicating whether or not the attribute is an entitlement. | [optional] [default to $false] +**IsGroup** | Pointer to **Boolean** | Flag indicating whether or not the attribute represents a group. This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$AttributeDefinition = Initialize-PSSailpoint.V3AttributeDefinition -Name sAMAccountName ` + -Type null ` + -Schema null ` + -Description SAM Account Name ` + -IsMulti false ` + -IsEntitlement false ` + -IsGroup false +``` + +- Convert the resource to JSON +```powershell +$AttributeDefinition | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AttributeDefinitionSchema.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AttributeDefinitionSchema.md new file mode 100644 index 000000000..0b9805b08 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AttributeDefinitionSchema.md @@ -0,0 +1,39 @@ +--- +id: attribute-definition-schema +title: AttributeDefinitionSchema +pagination_label: AttributeDefinitionSchema +sidebar_label: AttributeDefinitionSchema +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDefinitionSchema', 'AttributeDefinitionSchema'] +slug: /tools/sdk/powershell/v3/models/attribute-definition-schema +tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionSchema', 'AttributeDefinitionSchema'] +--- + + +# AttributeDefinitionSchema + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "CONNECTOR_SCHEMA" ] | The type of object being referenced | [optional] +**Id** | Pointer to **String** | The object ID this reference applies to. | [optional] +**Name** | Pointer to **String** | The human-readable display name of the object. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AttributeDefinitionSchema = Initialize-PSSailpoint.V3AttributeDefinitionSchema -Type CONNECTOR_SCHEMA ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name group +``` + +- Convert the resource to JSON +```powershell +$AttributeDefinitionSchema | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AttributeDefinitionType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AttributeDefinitionType.md new file mode 100644 index 000000000..970945808 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AttributeDefinitionType.md @@ -0,0 +1,28 @@ +--- +id: attribute-definition-type +title: AttributeDefinitionType +pagination_label: AttributeDefinitionType +sidebar_label: AttributeDefinitionType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDefinitionType', 'AttributeDefinitionType'] +slug: /tools/sdk/powershell/v3/models/attribute-definition-type +tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionType', 'AttributeDefinitionType'] +--- + + +# AttributeDefinitionType + +## Enum + + +* `STRING` (value: `"STRING"`) + +* `LONG` (value: `"LONG"`) + +* `INT` (value: `"INT"`) + +* `BOOLEAN` (value: `"BOOLEAN"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AttributeRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AttributeRequest.md new file mode 100644 index 000000000..4a0f2f65a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AttributeRequest.md @@ -0,0 +1,39 @@ +--- +id: attribute-request +title: AttributeRequest +pagination_label: AttributeRequest +sidebar_label: AttributeRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeRequest', 'AttributeRequest'] +slug: /tools/sdk/powershell/v3/models/attribute-request +tags: ['SDK', 'Software Development Kit', 'AttributeRequest', 'AttributeRequest'] +--- + + +# AttributeRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Attribute name. | [optional] +**Op** | Pointer to **String** | Operation to perform on attribute. | [optional] +**Value** | Pointer to **String** | Value of attribute. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AttributeRequest = Initialize-PSSailpoint.V3AttributeRequest -Name groups ` + -Op Add ` + -Value 3203537556531076 +``` + +- Convert the resource to JSON +```powershell +$AttributeRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AttributeValueDTO.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AttributeValueDTO.md new file mode 100644 index 000000000..c4547c2de --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AttributeValueDTO.md @@ -0,0 +1,39 @@ +--- +id: attribute-value-dto +title: AttributeValueDTO +pagination_label: AttributeValueDTO +sidebar_label: AttributeValueDTO +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeValueDTO', 'AttributeValueDTO'] +slug: /tools/sdk/powershell/v3/models/attribute-value-dto +tags: ['SDK', 'Software Development Kit', 'AttributeValueDTO', 'AttributeValueDTO'] +--- + + +# AttributeValueDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **String** | Technical name of the Attribute value. This is unique and cannot be changed after creation. | [optional] +**Name** | Pointer to **String** | The display name of the Attribute value. | [optional] +**Status** | Pointer to **String** | The status of the Attribute value. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AttributeValueDTO = Initialize-PSSailpoint.V3AttributeValueDTO -Value public ` + -Name Public ` + -Status active +``` + +- Convert the resource to JSON +```powershell +$AttributeValueDTO | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/AuthUser.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AuthUser.md new file mode 100644 index 000000000..752a417e4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/AuthUser.md @@ -0,0 +1,67 @@ +--- +id: auth-user +title: AuthUser +pagination_label: AuthUser +sidebar_label: AuthUser +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AuthUser', 'AuthUser'] +slug: /tools/sdk/powershell/v3/models/auth-user +tags: ['SDK', 'Software Development Kit', 'AuthUser', 'AuthUser'] +--- + + +# AuthUser + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Tenant** | Pointer to **String** | Tenant name. | [optional] +**Id** | Pointer to **String** | Identity ID. | [optional] +**Uid** | Pointer to **String** | Identity's unique identitifier. | [optional] +**VarProfile** | Pointer to **String** | ID of the auth profile associated with the auth user. | [optional] +**IdentificationNumber** | Pointer to **String** | Auth user's employee number. | [optional] +**Email** | Pointer to **String** | Auth user's email. | [optional] +**Phone** | Pointer to **String** | Auth user's phone number. | [optional] +**WorkPhone** | Pointer to **String** | Auth user's work phone number. | [optional] +**PersonalEmail** | Pointer to **String** | Auth user's personal email. | [optional] +**Firstname** | Pointer to **String** | Auth user's first name. | [optional] +**Lastname** | Pointer to **String** | Auth user's last name. | [optional] +**DisplayName** | Pointer to **String** | Auth user's name in displayed format. | [optional] +**Alias** | Pointer to **String** | Auth user's alias. | [optional] +**LastPasswordChangeDate** | Pointer to **String** | Date of last password change. | [optional] +**LastLoginTimestamp** | Pointer to **Int64** | Timestamp of the last login (long type value). | [optional] +**CurrentLoginTimestamp** | Pointer to **Int64** | Timestamp of the current login (long type value). | [optional] +**Capabilities** | Pointer to **[]String** | Array of the auth user's capabilities. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AuthUser = Initialize-PSSailpoint.V3AuthUser -Tenant test-tenant ` + -Id 2c91808458ae7a4f0158b1bbf8af0628 ` + -Uid will.smith ` + -VarProfile 2c91808458ae7a4f0158b1bbf8af0756 ` + -IdentificationNumber 19-5588452 ` + -Email william.smith@example.com ` + -Phone 5555555555 ` + -WorkPhone 5555555555 ` + -PersonalEmail william.smith@example.com ` + -Firstname Will ` + -Lastname Smith ` + -DisplayName Will Smith ` + -Alias will.smith ` + -LastPasswordChangeDate 2021-03-08T22:37:33.901Z ` + -LastLoginTimestamp 1656327185832 ` + -CurrentLoginTimestamp 1656327185832 ` + -Capabilities null +``` + +- Convert the resource to JSON +```powershell +$AuthUser | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/BackupOptions.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BackupOptions.md new file mode 100644 index 000000000..13f6882d4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BackupOptions.md @@ -0,0 +1,37 @@ +--- +id: backup-options +title: BackupOptions +pagination_label: BackupOptions +sidebar_label: BackupOptions +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BackupOptions', 'BackupOptions'] +slug: /tools/sdk/powershell/v3/models/backup-options +tags: ['SDK', 'Software Development Kit', 'BackupOptions', 'BackupOptions'] +--- + + +# BackupOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IncludeTypes** | Pointer to **[]String** | Object type names to be included in a Configuration Hub backup command. | [optional] +**ObjectOptions** | Pointer to [**map[string]ObjectExportImportNames**](object-export-import-names) | Additional options targeting specific objects related to each item in the includeTypes field. | [optional] + +## Examples + +- Prepare the resource +```powershell +$BackupOptions = Initialize-PSSailpoint.V3BackupOptions -IncludeTypes null ` + -ObjectOptions {TRIGGER_SUBSCRIPTION={includedNames=[Trigger Subscription name]}} +``` + +- Convert the resource to JSON +```powershell +$BackupOptions | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/BackupResponse.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BackupResponse.md new file mode 100644 index 000000000..d9839736f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BackupResponse.md @@ -0,0 +1,67 @@ +--- +id: backup-response +title: BackupResponse +pagination_label: BackupResponse +sidebar_label: BackupResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BackupResponse', 'BackupResponse'] +slug: /tools/sdk/powershell/v3/models/backup-response +tags: ['SDK', 'Software Development Kit', 'BackupResponse', 'BackupResponse'] +--- + + +# BackupResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JobId** | Pointer to **String** | Unique id assigned to this backup. | [optional] +**Status** | Pointer to **Enum** [ "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "CANCELLED", "FAILED" ] | Status of the backup. | [optional] +**Type** | Pointer to **Enum** [ "BACKUP" ] | Type of the job, will always be BACKUP for this type of job. | [optional] +**Tenant** | Pointer to **String** | The name of the tenant performing the upload | [optional] +**RequesterName** | Pointer to **String** | The name of the requester. | [optional] +**FileExists** | Pointer to **Boolean** | Whether or not a file was created and stored for this backup. | [optional] [default to $true] +**Created** | Pointer to **System.DateTime** | The time the job was started. | [optional] +**Modified** | Pointer to **System.DateTime** | The time of the last update to the job. | [optional] +**Completed** | Pointer to **System.DateTime** | The time the job was completed. | [optional] +**Name** | Pointer to **String** | The name assigned to the upload file in the request body. | [optional] +**UserCanDelete** | Pointer to **Boolean** | Whether this backup can be deleted by a regular user. | [optional] [default to $true] +**IsPartial** | Pointer to **Boolean** | Whether this backup contains all supported object types or only some of them. | [optional] [default to $false] +**BackupType** | Pointer to **Enum** [ "UPLOADED", "AUTOMATED", "MANUAL" ] | Denotes how this backup was created. - MANUAL - The backup was created by a user. - AUTOMATED - The backup was created by devops. - AUTOMATED_DRAFT - The backup was created during a draft process. - UPLOADED - The backup was created by uploading an existing configuration file. | [optional] +**Options** | Pointer to [**BackupOptions**](backup-options) | | [optional] +**HydrationStatus** | Pointer to **Enum** [ "HYDRATED", "NOT_HYDRATED" ] | Whether the object details of this backup are ready. | [optional] +**TotalObjectCount** | Pointer to **Int64** | Number of objects contained in this backup. | [optional] +**CloudStorageStatus** | Pointer to **Enum** [ "SYNCED", "NOT_SYNCED", "SYNC_FAILED" ] | Whether this backup has been transferred to a customer storage location. | [optional] + +## Examples + +- Prepare the resource +```powershell +$BackupResponse = Initialize-PSSailpoint.V3BackupResponse -JobId 3469b87d-48ca-439a-868f-2160001da8c1 ` + -Status COMPLETE ` + -Type BACKUP ` + -Tenant tenant-name ` + -RequesterName Requester Name ` + -FileExists true ` + -Created 2021-05-11T22:23:16Z ` + -Modified 2021-05-11T22:23:16Z ` + -Completed 2021-05-11T22:23:16Z ` + -Name Backup Name ` + -UserCanDelete false ` + -IsPartial false ` + -BackupType MANUAL ` + -Options null ` + -HydrationStatus NOT_HYDRATED ` + -TotalObjectCount 10 ` + -CloudStorageStatus SYNCED +``` + +- Convert the resource to JSON +```powershell +$BackupResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Base64Decode.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Base64Decode.md new file mode 100644 index 000000000..33edeb3ea --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Base64Decode.md @@ -0,0 +1,37 @@ +--- +id: base64-decode +title: Base64Decode +pagination_label: Base64Decode +sidebar_label: Base64Decode +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Base64Decode', 'Base64Decode'] +slug: /tools/sdk/powershell/v3/models/base64-decode +tags: ['SDK', 'Software Development Kit', 'Base64Decode', 'Base64Decode'] +--- + + +# Base64Decode + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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] + +## Examples + +- Prepare the resource +```powershell +$Base64Decode = Initialize-PSSailpoint.V3Base64Decode -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Base64Decode | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Base64Encode.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Base64Encode.md new file mode 100644 index 000000000..f30c53021 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Base64Encode.md @@ -0,0 +1,37 @@ +--- +id: base64-encode +title: Base64Encode +pagination_label: Base64Encode +sidebar_label: Base64Encode +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Base64Encode', 'Base64Encode'] +slug: /tools/sdk/powershell/v3/models/base64-encode +tags: ['SDK', 'Software Development Kit', 'Base64Encode', 'Base64Encode'] +--- + + +# Base64Encode + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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] + +## Examples + +- Prepare the resource +```powershell +$Base64Encode = Initialize-PSSailpoint.V3Base64Encode -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Base64Encode | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseAccess.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseAccess.md new file mode 100644 index 000000000..1561e1cc9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseAccess.md @@ -0,0 +1,53 @@ +--- +id: base-access +title: BaseAccess +pagination_label: BaseAccess +sidebar_label: BaseAccess +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BaseAccess', 'BaseAccess'] +slug: /tools/sdk/powershell/v3/models/base-access +tags: ['SDK', 'Software Development Kit', 'BaseAccess', 'BaseAccess'] +--- + + +# BaseAccess + +## Properties + +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] +**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] + +## Examples + +- Prepare the resource +```powershell +$BaseAccess = Initialize-PSSailpoint.V3BaseAccess -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -Description The admin role ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Synced 2018-06-25T20:22:33.104Z ` + -Enabled true ` + -Requestable true ` + -RequestCommentsRequired false ` + -Owner null +``` + +- Convert the resource to JSON +```powershell +$BaseAccess | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseAccessAllOfOwner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseAccessAllOfOwner.md new file mode 100644 index 000000000..4b0d80c42 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseAccessAllOfOwner.md @@ -0,0 +1,41 @@ +--- +id: base-access-all-of-owner +title: BaseAccessAllOfOwner +pagination_label: BaseAccessAllOfOwner +sidebar_label: BaseAccessAllOfOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BaseAccessAllOfOwner', 'BaseAccessAllOfOwner'] +slug: /tools/sdk/powershell/v3/models/base-access-all-of-owner +tags: ['SDK', 'Software Development Kit', 'BaseAccessAllOfOwner', 'BaseAccessAllOfOwner'] +--- + + +# BaseAccessAllOfOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Owner's DTO type. | [optional] +**Id** | Pointer to **String** | Owner's identity ID. | [optional] +**Name** | Pointer to **String** | Owner's display name. | [optional] +**Email** | Pointer to **String** | Owner's email. | [optional] + +## Examples + +- Prepare the resource +```powershell +$BaseAccessAllOfOwner = Initialize-PSSailpoint.V3BaseAccessAllOfOwner -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Support ` + -Email cloud-support@sailpoint.com +``` + +- Convert the resource to JSON +```powershell +$BaseAccessAllOfOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseAccessProfile.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseAccessProfile.md new file mode 100644 index 000000000..b0907c665 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseAccessProfile.md @@ -0,0 +1,37 @@ +--- +id: base-access-profile +title: BaseAccessProfile +pagination_label: BaseAccessProfile +sidebar_label: BaseAccessProfile +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BaseAccessProfile', 'BaseAccessProfile'] +slug: /tools/sdk/powershell/v3/models/base-access-profile +tags: ['SDK', 'Software Development Kit', 'BaseAccessProfile', 'BaseAccessProfile'] +--- + + +# BaseAccessProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Access profile's unique ID. | [optional] +**Name** | Pointer to **String** | Access profile's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$BaseAccessProfile = Initialize-PSSailpoint.V3BaseAccessProfile -Id 2c91809c6faade77016fb4f0b63407ae ` + -Name Admin Access +``` + +- Convert the resource to JSON +```powershell +$BaseAccessProfile | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseAccount.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseAccount.md new file mode 100644 index 000000000..9b5f93007 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseAccount.md @@ -0,0 +1,55 @@ +--- +id: base-account +title: BaseAccount +pagination_label: BaseAccount +sidebar_label: BaseAccount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BaseAccount', 'BaseAccount'] +slug: /tools/sdk/powershell/v3/models/base-account +tags: ['SDK', 'Software Development Kit', 'BaseAccount', 'BaseAccount'] +--- + + +# BaseAccount + +## Properties + +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] +**AccountId** | Pointer to **String** | Account ID. | [optional] +**Source** | Pointer to [**AccountSource**](account-source) | | [optional] +**Disabled** | Pointer to **Boolean** | Indicates whether the account is disabled. | [optional] [default to $false] +**Locked** | Pointer to **Boolean** | Indicates whether the account is locked. | [optional] [default to $false] +**Privileged** | Pointer to **Boolean** | Indicates whether the account is privileged. | [optional] [default to $false] +**ManuallyCorrelated** | Pointer to **Boolean** | Indicates whether the account has been manually correlated to an identity. | [optional] [default to $false] +**PasswordLastSet** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] +**EntitlementAttributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Map or dictionary of key/value pairs. | [optional] +**Created** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] + +## Examples + +- Prepare the resource +```powershell +$BaseAccount = Initialize-PSSailpoint.V3BaseAccount -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -AccountId John.Doe ` + -Source null ` + -Disabled false ` + -Locked false ` + -Privileged false ` + -ManuallyCorrelated false ` + -PasswordLastSet 2018-06-25T20:22:28.104Z ` + -EntitlementAttributes {moderator=true, admin=true, trust_level=4} ` + -Created 2018-06-25T20:22:28.104Z +``` + +- Convert the resource to JSON +```powershell +$BaseAccount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseCommonDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseCommonDto.md new file mode 100644 index 000000000..7890ac349 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseCommonDto.md @@ -0,0 +1,41 @@ +--- +id: base-common-dto +title: BaseCommonDto +pagination_label: BaseCommonDto +sidebar_label: BaseCommonDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BaseCommonDto', 'BaseCommonDto'] +slug: /tools/sdk/powershell/v3/models/base-common-dto +tags: ['SDK', 'Software Development Kit', 'BaseCommonDto', 'BaseCommonDto'] +--- + + +# BaseCommonDto + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$BaseCommonDto = Initialize-PSSailpoint.V3BaseCommonDto -Id id12345 ` + -Name aName ` + -Created 2015-05-28T14:07:17Z ` + -Modified 2015-05-28T14:07:17Z +``` + +- Convert the resource to JSON +```powershell +$BaseCommonDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseDocument.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseDocument.md new file mode 100644 index 000000000..ef61a0c43 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseDocument.md @@ -0,0 +1,39 @@ +--- +id: base-document +title: BaseDocument +pagination_label: BaseDocument +sidebar_label: BaseDocument +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BaseDocument', 'BaseDocument'] +slug: /tools/sdk/powershell/v3/models/base-document +tags: ['SDK', 'Software Development Kit', 'BaseDocument', 'BaseDocument'] +--- + + +# BaseDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | [required] +**Name** | **String** | | [required] +**Type** | [**DocumentType**](document-type) | | [required] + +## Examples + +- Prepare the resource +```powershell +$BaseDocument = Initialize-PSSailpoint.V3BaseDocument -Id 2c91808375d8e80a0175e1f88a575222 ` + -Name john.doe ` + -Type null +``` + +- Convert the resource to JSON +```powershell +$BaseDocument | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseEntitlement.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseEntitlement.md new file mode 100644 index 000000000..1f7b1c52e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseEntitlement.md @@ -0,0 +1,49 @@ +--- +id: base-entitlement +title: BaseEntitlement +pagination_label: BaseEntitlement +sidebar_label: BaseEntitlement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BaseEntitlement', 'BaseEntitlement'] +slug: /tools/sdk/powershell/v3/models/base-entitlement +tags: ['SDK', 'Software Development Kit', 'BaseEntitlement', 'BaseEntitlement'] +--- + + +# BaseEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**HasPermissions** | Pointer to **Boolean** | Indicates whether the entitlement has permissions. | [optional] [default to $false] +**Description** | Pointer to **String** | Entitlement's description. | [optional] +**Attribute** | Pointer to **String** | Entitlement attribute's name. | [optional] +**Value** | Pointer to **String** | Entitlement's value. | [optional] +**Schema** | Pointer to **String** | Entitlement's schema. | [optional] +**Privileged** | Pointer to **Boolean** | Indicates whether the entitlement is privileged. | [optional] [default to $false] +**Id** | Pointer to **String** | Entitlement's ID. | [optional] +**Name** | Pointer to **String** | Entitlement's name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$BaseEntitlement = Initialize-PSSailpoint.V3BaseEntitlement -HasPermissions false ` + -Description Cloud engineering ` + -Attribute memberOf ` + -Value CN=Cloud Engineering,DC=sailpoint,DC=COM ` + -Schema group ` + -Privileged false ` + -Id 2c918084575812550157589064f33b89 ` + -Name CN=Cloud Engineering,DC=sailpoint,DC=COM +``` + +- Convert the resource to JSON +```powershell +$BaseEntitlement | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseReferenceDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseReferenceDto.md new file mode 100644 index 000000000..13bd426f1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseReferenceDto.md @@ -0,0 +1,39 @@ +--- +id: base-reference-dto +title: BaseReferenceDto +pagination_label: BaseReferenceDto +sidebar_label: BaseReferenceDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BaseReferenceDto', 'BaseReferenceDto'] +slug: /tools/sdk/powershell/v3/models/base-reference-dto +tags: ['SDK', 'Software Development Kit', 'BaseReferenceDto', 'BaseReferenceDto'] +--- + + +# BaseReferenceDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] + +## Examples + +- Prepare the resource +```powershell +$BaseReferenceDto = Initialize-PSSailpoint.V3BaseReferenceDto -Type null ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$BaseReferenceDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseSegment.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseSegment.md new file mode 100644 index 000000000..bd87b95cf --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BaseSegment.md @@ -0,0 +1,37 @@ +--- +id: base-segment +title: BaseSegment +pagination_label: BaseSegment +sidebar_label: BaseSegment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BaseSegment', 'BaseSegment'] +slug: /tools/sdk/powershell/v3/models/base-segment +tags: ['SDK', 'Software Development Kit', 'BaseSegment', 'BaseSegment'] +--- + + +# BaseSegment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Segment's unique ID. | [optional] +**Name** | Pointer to **String** | Segment's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$BaseSegment = Initialize-PSSailpoint.V3BaseSegment -Id b009b6e3-b56d-41d9-8735-cb532ea0b017 ` + -Name Test Segment +``` + +- Convert the resource to JSON +```powershell +$BaseSegment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/BeforeProvisioningRuleDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BeforeProvisioningRuleDto.md new file mode 100644 index 000000000..3bce9227e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BeforeProvisioningRuleDto.md @@ -0,0 +1,39 @@ +--- +id: before-provisioning-rule-dto +title: BeforeProvisioningRuleDto +pagination_label: BeforeProvisioningRuleDto +sidebar_label: BeforeProvisioningRuleDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BeforeProvisioningRuleDto', 'BeforeProvisioningRuleDto'] +slug: /tools/sdk/powershell/v3/models/before-provisioning-rule-dto +tags: ['SDK', 'Software Development Kit', 'BeforeProvisioningRuleDto', 'BeforeProvisioningRuleDto'] +--- + + +# BeforeProvisioningRuleDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "RULE" ] | Before Provisioning Rule DTO type. | [optional] +**Id** | Pointer to **String** | Before Provisioning Rule ID. | [optional] +**Name** | Pointer to **String** | Rule display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$BeforeProvisioningRuleDto = Initialize-PSSailpoint.V3BeforeProvisioningRuleDto -Type RULE ` + -Id 048eb3d55c5a4758bd07dccb87741c78 ` + -Name Before Provisioning Airtable Rule +``` + +- Convert the resource to JSON +```powershell +$BeforeProvisioningRuleDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Bound.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Bound.md new file mode 100644 index 000000000..ed51ed979 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Bound.md @@ -0,0 +1,37 @@ +--- +id: bound +title: Bound +pagination_label: Bound +sidebar_label: Bound +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Bound', 'Bound'] +slug: /tools/sdk/powershell/v3/models/bound +tags: ['SDK', 'Software Development Kit', 'Bound', 'Bound'] +--- + + +# Bound + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | **String** | The value of the range's endpoint. | [required] +**Inclusive** | Pointer to **Boolean** | Indicates if the endpoint is included in the range. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$Bound = Initialize-PSSailpoint.V3Bound -Value 1 ` + -Inclusive false +``` + +- Convert the resource to JSON +```powershell +$Bound | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/BrandingItem.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BrandingItem.md new file mode 100644 index 000000000..834aa03e5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BrandingItem.md @@ -0,0 +1,49 @@ +--- +id: branding-item +title: BrandingItem +pagination_label: BrandingItem +sidebar_label: BrandingItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BrandingItem', 'BrandingItem'] +slug: /tools/sdk/powershell/v3/models/branding-item +tags: ['SDK', 'Software Development Kit', 'BrandingItem', 'BrandingItem'] +--- + + +# BrandingItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | name of branding item | [optional] +**ProductName** | Pointer to **String** | product name | [optional] +**ActionButtonColor** | Pointer to **String** | hex value of color for action button | [optional] +**ActiveLinkColor** | Pointer to **String** | hex value of color for link | [optional] +**NavigationColor** | Pointer to **String** | hex value of color for navigation bar | [optional] +**EmailFromAddress** | Pointer to **String** | email from address | [optional] +**StandardLogoURL** | Pointer to **String** | url to standard logo | [optional] +**LoginInformationalMessage** | Pointer to **String** | login information message | [optional] + +## Examples + +- Prepare the resource +```powershell +$BrandingItem = Initialize-PSSailpoint.V3BrandingItem -Name default ` + -ProductName product name ` + -ActionButtonColor 0074D9 ` + -ActiveLinkColor 011E69 ` + -NavigationColor 011E69 ` + -EmailFromAddress no-reply@sailpoint.com ` + -StandardLogoURL ` + -LoginInformationalMessage +``` + +- Convert the resource to JSON +```powershell +$BrandingItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/BrandingItemCreate.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BrandingItemCreate.md new file mode 100644 index 000000000..9f91efa91 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BrandingItemCreate.md @@ -0,0 +1,49 @@ +--- +id: branding-item-create +title: BrandingItemCreate +pagination_label: BrandingItemCreate +sidebar_label: BrandingItemCreate +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BrandingItemCreate', 'BrandingItemCreate'] +slug: /tools/sdk/powershell/v3/models/branding-item-create +tags: ['SDK', 'Software Development Kit', 'BrandingItemCreate', 'BrandingItemCreate'] +--- + + +# BrandingItemCreate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | name of branding item | [required] +**ProductName** | **String** | product name | [required] +**ActionButtonColor** | Pointer to **String** | hex value of color for action button | [optional] +**ActiveLinkColor** | Pointer to **String** | hex value of color for link | [optional] +**NavigationColor** | Pointer to **String** | hex value of color for navigation bar | [optional] +**EmailFromAddress** | Pointer to **String** | email from address | [optional] +**LoginInformationalMessage** | Pointer to **String** | login information message | [optional] +**FileStandard** | Pointer to **System.IO.FileInfo** | png file with logo | [optional] + +## Examples + +- Prepare the resource +```powershell +$BrandingItemCreate = Initialize-PSSailpoint.V3BrandingItemCreate -Name custom-branding-item ` + -ProductName product name ` + -ActionButtonColor 0074D9 ` + -ActiveLinkColor 011E69 ` + -NavigationColor 011E69 ` + -EmailFromAddress no-reply@sailpoint.com ` + -LoginInformationalMessage ` + -FileStandard \x00\x00\x00\x02 +``` + +- Convert the resource to JSON +```powershell +$BrandingItemCreate | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/BucketAggregation.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BucketAggregation.md new file mode 100644 index 000000000..7ae944a3d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BucketAggregation.md @@ -0,0 +1,43 @@ +--- +id: bucket-aggregation +title: BucketAggregation +pagination_label: BucketAggregation +sidebar_label: BucketAggregation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BucketAggregation', 'BucketAggregation'] +slug: /tools/sdk/powershell/v3/models/bucket-aggregation +tags: ['SDK', 'Software Development Kit', 'BucketAggregation', 'BucketAggregation'] +--- + + +# BucketAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | The name of the bucket aggregate to be included in the result. | [required] +**Type** | Pointer to [**BucketType**](bucket-type) | | [optional] +**Field** | **String** | The field to bucket on. Prefix the field name with '@' to reference a nested object. | [required] +**Size** | Pointer to **Int32** | Maximum number of buckets to include. | [optional] +**MinDocCount** | Pointer to **Int32** | Minimum number of documents a bucket should have. | [optional] + +## Examples + +- Prepare the resource +```powershell +$BucketAggregation = Initialize-PSSailpoint.V3BucketAggregation -Name Identity Locations ` + -Type null ` + -Field attributes.city ` + -Size 100 ` + -MinDocCount 2 +``` + +- Convert the resource to JSON +```powershell +$BucketAggregation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/BucketType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BucketType.md new file mode 100644 index 000000000..5e9ffaf94 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BucketType.md @@ -0,0 +1,22 @@ +--- +id: bucket-type +title: BucketType +pagination_label: BucketType +sidebar_label: BucketType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BucketType', 'BucketType'] +slug: /tools/sdk/powershell/v3/models/bucket-type +tags: ['SDK', 'Software Development Kit', 'BucketType', 'BucketType'] +--- + + +# BucketType + +## Enum + + +* `TERMS` (value: `"TERMS"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/BulkAddTaggedObject.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BulkAddTaggedObject.md new file mode 100644 index 000000000..eac1d3682 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BulkAddTaggedObject.md @@ -0,0 +1,39 @@ +--- +id: bulk-add-tagged-object +title: BulkAddTaggedObject +pagination_label: BulkAddTaggedObject +sidebar_label: BulkAddTaggedObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BulkAddTaggedObject', 'BulkAddTaggedObject'] +slug: /tools/sdk/powershell/v3/models/bulk-add-tagged-object +tags: ['SDK', 'Software Development Kit', 'BulkAddTaggedObject', 'BulkAddTaggedObject'] +--- + + +# BulkAddTaggedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectRefs** | Pointer to [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] +**Tags** | Pointer to **[]String** | Label to be applied to an Object | [optional] +**Operation** | Pointer to **Enum** [ "APPEND", "MERGE" ] | If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. | [optional] [default to "APPEND"] + +## Examples + +- Prepare the resource +```powershell +$BulkAddTaggedObject = Initialize-PSSailpoint.V3BulkAddTaggedObject -ObjectRefs null ` + -Tags [BU_FINANCE, PCI] ` + -Operation MERGE +``` + +- Convert the resource to JSON +```powershell +$BulkAddTaggedObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/BulkRemoveTaggedObject.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BulkRemoveTaggedObject.md new file mode 100644 index 000000000..814bcc845 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BulkRemoveTaggedObject.md @@ -0,0 +1,37 @@ +--- +id: bulk-remove-tagged-object +title: BulkRemoveTaggedObject +pagination_label: BulkRemoveTaggedObject +sidebar_label: BulkRemoveTaggedObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BulkRemoveTaggedObject', 'BulkRemoveTaggedObject'] +slug: /tools/sdk/powershell/v3/models/bulk-remove-tagged-object +tags: ['SDK', 'Software Development Kit', 'BulkRemoveTaggedObject', 'BulkRemoveTaggedObject'] +--- + + +# BulkRemoveTaggedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectRefs** | Pointer to [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] +**Tags** | Pointer to **[]String** | Label to be applied to an Object | [optional] + +## Examples + +- Prepare the resource +```powershell +$BulkRemoveTaggedObject = Initialize-PSSailpoint.V3BulkRemoveTaggedObject -ObjectRefs null ` + -Tags [BU_FINANCE, PCI] +``` + +- Convert the resource to JSON +```powershell +$BulkRemoveTaggedObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/BulkTaggedObjectResponse.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BulkTaggedObjectResponse.md new file mode 100644 index 000000000..5b41f8732 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/BulkTaggedObjectResponse.md @@ -0,0 +1,37 @@ +--- +id: bulk-tagged-object-response +title: BulkTaggedObjectResponse +pagination_label: BulkTaggedObjectResponse +sidebar_label: BulkTaggedObjectResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'BulkTaggedObjectResponse', 'BulkTaggedObjectResponse'] +slug: /tools/sdk/powershell/v3/models/bulk-tagged-object-response +tags: ['SDK', 'Software Development Kit', 'BulkTaggedObjectResponse', 'BulkTaggedObjectResponse'] +--- + + +# BulkTaggedObjectResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectRefs** | Pointer to [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] +**Tags** | Pointer to **[]String** | Label to be applied to an Object | [optional] + +## Examples + +- Prepare the resource +```powershell +$BulkTaggedObjectResponse = Initialize-PSSailpoint.V3BulkTaggedObjectResponse -ObjectRefs null ` + -Tags [BU_FINANCE, PCI] +``` + +- Convert the resource to JSON +```powershell +$BulkTaggedObjectResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Campaign.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Campaign.md new file mode 100644 index 000000000..08ae56c1b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Campaign.md @@ -0,0 +1,79 @@ +--- +id: campaign +title: Campaign +pagination_label: Campaign +sidebar_label: Campaign +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Campaign', 'Campaign'] +slug: /tools/sdk/powershell/v3/models/campaign +tags: ['SDK', 'Software Development Kit', 'Campaign', 'Campaign'] +--- + + +# Campaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the campaign | [optional] [readonly] +**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Deadline** | Pointer to **System.DateTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required] +**EmailNotificationEnabled** | Pointer to **Boolean** | Enables email notification for this campaign | [optional] [default to $false] +**AutoRevokeAllowed** | Pointer to **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] +**RecommendationsEnabled** | Pointer to **Boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to $false] +**Status** | Pointer to **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **System.DateTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **Int32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | Modified time of the campaign | [optional] [readonly] +**VarFilter** | Pointer to [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | Pointer to **Boolean** | Determines if comments on sunset date changes are required. | [optional] [default to $true] +**SourceOwnerCampaignInfo** | Pointer to [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | Pointer to [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | Pointer to [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | Pointer to [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | Pointer to [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \""orphan entitlements\"" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**MandatoryCommentRequirement** | Pointer to **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Campaign = Initialize-PSSailpoint.V3Campaign -Id 2c9079b270a266a60170a2779fcb0007 ` + -Name Manager Campaign ` + -Description Everyone needs to be reviewed by their manager ` + -Deadline 2020-03-15T10:00:01.456Z ` + -Type MANAGER ` + -EmailNotificationEnabled false ` + -AutoRevokeAllowed false ` + -RecommendationsEnabled true ` + -Status ACTIVE ` + -CorrelatedStatus CORRELATED ` + -Created 2020-03-03T22:15:13.611Z ` + -TotalCertifications 100 ` + -CompletedCertifications 10 ` + -Alerts null ` + -Modified 2020-03-03T22:20:12.674Z ` + -VarFilter null ` + -SunsetCommentsRequired true ` + -SourceOwnerCampaignInfo null ` + -SearchCampaignInfo null ` + -RoleCompositionCampaignInfo null ` + -MachineAccountCampaignInfo null ` + -SourcesWithOrphanEntitlements null ` + -MandatoryCommentRequirement NO_DECISIONS +``` + +- Convert the resource to JSON +```powershell +$Campaign | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAlert.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAlert.md new file mode 100644 index 000000000..b6ecf9c16 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAlert.md @@ -0,0 +1,37 @@ +--- +id: campaign-alert +title: CampaignAlert +pagination_label: CampaignAlert +sidebar_label: CampaignAlert +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAlert', 'CampaignAlert'] +slug: /tools/sdk/powershell/v3/models/campaign-alert +tags: ['SDK', 'Software Development Kit', 'CampaignAlert', 'CampaignAlert'] +--- + + +# CampaignAlert + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Level** | Pointer to **Enum** [ "ERROR", "WARN", "INFO" ] | Denotes the level of the message | [optional] +**Localizations** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignAlert = Initialize-PSSailpoint.V3CampaignAlert -Level ERROR ` + -Localizations null +``` + +- Convert the resource to JSON +```powershell +$CampaignAlert | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAllOfFilter.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAllOfFilter.md new file mode 100644 index 000000000..72f87c6f7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAllOfFilter.md @@ -0,0 +1,39 @@ +--- +id: campaign-all-of-filter +title: CampaignAllOfFilter +pagination_label: CampaignAllOfFilter +sidebar_label: CampaignAllOfFilter +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAllOfFilter', 'CampaignAllOfFilter'] +slug: /tools/sdk/powershell/v3/models/campaign-all-of-filter +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfFilter', 'CampaignAllOfFilter'] +--- + + +# CampaignAllOfFilter + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of whatever type of filter is being used. | [optional] +**Type** | Pointer to **Enum** [ "CAMPAIGN_FILTER", "RULE" ] | Type of the filter | [optional] +**Name** | Pointer to **String** | Name of the filter | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignAllOfFilter = Initialize-PSSailpoint.V3CampaignAllOfFilter -Id 0fbe863c063c4c88a35fd7f17e8a3df5 ` + -Type CAMPAIGN_FILTER ` + -Name Test Filter +``` + +- Convert the resource to JSON +```powershell +$CampaignAllOfFilter | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAllOfMachineAccountCampaignInfo.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAllOfMachineAccountCampaignInfo.md new file mode 100644 index 000000000..afc8747d0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAllOfMachineAccountCampaignInfo.md @@ -0,0 +1,37 @@ +--- +id: campaign-all-of-machine-account-campaign-info +title: CampaignAllOfMachineAccountCampaignInfo +pagination_label: CampaignAllOfMachineAccountCampaignInfo +sidebar_label: CampaignAllOfMachineAccountCampaignInfo +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAllOfMachineAccountCampaignInfo', 'CampaignAllOfMachineAccountCampaignInfo'] +slug: /tools/sdk/powershell/v3/models/campaign-all-of-machine-account-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfMachineAccountCampaignInfo', 'CampaignAllOfMachineAccountCampaignInfo'] +--- + + +# CampaignAllOfMachineAccountCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceIds** | Pointer to **[]String** | The list of sources to be included in the campaign. | [optional] +**ReviewerType** | Pointer to **Enum** [ "ACCOUNT_OWNER" ] | The reviewer's type. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignAllOfMachineAccountCampaignInfo = Initialize-PSSailpoint.V3CampaignAllOfMachineAccountCampaignInfo -SourceIds [0fbe863c063c4c88a35fd7f17e8a3df5] ` + -ReviewerType ACCOUNT_OWNER +``` + +- Convert the resource to JSON +```powershell +$CampaignAllOfMachineAccountCampaignInfo | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAllOfRoleCompositionCampaignInfo.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAllOfRoleCompositionCampaignInfo.md new file mode 100644 index 000000000..8faeb7939 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAllOfRoleCompositionCampaignInfo.md @@ -0,0 +1,43 @@ +--- +id: campaign-all-of-role-composition-campaign-info +title: CampaignAllOfRoleCompositionCampaignInfo +pagination_label: CampaignAllOfRoleCompositionCampaignInfo +sidebar_label: CampaignAllOfRoleCompositionCampaignInfo +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAllOfRoleCompositionCampaignInfo', 'CampaignAllOfRoleCompositionCampaignInfo'] +slug: /tools/sdk/powershell/v3/models/campaign-all-of-role-composition-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfRoleCompositionCampaignInfo', 'CampaignAllOfRoleCompositionCampaignInfo'] +--- + + +# CampaignAllOfRoleCompositionCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Reviewer** | Pointer to [**CampaignAllOfSearchCampaignInfoReviewer**](campaign-all-of-search-campaign-info-reviewer) | | [optional] +**RoleIds** | Pointer to **[]String** | Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. | [optional] +**RemediatorRef** | [**CampaignAllOfRoleCompositionCampaignInfoRemediatorRef**](campaign-all-of-role-composition-campaign-info-remediator-ref) | | [required] +**Query** | Pointer to **String** | Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. | [optional] +**Description** | Pointer to **String** | Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignAllOfRoleCompositionCampaignInfo = Initialize-PSSailpoint.V3CampaignAllOfRoleCompositionCampaignInfo -Reviewer null ` + -RoleIds [2c90ad2a70ace7d50170acf22ca90010] ` + -RemediatorRef null ` + -Query Search Query ` + -Description Role Composition Description +``` + +- Convert the resource to JSON +```powershell +$CampaignAllOfRoleCompositionCampaignInfo | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md new file mode 100644 index 000000000..068824309 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md @@ -0,0 +1,39 @@ +--- +id: campaign-all-of-role-composition-campaign-info-remediator-ref +title: CampaignAllOfRoleCompositionCampaignInfoRemediatorRef +pagination_label: CampaignAllOfRoleCompositionCampaignInfoRemediatorRef +sidebar_label: CampaignAllOfRoleCompositionCampaignInfoRemediatorRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAllOfRoleCompositionCampaignInfoRemediatorRef', 'CampaignAllOfRoleCompositionCampaignInfoRemediatorRef'] +slug: /tools/sdk/powershell/v3/models/campaign-all-of-role-composition-campaign-info-remediator-ref +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfRoleCompositionCampaignInfoRemediatorRef', 'CampaignAllOfRoleCompositionCampaignInfoRemediatorRef'] +--- + + +# CampaignAllOfRoleCompositionCampaignInfoRemediatorRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | Legal Remediator Type | [required] +**Id** | **String** | The ID of the remediator. | [required] +**Name** | Pointer to **String** | The name of the remediator. | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$CampaignAllOfRoleCompositionCampaignInfoRemediatorRef = Initialize-PSSailpoint.V3CampaignAllOfRoleCompositionCampaignInfoRemediatorRef -Type IDENTITY ` + -Id 2c90ad2a70ace7d50170acf22ca90010 ` + -Name Role Admin +``` + +- Convert the resource to JSON +```powershell +$CampaignAllOfRoleCompositionCampaignInfoRemediatorRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAllOfSearchCampaignInfo.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAllOfSearchCampaignInfo.md new file mode 100644 index 000000000..ff1a6c7fe --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAllOfSearchCampaignInfo.md @@ -0,0 +1,45 @@ +--- +id: campaign-all-of-search-campaign-info +title: CampaignAllOfSearchCampaignInfo +pagination_label: CampaignAllOfSearchCampaignInfo +sidebar_label: CampaignAllOfSearchCampaignInfo +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAllOfSearchCampaignInfo', 'CampaignAllOfSearchCampaignInfo'] +slug: /tools/sdk/powershell/v3/models/campaign-all-of-search-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSearchCampaignInfo', 'CampaignAllOfSearchCampaignInfo'] +--- + + +# CampaignAllOfSearchCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY", "ACCESS" ] | The type of search campaign represented. | [required] +**Description** | Pointer to **String** | Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available. | [optional] +**Reviewer** | Pointer to [**CampaignAllOfSearchCampaignInfoReviewer**](campaign-all-of-search-campaign-info-reviewer) | | [optional] +**Query** | Pointer to **String** | The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set. | [optional] +**IdentityIds** | Pointer to **[]String** | A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set. | [optional] +**AccessConstraints** | Pointer to [**[]AccessConstraint**](access-constraint) | Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignAllOfSearchCampaignInfo = Initialize-PSSailpoint.V3CampaignAllOfSearchCampaignInfo -Type ACCESS ` + -Description Search Campaign description ` + -Reviewer null ` + -Query Search Campaign query description ` + -IdentityIds [0fbe863c063c4c88a35fd7f17e8a3df5] ` + -AccessConstraints null +``` + +- Convert the resource to JSON +```powershell +$CampaignAllOfSearchCampaignInfo | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAllOfSearchCampaignInfoReviewer.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAllOfSearchCampaignInfoReviewer.md new file mode 100644 index 000000000..e1f493e59 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAllOfSearchCampaignInfoReviewer.md @@ -0,0 +1,39 @@ +--- +id: campaign-all-of-search-campaign-info-reviewer +title: CampaignAllOfSearchCampaignInfoReviewer +pagination_label: CampaignAllOfSearchCampaignInfoReviewer +sidebar_label: CampaignAllOfSearchCampaignInfoReviewer +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAllOfSearchCampaignInfoReviewer', 'CampaignAllOfSearchCampaignInfoReviewer'] +slug: /tools/sdk/powershell/v3/models/campaign-all-of-search-campaign-info-reviewer +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSearchCampaignInfoReviewer', 'CampaignAllOfSearchCampaignInfoReviewer'] +--- + + +# CampaignAllOfSearchCampaignInfoReviewer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP", "IDENTITY" ] | The reviewer's DTO type. | [optional] +**Id** | Pointer to **String** | The reviewer's ID. | [optional] +**Name** | Pointer to **String** | The reviewer's name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignAllOfSearchCampaignInfoReviewer = Initialize-PSSailpoint.V3CampaignAllOfSearchCampaignInfoReviewer -Type IDENTITY ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$CampaignAllOfSearchCampaignInfoReviewer | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAllOfSourceOwnerCampaignInfo.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAllOfSourceOwnerCampaignInfo.md new file mode 100644 index 000000000..f2663d2af --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAllOfSourceOwnerCampaignInfo.md @@ -0,0 +1,35 @@ +--- +id: campaign-all-of-source-owner-campaign-info +title: CampaignAllOfSourceOwnerCampaignInfo +pagination_label: CampaignAllOfSourceOwnerCampaignInfo +sidebar_label: CampaignAllOfSourceOwnerCampaignInfo +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAllOfSourceOwnerCampaignInfo', 'CampaignAllOfSourceOwnerCampaignInfo'] +slug: /tools/sdk/powershell/v3/models/campaign-all-of-source-owner-campaign-info +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSourceOwnerCampaignInfo', 'CampaignAllOfSourceOwnerCampaignInfo'] +--- + + +# CampaignAllOfSourceOwnerCampaignInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceIds** | Pointer to **[]String** | The list of sources to be included in the campaign. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignAllOfSourceOwnerCampaignInfo = Initialize-PSSailpoint.V3CampaignAllOfSourceOwnerCampaignInfo -SourceIds [0fbe863c063c4c88a35fd7f17e8a3df5] +``` + +- Convert the resource to JSON +```powershell +$CampaignAllOfSourceOwnerCampaignInfo | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAllOfSourcesWithOrphanEntitlements.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAllOfSourcesWithOrphanEntitlements.md new file mode 100644 index 000000000..616beeab0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignAllOfSourcesWithOrphanEntitlements.md @@ -0,0 +1,39 @@ +--- +id: campaign-all-of-sources-with-orphan-entitlements +title: CampaignAllOfSourcesWithOrphanEntitlements +pagination_label: CampaignAllOfSourcesWithOrphanEntitlements +sidebar_label: CampaignAllOfSourcesWithOrphanEntitlements +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAllOfSourcesWithOrphanEntitlements', 'CampaignAllOfSourcesWithOrphanEntitlements'] +slug: /tools/sdk/powershell/v3/models/campaign-all-of-sources-with-orphan-entitlements +tags: ['SDK', 'Software Development Kit', 'CampaignAllOfSourcesWithOrphanEntitlements', 'CampaignAllOfSourcesWithOrphanEntitlements'] +--- + + +# CampaignAllOfSourcesWithOrphanEntitlements + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the source | [optional] +**Type** | Pointer to **Enum** [ "SOURCE" ] | Type | [optional] +**Name** | Pointer to **String** | Name of the source | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignAllOfSourcesWithOrphanEntitlements = Initialize-PSSailpoint.V3CampaignAllOfSourcesWithOrphanEntitlements -Id 2c90ad2a70ace7d50170acf22ca90010 ` + -Type SOURCE ` + -Name Source with orphan entitlements +``` + +- Convert the resource to JSON +```powershell +$CampaignAllOfSourcesWithOrphanEntitlements | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignCompleteOptions.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignCompleteOptions.md new file mode 100644 index 000000000..e9c6ff829 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignCompleteOptions.md @@ -0,0 +1,35 @@ +--- +id: campaign-complete-options +title: CampaignCompleteOptions +pagination_label: CampaignCompleteOptions +sidebar_label: CampaignCompleteOptions +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignCompleteOptions', 'CampaignCompleteOptions'] +slug: /tools/sdk/powershell/v3/models/campaign-complete-options +tags: ['SDK', 'Software Development Kit', 'CampaignCompleteOptions', 'CampaignCompleteOptions'] +--- + + +# CampaignCompleteOptions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AutoCompleteAction** | Pointer to **Enum** [ "APPROVE", "REVOKE" ] | Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion. | [optional] [default to "APPROVE"] + +## Examples + +- Prepare the resource +```powershell +$CampaignCompleteOptions = Initialize-PSSailpoint.V3CampaignCompleteOptions -AutoCompleteAction REVOKE +``` + +- Convert the resource to JSON +```powershell +$CampaignCompleteOptions | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignFilterDetails.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignFilterDetails.md new file mode 100644 index 000000000..2939432ea --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignFilterDetails.md @@ -0,0 +1,47 @@ +--- +id: campaign-filter-details +title: CampaignFilterDetails +pagination_label: CampaignFilterDetails +sidebar_label: CampaignFilterDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignFilterDetails', 'CampaignFilterDetails'] +slug: /tools/sdk/powershell/v3/models/campaign-filter-details +tags: ['SDK', 'Software Development Kit', 'CampaignFilterDetails', 'CampaignFilterDetails'] +--- + + +# CampaignFilterDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the campaign filter | [required] +**Name** | **String** | Campaign filter name. | [required] +**Description** | Pointer to **String** | Campaign filter description. | [optional] +**Owner** | **String** | Owner of the filter. This field automatically populates at creation time with the current user. | [required] +**Mode** | **Enum** [ "INCLUSION", "EXCLUSION" ] | Mode/type of filter, either the INCLUSION or EXCLUSION type. The INCLUSION type includes the data in generated campaigns as per specified in the criteria, whereas the EXCLUSION type excludes the data in generated campaigns as per specified in criteria. | [required] +**CriteriaList** | Pointer to [**[]CampaignFilterDetailsCriteriaListInner**](campaign-filter-details-criteria-list-inner) | List of criteria. | [optional] +**IsSystemFilter** | **Boolean** | If true, the filter is created by the system. If false, the filter is created by a user. | [required][default to $false] + +## Examples + +- Prepare the resource +```powershell +$CampaignFilterDetails = Initialize-PSSailpoint.V3CampaignFilterDetails -Id 5ec18cef39020d6fd7a60ad3970aba61 ` + -Name Identity Attribute Campaign Filter ` + -Description Campaign filter to certify data based on an identity attribute's specified property. ` + -Owner SailPoint Support ` + -Mode INCLUSION ` + -CriteriaList [{type=IDENTITY_ATTRIBUTE, property=displayName, value=support, operation=CONTAINS, negateResult=false, shortCircuit=false, recordChildMatches=false, id=null, suppressMatchedItems=false, children=null}] ` + -IsSystemFilter false +``` + +- Convert the resource to JSON +```powershell +$CampaignFilterDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignFilterDetailsCriteriaListInner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignFilterDetailsCriteriaListInner.md new file mode 100644 index 000000000..8c08c1e0d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignFilterDetailsCriteriaListInner.md @@ -0,0 +1,41 @@ +--- +id: campaign-filter-details-criteria-list-inner +title: CampaignFilterDetailsCriteriaListInner +pagination_label: CampaignFilterDetailsCriteriaListInner +sidebar_label: CampaignFilterDetailsCriteriaListInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignFilterDetailsCriteriaListInner', 'CampaignFilterDetailsCriteriaListInner'] +slug: /tools/sdk/powershell/v3/models/campaign-filter-details-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'CampaignFilterDetailsCriteriaListInner', 'CampaignFilterDetailsCriteriaListInner'] +--- + + +# CampaignFilterDetailsCriteriaListInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**CriteriaType**](criteria-type) | | [required] +**Operation** | [**Operation**](operation) | | [required] +**Property** | **String** | Specified key from the type of criteria. | [required] +**Value** | **String** | Value for the specified key from the type of criteria. | [required] + +## Examples + +- Prepare the resource +```powershell +$CampaignFilterDetailsCriteriaListInner = Initialize-PSSailpoint.V3CampaignFilterDetailsCriteriaListInner -Type null ` + -Operation null ` + -Property displayName ` + -Value Allie +``` + +- Convert the resource to JSON +```powershell +$CampaignFilterDetailsCriteriaListInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignReference.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignReference.md new file mode 100644 index 000000000..7aee6b570 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignReference.md @@ -0,0 +1,47 @@ +--- +id: campaign-reference +title: CampaignReference +pagination_label: CampaignReference +sidebar_label: CampaignReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignReference', 'CampaignReference'] +slug: /tools/sdk/powershell/v3/models/campaign-reference +tags: ['SDK', 'Software Development Kit', 'CampaignReference', 'CampaignReference'] +--- + + +# CampaignReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the campaign. | [required] +**Name** | **String** | The name of the campaign. | [required] +**Type** | **Enum** [ "CAMPAIGN" ] | The type of object that is being referenced. | [required] +**CampaignType** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH" ] | The type of the campaign. | [required] +**Description** | **String** | The description of the campaign set by the admin who created it. | [required] +**CorrelatedStatus** | **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [required] +**MandatoryCommentRequirement** | **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [required] + +## Examples + +- Prepare the resource +```powershell +$CampaignReference = Initialize-PSSailpoint.V3CampaignReference -Id ef38f94347e94562b5bb8424a56397d8 ` + -Name Campaign Name ` + -Type CAMPAIGN ` + -CampaignType MANAGER ` + -Description A description of the campaign ` + -CorrelatedStatus CORRELATED ` + -MandatoryCommentRequirement NO_DECISIONS +``` + +- Convert the resource to JSON +```powershell +$CampaignReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignReport.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignReport.md new file mode 100644 index 000000000..1c4656df4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignReport.md @@ -0,0 +1,45 @@ +--- +id: campaign-report +title: CampaignReport +pagination_label: CampaignReport +sidebar_label: CampaignReport +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignReport', 'CampaignReport'] +slug: /tools/sdk/powershell/v3/models/campaign-report +tags: ['SDK', 'Software Development Kit', 'CampaignReport', 'CampaignReport'] +--- + + +# CampaignReport + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "REPORT_RESULT" ] | SOD policy violation report result DTO type. | [optional] +**Id** | Pointer to **String** | SOD policy violation report result ID. | [optional] +**Name** | Pointer to **String** | Human-readable name of the SOD policy violation report result. | [optional] +**Status** | Pointer to **Enum** [ "SUCCESS", "WARNING", "ERROR", "TERMINATED", "TEMP_ERROR", "PENDING" ] | Status of a SOD policy violation report. | [optional] +**ReportType** | [**ReportType**](report-type) | | [required] +**LastRunAt** | Pointer to **System.DateTime** | The most recent date and time this report was run | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$CampaignReport = Initialize-PSSailpoint.V3CampaignReport -Type REPORT_RESULT ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name SOD Policy 1 Violation ` + -Status PENDING ` + -ReportType null ` + -LastRunAt null +``` + +- Convert the resource to JSON +```powershell +$CampaignReport | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignReportsConfig.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignReportsConfig.md new file mode 100644 index 000000000..03304a999 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignReportsConfig.md @@ -0,0 +1,35 @@ +--- +id: campaign-reports-config +title: CampaignReportsConfig +pagination_label: CampaignReportsConfig +sidebar_label: CampaignReportsConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignReportsConfig', 'CampaignReportsConfig'] +slug: /tools/sdk/powershell/v3/models/campaign-reports-config +tags: ['SDK', 'Software Development Kit', 'CampaignReportsConfig', 'CampaignReportsConfig'] +--- + + +# CampaignReportsConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityAttributeColumns** | Pointer to **[]String** | list of identity attribute columns | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignReportsConfig = Initialize-PSSailpoint.V3CampaignReportsConfig -IdentityAttributeColumns [firstname, lastname] +``` + +- Convert the resource to JSON +```powershell +$CampaignReportsConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignTemplate.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignTemplate.md new file mode 100644 index 000000000..d7abc0778 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignTemplate.md @@ -0,0 +1,51 @@ +--- +id: campaign-template +title: CampaignTemplate +pagination_label: CampaignTemplate +sidebar_label: CampaignTemplate +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignTemplate', 'CampaignTemplate'] +slug: /tools/sdk/powershell/v3/models/campaign-template +tags: ['SDK', 'Software Development Kit', 'CampaignTemplate', 'CampaignTemplate'] +--- + + +# CampaignTemplate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the campaign template | [optional] +**Name** | **String** | This template's name. Has no bearing on generated campaigns' names. | [required] +**Description** | **String** | This template's description. Has no bearing on generated campaigns' descriptions. | [required] +**Created** | **System.DateTime** | Creation date of Campaign Template | [required][readonly] +**Modified** | **System.DateTime** | Modification date of Campaign Template | [required][readonly] +**Scheduled** | Pointer to **Boolean** | Indicates if this campaign template has been scheduled. | [optional] [readonly] [default to $false] +**OwnerRef** | Pointer to [**CampaignTemplateOwnerRef**](campaign-template-owner-ref) | | [optional] +**DeadlineDuration** | Pointer to **String** | The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign's deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was ""P2W"" (two weeks), the resulting campaign's deadline would be 2020-01-15 (the current date plus 14 days). | [optional] +**Campaign** | [**Campaign**](campaign) | | [required] + +## Examples + +- Prepare the resource +```powershell +$CampaignTemplate = Initialize-PSSailpoint.V3CampaignTemplate -Id 2c9079b270a266a60170a277bb960008 ` + -Name Manager Campaign Template ` + -Description Template for the annual manager campaign. ` + -Created 2020-03-05T22:44:00.364Z ` + -Modified 2020-03-05T22:52:09.969Z ` + -Scheduled false ` + -OwnerRef null ` + -DeadlineDuration P2W ` + -Campaign null +``` + +- Convert the resource to JSON +```powershell +$CampaignTemplate | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignTemplateOwnerRef.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignTemplateOwnerRef.md new file mode 100644 index 000000000..47ad49730 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignTemplateOwnerRef.md @@ -0,0 +1,41 @@ +--- +id: campaign-template-owner-ref +title: CampaignTemplateOwnerRef +pagination_label: CampaignTemplateOwnerRef +sidebar_label: CampaignTemplateOwnerRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignTemplateOwnerRef', 'CampaignTemplateOwnerRef'] +slug: /tools/sdk/powershell/v3/models/campaign-template-owner-ref +tags: ['SDK', 'Software Development Kit', 'CampaignTemplateOwnerRef', 'CampaignTemplateOwnerRef'] +--- + + +# CampaignTemplateOwnerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the owner | [optional] +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Type of the owner | [optional] +**Name** | Pointer to **String** | Name of the owner | [optional] +**Email** | Pointer to **String** | Email of the owner | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignTemplateOwnerRef = Initialize-PSSailpoint.V3CampaignTemplateOwnerRef -Id 2c918086676d3e0601677611dbde220f ` + -Type IDENTITY ` + -Name Mister Manager ` + -Email mr.manager@example.com +``` + +- Convert the resource to JSON +```powershell +$CampaignTemplateOwnerRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignsDeleteRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignsDeleteRequest.md new file mode 100644 index 000000000..95b63eade --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CampaignsDeleteRequest.md @@ -0,0 +1,35 @@ +--- +id: campaigns-delete-request +title: CampaignsDeleteRequest +pagination_label: CampaignsDeleteRequest +sidebar_label: CampaignsDeleteRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignsDeleteRequest', 'CampaignsDeleteRequest'] +slug: /tools/sdk/powershell/v3/models/campaigns-delete-request +tags: ['SDK', 'Software Development Kit', 'CampaignsDeleteRequest', 'CampaignsDeleteRequest'] +--- + + +# CampaignsDeleteRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | Pointer to **[]String** | The ids of the campaigns to delete | [optional] + +## Examples + +- Prepare the resource +```powershell +$CampaignsDeleteRequest = Initialize-PSSailpoint.V3CampaignsDeleteRequest -Ids [2c9180887335cee10173490db1776c26, 2c9180836a712436016a7125a90c0021] +``` + +- Convert the resource to JSON +```powershell +$CampaignsDeleteRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CancelAccessRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CancelAccessRequest.md new file mode 100644 index 000000000..08d73a587 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CancelAccessRequest.md @@ -0,0 +1,37 @@ +--- +id: cancel-access-request +title: CancelAccessRequest +pagination_label: CancelAccessRequest +sidebar_label: CancelAccessRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CancelAccessRequest', 'CancelAccessRequest'] +slug: /tools/sdk/powershell/v3/models/cancel-access-request +tags: ['SDK', 'Software Development Kit', 'CancelAccessRequest', 'CancelAccessRequest'] +--- + + +# CancelAccessRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountActivityId** | **String** | This refers to the identityRequestId. To successfully cancel an access request, you must provide the identityRequestId. | [required] +**Comment** | **String** | Reason for cancelling the pending access request. | [required] + +## Examples + +- Prepare the resource +```powershell +$CancelAccessRequest = Initialize-PSSailpoint.V3CancelAccessRequest -AccountActivityId 2c9180835d2e5168015d32f890ca1581 ` + -Comment I requested this role by mistake. +``` + +- Convert the resource to JSON +```powershell +$CancelAccessRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CancelledRequestDetails.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CancelledRequestDetails.md new file mode 100644 index 000000000..16b8f5f26 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CancelledRequestDetails.md @@ -0,0 +1,39 @@ +--- +id: cancelled-request-details +title: CancelledRequestDetails +pagination_label: CancelledRequestDetails +sidebar_label: CancelledRequestDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CancelledRequestDetails', 'CancelledRequestDetails'] +slug: /tools/sdk/powershell/v3/models/cancelled-request-details +tags: ['SDK', 'Software Development Kit', 'CancelledRequestDetails', 'CancelledRequestDetails'] +--- + + +# CancelledRequestDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment made by the owner when cancelling the associated request. | [optional] +**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**Modified** | Pointer to **System.DateTime** | Date comment was added by the owner when cancelling the associated request. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CancelledRequestDetails = Initialize-PSSailpoint.V3CancelledRequestDetails -Comment This request must be cancelled. ` + -Owner null ` + -Modified 2019-12-20T09:17:12.192Z +``` + +- Convert the resource to JSON +```powershell +$CancelledRequestDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Certification.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Certification.md new file mode 100644 index 000000000..83f73946e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Certification.md @@ -0,0 +1,67 @@ +--- +id: certification +title: Certification +pagination_label: Certification +sidebar_label: Certification +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Certification', 'Certification'] +slug: /tools/sdk/powershell/v3/models/certification +tags: ['SDK', 'Software Development Kit', 'Certification', 'Certification'] +--- + + +# Certification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | id of the certification | [optional] +**Name** | Pointer to **String** | name of the certification | [optional] +**Campaign** | Pointer to [**CampaignReference**](campaign-reference) | | [optional] +**Completed** | Pointer to **Boolean** | Have all decisions been made? | [optional] +**IdentitiesCompleted** | Pointer to **Int32** | The number of identities for whom all decisions have been made and are complete. | [optional] +**IdentitiesTotal** | Pointer to **Int32** | The total number of identities in the Certification, both complete and incomplete. | [optional] +**Created** | Pointer to **System.DateTime** | created date | [optional] +**Modified** | Pointer to **System.DateTime** | modified date | [optional] +**DecisionsMade** | Pointer to **Int32** | The number of approve/revoke/acknowledge decisions that have been made. | [optional] +**DecisionsTotal** | Pointer to **Int32** | The total number of approve/revoke/acknowledge decisions. | [optional] +**Due** | Pointer to **System.DateTime** | The due date of the certification. | [optional] +**Signed** | Pointer to **System.DateTime** | The date the reviewer signed off on the Certification. | [optional] +**Reviewer** | Pointer to [**Reviewer**](reviewer) | | [optional] +**Reassignment** | Pointer to [**Reassignment**](reassignment) | | [optional] +**HasErrors** | Pointer to **Boolean** | Identifies if the certification has an error | [optional] +**ErrorMessage** | Pointer to **String** | Description of the certification error | [optional] +**Phase** | Pointer to [**CertificationPhase**](certification-phase) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Certification = Initialize-PSSailpoint.V3Certification -Id 2c9180835d2e5168015d32f890ca1581 ` + -Name Source Owner Access Review for Employees [source] ` + -Campaign null ` + -Completed true ` + -IdentitiesCompleted 5 ` + -IdentitiesTotal 10 ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -DecisionsMade 20 ` + -DecisionsTotal 40 ` + -Due 2018-10-19T13:49:37.385Z ` + -Signed 2018-10-19T13:49:37.385Z ` + -Reviewer null ` + -Reassignment null ` + -HasErrors false ` + -ErrorMessage The certification has an error ` + -Phase null +``` + +- Convert the resource to JSON +```powershell +$Certification | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CertificationDecision.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CertificationDecision.md new file mode 100644 index 000000000..1e456e2d0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CertificationDecision.md @@ -0,0 +1,24 @@ +--- +id: certification-decision +title: CertificationDecision +pagination_label: CertificationDecision +sidebar_label: CertificationDecision +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationDecision', 'CertificationDecision'] +slug: /tools/sdk/powershell/v3/models/certification-decision +tags: ['SDK', 'Software Development Kit', 'CertificationDecision', 'CertificationDecision'] +--- + + +# CertificationDecision + +## Enum + + +* `APPROVE` (value: `"APPROVE"`) + +* `REVOKE` (value: `"REVOKE"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CertificationIdentitySummary.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CertificationIdentitySummary.md new file mode 100644 index 000000000..2c75ddcdf --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CertificationIdentitySummary.md @@ -0,0 +1,41 @@ +--- +id: certification-identity-summary +title: CertificationIdentitySummary +pagination_label: CertificationIdentitySummary +sidebar_label: CertificationIdentitySummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationIdentitySummary', 'CertificationIdentitySummary'] +slug: /tools/sdk/powershell/v3/models/certification-identity-summary +tags: ['SDK', 'Software Development Kit', 'CertificationIdentitySummary', 'CertificationIdentitySummary'] +--- + + +# CertificationIdentitySummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of the identity summary | [optional] +**Name** | Pointer to **String** | Name of the linked identity | [optional] +**IdentityId** | Pointer to **String** | The ID of the identity being certified | [optional] +**Completed** | Pointer to **Boolean** | Indicates whether the review items for the linked identity's certification have been completed | [optional] + +## Examples + +- Prepare the resource +```powershell +$CertificationIdentitySummary = Initialize-PSSailpoint.V3CertificationIdentitySummary -Id 2c91808772a504f50172a9540e501ba7 ` + -Name Alison Ferguso ` + -IdentityId 2c9180857182306001719937377a33de ` + -Completed true +``` + +- Convert the resource to JSON +```powershell +$CertificationIdentitySummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CertificationPhase.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CertificationPhase.md new file mode 100644 index 000000000..8cbfe777a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CertificationPhase.md @@ -0,0 +1,26 @@ +--- +id: certification-phase +title: CertificationPhase +pagination_label: CertificationPhase +sidebar_label: CertificationPhase +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationPhase', 'CertificationPhase'] +slug: /tools/sdk/powershell/v3/models/certification-phase +tags: ['SDK', 'Software Development Kit', 'CertificationPhase', 'CertificationPhase'] +--- + + +# CertificationPhase + +## Enum + + +* `STAGED` (value: `"STAGED"`) + +* `ACTIVE` (value: `"ACTIVE"`) + +* `SIGNED` (value: `"SIGNED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CertificationReference.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CertificationReference.md new file mode 100644 index 000000000..516113e3f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CertificationReference.md @@ -0,0 +1,41 @@ +--- +id: certification-reference +title: CertificationReference +pagination_label: CertificationReference +sidebar_label: CertificationReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationReference', 'CertificationReference'] +slug: /tools/sdk/powershell/v3/models/certification-reference +tags: ['SDK', 'Software Development Kit', 'CertificationReference', 'CertificationReference'] +--- + + +# CertificationReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The id of the certification. | [optional] +**Name** | Pointer to **String** | The name of the certification. | [optional] +**Type** | Pointer to **Enum** [ "CERTIFICATION" ] | | [optional] +**Reviewer** | Pointer to [**Reviewer**](reviewer) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CertificationReference = Initialize-PSSailpoint.V3CertificationReference -Id ef38f94347e94562b5bb8424a56397d8 ` + -Name Certification Name ` + -Type CERTIFICATION ` + -Reviewer null +``` + +- Convert the resource to JSON +```powershell +$CertificationReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CertificationTask.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CertificationTask.md new file mode 100644 index 000000000..266ca9c61 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CertificationTask.md @@ -0,0 +1,49 @@ +--- +id: certification-task +title: CertificationTask +pagination_label: CertificationTask +sidebar_label: CertificationTask +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationTask', 'CertificationTask'] +slug: /tools/sdk/powershell/v3/models/certification-task +tags: ['SDK', 'Software Development Kit', 'CertificationTask', 'CertificationTask'] +--- + + +# CertificationTask + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of the certification task. | [optional] +**Type** | Pointer to **Enum** [ "REASSIGN", "ADMIN_REASSIGN", "COMPLETE_CERTIFICATION", "FINISH_CERTIFICATION", "COMPLETE_CAMPAIGN", "ACTIVATE_CAMPAIGN", "CAMPAIGN_CREATE", "CAMPAIGN_DELETE" ] | The type of the certification task. More values may be added in the future. | [optional] +**TargetType** | Pointer to **Enum** [ "CERTIFICATION", "CAMPAIGN" ] | The type of item that is being operated on by this task whose ID is stored in the targetId field. | [optional] +**TargetId** | Pointer to **String** | The ID of the item being operated on by this task. | [optional] +**Status** | Pointer to **Enum** [ "QUEUED", "IN_PROGRESS", "SUCCESS", "ERROR" ] | The status of the task. | [optional] +**Errors** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | | [optional] +**ReassignmentTrailDTOs** | Pointer to [**[]ReassignmentTrailDTO**](reassignment-trail-dto) | Reassignment trails that lead to self certification identity | [optional] +**Created** | Pointer to **System.DateTime** | The date and time on which this task was created. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CertificationTask = Initialize-PSSailpoint.V3CertificationTask -Id 2c918086719eec070171a7e3355a360a ` + -Type ADMIN_REASSIGN ` + -TargetType CAMPAIGN ` + -TargetId 2c918086719eec070171a7e3355a834c ` + -Status QUEUED ` + -Errors null ` + -ReassignmentTrailDTOs {previousOwner=ef38f94347e94562b5bb8424a56397d8, newOwner=ef38f94347e94562b5bb8424a56397a3, reassignmentType=AUTOMATIC_REASSIGNMENT} ` + -Created 2020-09-24T18:10:47.693Z +``` + +- Convert the resource to JSON +```powershell +$CertificationTask | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ClientLogConfiguration.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ClientLogConfiguration.md new file mode 100644 index 000000000..f0448e31f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ClientLogConfiguration.md @@ -0,0 +1,43 @@ +--- +id: client-log-configuration +title: ClientLogConfiguration +pagination_label: ClientLogConfiguration +sidebar_label: ClientLogConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ClientLogConfiguration', 'ClientLogConfiguration'] +slug: /tools/sdk/powershell/v3/models/client-log-configuration +tags: ['SDK', 'Software Development Kit', 'ClientLogConfiguration', 'ClientLogConfiguration'] +--- + + +# ClientLogConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClientId** | Pointer to **String** | Log configuration's client ID | [optional] +**DurationMinutes** | Pointer to **Int32** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [optional] [default to 240] +**Expiration** | Pointer to **System.DateTime** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [optional] +**RootLevel** | [**StandardLevel**](standard-level) | | [required] +**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] + +## Examples + +- Prepare the resource +```powershell +$ClientLogConfiguration = Initialize-PSSailpoint.V3ClientLogConfiguration -ClientId 3a38a51992e8445ab51a549c0a70ee66 ` + -DurationMinutes 120 ` + -Expiration 2024-11-06T01:31:08.013164Z ` + -RootLevel null ` + -LogLevels INFO +``` + +- Convert the resource to JSON +```powershell +$ClientLogConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ClientLogConfigurationDurationMinutes.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ClientLogConfigurationDurationMinutes.md new file mode 100644 index 000000000..9213e21bb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ClientLogConfigurationDurationMinutes.md @@ -0,0 +1,41 @@ +--- +id: client-log-configuration-duration-minutes +title: ClientLogConfigurationDurationMinutes +pagination_label: ClientLogConfigurationDurationMinutes +sidebar_label: ClientLogConfigurationDurationMinutes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ClientLogConfigurationDurationMinutes', 'ClientLogConfigurationDurationMinutes'] +slug: /tools/sdk/powershell/v3/models/client-log-configuration-duration-minutes +tags: ['SDK', 'Software Development Kit', 'ClientLogConfigurationDurationMinutes', 'ClientLogConfigurationDurationMinutes'] +--- + + +# ClientLogConfigurationDurationMinutes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClientId** | Pointer to **String** | Log configuration's client ID | [optional] +**DurationMinutes** | Pointer to **Int32** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [optional] [default to 240] +**RootLevel** | [**StandardLevel**](standard-level) | | [required] +**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] + +## Examples + +- Prepare the resource +```powershell +$ClientLogConfigurationDurationMinutes = Initialize-PSSailpoint.V3ClientLogConfigurationDurationMinutes -ClientId 3a38a51992e8445ab51a549c0a70ee66 ` + -DurationMinutes 120 ` + -RootLevel null ` + -LogLevels INFO +``` + +- Convert the resource to JSON +```powershell +$ClientLogConfigurationDurationMinutes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ClientLogConfigurationExpiration.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ClientLogConfigurationExpiration.md new file mode 100644 index 000000000..9f0549140 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ClientLogConfigurationExpiration.md @@ -0,0 +1,41 @@ +--- +id: client-log-configuration-expiration +title: ClientLogConfigurationExpiration +pagination_label: ClientLogConfigurationExpiration +sidebar_label: ClientLogConfigurationExpiration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ClientLogConfigurationExpiration', 'ClientLogConfigurationExpiration'] +slug: /tools/sdk/powershell/v3/models/client-log-configuration-expiration +tags: ['SDK', 'Software Development Kit', 'ClientLogConfigurationExpiration', 'ClientLogConfigurationExpiration'] +--- + + +# ClientLogConfigurationExpiration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClientId** | Pointer to **String** | Log configuration's client ID | [optional] +**Expiration** | Pointer to **System.DateTime** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [optional] +**RootLevel** | [**StandardLevel**](standard-level) | | [required] +**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] + +## Examples + +- Prepare the resource +```powershell +$ClientLogConfigurationExpiration = Initialize-PSSailpoint.V3ClientLogConfigurationExpiration -ClientId 3a38a51992e8445ab51a549c0a70ee66 ` + -Expiration 2024-11-06T01:31:08.013164Z ` + -RootLevel null ` + -LogLevels INFO +``` + +- Convert the resource to JSON +```powershell +$ClientLogConfigurationExpiration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ClientType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ClientType.md new file mode 100644 index 000000000..0f3e7d1fd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ClientType.md @@ -0,0 +1,24 @@ +--- +id: client-type +title: ClientType +pagination_label: ClientType +sidebar_label: ClientType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ClientType', 'ClientType'] +slug: /tools/sdk/powershell/v3/models/client-type +tags: ['SDK', 'Software Development Kit', 'ClientType', 'ClientType'] +--- + + +# ClientType + +## Enum + + +* `CONFIDENTIAL` (value: `"CONFIDENTIAL"`) + +* `PUBLIC` (value: `"PUBLIC"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Column.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Column.md new file mode 100644 index 000000000..01e4330f0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Column.md @@ -0,0 +1,37 @@ +--- +id: column +title: Column +pagination_label: Column +sidebar_label: Column +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Column', 'Column'] +slug: /tools/sdk/powershell/v3/models/column +tags: ['SDK', 'Software Development Kit', 'Column', 'Column'] +--- + + +# Column + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Field** | **String** | The name of the field. | [required] +**Header** | Pointer to **String** | The value of the header. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Column = Initialize-PSSailpoint.V3Column -Field email ` + -Header Work Email +``` + +- Convert the resource to JSON +```powershell +$Column | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Comment.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Comment.md new file mode 100644 index 000000000..ddfb3d74f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Comment.md @@ -0,0 +1,41 @@ +--- +id: comment +title: Comment +pagination_label: Comment +sidebar_label: Comment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Comment', 'Comment'] +slug: /tools/sdk/powershell/v3/models/comment +tags: ['SDK', 'Software Development Kit', 'Comment', 'Comment'] +--- + + +# Comment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommenterId** | Pointer to **String** | Id of the identity making the comment | [optional] +**CommenterName** | Pointer to **String** | Human-readable display name of the identity making the comment | [optional] +**Body** | Pointer to **String** | Content of the comment | [optional] +**Date** | Pointer to **System.DateTime** | Date and time comment was made | [optional] + +## Examples + +- Prepare the resource +```powershell +$Comment = Initialize-PSSailpoint.V3Comment -CommenterId 2c918084660f45d6016617daa9210584 ` + -CommenterName Adam Kennedy ` + -Body Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat. ` + -Date 2017-07-11T18:45:37.098Z +``` + +- Convert the resource to JSON +```powershell +$Comment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CommentDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CommentDto.md new file mode 100644 index 000000000..ce2a52c12 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CommentDto.md @@ -0,0 +1,39 @@ +--- +id: comment-dto +title: CommentDto +pagination_label: CommentDto +sidebar_label: CommentDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CommentDto', 'CommentDto'] +slug: /tools/sdk/powershell/v3/models/comment-dto +tags: ['SDK', 'Software Development Kit', 'CommentDto', 'CommentDto'] +--- + + +# CommentDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment content. | [optional] +**Created** | Pointer to **System.DateTime** | Date and time comment was created. | [optional] +**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CommentDto = Initialize-PSSailpoint.V3CommentDto -Comment This is a comment. ` + -Created 2017-07-11T18:45:37.098Z ` + -Author null +``` + +- Convert the resource to JSON +```powershell +$CommentDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CommentDtoAuthor.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CommentDtoAuthor.md new file mode 100644 index 000000000..10ef9422c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CommentDtoAuthor.md @@ -0,0 +1,39 @@ +--- +id: comment-dto-author +title: CommentDtoAuthor +pagination_label: CommentDtoAuthor +sidebar_label: CommentDtoAuthor +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CommentDtoAuthor', 'CommentDtoAuthor'] +slug: /tools/sdk/powershell/v3/models/comment-dto-author +tags: ['SDK', 'Software Development Kit', 'CommentDtoAuthor', 'CommentDtoAuthor'] +--- + + +# CommentDtoAuthor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of object | [optional] +**Id** | Pointer to **String** | The unique ID of the object | [optional] +**Name** | Pointer to **String** | The display name of the object | [optional] + +## Examples + +- Prepare the resource +```powershell +$CommentDtoAuthor = Initialize-PSSailpoint.V3CommentDtoAuthor -Type IDENTITY ` + -Id 2c9180847e25f377017e2ae8cae4650b ` + -Name john.doe +``` + +- Convert the resource to JSON +```powershell +$CommentDtoAuthor | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CompletedApproval.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CompletedApproval.md new file mode 100644 index 000000000..98abae475 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CompletedApproval.md @@ -0,0 +1,79 @@ +--- +id: completed-approval +title: CompletedApproval +pagination_label: CompletedApproval +sidebar_label: CompletedApproval +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CompletedApproval', 'CompletedApproval'] +slug: /tools/sdk/powershell/v3/models/completed-approval +tags: ['SDK', 'Software Development Kit', 'CompletedApproval', 'CompletedApproval'] +--- + + +# CompletedApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The approval id. | [optional] +**Name** | Pointer to **String** | The name of the approval. | [optional] +**Created** | Pointer to **System.DateTime** | When the approval was created. | [optional] +**Modified** | Pointer to **System.DateTime** | When the approval was modified last time. | [optional] +**RequestCreated** | Pointer to **System.DateTime** | When the access-request was created. | [optional] +**RequestType** | Pointer to [**AccessRequestType**](access-request-type) | | [optional] +**Requester** | Pointer to [**AccessItemRequester**](access-item-requester) | | [optional] +**RequestedFor** | Pointer to [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] +**ReviewedBy** | Pointer to [**AccessItemReviewedBy**](access-item-reviewed-by) | | [optional] +**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**RequestedObject** | Pointer to [**RequestableObjectReference**](requestable-object-reference) | | [optional] +**RequesterComment** | Pointer to [**CompletedApprovalRequesterComment**](completed-approval-requester-comment) | | [optional] +**ReviewerComment** | Pointer to [**CompletedApprovalReviewerComment**](completed-approval-reviewer-comment) | | [optional] +**PreviousReviewersComments** | Pointer to [**[]CommentDto**](comment-dto) | The history of the previous reviewers comments. | [optional] +**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] +**CommentRequiredWhenRejected** | Pointer to **Boolean** | When true the rejector has to provide comments when rejecting | [optional] [default to $false] +**State** | Pointer to [**CompletedApprovalState**](completed-approval-state) | | [optional] +**RemoveDate** | Pointer to **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +**RemoveDateUpdateRequested** | Pointer to **Boolean** | If true, then the request was to change the remove date or sunset date. | [optional] [default to $false] +**CurrentRemoveDate** | Pointer to **System.DateTime** | The remove date or sunset date that was assigned at the time of the request. | [optional] +**SodViolationContext** | Pointer to [**SodViolationContextCheckCompleted**](sod-violation-context-check-completed) | | [optional] +**PreApprovalTriggerResult** | Pointer to [**CompletedApprovalPreApprovalTriggerResult**](completed-approval-pre-approval-trigger-result) | | [optional] +**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs provided during the request. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CompletedApproval = Initialize-PSSailpoint.V3CompletedApproval -Id id12345 ` + -Name aName ` + -Created 2017-07-11T18:45:37.098Z ` + -Modified 2018-07-25T20:22:28.104Z ` + -RequestCreated 2017-07-11T18:45:35.098Z ` + -RequestType null ` + -Requester null ` + -RequestedFor null ` + -ReviewedBy null ` + -Owner null ` + -RequestedObject null ` + -RequesterComment null ` + -ReviewerComment null ` + -PreviousReviewersComments null ` + -ForwardHistory null ` + -CommentRequiredWhenRejected true ` + -State null ` + -RemoveDate 2020-07-11T00:00Z ` + -RemoveDateUpdateRequested true ` + -CurrentRemoveDate 2020-07-11T00:00Z ` + -SodViolationContext null ` + -PreApprovalTriggerResult null ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} +``` + +- Convert the resource to JSON +```powershell +$CompletedApproval | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CompletedApprovalPreApprovalTriggerResult.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CompletedApprovalPreApprovalTriggerResult.md new file mode 100644 index 000000000..be0f4507f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CompletedApprovalPreApprovalTriggerResult.md @@ -0,0 +1,41 @@ +--- +id: completed-approval-pre-approval-trigger-result +title: CompletedApprovalPreApprovalTriggerResult +pagination_label: CompletedApprovalPreApprovalTriggerResult +sidebar_label: CompletedApprovalPreApprovalTriggerResult +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CompletedApprovalPreApprovalTriggerResult', 'CompletedApprovalPreApprovalTriggerResult'] +slug: /tools/sdk/powershell/v3/models/completed-approval-pre-approval-trigger-result +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalPreApprovalTriggerResult', 'CompletedApprovalPreApprovalTriggerResult'] +--- + + +# CompletedApprovalPreApprovalTriggerResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | The comment from the trigger | [optional] +**Decision** | Pointer to [**CompletedApprovalState**](completed-approval-state) | | [optional] +**Reviewer** | Pointer to **String** | The name of the approver | [optional] +**Date** | Pointer to **System.DateTime** | The date and time the trigger decided on the request | [optional] + +## Examples + +- Prepare the resource +```powershell +$CompletedApprovalPreApprovalTriggerResult = Initialize-PSSailpoint.V3CompletedApprovalPreApprovalTriggerResult -Comment This request was autoapproved by our automated ETS subscriber ` + -Decision null ` + -Reviewer Automated AR Approval ` + -Date 2022-06-07T19:18:40.748Z +``` + +- Convert the resource to JSON +```powershell +$CompletedApprovalPreApprovalTriggerResult | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CompletedApprovalRequesterComment.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CompletedApprovalRequesterComment.md new file mode 100644 index 000000000..b432f5603 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CompletedApprovalRequesterComment.md @@ -0,0 +1,39 @@ +--- +id: completed-approval-requester-comment +title: CompletedApprovalRequesterComment +pagination_label: CompletedApprovalRequesterComment +sidebar_label: CompletedApprovalRequesterComment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CompletedApprovalRequesterComment', 'CompletedApprovalRequesterComment'] +slug: /tools/sdk/powershell/v3/models/completed-approval-requester-comment +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalRequesterComment', 'CompletedApprovalRequesterComment'] +--- + + +# CompletedApprovalRequesterComment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment content. | [optional] +**Created** | Pointer to **System.DateTime** | Date and time comment was created. | [optional] +**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CompletedApprovalRequesterComment = Initialize-PSSailpoint.V3CompletedApprovalRequesterComment -Comment This is a comment. ` + -Created 2017-07-11T18:45:37.098Z ` + -Author null +``` + +- Convert the resource to JSON +```powershell +$CompletedApprovalRequesterComment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CompletedApprovalReviewerComment.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CompletedApprovalReviewerComment.md new file mode 100644 index 000000000..1a181e57d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CompletedApprovalReviewerComment.md @@ -0,0 +1,39 @@ +--- +id: completed-approval-reviewer-comment +title: CompletedApprovalReviewerComment +pagination_label: CompletedApprovalReviewerComment +sidebar_label: CompletedApprovalReviewerComment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CompletedApprovalReviewerComment', 'CompletedApprovalReviewerComment'] +slug: /tools/sdk/powershell/v3/models/completed-approval-reviewer-comment +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalReviewerComment', 'CompletedApprovalReviewerComment'] +--- + + +# CompletedApprovalReviewerComment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment content. | [optional] +**Created** | Pointer to **System.DateTime** | Date and time comment was created. | [optional] +**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CompletedApprovalReviewerComment = Initialize-PSSailpoint.V3CompletedApprovalReviewerComment -Comment This is a comment. ` + -Created 2017-07-11T18:45:37.098Z ` + -Author null +``` + +- Convert the resource to JSON +```powershell +$CompletedApprovalReviewerComment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CompletedApprovalState.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CompletedApprovalState.md new file mode 100644 index 000000000..1873c879c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CompletedApprovalState.md @@ -0,0 +1,24 @@ +--- +id: completed-approval-state +title: CompletedApprovalState +pagination_label: CompletedApprovalState +sidebar_label: CompletedApprovalState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CompletedApprovalState', 'CompletedApprovalState'] +slug: /tools/sdk/powershell/v3/models/completed-approval-state +tags: ['SDK', 'Software Development Kit', 'CompletedApprovalState', 'CompletedApprovalState'] +--- + + +# CompletedApprovalState + +## Enum + + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CompletionStatus.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CompletionStatus.md new file mode 100644 index 000000000..151c18b08 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CompletionStatus.md @@ -0,0 +1,28 @@ +--- +id: completion-status +title: CompletionStatus +pagination_label: CompletionStatus +sidebar_label: CompletionStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CompletionStatus', 'CompletionStatus'] +slug: /tools/sdk/powershell/v3/models/completion-status +tags: ['SDK', 'Software Development Kit', 'CompletionStatus', 'CompletionStatus'] +--- + + +# CompletionStatus + +## Enum + + +* `SUCCESS` (value: `"SUCCESS"`) + +* `FAILURE` (value: `"FAILURE"`) + +* `INCOMPLETE` (value: `"INCOMPLETE"`) + +* `PENDING` (value: `"PENDING"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Concatenation.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Concatenation.md new file mode 100644 index 000000000..58df42f49 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Concatenation.md @@ -0,0 +1,39 @@ +--- +id: concatenation +title: Concatenation +pagination_label: Concatenation +sidebar_label: Concatenation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Concatenation', 'Concatenation'] +slug: /tools/sdk/powershell/v3/models/concatenation +tags: ['SDK', 'Software Development Kit', 'Concatenation', 'Concatenation'] +--- + + +# Concatenation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Values** | [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | An array of items to join together | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$Concatenation = Initialize-PSSailpoint.V3Concatenation -Values [John, , Smith] ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Concatenation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Conditional.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Conditional.md new file mode 100644 index 000000000..4a5894ec0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Conditional.md @@ -0,0 +1,43 @@ +--- +id: conditional +title: Conditional +pagination_label: Conditional +sidebar_label: Conditional +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Conditional', 'Conditional'] +slug: /tools/sdk/powershell/v3/models/conditional +tags: ['SDK', 'Software Development Kit', 'Conditional', 'Conditional'] +--- + + +# Conditional + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Expression** | **String** | A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. The `eq` operator is the only valid comparison | [required] +**PositiveCondition** | **String** | The output of the transform if the expression evalutes to true | [required] +**NegativeCondition** | **String** | The output of the transform if the expression evalutes to false | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$Conditional = Initialize-PSSailpoint.V3Conditional -Expression ValueA eq ValueB ` + -PositiveCondition true ` + -NegativeCondition false ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Conditional | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ConflictingAccessCriteria.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ConflictingAccessCriteria.md new file mode 100644 index 000000000..b88c82d7a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ConflictingAccessCriteria.md @@ -0,0 +1,37 @@ +--- +id: conflicting-access-criteria +title: ConflictingAccessCriteria +pagination_label: ConflictingAccessCriteria +sidebar_label: ConflictingAccessCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConflictingAccessCriteria', 'ConflictingAccessCriteria'] +slug: /tools/sdk/powershell/v3/models/conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'ConflictingAccessCriteria', 'ConflictingAccessCriteria'] +--- + + +# ConflictingAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] +**RightCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConflictingAccessCriteria = Initialize-PSSailpoint.V3ConflictingAccessCriteria -LeftCriteria null ` + -RightCriteria null +``` + +- Convert the resource to JSON +```powershell +$ConflictingAccessCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ConnectorDetail.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ConnectorDetail.md new file mode 100644 index 000000000..b02bb8d55 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ConnectorDetail.md @@ -0,0 +1,116 @@ +--- +id: connector-detail +title: ConnectorDetail +pagination_label: ConnectorDetail +sidebar_label: ConnectorDetail +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorDetail', 'ConnectorDetail'] +slug: /tools/sdk/powershell/v3/models/connector-detail +tags: ['SDK', 'Software Development Kit', 'ConnectorDetail', 'ConnectorDetail'] +--- + + +# ConnectorDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The connector name | [optional] +**Type** | Pointer to **String** | The connector type | [optional] +**ClassName** | Pointer to **String** | The connector class name | [optional] +**ScriptName** | Pointer to **String** | The connector script name | [optional] +**ApplicationXml** | Pointer to **String** | The connector application xml | [optional] +**CorrelationConfigXml** | Pointer to **String** | The connector correlation config xml | [optional] +**SourceConfigXml** | Pointer to **String** | The connector source config xml | [optional] +**SourceConfig** | Pointer to **String** | The connector source config | [optional] +**SourceConfigFrom** | Pointer to **String** | The connector source config origin | [optional] +**S3Location** | Pointer to **String** | storage path key for this connector | [optional] +**UploadedFiles** | Pointer to **[]String** | The list of uploaded files supported by the connector. If there was any executable files uploaded to thee connector. Typically this be empty as the executable be uploaded at source creation. | [optional] +**FileUpload** | Pointer to **Boolean** | true if the source is file upload | [optional] [default to $false] +**DirectConnect** | Pointer to **Boolean** | true if the source is a direct connect source | [optional] [default to $false] +**TranslationProperties** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map containing translation attributes by loacale key | [optional] +**ConnectorMetadata** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map containing metadata pertinent to the UI to be used | [optional] +**Status** | Pointer to **Enum** [ "DEPRECATED", "DEVELOPMENT", "DEMO", "RELEASED" ] | The connector status | [optional] + +## Examples + +- Prepare the resource +```powershell +$ConnectorDetail = Initialize-PSSailpoint.V3ConnectorDetail -Name name ` + -Type ServiceNow ` + -ClassName class name ` + -ScriptName servicenow ` + -ApplicationXml <?xml version='1.0' encoding='UTF-8'?> +<!DOCTYPE Application PUBLIC "sailpoint.dtd" "sailpoint.dtd"> +<Application connector="sailpoint.connector.OpenConnectorAdapter" name="custom Atlassian Suite - Cloud" type="custom Atlassian Suite - Cloud"/> + ` + -CorrelationConfigXml <?xml version='1.0' encoding='UTF-8'?> +<!-- Copyright (C) 2021 SailPoint Technologies, Inc. All rights reserved. --> + +<!DOCTYPE CorrelationConfig PUBLIC "sailpoint.dtd" "sailpoint.dtd"> + +<CorrelationConfig name="custom Atlassian Suite - Cloud Account Correlation Config"> + <AttributeAssignments> + <Filter operation="EQ" property="email" value="mail"/> + <Filter operation="EQ" property="empId" value="employeeNumber"/> + <Filter operation="EQ" property="displayName" value="cn"/> + </AttributeAssignments> +</CorrelationConfig> + ` + -SourceConfigXml <?xml version="1.0" encoding="UTF-8" standalone="no"?><!-- Copyright (C) 2023 SailPoint Technologies, Inc. All rights reserved. --><Form xmlns="http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd" connectorName="custom Atlassian Suite - Cloud" directConnect="true" fileUpload="true" name="Custom Atlassian Suite - Cloud" status="released" type="SourceConfig"> + <BaseConfig> + <Field maxFiles="10" maxSize="300" name="fileUpload" supportedExtensions="jar" type="fileupload" validateJSON="false"/> + </BaseConfig> + + + +</Form> ` + -SourceConfig <?xml version="1.0" encoding="UTF-8" standalone="no"?><!-- Copyright (C) 2023 SailPoint Technologies, Inc. All rights reserved. --><Form xmlns="http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd" connectorName="custom Atlassian Suite - Cloud" directConnect="true" fileUpload="true" name="Custom Atlassian Suite - Cloud" status="released" type="SourceConfig"> + <BaseConfig> + <Field maxFiles="10" maxSize="300" name="fileUpload" supportedExtensions="jar" type="fileupload" validateJSON="false"/> + </BaseConfig> + + + +</Form> ` + -SourceConfigFrom sp-connect ` + -S3Location custom-connector/scriptname ` + -UploadedFiles [pod/org/connectorFiles/testconnector/test1.jar] ` + -FileUpload true ` + -DirectConnect true ` + -TranslationProperties {de=# Copyright (C) 2024 SailPoint Technologies, Inc. All rights reserved. +# DO NOT EDIT. This file is generated by "sailpointTranslate" command. +menuLabel_ConnectionSettings=Verbindungseinstellungen +menuLabel_AggregationSettings=Aggregationseinstellungen +sectionLabel_AuthenticationSettings=Verbindungseinstellungen +sectionLabel_AggregationSettings=Aggregationseinstellungen +sectionInfo_AuthenticationSettings=Konfigurieren Sie eine direkte Verbindung zwischen der Quelle Delinea Secret Server On-Premise und IdentityNow.<br><br>Geben Sie bei <strong>Zeit\u00fcberschreitung bei Verbindung</strong> die maximal erlaubte Zeitdauer (in Minuten) f\u00fcr die Verbindung von IdentityNow mit der Quelle ein.<br><br>Geben Sie die <strong>Host-URL</strong> der Delinea-SCIM-Serverquelle ein.<br><br>Geben Sie den <strong>API-Token</strong> der Quelle zur Authentifizierung ein. +sectionInfo_AggregationSettings=Geben Sie die Einstellungen f\u00fcr Ihre Aggregation an.<br><br>Geben Sie in das Feld <strong>Seitengr\u00f6\u00dfe</strong> die Anzahl an Kontoeintr\u00e4gen ein, die auf einer einzelnen Seite aggregiert werden sollen, wenn gro\u00dfe Datens\u00e4tze durchlaufen werden.<br>\n<br>Geben Sie im <strong>Kontofilter</strong> die Bedingungen f\u00fcr den Kontofilter an. Beispiel: userName sw "S"<br><br>Geben Sie im <strong>Gruppenfilter</strong> die Gruppenfilterbedingungen an. Beispiel: displayName sw "S". +placeHolder_accAggregation=userName sw "S" +placeHolder_grpAggregation=displayName sw "S" +placeHolder_host=https://{Delinea_SCIM_Server_host}/v2 +docLinkLabel_AuthenticationSettings=Mehr \u00fcber Verbindungseinstellungen +docLinkLabel_Filters=Mehr \u00fcber Konto- und Gruppenfilter +HostURL=Host-URL +ConnectionTimeout=Zeit\u00fcberschreitung bei Verbindung +API_TOKEN=API-Token +JSONPathMapping=JSON-Path-Attribut-Mapping +FilterConditionForAccounts=Kontofilter +FilterConditionForGroups=Gruppenfilter +Page_Size=Seitengr\u00f6\u00dfe +SchemaAttribute=Schema-Attribut +JSONpath=JSON-Pfad +ShortDesc=Das Integrationsmodul IdentityNow f\u00fcr Delinea Secret Server On-Premise bietet die M\u00f6glichkeit einer tiefen Governance f\u00fcr Konten und Gruppen. Es unterst\u00fctzt au\u00dferdem das End-to-End-Lebenszyklus-Management.} ` + -ConnectorMetadata {supportedUI=EXTJS, platform=ccg, shortDesc=connector description} ` + -Status RELEASED +``` + +- Convert the resource to JSON +```powershell +$ConnectorDetail | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreateExternalExecuteWorkflow200Response.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreateExternalExecuteWorkflow200Response.md new file mode 100644 index 000000000..59c887197 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreateExternalExecuteWorkflow200Response.md @@ -0,0 +1,37 @@ +--- +id: create-external-execute-workflow200-response +title: CreateExternalExecuteWorkflow200Response +pagination_label: CreateExternalExecuteWorkflow200Response +sidebar_label: CreateExternalExecuteWorkflow200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateExternalExecuteWorkflow200Response', 'CreateExternalExecuteWorkflow200Response'] +slug: /tools/sdk/powershell/v3/models/create-external-execute-workflow200-response +tags: ['SDK', 'Software Development Kit', 'CreateExternalExecuteWorkflow200Response', 'CreateExternalExecuteWorkflow200Response'] +--- + + +# CreateExternalExecuteWorkflow200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**WorkflowExecutionId** | Pointer to **String** | The workflow execution id | [optional] +**Message** | Pointer to **String** | An error message if any errors occurred | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateExternalExecuteWorkflow200Response = Initialize-PSSailpoint.V3CreateExternalExecuteWorkflow200Response -WorkflowExecutionId 0e11cefa-96e7-4b67-90d0-065bc1da5753 ` + -Message Workflow was not executed externally. Check enabled flag on workflow definition +``` + +- Convert the resource to JSON +```powershell +$CreateExternalExecuteWorkflow200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreateExternalExecuteWorkflowRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreateExternalExecuteWorkflowRequest.md new file mode 100644 index 000000000..9802f4b40 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreateExternalExecuteWorkflowRequest.md @@ -0,0 +1,35 @@ +--- +id: create-external-execute-workflow-request +title: CreateExternalExecuteWorkflowRequest +pagination_label: CreateExternalExecuteWorkflowRequest +sidebar_label: CreateExternalExecuteWorkflowRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateExternalExecuteWorkflowRequest', 'CreateExternalExecuteWorkflowRequest'] +slug: /tools/sdk/powershell/v3/models/create-external-execute-workflow-request +tags: ['SDK', 'Software Development Kit', 'CreateExternalExecuteWorkflowRequest', 'CreateExternalExecuteWorkflowRequest'] +--- + + +# CreateExternalExecuteWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarInput** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The input for the workflow | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateExternalExecuteWorkflowRequest = Initialize-PSSailpoint.V3CreateExternalExecuteWorkflowRequest -VarInput {customAttribute1=value1, customAttribute2=value2} +``` + +- Convert the resource to JSON +```powershell +$CreateExternalExecuteWorkflowRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreateOAuthClientRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreateOAuthClientRequest.md new file mode 100644 index 000000000..a3b3fe3df --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreateOAuthClientRequest.md @@ -0,0 +1,63 @@ +--- +id: create-o-auth-client-request +title: CreateOAuthClientRequest +pagination_label: CreateOAuthClientRequest +sidebar_label: CreateOAuthClientRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateOAuthClientRequest', 'CreateOAuthClientRequest'] +slug: /tools/sdk/powershell/v3/models/create-o-auth-client-request +tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientRequest', 'CreateOAuthClientRequest'] +--- + + +# CreateOAuthClientRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**BusinessName** | Pointer to **String** | The name of the business the API Client should belong to | [optional] +**HomepageUrl** | Pointer to **String** | The homepage URL associated with the owner of the API Client | [optional] +**Name** | **String** | A human-readable name for the API Client | [required] +**Description** | **String** | A description of the API Client | [required] +**AccessTokenValiditySeconds** | **Int32** | The number of seconds an access token generated for this API Client is valid for | [required] +**RefreshTokenValiditySeconds** | Pointer to **Int32** | The number of seconds a refresh token generated for this API Client is valid for | [optional] +**RedirectUris** | Pointer to **[]String** | A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. | [optional] +**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | [required] +**AccessType** | [**AccessType**](access-type) | | [required] +**Type** | Pointer to [**ClientType**](client-type) | | [optional] +**Internal** | Pointer to **Boolean** | An indicator of whether the API Client can be used for requests internal within the product. | [optional] +**Enabled** | **Boolean** | An indicator of whether the API Client is enabled for use | [required] +**StrongAuthSupported** | Pointer to **Boolean** | An indicator of whether the API Client supports strong authentication | [optional] +**ClaimsSupported** | Pointer to **Boolean** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [optional] +**Scope** | Pointer to **[]String** | Scopes of the API Client. If no scope is specified, the client will be created with the default scope ""sp:scopes:all"". This means the API Client will have all the rights of the owner who created it. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateOAuthClientRequest = Initialize-PSSailpoint.V3CreateOAuthClientRequest -BusinessName Acme-Solar ` + -HomepageUrl http://localhost:12345 ` + -Name Demo API Client ` + -Description An API client used for the authorization_code, refresh_token, and client_credentials flows ` + -AccessTokenValiditySeconds 750 ` + -RefreshTokenValiditySeconds 86400 ` + -RedirectUris [http://localhost:12345] ` + -GrantTypes [AUTHORIZATION_CODE, CLIENT_CREDENTIALS, REFRESH_TOKEN] ` + -AccessType null ` + -Type null ` + -Internal false ` + -Enabled true ` + -StrongAuthSupported false ` + -ClaimsSupported false ` + -Scope [demo:api-client-scope:first, demo:api-client-scope:second] +``` + +- Convert the resource to JSON +```powershell +$CreateOAuthClientRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreateOAuthClientResponse.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreateOAuthClientResponse.md new file mode 100644 index 000000000..834c13222 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreateOAuthClientResponse.md @@ -0,0 +1,71 @@ +--- +id: create-o-auth-client-response +title: CreateOAuthClientResponse +pagination_label: CreateOAuthClientResponse +sidebar_label: CreateOAuthClientResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateOAuthClientResponse', 'CreateOAuthClientResponse'] +slug: /tools/sdk/powershell/v3/models/create-o-auth-client-response +tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientResponse', 'CreateOAuthClientResponse'] +--- + + +# CreateOAuthClientResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | ID of the OAuth client | [required] +**Secret** | **String** | Secret of the OAuth client (This field is only returned on the intial create call.) | [required] +**BusinessName** | **String** | The name of the business the API Client should belong to | [required] +**HomepageUrl** | **String** | The homepage URL associated with the owner of the API Client | [required] +**Name** | **String** | A human-readable name for the API Client | [required] +**Description** | **String** | A description of the API Client | [required] +**AccessTokenValiditySeconds** | **Int32** | The number of seconds an access token generated for this API Client is valid for | [required] +**RefreshTokenValiditySeconds** | **Int32** | The number of seconds a refresh token generated for this API Client is valid for | [required] +**RedirectUris** | **[]String** | A list of the approved redirect URIs used with the authorization_code flow | [required] +**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | [required] +**AccessType** | [**AccessType**](access-type) | | [required] +**Type** | [**ClientType**](client-type) | | [required] +**Internal** | **Boolean** | An indicator of whether the API Client can be used for requests internal to IDN | [required] +**Enabled** | **Boolean** | An indicator of whether the API Client is enabled for use | [required] +**StrongAuthSupported** | **Boolean** | An indicator of whether the API Client supports strong authentication | [required] +**ClaimsSupported** | **Boolean** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [required] +**Created** | **System.DateTime** | The date and time, down to the millisecond, when the API Client was created | [required] +**Modified** | **System.DateTime** | The date and time, down to the millisecond, when the API Client was last updated | [required] +**Scope** | **[]String** | Scopes of the API Client. | [required] + +## Examples + +- Prepare the resource +```powershell +$CreateOAuthClientResponse = Initialize-PSSailpoint.V3CreateOAuthClientResponse -Id 2c9180835d2e5168015d32f890ca1581 ` + -Secret 5c32dd9b21adb51c77794d46e71de117a1d0ddb36a7ff941fa28014ab7de2cf3 ` + -BusinessName Acme-Solar ` + -HomepageUrl http://localhost:12345 ` + -Name Demo API Client ` + -Description An API client used for the authorization_code, refresh_token, and client_credentials flows ` + -AccessTokenValiditySeconds 750 ` + -RefreshTokenValiditySeconds 86400 ` + -RedirectUris [http://localhost:12345] ` + -GrantTypes [AUTHORIZATION_CODE, CLIENT_CREDENTIALS, REFRESH_TOKEN] ` + -AccessType null ` + -Type null ` + -Internal false ` + -Enabled true ` + -StrongAuthSupported false ` + -ClaimsSupported false ` + -Created 2017-07-11T18:45:37.098Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Scope [demo:api-client-scope:first, demo:api-client-scope:second] +``` + +- Convert the resource to JSON +```powershell +$CreateOAuthClientResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreatePersonalAccessTokenRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreatePersonalAccessTokenRequest.md new file mode 100644 index 000000000..9e15309ec --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreatePersonalAccessTokenRequest.md @@ -0,0 +1,39 @@ +--- +id: create-personal-access-token-request +title: CreatePersonalAccessTokenRequest +pagination_label: CreatePersonalAccessTokenRequest +sidebar_label: CreatePersonalAccessTokenRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreatePersonalAccessTokenRequest', 'CreatePersonalAccessTokenRequest'] +slug: /tools/sdk/powershell/v3/models/create-personal-access-token-request +tags: ['SDK', 'Software Development Kit', 'CreatePersonalAccessTokenRequest', 'CreatePersonalAccessTokenRequest'] +--- + + +# CreatePersonalAccessTokenRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. | [required] +**Scope** | Pointer to **[]String** | Scopes of the personal access token. If no scope is specified, the token will be created with the default scope ""sp:scopes:all"". This means the personal access token will have all the rights of the owner who created it. | [optional] +**AccessTokenValiditySeconds** | Pointer to **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreatePersonalAccessTokenRequest = Initialize-PSSailpoint.V3CreatePersonalAccessTokenRequest -Name NodeJS Integration ` + -Scope [demo:personal-access-token-scope:first, demo:personal-access-token-scope:second] ` + -AccessTokenValiditySeconds 36900 +``` + +- Convert the resource to JSON +```powershell +$CreatePersonalAccessTokenRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreatePersonalAccessTokenResponse.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreatePersonalAccessTokenResponse.md new file mode 100644 index 000000000..2ce9dc867 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreatePersonalAccessTokenResponse.md @@ -0,0 +1,47 @@ +--- +id: create-personal-access-token-response +title: CreatePersonalAccessTokenResponse +pagination_label: CreatePersonalAccessTokenResponse +sidebar_label: CreatePersonalAccessTokenResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreatePersonalAccessTokenResponse', 'CreatePersonalAccessTokenResponse'] +slug: /tools/sdk/powershell/v3/models/create-personal-access-token-response +tags: ['SDK', 'Software Development Kit', 'CreatePersonalAccessTokenResponse', 'CreatePersonalAccessTokenResponse'] +--- + + +# CreatePersonalAccessTokenResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The ID of the personal access token (to be used as the username for Basic Auth). | [required] +**Secret** | **String** | The secret of the personal access token (to be used as the password for Basic Auth). | [required] +**Scope** | **[]String** | Scopes of the personal access token. | [required] +**Name** | **String** | The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. | [required] +**Owner** | [**PatOwner**](pat-owner) | | [required] +**Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required] +**AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [required] + +## Examples + +- Prepare the resource +```powershell +$CreatePersonalAccessTokenResponse = Initialize-PSSailpoint.V3CreatePersonalAccessTokenResponse -Id 86f1dc6fe8f54414950454cbb11278fa ` + -Secret 1d1bef2b9f426383447f64f69349fc7cac176042578d205c256ba3f37c59adb9 ` + -Scope [demo:personal-access-token-scope:first, demo:personal-access-token-scope:second] ` + -Name NodeJS Integration ` + -Owner null ` + -Created 2017-07-11T18:45:37.098Z ` + -AccessTokenValiditySeconds 36900 +``` + +- Convert the resource to JSON +```powershell +$CreatePersonalAccessTokenResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreateSavedSearchRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreateSavedSearchRequest.md new file mode 100644 index 000000000..62197397d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreateSavedSearchRequest.md @@ -0,0 +1,55 @@ +--- +id: create-saved-search-request +title: CreateSavedSearchRequest +pagination_label: CreateSavedSearchRequest +sidebar_label: CreateSavedSearchRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateSavedSearchRequest', 'CreateSavedSearchRequest'] +slug: /tools/sdk/powershell/v3/models/create-saved-search-request +tags: ['SDK', 'Software Development Kit', 'CreateSavedSearchRequest', 'CreateSavedSearchRequest'] +--- + + +# CreateSavedSearchRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the saved search. | [optional] +**Description** | Pointer to **String** | The description of the saved search. | [optional] +**Created** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] +**Modified** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] +**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required] +**Columns** | Pointer to [**map[string]Column[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] +**Query** | **String** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required] +**Fields** | Pointer to **[]String** | The fields to be searched against in a multi-field query. | [optional] +**OrderBy** | Pointer to **map[string]String[]** | Sort by index. This takes precedence over the `sort` property. | [optional] +**Sort** | Pointer to **[]String** | The fields to be used to sort the search results. | [optional] +**Filters** | Pointer to [**SavedSearchDetailFilters**](saved-search-detail-filters) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateSavedSearchRequest = Initialize-PSSailpoint.V3CreateSavedSearchRequest -Name Disabled accounts ` + -Description Disabled accounts ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Indices [identities] ` + -Columns {identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]} ` + -Query @accounts(disabled:true) ` + -Fields [disabled] ` + -OrderBy {identity=[lastName, firstName], role=[name]} ` + -Sort [displayName] ` + -Filters null +``` + +- Convert the resource to JSON +```powershell +$CreateSavedSearchRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreateScheduledSearchRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreateScheduledSearchRequest.md new file mode 100644 index 000000000..6aaaecad5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreateScheduledSearchRequest.md @@ -0,0 +1,53 @@ +--- +id: create-scheduled-search-request +title: CreateScheduledSearchRequest +pagination_label: CreateScheduledSearchRequest +sidebar_label: CreateScheduledSearchRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateScheduledSearchRequest', 'CreateScheduledSearchRequest'] +slug: /tools/sdk/powershell/v3/models/create-scheduled-search-request +tags: ['SDK', 'Software Development Kit', 'CreateScheduledSearchRequest', 'CreateScheduledSearchRequest'] +--- + + +# CreateScheduledSearchRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the scheduled search. | [optional] +**Description** | Pointer to **String** | The description of the scheduled search. | [optional] +**SavedSearchId** | **String** | The ID of the saved search that will be executed. | [required] +**Created** | Pointer to **System.DateTime** | The date the scheduled search was initially created. | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | The last date the scheduled search was modified. | [optional] [readonly] +**Schedule** | [**Schedule1**](schedule1) | | [required] +**Recipients** | [**[]SearchScheduleRecipientsInner**](search-schedule-recipients-inner) | A list of identities that should receive the scheduled search report via email. | [required] +**Enabled** | Pointer to **Boolean** | Indicates if the scheduled search is enabled. | [optional] [default to $false] +**EmailEmptyResults** | Pointer to **Boolean** | Indicates if email generation should occur when search returns no results. | [optional] [default to $false] +**DisplayQueryDetails** | Pointer to **Boolean** | Indicates if the generated email should include the query and search results preview (which could include PII). | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$CreateScheduledSearchRequest = Initialize-PSSailpoint.V3CreateScheduledSearchRequest -Name Daily disabled accounts ` + -Description Daily disabled accounts ` + -SavedSearchId 554f1511-f0a1-4744-ab14-599514d3e57c ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Schedule null ` + -Recipients null ` + -Enabled false ` + -EmailEmptyResults false ` + -DisplayQueryDetails false +``` + +- Convert the resource to JSON +```powershell +$CreateScheduledSearchRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreateUploadedConfigurationRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreateUploadedConfigurationRequest.md new file mode 100644 index 000000000..a4c96aa90 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreateUploadedConfigurationRequest.md @@ -0,0 +1,37 @@ +--- +id: create-uploaded-configuration-request +title: CreateUploadedConfigurationRequest +pagination_label: CreateUploadedConfigurationRequest +sidebar_label: CreateUploadedConfigurationRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateUploadedConfigurationRequest', 'CreateUploadedConfigurationRequest'] +slug: /tools/sdk/powershell/v3/models/create-uploaded-configuration-request +tags: ['SDK', 'Software Development Kit', 'CreateUploadedConfigurationRequest', 'CreateUploadedConfigurationRequest'] +--- + + +# CreateUploadedConfigurationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarData** | **System.IO.FileInfo** | JSON file containing the objects to be imported. | [required] +**Name** | **String** | Name that will be assigned to the uploaded configuration file. | [required] + +## Examples + +- Prepare the resource +```powershell +$CreateUploadedConfigurationRequest = Initialize-PSSailpoint.V3CreateUploadedConfigurationRequest -VarData null ` + -Name null +``` + +- Convert the resource to JSON +```powershell +$CreateUploadedConfigurationRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreateWorkflowRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreateWorkflowRequest.md new file mode 100644 index 000000000..348008fdd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CreateWorkflowRequest.md @@ -0,0 +1,45 @@ +--- +id: create-workflow-request +title: CreateWorkflowRequest +pagination_label: CreateWorkflowRequest +sidebar_label: CreateWorkflowRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CreateWorkflowRequest', 'CreateWorkflowRequest'] +slug: /tools/sdk/powershell/v3/models/create-workflow-request +tags: ['SDK', 'Software Development Kit', 'CreateWorkflowRequest', 'CreateWorkflowRequest'] +--- + + +# CreateWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | The name of the workflow | [required] +**Owner** | Pointer to [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] +**Description** | Pointer to **String** | Description of what the workflow accomplishes | [optional] +**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] +**Enabled** | Pointer to **Boolean** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to $false] +**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$CreateWorkflowRequest = Initialize-PSSailpoint.V3CreateWorkflowRequest -Name Send Email ` + -Owner null ` + -Description Send an email to the identity who's attributes changed. ` + -Definition null ` + -Enabled false ` + -Trigger null +``` + +- Convert the resource to JSON +```powershell +$CreateWorkflowRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/CriteriaType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CriteriaType.md new file mode 100644 index 000000000..564bfaf0f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/CriteriaType.md @@ -0,0 +1,40 @@ +--- +id: criteria-type +title: CriteriaType +pagination_label: CriteriaType +sidebar_label: CriteriaType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'CriteriaType', 'CriteriaType'] +slug: /tools/sdk/powershell/v3/models/criteria-type +tags: ['SDK', 'Software Development Kit', 'CriteriaType', 'CriteriaType'] +--- + + +# CriteriaType + +## Enum + + +* `COMPOSITE` (value: `"COMPOSITE"`) + +* `ROLE` (value: `"ROLE"`) + +* `IDENTITY` (value: `"IDENTITY"`) + +* `IDENTITY_ATTRIBUTE` (value: `"IDENTITY_ATTRIBUTE"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `SOURCE` (value: `"SOURCE"`) + +* `ACCOUNT` (value: `"ACCOUNT"`) + +* `AGGREGATED_ENTITLEMENT` (value: `"AGGREGATED_ENTITLEMENT"`) + +* `INVALID_CERTIFIABLE_ENTITY` (value: `"INVALID_CERTIFIABLE_ENTITY"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/DataAccess.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DataAccess.md new file mode 100644 index 000000000..316208b4d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DataAccess.md @@ -0,0 +1,39 @@ +--- +id: data-access +title: DataAccess +pagination_label: DataAccess +sidebar_label: DataAccess +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DataAccess', 'DataAccess'] +slug: /tools/sdk/powershell/v3/models/data-access +tags: ['SDK', 'Software Development Kit', 'DataAccess', 'DataAccess'] +--- + + +# DataAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policies** | Pointer to [**[]DataAccessPoliciesInner**](data-access-policies-inner) | List of classification policies that apply to resources the entitlement \ groups has access to | [optional] +**Categories** | Pointer to [**[]DataAccessCategoriesInner**](data-access-categories-inner) | List of classification categories that apply to resources the entitlement \ groups has access to | [optional] +**ImpactScore** | Pointer to [**DataAccessImpactScore**](data-access-impact-score) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$DataAccess = Initialize-PSSailpoint.V3DataAccess -Policies null ` + -Categories null ` + -ImpactScore null +``` + +- Convert the resource to JSON +```powershell +$DataAccess | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/DataAccessCategoriesInner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DataAccessCategoriesInner.md new file mode 100644 index 000000000..f12a157be --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DataAccessCategoriesInner.md @@ -0,0 +1,37 @@ +--- +id: data-access-categories-inner +title: DataAccessCategoriesInner +pagination_label: DataAccessCategoriesInner +sidebar_label: DataAccessCategoriesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DataAccessCategoriesInner', 'DataAccessCategoriesInner'] +slug: /tools/sdk/powershell/v3/models/data-access-categories-inner +tags: ['SDK', 'Software Development Kit', 'DataAccessCategoriesInner', 'DataAccessCategoriesInner'] +--- + + +# DataAccessCategoriesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **String** | Value of the category | [optional] +**MatchCount** | Pointer to **Int32** | Number of matched for each category | [optional] + +## Examples + +- Prepare the resource +```powershell +$DataAccessCategoriesInner = Initialize-PSSailpoint.V3DataAccessCategoriesInner -Value email-7 ` + -MatchCount 10 +``` + +- Convert the resource to JSON +```powershell +$DataAccessCategoriesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/DataAccessImpactScore.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DataAccessImpactScore.md new file mode 100644 index 000000000..14dd62bb0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DataAccessImpactScore.md @@ -0,0 +1,35 @@ +--- +id: data-access-impact-score +title: DataAccessImpactScore +pagination_label: DataAccessImpactScore +sidebar_label: DataAccessImpactScore +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DataAccessImpactScore', 'DataAccessImpactScore'] +slug: /tools/sdk/powershell/v3/models/data-access-impact-score +tags: ['SDK', 'Software Development Kit', 'DataAccessImpactScore', 'DataAccessImpactScore'] +--- + + +# DataAccessImpactScore + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **String** | Impact Score for this data | [optional] + +## Examples + +- Prepare the resource +```powershell +$DataAccessImpactScore = Initialize-PSSailpoint.V3DataAccessImpactScore -Value Medium +``` + +- Convert the resource to JSON +```powershell +$DataAccessImpactScore | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/DataAccessPoliciesInner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DataAccessPoliciesInner.md new file mode 100644 index 000000000..ea0ce17c4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DataAccessPoliciesInner.md @@ -0,0 +1,35 @@ +--- +id: data-access-policies-inner +title: DataAccessPoliciesInner +pagination_label: DataAccessPoliciesInner +sidebar_label: DataAccessPoliciesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DataAccessPoliciesInner', 'DataAccessPoliciesInner'] +slug: /tools/sdk/powershell/v3/models/data-access-policies-inner +tags: ['SDK', 'Software Development Kit', 'DataAccessPoliciesInner', 'DataAccessPoliciesInner'] +--- + + +# DataAccessPoliciesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | Pointer to **String** | Value of the policy | [optional] + +## Examples + +- Prepare the resource +```powershell +$DataAccessPoliciesInner = Initialize-PSSailpoint.V3DataAccessPoliciesInner -Value GDPR-20 +``` + +- Convert the resource to JSON +```powershell +$DataAccessPoliciesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/DateCompare.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DateCompare.md new file mode 100644 index 000000000..94c7b4c88 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DateCompare.md @@ -0,0 +1,47 @@ +--- +id: date-compare +title: DateCompare +pagination_label: DateCompare +sidebar_label: DateCompare +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DateCompare', 'DateCompare'] +slug: /tools/sdk/powershell/v3/models/date-compare +tags: ['SDK', 'Software Development Kit', 'DateCompare', 'DateCompare'] +--- + + +# DateCompare + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FirstDate** | [**DateCompareFirstDate**](date-compare-first-date) | | [required] +**SecondDate** | [**DateCompareSecondDate**](date-compare-second-date) | | [required] +**Operator** | **Enum** [ "LT", "LTE", "GT", "GTE" ] | This is the comparison to perform. | Operation | Description | | --------- | ------- | | LT | Strictly less than: `firstDate < secondDate` | | LTE | Less than or equal to: `firstDate <= secondDate` | | GT | Strictly greater than: `firstDate > secondDate` | | GTE | Greater than or equal to: `firstDate >= secondDate` | | [required] +**PositiveCondition** | **String** | The output of the transform if the expression evalutes to true | [required] +**NegativeCondition** | **String** | The output of the transform if the expression evalutes to false | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$DateCompare = Initialize-PSSailpoint.V3DateCompare -FirstDate null ` + -SecondDate null ` + -Operator LT ` + -PositiveCondition true ` + -NegativeCondition false ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$DateCompare | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/DateCompareFirstDate.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DateCompareFirstDate.md new file mode 100644 index 000000000..68c6d70ba --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DateCompareFirstDate.md @@ -0,0 +1,55 @@ +--- +id: date-compare-first-date +title: DateCompareFirstDate +pagination_label: DateCompareFirstDate +sidebar_label: DateCompareFirstDate +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DateCompareFirstDate', 'DateCompareFirstDate'] +slug: /tools/sdk/powershell/v3/models/date-compare-first-date +tags: ['SDK', 'Software Development Kit', 'DateCompareFirstDate', 'DateCompareFirstDate'] +--- + + +# DateCompareFirstDate + +## Properties + +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] +**InputFormat** | Pointer to [**DateFormatInputFormat**](date-format-input-format) | | [optional] +**OutputFormat** | Pointer to [**DateFormatOutputFormat**](date-format-output-format) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$DateCompareFirstDate = Initialize-PSSailpoint.V3DateCompareFirstDate -SourceName Workday ` + -AttributeName DEPARTMENT ` + -AccountSortAttribute created ` + -AccountSortDescending false ` + -AccountReturnFirstLink false ` + -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` + -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` + -InputFormat null ` + -OutputFormat null +``` + +- Convert the resource to JSON +```powershell +$DateCompareFirstDate | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/DateCompareSecondDate.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DateCompareSecondDate.md new file mode 100644 index 000000000..bb5bae7ac --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DateCompareSecondDate.md @@ -0,0 +1,55 @@ +--- +id: date-compare-second-date +title: DateCompareSecondDate +pagination_label: DateCompareSecondDate +sidebar_label: DateCompareSecondDate +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DateCompareSecondDate', 'DateCompareSecondDate'] +slug: /tools/sdk/powershell/v3/models/date-compare-second-date +tags: ['SDK', 'Software Development Kit', 'DateCompareSecondDate', 'DateCompareSecondDate'] +--- + + +# DateCompareSecondDate + +## Properties + +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] +**InputFormat** | Pointer to [**DateFormatInputFormat**](date-format-input-format) | | [optional] +**OutputFormat** | Pointer to [**DateFormatOutputFormat**](date-format-output-format) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$DateCompareSecondDate = Initialize-PSSailpoint.V3DateCompareSecondDate -SourceName Workday ` + -AttributeName DEPARTMENT ` + -AccountSortAttribute created ` + -AccountSortDescending false ` + -AccountReturnFirstLink false ` + -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` + -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` + -InputFormat null ` + -OutputFormat null +``` + +- Convert the resource to JSON +```powershell +$DateCompareSecondDate | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/DateFormat.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DateFormat.md new file mode 100644 index 000000000..19fa779e8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DateFormat.md @@ -0,0 +1,41 @@ +--- +id: date-format +title: DateFormat +pagination_label: DateFormat +sidebar_label: DateFormat +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DateFormat', 'DateFormat'] +slug: /tools/sdk/powershell/v3/models/date-format +tags: ['SDK', 'Software Development Kit', 'DateFormat', 'DateFormat'] +--- + + +# DateFormat + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**InputFormat** | Pointer to [**DateFormatInputFormat**](date-format-input-format) | | [optional] +**OutputFormat** | Pointer to [**DateFormatOutputFormat**](date-format-output-format) | | [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] + +## Examples + +- Prepare the resource +```powershell +$DateFormat = Initialize-PSSailpoint.V3DateFormat -InputFormat null ` + -OutputFormat null ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$DateFormat | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/DateFormatInputFormat.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DateFormatInputFormat.md new file mode 100644 index 000000000..7fed076fa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DateFormatInputFormat.md @@ -0,0 +1,34 @@ +--- +id: date-format-input-format +title: DateFormatInputFormat +pagination_label: DateFormatInputFormat +sidebar_label: DateFormatInputFormat +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DateFormatInputFormat', 'DateFormatInputFormat'] +slug: /tools/sdk/powershell/v3/models/date-format-input-format +tags: ['SDK', 'Software Development Kit', 'DateFormatInputFormat', 'DateFormatInputFormat'] +--- + + +# DateFormatInputFormat + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$DateFormatInputFormat = Initialize-PSSailpoint.V3DateFormatInputFormat +``` + +- Convert the resource to JSON +```powershell +$DateFormatInputFormat | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/DateFormatOutputFormat.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DateFormatOutputFormat.md new file mode 100644 index 000000000..9c4dda018 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DateFormatOutputFormat.md @@ -0,0 +1,34 @@ +--- +id: date-format-output-format +title: DateFormatOutputFormat +pagination_label: DateFormatOutputFormat +sidebar_label: DateFormatOutputFormat +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DateFormatOutputFormat', 'DateFormatOutputFormat'] +slug: /tools/sdk/powershell/v3/models/date-format-output-format +tags: ['SDK', 'Software Development Kit', 'DateFormatOutputFormat', 'DateFormatOutputFormat'] +--- + + +# DateFormatOutputFormat + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$DateFormatOutputFormat = Initialize-PSSailpoint.V3DateFormatOutputFormat +``` + +- Convert the resource to JSON +```powershell +$DateFormatOutputFormat | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/DateMath.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DateMath.md new file mode 100644 index 000000000..e74263e07 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DateMath.md @@ -0,0 +1,41 @@ +--- +id: date-math +title: DateMath +pagination_label: DateMath +sidebar_label: DateMath +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DateMath', 'DateMath'] +slug: /tools/sdk/powershell/v3/models/date-math +tags: ['SDK', 'Software Development Kit', 'DateMath', 'DateMath'] +--- + + +# DateMath + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Expression** | **String** | A string value of the date and time components to operation on, along with the math operations to execute. | [required] +**RoundUp** | Pointer to **Boolean** | A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. If not provided, the transform will default to `false` `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) | [optional] [default to $false] +**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] + +## Examples + +- Prepare the resource +```powershell +$DateMath = Initialize-PSSailpoint.V3DateMath -Expression now+1w ` + -RoundUp false ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$DateMath | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/DecomposeDiacriticalMarks.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DecomposeDiacriticalMarks.md new file mode 100644 index 000000000..a9f93db67 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DecomposeDiacriticalMarks.md @@ -0,0 +1,37 @@ +--- +id: decompose-diacritical-marks +title: DecomposeDiacriticalMarks +pagination_label: DecomposeDiacriticalMarks +sidebar_label: DecomposeDiacriticalMarks +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DecomposeDiacriticalMarks', 'DecomposeDiacriticalMarks'] +slug: /tools/sdk/powershell/v3/models/decompose-diacritical-marks +tags: ['SDK', 'Software Development Kit', 'DecomposeDiacriticalMarks', 'DecomposeDiacriticalMarks'] +--- + + +# DecomposeDiacriticalMarks + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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] + +## Examples + +- Prepare the resource +```powershell +$DecomposeDiacriticalMarks = Initialize-PSSailpoint.V3DecomposeDiacriticalMarks -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$DecomposeDiacriticalMarks | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/DeleteNonEmployeeRecordsInBulkRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DeleteNonEmployeeRecordsInBulkRequest.md new file mode 100644 index 000000000..fbe54182f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DeleteNonEmployeeRecordsInBulkRequest.md @@ -0,0 +1,35 @@ +--- +id: delete-non-employee-records-in-bulk-request +title: DeleteNonEmployeeRecordsInBulkRequest +pagination_label: DeleteNonEmployeeRecordsInBulkRequest +sidebar_label: DeleteNonEmployeeRecordsInBulkRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DeleteNonEmployeeRecordsInBulkRequest', 'DeleteNonEmployeeRecordsInBulkRequest'] +slug: /tools/sdk/powershell/v3/models/delete-non-employee-records-in-bulk-request +tags: ['SDK', 'Software Development Kit', 'DeleteNonEmployeeRecordsInBulkRequest', 'DeleteNonEmployeeRecordsInBulkRequest'] +--- + + +# DeleteNonEmployeeRecordsInBulkRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Ids** | **[]String** | List of non-employee ids. | [required] + +## Examples + +- Prepare the resource +```powershell +$DeleteNonEmployeeRecordsInBulkRequest = Initialize-PSSailpoint.V3DeleteNonEmployeeRecordsInBulkRequest -Ids [2b838de9-db9b-abcf-e646-d4f274ad4238, 2d838de9-db9b-abcf-e646-d4f274ad4238] +``` + +- Convert the resource to JSON +```powershell +$DeleteNonEmployeeRecordsInBulkRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/DeleteSource202Response.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DeleteSource202Response.md new file mode 100644 index 000000000..cc829904e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DeleteSource202Response.md @@ -0,0 +1,39 @@ +--- +id: delete-source202-response +title: DeleteSource202Response +pagination_label: DeleteSource202Response +sidebar_label: DeleteSource202Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DeleteSource202Response', 'DeleteSource202Response'] +slug: /tools/sdk/powershell/v3/models/delete-source202-response +tags: ['SDK', 'Software Development Kit', 'DeleteSource202Response', 'DeleteSource202Response'] +--- + + +# DeleteSource202Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "TASK_RESULT" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Task result ID. | [optional] +**Name** | Pointer to **String** | Task result's human-readable display name (this should be null/empty). | [optional] + +## Examples + +- Prepare the resource +```powershell +$DeleteSource202Response = Initialize-PSSailpoint.V3DeleteSource202Response -Type TASK_RESULT ` + -Id 2c91808779ecf55b0179f720942f181a ` + -Name null +``` + +- Convert the resource to JSON +```powershell +$DeleteSource202Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/DeleteVendorConnectorMapping200Response.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DeleteVendorConnectorMapping200Response.md new file mode 100644 index 000000000..8618657bb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DeleteVendorConnectorMapping200Response.md @@ -0,0 +1,35 @@ +--- +id: delete-vendor-connector-mapping200-response +title: DeleteVendorConnectorMapping200Response +pagination_label: DeleteVendorConnectorMapping200Response +sidebar_label: DeleteVendorConnectorMapping200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DeleteVendorConnectorMapping200Response', 'DeleteVendorConnectorMapping200Response'] +slug: /tools/sdk/powershell/v3/models/delete-vendor-connector-mapping200-response +tags: ['SDK', 'Software Development Kit', 'DeleteVendorConnectorMapping200Response', 'DeleteVendorConnectorMapping200Response'] +--- + + +# DeleteVendorConnectorMapping200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | Pointer to **Int32** | The number of vendor connector mappings successfully deleted. | [optional] + +## Examples + +- Prepare the resource +```powershell +$DeleteVendorConnectorMapping200Response = Initialize-PSSailpoint.V3DeleteVendorConnectorMapping200Response -Count 1 +``` + +- Convert the resource to JSON +```powershell +$DeleteVendorConnectorMapping200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/DependantAppConnections.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DependantAppConnections.md new file mode 100644 index 000000000..a90751d3a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DependantAppConnections.md @@ -0,0 +1,51 @@ +--- +id: dependant-app-connections +title: DependantAppConnections +pagination_label: DependantAppConnections +sidebar_label: DependantAppConnections +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DependantAppConnections', 'DependantAppConnections'] +slug: /tools/sdk/powershell/v3/models/dependant-app-connections +tags: ['SDK', 'Software Development Kit', 'DependantAppConnections', 'DependantAppConnections'] +--- + + +# DependantAppConnections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CloudAppId** | Pointer to **String** | Id of the connected Application | [optional] +**Description** | Pointer to **String** | Description of the connected Application | [optional] +**Enabled** | Pointer to **Boolean** | Is the Application enabled | [optional] [default to $true] +**ProvisionRequestEnabled** | Pointer to **Boolean** | Is Provisioning enabled for connected Application | [optional] [default to $true] +**AccountSource** | Pointer to [**DependantAppConnectionsAccountSource**](dependant-app-connections-account-source) | | [optional] +**LauncherCount** | Pointer to **Int64** | The amount of launchers for connected Application (long type) | [optional] +**MatchAllAccount** | Pointer to **Boolean** | Is Provisioning enabled for connected Application | [optional] [default to $false] +**Owner** | Pointer to [**[]BaseReferenceDto**](base-reference-dto) | The owner of the connected Application | [optional] +**AppCenterEnabled** | Pointer to **Boolean** | Is App Center enabled for connected Application | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$DependantAppConnections = Initialize-PSSailpoint.V3DependantAppConnections -CloudAppId 9e3cdd80edf84f119327df8bbd5bb5ac ` + -Description This is a Sailpoint application ` + -Enabled true ` + -ProvisionRequestEnabled true ` + -AccountSource null ` + -LauncherCount 100 ` + -MatchAllAccount true ` + -Owner null ` + -AppCenterEnabled false +``` + +- Convert the resource to JSON +```powershell +$DependantAppConnections | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/DependantAppConnectionsAccountSource.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DependantAppConnectionsAccountSource.md new file mode 100644 index 000000000..23d9a815a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DependantAppConnectionsAccountSource.md @@ -0,0 +1,37 @@ +--- +id: dependant-app-connections-account-source +title: DependantAppConnectionsAccountSource +pagination_label: DependantAppConnectionsAccountSource +sidebar_label: DependantAppConnectionsAccountSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DependantAppConnectionsAccountSource', 'DependantAppConnectionsAccountSource'] +slug: /tools/sdk/powershell/v3/models/dependant-app-connections-account-source +tags: ['SDK', 'Software Development Kit', 'DependantAppConnectionsAccountSource', 'DependantAppConnectionsAccountSource'] +--- + + +# DependantAppConnectionsAccountSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UseForPasswordManagement** | Pointer to **Boolean** | Use this Account Source for password management | [optional] [default to $false] +**PasswordPolicies** | Pointer to [**[]DependantAppConnectionsAccountSourcePasswordPoliciesInner**](dependant-app-connections-account-source-password-policies-inner) | A list of Password Policies for this Account Source | [optional] + +## Examples + +- Prepare the resource +```powershell +$DependantAppConnectionsAccountSource = Initialize-PSSailpoint.V3DependantAppConnectionsAccountSource -UseForPasswordManagement false ` + -PasswordPolicies null +``` + +- Convert the resource to JSON +```powershell +$DependantAppConnectionsAccountSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/DependantAppConnectionsAccountSourcePasswordPoliciesInner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DependantAppConnectionsAccountSourcePasswordPoliciesInner.md new file mode 100644 index 000000000..9c686e398 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DependantAppConnectionsAccountSourcePasswordPoliciesInner.md @@ -0,0 +1,39 @@ +--- +id: dependant-app-connections-account-source-password-policies-inner +title: DependantAppConnectionsAccountSourcePasswordPoliciesInner +pagination_label: DependantAppConnectionsAccountSourcePasswordPoliciesInner +sidebar_label: DependantAppConnectionsAccountSourcePasswordPoliciesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DependantAppConnectionsAccountSourcePasswordPoliciesInner', 'DependantAppConnectionsAccountSourcePasswordPoliciesInner'] +slug: /tools/sdk/powershell/v3/models/dependant-app-connections-account-source-password-policies-inner +tags: ['SDK', 'Software Development Kit', 'DependantAppConnectionsAccountSourcePasswordPoliciesInner', 'DependantAppConnectionsAccountSourcePasswordPoliciesInner'] +--- + + +# DependantAppConnectionsAccountSourcePasswordPoliciesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **String** | DTO type | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] + +## Examples + +- Prepare the resource +```powershell +$DependantAppConnectionsAccountSourcePasswordPoliciesInner = Initialize-PSSailpoint.V3DependantAppConnectionsAccountSourcePasswordPoliciesInner -Type PASSWORD_POLICY ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name Policy ODS +``` + +- Convert the resource to JSON +```powershell +$DependantAppConnectionsAccountSourcePasswordPoliciesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/DependantConnectionsMissingDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DependantConnectionsMissingDto.md new file mode 100644 index 000000000..b776f30e0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DependantConnectionsMissingDto.md @@ -0,0 +1,37 @@ +--- +id: dependant-connections-missing-dto +title: DependantConnectionsMissingDto +pagination_label: DependantConnectionsMissingDto +sidebar_label: DependantConnectionsMissingDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DependantConnectionsMissingDto', 'DependantConnectionsMissingDto'] +slug: /tools/sdk/powershell/v3/models/dependant-connections-missing-dto +tags: ['SDK', 'Software Development Kit', 'DependantConnectionsMissingDto', 'DependantConnectionsMissingDto'] +--- + + +# DependantConnectionsMissingDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DependencyType** | Pointer to **Enum** [ "identityProfiles", "credentialProfiles", "mappingProfiles", "sourceAttributes", "dependantCustomTransforms", "dependantApps" ] | The type of dependency type that is missing in the SourceConnections | [optional] +**Reason** | Pointer to **String** | The reason why this dependency is missing | [optional] + +## Examples + +- Prepare the resource +```powershell +$DependantConnectionsMissingDto = Initialize-PSSailpoint.V3DependantConnectionsMissingDto -DependencyType dependantApps ` + -Reason If there was an error retrieving any dependencies, it would lbe listed here +``` + +- Convert the resource to JSON +```powershell +$DependantConnectionsMissingDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/DimensionRef.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DimensionRef.md new file mode 100644 index 000000000..597afbf13 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DimensionRef.md @@ -0,0 +1,39 @@ +--- +id: dimension-ref +title: DimensionRef +pagination_label: DimensionRef +sidebar_label: DimensionRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DimensionRef', 'DimensionRef'] +slug: /tools/sdk/powershell/v3/models/dimension-ref +tags: ['SDK', 'Software Development Kit', 'DimensionRef', 'DimensionRef'] +--- + + +# DimensionRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "DIMENSION" ] | The type of the object to which this reference applies | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] + +## Examples + +- Prepare the resource +```powershell +$DimensionRef = Initialize-PSSailpoint.V3DimensionRef -Type DIMENSION ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name Role 2 +``` + +- Convert the resource to JSON +```powershell +$DimensionRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/DisplayReference.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DisplayReference.md new file mode 100644 index 000000000..b7bf63d53 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DisplayReference.md @@ -0,0 +1,39 @@ +--- +id: display-reference +title: DisplayReference +pagination_label: DisplayReference +sidebar_label: DisplayReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DisplayReference', 'DisplayReference'] +slug: /tools/sdk/powershell/v3/models/display-reference +tags: ['SDK', 'Software Development Kit', 'DisplayReference', 'DisplayReference'] +--- + + +# DisplayReference + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$DisplayReference = Initialize-PSSailpoint.V3DisplayReference -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -DisplayName John Q. Doe +``` + +- Convert the resource to JSON +```powershell +$DisplayReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/DocumentType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DocumentType.md new file mode 100644 index 000000000..e96929a4e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DocumentType.md @@ -0,0 +1,36 @@ +--- +id: document-type +title: DocumentType +pagination_label: DocumentType +sidebar_label: DocumentType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DocumentType', 'DocumentType'] +slug: /tools/sdk/powershell/v3/models/document-type +tags: ['SDK', 'Software Development Kit', 'DocumentType', 'DocumentType'] +--- + + +# DocumentType + +## Enum + + +* `accessprofile` (value: `"accessprofile"`) + +* `accountactivity` (value: `"accountactivity"`) + +* `account` (value: `"account"`) + +* `aggregation` (value: `"aggregation"`) + +* `entitlement` (value: `"entitlement"`) + +* `event` (value: `"event"`) + +* `identity` (value: `"identity"`) + +* `role` (value: `"role"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/DtoType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DtoType.md new file mode 100644 index 000000000..6b654c81a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DtoType.md @@ -0,0 +1,78 @@ +--- +id: dto-type +title: DtoType +pagination_label: DtoType +sidebar_label: DtoType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DtoType', 'DtoType'] +slug: /tools/sdk/powershell/v3/models/dto-type +tags: ['SDK', 'Software Development Kit', 'DtoType', 'DtoType'] +--- + + +# DtoType + +## Enum + + +* `ACCOUNT_CORRELATION_CONFIG` (value: `"ACCOUNT_CORRELATION_CONFIG"`) + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ACCESS_REQUEST_APPROVAL` (value: `"ACCESS_REQUEST_APPROVAL"`) + +* `ACCOUNT` (value: `"ACCOUNT"`) + +* `APPLICATION` (value: `"APPLICATION"`) + +* `CAMPAIGN` (value: `"CAMPAIGN"`) + +* `CAMPAIGN_FILTER` (value: `"CAMPAIGN_FILTER"`) + +* `CERTIFICATION` (value: `"CERTIFICATION"`) + +* `CLUSTER` (value: `"CLUSTER"`) + +* `CONNECTOR_SCHEMA` (value: `"CONNECTOR_SCHEMA"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + +* `GOVERNANCE_GROUP` (value: `"GOVERNANCE_GROUP"`) + +* `IDENTITY` (value: `"IDENTITY"`) + +* `IDENTITY_PROFILE` (value: `"IDENTITY_PROFILE"`) + +* `IDENTITY_REQUEST` (value: `"IDENTITY_REQUEST"`) + +* `MACHINE_IDENTITY` (value: `"MACHINE_IDENTITY"`) + +* `LIFECYCLE_STATE` (value: `"LIFECYCLE_STATE"`) + +* `PASSWORD_POLICY` (value: `"PASSWORD_POLICY"`) + +* `ROLE` (value: `"ROLE"`) + +* `RULE` (value: `"RULE"`) + +* `SOD_POLICY` (value: `"SOD_POLICY"`) + +* `SOURCE` (value: `"SOURCE"`) + +* `TAG` (value: `"TAG"`) + +* `TAG_CATEGORY` (value: `"TAG_CATEGORY"`) + +* `TASK_RESULT` (value: `"TASK_RESULT"`) + +* `REPORT_RESULT` (value: `"REPORT_RESULT"`) + +* `SOD_VIOLATION` (value: `"SOD_VIOLATION"`) + +* `ACCOUNT_ACTIVITY` (value: `"ACCOUNT_ACTIVITY"`) + +* `WORKGROUP` (value: `"WORKGROUP"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/DuoVerificationRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DuoVerificationRequest.md new file mode 100644 index 000000000..4f0891099 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/DuoVerificationRequest.md @@ -0,0 +1,37 @@ +--- +id: duo-verification-request +title: DuoVerificationRequest +pagination_label: DuoVerificationRequest +sidebar_label: DuoVerificationRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'DuoVerificationRequest', 'DuoVerificationRequest'] +slug: /tools/sdk/powershell/v3/models/duo-verification-request +tags: ['SDK', 'Software Development Kit', 'DuoVerificationRequest', 'DuoVerificationRequest'] +--- + + +# DuoVerificationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserId** | **String** | User id for Verification request. | [required] +**SignedResponse** | **String** | User id for Verification request. | [required] + +## Examples + +- Prepare the resource +```powershell +$DuoVerificationRequest = Initialize-PSSailpoint.V3DuoVerificationRequest -UserId 2c9180947f0ef465017f215cbcfd004b ` + -SignedResponse AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2 +``` + +- Convert the resource to JSON +```powershell +$DuoVerificationRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/E164phone.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/E164phone.md new file mode 100644 index 000000000..8f66defd2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/E164phone.md @@ -0,0 +1,39 @@ +--- +id: e164phone +title: E164phone +pagination_label: E164phone +sidebar_label: E164phone +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'E164phone', 'E164phone'] +slug: /tools/sdk/powershell/v3/models/e164phone +tags: ['SDK', 'Software Development Kit', 'E164phone', 'E164phone'] +--- + + +# E164phone + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DefaultRegion** | Pointer to **String** | This is an optional attribute that can be used to define the region of the phone number to format into. If defaultRegion is not provided, it will take US as the default country. The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) | [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] + +## Examples + +- Prepare the resource +```powershell +$E164phone = Initialize-PSSailpoint.V3E164phone -DefaultRegion US ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$E164phone | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/EmailNotificationOption.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/EmailNotificationOption.md new file mode 100644 index 000000000..bb54b66a0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/EmailNotificationOption.md @@ -0,0 +1,41 @@ +--- +id: email-notification-option +title: EmailNotificationOption +pagination_label: EmailNotificationOption +sidebar_label: EmailNotificationOption +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EmailNotificationOption', 'EmailNotificationOption'] +slug: /tools/sdk/powershell/v3/models/email-notification-option +tags: ['SDK', 'Software Development Kit', 'EmailNotificationOption', 'EmailNotificationOption'] +--- + + +# EmailNotificationOption + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NotifyManagers** | Pointer to **Boolean** | If true, then the manager is notified of the lifecycle state change. | [optional] [default to $false] +**NotifyAllAdmins** | Pointer to **Boolean** | If true, then all the admins are notified of the lifecycle state change. | [optional] [default to $false] +**NotifySpecificUsers** | Pointer to **Boolean** | If true, then the users specified in ""emailAddressList"" below are notified of lifecycle state change. | [optional] [default to $false] +**EmailAddressList** | Pointer to **[]String** | List of user email addresses. If ""notifySpecificUsers"" option is true, then these users are notified of lifecycle state change. | [optional] + +## Examples + +- Prepare the resource +```powershell +$EmailNotificationOption = Initialize-PSSailpoint.V3EmailNotificationOption -NotifyManagers true ` + -NotifyAllAdmins true ` + -NotifySpecificUsers true ` + -EmailAddressList [test@test.com, test2@test.com] +``` + +- Convert the resource to JSON +```powershell +$EmailNotificationOption | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Entitlement.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Entitlement.md new file mode 100644 index 000000000..7913c7c0a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Entitlement.md @@ -0,0 +1,61 @@ +--- +id: entitlement +title: Entitlement +pagination_label: Entitlement +sidebar_label: Entitlement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Entitlement', 'Entitlement'] +slug: /tools/sdk/powershell/v3/models/entitlement +tags: ['SDK', 'Software Development Kit', 'Entitlement', 'Entitlement'] +--- + + +# Entitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The entitlement id | [optional] +**Name** | Pointer to **String** | The entitlement name | [optional] +**Attribute** | Pointer to **String** | The entitlement attribute name | [optional] +**Value** | Pointer to **String** | The value of the entitlement | [optional] +**SourceSchemaObjectType** | Pointer to **String** | The object type of the entitlement from the source schema | [optional] +**Description** | Pointer to **String** | The description of the entitlement | [optional] +**Privileged** | Pointer to **Boolean** | True if the entitlement is privileged | [optional] +**CloudGoverned** | Pointer to **Boolean** | True if the entitlement is cloud governed | [optional] +**Created** | Pointer to **System.DateTime** | Time when the entitlement was created | [optional] +**Modified** | Pointer to **System.DateTime** | Time when the entitlement was last modified | [optional] +**Source** | Pointer to [**EntitlementSource**](entitlement-source) | | [optional] +**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map of free-form key-value pairs from the source system | [optional] +**Segments** | Pointer to **[]String** | List of IDs of segments, if any, to which this Entitlement is assigned. | [optional] +**DirectPermissions** | Pointer to [**[]PermissionDto**](permission-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Entitlement = Initialize-PSSailpoint.V3Entitlement -Id 2c91808874ff91550175097daaec161c ` + -Name LauncherTest2 ` + -Attribute memberOf ` + -Value CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` + -SourceSchemaObjectType group ` + -Description CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` + -Privileged true ` + -CloudGoverned true ` + -Created 2020-10-08T18:33:52.029Z ` + -Modified 2020-10-08T18:33:52.029Z ` + -Source null ` + -Attributes {fieldName=fieldValue} ` + -Segments [f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a] ` + -DirectPermissions null +``` + +- Convert the resource to JSON +```powershell +$Entitlement | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/EntitlementDocument.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/EntitlementDocument.md new file mode 100644 index 000000000..0ba4994b8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/EntitlementDocument.md @@ -0,0 +1,63 @@ +--- +id: entitlement-document +title: EntitlementDocument +pagination_label: EntitlementDocument +sidebar_label: EntitlementDocument +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementDocument', 'EntitlementDocument'] +slug: /tools/sdk/powershell/v3/models/entitlement-document +tags: ['SDK', 'Software Development Kit', 'EntitlementDocument', 'EntitlementDocument'] +--- + + +# EntitlementDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | [required] +**Name** | **String** | | [required] +**Type** | [**DocumentType**](document-type) | | [required] +**Modified** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional] +**Synced** | Pointer to **String** | 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] +**DisplayName** | Pointer to **String** | Entitlement's display name. | [optional] +**Source** | Pointer to [**EntitlementDocumentAllOfSource**](entitlement-document-all-of-source) | | [optional] +**Segments** | Pointer to [**[]BaseSegment**](base-segment) | Segments with the role. | [optional] +**SegmentCount** | Pointer to **Int32** | Number of segments with the role. | [optional] +**Requestable** | Pointer to **Boolean** | Indicates whether the entitlement is requestable. | [optional] [default to $false] +**CloudGoverned** | Pointer to **Boolean** | Indicates whether the entitlement is cloud governed. | [optional] [default to $false] +**Created** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Privileged** | Pointer to **Boolean** | Indicates whether the entitlement is privileged. | [optional] [default to $false] +**IdentityCount** | Pointer to **Int32** | Number of identities who have access to the entitlement. | [optional] +**Tags** | Pointer to **[]String** | Tags that have been applied to the object. | [optional] + +## Examples + +- Prepare the resource +```powershell +$EntitlementDocument = Initialize-PSSailpoint.V3EntitlementDocument -Id 2c91808375d8e80a0175e1f88a575222 ` + -Name john.doe ` + -Type null ` + -Modified 2018-06-25T20:22:28.104Z ` + -Synced null ` + -DisplayName Admin ` + -Source null ` + -Segments null ` + -SegmentCount 1 ` + -Requestable false ` + -CloudGoverned false ` + -Created 2018-06-25T20:22:28.104Z ` + -Privileged false ` + -IdentityCount 3 ` + -Tags [TAG_1, TAG_2] +``` + +- Convert the resource to JSON +```powershell +$EntitlementDocument | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/EntitlementDocumentAllOfSource.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/EntitlementDocumentAllOfSource.md new file mode 100644 index 000000000..c3fbb4595 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/EntitlementDocumentAllOfSource.md @@ -0,0 +1,37 @@ +--- +id: entitlement-document-all-of-source +title: EntitlementDocumentAllOfSource +pagination_label: EntitlementDocumentAllOfSource +sidebar_label: EntitlementDocumentAllOfSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementDocumentAllOfSource', 'EntitlementDocumentAllOfSource'] +slug: /tools/sdk/powershell/v3/models/entitlement-document-all-of-source +tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfSource', 'EntitlementDocumentAllOfSource'] +--- + + +# EntitlementDocumentAllOfSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of entitlement's source. | [optional] +**Name** | Pointer to **String** | Display name of entitlement's source. | [optional] + +## Examples + +- Prepare the resource +```powershell +$EntitlementDocumentAllOfSource = Initialize-PSSailpoint.V3EntitlementDocumentAllOfSource -Id 2c91808b6e9e6fb8016eec1a2b6f7b5f ` + -Name ODS-HR-Employees +``` + +- Convert the resource to JSON +```powershell +$EntitlementDocumentAllOfSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/EntitlementDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/EntitlementDto.md new file mode 100644 index 000000000..50c63a35c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/EntitlementDto.md @@ -0,0 +1,57 @@ +--- +id: entitlement-dto +title: EntitlementDto +pagination_label: EntitlementDto +sidebar_label: EntitlementDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementDto', 'EntitlementDto'] +slug: /tools/sdk/powershell/v3/models/entitlement-dto +tags: ['SDK', 'Software Development Kit', 'EntitlementDto', 'EntitlementDto'] +--- + + +# EntitlementDto + +## Properties + +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] +**Attribute** | Pointer to **String** | Name of the entitlement attribute | [optional] +**Value** | Pointer to **String** | Raw value of the entitlement | [optional] +**Description** | Pointer to **String** | Entitlment description | [optional] +**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Entitlement attributes | [optional] +**SourceSchemaObjectType** | Pointer to **String** | Schema objectType on the given application that maps to an Account Group | [optional] +**Privileged** | Pointer to **Boolean** | Determines if this Entitlement is privileged. | [optional] +**CloudGoverned** | Pointer to **Boolean** | Determines if this Entitlement is goverened in the cloud. | [optional] +**Source** | Pointer to [**EntitlementSource**](entitlement-source) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$EntitlementDto = Initialize-PSSailpoint.V3EntitlementDto -Id id12345 ` + -Name aName ` + -Created 2015-05-28T14:07:17Z ` + -Modified 2015-05-28T14:07:17Z ` + -Attribute authorizationType ` + -Value CN=Users,dc=sailpoint,dc=com ` + -Description Active Directory DC ` + -Attributes {GroupType=Security, sAMAccountName=Buyer} ` + -SourceSchemaObjectType group ` + -Privileged false ` + -CloudGoverned false ` + -Source null +``` + +- Convert the resource to JSON +```powershell +$EntitlementDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/EntitlementRef.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/EntitlementRef.md new file mode 100644 index 000000000..db8b2bc89 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/EntitlementRef.md @@ -0,0 +1,39 @@ +--- +id: entitlement-ref +title: EntitlementRef +pagination_label: EntitlementRef +sidebar_label: EntitlementRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementRef', 'EntitlementRef'] +slug: /tools/sdk/powershell/v3/models/entitlement-ref +tags: ['SDK', 'Software Development Kit', 'EntitlementRef', 'EntitlementRef'] +--- + + +# EntitlementRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | Entitlement's DTO type. | [optional] +**Id** | Pointer to **String** | Entitlement's ID. | [optional] +**Name** | Pointer to **String** | Entitlement's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$EntitlementRef = Initialize-PSSailpoint.V3EntitlementRef -Type ENTITLEMENT ` + -Id 2c91809773dee32014e13e122092014e ` + -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local +``` + +- Convert the resource to JSON +```powershell +$EntitlementRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/EntitlementRef1.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/EntitlementRef1.md new file mode 100644 index 000000000..e23742018 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/EntitlementRef1.md @@ -0,0 +1,39 @@ +--- +id: entitlement-ref1 +title: EntitlementRef1 +pagination_label: EntitlementRef1 +sidebar_label: EntitlementRef1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementRef1', 'EntitlementRef1'] +slug: /tools/sdk/powershell/v3/models/entitlement-ref1 +tags: ['SDK', 'Software Development Kit', 'EntitlementRef1', 'EntitlementRef1'] +--- + + +# EntitlementRef1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | Entitlement's DTO type. | [optional] +**Id** | Pointer to **String** | Entitlement's ID. | [optional] +**Name** | Pointer to **String** | Entitlement's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$EntitlementRef1 = Initialize-PSSailpoint.V3EntitlementRef1 -Type ENTITLEMENT ` + -Id 2c91809773dee32014e13e122092014e ` + -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local +``` + +- Convert the resource to JSON +```powershell +$EntitlementRef1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/EntitlementRequestConfig.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/EntitlementRequestConfig.md new file mode 100644 index 000000000..cde603720 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/EntitlementRequestConfig.md @@ -0,0 +1,41 @@ +--- +id: entitlement-request-config +title: EntitlementRequestConfig +pagination_label: EntitlementRequestConfig +sidebar_label: EntitlementRequestConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementRequestConfig', 'EntitlementRequestConfig'] +slug: /tools/sdk/powershell/v3/models/entitlement-request-config +tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig', 'EntitlementRequestConfig'] +--- + + +# EntitlementRequestConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AllowEntitlementRequest** | Pointer to **Boolean** | If this is true, entitlement requests are allowed. | [optional] [default to $false] +**RequestCommentsRequired** | Pointer to **Boolean** | If this is true, comments are required to submit entitlement requests. | [optional] [default to $false] +**DeniedCommentsRequired** | Pointer to **Boolean** | If this is true, comments are required to reject entitlement requests. | [optional] [default to $false] +**GrantRequestApprovalSchemes** | Pointer to **String** | Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are ""entitlementOwner"", ""sourceOwner"", ""manager"" and ""`workgroup:{id}`"". You can use multiple governance groups (workgroups). | [optional] [default to "sourceOwner"] + +## Examples + +- Prepare the resource +```powershell +$EntitlementRequestConfig = Initialize-PSSailpoint.V3EntitlementRequestConfig -AllowEntitlementRequest true ` + -RequestCommentsRequired false ` + -DeniedCommentsRequired false ` + -GrantRequestApprovalSchemes entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584 +``` + +- Convert the resource to JSON +```powershell +$EntitlementRequestConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/EntitlementSource.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/EntitlementSource.md new file mode 100644 index 000000000..727c2c4a9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/EntitlementSource.md @@ -0,0 +1,39 @@ +--- +id: entitlement-source +title: EntitlementSource +pagination_label: EntitlementSource +sidebar_label: EntitlementSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementSource', 'EntitlementSource'] +slug: /tools/sdk/powershell/v3/models/entitlement-source +tags: ['SDK', 'Software Development Kit', 'EntitlementSource', 'EntitlementSource'] +--- + + +# EntitlementSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The source ID | [optional] +**Type** | Pointer to **String** | The source type, will always be ""SOURCE"" | [optional] +**Name** | Pointer to **String** | The source name | [optional] + +## Examples + +- Prepare the resource +```powershell +$EntitlementSource = Initialize-PSSailpoint.V3EntitlementSource -Id 2c9180827ca885d7017ca8ce28a000eb ` + -Type SOURCE ` + -Name ODS-AD-Source +``` + +- Convert the resource to JSON +```powershell +$EntitlementSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/EntitlementSummary.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/EntitlementSummary.md new file mode 100644 index 000000000..ec2b4432d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/EntitlementSummary.md @@ -0,0 +1,53 @@ +--- +id: entitlement-summary +title: EntitlementSummary +pagination_label: EntitlementSummary +sidebar_label: EntitlementSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementSummary', 'EntitlementSummary'] +slug: /tools/sdk/powershell/v3/models/entitlement-summary +tags: ['SDK', 'Software Development Kit', 'EntitlementSummary', 'EntitlementSummary'] +--- + + +# EntitlementSummary + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$EntitlementSummary = Initialize-PSSailpoint.V3EntitlementSummary -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -DisplayName John Q. Doe ` + -Type null ` + -Description null ` + -Source null ` + -Privileged false ` + -Attribute memberOf ` + -Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com ` + -Standalone false +``` + +- Convert the resource to JSON +```powershell +$EntitlementSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ErrorMessageDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ErrorMessageDto.md new file mode 100644 index 000000000..affab537d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ErrorMessageDto.md @@ -0,0 +1,39 @@ +--- +id: error-message-dto +title: ErrorMessageDto +pagination_label: ErrorMessageDto +sidebar_label: ErrorMessageDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ErrorMessageDto', 'ErrorMessageDto'] +slug: /tools/sdk/powershell/v3/models/error-message-dto +tags: ['SDK', 'Software Development Kit', 'ErrorMessageDto', 'ErrorMessageDto'] +--- + + +# ErrorMessageDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Locale** | Pointer to **String** | The locale for the message text, a BCP 47 language tag. | [optional] +**LocaleOrigin** | Pointer to [**LocaleOrigin**](locale-origin) | | [optional] +**Text** | Pointer to **String** | Actual text of the error message in the indicated locale. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ErrorMessageDto = Initialize-PSSailpoint.V3ErrorMessageDto -Locale en-US ` + -LocaleOrigin null ` + -Text The request was syntactically correct but its content is semantically invalid. +``` + +- Convert the resource to JSON +```powershell +$ErrorMessageDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ErrorResponseDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ErrorResponseDto.md new file mode 100644 index 000000000..05ffafdc9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ErrorResponseDto.md @@ -0,0 +1,41 @@ +--- +id: error-response-dto +title: ErrorResponseDto +pagination_label: ErrorResponseDto +sidebar_label: ErrorResponseDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ErrorResponseDto', 'ErrorResponseDto'] +slug: /tools/sdk/powershell/v3/models/error-response-dto +tags: ['SDK', 'Software Development Kit', 'ErrorResponseDto', 'ErrorResponseDto'] +--- + + +# ErrorResponseDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetailCode** | Pointer to **String** | Fine-grained error code providing more detail of the error. | [optional] +**TrackingId** | Pointer to **String** | Unique tracking id for the error. | [optional] +**Messages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | Generic localized reason for error | [optional] +**Causes** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [optional] + +## Examples + +- Prepare the resource +```powershell +$ErrorResponseDto = Initialize-PSSailpoint.V3ErrorResponseDto -DetailCode 400.1 Bad Request Content ` + -TrackingId e7eab60924f64aa284175b9fa3309599 ` + -Messages null ` + -Causes null +``` + +- Convert the resource to JSON +```powershell +$ErrorResponseDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Event.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Event.md new file mode 100644 index 000000000..a69d000d5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Event.md @@ -0,0 +1,69 @@ +--- +id: model-event +title: ModelEvent +pagination_label: ModelEvent +sidebar_label: ModelEvent +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ModelEvent', 'ModelEvent'] +slug: /tools/sdk/powershell/v3/models/model-event +tags: ['SDK', 'Software Development Kit', 'ModelEvent', 'ModelEvent'] +--- + + +# ModelEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | [required] +**Name** | **String** | | [required] +**Type** | [**DocumentType**](document-type) | | [required] +**Created** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Synced** | Pointer to **String** | 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] +**Action** | Pointer to **String** | Name of the event as it's displayed in audit reports. | [optional] +**Type** | Pointer to **String** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional] +**Actor** | Pointer to **String** | Name of the actor that generated the event. | [optional] +**Target** | Pointer to **String** | Name of the target, or recipient, of the event. | [optional] +**Stack** | Pointer to **String** | The event's stack. | [optional] +**TrackingNumber** | Pointer to **String** | ID of the group of events. | [optional] +**IpAddress** | Pointer to **String** | Target system's IP address. | [optional] +**Details** | Pointer to **String** | ID of event's details. | [optional] +**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Attributes involved in the event. | [optional] +**Objects** | Pointer to **[]String** | Objects the event is happening to. | [optional] +**Operation** | Pointer to **String** | Operation, or action, performed during the event. | [optional] +**Status** | Pointer to **String** | Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. | [optional] +**TechnicalName** | Pointer to **String** | Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ModelEvent = Initialize-PSSailpoint.V3ModelEvent -Id 2c91808375d8e80a0175e1f88a575222 ` + -Name john.doe ` + -Type null ` + -Created 2018-06-25T20:22:28.104Z ` + -Synced null ` + -Action update ` + -Type SYSTEM_CONFIG ` + -Actor System ` + -Target Carol.Adams ` + -Stack tpe ` + -TrackingNumber 63f891e0735f4cc8bf1968144a1e7440 ` + -IpAddress 52.52.97.85 ` + -Details 73b65dfbed1842548c207432a18c84b0 ` + -Attributes {pod=stg03-useast1, org=acme, sourceName=SailPoint} ` + -Objects null ` + -Operation REQUEST ` + -Status PASSED ` + -TechnicalName AUTHENTICATION_REQUEST_PASSED +``` + +- Convert the resource to JSON +```powershell +$ModelEvent | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/EventAttributes.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/EventAttributes.md new file mode 100644 index 000000000..3ebd5ba25 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/EventAttributes.md @@ -0,0 +1,41 @@ +--- +id: event-attributes +title: EventAttributes +pagination_label: EventAttributes +sidebar_label: EventAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EventAttributes', 'EventAttributes'] +slug: /tools/sdk/powershell/v3/models/event-attributes +tags: ['SDK', 'Software Development Kit', 'EventAttributes', 'EventAttributes'] +--- + + +# EventAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the trigger | [required] +**VarFilter** | Pointer to **String** | JSON path expression that will limit which events the trigger will fire on | [optional] +**Description** | Pointer to **String** | Description of the event trigger | [optional] +**AttributeToFilter** | Pointer to **String** | The attribute to filter on | [optional] + +## Examples + +- Prepare the resource +```powershell +$EventAttributes = Initialize-PSSailpoint.V3EventAttributes -Id idn:identity-attributes-changed ` + -VarFilter $.changes[?(@.attribute == 'manager')] ` + -Description Triggered when an identity's manager attribute changes ` + -AttributeToFilter LifecycleState +``` + +- Convert the resource to JSON +```powershell +$EventAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/EventDocument.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/EventDocument.md new file mode 100644 index 000000000..bf654f660 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/EventDocument.md @@ -0,0 +1,69 @@ +--- +id: event-document +title: EventDocument +pagination_label: EventDocument +sidebar_label: EventDocument +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'EventDocument', 'EventDocument'] +slug: /tools/sdk/powershell/v3/models/event-document +tags: ['SDK', 'Software Development Kit', 'EventDocument', 'EventDocument'] +--- + + +# EventDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | | [required] +**Name** | **String** | | [required] +**Type** | [**DocumentType**](document-type) | | [required] +**Created** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional] +**Synced** | Pointer to **String** | 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] +**Action** | Pointer to **String** | Name of the event as it's displayed in audit reports. | [optional] +**Type** | Pointer to **String** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional] +**Actor** | Pointer to **String** | Name of the actor that generated the event. | [optional] +**Target** | Pointer to **String** | Name of the target, or recipient, of the event. | [optional] +**Stack** | Pointer to **String** | The event's stack. | [optional] +**TrackingNumber** | Pointer to **String** | ID of the group of events. | [optional] +**IpAddress** | Pointer to **String** | Target system's IP address. | [optional] +**Details** | Pointer to **String** | ID of event's details. | [optional] +**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Attributes involved in the event. | [optional] +**Objects** | Pointer to **[]String** | Objects the event is happening to. | [optional] +**Operation** | Pointer to **String** | Operation, or action, performed during the event. | [optional] +**Status** | Pointer to **String** | Event status. Refer to [Event Statuses](https://documentation.sailpoint.com/saas/help/search/index.html#event-statuses) for a list of event statuses and their meanings. | [optional] +**TechnicalName** | Pointer to **String** | Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. | [optional] + +## Examples + +- Prepare the resource +```powershell +$EventDocument = Initialize-PSSailpoint.V3EventDocument -Id 2c91808375d8e80a0175e1f88a575222 ` + -Name john.doe ` + -Type null ` + -Created 2018-06-25T20:22:28.104Z ` + -Synced null ` + -Action update ` + -Type SYSTEM_CONFIG ` + -Actor System ` + -Target Carol.Adams ` + -Stack tpe ` + -TrackingNumber 63f891e0735f4cc8bf1968144a1e7440 ` + -IpAddress 52.52.97.85 ` + -Details 73b65dfbed1842548c207432a18c84b0 ` + -Attributes {pod=stg03-useast1, org=acme, sourceName=SailPoint} ` + -Objects null ` + -Operation REQUEST ` + -Status PASSED ` + -TechnicalName AUTHENTICATION_REQUEST_PASSED +``` + +- Convert the resource to JSON +```powershell +$EventDocument | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ExceptionAccessCriteria.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ExceptionAccessCriteria.md new file mode 100644 index 000000000..49c823dcc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ExceptionAccessCriteria.md @@ -0,0 +1,37 @@ +--- +id: exception-access-criteria +title: ExceptionAccessCriteria +pagination_label: ExceptionAccessCriteria +sidebar_label: ExceptionAccessCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExceptionAccessCriteria', 'ExceptionAccessCriteria'] +slug: /tools/sdk/powershell/v3/models/exception-access-criteria +tags: ['SDK', 'Software Development Kit', 'ExceptionAccessCriteria', 'ExceptionAccessCriteria'] +--- + + +# ExceptionAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**ExceptionCriteria**](exception-criteria) | | [optional] +**RightCriteria** | Pointer to [**ExceptionCriteria**](exception-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ExceptionAccessCriteria = Initialize-PSSailpoint.V3ExceptionAccessCriteria -LeftCriteria null ` + -RightCriteria null +``` + +- Convert the resource to JSON +```powershell +$ExceptionAccessCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ExceptionCriteria.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ExceptionCriteria.md new file mode 100644 index 000000000..b19a38418 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ExceptionCriteria.md @@ -0,0 +1,35 @@ +--- +id: exception-criteria +title: ExceptionCriteria +pagination_label: ExceptionCriteria +sidebar_label: ExceptionCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExceptionCriteria', 'ExceptionCriteria'] +slug: /tools/sdk/powershell/v3/models/exception-criteria +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteria', 'ExceptionCriteria'] +--- + + +# ExceptionCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CriteriaList** | Pointer to [**[]ExceptionCriteriaCriteriaListInner**](exception-criteria-criteria-list-inner) | List of exception criteria. There is a min of 1 and max of 50 items in the list. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ExceptionCriteria = Initialize-PSSailpoint.V3ExceptionCriteria -CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, existing=true}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, existing=false}] +``` + +- Convert the resource to JSON +```powershell +$ExceptionCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ExceptionCriteriaAccess.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ExceptionCriteriaAccess.md new file mode 100644 index 000000000..cc332420c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ExceptionCriteriaAccess.md @@ -0,0 +1,41 @@ +--- +id: exception-criteria-access +title: ExceptionCriteriaAccess +pagination_label: ExceptionCriteriaAccess +sidebar_label: ExceptionCriteriaAccess +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExceptionCriteriaAccess', 'ExceptionCriteriaAccess'] +slug: /tools/sdk/powershell/v3/models/exception-criteria-access +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteriaAccess', 'ExceptionCriteriaAccess'] +--- + + +# ExceptionCriteriaAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] +**Existing** | Pointer to **Boolean** | Whether the subject identity already had that access or not | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$ExceptionCriteriaAccess = Initialize-PSSailpoint.V3ExceptionCriteriaAccess -Type null ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local ` + -Existing true +``` + +- Convert the resource to JSON +```powershell +$ExceptionCriteriaAccess | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ExceptionCriteriaCriteriaListInner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ExceptionCriteriaCriteriaListInner.md new file mode 100644 index 000000000..9e1efe727 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ExceptionCriteriaCriteriaListInner.md @@ -0,0 +1,41 @@ +--- +id: exception-criteria-criteria-list-inner +title: ExceptionCriteriaCriteriaListInner +pagination_label: ExceptionCriteriaCriteriaListInner +sidebar_label: ExceptionCriteriaCriteriaListInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExceptionCriteriaCriteriaListInner', 'ExceptionCriteriaCriteriaListInner'] +slug: /tools/sdk/powershell/v3/models/exception-criteria-criteria-list-inner +tags: ['SDK', 'Software Development Kit', 'ExceptionCriteriaCriteriaListInner', 'ExceptionCriteriaCriteriaListInner'] +--- + + +# ExceptionCriteriaCriteriaListInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | The type of object that is referenced | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] +**Existing** | Pointer to **Boolean** | Whether the subject identity already had that access or not | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$ExceptionCriteriaCriteriaListInner = Initialize-PSSailpoint.V3ExceptionCriteriaCriteriaListInner -Type ENTITLEMENT ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local ` + -Existing true +``` + +- Convert the resource to JSON +```powershell +$ExceptionCriteriaCriteriaListInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ExecutionStatus.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ExecutionStatus.md new file mode 100644 index 000000000..2d0dd16f6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ExecutionStatus.md @@ -0,0 +1,28 @@ +--- +id: execution-status +title: ExecutionStatus +pagination_label: ExecutionStatus +sidebar_label: ExecutionStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExecutionStatus', 'ExecutionStatus'] +slug: /tools/sdk/powershell/v3/models/execution-status +tags: ['SDK', 'Software Development Kit', 'ExecutionStatus', 'ExecutionStatus'] +--- + + +# ExecutionStatus + +## Enum + + +* `EXECUTING` (value: `"EXECUTING"`) + +* `VERIFYING` (value: `"VERIFYING"`) + +* `TERMINATED` (value: `"TERMINATED"`) + +* `COMPLETED` (value: `"COMPLETED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ExpansionItem.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ExpansionItem.md new file mode 100644 index 000000000..0c4b793a4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ExpansionItem.md @@ -0,0 +1,43 @@ +--- +id: expansion-item +title: ExpansionItem +pagination_label: ExpansionItem +sidebar_label: ExpansionItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExpansionItem', 'ExpansionItem'] +slug: /tools/sdk/powershell/v3/models/expansion-item +tags: ['SDK', 'Software Development Kit', 'ExpansionItem', 'ExpansionItem'] +--- + + +# ExpansionItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | Pointer to **String** | The ID of the account | [optional] +**Cause** | Pointer to **String** | | [optional] +**Name** | Pointer to **String** | The name of the item | [optional] +**AttributeRequests** | Pointer to [**[]AttributeRequest**](attribute-request) | | [optional] +**Source** | Pointer to [**AccountSource**](account-source) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ExpansionItem = Initialize-PSSailpoint.V3ExpansionItem -AccountId 2c91808981f58ea601821c3e93482e6f ` + -Cause Role ` + -Name smartsheet-role ` + -AttributeRequests null ` + -Source null +``` + +- Convert the resource to JSON +```powershell +$ExpansionItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Expression.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Expression.md new file mode 100644 index 000000000..12c6efa81 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Expression.md @@ -0,0 +1,41 @@ +--- +id: expression +title: Expression +pagination_label: Expression +sidebar_label: Expression +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Expression', 'Expression'] +slug: /tools/sdk/powershell/v3/models/expression +tags: ['SDK', 'Software Development Kit', 'Expression', 'Expression'] +--- + + +# Expression + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operator** | Pointer to **Enum** [ "AND", "EQUALS" ] | Operator for the expression | [optional] +**Attribute** | Pointer to **String** | Name for the attribute | [optional] +**Value** | Pointer to [**Value**](value) | | [optional] +**Children** | Pointer to [**[]ExpressionChildrenInner**](expression-children-inner) | List of expressions | [optional] + +## Examples + +- Prepare the resource +```powershell +$Expression = Initialize-PSSailpoint.V3Expression -Operator EQUALS ` + -Attribute location ` + -Value null ` + -Children [] +``` + +- Convert the resource to JSON +```powershell +$Expression | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ExpressionChildrenInner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ExpressionChildrenInner.md new file mode 100644 index 000000000..05276b235 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ExpressionChildrenInner.md @@ -0,0 +1,41 @@ +--- +id: expression-children-inner +title: ExpressionChildrenInner +pagination_label: ExpressionChildrenInner +sidebar_label: ExpressionChildrenInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExpressionChildrenInner', 'ExpressionChildrenInner'] +slug: /tools/sdk/powershell/v3/models/expression-children-inner +tags: ['SDK', 'Software Development Kit', 'ExpressionChildrenInner', 'ExpressionChildrenInner'] +--- + + +# ExpressionChildrenInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operator** | Pointer to **Enum** [ "AND", "EQUALS" ] | Operator for the expression | [optional] +**Attribute** | Pointer to **String** | Name for the attribute | [optional] +**Value** | Pointer to [**Value**](value) | | [optional] +**Children** | Pointer to **String** | There cannot be anymore nested children. This will always be null. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ExpressionChildrenInner = Initialize-PSSailpoint.V3ExpressionChildrenInner -Operator EQUALS ` + -Attribute location ` + -Value null ` + -Children null +``` + +- Convert the resource to JSON +```powershell +$ExpressionChildrenInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ExternalAttributes.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ExternalAttributes.md new file mode 100644 index 000000000..1d9593f85 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ExternalAttributes.md @@ -0,0 +1,41 @@ +--- +id: external-attributes +title: ExternalAttributes +pagination_label: ExternalAttributes +sidebar_label: ExternalAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ExternalAttributes', 'ExternalAttributes'] +slug: /tools/sdk/powershell/v3/models/external-attributes +tags: ['SDK', 'Software Development Kit', 'ExternalAttributes', 'ExternalAttributes'] +--- + + +# ExternalAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | A unique name for the external trigger | [optional] +**Description** | Pointer to **String** | Additonal context about the external trigger | [optional] +**ClientId** | Pointer to **String** | OAuth Client ID to authenticate with this trigger | [optional] +**Url** | Pointer to **String** | URL to invoke this workflow | [optional] + +## Examples + +- Prepare the resource +```powershell +$ExternalAttributes = Initialize-PSSailpoint.V3ExternalAttributes -Name search-and-notify ` + -Description Run a search and notify the results ` + -ClientId 87e239b2-b85b-4bde-b9a7-55bf304ddcdc ` + -Url https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d +``` + +- Convert the resource to JSON +```powershell +$ExternalAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/FederationProtocolDetails.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/FederationProtocolDetails.md new file mode 100644 index 000000000..6fb727e65 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/FederationProtocolDetails.md @@ -0,0 +1,37 @@ +--- +id: federation-protocol-details +title: FederationProtocolDetails +pagination_label: FederationProtocolDetails +sidebar_label: FederationProtocolDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FederationProtocolDetails', 'FederationProtocolDetails'] +slug: /tools/sdk/powershell/v3/models/federation-protocol-details +tags: ['SDK', 'Software Development Kit', 'FederationProtocolDetails', 'FederationProtocolDetails'] +--- + + +# FederationProtocolDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | Pointer to **Enum** [ "SAML_IDP", "SAML_SP" ] | Federation protocol role | [optional] +**EntityId** | Pointer to **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] + +## Examples + +- Prepare the resource +```powershell +$FederationProtocolDetails = Initialize-PSSailpoint.V3FederationProtocolDetails -Role SAML_IDP ` + -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 +``` + +- Convert the resource to JSON +```powershell +$FederationProtocolDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/FieldDetailsDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/FieldDetailsDto.md new file mode 100644 index 000000000..726b13e8b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/FieldDetailsDto.md @@ -0,0 +1,45 @@ +--- +id: field-details-dto +title: FieldDetailsDto +pagination_label: FieldDetailsDto +sidebar_label: FieldDetailsDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FieldDetailsDto', 'FieldDetailsDto'] +slug: /tools/sdk/powershell/v3/models/field-details-dto +tags: ['SDK', 'Software Development Kit', 'FieldDetailsDto', 'FieldDetailsDto'] +--- + + +# FieldDetailsDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the attribute. | [optional] +**Transform** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The transform to apply to the field | [optional] +**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Attributes required for the transform | [optional] +**IsRequired** | Pointer to **Boolean** | Flag indicating whether or not the attribute is required. | [optional] [readonly] [default to $false] +**Type** | Pointer to **String** | The type of the attribute. | [optional] +**IsMultiValued** | Pointer to **Boolean** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$FieldDetailsDto = Initialize-PSSailpoint.V3FieldDetailsDto -Name userName ` + -Transform {type=rule, attributes={name=Create Unique LDAP Attribute}} ` + -Attributes {template=${firstname}.${lastname}${uniqueCounter}, cloudMaxUniqueChecks=50, cloudMaxSize=20, cloudRequired=true} ` + -IsRequired false ` + -Type string ` + -IsMultiValued false +``` + +- Convert the resource to JSON +```powershell +$FieldDetailsDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Filter.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Filter.md new file mode 100644 index 000000000..0e3118541 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Filter.md @@ -0,0 +1,41 @@ +--- +id: model-filter +title: ModelFilter +pagination_label: ModelFilter +sidebar_label: ModelFilter +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ModelFilter', 'ModelFilter'] +slug: /tools/sdk/powershell/v3/models/model-filter +tags: ['SDK', 'Software Development Kit', 'ModelFilter', 'ModelFilter'] +--- + + +# ModelFilter + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**FilterType**](filter-type) | | [optional] +**Range** | Pointer to [**Range**](range) | | [optional] +**Terms** | Pointer to **[]String** | The terms to be filtered. | [optional] +**Exclude** | Pointer to **Boolean** | Indicates if the filter excludes results. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$ModelFilter = Initialize-PSSailpoint.V3ModelFilter -Type null ` + -Range null ` + -Terms null ` + -Exclude false +``` + +- Convert the resource to JSON +```powershell +$ModelFilter | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/FilterAggregation.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/FilterAggregation.md new file mode 100644 index 000000000..dbcfcafb9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/FilterAggregation.md @@ -0,0 +1,41 @@ +--- +id: filter-aggregation +title: FilterAggregation +pagination_label: FilterAggregation +sidebar_label: FilterAggregation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FilterAggregation', 'FilterAggregation'] +slug: /tools/sdk/powershell/v3/models/filter-aggregation +tags: ['SDK', 'Software Development Kit', 'FilterAggregation', 'FilterAggregation'] +--- + + +# FilterAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | The name of the filter aggregate to be included in the result. | [required] +**Type** | Pointer to [**SearchFilterType**](search-filter-type) | | [optional] +**Field** | **String** | The search field to apply the filter to. Prefix the field name with '@' to reference a nested object. | [required] +**Value** | **String** | The value to filter on. | [required] + +## Examples + +- Prepare the resource +```powershell +$FilterAggregation = Initialize-PSSailpoint.V3FilterAggregation -Name Entitlements ` + -Type null ` + -Field access.type ` + -Value ENTITLEMENT +``` + +- Convert the resource to JSON +```powershell +$FilterAggregation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/FilterType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/FilterType.md new file mode 100644 index 000000000..321b6a994 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/FilterType.md @@ -0,0 +1,26 @@ +--- +id: filter-type +title: FilterType +pagination_label: FilterType +sidebar_label: FilterType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FilterType', 'FilterType'] +slug: /tools/sdk/powershell/v3/models/filter-type +tags: ['SDK', 'Software Development Kit', 'FilterType', 'FilterType'] +--- + + +# FilterType + +## Enum + + +* `EXISTS` (value: `"EXISTS"`) + +* `RANGE` (value: `"RANGE"`) + +* `TERMS` (value: `"TERMS"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/FirstValid.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/FirstValid.md new file mode 100644 index 000000000..e55d6d848 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/FirstValid.md @@ -0,0 +1,39 @@ +--- +id: first-valid +title: FirstValid +pagination_label: FirstValid +sidebar_label: FirstValid +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FirstValid', 'FirstValid'] +slug: /tools/sdk/powershell/v3/models/first-valid +tags: ['SDK', 'Software Development Kit', 'FirstValid', 'FirstValid'] +--- + + +# FirstValid + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Values** | [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | An array of attributes to evaluate for existence. | [required] +**IgnoreErrors** | Pointer to **Boolean** | a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. | [optional] [default to $false] +**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] + +## Examples + +- Prepare the resource +```powershell +$FirstValid = Initialize-PSSailpoint.V3FirstValid -Values [{attributes={sourceName=Active Directory, attributeName=sAMAccountName}, type=accountAttribute}, {attributes={sourceName=Okta, attributeName=login}, type=accountAttribute}, {attributes={sourceName=HR Source, attributeName=employeeID}, type=accountAttribute}] ` + -IgnoreErrors false ` + -RequiresPeriodicRefresh false +``` + +- Convert the resource to JSON +```powershell +$FirstValid | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/FormDetails.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/FormDetails.md new file mode 100644 index 000000000..b59afac80 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/FormDetails.md @@ -0,0 +1,45 @@ +--- +id: form-details +title: FormDetails +pagination_label: FormDetails +sidebar_label: FormDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormDetails', 'FormDetails'] +slug: /tools/sdk/powershell/v3/models/form-details +tags: ['SDK', 'Software Development Kit', 'FormDetails', 'FormDetails'] +--- + + +# FormDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the form | [optional] +**Name** | Pointer to **String** | Name of the form | [optional] +**Title** | Pointer to **String** | The form title | [optional] +**Subtitle** | Pointer to **String** | The form subtitle. | [optional] +**TargetUser** | Pointer to **String** | The name of the user that should be shown this form | [optional] +**Sections** | Pointer to [**[]SectionDetails**](section-details) | Sections of the form | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormDetails = Initialize-PSSailpoint.V3FormDetails -Id 2c9180835d2e5168015d32f890ca1581 ` + -Name AccountSelection Form ` + -Title Account Selection for John.Doe ` + -Subtitle Please select from the following ` + -TargetUser Jane.Doe ` + -Sections null +``` + +- Convert the resource to JSON +```powershell +$FormDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/FormItemDetails.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/FormItemDetails.md new file mode 100644 index 000000000..a1a390364 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/FormItemDetails.md @@ -0,0 +1,35 @@ +--- +id: form-item-details +title: FormItemDetails +pagination_label: FormItemDetails +sidebar_label: FormItemDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FormItemDetails', 'FormItemDetails'] +slug: /tools/sdk/powershell/v3/models/form-item-details +tags: ['SDK', 'Software Development Kit', 'FormItemDetails', 'FormItemDetails'] +--- + + +# FormItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Name of the FormItem | [optional] + +## Examples + +- Prepare the resource +```powershell +$FormItemDetails = Initialize-PSSailpoint.V3FormItemDetails -Name Field1 +``` + +- Convert the resource to JSON +```powershell +$FormItemDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ForwardApprovalDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ForwardApprovalDto.md new file mode 100644 index 000000000..6684152f5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ForwardApprovalDto.md @@ -0,0 +1,37 @@ +--- +id: forward-approval-dto +title: ForwardApprovalDto +pagination_label: ForwardApprovalDto +sidebar_label: ForwardApprovalDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ForwardApprovalDto', 'ForwardApprovalDto'] +slug: /tools/sdk/powershell/v3/models/forward-approval-dto +tags: ['SDK', 'Software Development Kit', 'ForwardApprovalDto', 'ForwardApprovalDto'] +--- + + +# ForwardApprovalDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NewOwnerId** | **String** | The Id of the new owner | [required] +**Comment** | **String** | The comment provided by the forwarder | [required] + +## Examples + +- Prepare the resource +```powershell +$ForwardApprovalDto = Initialize-PSSailpoint.V3ForwardApprovalDto -NewOwnerId 2c91808568c529c60168cca6f90c1314 ` + -Comment 2c91808568c529c60168cca6f90c1313 +``` + +- Convert the resource to JSON +```powershell +$ForwardApprovalDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/FullDiscoveredApplications.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/FullDiscoveredApplications.md new file mode 100644 index 000000000..67b9b89b8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/FullDiscoveredApplications.md @@ -0,0 +1,53 @@ +--- +id: full-discovered-applications +title: FullDiscoveredApplications +pagination_label: FullDiscoveredApplications +sidebar_label: FullDiscoveredApplications +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FullDiscoveredApplications', 'FullDiscoveredApplications'] +slug: /tools/sdk/powershell/v3/models/full-discovered-applications +tags: ['SDK', 'Software Development Kit', 'FullDiscoveredApplications', 'FullDiscoveredApplications'] +--- + + +# FullDiscoveredApplications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Unique identifier for the discovered application. | [optional] +**Name** | Pointer to **String** | Name of the discovered application. | [optional] +**DiscoverySource** | Pointer to **String** | Source from which the application was discovered. | [optional] +**DiscoveredVendor** | Pointer to **String** | The vendor associated with the discovered application. | [optional] +**Description** | Pointer to **String** | A brief description of the discovered application. | [optional] +**RecommendedConnectors** | Pointer to **[]String** | List of recommended connectors for the application. | [optional] +**DiscoveredAt** | Pointer to **System.DateTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**CreatedAt** | Pointer to **System.DateTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**Status** | Pointer to **String** | The status of an application within the discovery source. By default this field is set to ""ACTIVE"" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to ""INACTIVE"". | [optional] +**AssociatedSources** | Pointer to **[]String** | List of associated sources related to this discovered application. | [optional] + +## Examples + +- Prepare the resource +```powershell +$FullDiscoveredApplications = Initialize-PSSailpoint.V3FullDiscoveredApplications -Id null ` + -Name ExampleApp ` + -DiscoverySource csv ` + -DiscoveredVendor ExampleVendor ` + -Description An application for managing examples. ` + -RecommendedConnectors [ConnectorA, ConnectorB] ` + -DiscoveredAt 2023-01-01T12:00Z ` + -CreatedAt 2023-01-01T12:00Z ` + -Status ACTIVE ` + -AssociatedSources [e0cc5d7d-bf7f-4f81-b2af-8885b09d9923, a0303682-5e4a-44f7-bdc2-6ce6112549c1] +``` + +- Convert the resource to JSON +```powershell +$FullDiscoveredApplications | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/GenerateRandomString.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/GenerateRandomString.md new file mode 100644 index 000000000..278e54653 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/GenerateRandomString.md @@ -0,0 +1,45 @@ +--- +id: generate-random-string +title: GenerateRandomString +pagination_label: GenerateRandomString +sidebar_label: GenerateRandomString +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GenerateRandomString', 'GenerateRandomString'] +slug: /tools/sdk/powershell/v3/models/generate-random-string +tags: ['SDK', 'Software Development Kit', 'GenerateRandomString', 'GenerateRandomString'] +--- + + +# GenerateRandomString + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | This must always be set to ""Cloud Services Deployment Utility"" | [required] +**Operation** | **String** | The operation to perform `generateRandomString` | [required] +**IncludeNumbers** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include numbers | [required] +**IncludeSpecialChars** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include special characters | [required] +**Length** | **String** | This specifies how long the randomly generated string needs to be >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$GenerateRandomString = Initialize-PSSailpoint.V3GenerateRandomString -Name Cloud Services Deployment Utility ` + -Operation generateRandomString ` + -IncludeNumbers true ` + -IncludeSpecialChars true ` + -Length 10 ` + -RequiresPeriodicRefresh false +``` + +- Convert the resource to JSON +```powershell +$GenerateRandomString | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/GetActiveCampaigns200ResponseInner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/GetActiveCampaigns200ResponseInner.md new file mode 100644 index 000000000..270b90d07 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/GetActiveCampaigns200ResponseInner.md @@ -0,0 +1,79 @@ +--- +id: get-active-campaigns200-response-inner +title: GetActiveCampaigns200ResponseInner +pagination_label: GetActiveCampaigns200ResponseInner +sidebar_label: GetActiveCampaigns200ResponseInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetActiveCampaigns200ResponseInner', 'GetActiveCampaigns200ResponseInner'] +slug: /tools/sdk/powershell/v3/models/get-active-campaigns200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetActiveCampaigns200ResponseInner', 'GetActiveCampaigns200ResponseInner'] +--- + + +# GetActiveCampaigns200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the campaign | [optional] [readonly] +**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Deadline** | Pointer to **System.DateTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required] +**EmailNotificationEnabled** | Pointer to **Boolean** | Enables email notification for this campaign | [optional] [default to $false] +**AutoRevokeAllowed** | Pointer to **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] +**RecommendationsEnabled** | Pointer to **Boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to $false] +**Status** | Pointer to **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **System.DateTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **Int32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | Modified time of the campaign | [optional] [readonly] +**VarFilter** | Pointer to [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | Pointer to **Boolean** | Determines if comments on sunset date changes are required. | [optional] [default to $true] +**SourceOwnerCampaignInfo** | Pointer to [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | Pointer to [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | Pointer to [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | Pointer to [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | Pointer to [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \""orphan entitlements\"" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**MandatoryCommentRequirement** | Pointer to **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] + +## Examples + +- Prepare the resource +```powershell +$GetActiveCampaigns200ResponseInner = Initialize-PSSailpoint.V3GetActiveCampaigns200ResponseInner -Id 2c9079b270a266a60170a2779fcb0007 ` + -Name Manager Campaign ` + -Description Everyone needs to be reviewed by their manager ` + -Deadline 2020-03-15T10:00:01.456Z ` + -Type MANAGER ` + -EmailNotificationEnabled false ` + -AutoRevokeAllowed false ` + -RecommendationsEnabled true ` + -Status ACTIVE ` + -CorrelatedStatus CORRELATED ` + -Created 2020-03-03T22:15:13.611Z ` + -TotalCertifications 100 ` + -CompletedCertifications 10 ` + -Alerts null ` + -Modified 2020-03-03T22:20:12.674Z ` + -VarFilter null ` + -SunsetCommentsRequired true ` + -SourceOwnerCampaignInfo null ` + -SearchCampaignInfo null ` + -RoleCompositionCampaignInfo null ` + -MachineAccountCampaignInfo null ` + -SourcesWithOrphanEntitlements null ` + -MandatoryCommentRequirement NO_DECISIONS +``` + +- Convert the resource to JSON +```powershell +$GetActiveCampaigns200ResponseInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/GetDiscoveredApplications200ResponseInner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/GetDiscoveredApplications200ResponseInner.md new file mode 100644 index 000000000..e748a541b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/GetDiscoveredApplications200ResponseInner.md @@ -0,0 +1,53 @@ +--- +id: get-discovered-applications200-response-inner +title: GetDiscoveredApplications200ResponseInner +pagination_label: GetDiscoveredApplications200ResponseInner +sidebar_label: GetDiscoveredApplications200ResponseInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetDiscoveredApplications200ResponseInner', 'GetDiscoveredApplications200ResponseInner'] +slug: /tools/sdk/powershell/v3/models/get-discovered-applications200-response-inner +tags: ['SDK', 'Software Development Kit', 'GetDiscoveredApplications200ResponseInner', 'GetDiscoveredApplications200ResponseInner'] +--- + + +# GetDiscoveredApplications200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Unique identifier for the discovered application. | [optional] +**Name** | Pointer to **String** | Name of the discovered application. | [optional] +**DiscoverySource** | Pointer to **String** | Source from which the application was discovered. | [optional] +**DiscoveredVendor** | Pointer to **String** | The vendor associated with the discovered application. | [optional] +**Description** | Pointer to **String** | A brief description of the discovered application. | [optional] +**RecommendedConnectors** | Pointer to **[]String** | List of recommended connectors for the application. | [optional] +**DiscoveredAt** | Pointer to **System.DateTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**CreatedAt** | Pointer to **System.DateTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**Status** | Pointer to **String** | The status of an application within the discovery source. By default this field is set to ""ACTIVE"" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to ""INACTIVE"". | [optional] +**AssociatedSources** | Pointer to **[]String** | List of associated sources related to this discovered application. | [optional] + +## Examples + +- Prepare the resource +```powershell +$GetDiscoveredApplications200ResponseInner = Initialize-PSSailpoint.V3GetDiscoveredApplications200ResponseInner -Id null ` + -Name ExampleApp ` + -DiscoverySource csv ` + -DiscoveredVendor ExampleVendor ` + -Description An application for managing examples. ` + -RecommendedConnectors [ConnectorA, ConnectorB] ` + -DiscoveredAt 2023-01-01T12:00Z ` + -CreatedAt 2023-01-01T12:00Z ` + -Status ACTIVE ` + -AssociatedSources [e0cc5d7d-bf7f-4f81-b2af-8885b09d9923, a0303682-5e4a-44f7-bdc2-6ce6112549c1] +``` + +- Convert the resource to JSON +```powershell +$GetDiscoveredApplications200ResponseInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/GetOAuthClientResponse.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/GetOAuthClientResponse.md new file mode 100644 index 000000000..6cf02387e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/GetOAuthClientResponse.md @@ -0,0 +1,75 @@ +--- +id: get-o-auth-client-response +title: GetOAuthClientResponse +pagination_label: GetOAuthClientResponse +sidebar_label: GetOAuthClientResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetOAuthClientResponse', 'GetOAuthClientResponse'] +slug: /tools/sdk/powershell/v3/models/get-o-auth-client-response +tags: ['SDK', 'Software Development Kit', 'GetOAuthClientResponse', 'GetOAuthClientResponse'] +--- + + +# GetOAuthClientResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | ID of the OAuth client | [required] +**BusinessName** | **String** | The name of the business the API Client should belong to | [required] +**HomepageUrl** | **String** | The homepage URL associated with the owner of the API Client | [required] +**Name** | **String** | A human-readable name for the API Client | [required] +**Description** | **String** | A description of the API Client | [required] +**AccessTokenValiditySeconds** | **Int32** | The number of seconds an access token generated for this API Client is valid for | [required] +**RefreshTokenValiditySeconds** | **Int32** | The number of seconds a refresh token generated for this API Client is valid for | [required] +**RedirectUris** | **[]String** | A list of the approved redirect URIs used with the authorization_code flow | [required] +**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | [required] +**AccessType** | [**AccessType**](access-type) | | [required] +**Type** | [**ClientType**](client-type) | | [required] +**Internal** | **Boolean** | An indicator of whether the API Client can be used for requests internal to IDN | [required] +**Enabled** | **Boolean** | An indicator of whether the API Client is enabled for use | [required] +**StrongAuthSupported** | **Boolean** | An indicator of whether the API Client supports strong authentication | [required] +**ClaimsSupported** | **Boolean** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [required] +**Created** | **System.DateTime** | The date and time, down to the millisecond, when the API Client was created | [required] +**Modified** | **System.DateTime** | The date and time, down to the millisecond, when the API Client was last updated | [required] +**Secret** | Pointer to **String** | | [optional] +**Metadata** | Pointer to **String** | | [optional] +**LastUsed** | Pointer to **System.DateTime** | The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed. | [optional] +**Scope** | **[]String** | Scopes of the API Client. | [required] + +## Examples + +- Prepare the resource +```powershell +$GetOAuthClientResponse = Initialize-PSSailpoint.V3GetOAuthClientResponse -Id 2c9180835d2e5168015d32f890ca1581 ` + -BusinessName Acme-Solar ` + -HomepageUrl http://localhost:12345 ` + -Name Demo API Client ` + -Description An API client used for the authorization_code, refresh_token, and client_credentials flows ` + -AccessTokenValiditySeconds 750 ` + -RefreshTokenValiditySeconds 86400 ` + -RedirectUris [http://localhost:12345] ` + -GrantTypes [AUTHORIZATION_CODE, CLIENT_CREDENTIALS, REFRESH_TOKEN] ` + -AccessType null ` + -Type null ` + -Internal false ` + -Enabled true ` + -StrongAuthSupported false ` + -ClaimsSupported false ` + -Created 2017-07-11T18:45:37.098Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Secret null ` + -Metadata null ` + -LastUsed 2017-07-11T18:45:37.098Z ` + -Scope [demo:api-client-scope:first, demo:api-client-scope:second] +``` + +- Convert the resource to JSON +```powershell +$GetOAuthClientResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/GetPersonalAccessTokenResponse.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/GetPersonalAccessTokenResponse.md new file mode 100644 index 000000000..9e58b3d93 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/GetPersonalAccessTokenResponse.md @@ -0,0 +1,47 @@ +--- +id: get-personal-access-token-response +title: GetPersonalAccessTokenResponse +pagination_label: GetPersonalAccessTokenResponse +sidebar_label: GetPersonalAccessTokenResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetPersonalAccessTokenResponse', 'GetPersonalAccessTokenResponse'] +slug: /tools/sdk/powershell/v3/models/get-personal-access-token-response +tags: ['SDK', 'Software Development Kit', 'GetPersonalAccessTokenResponse', 'GetPersonalAccessTokenResponse'] +--- + + +# GetPersonalAccessTokenResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The ID of the personal access token (to be used as the username for Basic Auth). | [required] +**Name** | **String** | The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. | [required] +**Scope** | **[]String** | Scopes of the personal access token. | [required] +**Owner** | [**PatOwner**](pat-owner) | | [required] +**Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required] +**LastUsed** | Pointer to **System.DateTime** | The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. | [optional] +**Managed** | Pointer to **Boolean** | If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$GetPersonalAccessTokenResponse = Initialize-PSSailpoint.V3GetPersonalAccessTokenResponse -Id 86f1dc6fe8f54414950454cbb11278fa ` + -Name NodeJS Integration ` + -Scope [demo:personal-access-token-scope:first, demo:personal-access-token-scope:second] ` + -Owner null ` + -Created 2017-07-11T18:45:37.098Z ` + -LastUsed 2017-07-11T18:45:37.098Z ` + -Managed false +``` + +- Convert the resource to JSON +```powershell +$GetPersonalAccessTokenResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/GetReferenceIdentityAttribute.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/GetReferenceIdentityAttribute.md new file mode 100644 index 000000000..efa04d360 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/GetReferenceIdentityAttribute.md @@ -0,0 +1,41 @@ +--- +id: get-reference-identity-attribute +title: GetReferenceIdentityAttribute +pagination_label: GetReferenceIdentityAttribute +sidebar_label: GetReferenceIdentityAttribute +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetReferenceIdentityAttribute', 'GetReferenceIdentityAttribute'] +slug: /tools/sdk/powershell/v3/models/get-reference-identity-attribute +tags: ['SDK', 'Software Development Kit', 'GetReferenceIdentityAttribute', 'GetReferenceIdentityAttribute'] +--- + + +# GetReferenceIdentityAttribute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | This must always be set to ""Cloud Services Deployment Utility"" | [required] +**Operation** | **String** | The operation to perform `getReferenceIdentityAttribute` | [required] +**Uid** | **String** | This is the SailPoint User Name (uid) value of the identity whose attribute is desired As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$GetReferenceIdentityAttribute = Initialize-PSSailpoint.V3GetReferenceIdentityAttribute -Name Cloud Services Deployment Utility ` + -Operation getReferenceIdentityAttribute ` + -Uid 2c91808570313110017040b06f344ec9 ` + -RequiresPeriodicRefresh false +``` + +- Convert the resource to JSON +```powershell +$GetReferenceIdentityAttribute | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/GetVendorConnectorMappings405Response.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/GetVendorConnectorMappings405Response.md new file mode 100644 index 000000000..1fcd0695a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/GetVendorConnectorMappings405Response.md @@ -0,0 +1,39 @@ +--- +id: get-vendor-connector-mappings405-response +title: GetVendorConnectorMappings405Response +pagination_label: GetVendorConnectorMappings405Response +sidebar_label: GetVendorConnectorMappings405Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetVendorConnectorMappings405Response', 'GetVendorConnectorMappings405Response'] +slug: /tools/sdk/powershell/v3/models/get-vendor-connector-mappings405-response +tags: ['SDK', 'Software Development Kit', 'GetVendorConnectorMappings405Response', 'GetVendorConnectorMappings405Response'] +--- + + +# GetVendorConnectorMappings405Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ErrorName** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A message describing the error | [optional] +**ErrorMessage** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Description of the error | [optional] +**TrackingId** | Pointer to **String** | Unique tracking id for the error. | [optional] + +## Examples + +- Prepare the resource +```powershell +$GetVendorConnectorMappings405Response = Initialize-PSSailpoint.V3GetVendorConnectorMappings405Response -ErrorName NotSupportedException ` + -ErrorMessage Cannot consume content type ` + -TrackingId e7eab60924f64aa284175b9fa3309599 +``` + +- Convert the resource to JSON +```powershell +$GetVendorConnectorMappings405Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/GrantType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/GrantType.md new file mode 100644 index 000000000..9c89bd818 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/GrantType.md @@ -0,0 +1,26 @@ +--- +id: grant-type +title: GrantType +pagination_label: GrantType +sidebar_label: GrantType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GrantType', 'GrantType'] +slug: /tools/sdk/powershell/v3/models/grant-type +tags: ['SDK', 'Software Development Kit', 'GrantType', 'GrantType'] +--- + + +# GrantType + +## Enum + + +* `CLIENT_CREDENTIALS` (value: `"CLIENT_CREDENTIALS"`) + +* `AUTHORIZATION_CODE` (value: `"AUTHORIZATION_CODE"`) + +* `REFRESH_TOKEN` (value: `"REFRESH_TOKEN"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ISO3166.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ISO3166.md new file mode 100644 index 000000000..ca7250cb0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ISO3166.md @@ -0,0 +1,39 @@ +--- +id: iso3166 +title: ISO3166 +pagination_label: ISO3166 +sidebar_label: ISO3166 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ISO3166', 'ISO3166'] +slug: /tools/sdk/powershell/v3/models/iso3166 +tags: ['SDK', 'Software Development Kit', 'ISO3166', 'ISO3166'] +--- + + +# ISO3166 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Format** | Pointer to **String** | An optional value to denote which ISO 3166 format to return. Valid values are: `alpha2` - Two-character country code (e.g., ""US""); this is the default value if no format is supplied `alpha3` - Three-character country code (e.g., ""USA"") `numeric` - The numeric country code (e.g., ""840"") | [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] + +## Examples + +- Prepare the resource +```powershell +$ISO3166 = Initialize-PSSailpoint.V3ISO3166 -Format alpha2 ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$ISO3166 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentitiesDetailsReportArguments.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentitiesDetailsReportArguments.md new file mode 100644 index 000000000..02dce12fb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentitiesDetailsReportArguments.md @@ -0,0 +1,35 @@ +--- +id: identities-details-report-arguments +title: IdentitiesDetailsReportArguments +pagination_label: IdentitiesDetailsReportArguments +sidebar_label: IdentitiesDetailsReportArguments +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentitiesDetailsReportArguments', 'IdentitiesDetailsReportArguments'] +slug: /tools/sdk/powershell/v3/models/identities-details-report-arguments +tags: ['SDK', 'Software Development Kit', 'IdentitiesDetailsReportArguments', 'IdentitiesDetailsReportArguments'] +--- + + +# IdentitiesDetailsReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CorrelatedOnly** | **Boolean** | Flag to specify if only correlated identities are included in report. | [required][default to $false] + +## Examples + +- Prepare the resource +```powershell +$IdentitiesDetailsReportArguments = Initialize-PSSailpoint.V3IdentitiesDetailsReportArguments -CorrelatedOnly true +``` + +- Convert the resource to JSON +```powershell +$IdentitiesDetailsReportArguments | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentitiesReportArguments.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentitiesReportArguments.md new file mode 100644 index 000000000..c1795218c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentitiesReportArguments.md @@ -0,0 +1,35 @@ +--- +id: identities-report-arguments +title: IdentitiesReportArguments +pagination_label: IdentitiesReportArguments +sidebar_label: IdentitiesReportArguments +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentitiesReportArguments', 'IdentitiesReportArguments'] +slug: /tools/sdk/powershell/v3/models/identities-report-arguments +tags: ['SDK', 'Software Development Kit', 'IdentitiesReportArguments', 'IdentitiesReportArguments'] +--- + + +# IdentitiesReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CorrelatedOnly** | Pointer to **Boolean** | Flag to specify if only correlated identities are included in report. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$IdentitiesReportArguments = Initialize-PSSailpoint.V3IdentitiesReportArguments -CorrelatedOnly true +``` + +- Convert the resource to JSON +```powershell +$IdentitiesReportArguments | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityAccess.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityAccess.md new file mode 100644 index 000000000..ddbeef0d8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityAccess.md @@ -0,0 +1,59 @@ +--- +id: identity-access +title: IdentityAccess +pagination_label: IdentityAccess +sidebar_label: IdentityAccess +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAccess', 'IdentityAccess'] +slug: /tools/sdk/powershell/v3/models/identity-access +tags: ['SDK', 'Software Development Kit', 'IdentityAccess', 'IdentityAccess'] +--- + + +# IdentityAccess + +## Properties + +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] +**Privileged** | Pointer to **Boolean** | | [optional] +**Attribute** | Pointer to **String** | | [optional] +**Value** | Pointer to **String** | | [optional] +**Standalone** | Pointer to **Boolean** | | [optional] +**Disabled** | Pointer to **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAccess = Initialize-PSSailpoint.V3IdentityAccess -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -DisplayName John Q. Doe ` + -Type null ` + -Description null ` + -Source null ` + -Owner null ` + -Revocable null ` + -Privileged false ` + -Attribute memberOf ` + -Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com ` + -Standalone false ` + -Disabled null +``` + +- Convert the resource to JSON +```powershell +$IdentityAccess | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityAttribute.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityAttribute.md new file mode 100644 index 000000000..301a8992c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityAttribute.md @@ -0,0 +1,39 @@ +--- +id: identity-attribute +title: IdentityAttribute +pagination_label: IdentityAttribute +sidebar_label: IdentityAttribute +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttribute', 'IdentityAttribute'] +slug: /tools/sdk/powershell/v3/models/identity-attribute +tags: ['SDK', 'Software Development Kit', 'IdentityAttribute', 'IdentityAttribute'] +--- + + +# IdentityAttribute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | The system (camel-cased) name of the identity attribute to bring in | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$IdentityAttribute = Initialize-PSSailpoint.V3IdentityAttribute -Name email ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$IdentityAttribute | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityAttributeConfig.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityAttributeConfig.md new file mode 100644 index 000000000..c1c06625e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityAttributeConfig.md @@ -0,0 +1,37 @@ +--- +id: identity-attribute-config +title: IdentityAttributeConfig +pagination_label: IdentityAttributeConfig +sidebar_label: IdentityAttributeConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributeConfig', 'IdentityAttributeConfig'] +slug: /tools/sdk/powershell/v3/models/identity-attribute-config +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig', 'IdentityAttributeConfig'] +--- + + +# IdentityAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **Boolean** | The backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false] +**AttributeTransforms** | Pointer to [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributeConfig = Initialize-PSSailpoint.V3IdentityAttributeConfig -Enabled true ` + -AttributeTransforms null +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributeConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityAttributePreview.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityAttributePreview.md new file mode 100644 index 000000000..fcb68a9a1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityAttributePreview.md @@ -0,0 +1,41 @@ +--- +id: identity-attribute-preview +title: IdentityAttributePreview +pagination_label: IdentityAttributePreview +sidebar_label: IdentityAttributePreview +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributePreview', 'IdentityAttributePreview'] +slug: /tools/sdk/powershell/v3/models/identity-attribute-preview +tags: ['SDK', 'Software Development Kit', 'IdentityAttributePreview', 'IdentityAttributePreview'] +--- + + +# IdentityAttributePreview + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Name of the attribute that is being previewed. | [optional] +**Value** | Pointer to **String** | Value that was derived during the preview. | [optional] +**PreviousValue** | Pointer to **String** | The value of the attribute before the preview. | [optional] +**ErrorMessages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributePreview = Initialize-PSSailpoint.V3IdentityAttributePreview -Name email ` + -Value email@mail.com ` + -PreviousValue oldEmail@mail.com ` + -ErrorMessages null +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributePreview | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityAttributeTransform.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityAttributeTransform.md new file mode 100644 index 000000000..948e30244 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityAttributeTransform.md @@ -0,0 +1,37 @@ +--- +id: identity-attribute-transform +title: IdentityAttributeTransform +pagination_label: IdentityAttributeTransform +sidebar_label: IdentityAttributeTransform +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributeTransform', 'IdentityAttributeTransform'] +slug: /tools/sdk/powershell/v3/models/identity-attribute-transform +tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'IdentityAttributeTransform'] +--- + + +# IdentityAttributeTransform + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityAttributeName** | Pointer to **String** | Name of the identity attribute. | [optional] +**TransformDefinition** | Pointer to [**TransformDefinition**](transform-definition) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAttributeTransform = Initialize-PSSailpoint.V3IdentityAttributeTransform -IdentityAttributeName email ` + -TransformDefinition null +``` + +- Convert the resource to JSON +```powershell +$IdentityAttributeTransform | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityCertDecisionSummary.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityCertDecisionSummary.md new file mode 100644 index 000000000..fb76720c3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityCertDecisionSummary.md @@ -0,0 +1,65 @@ +--- +id: identity-cert-decision-summary +title: IdentityCertDecisionSummary +pagination_label: IdentityCertDecisionSummary +sidebar_label: IdentityCertDecisionSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityCertDecisionSummary', 'IdentityCertDecisionSummary'] +slug: /tools/sdk/powershell/v3/models/identity-cert-decision-summary +tags: ['SDK', 'Software Development Kit', 'IdentityCertDecisionSummary', 'IdentityCertDecisionSummary'] +--- + + +# IdentityCertDecisionSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**EntitlementDecisionsMade** | Pointer to **Int32** | Number of entitlement decisions that have been made | [optional] +**AccessProfileDecisionsMade** | Pointer to **Int32** | Number of access profile decisions that have been made | [optional] +**RoleDecisionsMade** | Pointer to **Int32** | Number of role decisions that have been made | [optional] +**AccountDecisionsMade** | Pointer to **Int32** | Number of account decisions that have been made | [optional] +**EntitlementDecisionsTotal** | Pointer to **Int32** | The total number of entitlement decisions on the certification, both complete and incomplete | [optional] +**AccessProfileDecisionsTotal** | Pointer to **Int32** | The total number of access profile decisions on the certification, both complete and incomplete | [optional] +**RoleDecisionsTotal** | Pointer to **Int32** | The total number of role decisions on the certification, both complete and incomplete | [optional] +**AccountDecisionsTotal** | Pointer to **Int32** | The total number of account decisions on the certification, both complete and incomplete | [optional] +**EntitlementsApproved** | Pointer to **Int32** | The number of entitlement decisions that have been made which were approved | [optional] +**EntitlementsRevoked** | Pointer to **Int32** | The number of entitlement decisions that have been made which were revoked | [optional] +**AccessProfilesApproved** | Pointer to **Int32** | The number of access profile decisions that have been made which were approved | [optional] +**AccessProfilesRevoked** | Pointer to **Int32** | The number of access profile decisions that have been made which were revoked | [optional] +**RolesApproved** | Pointer to **Int32** | The number of role decisions that have been made which were approved | [optional] +**RolesRevoked** | Pointer to **Int32** | The number of role decisions that have been made which were revoked | [optional] +**AccountsApproved** | Pointer to **Int32** | The number of account decisions that have been made which were approved | [optional] +**AccountsRevoked** | Pointer to **Int32** | The number of account decisions that have been made which were revoked | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityCertDecisionSummary = Initialize-PSSailpoint.V3IdentityCertDecisionSummary -EntitlementDecisionsMade 3 ` + -AccessProfileDecisionsMade 5 ` + -RoleDecisionsMade 2 ` + -AccountDecisionsMade 4 ` + -EntitlementDecisionsTotal 6 ` + -AccessProfileDecisionsTotal 10 ` + -RoleDecisionsTotal 4 ` + -AccountDecisionsTotal 8 ` + -EntitlementsApproved 2 ` + -EntitlementsRevoked 1 ` + -AccessProfilesApproved 3 ` + -AccessProfilesRevoked 2 ` + -RolesApproved 2 ` + -RolesRevoked 0 ` + -AccountsApproved 1 ` + -AccountsRevoked 3 +``` + +- Convert the resource to JSON +```powershell +$IdentityCertDecisionSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityCertificationDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityCertificationDto.md new file mode 100644 index 000000000..c54b939f7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityCertificationDto.md @@ -0,0 +1,67 @@ +--- +id: identity-certification-dto +title: IdentityCertificationDto +pagination_label: IdentityCertificationDto +sidebar_label: IdentityCertificationDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityCertificationDto', 'IdentityCertificationDto'] +slug: /tools/sdk/powershell/v3/models/identity-certification-dto +tags: ['SDK', 'Software Development Kit', 'IdentityCertificationDto', 'IdentityCertificationDto'] +--- + + +# IdentityCertificationDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | id of the certification | [optional] +**Name** | Pointer to **String** | name of the certification | [optional] +**Campaign** | Pointer to [**CampaignReference**](campaign-reference) | | [optional] +**Completed** | Pointer to **Boolean** | Have all decisions been made? | [optional] +**IdentitiesCompleted** | Pointer to **Int32** | The number of identities for whom all decisions have been made and are complete. | [optional] +**IdentitiesTotal** | Pointer to **Int32** | The total number of identities in the Certification, both complete and incomplete. | [optional] +**Created** | Pointer to **System.DateTime** | created date | [optional] +**Modified** | Pointer to **System.DateTime** | modified date | [optional] +**DecisionsMade** | Pointer to **Int32** | The number of approve/revoke/acknowledge decisions that have been made. | [optional] +**DecisionsTotal** | Pointer to **Int32** | The total number of approve/revoke/acknowledge decisions. | [optional] +**Due** | Pointer to **System.DateTime** | The due date of the certification. | [optional] +**Signed** | Pointer to **System.DateTime** | The date the reviewer signed off on the Certification. | [optional] +**Reviewer** | Pointer to [**Reviewer**](reviewer) | | [optional] +**Reassignment** | Pointer to [**Reassignment**](reassignment) | | [optional] +**HasErrors** | Pointer to **Boolean** | Identifies if the certification has an error | [optional] +**ErrorMessage** | Pointer to **String** | Description of the certification error | [optional] +**Phase** | Pointer to [**CertificationPhase**](certification-phase) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityCertificationDto = Initialize-PSSailpoint.V3IdentityCertificationDto -Id 2c9180835d2e5168015d32f890ca1581 ` + -Name Source Owner Access Review for Employees [source] ` + -Campaign null ` + -Completed true ` + -IdentitiesCompleted 5 ` + -IdentitiesTotal 10 ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -DecisionsMade 20 ` + -DecisionsTotal 40 ` + -Due 2018-10-19T13:49:37.385Z ` + -Signed 2018-10-19T13:49:37.385Z ` + -Reviewer null ` + -Reassignment null ` + -HasErrors false ` + -ErrorMessage The certification has an error ` + -Phase null +``` + +- Convert the resource to JSON +```powershell +$IdentityCertificationDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityDocument.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityDocument.md new file mode 100644 index 000000000..81161c6c7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityDocument.md @@ -0,0 +1,101 @@ +--- +id: identity-document +title: IdentityDocument +pagination_label: IdentityDocument +sidebar_label: IdentityDocument +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityDocument', 'IdentityDocument'] +slug: /tools/sdk/powershell/v3/models/identity-document +tags: ['SDK', 'Software Development Kit', 'IdentityDocument', 'IdentityDocument'] +--- + + +# IdentityDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the referenced object. | [required] +**Name** | **String** | The human readable name of the referenced object. | [required] +**Type** | [**DocumentType**](document-type) | | [required] +**DisplayName** | Pointer to **String** | Identity's display name. | [optional] +**FirstName** | Pointer to **String** | Identity's first name. | [optional] +**LastName** | Pointer to **String** | Identity's last name. | [optional] +**Email** | Pointer to **String** | Identity's primary email address. | [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] +**Phone** | Pointer to **String** | Identity's phone number. | [optional] +**Synced** | Pointer to **String** | 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] +**Inactive** | Pointer to **Boolean** | Indicates whether the identity is inactive. | [optional] [default to $false] +**Protected** | Pointer to **Boolean** | Indicates whether the identity is protected. | [optional] [default to $false] +**Status** | Pointer to **String** | Identity's status in SailPoint. | [optional] +**EmployeeNumber** | Pointer to **String** | Identity's employee number. | [optional] +**Manager** | Pointer to [**IdentityDocumentAllOfManager**](identity-document-all-of-manager) | | [optional] +**IsManager** | Pointer to **Boolean** | Indicates whether the identity is a manager of other identities. | [optional] +**IdentityProfile** | Pointer to [**IdentityDocumentAllOfIdentityProfile**](identity-document-all-of-identity-profile) | | [optional] +**Source** | Pointer to [**IdentityDocumentAllOfSource**](identity-document-all-of-source) | | [optional] +**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Map or dictionary of key/value pairs. | [optional] +**ProcessingState** | Pointer to **String** | Identity's processing state. | [optional] +**ProcessingDetails** | Pointer to [**ProcessingDetails**](processing-details) | | [optional] +**Accounts** | Pointer to [**[]BaseAccount**](base-account) | List of accounts associated with the identity. | [optional] +**AccountCount** | Pointer to **Int32** | Number of accounts associated with the identity. | [optional] +**Apps** | Pointer to [**[]App**](app) | List of applications the identity has access to. | [optional] +**AppCount** | Pointer to **Int32** | Number of applications the identity has access to. | [optional] +**Access** | Pointer to [**[]IdentityAccess**](identity-access) | List of access items assigned to the identity. | [optional] +**AccessCount** | Pointer to **Int32** | Number of access items assigned to the identity. | [optional] +**EntitlementCount** | Pointer to **Int32** | Number of entitlements assigned to the identity. | [optional] +**RoleCount** | Pointer to **Int32** | Number of roles assigned to the identity. | [optional] +**AccessProfileCount** | Pointer to **Int32** | Number of access profiles assigned to the identity. | [optional] +**Owns** | Pointer to [**[]Owns**](owns) | Access items the identity owns. | [optional] +**OwnsCount** | Pointer to **Int32** | Number of access items the identity owns. | [optional] +**Tags** | Pointer to **[]String** | Tags that have been applied to the object. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityDocument = Initialize-PSSailpoint.V3IdentityDocument -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -Type null ` + -DisplayName Carol.Adams ` + -FirstName Carol ` + -LastName Adams ` + -Email Carol.Adams@sailpointdemo.com ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Phone +1 440-527-3672 ` + -Synced null ` + -Inactive false ` + -Protected false ` + -Status UNREGISTERED ` + -EmployeeNumber 1a2a3d4e ` + -Manager null ` + -IsManager false ` + -IdentityProfile null ` + -Source null ` + -Attributes {country=US, firstname=Carol, cloudStatus=UNREGISTERED} ` + -ProcessingState null ` + -ProcessingDetails null ` + -Accounts null ` + -AccountCount 3 ` + -Apps null ` + -AppCount 2 ` + -Access null ` + -AccessCount 5 ` + -EntitlementCount 10 ` + -RoleCount 1 ` + -AccessProfileCount 1 ` + -Owns null ` + -OwnsCount 5 ` + -Tags [TAG_1, TAG_2] +``` + +- Convert the resource to JSON +```powershell +$IdentityDocument | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityDocumentAllOfIdentityProfile.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityDocumentAllOfIdentityProfile.md new file mode 100644 index 000000000..f2b38741a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityDocumentAllOfIdentityProfile.md @@ -0,0 +1,37 @@ +--- +id: identity-document-all-of-identity-profile +title: IdentityDocumentAllOfIdentityProfile +pagination_label: IdentityDocumentAllOfIdentityProfile +sidebar_label: IdentityDocumentAllOfIdentityProfile +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityDocumentAllOfIdentityProfile', 'IdentityDocumentAllOfIdentityProfile'] +slug: /tools/sdk/powershell/v3/models/identity-document-all-of-identity-profile +tags: ['SDK', 'Software Development Kit', 'IdentityDocumentAllOfIdentityProfile', 'IdentityDocumentAllOfIdentityProfile'] +--- + + +# IdentityDocumentAllOfIdentityProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Identity profile's ID. | [optional] +**Name** | Pointer to **String** | Identity profile's name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityDocumentAllOfIdentityProfile = Initialize-PSSailpoint.V3IdentityDocumentAllOfIdentityProfile -Id 3bc8ad26b8664945866b31339d1ff7d2 ` + -Name HR Employees +``` + +- Convert the resource to JSON +```powershell +$IdentityDocumentAllOfIdentityProfile | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityDocumentAllOfManager.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityDocumentAllOfManager.md new file mode 100644 index 000000000..06796cda3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityDocumentAllOfManager.md @@ -0,0 +1,39 @@ +--- +id: identity-document-all-of-manager +title: IdentityDocumentAllOfManager +pagination_label: IdentityDocumentAllOfManager +sidebar_label: IdentityDocumentAllOfManager +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityDocumentAllOfManager', 'IdentityDocumentAllOfManager'] +slug: /tools/sdk/powershell/v3/models/identity-document-all-of-manager +tags: ['SDK', 'Software Development Kit', 'IdentityDocumentAllOfManager', 'IdentityDocumentAllOfManager'] +--- + + +# IdentityDocumentAllOfManager + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of identity's manager. | [optional] +**Name** | Pointer to **String** | Name of identity's manager. | [optional] +**DisplayName** | Pointer to **String** | Display name of identity's manager. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityDocumentAllOfManager = Initialize-PSSailpoint.V3IdentityDocumentAllOfManager -Id 2c9180867dfe694b017e208e27c05799 ` + -Name Amanda.Ross ` + -DisplayName Amanda.Ross +``` + +- Convert the resource to JSON +```powershell +$IdentityDocumentAllOfManager | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityDocumentAllOfSource.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityDocumentAllOfSource.md new file mode 100644 index 000000000..569ef0a54 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityDocumentAllOfSource.md @@ -0,0 +1,37 @@ +--- +id: identity-document-all-of-source +title: IdentityDocumentAllOfSource +pagination_label: IdentityDocumentAllOfSource +sidebar_label: IdentityDocumentAllOfSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityDocumentAllOfSource', 'IdentityDocumentAllOfSource'] +slug: /tools/sdk/powershell/v3/models/identity-document-all-of-source +tags: ['SDK', 'Software Development Kit', 'IdentityDocumentAllOfSource', 'IdentityDocumentAllOfSource'] +--- + + +# IdentityDocumentAllOfSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of identity's source. | [optional] +**Name** | Pointer to **String** | Display name of identity's source. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityDocumentAllOfSource = Initialize-PSSailpoint.V3IdentityDocumentAllOfSource -Id 2c91808b6e9e6fb8016eec1a2b6f7b5f ` + -Name ODS-HR-Employees +``` + +- Convert the resource to JSON +```powershell +$IdentityDocumentAllOfSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityExceptionReportReference.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityExceptionReportReference.md new file mode 100644 index 000000000..4d172f1b3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityExceptionReportReference.md @@ -0,0 +1,37 @@ +--- +id: identity-exception-report-reference +title: IdentityExceptionReportReference +pagination_label: IdentityExceptionReportReference +sidebar_label: IdentityExceptionReportReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityExceptionReportReference', 'IdentityExceptionReportReference'] +slug: /tools/sdk/powershell/v3/models/identity-exception-report-reference +tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'IdentityExceptionReportReference'] +--- + + +# IdentityExceptionReportReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TaskResultId** | Pointer to **String** | The id of the task result. | [optional] +**ReportName** | Pointer to **String** | The name of the report. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityExceptionReportReference = Initialize-PSSailpoint.V3IdentityExceptionReportReference -TaskResultId 2b838de9-db9b-abcf-e646-d4f274ad4238 ` + -ReportName My annual report +``` + +- Convert the resource to JSON +```powershell +$IdentityExceptionReportReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityPreviewRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityPreviewRequest.md new file mode 100644 index 000000000..73cf05a99 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityPreviewRequest.md @@ -0,0 +1,37 @@ +--- +id: identity-preview-request +title: IdentityPreviewRequest +pagination_label: IdentityPreviewRequest +sidebar_label: IdentityPreviewRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityPreviewRequest', 'IdentityPreviewRequest'] +slug: /tools/sdk/powershell/v3/models/identity-preview-request +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewRequest', 'IdentityPreviewRequest'] +--- + + +# IdentityPreviewRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **String** | The Identity id | [optional] +**IdentityAttributeConfig** | Pointer to [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityPreviewRequest = Initialize-PSSailpoint.V3IdentityPreviewRequest -IdentityId null ` + -IdentityAttributeConfig null +``` + +- Convert the resource to JSON +```powershell +$IdentityPreviewRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityPreviewResponse.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityPreviewResponse.md new file mode 100644 index 000000000..1ae7e9cc3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityPreviewResponse.md @@ -0,0 +1,37 @@ +--- +id: identity-preview-response +title: IdentityPreviewResponse +pagination_label: IdentityPreviewResponse +sidebar_label: IdentityPreviewResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityPreviewResponse', 'IdentityPreviewResponse'] +slug: /tools/sdk/powershell/v3/models/identity-preview-response +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewResponse', 'IdentityPreviewResponse'] +--- + + +# IdentityPreviewResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identity** | Pointer to [**IdentityPreviewResponseIdentity**](identity-preview-response-identity) | | [optional] +**PreviewAttributes** | Pointer to [**[]IdentityAttributePreview**](identity-attribute-preview) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityPreviewResponse = Initialize-PSSailpoint.V3IdentityPreviewResponse -Identity null ` + -PreviewAttributes null +``` + +- Convert the resource to JSON +```powershell +$IdentityPreviewResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityPreviewResponseIdentity.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityPreviewResponseIdentity.md new file mode 100644 index 000000000..02eb5d5d6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityPreviewResponseIdentity.md @@ -0,0 +1,39 @@ +--- +id: identity-preview-response-identity +title: IdentityPreviewResponseIdentity +pagination_label: IdentityPreviewResponseIdentity +sidebar_label: IdentityPreviewResponseIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityPreviewResponseIdentity', 'IdentityPreviewResponseIdentity'] +slug: /tools/sdk/powershell/v3/models/identity-preview-response-identity +tags: ['SDK', 'Software Development Kit', 'IdentityPreviewResponseIdentity', 'IdentityPreviewResponseIdentity'] +--- + + +# IdentityPreviewResponseIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Identity's DTO type. | [optional] +**Id** | Pointer to **String** | Identity ID. | [optional] +**Name** | Pointer to **String** | Identity's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityPreviewResponseIdentity = Initialize-PSSailpoint.V3IdentityPreviewResponseIdentity -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$IdentityPreviewResponseIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityProfile.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityProfile.md new file mode 100644 index 000000000..694e3488b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityProfile.md @@ -0,0 +1,59 @@ +--- +id: identity-profile +title: IdentityProfile +pagination_label: IdentityProfile +sidebar_label: IdentityProfile +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfile', 'IdentityProfile'] +slug: /tools/sdk/powershell/v3/models/identity-profile +tags: ['SDK', 'Software Development Kit', 'IdentityProfile', 'IdentityProfile'] +--- + + +# IdentityProfile + +## Properties + +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] +**Description** | Pointer to **String** | The description of the Identity Profile. | [optional] +**Owner** | Pointer to [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] +**Priority** | Pointer to **Int64** | The priority for an Identity Profile. | [optional] +**AuthoritativeSource** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | [required] +**IdentityRefreshRequired** | Pointer to **Boolean** | True if a identity refresh is needed. Typically triggered when a change on the source has been made. | [optional] [default to $false] +**IdentityCount** | Pointer to **Int32** | The number of identities that belong to the Identity Profile. | [optional] +**IdentityAttributeConfig** | Pointer to [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] +**IdentityExceptionReportReference** | Pointer to [**IdentityExceptionReportReference**](identity-exception-report-reference) | | [optional] +**HasTimeBasedAttr** | Pointer to **Boolean** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$IdentityProfile = Initialize-PSSailpoint.V3IdentityProfile -Id id12345 ` + -Name aName ` + -Created 2015-05-28T14:07:17Z ` + -Modified 2015-05-28T14:07:17Z ` + -Description My custom flat file profile ` + -Owner null ` + -Priority 10 ` + -AuthoritativeSource null ` + -IdentityRefreshRequired true ` + -IdentityCount 8 ` + -IdentityAttributeConfig null ` + -IdentityExceptionReportReference null ` + -HasTimeBasedAttr true +``` + +- Convert the resource to JSON +```powershell +$IdentityProfile | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityProfileAllOfAuthoritativeSource.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityProfileAllOfAuthoritativeSource.md new file mode 100644 index 000000000..54e1f56e5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityProfileAllOfAuthoritativeSource.md @@ -0,0 +1,39 @@ +--- +id: identity-profile-all-of-authoritative-source +title: IdentityProfileAllOfAuthoritativeSource +pagination_label: IdentityProfileAllOfAuthoritativeSource +sidebar_label: IdentityProfileAllOfAuthoritativeSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfileAllOfAuthoritativeSource', 'IdentityProfileAllOfAuthoritativeSource'] +slug: /tools/sdk/powershell/v3/models/identity-profile-all-of-authoritative-source +tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSource', 'IdentityProfileAllOfAuthoritativeSource'] +--- + + +# IdentityProfileAllOfAuthoritativeSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "SOURCE" ] | Type of the object to which this reference applies | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityProfileAllOfAuthoritativeSource = Initialize-PSSailpoint.V3IdentityProfileAllOfAuthoritativeSource -Type SOURCE ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name HR Active Directory +``` + +- Convert the resource to JSON +```powershell +$IdentityProfileAllOfAuthoritativeSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityProfileAllOfOwner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityProfileAllOfOwner.md new file mode 100644 index 000000000..7ddb75dd7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityProfileAllOfOwner.md @@ -0,0 +1,39 @@ +--- +id: identity-profile-all-of-owner +title: IdentityProfileAllOfOwner +pagination_label: IdentityProfileAllOfOwner +sidebar_label: IdentityProfileAllOfOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfileAllOfOwner', 'IdentityProfileAllOfOwner'] +slug: /tools/sdk/powershell/v3/models/identity-profile-all-of-owner +tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'IdentityProfileAllOfOwner'] +--- + + +# IdentityProfileAllOfOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Type of the object to which this reference applies | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityProfileAllOfOwner = Initialize-PSSailpoint.V3IdentityProfileAllOfOwner -Type IDENTITY ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$IdentityProfileAllOfOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityProfileExportedObject.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityProfileExportedObject.md new file mode 100644 index 000000000..54eaa547f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityProfileExportedObject.md @@ -0,0 +1,39 @@ +--- +id: identity-profile-exported-object +title: IdentityProfileExportedObject +pagination_label: IdentityProfileExportedObject +sidebar_label: IdentityProfileExportedObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfileExportedObject', 'IdentityProfileExportedObject'] +slug: /tools/sdk/powershell/v3/models/identity-profile-exported-object +tags: ['SDK', 'Software Development Kit', 'IdentityProfileExportedObject', 'IdentityProfileExportedObject'] +--- + + +# IdentityProfileExportedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Version** | Pointer to **Int32** | Version or object from the target service. | [optional] +**Self** | Pointer to [**IdentityProfileExportedObjectSelf**](identity-profile-exported-object-self) | | [optional] +**Object** | Pointer to [**IdentityProfile**](identity-profile) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityProfileExportedObject = Initialize-PSSailpoint.V3IdentityProfileExportedObject -Version 1 ` + -Self null ` + -Object null +``` + +- Convert the resource to JSON +```powershell +$IdentityProfileExportedObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityProfileExportedObjectSelf.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityProfileExportedObjectSelf.md new file mode 100644 index 000000000..c83933112 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityProfileExportedObjectSelf.md @@ -0,0 +1,39 @@ +--- +id: identity-profile-exported-object-self +title: IdentityProfileExportedObjectSelf +pagination_label: IdentityProfileExportedObjectSelf +sidebar_label: IdentityProfileExportedObjectSelf +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfileExportedObjectSelf', 'IdentityProfileExportedObjectSelf'] +slug: /tools/sdk/powershell/v3/models/identity-profile-exported-object-self +tags: ['SDK', 'Software Development Kit', 'IdentityProfileExportedObjectSelf', 'IdentityProfileExportedObjectSelf'] +--- + + +# IdentityProfileExportedObjectSelf + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "ACCESS_REQUEST_CONFIG", "ATTR_SYNC_SOURCE_CONFIG", "AUTH_ORG", "CAMPAIGN_FILTER", "FORM_DEFINITION", "GOVERNANCE_GROUP", "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "LIFECYCLE_STATE", "NOTIFICATION_TEMPLATE", "PASSWORD_POLICY", "PASSWORD_SYNC_GROUP", "PUBLIC_IDENTITIES_CONFIG", "ROLE", "RULE", "SEGMENT", "SERVICE_DESK_INTEGRATION", "SOD_POLICY", "SOURCE", "TAG", "TRANSFORM", "TRIGGER_SUBSCRIPTION", "WORKFLOW" ] | Exported object's DTO type. | [optional] +**Id** | Pointer to **String** | Exported object's ID. | [optional] +**Name** | Pointer to **String** | Exported object's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityProfileExportedObjectSelf = Initialize-PSSailpoint.V3IdentityProfileExportedObjectSelf -Type SOURCE ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name HR Active Directory +``` + +- Convert the resource to JSON +```powershell +$IdentityProfileExportedObjectSelf | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityProfileIdentityErrorReportArguments.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityProfileIdentityErrorReportArguments.md new file mode 100644 index 000000000..3d53c34af --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityProfileIdentityErrorReportArguments.md @@ -0,0 +1,35 @@ +--- +id: identity-profile-identity-error-report-arguments +title: IdentityProfileIdentityErrorReportArguments +pagination_label: IdentityProfileIdentityErrorReportArguments +sidebar_label: IdentityProfileIdentityErrorReportArguments +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfileIdentityErrorReportArguments', 'IdentityProfileIdentityErrorReportArguments'] +slug: /tools/sdk/powershell/v3/models/identity-profile-identity-error-report-arguments +tags: ['SDK', 'Software Development Kit', 'IdentityProfileIdentityErrorReportArguments', 'IdentityProfileIdentityErrorReportArguments'] +--- + + +# IdentityProfileIdentityErrorReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AuthoritativeSource** | **String** | Source ID. | [required] + +## Examples + +- Prepare the resource +```powershell +$IdentityProfileIdentityErrorReportArguments = Initialize-PSSailpoint.V3IdentityProfileIdentityErrorReportArguments -AuthoritativeSource 1234sourceId5678902 +``` + +- Convert the resource to JSON +```powershell +$IdentityProfileIdentityErrorReportArguments | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityProfilesConnections.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityProfilesConnections.md new file mode 100644 index 000000000..ef02643c1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityProfilesConnections.md @@ -0,0 +1,39 @@ +--- +id: identity-profiles-connections +title: IdentityProfilesConnections +pagination_label: IdentityProfilesConnections +sidebar_label: IdentityProfilesConnections +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfilesConnections', 'IdentityProfilesConnections'] +slug: /tools/sdk/powershell/v3/models/identity-profiles-connections +tags: ['SDK', 'Software Development Kit', 'IdentityProfilesConnections', 'IdentityProfilesConnections'] +--- + + +# IdentityProfilesConnections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the IdentityProfile this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the IdentityProfile to which this reference applies | [optional] +**IdentityCount** | Pointer to **Int64** | The Number of Identities managed by this IdentityProfile | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityProfilesConnections = Initialize-PSSailpoint.V3IdentityProfilesConnections -Id 76cfddb62818416f816bc494410f46c4 ` + -Name ODS-Identity-Profile ` + -IdentityCount 100 +``` + +- Convert the resource to JSON +```powershell +$IdentityProfilesConnections | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityReference.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityReference.md new file mode 100644 index 000000000..a8205d43c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityReference.md @@ -0,0 +1,39 @@ +--- +id: identity-reference +title: IdentityReference +pagination_label: IdentityReference +sidebar_label: IdentityReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityReference', 'IdentityReference'] +slug: /tools/sdk/powershell/v3/models/identity-reference +tags: ['SDK', 'Software Development Kit', 'IdentityReference', 'IdentityReference'] +--- + + +# IdentityReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **String** | Identity id | [optional] +**Name** | Pointer to **String** | Human-readable display name of identity. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityReference = Initialize-PSSailpoint.V3IdentityReference -Type null ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Thomas Edison +``` + +- Convert the resource to JSON +```powershell +$IdentityReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityReferenceWithNameAndEmail.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityReferenceWithNameAndEmail.md new file mode 100644 index 000000000..6fef3b0b1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityReferenceWithNameAndEmail.md @@ -0,0 +1,41 @@ +--- +id: identity-reference-with-name-and-email +title: IdentityReferenceWithNameAndEmail +pagination_label: IdentityReferenceWithNameAndEmail +sidebar_label: IdentityReferenceWithNameAndEmail +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityReferenceWithNameAndEmail', 'IdentityReferenceWithNameAndEmail'] +slug: /tools/sdk/powershell/v3/models/identity-reference-with-name-and-email +tags: ['SDK', 'Software Development Kit', 'IdentityReferenceWithNameAndEmail', 'IdentityReferenceWithNameAndEmail'] +--- + + +# IdentityReferenceWithNameAndEmail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **String** | The type can only be IDENTITY. This is read-only. | [optional] +**Id** | Pointer to **String** | Identity ID. | [optional] +**Name** | Pointer to **String** | Identity's human-readable display name. This is read-only. | [optional] +**Email** | Pointer to **String** | Identity's email address. This is read-only. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityReferenceWithNameAndEmail = Initialize-PSSailpoint.V3IdentityReferenceWithNameAndEmail -Type IDENTITY ` + -Id 5168015d32f890ca15812c9180835d2e ` + -Name Alison Ferguso ` + -Email alison.ferguso@identitysoon.com +``` + +- Convert the resource to JSON +```powershell +$IdentityReferenceWithNameAndEmail | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentitySummary.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentitySummary.md new file mode 100644 index 000000000..c54bc361d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentitySummary.md @@ -0,0 +1,41 @@ +--- +id: identity-summary +title: IdentitySummary +pagination_label: IdentitySummary +sidebar_label: IdentitySummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentitySummary', 'IdentitySummary'] +slug: /tools/sdk/powershell/v3/models/identity-summary +tags: ['SDK', 'Software Development Kit', 'IdentitySummary', 'IdentitySummary'] +--- + + +# IdentitySummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of this identity summary | [optional] +**Name** | Pointer to **String** | Human-readable display name of identity | [optional] +**IdentityId** | Pointer to **String** | ID of the identity that this summary represents | [optional] +**Completed** | Pointer to **Boolean** | Indicates if all access items for this summary have been decided on | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$IdentitySummary = Initialize-PSSailpoint.V3IdentitySummary -Id ff80818155fe8c080155fe8d925b0316 ` + -Name SailPoint Services ` + -IdentityId c15b9f5cca5a4e9599eaa0e64fa921bd ` + -Completed true +``` + +- Convert the resource to JSON +```powershell +$IdentitySummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityWithNewAccess.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityWithNewAccess.md new file mode 100644 index 000000000..d093ac280 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityWithNewAccess.md @@ -0,0 +1,37 @@ +--- +id: identity-with-new-access +title: IdentityWithNewAccess +pagination_label: IdentityWithNewAccess +sidebar_label: IdentityWithNewAccess +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityWithNewAccess', 'IdentityWithNewAccess'] +slug: /tools/sdk/powershell/v3/models/identity-with-new-access +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess', 'IdentityWithNewAccess'] +--- + + +# IdentityWithNewAccess + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **String** | Identity id to be checked. | [required] +**AccessRefs** | [**[]IdentityWithNewAccessAccessRefsInner**](identity-with-new-access-access-refs-inner) | The list of entitlements to consider for possible violations in a preventive check. | [required] + +## Examples + +- Prepare the resource +```powershell +$IdentityWithNewAccess = Initialize-PSSailpoint.V3IdentityWithNewAccess -IdentityId 2c91808568c529c60168cca6f90c1313 ` + -AccessRefs [{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}] +``` + +- Convert the resource to JSON +```powershell +$IdentityWithNewAccess | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityWithNewAccess1.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityWithNewAccess1.md new file mode 100644 index 000000000..69138a60a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityWithNewAccess1.md @@ -0,0 +1,39 @@ +--- +id: identity-with-new-access1 +title: IdentityWithNewAccess1 +pagination_label: IdentityWithNewAccess1 +sidebar_label: IdentityWithNewAccess1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityWithNewAccess1', 'IdentityWithNewAccess1'] +slug: /tools/sdk/powershell/v3/models/identity-with-new-access1 +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess1', 'IdentityWithNewAccess1'] +--- + + +# IdentityWithNewAccess1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **String** | Set of identity IDs to be checked. | [required] +**AccessRefs** | [**[]EntitlementRef1**](entitlement-ref1) | The bundle of access profiles to be added to the identities specified. All references must be ENTITLEMENT type. | [required] +**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityWithNewAccess1 = Initialize-PSSailpoint.V3IdentityWithNewAccess1 -IdentityId 2c91809050db617d0150e0bf3215385e ` + -AccessRefs null ` + -ClientMetadata {clientName=client1, clientId=2c91808f7892918f0178b78da4a305a1} +``` + +- Convert the resource to JSON +```powershell +$IdentityWithNewAccess1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityWithNewAccessAccessRefsInner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityWithNewAccessAccessRefsInner.md new file mode 100644 index 000000000..46029f6b2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdentityWithNewAccessAccessRefsInner.md @@ -0,0 +1,39 @@ +--- +id: identity-with-new-access-access-refs-inner +title: IdentityWithNewAccessAccessRefsInner +pagination_label: IdentityWithNewAccessAccessRefsInner +sidebar_label: IdentityWithNewAccessAccessRefsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityWithNewAccessAccessRefsInner', 'IdentityWithNewAccessAccessRefsInner'] +slug: /tools/sdk/powershell/v3/models/identity-with-new-access-access-refs-inner +tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccessAccessRefsInner', 'IdentityWithNewAccessAccessRefsInner'] +--- + + +# IdentityWithNewAccessAccessRefsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | Entitlement's DTO type. | [optional] +**Id** | Pointer to **String** | Entitlement's ID. | [optional] +**Name** | Pointer to **String** | Entitlement's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityWithNewAccessAccessRefsInner = Initialize-PSSailpoint.V3IdentityWithNewAccessAccessRefsInner -Type ENTITLEMENT ` + -Id 2c91809773dee32014e13e122092014e ` + -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local +``` + +- Convert the resource to JSON +```powershell +$IdentityWithNewAccessAccessRefsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdpDetails.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdpDetails.md new file mode 100644 index 000000000..b263c0871 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IdpDetails.md @@ -0,0 +1,61 @@ +--- +id: idp-details +title: IdpDetails +pagination_label: IdpDetails +sidebar_label: IdpDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdpDetails', 'IdpDetails'] +slug: /tools/sdk/powershell/v3/models/idp-details +tags: ['SDK', 'Software Development Kit', 'IdpDetails', 'IdpDetails'] +--- + + +# IdpDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | Pointer to **Enum** [ "SAML_IDP" ] | Federation protocol role | [optional] +**EntityId** | Pointer to **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**Binding** | Pointer to **String** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**AuthContext** | Pointer to **String** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**LogoutUrl** | Pointer to **String** | The IDP logout URL. Used with IDP configurations. | [optional] +**IncludeAuthContext** | Pointer to **Boolean** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to $false] +**NameId** | Pointer to **String** | The name id format to use. Used with IDP configurations. | [optional] +**JitConfiguration** | Pointer to [**JITConfiguration**](jit-configuration) | | [optional] +**Cert** | Pointer to **String** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**LoginUrlPost** | Pointer to **String** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**LoginUrlRedirect** | Pointer to **String** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**MappingAttribute** | Pointer to **String** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [optional] +**CertificateExpirationDate** | Pointer to **String** | The expiration date extracted from the certificate. | [optional] +**CertificateName** | Pointer to **String** | The name extracted from the certificate. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdpDetails = Initialize-PSSailpoint.V3IdpDetails -Role SAML_IDP ` + -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 ` + -Binding urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST ` + -AuthContext urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport ` + -LogoutUrl https://dev-206445.oktapreview.com/login/signout ` + -IncludeAuthContext false ` + -NameId urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress ` + -JitConfiguration null ` + -Cert -----BEGIN CERTIFICATE-----****-----END CERTIFICATE----- ` + -LoginUrlPost https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` + -LoginUrlRedirect https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` + -MappingAttribute email ` + -CertificateExpirationDate Fri Mar 08 08:54:24 UTC 2013 ` + -CertificateName OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL +``` + +- Convert the resource to JSON +```powershell +$IdpDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ImportNonEmployeeRecordsInBulkRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ImportNonEmployeeRecordsInBulkRequest.md new file mode 100644 index 000000000..e82dd8606 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ImportNonEmployeeRecordsInBulkRequest.md @@ -0,0 +1,35 @@ +--- +id: import-non-employee-records-in-bulk-request +title: ImportNonEmployeeRecordsInBulkRequest +pagination_label: ImportNonEmployeeRecordsInBulkRequest +sidebar_label: ImportNonEmployeeRecordsInBulkRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ImportNonEmployeeRecordsInBulkRequest', 'ImportNonEmployeeRecordsInBulkRequest'] +slug: /tools/sdk/powershell/v3/models/import-non-employee-records-in-bulk-request +tags: ['SDK', 'Software Development Kit', 'ImportNonEmployeeRecordsInBulkRequest', 'ImportNonEmployeeRecordsInBulkRequest'] +--- + + +# ImportNonEmployeeRecordsInBulkRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarData** | **System.IO.FileInfo** | | [required] + +## Examples + +- Prepare the resource +```powershell +$ImportNonEmployeeRecordsInBulkRequest = Initialize-PSSailpoint.V3ImportNonEmployeeRecordsInBulkRequest -VarData null +``` + +- Convert the resource to JSON +```powershell +$ImportNonEmployeeRecordsInBulkRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ImportObject.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ImportObject.md new file mode 100644 index 000000000..164980656 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ImportObject.md @@ -0,0 +1,39 @@ +--- +id: import-object +title: ImportObject +pagination_label: ImportObject +sidebar_label: ImportObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ImportObject', 'ImportObject'] +slug: /tools/sdk/powershell/v3/models/import-object +tags: ['SDK', 'Software Development Kit', 'ImportObject', 'ImportObject'] +--- + + +# ImportObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "RULE", "SOURCE", "TRANSFORM", "TRIGGER_SUBSCRIPTION" ] | DTO type of object created or updated by import. | [optional] +**Id** | Pointer to **String** | ID of object created or updated by import. | [optional] +**Name** | Pointer to **String** | Display name of object created or updated by import. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ImportObject = Initialize-PSSailpoint.V3ImportObject -Type SOURCE ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name HR Active Directory +``` + +- Convert the resource to JSON +```powershell +$ImportObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/IndexOf.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IndexOf.md new file mode 100644 index 000000000..66025097d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/IndexOf.md @@ -0,0 +1,39 @@ +--- +id: index-of +title: IndexOf +pagination_label: IndexOf +sidebar_label: IndexOf +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IndexOf', 'IndexOf'] +slug: /tools/sdk/powershell/v3/models/index-of +tags: ['SDK', 'Software Development Kit', 'IndexOf', 'IndexOf'] +--- + + +# IndexOf + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Substring** | **String** | A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring. | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$IndexOf = Initialize-PSSailpoint.V3IndexOf -Substring admin_ ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$IndexOf | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/InnerHit.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/InnerHit.md new file mode 100644 index 000000000..360026f80 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/InnerHit.md @@ -0,0 +1,37 @@ +--- +id: inner-hit +title: InnerHit +pagination_label: InnerHit +sidebar_label: InnerHit +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'InnerHit', 'InnerHit'] +slug: /tools/sdk/powershell/v3/models/inner-hit +tags: ['SDK', 'Software Development Kit', 'InnerHit', 'InnerHit'] +--- + + +# InnerHit + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | **String** | The search query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [required] +**Type** | **String** | The nested type to use in the inner hits query. The nested type [Nested Type](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html) refers to a document ""nested"" within another document. For example, an identity can have nested documents for access, accounts, and apps. | [required] + +## Examples + +- Prepare the resource +```powershell +$InnerHit = Initialize-PSSailpoint.V3InnerHit -Query source.name:\"Active Directory\" ` + -Type access +``` + +- Convert the resource to JSON +```powershell +$InnerHit | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/JITConfiguration.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/JITConfiguration.md new file mode 100644 index 000000000..f9d31327a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/JITConfiguration.md @@ -0,0 +1,39 @@ +--- +id: jit-configuration +title: JITConfiguration +pagination_label: JITConfiguration +sidebar_label: JITConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'JITConfiguration', 'JITConfiguration'] +slug: /tools/sdk/powershell/v3/models/jit-configuration +tags: ['SDK', 'Software Development Kit', 'JITConfiguration', 'JITConfiguration'] +--- + + +# JITConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **Boolean** | The indicator for just-in-time provisioning enabled | [optional] [default to $false] +**SourceId** | Pointer to **String** | the sourceId that mapped to just-in-time provisioning configuration | [optional] +**SourceAttributeMappings** | Pointer to **map[string]String** | A mapping of identity profile attribute names to SAML assertion attribute names | [optional] + +## Examples + +- Prepare the resource +```powershell +$JITConfiguration = Initialize-PSSailpoint.V3JITConfiguration -Enabled false ` + -SourceId 2c9180857377ed2901739c12a2da5ac8 ` + -SourceAttributeMappings {firstName=okta.firstName, lastName=okta.lastName, email=okta.email} +``` + +- Convert the resource to JSON +```powershell +$JITConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/JsonPatchOperation.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/JsonPatchOperation.md new file mode 100644 index 000000000..c78e3331d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/JsonPatchOperation.md @@ -0,0 +1,39 @@ +--- +id: json-patch-operation +title: JsonPatchOperation +pagination_label: JsonPatchOperation +sidebar_label: JsonPatchOperation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'JsonPatchOperation', 'JsonPatchOperation'] +slug: /tools/sdk/powershell/v3/models/json-patch-operation +tags: ['SDK', 'Software Development Kit', 'JsonPatchOperation', 'JsonPatchOperation'] +--- + + +# JsonPatchOperation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Op** | **Enum** [ "add", "remove", "replace", "move", "copy", "test" ] | The operation to be performed | [required] +**Path** | **String** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required] +**Value** | Pointer to [**JsonPatchOperationValue**](json-patch-operation-value) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$JsonPatchOperation = Initialize-PSSailpoint.V3JsonPatchOperation -Op replace ` + -Path /description ` + -Value null +``` + +- Convert the resource to JSON +```powershell +$JsonPatchOperation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/JsonPatchOperationValue.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/JsonPatchOperationValue.md new file mode 100644 index 000000000..b625d75eb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/JsonPatchOperationValue.md @@ -0,0 +1,34 @@ +--- +id: json-patch-operation-value +title: JsonPatchOperationValue +pagination_label: JsonPatchOperationValue +sidebar_label: JsonPatchOperationValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'JsonPatchOperationValue', 'JsonPatchOperationValue'] +slug: /tools/sdk/powershell/v3/models/json-patch-operation-value +tags: ['SDK', 'Software Development Kit', 'JsonPatchOperationValue', 'JsonPatchOperationValue'] +--- + + +# JsonPatchOperationValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$JsonPatchOperationValue = Initialize-PSSailpoint.V3JsonPatchOperationValue +``` + +- Convert the resource to JSON +```powershell +$JsonPatchOperationValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/KbaAnswerRequestItem.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/KbaAnswerRequestItem.md new file mode 100644 index 000000000..d824cd20d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/KbaAnswerRequestItem.md @@ -0,0 +1,37 @@ +--- +id: kba-answer-request-item +title: KbaAnswerRequestItem +pagination_label: KbaAnswerRequestItem +sidebar_label: KbaAnswerRequestItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'KbaAnswerRequestItem', 'KbaAnswerRequestItem'] +slug: /tools/sdk/powershell/v3/models/kba-answer-request-item +tags: ['SDK', 'Software Development Kit', 'KbaAnswerRequestItem', 'KbaAnswerRequestItem'] +--- + + +# KbaAnswerRequestItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Question Id | [required] +**Answer** | **String** | An answer for the KBA question | [required] + +## Examples + +- Prepare the resource +```powershell +$KbaAnswerRequestItem = Initialize-PSSailpoint.V3KbaAnswerRequestItem -Id c54fee53-2d63-4fc5-9259-3e93b9994135 ` + -Answer Your answer +``` + +- Convert the resource to JSON +```powershell +$KbaAnswerRequestItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/KbaAnswerResponseItem.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/KbaAnswerResponseItem.md new file mode 100644 index 000000000..367c5f160 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/KbaAnswerResponseItem.md @@ -0,0 +1,39 @@ +--- +id: kba-answer-response-item +title: KbaAnswerResponseItem +pagination_label: KbaAnswerResponseItem +sidebar_label: KbaAnswerResponseItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'KbaAnswerResponseItem', 'KbaAnswerResponseItem'] +slug: /tools/sdk/powershell/v3/models/kba-answer-response-item +tags: ['SDK', 'Software Development Kit', 'KbaAnswerResponseItem', 'KbaAnswerResponseItem'] +--- + + +# KbaAnswerResponseItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Question Id | [required] +**Question** | **String** | Question description | [required] +**HasAnswer** | **Boolean** | Denotes whether the KBA question has an answer configured for the current user | [required] + +## Examples + +- Prepare the resource +```powershell +$KbaAnswerResponseItem = Initialize-PSSailpoint.V3KbaAnswerResponseItem -Id c54fee53-2d63-4fc5-9259-3e93b9994135 ` + -Question [{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}] ` + -HasAnswer true +``` + +- Convert the resource to JSON +```powershell +$KbaAnswerResponseItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/KbaAuthResponse.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/KbaAuthResponse.md new file mode 100644 index 000000000..32d2862aa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/KbaAuthResponse.md @@ -0,0 +1,37 @@ +--- +id: kba-auth-response +title: KbaAuthResponse +pagination_label: KbaAuthResponse +sidebar_label: KbaAuthResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'KbaAuthResponse', 'KbaAuthResponse'] +slug: /tools/sdk/powershell/v3/models/kba-auth-response +tags: ['SDK', 'Software Development Kit', 'KbaAuthResponse', 'KbaAuthResponse'] +--- + + +# KbaAuthResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**KbaAuthResponseItems** | Pointer to [**[]KbaAuthResponseItem**](kba-auth-response-item) | | [optional] +**Status** | Pointer to **Enum** [ "PENDING", "SUCCESS", "FAILED", "LOCKOUT", "NOT_ENOUGH_DATA" ] | MFA Authentication status | [optional] + +## Examples + +- Prepare the resource +```powershell +$KbaAuthResponse = Initialize-PSSailpoint.V3KbaAuthResponse -KbaAuthResponseItems [{questionId=089899f13a8f4da7824996191587bab9, isVerified=false}] ` + -Status PENDING +``` + +- Convert the resource to JSON +```powershell +$KbaAuthResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/KbaAuthResponseItem.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/KbaAuthResponseItem.md new file mode 100644 index 000000000..fb396ee2a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/KbaAuthResponseItem.md @@ -0,0 +1,37 @@ +--- +id: kba-auth-response-item +title: KbaAuthResponseItem +pagination_label: KbaAuthResponseItem +sidebar_label: KbaAuthResponseItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'KbaAuthResponseItem', 'KbaAuthResponseItem'] +slug: /tools/sdk/powershell/v3/models/kba-auth-response-item +tags: ['SDK', 'Software Development Kit', 'KbaAuthResponseItem', 'KbaAuthResponseItem'] +--- + + +# KbaAuthResponseItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**QuestionId** | Pointer to **String** | The KBA question id | [optional] +**IsVerified** | Pointer to **Boolean** | Return true if verified | [optional] + +## Examples + +- Prepare the resource +```powershell +$KbaAuthResponseItem = Initialize-PSSailpoint.V3KbaAuthResponseItem -QuestionId 089899f13a8f4da7824996191587bab9 ` + -IsVerified true +``` + +- Convert the resource to JSON +```powershell +$KbaAuthResponseItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/KbaQuestion.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/KbaQuestion.md new file mode 100644 index 000000000..89b9d3a75 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/KbaQuestion.md @@ -0,0 +1,41 @@ +--- +id: kba-question +title: KbaQuestion +pagination_label: KbaQuestion +sidebar_label: KbaQuestion +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'KbaQuestion', 'KbaQuestion'] +slug: /tools/sdk/powershell/v3/models/kba-question +tags: ['SDK', 'Software Development Kit', 'KbaQuestion', 'KbaQuestion'] +--- + + +# KbaQuestion + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | KBA Question Id | [required] +**Text** | **String** | KBA Question description | [required] +**HasAnswer** | **Boolean** | Denotes whether the KBA question has an answer configured for any user in the tenant | [required] +**NumAnswers** | **Int32** | Denotes the number of KBA configurations for this question | [required] + +## Examples + +- Prepare the resource +```powershell +$KbaQuestion = Initialize-PSSailpoint.V3KbaQuestion -Id 143cfd3b-c23f-426b-ae5f-d3db06fa5919 ` + -Text [{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}] ` + -HasAnswer true ` + -NumAnswers 5 +``` + +- Convert the resource to JSON +```powershell +$KbaQuestion | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/LeftPad.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/LeftPad.md new file mode 100644 index 000000000..a5d60152c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/LeftPad.md @@ -0,0 +1,41 @@ +--- +id: left-pad +title: LeftPad +pagination_label: LeftPad +sidebar_label: LeftPad +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LeftPad', 'LeftPad'] +slug: /tools/sdk/powershell/v3/models/left-pad +tags: ['SDK', 'Software Development Kit', 'LeftPad', 'LeftPad'] +--- + + +# LeftPad + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Length** | **String** | An integer value for the desired length of the final output string | [required] +**Padding** | Pointer to **String** | A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space ("" "") character for padding | [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] + +## Examples + +- Prepare the resource +```powershell +$LeftPad = Initialize-PSSailpoint.V3LeftPad -Length 4 ` + -Padding 0 ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$LeftPad | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/LifecycleState.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/LifecycleState.md new file mode 100644 index 000000000..cdc8eb8e4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/LifecycleState.md @@ -0,0 +1,57 @@ +--- +id: lifecycle-state +title: LifecycleState +pagination_label: LifecycleState +sidebar_label: LifecycleState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LifecycleState', 'LifecycleState'] +slug: /tools/sdk/powershell/v3/models/lifecycle-state +tags: ['SDK', 'Software Development Kit', 'LifecycleState', 'LifecycleState'] +--- + + +# LifecycleState + +## Properties + +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] +**Enabled** | Pointer to **Boolean** | Indicates whether the lifecycle state is enabled or disabled. | [optional] [default to $false] +**TechnicalName** | **String** | The lifecycle state's technical name. This is for internal use. | [required] +**Description** | Pointer to **String** | Lifecycle state's description. | [optional] +**IdentityCount** | Pointer to **Int32** | Number of identities that have the lifecycle state. | [optional] [readonly] +**EmailNotificationOption** | Pointer to [**EmailNotificationOption**](email-notification-option) | | [optional] +**AccountActions** | Pointer to [**[]AccountAction**](account-action) | | [optional] +**AccessProfileIds** | Pointer to **[]String** | List of unique access-profile IDs that are associated with the lifecycle state. | [optional] +**IdentityState** | Pointer to **String** | The lifecycle state's associated identity state. This field is generally 'null'. | [optional] + +## Examples + +- Prepare the resource +```powershell +$LifecycleState = Initialize-PSSailpoint.V3LifecycleState -Id id12345 ` + -Name aName ` + -Created 2015-05-28T14:07:17Z ` + -Modified 2015-05-28T14:07:17Z ` + -Enabled true ` + -TechnicalName Technical Name ` + -Description Lifecycle description ` + -IdentityCount 42 ` + -EmailNotificationOption null ` + -AccountActions null ` + -AccessProfileIds [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500] ` + -IdentityState null +``` + +- Convert the resource to JSON +```powershell +$LifecycleState | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/LifecyclestateDeleted.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/LifecyclestateDeleted.md new file mode 100644 index 000000000..fbb7bd744 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/LifecyclestateDeleted.md @@ -0,0 +1,39 @@ +--- +id: lifecyclestate-deleted +title: LifecyclestateDeleted +pagination_label: LifecyclestateDeleted +sidebar_label: LifecyclestateDeleted +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LifecyclestateDeleted', 'LifecyclestateDeleted'] +slug: /tools/sdk/powershell/v3/models/lifecyclestate-deleted +tags: ['SDK', 'Software Development Kit', 'LifecyclestateDeleted', 'LifecyclestateDeleted'] +--- + + +# LifecyclestateDeleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "LIFECYCLE_STATE" ] | Deleted lifecycle state's DTO type. | [optional] +**Id** | Pointer to **String** | Deleted lifecycle state ID. | [optional] +**Name** | Pointer to **String** | Deleted lifecycle state's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$LifecyclestateDeleted = Initialize-PSSailpoint.V3LifecyclestateDeleted -Type LIFECYCLE_STATE ` + -Id 12345 ` + -Name Contractor Lifecycle +``` + +- Convert the resource to JSON +```powershell +$LifecyclestateDeleted | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ListAccessProfiles401Response.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ListAccessProfiles401Response.md new file mode 100644 index 000000000..93df5d330 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ListAccessProfiles401Response.md @@ -0,0 +1,35 @@ +--- +id: list-access-profiles401-response +title: ListAccessProfiles401Response +pagination_label: ListAccessProfiles401Response +sidebar_label: ListAccessProfiles401Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ListAccessProfiles401Response', 'ListAccessProfiles401Response'] +slug: /tools/sdk/powershell/v3/models/list-access-profiles401-response +tags: ['SDK', 'Software Development Kit', 'ListAccessProfiles401Response', 'ListAccessProfiles401Response'] +--- + + +# ListAccessProfiles401Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarError** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A message describing the error | [optional] + +## Examples + +- Prepare the resource +```powershell +$ListAccessProfiles401Response = Initialize-PSSailpoint.V3ListAccessProfiles401Response -VarError JWT validation failed: JWT is expired +``` + +- Convert the resource to JSON +```powershell +$ListAccessProfiles401Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ListAccessProfiles429Response.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ListAccessProfiles429Response.md new file mode 100644 index 000000000..2596f6e24 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ListAccessProfiles429Response.md @@ -0,0 +1,35 @@ +--- +id: list-access-profiles429-response +title: ListAccessProfiles429Response +pagination_label: ListAccessProfiles429Response +sidebar_label: ListAccessProfiles429Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ListAccessProfiles429Response', 'ListAccessProfiles429Response'] +slug: /tools/sdk/powershell/v3/models/list-access-profiles429-response +tags: ['SDK', 'Software Development Kit', 'ListAccessProfiles429Response', 'ListAccessProfiles429Response'] +--- + + +# ListAccessProfiles429Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A message describing the error | [optional] + +## Examples + +- Prepare the resource +```powershell +$ListAccessProfiles429Response = Initialize-PSSailpoint.V3ListAccessProfiles429Response -Message Rate Limit Exceeded +``` + +- Convert the resource to JSON +```powershell +$ListAccessProfiles429Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ListCampaignFilters200Response.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ListCampaignFilters200Response.md new file mode 100644 index 000000000..18ddfa255 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ListCampaignFilters200Response.md @@ -0,0 +1,37 @@ +--- +id: list-campaign-filters200-response +title: ListCampaignFilters200Response +pagination_label: ListCampaignFilters200Response +sidebar_label: ListCampaignFilters200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ListCampaignFilters200Response', 'ListCampaignFilters200Response'] +slug: /tools/sdk/powershell/v3/models/list-campaign-filters200-response +tags: ['SDK', 'Software Development Kit', 'ListCampaignFilters200Response', 'ListCampaignFilters200Response'] +--- + + +# ListCampaignFilters200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Items** | Pointer to [**[]CampaignFilterDetails**](campaign-filter-details) | List of campaign filters. | [optional] +**Count** | Pointer to **Int32** | Number of filters returned. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ListCampaignFilters200Response = Initialize-PSSailpoint.V3ListCampaignFilters200Response -Items null ` + -Count 2 +``` + +- Convert the resource to JSON +```powershell +$ListCampaignFilters200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ListCompleteWorkflowLibrary200ResponseInner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ListCompleteWorkflowLibrary200ResponseInner.md new file mode 100644 index 000000000..2d7c8c71b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ListCompleteWorkflowLibrary200ResponseInner.md @@ -0,0 +1,59 @@ +--- +id: list-complete-workflow-library200-response-inner +title: ListCompleteWorkflowLibrary200ResponseInner +pagination_label: ListCompleteWorkflowLibrary200ResponseInner +sidebar_label: ListCompleteWorkflowLibrary200ResponseInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ListCompleteWorkflowLibrary200ResponseInner', 'ListCompleteWorkflowLibrary200ResponseInner'] +slug: /tools/sdk/powershell/v3/models/list-complete-workflow-library200-response-inner +tags: ['SDK', 'Software Development Kit', 'ListCompleteWorkflowLibrary200ResponseInner', 'ListCompleteWorkflowLibrary200ResponseInner'] +--- + + +# ListCompleteWorkflowLibrary200ResponseInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Operator ID. | [optional] +**Name** | Pointer to **String** | Operator friendly name | [optional] +**Type** | Pointer to **String** | Operator type | [optional] +**Description** | Pointer to **String** | Description of the operator | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the operator accepts | [optional] +**ExampleOutput** | Pointer to [**WorkflowLibraryActionExampleOutput**](workflow-library-action-example-output) | | [optional] +**Deprecated** | Pointer to **Boolean** | | [optional] +**DeprecatedBy** | Pointer to **System.DateTime** | | [optional] +**VersionNumber** | Pointer to **Int32** | Version number | [optional] +**IsSimulationEnabled** | Pointer to **Boolean** | | [optional] +**IsDynamicSchema** | Pointer to **Boolean** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**OutputSchema** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Example output schema | [optional] +**InputExample** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Example trigger payload if applicable | [optional] + +## Examples + +- Prepare the resource +```powershell +$ListCompleteWorkflowLibrary200ResponseInner = Initialize-PSSailpoint.V3ListCompleteWorkflowLibrary200ResponseInner -Id sp:compare-boolean ` + -Name Compare Boolean Values ` + -Type OPERATOR ` + -Description Compare two boolean values and decide what happens based on the result. ` + -FormFields [{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] ` + -ExampleOutput null ` + -Deprecated null ` + -DeprecatedBy null ` + -VersionNumber null ` + -IsSimulationEnabled null ` + -IsDynamicSchema false ` + -OutputSchema null ` + -InputExample {changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} +``` + +- Convert the resource to JSON +```powershell +$ListCompleteWorkflowLibrary200ResponseInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/LocaleOrigin.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/LocaleOrigin.md new file mode 100644 index 000000000..d60d218f0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/LocaleOrigin.md @@ -0,0 +1,24 @@ +--- +id: locale-origin +title: LocaleOrigin +pagination_label: LocaleOrigin +sidebar_label: LocaleOrigin +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LocaleOrigin', 'LocaleOrigin'] +slug: /tools/sdk/powershell/v3/models/locale-origin +tags: ['SDK', 'Software Development Kit', 'LocaleOrigin', 'LocaleOrigin'] +--- + + +# LocaleOrigin + +## Enum + + +* `DEFAULT` (value: `"DEFAULT"`) + +* `REQUEST` (value: `"REQUEST"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/LockoutConfiguration.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/LockoutConfiguration.md new file mode 100644 index 000000000..adccba285 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/LockoutConfiguration.md @@ -0,0 +1,39 @@ +--- +id: lockout-configuration +title: LockoutConfiguration +pagination_label: LockoutConfiguration +sidebar_label: LockoutConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LockoutConfiguration', 'LockoutConfiguration'] +slug: /tools/sdk/powershell/v3/models/lockout-configuration +tags: ['SDK', 'Software Development Kit', 'LockoutConfiguration', 'LockoutConfiguration'] +--- + + +# LockoutConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaximumAttempts** | Pointer to **Int32** | The maximum attempts allowed before lockout occurs. | [optional] +**LockoutDuration** | Pointer to **Int32** | The total time in minutes a user will be locked out. | [optional] +**LockoutWindow** | Pointer to **Int32** | A rolling window where authentication attempts in a series count towards the maximum before lockout occurs. | [optional] + +## Examples + +- Prepare the resource +```powershell +$LockoutConfiguration = Initialize-PSSailpoint.V3LockoutConfiguration -MaximumAttempts 5 ` + -LockoutDuration 15 ` + -LockoutWindow 5 +``` + +- Convert the resource to JSON +```powershell +$LockoutConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Lookup.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Lookup.md new file mode 100644 index 000000000..a2de35b13 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Lookup.md @@ -0,0 +1,39 @@ +--- +id: lookup +title: Lookup +pagination_label: Lookup +sidebar_label: Lookup +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Lookup', 'Lookup'] +slug: /tools/sdk/powershell/v3/models/lookup +tags: ['SDK', 'Software Development Kit', 'Lookup', 'Lookup'] +--- + + +# Lookup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Table** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return ""Unknown Region"" for the attribute that is mapped to this transform. | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$Lookup = Initialize-PSSailpoint.V3Lookup -Table {USA=Americas, FRA=EMEA, AUS=APAC, default=Unknown Region} ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Lookup | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Lower.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Lower.md new file mode 100644 index 000000000..90c4818ed --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Lower.md @@ -0,0 +1,37 @@ +--- +id: lower +title: Lower +pagination_label: Lower +sidebar_label: Lower +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Lower', 'Lower'] +slug: /tools/sdk/powershell/v3/models/lower +tags: ['SDK', 'Software Development Kit', 'Lower', 'Lower'] +--- + + +# Lower + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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] + +## Examples + +- Prepare the resource +```powershell +$Lower = Initialize-PSSailpoint.V3Lower -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Lower | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClient.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClient.md new file mode 100644 index 000000000..d8c858ac5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClient.md @@ -0,0 +1,75 @@ +--- +id: managed-client +title: ManagedClient +pagination_label: ManagedClient +sidebar_label: ManagedClient +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClient', 'ManagedClient'] +slug: /tools/sdk/powershell/v3/models/managed-client +tags: ['SDK', 'Software Development Kit', 'ManagedClient', 'ManagedClient'] +--- + + +# ManagedClient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ManagedClient ID | [optional] [readonly] +**AlertKey** | Pointer to **String** | ManagedClient alert key | [optional] [readonly] +**ApiGatewayBaseUrl** | Pointer to **String** | | [optional] +**Cookbook** | Pointer to **String** | | [optional] +**CcId** | Pointer to **Int64** | Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) | [optional] +**ClientId** | **String** | The client ID used in API management | [required] +**ClusterId** | **String** | Cluster ID that the ManagedClient is linked to | [required] +**Description** | **String** | ManagedClient description | [required][default to ""] +**IpAddress** | Pointer to **String** | The public IP address of the ManagedClient | [optional] [readonly] +**LastSeen** | Pointer to **System.DateTime** | When the ManagedClient was last seen by the server | [optional] [readonly] +**Name** | Pointer to **String** | ManagedClient name | [optional] [default to "VA-$clientId"] +**SinceLastSeen** | Pointer to **String** | Milliseconds since the ManagedClient has polled the server | [optional] [readonly] +**Status** | Pointer to **Enum** [ "NORMAL", "UNDEFINED", "NOT_CONFIGURED", "CONFIGURING", "WARNING", "ERROR", "FAILED" ] | Status of the ManagedClient | [optional] [readonly] +**Type** | **String** | Type of the ManagedClient (VA, CCG) | [required] +**ClusterType** | Pointer to **Enum** [ "idn", "iai", "spConnectCluster", "sqsCluster", "das-rc", "das-pc", "das-dc" ] | Cluster Type of the ManagedClient | [optional] [readonly] +**VaDownloadUrl** | Pointer to **String** | ManagedClient VA download URL | [optional] [readonly] +**VaVersion** | Pointer to **String** | Version that the ManagedClient's VA is running | [optional] [readonly] +**Secret** | Pointer to **String** | Client's apiKey | [optional] +**CreatedAt** | Pointer to **System.DateTime** | The date/time this ManagedClient was created | [optional] +**UpdatedAt** | Pointer to **System.DateTime** | The date/time this ManagedClient was last updated | [optional] +**ProvisionStatus** | Pointer to **Enum** [ "PROVISIONED", "DRAFT" ] | The provisioning status of the ManagedClient | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$ManagedClient = Initialize-PSSailpoint.V3ManagedClient -Id 2c9180878eaf4204018eb019c3570003 ` + -AlertKey CLIENT_STATUS_NOT_CONFIGURED ` + -ApiGatewayBaseUrl null ` + -Cookbook null ` + -CcId 2248 ` + -ClientId 00be54a2-bb6d-402f-9159-beb2d5319347 ` + -ClusterId e1ff7bb24c934240bbf55e1aa39e41c5 ` + -Description A short description of the ManagedClient ` + -IpAddress 123.456.78.90 ` + -LastSeen 2020-01-01T00:00Z ` + -Name aName ` + -SinceLastSeen 15000 ` + -Status NORMAL ` + -Type VA ` + -ClusterType idn ` + -VaDownloadUrl aUrl ` + -VaVersion va-megapod-useast1-610-1621372012 ` + -Secret ef878e15eaa8c8d3e2fa52f41125e2a0eeadadc6a14f931a33ad3e1b62d56381 ` + -CreatedAt 2023-08-04T20:48:01.865Z ` + -UpdatedAt 2023-08-04T20:48:01.865Z ` + -ProvisionStatus PROVISIONED +``` + +- Convert the resource to JSON +```powershell +$ManagedClient | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClientRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClientRequest.md new file mode 100644 index 000000000..1bbfa082f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClientRequest.md @@ -0,0 +1,41 @@ +--- +id: managed-client-request +title: ManagedClientRequest +pagination_label: ManagedClientRequest +sidebar_label: ManagedClientRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClientRequest', 'ManagedClientRequest'] +slug: /tools/sdk/powershell/v3/models/managed-client-request +tags: ['SDK', 'Software Development Kit', 'ManagedClientRequest', 'ManagedClientRequest'] +--- + + +# ManagedClientRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClusterId** | **String** | Cluster ID that the ManagedClient is linked to | [required] +**Description** | Pointer to **String** | description for the ManagedClient to create | [optional] +**Name** | Pointer to **String** | name for the ManagedClient to create | [optional] +**Type** | Pointer to **String** | Type of the ManagedClient (VA, CCG) to create | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagedClientRequest = Initialize-PSSailpoint.V3ManagedClientRequest -ClusterId aClusterId ` + -Description A short description of the ManagedClient ` + -Name aName ` + -Type VA +``` + +- Convert the resource to JSON +```powershell +$ManagedClientRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClientStatus.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClientStatus.md new file mode 100644 index 000000000..1687979dc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClientStatus.md @@ -0,0 +1,41 @@ +--- +id: managed-client-status +title: ManagedClientStatus +pagination_label: ManagedClientStatus +sidebar_label: ManagedClientStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClientStatus', 'ManagedClientStatus'] +slug: /tools/sdk/powershell/v3/models/managed-client-status +tags: ['SDK', 'Software Development Kit', 'ManagedClientStatus', 'ManagedClientStatus'] +--- + + +# ManagedClientStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Body** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | ManagedClientStatus body information | [required] +**Status** | [**ManagedClientStatusCode**](managed-client-status-code) | | [required] +**Type** | [**ManagedClientType**](managed-client-type) | | [required] +**Timestamp** | **System.DateTime** | timestamp on the Client Status update | [required] + +## Examples + +- Prepare the resource +```powershell +$ManagedClientStatus = Initialize-PSSailpoint.V3ManagedClientStatus -Body {alertKey=, id=5678, clusterId=1234, ccg_etag=ccg_etag123xyz456, ccg_pin=NONE, cookbook_etag=20210420125956-20210511144538, hostname=megapod-useast1-secret-hostname.sailpoint.com, internal_ip=127.0.0.1, lastSeen=1620843964604, sinceSeen=14708, sinceSeenMillis=14708, localDev=false, stacktrace=, state=null, status=NORMAL, uuid=null, product=idn, va_version=null, platform_version=2, os_version=2345.3.1, os_type=flatcar, hypervisor=unknown} ` + -Status null ` + -Type null ` + -Timestamp 2020-01-01T00:00Z +``` + +- Convert the resource to JSON +```powershell +$ManagedClientStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClientStatusCode.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClientStatusCode.md new file mode 100644 index 000000000..f5a3884cc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClientStatusCode.md @@ -0,0 +1,34 @@ +--- +id: managed-client-status-code +title: ManagedClientStatusCode +pagination_label: ManagedClientStatusCode +sidebar_label: ManagedClientStatusCode +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClientStatusCode', 'ManagedClientStatusCode'] +slug: /tools/sdk/powershell/v3/models/managed-client-status-code +tags: ['SDK', 'Software Development Kit', 'ManagedClientStatusCode', 'ManagedClientStatusCode'] +--- + + +# ManagedClientStatusCode + +## Enum + + +* `NORMAL` (value: `"NORMAL"`) + +* `UNDEFINED` (value: `"UNDEFINED"`) + +* `NOT_CONFIGURED` (value: `"NOT_CONFIGURED"`) + +* `CONFIGURING` (value: `"CONFIGURING"`) + +* `WARNING` (value: `"WARNING"`) + +* `ERROR` (value: `"ERROR"`) + +* `FAILED` (value: `"FAILED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClientType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClientType.md new file mode 100644 index 000000000..74abe924b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClientType.md @@ -0,0 +1,28 @@ +--- +id: managed-client-type +title: ManagedClientType +pagination_label: ManagedClientType +sidebar_label: ManagedClientType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClientType', 'ManagedClientType'] +slug: /tools/sdk/powershell/v3/models/managed-client-type +tags: ['SDK', 'Software Development Kit', 'ManagedClientType', 'ManagedClientType'] +--- + + +# ManagedClientType + +## Enum + + +* `CCG` (value: `"CCG"`) + +* `VA` (value: `"VA"`) + +* `INTERNAL` (value: `"INTERNAL"`) + +* `IIQ_HARVESTER` (value: `"IIQ_HARVESTER"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedCluster.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedCluster.md new file mode 100644 index 000000000..f2853c64d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedCluster.md @@ -0,0 +1,83 @@ +--- +id: managed-cluster +title: ManagedCluster +pagination_label: ManagedCluster +sidebar_label: ManagedCluster +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedCluster', 'ManagedCluster'] +slug: /tools/sdk/powershell/v3/models/managed-cluster +tags: ['SDK', 'Software Development Kit', 'ManagedCluster', 'ManagedCluster'] +--- + + +# ManagedCluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | ManagedCluster ID | [required] +**Name** | Pointer to **String** | ManagedCluster name | [optional] +**Pod** | Pointer to **String** | ManagedCluster pod | [optional] +**Org** | Pointer to **String** | ManagedCluster org | [optional] +**Type** | Pointer to [**ManagedClusterTypes**](managed-cluster-types) | | [optional] +**Configuration** | Pointer to **map[string]String** | ManagedProcess configuration map | [optional] +**KeyPair** | Pointer to [**ManagedClusterKeyPair**](managed-cluster-key-pair) | | [optional] +**Attributes** | Pointer to [**ManagedClusterAttributes**](managed-cluster-attributes) | | [optional] +**Description** | Pointer to **String** | ManagedCluster description | [optional] [default to "q"] +**Redis** | Pointer to [**ManagedClusterRedis**](managed-cluster-redis) | | [optional] +**ClientType** | [**ManagedClientType**](managed-client-type) | | [required] +**CcgVersion** | **String** | CCG version used by the ManagedCluster | [required] +**PinnedConfig** | Pointer to **Boolean** | boolean flag indiacting whether or not the cluster configuration is pinned | [optional] [default to $false] +**LogConfiguration** | Pointer to [**ClientLogConfiguration**](client-log-configuration) | | [optional] +**Operational** | Pointer to **Boolean** | Whether or not the cluster is operational or not | [optional] [default to $false] +**Status** | Pointer to **String** | Cluster status | [optional] +**PublicKeyCertificate** | Pointer to **String** | Public key certificate | [optional] +**PublicKeyThumbprint** | Pointer to **String** | Public key thumbprint | [optional] +**PublicKey** | Pointer to **String** | Public key | [optional] +**AlertKey** | Pointer to **String** | Key describing any immediate cluster alerts | [optional] +**ClientIds** | Pointer to **[]String** | List of clients in a cluster | [optional] +**ServiceCount** | Pointer to **Int32** | Number of services bound to a cluster | [optional] [default to 0] +**CcId** | Pointer to **String** | CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished | [optional] [default to "0"] +**CreatedAt** | Pointer to **System.DateTime** | The date/time this cluster was created | [optional] +**UpdatedAt** | Pointer to **System.DateTime** | The date/time this cluster was last updated | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagedCluster = Initialize-PSSailpoint.V3ManagedCluster -Id e1ff7bb24c934240bbf55e1aa39e41c5 ` + -Name Managed Cluster Name ` + -Pod megapod-useast1 ` + -Org denali ` + -Type null ` + -Configuration {clusterExternalId=e1ff7bb24c934240bbf55e1aa39e41c5, clusterType=sqsCluster, gmtOffset=-5} ` + -KeyPair null ` + -Attributes null ` + -Description A short description of the managed cluster. ` + -Redis null ` + -ClientType null ` + -CcgVersion v01 ` + -PinnedConfig false ` + -LogConfiguration null ` + -Operational false ` + -Status NORMAL ` + -PublicKeyCertificate -----BEGIN CERTIFICATE-----TCCAb2gAwIBAgIBADANBgkqhkiG9w0BAQsFADAuMQ0wCwYDVQQD-----END CERTIFICATE----- ` + -PublicKeyThumbprint obc6pLiulGbtZ ` + -PublicKey -----BEGIN PUBLIC KEY-----jANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3WgnsxP52MDgBTfHR+5n4-----END PUBLIC KEY----- ` + -AlertKey LIMITED_RESOURCES ` + -ClientIds [1244, 1245] ` + -ServiceCount 6 ` + -CcId 1533 ` + -CreatedAt 2023-08-04T20:48:01.865Z ` + -UpdatedAt 2023-08-04T20:48:01.865Z +``` + +- Convert the resource to JSON +```powershell +$ManagedCluster | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClusterAttributes.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClusterAttributes.md new file mode 100644 index 000000000..34190db35 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClusterAttributes.md @@ -0,0 +1,37 @@ +--- +id: managed-cluster-attributes +title: ManagedClusterAttributes +pagination_label: ManagedClusterAttributes +sidebar_label: ManagedClusterAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterAttributes', 'ManagedClusterAttributes'] +slug: /tools/sdk/powershell/v3/models/managed-cluster-attributes +tags: ['SDK', 'Software Development Kit', 'ManagedClusterAttributes', 'ManagedClusterAttributes'] +--- + + +# ManagedClusterAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Queue** | Pointer to [**ManagedClusterQueue**](managed-cluster-queue) | | [optional] +**Keystore** | Pointer to **String** | ManagedCluster keystore for spConnectCluster type | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagedClusterAttributes = Initialize-PSSailpoint.V3ManagedClusterAttributes -Queue null ` + -Keystore /u3+7QAAAAIAAAABAAAAAQAvL3Byb3h5LWNsdXN0ZXIvMmM5MTgwODc3Yjg3MW +``` + +- Convert the resource to JSON +```powershell +$ManagedClusterAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClusterKeyPair.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClusterKeyPair.md new file mode 100644 index 000000000..3e88a74cd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClusterKeyPair.md @@ -0,0 +1,39 @@ +--- +id: managed-cluster-key-pair +title: ManagedClusterKeyPair +pagination_label: ManagedClusterKeyPair +sidebar_label: ManagedClusterKeyPair +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterKeyPair', 'ManagedClusterKeyPair'] +slug: /tools/sdk/powershell/v3/models/managed-cluster-key-pair +tags: ['SDK', 'Software Development Kit', 'ManagedClusterKeyPair', 'ManagedClusterKeyPair'] +--- + + +# ManagedClusterKeyPair + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PublicKey** | Pointer to **String** | ManagedCluster publicKey | [optional] +**PublicKeyThumbprint** | Pointer to **String** | ManagedCluster publicKeyThumbprint | [optional] +**PublicKeyCertificate** | Pointer to **String** | ManagedCluster publicKeyCertificate | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagedClusterKeyPair = Initialize-PSSailpoint.V3ManagedClusterKeyPair -PublicKey -----BEGIN PUBLIC KEY-----******-----END PUBLIC KEY----- ` + -PublicKeyThumbprint 6CMlaJIV44-xJxcB3CJBjDUUn54 ` + -PublicKeyCertificate -----BEGIN CERTIFICATE-----****-----END CERTIFICATE----- +``` + +- Convert the resource to JSON +```powershell +$ManagedClusterKeyPair | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClusterQueue.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClusterQueue.md new file mode 100644 index 000000000..cf9d68399 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClusterQueue.md @@ -0,0 +1,37 @@ +--- +id: managed-cluster-queue +title: ManagedClusterQueue +pagination_label: ManagedClusterQueue +sidebar_label: ManagedClusterQueue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterQueue', 'ManagedClusterQueue'] +slug: /tools/sdk/powershell/v3/models/managed-cluster-queue +tags: ['SDK', 'Software Development Kit', 'ManagedClusterQueue', 'ManagedClusterQueue'] +--- + + +# ManagedClusterQueue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | ManagedCluster queue name | [optional] +**Region** | Pointer to **String** | ManagedCluster queue aws region | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagedClusterQueue = Initialize-PSSailpoint.V3ManagedClusterQueue -Name megapod-useast1-denali-lwt-cluster-1533 ` + -Region us-east-1 +``` + +- Convert the resource to JSON +```powershell +$ManagedClusterQueue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClusterRedis.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClusterRedis.md new file mode 100644 index 000000000..21f2fbeec --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClusterRedis.md @@ -0,0 +1,37 @@ +--- +id: managed-cluster-redis +title: ManagedClusterRedis +pagination_label: ManagedClusterRedis +sidebar_label: ManagedClusterRedis +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterRedis', 'ManagedClusterRedis'] +slug: /tools/sdk/powershell/v3/models/managed-cluster-redis +tags: ['SDK', 'Software Development Kit', 'ManagedClusterRedis', 'ManagedClusterRedis'] +--- + + +# ManagedClusterRedis + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RedisHost** | Pointer to **String** | ManagedCluster redisHost | [optional] +**RedisPort** | Pointer to **Int32** | ManagedCluster redisPort | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagedClusterRedis = Initialize-PSSailpoint.V3ManagedClusterRedis -RedisHost megapod-useast1-shared-redis.cloud.sailpoint.com ` + -RedisPort 6379 +``` + +- Convert the resource to JSON +```powershell +$ManagedClusterRedis | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClusterRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClusterRequest.md new file mode 100644 index 000000000..13a46efac --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClusterRequest.md @@ -0,0 +1,41 @@ +--- +id: managed-cluster-request +title: ManagedClusterRequest +pagination_label: ManagedClusterRequest +sidebar_label: ManagedClusterRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterRequest', 'ManagedClusterRequest'] +slug: /tools/sdk/powershell/v3/models/managed-cluster-request +tags: ['SDK', 'Software Development Kit', 'ManagedClusterRequest', 'ManagedClusterRequest'] +--- + + +# ManagedClusterRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | ManagedCluster name | [required] +**Type** | Pointer to [**ManagedClusterTypes**](managed-cluster-types) | | [optional] +**Configuration** | Pointer to **map[string]String** | ManagedProcess configuration map | [optional] +**Description** | Pointer to **String** | ManagedCluster description | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagedClusterRequest = Initialize-PSSailpoint.V3ManagedClusterRequest -Name Managed Cluster Name ` + -Type null ` + -Configuration {clusterExternalId=externalId, ccgVersion=77.0.0} ` + -Description A short description of the managed cluster. +``` + +- Convert the resource to JSON +```powershell +$ManagedClusterRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClusterTypes.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClusterTypes.md new file mode 100644 index 000000000..adcabe1fa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagedClusterTypes.md @@ -0,0 +1,24 @@ +--- +id: managed-cluster-types +title: ManagedClusterTypes +pagination_label: ManagedClusterTypes +sidebar_label: ManagedClusterTypes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterTypes', 'ManagedClusterTypes'] +slug: /tools/sdk/powershell/v3/models/managed-cluster-types +tags: ['SDK', 'Software Development Kit', 'ManagedClusterTypes', 'ManagedClusterTypes'] +--- + + +# ManagedClusterTypes + +## Enum + + +* `idn` (value: `"idn"`) + +* `iai` (value: `"iai"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagerCorrelationMapping.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagerCorrelationMapping.md new file mode 100644 index 000000000..19ec150c0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManagerCorrelationMapping.md @@ -0,0 +1,37 @@ +--- +id: manager-correlation-mapping +title: ManagerCorrelationMapping +pagination_label: ManagerCorrelationMapping +sidebar_label: ManagerCorrelationMapping +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagerCorrelationMapping', 'ManagerCorrelationMapping'] +slug: /tools/sdk/powershell/v3/models/manager-correlation-mapping +tags: ['SDK', 'Software Development Kit', 'ManagerCorrelationMapping', 'ManagerCorrelationMapping'] +--- + + +# ManagerCorrelationMapping + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountAttributeName** | Pointer to **String** | Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. | [optional] +**IdentityAttributeName** | Pointer to **String** | Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagerCorrelationMapping = Initialize-PSSailpoint.V3ManagerCorrelationMapping -AccountAttributeName manager ` + -IdentityAttributeName manager +``` + +- Convert the resource to JSON +```powershell +$ManagerCorrelationMapping | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManualDiscoverApplications.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManualDiscoverApplications.md new file mode 100644 index 000000000..e14f98058 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManualDiscoverApplications.md @@ -0,0 +1,37 @@ +--- +id: manual-discover-applications +title: ManualDiscoverApplications +pagination_label: ManualDiscoverApplications +sidebar_label: ManualDiscoverApplications +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManualDiscoverApplications', 'ManualDiscoverApplications'] +slug: /tools/sdk/powershell/v3/models/manual-discover-applications +tags: ['SDK', 'Software Development Kit', 'ManualDiscoverApplications', 'ManualDiscoverApplications'] +--- + + +# ManualDiscoverApplications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | **System.IO.FileInfo** | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. | [required] + +## Examples + +- Prepare the resource +```powershell +$ManualDiscoverApplications = Initialize-PSSailpoint.V3ManualDiscoverApplications -File application_name,description +"Sample App","This is a sample description for Sample App." +"Another App","Description for Another App." +``` + +- Convert the resource to JSON +```powershell +$ManualDiscoverApplications | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManualDiscoverApplicationsTemplate.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManualDiscoverApplicationsTemplate.md new file mode 100644 index 000000000..aa5447d92 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManualDiscoverApplicationsTemplate.md @@ -0,0 +1,37 @@ +--- +id: manual-discover-applications-template +title: ManualDiscoverApplicationsTemplate +pagination_label: ManualDiscoverApplicationsTemplate +sidebar_label: ManualDiscoverApplicationsTemplate +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManualDiscoverApplicationsTemplate', 'ManualDiscoverApplicationsTemplate'] +slug: /tools/sdk/powershell/v3/models/manual-discover-applications-template +tags: ['SDK', 'Software Development Kit', 'ManualDiscoverApplicationsTemplate', 'ManualDiscoverApplicationsTemplate'] +--- + + +# ManualDiscoverApplicationsTemplate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApplicationName** | Pointer to **String** | Name of the application. | [optional] +**Description** | Pointer to **String** | Description of the application. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManualDiscoverApplicationsTemplate = Initialize-PSSailpoint.V3ManualDiscoverApplicationsTemplate -ApplicationName Example Application ` + -Description Example Description +``` + +- Convert the resource to JSON +```powershell +$ManualDiscoverApplicationsTemplate | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManualWorkItemDetails.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManualWorkItemDetails.md new file mode 100644 index 000000000..95308166c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManualWorkItemDetails.md @@ -0,0 +1,45 @@ +--- +id: manual-work-item-details +title: ManualWorkItemDetails +pagination_label: ManualWorkItemDetails +sidebar_label: ManualWorkItemDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManualWorkItemDetails', 'ManualWorkItemDetails'] +slug: /tools/sdk/powershell/v3/models/manual-work-item-details +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetails', 'ManualWorkItemDetails'] +--- + + +# ManualWorkItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Forwarded** | Pointer to **Boolean** | True if the request for this item was forwarded from one owner to another. | [optional] [default to $false] +**OriginalOwner** | Pointer to [**ManualWorkItemDetailsOriginalOwner**](manual-work-item-details-original-owner) | | [optional] +**CurrentOwner** | Pointer to [**ManualWorkItemDetailsCurrentOwner**](manual-work-item-details-current-owner) | | [optional] +**Modified** | Pointer to **System.DateTime** | Time at which item was modified. | [optional] +**Status** | Pointer to [**ManualWorkItemState**](manual-work-item-state) | | [optional] +**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManualWorkItemDetails = Initialize-PSSailpoint.V3ManualWorkItemDetails -Forwarded true ` + -OriginalOwner null ` + -CurrentOwner null ` + -Modified 2019-08-23T18:52:57.398Z ` + -Status null ` + -ForwardHistory null +``` + +- Convert the resource to JSON +```powershell +$ManualWorkItemDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManualWorkItemDetailsCurrentOwner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManualWorkItemDetailsCurrentOwner.md new file mode 100644 index 000000000..3bc7c6821 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManualWorkItemDetailsCurrentOwner.md @@ -0,0 +1,39 @@ +--- +id: manual-work-item-details-current-owner +title: ManualWorkItemDetailsCurrentOwner +pagination_label: ManualWorkItemDetailsCurrentOwner +sidebar_label: ManualWorkItemDetailsCurrentOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManualWorkItemDetailsCurrentOwner', 'ManualWorkItemDetailsCurrentOwner'] +slug: /tools/sdk/powershell/v3/models/manual-work-item-details-current-owner +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetailsCurrentOwner', 'ManualWorkItemDetailsCurrentOwner'] +--- + + +# ManualWorkItemDetailsCurrentOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP", "IDENTITY" ] | DTO type of current work item owner's identity. | [optional] +**Id** | Pointer to **String** | ID of current work item owner's identity. | [optional] +**Name** | Pointer to **String** | Display name of current work item owner. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManualWorkItemDetailsCurrentOwner = Initialize-PSSailpoint.V3ManualWorkItemDetailsCurrentOwner -Type IDENTITY ` + -Id 2c3780a46faadee4016fb4e018c20652 ` + -Name Allen Albertson +``` + +- Convert the resource to JSON +```powershell +$ManualWorkItemDetailsCurrentOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManualWorkItemDetailsOriginalOwner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManualWorkItemDetailsOriginalOwner.md new file mode 100644 index 000000000..513317cff --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManualWorkItemDetailsOriginalOwner.md @@ -0,0 +1,39 @@ +--- +id: manual-work-item-details-original-owner +title: ManualWorkItemDetailsOriginalOwner +pagination_label: ManualWorkItemDetailsOriginalOwner +sidebar_label: ManualWorkItemDetailsOriginalOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManualWorkItemDetailsOriginalOwner', 'ManualWorkItemDetailsOriginalOwner'] +slug: /tools/sdk/powershell/v3/models/manual-work-item-details-original-owner +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetailsOriginalOwner', 'ManualWorkItemDetailsOriginalOwner'] +--- + + +# ManualWorkItemDetailsOriginalOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP", "IDENTITY" ] | DTO type of original work item owner's identity. | [optional] +**Id** | Pointer to **String** | ID of original work item owner's identity. | [optional] +**Name** | Pointer to **String** | Display name of original work item owner. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManualWorkItemDetailsOriginalOwner = Initialize-PSSailpoint.V3ManualWorkItemDetailsOriginalOwner -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$ManualWorkItemDetailsOriginalOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManualWorkItemState.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManualWorkItemState.md new file mode 100644 index 000000000..fe11e1458 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ManualWorkItemState.md @@ -0,0 +1,32 @@ +--- +id: manual-work-item-state +title: ManualWorkItemState +pagination_label: ManualWorkItemState +sidebar_label: ManualWorkItemState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManualWorkItemState', 'ManualWorkItemState'] +slug: /tools/sdk/powershell/v3/models/manual-work-item-state +tags: ['SDK', 'Software Development Kit', 'ManualWorkItemState', 'ManualWorkItemState'] +--- + + +# ManualWorkItemState + +## Enum + + +* `PENDING` (value: `"PENDING"`) + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `EXPIRED` (value: `"EXPIRED"`) + +* `CANCELLED` (value: `"CANCELLED"`) + +* `ARCHIVED` (value: `"ARCHIVED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/MetricAggregation.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/MetricAggregation.md new file mode 100644 index 000000000..91f30a65e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/MetricAggregation.md @@ -0,0 +1,39 @@ +--- +id: metric-aggregation +title: MetricAggregation +pagination_label: MetricAggregation +sidebar_label: MetricAggregation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MetricAggregation', 'MetricAggregation'] +slug: /tools/sdk/powershell/v3/models/metric-aggregation +tags: ['SDK', 'Software Development Kit', 'MetricAggregation', 'MetricAggregation'] +--- + + +# MetricAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | The name of the metric aggregate to be included in the result. If the metric aggregation is omitted, the resulting aggregation will be a count of the documents in the search results. | [required] +**Type** | Pointer to [**MetricType**](metric-type) | | [optional] +**Field** | **String** | The field the calculation is performed on. Prefix the field name with '@' to reference a nested object. | [required] + +## Examples + +- Prepare the resource +```powershell +$MetricAggregation = Initialize-PSSailpoint.V3MetricAggregation -Name Access Name Count ` + -Type null ` + -Field @access.name +``` + +- Convert the resource to JSON +```powershell +$MetricAggregation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/MetricType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/MetricType.md new file mode 100644 index 000000000..8845be324 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/MetricType.md @@ -0,0 +1,34 @@ +--- +id: metric-type +title: MetricType +pagination_label: MetricType +sidebar_label: MetricType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MetricType', 'MetricType'] +slug: /tools/sdk/powershell/v3/models/metric-type +tags: ['SDK', 'Software Development Kit', 'MetricType', 'MetricType'] +--- + + +# MetricType + +## Enum + + +* `COUNT` (value: `"COUNT"`) + +* `UNIQUE_COUNT` (value: `"UNIQUE_COUNT"`) + +* `AVG` (value: `"AVG"`) + +* `SUM` (value: `"SUM"`) + +* `MEDIAN` (value: `"MEDIAN"`) + +* `MIN` (value: `"MIN"`) + +* `MAX` (value: `"MAX"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/MfaConfigTestResponse.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/MfaConfigTestResponse.md new file mode 100644 index 000000000..c2aa62820 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/MfaConfigTestResponse.md @@ -0,0 +1,37 @@ +--- +id: mfa-config-test-response +title: MfaConfigTestResponse +pagination_label: MfaConfigTestResponse +sidebar_label: MfaConfigTestResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MfaConfigTestResponse', 'MfaConfigTestResponse'] +slug: /tools/sdk/powershell/v3/models/mfa-config-test-response +tags: ['SDK', 'Software Development Kit', 'MfaConfigTestResponse', 'MfaConfigTestResponse'] +--- + + +# MfaConfigTestResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **Enum** [ "SUCCESS", "FAILED" ] | The configuration test result. | [optional] [readonly] +**VarError** | Pointer to **String** | The error message to indicate the failure of configuration test. | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$MfaConfigTestResponse = Initialize-PSSailpoint.V3MfaConfigTestResponse -State SUCCESS ` + -VarError MFA Method is disabled. +``` + +- Convert the resource to JSON +```powershell +$MfaConfigTestResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/MfaDuoConfig.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/MfaDuoConfig.md new file mode 100644 index 000000000..bc7067f94 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/MfaDuoConfig.md @@ -0,0 +1,45 @@ +--- +id: mfa-duo-config +title: MfaDuoConfig +pagination_label: MfaDuoConfig +sidebar_label: MfaDuoConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MfaDuoConfig', 'MfaDuoConfig'] +slug: /tools/sdk/powershell/v3/models/mfa-duo-config +tags: ['SDK', 'Software Development Kit', 'MfaDuoConfig', 'MfaDuoConfig'] +--- + + +# MfaDuoConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MfaMethod** | Pointer to **String** | Mfa method name | [optional] +**Enabled** | Pointer to **Boolean** | If MFA method is enabled. | [optional] [default to $false] +**VarHost** | Pointer to **String** | The server host name or IP address of the MFA provider. | [optional] +**AccessKey** | Pointer to **String** | The secret key for authenticating requests to the MFA provider. | [optional] +**IdentityAttribute** | Pointer to **String** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [optional] +**ConfigProperties** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map with additional config properties for the given MFA method - duo-web. | [optional] + +## Examples + +- Prepare the resource +```powershell +$MfaDuoConfig = Initialize-PSSailpoint.V3MfaDuoConfig -MfaMethod duo-web ` + -Enabled true ` + -VarHost example.com ` + -AccessKey qw123Y3QlA5UqocYpdU3rEkzrK2D497y ` + -IdentityAttribute email ` + -ConfigProperties {skey=qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x, ikey=Q123WE45R6TY7890ZXCV} +``` + +- Convert the resource to JSON +```powershell +$MfaDuoConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/MfaOktaConfig.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/MfaOktaConfig.md new file mode 100644 index 000000000..c27b02caa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/MfaOktaConfig.md @@ -0,0 +1,43 @@ +--- +id: mfa-okta-config +title: MfaOktaConfig +pagination_label: MfaOktaConfig +sidebar_label: MfaOktaConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MfaOktaConfig', 'MfaOktaConfig'] +slug: /tools/sdk/powershell/v3/models/mfa-okta-config +tags: ['SDK', 'Software Development Kit', 'MfaOktaConfig', 'MfaOktaConfig'] +--- + + +# MfaOktaConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MfaMethod** | Pointer to **String** | Mfa method name | [optional] +**Enabled** | Pointer to **Boolean** | If MFA method is enabled. | [optional] [default to $false] +**VarHost** | Pointer to **String** | The server host name or IP address of the MFA provider. | [optional] +**AccessKey** | Pointer to **String** | The secret key for authenticating requests to the MFA provider. | [optional] +**IdentityAttribute** | Pointer to **String** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [optional] + +## Examples + +- Prepare the resource +```powershell +$MfaOktaConfig = Initialize-PSSailpoint.V3MfaOktaConfig -MfaMethod okta-verify ` + -Enabled true ` + -VarHost example.com ` + -AccessKey qw123Y3QlA5UqocYpdU3rEkzrK2D497y ` + -IdentityAttribute email +``` + +- Convert the resource to JSON +```powershell +$MfaOktaConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/MultiPolicyRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/MultiPolicyRequest.md new file mode 100644 index 000000000..7edcfbf07 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/MultiPolicyRequest.md @@ -0,0 +1,35 @@ +--- +id: multi-policy-request +title: MultiPolicyRequest +pagination_label: MultiPolicyRequest +sidebar_label: MultiPolicyRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'MultiPolicyRequest', 'MultiPolicyRequest'] +slug: /tools/sdk/powershell/v3/models/multi-policy-request +tags: ['SDK', 'Software Development Kit', 'MultiPolicyRequest', 'MultiPolicyRequest'] +--- + + +# MultiPolicyRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**FilteredPolicyList** | Pointer to **[]String** | Multi-policy report will be run for this list of ids | [optional] + +## Examples + +- Prepare the resource +```powershell +$MultiPolicyRequest = Initialize-PSSailpoint.V3MultiPolicyRequest -FilteredPolicyList null +``` + +- Convert the resource to JSON +```powershell +$MultiPolicyRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NameNormalizer.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NameNormalizer.md new file mode 100644 index 000000000..e4fd8bb5e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NameNormalizer.md @@ -0,0 +1,37 @@ +--- +id: name-normalizer +title: NameNormalizer +pagination_label: NameNormalizer +sidebar_label: NameNormalizer +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NameNormalizer', 'NameNormalizer'] +slug: /tools/sdk/powershell/v3/models/name-normalizer +tags: ['SDK', 'Software Development Kit', 'NameNormalizer', 'NameNormalizer'] +--- + + +# NameNormalizer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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] + +## Examples + +- Prepare the resource +```powershell +$NameNormalizer = Initialize-PSSailpoint.V3NameNormalizer -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$NameNormalizer | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NamedConstructs.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NamedConstructs.md new file mode 100644 index 000000000..0c90d793a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NamedConstructs.md @@ -0,0 +1,30 @@ +--- +id: named-constructs +title: NamedConstructs +pagination_label: NamedConstructs +sidebar_label: NamedConstructs +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NamedConstructs', 'NamedConstructs'] +slug: /tools/sdk/powershell/v3/models/named-constructs +tags: ['SDK', 'Software Development Kit', 'NamedConstructs', 'NamedConstructs'] +--- + + +# NamedConstructs + +## Enum + + +* `ISO8601` (value: `"ISO8601"`) + +* `LDAP` (value: `"LDAP"`) + +* `PEOPLE_SOFT` (value: `"PEOPLE_SOFT"`) + +* `EPOCH_TIME_JAVA` (value: `"EPOCH_TIME_JAVA"`) + +* `EPOCH_TIME_WIN32` (value: `"EPOCH_TIME_WIN32"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NestedAggregation.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NestedAggregation.md new file mode 100644 index 000000000..0916977a8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NestedAggregation.md @@ -0,0 +1,37 @@ +--- +id: nested-aggregation +title: NestedAggregation +pagination_label: NestedAggregation +sidebar_label: NestedAggregation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NestedAggregation', 'NestedAggregation'] +slug: /tools/sdk/powershell/v3/models/nested-aggregation +tags: ['SDK', 'Software Development Kit', 'NestedAggregation', 'NestedAggregation'] +--- + + +# NestedAggregation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | The name of the nested aggregate to be included in the result. | [required] +**Type** | **String** | The type of the nested object. | [required] + +## Examples + +- Prepare the resource +```powershell +$NestedAggregation = Initialize-PSSailpoint.V3NestedAggregation -Name id ` + -Type access +``` + +- Convert the resource to JSON +```powershell +$NestedAggregation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NetworkConfiguration.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NetworkConfiguration.md new file mode 100644 index 000000000..698facd3d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NetworkConfiguration.md @@ -0,0 +1,39 @@ +--- +id: network-configuration +title: NetworkConfiguration +pagination_label: NetworkConfiguration +sidebar_label: NetworkConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NetworkConfiguration', 'NetworkConfiguration'] +slug: /tools/sdk/powershell/v3/models/network-configuration +tags: ['SDK', 'Software Development Kit', 'NetworkConfiguration', 'NetworkConfiguration'] +--- + + +# NetworkConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Range** | Pointer to **[]String** | The collection of ip ranges. | [optional] +**Geolocation** | Pointer to **[]String** | The collection of country codes. | [optional] +**Whitelisted** | Pointer to **Boolean** | Denotes whether the provided lists are whitelisted or blacklisted for geo location. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$NetworkConfiguration = Initialize-PSSailpoint.V3NetworkConfiguration -Range [1.3.7.2, 255.255.255.252/30] ` + -Geolocation [CA, FR, HT] ` + -Whitelisted true +``` + +- Convert the resource to JSON +```powershell +$NetworkConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeApprovalDecision.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeApprovalDecision.md new file mode 100644 index 000000000..3b5274366 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeApprovalDecision.md @@ -0,0 +1,35 @@ +--- +id: non-employee-approval-decision +title: NonEmployeeApprovalDecision +pagination_label: NonEmployeeApprovalDecision +sidebar_label: NonEmployeeApprovalDecision +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalDecision', 'NonEmployeeApprovalDecision'] +slug: /tools/sdk/powershell/v3/models/non-employee-approval-decision +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalDecision', 'NonEmployeeApprovalDecision'] +--- + + +# NonEmployeeApprovalDecision + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment on the approval item. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeApprovalDecision = Initialize-PSSailpoint.V3NonEmployeeApprovalDecision -Comment Approved by manager +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeApprovalDecision | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeApprovalItem.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeApprovalItem.md new file mode 100644 index 000000000..4424e42bb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeApprovalItem.md @@ -0,0 +1,51 @@ +--- +id: non-employee-approval-item +title: NonEmployeeApprovalItem +pagination_label: NonEmployeeApprovalItem +sidebar_label: NonEmployeeApprovalItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalItem', 'NonEmployeeApprovalItem'] +slug: /tools/sdk/powershell/v3/models/non-employee-approval-item +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItem', 'NonEmployeeApprovalItem'] +--- + + +# NonEmployeeApprovalItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee approval item id | [optional] +**Approver** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **String** | Requested identity account name | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**ApprovalOrder** | Pointer to **Double** | Approval order | [optional] +**Comment** | Pointer to **String** | comment of approver | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] +**NonEmployeeRequest** | Pointer to [**NonEmployeeRequestLite**](non-employee-request-lite) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeApprovalItem = Initialize-PSSailpoint.V3NonEmployeeApprovalItem -Id 2c1e388b-1e55-4b0a-ab5c-897f1204159c ` + -Approver null ` + -AccountName test.account ` + -ApprovalStatus null ` + -ApprovalOrder 1 ` + -Comment I approve ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z ` + -NonEmployeeRequest null +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeApprovalItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeApprovalItemBase.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeApprovalItemBase.md new file mode 100644 index 000000000..2c68d3605 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeApprovalItemBase.md @@ -0,0 +1,49 @@ +--- +id: non-employee-approval-item-base +title: NonEmployeeApprovalItemBase +pagination_label: NonEmployeeApprovalItemBase +sidebar_label: NonEmployeeApprovalItemBase +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalItemBase', 'NonEmployeeApprovalItemBase'] +slug: /tools/sdk/powershell/v3/models/non-employee-approval-item-base +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItemBase', 'NonEmployeeApprovalItemBase'] +--- + + +# NonEmployeeApprovalItemBase + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee approval item id | [optional] +**Approver** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **String** | Requested identity account name | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**ApprovalOrder** | Pointer to **Double** | Approval order | [optional] +**Comment** | Pointer to **String** | comment of approver | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeApprovalItemBase = Initialize-PSSailpoint.V3NonEmployeeApprovalItemBase -Id 2c1e388b-1e55-4b0a-ab5c-897f1204159c ` + -Approver null ` + -AccountName test.account ` + -ApprovalStatus null ` + -ApprovalOrder 1 ` + -Comment I approve ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeApprovalItemBase | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeApprovalItemDetail.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeApprovalItemDetail.md new file mode 100644 index 000000000..62018fc78 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeApprovalItemDetail.md @@ -0,0 +1,51 @@ +--- +id: non-employee-approval-item-detail +title: NonEmployeeApprovalItemDetail +pagination_label: NonEmployeeApprovalItemDetail +sidebar_label: NonEmployeeApprovalItemDetail +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalItemDetail', 'NonEmployeeApprovalItemDetail'] +slug: /tools/sdk/powershell/v3/models/non-employee-approval-item-detail +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItemDetail', 'NonEmployeeApprovalItemDetail'] +--- + + +# NonEmployeeApprovalItemDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee approval item id | [optional] +**Approver** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **String** | Requested identity account name | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**ApprovalOrder** | Pointer to **Double** | Approval order | [optional] +**Comment** | Pointer to **String** | comment of approver | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] +**NonEmployeeRequest** | Pointer to [**NonEmployeeRequestWithoutApprovalItem**](non-employee-request-without-approval-item) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeApprovalItemDetail = Initialize-PSSailpoint.V3NonEmployeeApprovalItemDetail -Id 2c1e388b-1e55-4b0a-ab5c-897f1204159c ` + -Approver null ` + -AccountName test.account ` + -ApprovalStatus null ` + -ApprovalOrder 1 ` + -Comment I approve ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z ` + -NonEmployeeRequest null +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeApprovalItemDetail | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeApprovalSummary.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeApprovalSummary.md new file mode 100644 index 000000000..4660b1dd8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeApprovalSummary.md @@ -0,0 +1,39 @@ +--- +id: non-employee-approval-summary +title: NonEmployeeApprovalSummary +pagination_label: NonEmployeeApprovalSummary +sidebar_label: NonEmployeeApprovalSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalSummary', 'NonEmployeeApprovalSummary'] +slug: /tools/sdk/powershell/v3/models/non-employee-approval-summary +tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalSummary', 'NonEmployeeApprovalSummary'] +--- + + +# NonEmployeeApprovalSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Approved** | Pointer to **Int32** | The number of approved non-employee approval requests. | [optional] +**Pending** | Pointer to **Int32** | The number of pending non-employee approval requests. | [optional] +**Rejected** | Pointer to **Int32** | The number of rejected non-employee approval requests. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeApprovalSummary = Initialize-PSSailpoint.V3NonEmployeeApprovalSummary -Approved 2 ` + -Pending 2 ` + -Rejected 2 +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeApprovalSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeBulkUploadJob.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeBulkUploadJob.md new file mode 100644 index 000000000..d373054a1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeBulkUploadJob.md @@ -0,0 +1,43 @@ +--- +id: non-employee-bulk-upload-job +title: NonEmployeeBulkUploadJob +pagination_label: NonEmployeeBulkUploadJob +sidebar_label: NonEmployeeBulkUploadJob +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeBulkUploadJob', 'NonEmployeeBulkUploadJob'] +slug: /tools/sdk/powershell/v3/models/non-employee-bulk-upload-job +tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadJob', 'NonEmployeeBulkUploadJob'] +--- + + +# NonEmployeeBulkUploadJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The bulk upload job's ID. (UUID) | [optional] +**SourceId** | Pointer to **String** | The ID of the source to bulk-upload non-employees to. (UUID) | [optional] +**Created** | Pointer to **System.DateTime** | The date-time the job was submitted. | [optional] +**Modified** | Pointer to **System.DateTime** | The date-time that the job was last updated. | [optional] +**Status** | Pointer to **Enum** [ "PENDING", "IN_PROGRESS", "COMPLETED", "ERROR" ] | Returns the following values indicating the progress or result of the bulk upload job. ""PENDING"" means the job is queued and waiting to be processed. ""IN_PROGRESS"" means the job is currently being processed. ""COMPLETED"" means the job has been completed without any errors. ""ERROR"" means the job failed to process with errors. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeBulkUploadJob = Initialize-PSSailpoint.V3NonEmployeeBulkUploadJob -Id 2c91808568c529c60168cca6f90cffff ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -Created 2019-08-23T18:52:59.162Z ` + -Modified 2019-08-23T18:52:59.162Z ` + -Status PENDING +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeBulkUploadJob | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeBulkUploadStatus.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeBulkUploadStatus.md new file mode 100644 index 000000000..de8d5b9f0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeBulkUploadStatus.md @@ -0,0 +1,35 @@ +--- +id: non-employee-bulk-upload-status +title: NonEmployeeBulkUploadStatus +pagination_label: NonEmployeeBulkUploadStatus +sidebar_label: NonEmployeeBulkUploadStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeBulkUploadStatus', 'NonEmployeeBulkUploadStatus'] +slug: /tools/sdk/powershell/v3/models/non-employee-bulk-upload-status +tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadStatus', 'NonEmployeeBulkUploadStatus'] +--- + + +# NonEmployeeBulkUploadStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **Enum** [ "PENDING", "IN_PROGRESS", "COMPLETED", "ERROR" ] | Returns the following values indicating the progress or result of the bulk upload job. ""PENDING"" means the job is queued and waiting to be processed. ""IN_PROGRESS"" means the job is currently being processed. ""COMPLETED"" means the job has been completed without any errors. ""ERROR"" means the job failed to process with errors. null means job has been submitted to the source. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeBulkUploadStatus = Initialize-PSSailpoint.V3NonEmployeeBulkUploadStatus -Status PENDING +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeBulkUploadStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeIdentityDtoType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeIdentityDtoType.md new file mode 100644 index 000000000..90bd8907d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeIdentityDtoType.md @@ -0,0 +1,24 @@ +--- +id: non-employee-identity-dto-type +title: NonEmployeeIdentityDtoType +pagination_label: NonEmployeeIdentityDtoType +sidebar_label: NonEmployeeIdentityDtoType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeIdentityDtoType', 'NonEmployeeIdentityDtoType'] +slug: /tools/sdk/powershell/v3/models/non-employee-identity-dto-type +tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdentityDtoType', 'NonEmployeeIdentityDtoType'] +--- + + +# NonEmployeeIdentityDtoType + +## Enum + + +* `GOVERNANCE_GROUP` (value: `"GOVERNANCE_GROUP"`) + +* `IDENTITY` (value: `"IDENTITY"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeIdentityReferenceWithId.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeIdentityReferenceWithId.md new file mode 100644 index 000000000..082d89cef --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeIdentityReferenceWithId.md @@ -0,0 +1,37 @@ +--- +id: non-employee-identity-reference-with-id +title: NonEmployeeIdentityReferenceWithId +pagination_label: NonEmployeeIdentityReferenceWithId +sidebar_label: NonEmployeeIdentityReferenceWithId +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeIdentityReferenceWithId', 'NonEmployeeIdentityReferenceWithId'] +slug: /tools/sdk/powershell/v3/models/non-employee-identity-reference-with-id +tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdentityReferenceWithId', 'NonEmployeeIdentityReferenceWithId'] +--- + + +# NonEmployeeIdentityReferenceWithId + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**NonEmployeeIdentityDtoType**](non-employee-identity-dto-type) | | [optional] +**Id** | Pointer to **String** | Identity id | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeIdentityReferenceWithId = Initialize-PSSailpoint.V3NonEmployeeIdentityReferenceWithId -Type null ` + -Id 5168015d32f890ca15812c9180835d2e +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeIdentityReferenceWithId | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeIdnUserRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeIdnUserRequest.md new file mode 100644 index 000000000..06775ff81 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeIdnUserRequest.md @@ -0,0 +1,35 @@ +--- +id: non-employee-idn-user-request +title: NonEmployeeIdnUserRequest +pagination_label: NonEmployeeIdnUserRequest +sidebar_label: NonEmployeeIdnUserRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeIdnUserRequest', 'NonEmployeeIdnUserRequest'] +slug: /tools/sdk/powershell/v3/models/non-employee-idn-user-request +tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdnUserRequest', 'NonEmployeeIdnUserRequest'] +--- + + +# NonEmployeeIdnUserRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Identity id. | [required] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeIdnUserRequest = Initialize-PSSailpoint.V3NonEmployeeIdnUserRequest -Id 2c91808570313110017040b06f344ec9 +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeIdnUserRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeRecord.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeRecord.md new file mode 100644 index 000000000..d2220b579 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeRecord.md @@ -0,0 +1,59 @@ +--- +id: non-employee-record +title: NonEmployeeRecord +pagination_label: NonEmployeeRecord +sidebar_label: NonEmployeeRecord +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRecord', 'NonEmployeeRecord'] +slug: /tools/sdk/powershell/v3/models/non-employee-record +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRecord', 'NonEmployeeRecord'] +--- + + +# NonEmployeeRecord + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee record id. | [optional] +**AccountName** | Pointer to **String** | Requested identity account name. | [optional] +**FirstName** | Pointer to **String** | Non-Employee's first name. | [optional] +**LastName** | Pointer to **String** | Non-Employee's last name. | [optional] +**Email** | Pointer to **String** | Non-Employee's email. | [optional] +**Phone** | Pointer to **String** | Non-Employee's phone. | [optional] +**Manager** | Pointer to **String** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**SourceId** | Pointer to **String** | Non-Employee's source id. | [optional] +**VarData** | Pointer to **map[string]String** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**StartDate** | Pointer to **System.DateTime** | Non-Employee employment start date. | [optional] +**EndDate** | Pointer to **System.DateTime** | Non-Employee employment end date. | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeRecord = Initialize-PSSailpoint.V3NonEmployeeRecord -Id ef38f94347e94562b5bb8424a56397d8 ` + -AccountName Abby.Smith ` + -FirstName William ` + -LastName Smith ` + -Email william.smith@example.com ` + -Phone 5125555555 ` + -Manager jane.doe ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -VarData {description=Auditing} ` + -StartDate 2019-08-23T18:52:59.162Z ` + -EndDate 2020-08-23T18:52:59.162Z ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeRecord | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeRejectApprovalDecision.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeRejectApprovalDecision.md new file mode 100644 index 000000000..3852681f1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeRejectApprovalDecision.md @@ -0,0 +1,35 @@ +--- +id: non-employee-reject-approval-decision +title: NonEmployeeRejectApprovalDecision +pagination_label: NonEmployeeRejectApprovalDecision +sidebar_label: NonEmployeeRejectApprovalDecision +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRejectApprovalDecision', 'NonEmployeeRejectApprovalDecision'] +slug: /tools/sdk/powershell/v3/models/non-employee-reject-approval-decision +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRejectApprovalDecision', 'NonEmployeeRejectApprovalDecision'] +--- + + +# NonEmployeeRejectApprovalDecision + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | **String** | Comment on the approval item. | [required] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeRejectApprovalDecision = Initialize-PSSailpoint.V3NonEmployeeRejectApprovalDecision -Comment approved +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeRejectApprovalDecision | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeRequest.md new file mode 100644 index 000000000..81349d200 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeRequest.md @@ -0,0 +1,73 @@ +--- +id: non-employee-request +title: NonEmployeeRequest +pagination_label: NonEmployeeRequest +sidebar_label: NonEmployeeRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequest', 'NonEmployeeRequest'] +slug: /tools/sdk/powershell/v3/models/non-employee-request +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequest', 'NonEmployeeRequest'] +--- + + +# NonEmployeeRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] +**AccountName** | Pointer to **String** | Requested identity account name. | [optional] +**FirstName** | Pointer to **String** | Non-Employee's first name. | [optional] +**LastName** | Pointer to **String** | Non-Employee's last name. | [optional] +**Email** | Pointer to **String** | Non-Employee's email. | [optional] +**Phone** | Pointer to **String** | Non-Employee's phone. | [optional] +**Manager** | Pointer to **String** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**NonEmployeeSource** | Pointer to [**NonEmployeeSourceLite**](non-employee-source-lite) | | [optional] +**VarData** | Pointer to **map[string]String** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**ApprovalItems** | Pointer to [**[]NonEmployeeApprovalItemBase**](non-employee-approval-item-base) | List of approval item for the request | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**Comment** | Pointer to **String** | Comment of requester | [optional] +**CompletionDate** | Pointer to **System.DateTime** | When the request was completely approved. | [optional] +**StartDate** | Pointer to **System.DateTime** | Non-Employee employment start date. | [optional] +**EndDate** | Pointer to **System.DateTime** | Non-Employee employment end date. | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeRequest = Initialize-PSSailpoint.V3NonEmployeeRequest -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -Name Retail ` + -Description Source description ` + -AccountName william.smith ` + -FirstName William ` + -LastName Smith ` + -Email william.smith@example.com ` + -Phone 5125555555 ` + -Manager jane.doe ` + -NonEmployeeSource null ` + -VarData {description=Auditing} ` + -ApprovalItems null ` + -ApprovalStatus null ` + -Comment approved ` + -CompletionDate 2020-03-24T11:11:41.139-05:00 ` + -StartDate 2020-03-24T00:00-05:00 ` + -EndDate 2021-03-25T00:00-05:00 ` + -Modified 2020-03-24T11:11:41.139-05:00 ` + -Created 2020-03-24T11:11:41.139-05:00 +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeRequestBody.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeRequestBody.md new file mode 100644 index 000000000..895248c48 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeRequestBody.md @@ -0,0 +1,53 @@ +--- +id: non-employee-request-body +title: NonEmployeeRequestBody +pagination_label: NonEmployeeRequestBody +sidebar_label: NonEmployeeRequestBody +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequestBody', 'NonEmployeeRequestBody'] +slug: /tools/sdk/powershell/v3/models/non-employee-request-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestBody', 'NonEmployeeRequestBody'] +--- + + +# NonEmployeeRequestBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountName** | **String** | Requested identity account name. | [required] +**FirstName** | **String** | Non-Employee's first name. | [required] +**LastName** | **String** | Non-Employee's last name. | [required] +**Email** | **String** | Non-Employee's email. | [required] +**Phone** | **String** | Non-Employee's phone. | [required] +**Manager** | **String** | The account ID of a valid identity to serve as this non-employee's manager. | [required] +**SourceId** | **String** | Non-Employee's source id. | [required] +**VarData** | Pointer to **map[string]String** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**StartDate** | **System.DateTime** | Non-Employee employment start date. | [required] +**EndDate** | **System.DateTime** | Non-Employee employment end date. | [required] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeRequestBody = Initialize-PSSailpoint.V3NonEmployeeRequestBody -AccountName william.smith ` + -FirstName William ` + -LastName Smith ` + -Email william.smith@example.com ` + -Phone 5125555555 ` + -Manager jane.doe ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -VarData {description=Auditing} ` + -StartDate 2020-03-24T00:00-05:00 ` + -EndDate 2021-03-25T00:00-05:00 +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeRequestBody | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeRequestLite.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeRequestLite.md new file mode 100644 index 000000000..d40d6c942 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeRequestLite.md @@ -0,0 +1,37 @@ +--- +id: non-employee-request-lite +title: NonEmployeeRequestLite +pagination_label: NonEmployeeRequestLite +sidebar_label: NonEmployeeRequestLite +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequestLite', 'NonEmployeeRequestLite'] +slug: /tools/sdk/powershell/v3/models/non-employee-request-lite +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestLite', 'NonEmployeeRequestLite'] +--- + + +# NonEmployeeRequestLite + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee request id. | [optional] +**Requester** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeRequestLite = Initialize-PSSailpoint.V3NonEmployeeRequestLite -Id ac110005-7156-1150-8171-5b292e3e0084 ` + -Requester null +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeRequestLite | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeRequestSummary.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeRequestSummary.md new file mode 100644 index 000000000..9a42016bc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeRequestSummary.md @@ -0,0 +1,41 @@ +--- +id: non-employee-request-summary +title: NonEmployeeRequestSummary +pagination_label: NonEmployeeRequestSummary +sidebar_label: NonEmployeeRequestSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequestSummary', 'NonEmployeeRequestSummary'] +slug: /tools/sdk/powershell/v3/models/non-employee-request-summary +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestSummary', 'NonEmployeeRequestSummary'] +--- + + +# NonEmployeeRequestSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Approved** | Pointer to **Int32** | The number of approved non-employee requests on all sources that *requested-for* user manages. | [optional] +**Rejected** | Pointer to **Int32** | The number of rejected non-employee requests on all sources that *requested-for* user manages. | [optional] +**Pending** | Pointer to **Int32** | The number of pending non-employee requests on all sources that *requested-for* user manages. | [optional] +**NonEmployeeCount** | Pointer to **Int32** | The number of non-employee records on all sources that *requested-for* user manages. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeRequestSummary = Initialize-PSSailpoint.V3NonEmployeeRequestSummary -Approved 2 ` + -Rejected 2 ` + -Pending 2 ` + -NonEmployeeCount 2 +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeRequestSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeRequestWithoutApprovalItem.md new file mode 100644 index 000000000..edcb22d21 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -0,0 +1,67 @@ +--- +id: non-employee-request-without-approval-item +title: NonEmployeeRequestWithoutApprovalItem +pagination_label: NonEmployeeRequestWithoutApprovalItem +sidebar_label: NonEmployeeRequestWithoutApprovalItem +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequestWithoutApprovalItem', 'NonEmployeeRequestWithoutApprovalItem'] +slug: /tools/sdk/powershell/v3/models/non-employee-request-without-approval-item +tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestWithoutApprovalItem', 'NonEmployeeRequestWithoutApprovalItem'] +--- + + +# NonEmployeeRequestWithoutApprovalItem + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee request id. | [optional] +**Requester** | Pointer to [**NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | | [optional] +**AccountName** | Pointer to **String** | Requested identity account name. | [optional] +**FirstName** | Pointer to **String** | Non-Employee's first name. | [optional] +**LastName** | Pointer to **String** | Non-Employee's last name. | [optional] +**Email** | Pointer to **String** | Non-Employee's email. | [optional] +**Phone** | Pointer to **String** | Non-Employee's phone. | [optional] +**Manager** | Pointer to **String** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] +**NonEmployeeSource** | Pointer to [**NonEmployeeSourceLiteWithSchemaAttributes**](non-employee-source-lite-with-schema-attributes) | | [optional] +**VarData** | Pointer to **map[string]String** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] +**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] +**Comment** | Pointer to **String** | Comment of requester | [optional] +**CompletionDate** | Pointer to **System.DateTime** | When the request was completely approved. | [optional] +**StartDate** | Pointer to **System.DateTime** | Non-Employee employment start date. | [optional] +**EndDate** | Pointer to **System.DateTime** | Non-Employee employment end date. | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V3NonEmployeeRequestWithoutApprovalItem -Id ac110005-7156-1150-8171-5b292e3e0084 ` + -Requester null ` + -AccountName william.smith ` + -FirstName William ` + -LastName Smith ` + -Email william.smith@example.com ` + -Phone 5125555555 ` + -Manager jane.doe ` + -NonEmployeeSource null ` + -VarData {description=Auditing} ` + -ApprovalStatus null ` + -Comment approved ` + -CompletionDate 2020-03-24T11:11:41.139-05:00 ` + -StartDate Mon Mar 23 20:00:00 EDT 2020 ` + -EndDate Wed Mar 24 20:00:00 EDT 2021 ` + -Modified 2020-03-24T11:11:41.139-05:00 ` + -Created 2020-03-24T11:11:41.139-05:00 +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeRequestWithoutApprovalItem | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSchemaAttribute.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSchemaAttribute.md new file mode 100644 index 000000000..b61898a7c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSchemaAttribute.md @@ -0,0 +1,53 @@ +--- +id: non-employee-schema-attribute +title: NonEmployeeSchemaAttribute +pagination_label: NonEmployeeSchemaAttribute +sidebar_label: NonEmployeeSchemaAttribute +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSchemaAttribute', 'NonEmployeeSchemaAttribute'] +slug: /tools/sdk/powershell/v3/models/non-employee-schema-attribute +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttribute', 'NonEmployeeSchemaAttribute'] +--- + + +# NonEmployeeSchemaAttribute + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Schema Attribute Id | [optional] +**System** | Pointer to **Boolean** | True if this schema attribute is mandatory on all non-employees sources. | [optional] [default to $false] +**Modified** | Pointer to **System.DateTime** | When the schema attribute was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the schema attribute was created. | [optional] +**Type** | [**NonEmployeeSchemaAttributeType**](non-employee-schema-attribute-type) | | [required] +**Label** | **String** | Label displayed on the UI for this schema attribute. | [required] +**TechnicalName** | **String** | The technical name of the attribute. Must be unique per source. | [required] +**HelpText** | Pointer to **String** | help text displayed by UI. | [optional] +**Placeholder** | Pointer to **String** | Hint text that fills UI box. | [optional] +**Required** | Pointer to **Boolean** | If true, the schema attribute is required for all non-employees in the source | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeSchemaAttribute = Initialize-PSSailpoint.V3NonEmployeeSchemaAttribute -Id ac110005-7156-1150-8171-5b292e3e0084 ` + -System true ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z ` + -Type null ` + -Label Account Name ` + -TechnicalName account.name ` + -HelpText The unique identifier for the account ` + -Placeholder Enter a unique user name for this account. ` + -Required true +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeSchemaAttribute | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSchemaAttributeBody.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSchemaAttributeBody.md new file mode 100644 index 000000000..7449effac --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSchemaAttributeBody.md @@ -0,0 +1,45 @@ +--- +id: non-employee-schema-attribute-body +title: NonEmployeeSchemaAttributeBody +pagination_label: NonEmployeeSchemaAttributeBody +sidebar_label: NonEmployeeSchemaAttributeBody +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSchemaAttributeBody', 'NonEmployeeSchemaAttributeBody'] +slug: /tools/sdk/powershell/v3/models/non-employee-schema-attribute-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeBody', 'NonEmployeeSchemaAttributeBody'] +--- + + +# NonEmployeeSchemaAttributeBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **String** | Type of the attribute. Only type 'TEXT' is supported for custom attributes. | [required] +**Label** | **String** | Label displayed on the UI for this schema attribute. | [required] +**TechnicalName** | **String** | The technical name of the attribute. Must be unique per source. | [required] +**HelpText** | Pointer to **String** | help text displayed by UI. | [optional] +**Placeholder** | Pointer to **String** | Hint text that fills UI box. | [optional] +**Required** | Pointer to **Boolean** | If true, the schema attribute is required for all non-employees in the source | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeSchemaAttributeBody = Initialize-PSSailpoint.V3NonEmployeeSchemaAttributeBody -Type TEXT ` + -Label Account Name ` + -TechnicalName account.name ` + -HelpText The unique identifier for the account ` + -Placeholder Enter a unique user name for this account. ` + -Required true +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeSchemaAttributeBody | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSchemaAttributeType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSchemaAttributeType.md new file mode 100644 index 000000000..31dc9bd22 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSchemaAttributeType.md @@ -0,0 +1,26 @@ +--- +id: non-employee-schema-attribute-type +title: NonEmployeeSchemaAttributeType +pagination_label: NonEmployeeSchemaAttributeType +sidebar_label: NonEmployeeSchemaAttributeType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSchemaAttributeType', 'NonEmployeeSchemaAttributeType'] +slug: /tools/sdk/powershell/v3/models/non-employee-schema-attribute-type +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeType', 'NonEmployeeSchemaAttributeType'] +--- + + +# NonEmployeeSchemaAttributeType + +## Enum + + +* `TEXT` (value: `"TEXT"`) + +* `DATE` (value: `"DATE"`) + +* `IDENTITY` (value: `"IDENTITY"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSource.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSource.md new file mode 100644 index 000000000..6124f8afd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSource.md @@ -0,0 +1,49 @@ +--- +id: non-employee-source +title: NonEmployeeSource +pagination_label: NonEmployeeSource +sidebar_label: NonEmployeeSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSource', 'NonEmployeeSource'] +slug: /tools/sdk/powershell/v3/models/non-employee-source +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSource', 'NonEmployeeSource'] +--- + + +# NonEmployeeSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] +**Approvers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of approvers | [optional] +**AccountManagers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeSource = Initialize-PSSailpoint.V3NonEmployeeSource -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -Name Retail ` + -Description Source description ` + -Approvers null ` + -AccountManagers null ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSourceLite.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSourceLite.md new file mode 100644 index 000000000..842e4df53 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSourceLite.md @@ -0,0 +1,41 @@ +--- +id: non-employee-source-lite +title: NonEmployeeSourceLite +pagination_label: NonEmployeeSourceLite +sidebar_label: NonEmployeeSourceLite +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceLite', 'NonEmployeeSourceLite'] +slug: /tools/sdk/powershell/v3/models/non-employee-source-lite +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceLite', 'NonEmployeeSourceLite'] +--- + + +# NonEmployeeSourceLite + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeSourceLite = Initialize-PSSailpoint.V3NonEmployeeSourceLite -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -Name Retail ` + -Description Source description +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeSourceLite | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSourceLiteWithSchemaAttributes.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSourceLiteWithSchemaAttributes.md new file mode 100644 index 000000000..655c94193 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSourceLiteWithSchemaAttributes.md @@ -0,0 +1,43 @@ +--- +id: non-employee-source-lite-with-schema-attributes +title: NonEmployeeSourceLiteWithSchemaAttributes +pagination_label: NonEmployeeSourceLiteWithSchemaAttributes +sidebar_label: NonEmployeeSourceLiteWithSchemaAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceLiteWithSchemaAttributes', 'NonEmployeeSourceLiteWithSchemaAttributes'] +slug: /tools/sdk/powershell/v3/models/non-employee-source-lite-with-schema-attributes +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceLiteWithSchemaAttributes', 'NonEmployeeSourceLiteWithSchemaAttributes'] +--- + + +# NonEmployeeSourceLiteWithSchemaAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] +**SchemaAttributes** | Pointer to [**[]NonEmployeeSchemaAttribute**](non-employee-schema-attribute) | List of schema attributes associated with this non-employee source. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeSourceLiteWithSchemaAttributes = Initialize-PSSailpoint.V3NonEmployeeSourceLiteWithSchemaAttributes -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -Name Retail ` + -Description Source description ` + -SchemaAttributes null +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeSourceLiteWithSchemaAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSourceRequestBody.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSourceRequestBody.md new file mode 100644 index 000000000..5b9061463 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSourceRequestBody.md @@ -0,0 +1,45 @@ +--- +id: non-employee-source-request-body +title: NonEmployeeSourceRequestBody +pagination_label: NonEmployeeSourceRequestBody +sidebar_label: NonEmployeeSourceRequestBody +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceRequestBody', 'NonEmployeeSourceRequestBody'] +slug: /tools/sdk/powershell/v3/models/non-employee-source-request-body +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceRequestBody', 'NonEmployeeSourceRequestBody'] +--- + + +# NonEmployeeSourceRequestBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Name of non-employee source. | [required] +**Description** | **String** | Description of non-employee source. | [required] +**Owner** | [**NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | | [required] +**ManagementWorkgroup** | Pointer to **String** | The ID for the management workgroup that contains source sub-admins | [optional] +**Approvers** | Pointer to [**[]NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | List of approvers. | [optional] +**AccountManagers** | Pointer to [**[]NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | List of account managers. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeSourceRequestBody = Initialize-PSSailpoint.V3NonEmployeeSourceRequestBody -Name Retail ` + -Description Source description ` + -Owner null ` + -ManagementWorkgroup 123299 ` + -Approvers null ` + -AccountManagers null +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeSourceRequestBody | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSourceWithCloudExternalId.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSourceWithCloudExternalId.md new file mode 100644 index 000000000..14e93453d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSourceWithCloudExternalId.md @@ -0,0 +1,51 @@ +--- +id: non-employee-source-with-cloud-external-id +title: NonEmployeeSourceWithCloudExternalId +pagination_label: NonEmployeeSourceWithCloudExternalId +sidebar_label: NonEmployeeSourceWithCloudExternalId +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceWithCloudExternalId', 'NonEmployeeSourceWithCloudExternalId'] +slug: /tools/sdk/powershell/v3/models/non-employee-source-with-cloud-external-id +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceWithCloudExternalId', 'NonEmployeeSourceWithCloudExternalId'] +--- + + +# NonEmployeeSourceWithCloudExternalId + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] +**Approvers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of approvers | [optional] +**AccountManagers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] +**CloudExternalId** | Pointer to **String** | Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeSourceWithCloudExternalId = Initialize-PSSailpoint.V3NonEmployeeSourceWithCloudExternalId -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -Name Retail ` + -Description Source description ` + -Approvers null ` + -AccountManagers null ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z ` + -CloudExternalId 99999 +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeSourceWithCloudExternalId | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSourceWithNECount.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSourceWithNECount.md new file mode 100644 index 000000000..b7f9f87b0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/NonEmployeeSourceWithNECount.md @@ -0,0 +1,51 @@ +--- +id: non-employee-source-with-ne-count +title: NonEmployeeSourceWithNECount +pagination_label: NonEmployeeSourceWithNECount +sidebar_label: NonEmployeeSourceWithNECount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceWithNECount', 'NonEmployeeSourceWithNECount'] +slug: /tools/sdk/powershell/v3/models/non-employee-source-with-ne-count +tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceWithNECount', 'NonEmployeeSourceWithNECount'] +--- + + +# NonEmployeeSourceWithNECount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Non-Employee source id. | [optional] +**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] +**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] +**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] +**Approvers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of approvers | [optional] +**AccountManagers** | Pointer to [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] +**NonEmployeeCount** | Pointer to **Int32** | Number of non-employee records associated with this source. | [optional] + +## Examples + +- Prepare the resource +```powershell +$NonEmployeeSourceWithNECount = Initialize-PSSailpoint.V3NonEmployeeSourceWithNECount -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` + -SourceId 2c91808568c529c60168cca6f90c1313 ` + -Name Retail ` + -Description Source description ` + -Approvers null ` + -AccountManagers null ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z ` + -NonEmployeeCount 120 +``` + +- Convert the resource to JSON +```powershell +$NonEmployeeSourceWithNECount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ObjectExportImportNames.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ObjectExportImportNames.md new file mode 100644 index 000000000..fdc0b6459 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ObjectExportImportNames.md @@ -0,0 +1,35 @@ +--- +id: object-export-import-names +title: ObjectExportImportNames +pagination_label: ObjectExportImportNames +sidebar_label: ObjectExportImportNames +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectExportImportNames', 'ObjectExportImportNames'] +slug: /tools/sdk/powershell/v3/models/object-export-import-names +tags: ['SDK', 'Software Development Kit', 'ObjectExportImportNames', 'ObjectExportImportNames'] +--- + + +# ObjectExportImportNames + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IncludedNames** | Pointer to **[]String** | Object names to be included in a backup. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ObjectExportImportNames = Initialize-PSSailpoint.V3ObjectExportImportNames -IncludedNames null +``` + +- Convert the resource to JSON +```powershell +$ObjectExportImportNames | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ObjectImportResult.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ObjectImportResult.md new file mode 100644 index 000000000..8916b85d2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ObjectImportResult.md @@ -0,0 +1,41 @@ +--- +id: object-import-result +title: ObjectImportResult +pagination_label: ObjectImportResult +sidebar_label: ObjectImportResult +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectImportResult', 'ObjectImportResult'] +slug: /tools/sdk/powershell/v3/models/object-import-result +tags: ['SDK', 'Software Development Kit', 'ObjectImportResult', 'ObjectImportResult'] +--- + + +# ObjectImportResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Infos** | [**[]SpConfigMessage**](sp-config-message) | Informational messages returned from the target service on import. | [required] +**Warnings** | [**[]SpConfigMessage**](sp-config-message) | Warning messages returned from the target service on import. | [required] +**Errors** | [**[]SpConfigMessage**](sp-config-message) | Error messages returned from the target service on import. | [required] +**ImportedObjects** | [**[]ImportObject**](import-object) | References to objects that were created or updated by the import. | [required] + +## Examples + +- Prepare the resource +```powershell +$ObjectImportResult = Initialize-PSSailpoint.V3ObjectImportResult -Infos null ` + -Warnings null ` + -Errors null ` + -ImportedObjects null +``` + +- Convert the resource to JSON +```powershell +$ObjectImportResult | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ObjectMappingBulkCreateRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ObjectMappingBulkCreateRequest.md new file mode 100644 index 000000000..c9b8499b8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ObjectMappingBulkCreateRequest.md @@ -0,0 +1,35 @@ +--- +id: object-mapping-bulk-create-request +title: ObjectMappingBulkCreateRequest +pagination_label: ObjectMappingBulkCreateRequest +sidebar_label: ObjectMappingBulkCreateRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectMappingBulkCreateRequest', 'ObjectMappingBulkCreateRequest'] +slug: /tools/sdk/powershell/v3/models/object-mapping-bulk-create-request +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkCreateRequest', 'ObjectMappingBulkCreateRequest'] +--- + + +# ObjectMappingBulkCreateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NewObjectsMappings** | [**[]ObjectMappingRequest**](object-mapping-request) | | [required] + +## Examples + +- Prepare the resource +```powershell +$ObjectMappingBulkCreateRequest = Initialize-PSSailpoint.V3ObjectMappingBulkCreateRequest -NewObjectsMappings null +``` + +- Convert the resource to JSON +```powershell +$ObjectMappingBulkCreateRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ObjectMappingBulkCreateResponse.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ObjectMappingBulkCreateResponse.md new file mode 100644 index 000000000..a25a52f14 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ObjectMappingBulkCreateResponse.md @@ -0,0 +1,35 @@ +--- +id: object-mapping-bulk-create-response +title: ObjectMappingBulkCreateResponse +pagination_label: ObjectMappingBulkCreateResponse +sidebar_label: ObjectMappingBulkCreateResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectMappingBulkCreateResponse', 'ObjectMappingBulkCreateResponse'] +slug: /tools/sdk/powershell/v3/models/object-mapping-bulk-create-response +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkCreateResponse', 'ObjectMappingBulkCreateResponse'] +--- + + +# ObjectMappingBulkCreateResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AddedObjects** | Pointer to [**[]ObjectMappingResponse**](object-mapping-response) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ObjectMappingBulkCreateResponse = Initialize-PSSailpoint.V3ObjectMappingBulkCreateResponse -AddedObjects null +``` + +- Convert the resource to JSON +```powershell +$ObjectMappingBulkCreateResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ObjectMappingBulkPatchRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ObjectMappingBulkPatchRequest.md new file mode 100644 index 000000000..72f20c592 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ObjectMappingBulkPatchRequest.md @@ -0,0 +1,35 @@ +--- +id: object-mapping-bulk-patch-request +title: ObjectMappingBulkPatchRequest +pagination_label: ObjectMappingBulkPatchRequest +sidebar_label: ObjectMappingBulkPatchRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectMappingBulkPatchRequest', 'ObjectMappingBulkPatchRequest'] +slug: /tools/sdk/powershell/v3/models/object-mapping-bulk-patch-request +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkPatchRequest', 'ObjectMappingBulkPatchRequest'] +--- + + +# ObjectMappingBulkPatchRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Patches** | [**map[string]JsonPatchOperation[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | Map of id of the object mapping to a JsonPatchOperation describing what to patch on that object mapping. | [required] + +## Examples + +- Prepare the resource +```powershell +$ObjectMappingBulkPatchRequest = Initialize-PSSailpoint.V3ObjectMappingBulkPatchRequest -Patches {603b1a61-d03d-4ed1-864f-a508fbd1995d=[{op=replace, path=/enabled, value=true}], 00bece34-f50d-4227-8878-76f620b5a971=[{op=replace, path=/targetValue, value=New Target Value}]} +``` + +- Convert the resource to JSON +```powershell +$ObjectMappingBulkPatchRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ObjectMappingBulkPatchResponse.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ObjectMappingBulkPatchResponse.md new file mode 100644 index 000000000..26bb186dc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ObjectMappingBulkPatchResponse.md @@ -0,0 +1,35 @@ +--- +id: object-mapping-bulk-patch-response +title: ObjectMappingBulkPatchResponse +pagination_label: ObjectMappingBulkPatchResponse +sidebar_label: ObjectMappingBulkPatchResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectMappingBulkPatchResponse', 'ObjectMappingBulkPatchResponse'] +slug: /tools/sdk/powershell/v3/models/object-mapping-bulk-patch-response +tags: ['SDK', 'Software Development Kit', 'ObjectMappingBulkPatchResponse', 'ObjectMappingBulkPatchResponse'] +--- + + +# ObjectMappingBulkPatchResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PatchedObjects** | Pointer to [**[]ObjectMappingResponse**](object-mapping-response) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ObjectMappingBulkPatchResponse = Initialize-PSSailpoint.V3ObjectMappingBulkPatchResponse -PatchedObjects null +``` + +- Convert the resource to JSON +```powershell +$ObjectMappingBulkPatchResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ObjectMappingRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ObjectMappingRequest.md new file mode 100644 index 000000000..839e93e00 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ObjectMappingRequest.md @@ -0,0 +1,43 @@ +--- +id: object-mapping-request +title: ObjectMappingRequest +pagination_label: ObjectMappingRequest +sidebar_label: ObjectMappingRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectMappingRequest', 'ObjectMappingRequest'] +slug: /tools/sdk/powershell/v3/models/object-mapping-request +tags: ['SDK', 'Software Development Kit', 'ObjectMappingRequest', 'ObjectMappingRequest'] +--- + + +# ObjectMappingRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectType** | **Enum** [ "ACCESS_PROFILE", "ACCESS_REQUEST_CONFIG", "ATTR_SYNC_SOURCE_CONFIG", "AUTH_ORG", "CAMPAIGN_FILTER", "ENTITLEMENT", "FORM_DEFINITION", "GOVERNANCE_GROUP", "IDENTITY", "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "LIFECYCLE_STATE", "NOTIFICATION_TEMPLATE", "PASSWORD_POLICY", "PASSWORD_SYNC_GROUP", "PUBLIC_IDENTITIES_CONFIG", "ROLE", "RULE", "SEGMENT", "SERVICE_DESK_INTEGRATION", "SOD_POLICY", "SOURCE", "TAG", "TRANSFORM", "TRIGGER_SUBSCRIPTION", "WORKFLOW" ] | Type of the object the mapping value applies to, must be one from enum | [required] +**JsonPath** | **String** | JSONPath expression denoting the path within the object where the mapping value should be applied | [required] +**SourceValue** | **String** | Original value at the jsonPath location within the object | [required] +**TargetValue** | **String** | Value to be assigned at the jsonPath location within the object | [required] +**Enabled** | Pointer to **Boolean** | Whether or not this object mapping is enabled | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$ObjectMappingRequest = Initialize-PSSailpoint.V3ObjectMappingRequest -ObjectType IDENTITY ` + -JsonPath $.name ` + -SourceValue My Governance Group Name ` + -TargetValue My New Governance Group Name ` + -Enabled false +``` + +- Convert the resource to JSON +```powershell +$ObjectMappingRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ObjectMappingResponse.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ObjectMappingResponse.md new file mode 100644 index 000000000..b0cc20a7b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ObjectMappingResponse.md @@ -0,0 +1,49 @@ +--- +id: object-mapping-response +title: ObjectMappingResponse +pagination_label: ObjectMappingResponse +sidebar_label: ObjectMappingResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectMappingResponse', 'ObjectMappingResponse'] +slug: /tools/sdk/powershell/v3/models/object-mapping-response +tags: ['SDK', 'Software Development Kit', 'ObjectMappingResponse', 'ObjectMappingResponse'] +--- + + +# ObjectMappingResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectMappingId** | Pointer to **String** | Id of the object mapping | [optional] +**ObjectType** | Pointer to **Enum** [ "ACCESS_PROFILE", "ACCESS_REQUEST_CONFIG", "ATTR_SYNC_SOURCE_CONFIG", "AUTH_ORG", "CAMPAIGN_FILTER", "ENTITLEMENT", "FORM_DEFINITION", "GOVERNANCE_GROUP", "IDENTITY", "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "LIFECYCLE_STATE", "NOTIFICATION_TEMPLATE", "PASSWORD_POLICY", "PASSWORD_SYNC_GROUP", "PUBLIC_IDENTITIES_CONFIG", "ROLE", "RULE", "SEGMENT", "SERVICE_DESK_INTEGRATION", "SOD_POLICY", "SOURCE", "TAG", "TRANSFORM", "TRIGGER_SUBSCRIPTION", "WORKFLOW" ] | Type of the object the mapping value applies to | [optional] +**JsonPath** | Pointer to **String** | JSONPath expression denoting the path within the object where the mapping value should be applied | [optional] +**SourceValue** | Pointer to **String** | Original value at the jsonPath location within the object | [optional] +**TargetValue** | Pointer to **String** | Value to be assigned at the jsonPath location within the object | [optional] +**Enabled** | Pointer to **Boolean** | Whether or not this object mapping is enabled | [optional] [default to $false] +**Created** | Pointer to **String** | Object mapping creation timestamp | [optional] +**Modified** | Pointer to **String** | Object mapping latest update timestamp | [optional] + +## Examples + +- Prepare the resource +```powershell +$ObjectMappingResponse = Initialize-PSSailpoint.V3ObjectMappingResponse -ObjectMappingId 3d6e0144-963f-4bd6-8d8d-d77b4e507ce4 ` + -ObjectType IDENTITY ` + -JsonPath $.name ` + -SourceValue My Governance Group Name ` + -TargetValue My New Governance Group Name ` + -Enabled false ` + -Created 2024-03-19T23:18:53.732Z ` + -Modified 2024-03-19T23:18:53.732Z +``` + +- Convert the resource to JSON +```powershell +$ObjectMappingResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/OktaVerificationRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/OktaVerificationRequest.md new file mode 100644 index 000000000..1f0b8a51e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/OktaVerificationRequest.md @@ -0,0 +1,35 @@ +--- +id: okta-verification-request +title: OktaVerificationRequest +pagination_label: OktaVerificationRequest +sidebar_label: OktaVerificationRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OktaVerificationRequest', 'OktaVerificationRequest'] +slug: /tools/sdk/powershell/v3/models/okta-verification-request +tags: ['SDK', 'Software Development Kit', 'OktaVerificationRequest', 'OktaVerificationRequest'] +--- + + +# OktaVerificationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserId** | **String** | User identifier for Verification request. The value of the user's attribute. | [required] + +## Examples + +- Prepare the resource +```powershell +$OktaVerificationRequest = Initialize-PSSailpoint.V3OktaVerificationRequest -UserId example@mail.com +``` + +- Convert the resource to JSON +```powershell +$OktaVerificationRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Operation.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Operation.md new file mode 100644 index 000000000..3adafa4b4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Operation.md @@ -0,0 +1,34 @@ +--- +id: operation +title: Operation +pagination_label: Operation +sidebar_label: Operation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Operation', 'Operation'] +slug: /tools/sdk/powershell/v3/models/operation +tags: ['SDK', 'Software Development Kit', 'Operation', 'Operation'] +--- + + +# Operation + +## Enum + + +* `EQUALS` (value: `"EQUALS"`) + +* `NOT_EQUALS` (value: `"NOT_EQUALS"`) + +* `CONTAINS` (value: `"CONTAINS"`) + +* `STARTS_WITH` (value: `"STARTS_WITH"`) + +* `ENDS_WITH` (value: `"ENDS_WITH"`) + +* `AND` (value: `"AND"`) + +* `OR` (value: `"OR"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/OriginalRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/OriginalRequest.md new file mode 100644 index 000000000..0624b7525 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/OriginalRequest.md @@ -0,0 +1,41 @@ +--- +id: original-request +title: OriginalRequest +pagination_label: OriginalRequest +sidebar_label: OriginalRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OriginalRequest', 'OriginalRequest'] +slug: /tools/sdk/powershell/v3/models/original-request +tags: ['SDK', 'Software Development Kit', 'OriginalRequest', 'OriginalRequest'] +--- + + +# OriginalRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | Pointer to **String** | Account ID. | [optional] +**AttributeRequests** | Pointer to [**[]AttributeRequest**](attribute-request) | Attribute changes requested for account. | [optional] +**Op** | Pointer to **String** | Operation used. | [optional] +**Source** | Pointer to [**AccountSource**](account-source) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$OriginalRequest = Initialize-PSSailpoint.V3OriginalRequest -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` + -AttributeRequests null ` + -Op add ` + -Source null +``` + +- Convert the resource to JSON +```powershell +$OriginalRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/OrphanIdentitiesReportArguments.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/OrphanIdentitiesReportArguments.md new file mode 100644 index 000000000..077e3c8bf --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/OrphanIdentitiesReportArguments.md @@ -0,0 +1,35 @@ +--- +id: orphan-identities-report-arguments +title: OrphanIdentitiesReportArguments +pagination_label: OrphanIdentitiesReportArguments +sidebar_label: OrphanIdentitiesReportArguments +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OrphanIdentitiesReportArguments', 'OrphanIdentitiesReportArguments'] +slug: /tools/sdk/powershell/v3/models/orphan-identities-report-arguments +tags: ['SDK', 'Software Development Kit', 'OrphanIdentitiesReportArguments', 'OrphanIdentitiesReportArguments'] +--- + + +# OrphanIdentitiesReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SelectedFormats** | Pointer to **[]String** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] + +## Examples + +- Prepare the resource +```powershell +$OrphanIdentitiesReportArguments = Initialize-PSSailpoint.V3OrphanIdentitiesReportArguments -SelectedFormats [CSV] +``` + +- Convert the resource to JSON +```powershell +$OrphanIdentitiesReportArguments | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/OwnerDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/OwnerDto.md new file mode 100644 index 000000000..192584ff9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/OwnerDto.md @@ -0,0 +1,39 @@ +--- +id: owner-dto +title: OwnerDto +pagination_label: OwnerDto +sidebar_label: OwnerDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OwnerDto', 'OwnerDto'] +slug: /tools/sdk/powershell/v3/models/owner-dto +tags: ['SDK', 'Software Development Kit', 'OwnerDto', 'OwnerDto'] +--- + + +# OwnerDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Owner's DTO type. | [optional] +**Id** | Pointer to **String** | Owner's identity ID. | [optional] +**Name** | Pointer to **String** | Owner's name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$OwnerDto = Initialize-PSSailpoint.V3OwnerDto -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Support +``` + +- Convert the resource to JSON +```powershell +$OwnerDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/OwnerReference.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/OwnerReference.md new file mode 100644 index 000000000..51f22658e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/OwnerReference.md @@ -0,0 +1,39 @@ +--- +id: owner-reference +title: OwnerReference +pagination_label: OwnerReference +sidebar_label: OwnerReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OwnerReference', 'OwnerReference'] +slug: /tools/sdk/powershell/v3/models/owner-reference +tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'OwnerReference'] +--- + + +# OwnerReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] +**Id** | Pointer to **String** | Identity id | [optional] +**Name** | Pointer to **String** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] + +## Examples + +- Prepare the resource +```powershell +$OwnerReference = Initialize-PSSailpoint.V3OwnerReference -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name support +``` + +- Convert the resource to JSON +```powershell +$OwnerReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/OwnerReferenceSegments.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/OwnerReferenceSegments.md new file mode 100644 index 000000000..36476f8cb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/OwnerReferenceSegments.md @@ -0,0 +1,39 @@ +--- +id: owner-reference-segments +title: OwnerReferenceSegments +pagination_label: OwnerReferenceSegments +sidebar_label: OwnerReferenceSegments +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'OwnerReferenceSegments', 'OwnerReferenceSegments'] +slug: /tools/sdk/powershell/v3/models/owner-reference-segments +tags: ['SDK', 'Software Development Kit', 'OwnerReferenceSegments', 'OwnerReferenceSegments'] +--- + + +# OwnerReferenceSegments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] +**Id** | Pointer to **String** | Identity id | [optional] +**Name** | Pointer to **String** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] + +## Examples + +- Prepare the resource +```powershell +$OwnerReferenceSegments = Initialize-PSSailpoint.V3OwnerReferenceSegments -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name support +``` + +- Convert the resource to JSON +```powershell +$OwnerReferenceSegments | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Owns.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Owns.md new file mode 100644 index 000000000..e6178a28a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Owns.md @@ -0,0 +1,47 @@ +--- +id: owns +title: Owns +pagination_label: Owns +sidebar_label: Owns +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Owns', 'Owns'] +slug: /tools/sdk/powershell/v3/models/owns +tags: ['SDK', 'Software Development Kit', 'Owns', 'Owns'] +--- + + +# Owns + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Sources** | Pointer to [**[]Reference1**](reference1) | | [optional] +**Entitlements** | Pointer to [**[]Reference1**](reference1) | | [optional] +**AccessProfiles** | Pointer to [**[]Reference1**](reference1) | | [optional] +**Roles** | Pointer to [**[]Reference1**](reference1) | | [optional] +**Apps** | Pointer to [**[]Reference1**](reference1) | | [optional] +**GovernanceGroups** | Pointer to [**[]Reference1**](reference1) | | [optional] +**FallbackApprover** | Pointer to **Boolean** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Owns = Initialize-PSSailpoint.V3Owns -Sources null ` + -Entitlements null ` + -AccessProfiles null ` + -Roles null ` + -Apps null ` + -GovernanceGroups null ` + -FallbackApprover false +``` + +- Convert the resource to JSON +```powershell +$Owns | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordChangeRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordChangeRequest.md new file mode 100644 index 000000000..e7c838a3e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordChangeRequest.md @@ -0,0 +1,43 @@ +--- +id: password-change-request +title: PasswordChangeRequest +pagination_label: PasswordChangeRequest +sidebar_label: PasswordChangeRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordChangeRequest', 'PasswordChangeRequest'] +slug: /tools/sdk/powershell/v3/models/password-change-request +tags: ['SDK', 'Software Development Kit', 'PasswordChangeRequest', 'PasswordChangeRequest'] +--- + + +# PasswordChangeRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **String** | The identity ID that requested the password change | [optional] +**EncryptedPassword** | Pointer to **String** | The RSA encrypted password | [optional] +**PublicKeyId** | Pointer to **String** | The encryption key ID | [optional] +**AccountId** | Pointer to **String** | Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [optional] +**SourceId** | Pointer to **String** | The ID of the source for which identity is requesting the password change | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordChangeRequest = Initialize-PSSailpoint.V3PasswordChangeRequest -IdentityId 8a807d4c73c545510173c545f0a002ff ` + -EncryptedPassword XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A== ` + -PublicKeyId YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2 ` + -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` + -SourceId 8a807d4c73c545510173c545d4b60246 +``` + +- Convert the resource to JSON +```powershell +$PasswordChangeRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordChangeResponse.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordChangeResponse.md new file mode 100644 index 000000000..72a83539d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordChangeResponse.md @@ -0,0 +1,37 @@ +--- +id: password-change-response +title: PasswordChangeResponse +pagination_label: PasswordChangeResponse +sidebar_label: PasswordChangeResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordChangeResponse', 'PasswordChangeResponse'] +slug: /tools/sdk/powershell/v3/models/password-change-response +tags: ['SDK', 'Software Development Kit', 'PasswordChangeResponse', 'PasswordChangeResponse'] +--- + + +# PasswordChangeResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | Pointer to **String** | The password change request ID | [optional] +**State** | Pointer to **Enum** [ "IN_PROGRESS", "FINISHED", "FAILED" ] | Password change state | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordChangeResponse = Initialize-PSSailpoint.V3PasswordChangeResponse -RequestId 089899f13a8f4da7824996191587bab9 ` + -State IN_PROGRESS +``` + +- Convert the resource to JSON +```powershell +$PasswordChangeResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordInfo.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordInfo.md new file mode 100644 index 000000000..35a5c877e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordInfo.md @@ -0,0 +1,45 @@ +--- +id: password-info +title: PasswordInfo +pagination_label: PasswordInfo +sidebar_label: PasswordInfo +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordInfo', 'PasswordInfo'] +slug: /tools/sdk/powershell/v3/models/password-info +tags: ['SDK', 'Software Development Kit', 'PasswordInfo', 'PasswordInfo'] +--- + + +# PasswordInfo + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | Pointer to **String** | Identity ID | [optional] +**SourceId** | Pointer to **String** | source ID | [optional] +**PublicKeyId** | Pointer to **String** | public key ID | [optional] +**PublicKey** | Pointer to **String** | User's public key with Base64 encoding | [optional] +**Accounts** | Pointer to [**[]PasswordInfoAccount**](password-info-account) | Account info related to queried identity and source | [optional] +**Policies** | Pointer to **[]String** | Password constraints | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordInfo = Initialize-PSSailpoint.V3PasswordInfo -IdentityId 2c918085744fec4301746f9a5bce4605 ` + -SourceId 2c918083746f642c01746f990884012a ` + -PublicKeyId N2M1OTJiMGEtMDJlZS00ZWU3LTkyYTEtNjA5YmI5NWE3ZWVh ` + -PublicKey MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuGFkWi2J75TztpbaPKd36bJnIB3J8gZ6UcoS9oSDYsqBzPpTsfZXYaEf4Y4BKGgJIXmE/lwhwuj7mU1itdZ2qTSNFtnXA8Fn75c3UUkk+h+wdZbkuSmqlsJo3R1OnJkwkJggcAy9Jvk9jlcrNLWorpQ1w9raUvxtvfgkSdq153KxotenQ1HciSyZ0nA/Kw0UaucLnho8xdRowZs11afXGXA9IT9H6D8T6zUdtSxm0nAyH+mluma5LdTfaM50W3l/L8q56Vrqmx2pZIiwdx/0+g3Y++jV70zom0ZBkC1MmSoLMrQYG5OICNjr72f78B2PaGXfarQHqARLjKpMVt9YIQIDAQAB ` + -Accounts null ` + -Policies [passwordRepeatedChar is 3, passwordMinAlpha is 1, passwordMinLength is 5, passwordMinNumeric is 1] +``` + +- Convert the resource to JSON +```powershell +$PasswordInfo | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordInfoAccount.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordInfoAccount.md new file mode 100644 index 000000000..5095fe538 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordInfoAccount.md @@ -0,0 +1,37 @@ +--- +id: password-info-account +title: PasswordInfoAccount +pagination_label: PasswordInfoAccount +sidebar_label: PasswordInfoAccount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordInfoAccount', 'PasswordInfoAccount'] +slug: /tools/sdk/powershell/v3/models/password-info-account +tags: ['SDK', 'Software Development Kit', 'PasswordInfoAccount', 'PasswordInfoAccount'] +--- + + +# PasswordInfoAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | Pointer to **String** | Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [optional] +**AccountName** | Pointer to **String** | Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008 | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordInfoAccount = Initialize-PSSailpoint.V3PasswordInfoAccount -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` + -AccountName Abby.Smith +``` + +- Convert the resource to JSON +```powershell +$PasswordInfoAccount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordInfoQueryDTO.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordInfoQueryDTO.md new file mode 100644 index 000000000..0d5257f53 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordInfoQueryDTO.md @@ -0,0 +1,37 @@ +--- +id: password-info-query-dto +title: PasswordInfoQueryDTO +pagination_label: PasswordInfoQueryDTO +sidebar_label: PasswordInfoQueryDTO +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordInfoQueryDTO', 'PasswordInfoQueryDTO'] +slug: /tools/sdk/powershell/v3/models/password-info-query-dto +tags: ['SDK', 'Software Development Kit', 'PasswordInfoQueryDTO', 'PasswordInfoQueryDTO'] +--- + + +# PasswordInfoQueryDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserName** | Pointer to **String** | The login name of the user | [optional] +**SourceName** | Pointer to **String** | The display name of the source | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordInfoQueryDTO = Initialize-PSSailpoint.V3PasswordInfoQueryDTO -UserName Abby.Smith ` + -SourceName My-AD +``` + +- Convert the resource to JSON +```powershell +$PasswordInfoQueryDTO | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordOrgConfig.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordOrgConfig.md new file mode 100644 index 000000000..5ebe87233 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordOrgConfig.md @@ -0,0 +1,41 @@ +--- +id: password-org-config +title: PasswordOrgConfig +pagination_label: PasswordOrgConfig +sidebar_label: PasswordOrgConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordOrgConfig', 'PasswordOrgConfig'] +slug: /tools/sdk/powershell/v3/models/password-org-config +tags: ['SDK', 'Software Development Kit', 'PasswordOrgConfig', 'PasswordOrgConfig'] +--- + + +# PasswordOrgConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CustomInstructionsEnabled** | Pointer to **Boolean** | Indicator whether custom password instructions feature is enabled. The default value is false. | [optional] [default to $false] +**DigitTokenEnabled** | Pointer to **Boolean** | Indicator whether ""digit token"" feature is enabled. The default value is false. | [optional] [default to $false] +**DigitTokenDurationMinutes** | Pointer to **Int32** | The duration of ""digit token"" in minutes. The default value is 5. | [optional] [default to 5] +**DigitTokenLength** | Pointer to **Int32** | The length of ""digit token"". The default value is 6. | [optional] [default to 6] + +## Examples + +- Prepare the resource +```powershell +$PasswordOrgConfig = Initialize-PSSailpoint.V3PasswordOrgConfig -CustomInstructionsEnabled true ` + -DigitTokenEnabled true ` + -DigitTokenDurationMinutes 10 ` + -DigitTokenLength 9 +``` + +- Convert the resource to JSON +```powershell +$PasswordOrgConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordPolicyV3Dto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordPolicyV3Dto.md new file mode 100644 index 000000000..1dba5cd95 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordPolicyV3Dto.md @@ -0,0 +1,95 @@ +--- +id: password-policy-v3-dto +title: PasswordPolicyV3Dto +pagination_label: PasswordPolicyV3Dto +sidebar_label: PasswordPolicyV3Dto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordPolicyV3Dto', 'PasswordPolicyV3Dto'] +slug: /tools/sdk/powershell/v3/models/password-policy-v3-dto +tags: ['SDK', 'Software Development Kit', 'PasswordPolicyV3Dto', 'PasswordPolicyV3Dto'] +--- + + +# PasswordPolicyV3Dto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The password policy Id. | [optional] +**Description** | Pointer to **String** | Description for current password policy. | [optional] +**Name** | Pointer to **String** | The name of the password policy. | [optional] +**DateCreated** | Pointer to **System.DateTime** | Date the Password Policy was created. | [optional] +**LastUpdated** | Pointer to **System.DateTime** | Date the Password Policy was updated. | [optional] +**FirstExpirationReminder** | Pointer to **Int64** | The number of days before expiration remaninder. | [optional] +**AccountIdMinWordLength** | Pointer to **Int64** | The minimun length of account Id. By default is equals to -1. | [optional] +**AccountNameMinWordLength** | Pointer to **Int64** | The minimun length of account name. By default is equals to -1. | [optional] +**MinAlpha** | Pointer to **Int64** | Maximum alpha. By default is equals to 0. | [optional] +**MinCharacterTypes** | Pointer to **Int64** | MinCharacterTypes. By default is equals to -1. | [optional] +**MaxLength** | Pointer to **Int64** | Maximum length of the password. | [optional] +**MinLength** | Pointer to **Int64** | Minimum length of the password. By default is equals to 0. | [optional] +**MaxRepeatedChars** | Pointer to **Int64** | Maximum repetition of the same character in the password. By default is equals to -1. | [optional] +**MinLower** | Pointer to **Int64** | Minimum amount of lower case character in the password. By default is equals to 0. | [optional] +**MinNumeric** | Pointer to **Int64** | Minimum amount of numeric characters in the password. By default is equals to 0. | [optional] +**MinSpecial** | Pointer to **Int64** | Minimum amount of special symbols in the password. By default is equals to 0. | [optional] +**MinUpper** | Pointer to **Int64** | Minimum amount of upper case symbols in the password. By default is equals to 0. | [optional] +**PasswordExpiration** | Pointer to **Int64** | Number of days before current password expires. By default is equals to 90. | [optional] +**DefaultPolicy** | Pointer to **Boolean** | Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default. | [optional] [default to $false] +**EnablePasswdExpiration** | Pointer to **Boolean** | Defines whether this policy is enabled to expire or not. This field is false by default. | [optional] [default to $false] +**RequireStrongAuthn** | Pointer to **Boolean** | Defines whether this policy require strong Auth or not. This field is false by default. | [optional] [default to $false] +**RequireStrongAuthOffNetwork** | Pointer to **Boolean** | Defines whether this policy require strong Auth of network or not. This field is false by default. | [optional] [default to $false] +**RequireStrongAuthUntrustedGeographies** | Pointer to **Boolean** | Defines whether this policy require strong Auth for untrusted geographies. This field is false by default. | [optional] [default to $false] +**UseAccountAttributes** | Pointer to **Boolean** | Defines whether this policy uses account attributes or not. This field is false by default. | [optional] [default to $false] +**UseDictionary** | Pointer to **Boolean** | Defines whether this policy uses dictionary or not. This field is false by default. | [optional] [default to $false] +**UseIdentityAttributes** | Pointer to **Boolean** | Defines whether this policy uses identity attributes or not. This field is false by default. | [optional] [default to $false] +**ValidateAgainstAccountId** | Pointer to **Boolean** | Defines whether this policy validate against account id or not. This field is false by default. | [optional] [default to $false] +**ValidateAgainstAccountName** | Pointer to **Boolean** | Defines whether this policy validate against account name or not. This field is false by default. | [optional] [default to $false] +**Created** | Pointer to **String** | | [optional] +**Modified** | Pointer to **String** | | [optional] +**SourceIds** | Pointer to **[]String** | List of sources IDs managed by this password policy. | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordPolicyV3Dto = Initialize-PSSailpoint.V3PasswordPolicyV3Dto -Id 2c91808e7d976f3b017d9f5ceae440c8 ` + -Description Information about the Password Policy ` + -Name PasswordPolicy Example ` + -DateCreated null ` + -LastUpdated null ` + -FirstExpirationReminder 45 ` + -AccountIdMinWordLength 4 ` + -AccountNameMinWordLength 6 ` + -MinAlpha 5 ` + -MinCharacterTypes 5 ` + -MaxLength 25 ` + -MinLength 8 ` + -MaxRepeatedChars 3 ` + -MinLower 8 ` + -MinNumeric 8 ` + -MinSpecial 8 ` + -MinUpper 8 ` + -PasswordExpiration 8 ` + -DefaultPolicy true ` + -EnablePasswdExpiration true ` + -RequireStrongAuthn true ` + -RequireStrongAuthOffNetwork true ` + -RequireStrongAuthUntrustedGeographies true ` + -UseAccountAttributes false ` + -UseDictionary false ` + -UseIdentityAttributes false ` + -ValidateAgainstAccountId false ` + -ValidateAgainstAccountName true ` + -Created null ` + -Modified null ` + -SourceIds [2c91808382ffee0b01830de154f14034, 2f98808382ffee0b01830de154f12134] +``` + +- Convert the resource to JSON +```powershell +$PasswordPolicyV3Dto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordStatus.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordStatus.md new file mode 100644 index 000000000..86261194c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordStatus.md @@ -0,0 +1,41 @@ +--- +id: password-status +title: PasswordStatus +pagination_label: PasswordStatus +sidebar_label: PasswordStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordStatus', 'PasswordStatus'] +slug: /tools/sdk/powershell/v3/models/password-status +tags: ['SDK', 'Software Development Kit', 'PasswordStatus', 'PasswordStatus'] +--- + + +# PasswordStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | Pointer to **String** | The password change request ID | [optional] +**State** | Pointer to **Enum** [ "IN_PROGRESS", "FINISHED", "FAILED" ] | Password change state | [optional] +**Errors** | Pointer to **[]String** | The errors during the password change request | [optional] +**SourceIds** | Pointer to **[]String** | List of source IDs in the password change request | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordStatus = Initialize-PSSailpoint.V3PasswordStatus -RequestId 089899f13a8f4da7824996191587bab9 ` + -State IN_PROGRESS ` + -Errors [The password change payload is invalid] ` + -SourceIds [2c918083746f642c01746f990884012a] +``` + +- Convert the resource to JSON +```powershell +$PasswordStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordSyncGroup.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordSyncGroup.md new file mode 100644 index 000000000..6f3c4025d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PasswordSyncGroup.md @@ -0,0 +1,45 @@ +--- +id: password-sync-group +title: PasswordSyncGroup +pagination_label: PasswordSyncGroup +sidebar_label: PasswordSyncGroup +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordSyncGroup', 'PasswordSyncGroup'] +slug: /tools/sdk/powershell/v3/models/password-sync-group +tags: ['SDK', 'Software Development Kit', 'PasswordSyncGroup', 'PasswordSyncGroup'] +--- + + +# PasswordSyncGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the sync group | [optional] +**Name** | Pointer to **String** | Name of the sync group | [optional] +**PasswordPolicyId** | Pointer to **String** | ID of the password policy | [optional] +**SourceIds** | Pointer to **[]String** | List of password managed sources IDs | [optional] +**Created** | Pointer to **System.DateTime** | The date and time this sync group was created | [optional] +**Modified** | Pointer to **System.DateTime** | The date and time this sync group was last modified | [optional] + +## Examples + +- Prepare the resource +```powershell +$PasswordSyncGroup = Initialize-PSSailpoint.V3PasswordSyncGroup -Id 6881f631-3bd5-4213-9c75-8e05cc3e35dd ` + -Name Password Sync Group 1 ` + -PasswordPolicyId 2c91808d744ba0ce01746f93b6204501 ` + -SourceIds [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500] ` + -Created 2023-03-16T04:00Z ` + -Modified 2023-03-16T04:00Z +``` + +- Convert the resource to JSON +```powershell +$PasswordSyncGroup | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/PatOwner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PatOwner.md new file mode 100644 index 000000000..a0a75472e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PatOwner.md @@ -0,0 +1,39 @@ +--- +id: pat-owner +title: PatOwner +pagination_label: PatOwner +sidebar_label: PatOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PatOwner', 'PatOwner'] +slug: /tools/sdk/powershell/v3/models/pat-owner +tags: ['SDK', 'Software Development Kit', 'PatOwner', 'PatOwner'] +--- + + +# PatOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Personal access token owner's DTO type. | [optional] +**Id** | Pointer to **String** | Personal access token owner's identity ID. | [optional] +**Name** | Pointer to **String** | Personal access token owner's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$PatOwner = Initialize-PSSailpoint.V3PatOwner -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Support +``` + +- Convert the resource to JSON +```powershell +$PatOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/PatchServiceDeskIntegrationRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PatchServiceDeskIntegrationRequest.md new file mode 100644 index 000000000..2c55e5419 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PatchServiceDeskIntegrationRequest.md @@ -0,0 +1,35 @@ +--- +id: patch-service-desk-integration-request +title: PatchServiceDeskIntegrationRequest +pagination_label: PatchServiceDeskIntegrationRequest +sidebar_label: PatchServiceDeskIntegrationRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PatchServiceDeskIntegrationRequest', 'PatchServiceDeskIntegrationRequest'] +slug: /tools/sdk/powershell/v3/models/patch-service-desk-integration-request +tags: ['SDK', 'Software Development Kit', 'PatchServiceDeskIntegrationRequest', 'PatchServiceDeskIntegrationRequest'] +--- + + +# PatchServiceDeskIntegrationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operations** | Pointer to [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] + +## Examples + +- Prepare the resource +```powershell +$PatchServiceDeskIntegrationRequest = Initialize-PSSailpoint.V3PatchServiceDeskIntegrationRequest -Operations null +``` + +- Convert the resource to JSON +```powershell +$PatchServiceDeskIntegrationRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/PendingApproval.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PendingApproval.md new file mode 100644 index 000000000..68f417410 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PendingApproval.md @@ -0,0 +1,71 @@ +--- +id: pending-approval +title: PendingApproval +pagination_label: PendingApproval +sidebar_label: PendingApproval +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PendingApproval', 'PendingApproval'] +slug: /tools/sdk/powershell/v3/models/pending-approval +tags: ['SDK', 'Software Development Kit', 'PendingApproval', 'PendingApproval'] +--- + + +# PendingApproval + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The approval id. | [optional] +**Name** | Pointer to **String** | The name of the approval. | [optional] +**Created** | Pointer to **System.DateTime** | When the approval was created. | [optional] +**Modified** | Pointer to **System.DateTime** | When the approval was modified last time. | [optional] +**RequestCreated** | Pointer to **System.DateTime** | When the access-request was created. | [optional] +**RequestType** | Pointer to [**AccessRequestType**](access-request-type) | | [optional] +**Requester** | Pointer to [**AccessItemRequester**](access-item-requester) | | [optional] +**RequestedFor** | Pointer to [**[]AccessItemRequestedFor**](access-item-requested-for) | Identities access was requested for. | [optional] +**Owner** | Pointer to [**PendingApprovalOwner**](pending-approval-owner) | | [optional] +**RequestedObject** | Pointer to [**RequestableObjectReference**](requestable-object-reference) | | [optional] +**RequesterComment** | Pointer to [**CommentDto**](comment-dto) | | [optional] +**PreviousReviewersComments** | Pointer to [**[]CommentDto**](comment-dto) | The history of the previous reviewers comments. | [optional] +**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] +**CommentRequiredWhenRejected** | Pointer to **Boolean** | When true the rejector has to provide comments when rejecting | [optional] [default to $false] +**ActionInProcess** | Pointer to [**PendingApprovalAction**](pending-approval-action) | | [optional] +**RemoveDate** | Pointer to **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] +**RemoveDateUpdateRequested** | Pointer to **Boolean** | If true, then the request is to change the remove date or sunset date. | [optional] [default to $false] +**CurrentRemoveDate** | Pointer to **System.DateTime** | The remove date or sunset date that was assigned at the time of the request. | [optional] +**SodViolationContext** | Pointer to [**SodViolationContextCheckCompleted**](sod-violation-context-check-completed) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PendingApproval = Initialize-PSSailpoint.V3PendingApproval -Id id12345 ` + -Name aName ` + -Created 2017-07-11T18:45:37.098Z ` + -Modified 2018-07-25T20:22:28.104Z ` + -RequestCreated 2017-07-11T18:45:35.098Z ` + -RequestType null ` + -Requester null ` + -RequestedFor null ` + -Owner null ` + -RequestedObject null ` + -RequesterComment null ` + -PreviousReviewersComments null ` + -ForwardHistory null ` + -CommentRequiredWhenRejected true ` + -ActionInProcess null ` + -RemoveDate 2020-07-11T00:00Z ` + -RemoveDateUpdateRequested true ` + -CurrentRemoveDate 2020-07-11T00:00Z ` + -SodViolationContext null +``` + +- Convert the resource to JSON +```powershell +$PendingApproval | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/PendingApprovalAction.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PendingApprovalAction.md new file mode 100644 index 000000000..4e43924b7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PendingApprovalAction.md @@ -0,0 +1,26 @@ +--- +id: pending-approval-action +title: PendingApprovalAction +pagination_label: PendingApprovalAction +sidebar_label: PendingApprovalAction +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PendingApprovalAction', 'PendingApprovalAction'] +slug: /tools/sdk/powershell/v3/models/pending-approval-action +tags: ['SDK', 'Software Development Kit', 'PendingApprovalAction', 'PendingApprovalAction'] +--- + + +# PendingApprovalAction + +## Enum + + +* `APPROVED` (value: `"APPROVED"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `FORWARDED` (value: `"FORWARDED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/PendingApprovalOwner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PendingApprovalOwner.md new file mode 100644 index 000000000..e22566e78 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PendingApprovalOwner.md @@ -0,0 +1,39 @@ +--- +id: pending-approval-owner +title: PendingApprovalOwner +pagination_label: PendingApprovalOwner +sidebar_label: PendingApprovalOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PendingApprovalOwner', 'PendingApprovalOwner'] +slug: /tools/sdk/powershell/v3/models/pending-approval-owner +tags: ['SDK', 'Software Development Kit', 'PendingApprovalOwner', 'PendingApprovalOwner'] +--- + + +# PendingApprovalOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Access item owner's DTO type. | [optional] +**Id** | Pointer to **String** | Access item owner's identity ID. | [optional] +**Name** | Pointer to **String** | Access item owner's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$PendingApprovalOwner = Initialize-PSSailpoint.V3PendingApprovalOwner -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Support +``` + +- Convert the resource to JSON +```powershell +$PendingApprovalOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/PermissionDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PermissionDto.md new file mode 100644 index 000000000..4cacd1358 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PermissionDto.md @@ -0,0 +1,37 @@ +--- +id: permission-dto +title: PermissionDto +pagination_label: PermissionDto +sidebar_label: PermissionDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PermissionDto', 'PermissionDto'] +slug: /tools/sdk/powershell/v3/models/permission-dto +tags: ['SDK', 'Software Development Kit', 'PermissionDto', 'PermissionDto'] +--- + + +# PermissionDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Rights** | Pointer to **[]String** | All the rights (e.g. actions) that this permission allows on the target | [optional] [readonly] +**Target** | Pointer to **String** | The target the permission would grants rights on. | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$PermissionDto = Initialize-PSSailpoint.V3PermissionDto -Rights null ` + -Target SYS.GV_$TRANSACTION +``` + +- Convert the resource to JSON +```powershell +$PermissionDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/PreApprovalTriggerDetails.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PreApprovalTriggerDetails.md new file mode 100644 index 000000000..d8b34c852 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PreApprovalTriggerDetails.md @@ -0,0 +1,39 @@ +--- +id: pre-approval-trigger-details +title: PreApprovalTriggerDetails +pagination_label: PreApprovalTriggerDetails +sidebar_label: PreApprovalTriggerDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PreApprovalTriggerDetails', 'PreApprovalTriggerDetails'] +slug: /tools/sdk/powershell/v3/models/pre-approval-trigger-details +tags: ['SDK', 'Software Development Kit', 'PreApprovalTriggerDetails', 'PreApprovalTriggerDetails'] +--- + + +# PreApprovalTriggerDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment left for the pre-approval decision | [optional] +**Reviewer** | Pointer to **String** | The reviewer of the pre-approval decision | [optional] +**Decision** | Pointer to **Enum** [ "APPROVED", "REJECTED" ] | The decision of the pre-approval trigger | [optional] + +## Examples + +- Prepare the resource +```powershell +$PreApprovalTriggerDetails = Initialize-PSSailpoint.V3PreApprovalTriggerDetails -Comment Access is Approved ` + -Reviewer John Doe ` + -Decision APPROVED +``` + +- Convert the resource to JSON +```powershell +$PreApprovalTriggerDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProcessingDetails.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProcessingDetails.md new file mode 100644 index 000000000..e8dada968 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProcessingDetails.md @@ -0,0 +1,43 @@ +--- +id: processing-details +title: ProcessingDetails +pagination_label: ProcessingDetails +sidebar_label: ProcessingDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProcessingDetails', 'ProcessingDetails'] +slug: /tools/sdk/powershell/v3/models/processing-details +tags: ['SDK', 'Software Development Kit', 'ProcessingDetails', 'ProcessingDetails'] +--- + + +# ProcessingDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Date** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] +**Stage** | Pointer to **String** | | [optional] +**RetryCount** | Pointer to **Int32** | | [optional] +**VarStackTrace** | Pointer to **String** | | [optional] +**Message** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProcessingDetails = Initialize-PSSailpoint.V3ProcessingDetails -Date 2018-06-25T20:22:28.104Z ` + -Stage In Process ` + -RetryCount 0 ` + -VarStackTrace <stack trace> ` + -Message <message> +``` + +- Convert the resource to JSON +```powershell +$ProcessingDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningConfig.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningConfig.md new file mode 100644 index 000000000..1b0f5aabc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningConfig.md @@ -0,0 +1,43 @@ +--- +id: provisioning-config +title: ProvisioningConfig +pagination_label: ProvisioningConfig +sidebar_label: ProvisioningConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningConfig', 'ProvisioningConfig'] +slug: /tools/sdk/powershell/v3/models/provisioning-config +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfig', 'ProvisioningConfig'] +--- + + +# ProvisioningConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UniversalManager** | Pointer to **Boolean** | Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. | [optional] [readonly] [default to $false] +**ManagedResourceRefs** | Pointer to [**[]ServiceDeskSource**](service-desk-source) | References to sources for the Service Desk integration template. May only be specified if universalManager is false. | [optional] +**PlanInitializerScript** | Pointer to [**ProvisioningConfigPlanInitializerScript**](provisioning-config-plan-initializer-script) | | [optional] +**NoProvisioningRequests** | Pointer to **Boolean** | Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. | [optional] [default to $false] +**ProvisioningRequestExpiration** | Pointer to **Int32** | When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningConfig = Initialize-PSSailpoint.V3ProvisioningConfig -UniversalManager true ` + -ManagedResourceRefs [{type=SOURCE, id=2c9180855d191c59015d291ceb051111, name=My Source 1}, {type=SOURCE, id=2c9180855d191c59015d291ceb052222, name=My Source 2}] ` + -PlanInitializerScript null ` + -NoProvisioningRequests true ` + -ProvisioningRequestExpiration 7 +``` + +- Convert the resource to JSON +```powershell +$ProvisioningConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningConfigPlanInitializerScript.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningConfigPlanInitializerScript.md new file mode 100644 index 000000000..795a492b1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningConfigPlanInitializerScript.md @@ -0,0 +1,36 @@ +--- +id: provisioning-config-plan-initializer-script +title: ProvisioningConfigPlanInitializerScript +pagination_label: ProvisioningConfigPlanInitializerScript +sidebar_label: ProvisioningConfigPlanInitializerScript +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningConfigPlanInitializerScript', 'ProvisioningConfigPlanInitializerScript'] +slug: /tools/sdk/powershell/v3/models/provisioning-config-plan-initializer-script +tags: ['SDK', 'Software Development Kit', 'ProvisioningConfigPlanInitializerScript', 'ProvisioningConfigPlanInitializerScript'] +--- + + +# ProvisioningConfigPlanInitializerScript + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Source** | Pointer to **String** | This is a Rule that allows provisioning instruction changes. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningConfigPlanInitializerScript = Initialize-PSSailpoint.V3ProvisioningConfigPlanInitializerScript -Source <?xml version='1.0' encoding='UTF-8'?>\r\n<!DOCTYPE Rule PUBLIC \"sailpoint.dtd\" \"sailpoint.dtd\">\r\n<Rule name=\"Example Rule\" type=\"BeforeProvisioning\">\r\n <Description>Before Provisioning Rule which changes disables and enables to a modify.</Description>\r\n <Source><![CDATA[\r\nimport sailpoint.object.*;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest.Operation;\r\nimport sailpoint.object.ProvisioningPlan.AttributeRequest;\r\nimport sailpoint.object.ProvisioningPlan;\r\nimport sailpoint.object.ProvisioningPlan.Operation;\r\n\r\nfor ( AccountRequest accountRequest : plan.getAccountRequests() ) {\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Disable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Enable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n}\r\n\r\n ]]></Source> + +``` + +- Convert the resource to JSON +```powershell +$ProvisioningConfigPlanInitializerScript | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningCriteriaLevel1.md new file mode 100644 index 000000000..49ae87a73 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningCriteriaLevel1.md @@ -0,0 +1,41 @@ +--- +id: provisioning-criteria-level1 +title: ProvisioningCriteriaLevel1 +pagination_label: ProvisioningCriteriaLevel1 +sidebar_label: ProvisioningCriteriaLevel1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCriteriaLevel1', 'ProvisioningCriteriaLevel1'] +slug: /tools/sdk/powershell/v3/models/provisioning-criteria-level1 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'ProvisioningCriteriaLevel1'] +--- + + +# ProvisioningCriteriaLevel1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**Attribute** | Pointer to **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] +**Value** | Pointer to **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] +**Children** | Pointer to [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningCriteriaLevel1 = Initialize-PSSailpoint.V3ProvisioningCriteriaLevel1 -Operation null ` + -Attribute email ` + -Value carlee.cert1c9f9b6fd@mailinator.com ` + -Children null +``` + +- Convert the resource to JSON +```powershell +$ProvisioningCriteriaLevel1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningCriteriaLevel2.md new file mode 100644 index 000000000..5fcf1d73f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningCriteriaLevel2.md @@ -0,0 +1,41 @@ +--- +id: provisioning-criteria-level2 +title: ProvisioningCriteriaLevel2 +pagination_label: ProvisioningCriteriaLevel2 +sidebar_label: ProvisioningCriteriaLevel2 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCriteriaLevel2', 'ProvisioningCriteriaLevel2'] +slug: /tools/sdk/powershell/v3/models/provisioning-criteria-level2 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'ProvisioningCriteriaLevel2'] +--- + + +# ProvisioningCriteriaLevel2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**Attribute** | Pointer to **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] +**Value** | Pointer to **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] +**Children** | Pointer to [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningCriteriaLevel2 = Initialize-PSSailpoint.V3ProvisioningCriteriaLevel2 -Operation null ` + -Attribute email ` + -Value carlee.cert1c9f9b6fd@mailinator.com ` + -Children null +``` + +- Convert the resource to JSON +```powershell +$ProvisioningCriteriaLevel2 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningCriteriaLevel3.md new file mode 100644 index 000000000..e262482ca --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningCriteriaLevel3.md @@ -0,0 +1,41 @@ +--- +id: provisioning-criteria-level3 +title: ProvisioningCriteriaLevel3 +pagination_label: ProvisioningCriteriaLevel3 +sidebar_label: ProvisioningCriteriaLevel3 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCriteriaLevel3', 'ProvisioningCriteriaLevel3'] +slug: /tools/sdk/powershell/v3/models/provisioning-criteria-level3 +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'ProvisioningCriteriaLevel3'] +--- + + +# ProvisioningCriteriaLevel3 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] +**Attribute** | Pointer to **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] +**Value** | Pointer to **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] +**Children** | Pointer to **String** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningCriteriaLevel3 = Initialize-PSSailpoint.V3ProvisioningCriteriaLevel3 -Operation null ` + -Attribute email ` + -Value carlee.cert1c9f9b6fd@mailinator.com ` + -Children null +``` + +- Convert the resource to JSON +```powershell +$ProvisioningCriteriaLevel3 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningCriteriaOperation.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningCriteriaOperation.md new file mode 100644 index 000000000..49845384a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningCriteriaOperation.md @@ -0,0 +1,32 @@ +--- +id: provisioning-criteria-operation +title: ProvisioningCriteriaOperation +pagination_label: ProvisioningCriteriaOperation +sidebar_label: ProvisioningCriteriaOperation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCriteriaOperation', 'ProvisioningCriteriaOperation'] +slug: /tools/sdk/powershell/v3/models/provisioning-criteria-operation +tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaOperation', 'ProvisioningCriteriaOperation'] +--- + + +# ProvisioningCriteriaOperation + +## Enum + + +* `EQUALS` (value: `"EQUALS"`) + +* `NOT_EQUALS` (value: `"NOT_EQUALS"`) + +* `CONTAINS` (value: `"CONTAINS"`) + +* `HAS` (value: `"HAS"`) + +* `AND` (value: `"AND"`) + +* `OR` (value: `"OR"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningDetails.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningDetails.md new file mode 100644 index 000000000..05914a062 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningDetails.md @@ -0,0 +1,35 @@ +--- +id: provisioning-details +title: ProvisioningDetails +pagination_label: ProvisioningDetails +sidebar_label: ProvisioningDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningDetails', 'ProvisioningDetails'] +slug: /tools/sdk/powershell/v3/models/provisioning-details +tags: ['SDK', 'Software Development Kit', 'ProvisioningDetails', 'ProvisioningDetails'] +--- + + +# ProvisioningDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OrderedSubPhaseReferences** | Pointer to **String** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain ""manualWorkItemDetails"" which indicate that there is further information in that object for this phase. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningDetails = Initialize-PSSailpoint.V3ProvisioningDetails -OrderedSubPhaseReferences manualWorkItemDetails +``` + +- Convert the resource to JSON +```powershell +$ProvisioningDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningPolicy.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningPolicy.md new file mode 100644 index 000000000..3c089b2ec --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningPolicy.md @@ -0,0 +1,41 @@ +--- +id: provisioning-policy +title: ProvisioningPolicy +pagination_label: ProvisioningPolicy +sidebar_label: ProvisioningPolicy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningPolicy', 'ProvisioningPolicy'] +slug: /tools/sdk/powershell/v3/models/provisioning-policy +tags: ['SDK', 'Software Development Kit', 'ProvisioningPolicy', 'ProvisioningPolicy'] +--- + + +# ProvisioningPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | the provisioning policy name | [required] +**Description** | Pointer to **String** | the description of the provisioning policy | [optional] +**UsageType** | Pointer to [**UsageType**](usage-type) | | [optional] +**Fields** | Pointer to [**[]FieldDetailsDto**](field-details-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningPolicy = Initialize-PSSailpoint.V3ProvisioningPolicy -Name example provisioning policy for inactive identities ` + -Description this provisioning policy creates access based on an identity going inactive ` + -UsageType null ` + -Fields null +``` + +- Convert the resource to JSON +```powershell +$ProvisioningPolicy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningPolicyDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningPolicyDto.md new file mode 100644 index 000000000..028e978d6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningPolicyDto.md @@ -0,0 +1,41 @@ +--- +id: provisioning-policy-dto +title: ProvisioningPolicyDto +pagination_label: ProvisioningPolicyDto +sidebar_label: ProvisioningPolicyDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningPolicyDto', 'ProvisioningPolicyDto'] +slug: /tools/sdk/powershell/v3/models/provisioning-policy-dto +tags: ['SDK', 'Software Development Kit', 'ProvisioningPolicyDto', 'ProvisioningPolicyDto'] +--- + + +# ProvisioningPolicyDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | the provisioning policy name | [required] +**Description** | Pointer to **String** | the description of the provisioning policy | [optional] +**UsageType** | Pointer to [**UsageType**](usage-type) | | [optional] +**Fields** | Pointer to [**[]FieldDetailsDto**](field-details-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ProvisioningPolicyDto = Initialize-PSSailpoint.V3ProvisioningPolicyDto -Name example provisioning policy for inactive identities ` + -Description this provisioning policy creates access based on an identity going inactive ` + -UsageType null ` + -Fields null +``` + +- Convert the resource to JSON +```powershell +$ProvisioningPolicyDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningState.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningState.md new file mode 100644 index 000000000..0b0806f94 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ProvisioningState.md @@ -0,0 +1,32 @@ +--- +id: provisioning-state +title: ProvisioningState +pagination_label: ProvisioningState +sidebar_label: ProvisioningState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningState', 'ProvisioningState'] +slug: /tools/sdk/powershell/v3/models/provisioning-state +tags: ['SDK', 'Software Development Kit', 'ProvisioningState', 'ProvisioningState'] +--- + + +# ProvisioningState + +## Enum + + +* `PENDING` (value: `"PENDING"`) + +* `FINISHED` (value: `"FINISHED"`) + +* `UNVERIFIABLE` (value: `"UNVERIFIABLE"`) + +* `COMMITED` (value: `"COMMITED"`) + +* `FAILED` (value: `"FAILED"`) + +* `RETRY` (value: `"RETRY"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/PublicIdentity.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PublicIdentity.md new file mode 100644 index 000000000..6fb1d49e7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PublicIdentity.md @@ -0,0 +1,49 @@ +--- +id: public-identity +title: PublicIdentity +pagination_label: PublicIdentity +sidebar_label: PublicIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PublicIdentity', 'PublicIdentity'] +slug: /tools/sdk/powershell/v3/models/public-identity +tags: ['SDK', 'Software Development Kit', 'PublicIdentity', 'PublicIdentity'] +--- + + +# PublicIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Identity id | [optional] +**Name** | Pointer to **String** | Human-readable display name of identity. | [optional] +**Alias** | Pointer to **String** | Alternate unique identifier for the identity. | [optional] +**Email** | Pointer to **String** | Email address of identity. | [optional] +**Status** | Pointer to **String** | The lifecycle status for the identity | [optional] +**IdentityState** | Pointer to **Enum** [ "ACTIVE", "INACTIVE_SHORT_TERM", "INACTIVE_LONG_TERM" ] | The current state of the identity, which determines how Identity Security Cloud interacts with the identity. An identity that is Active will be included identity picklists in Request Center, identity processing, and more. Identities that are Inactive will be excluded from these features. | [optional] +**Manager** | Pointer to [**IdentityReference**](identity-reference) | | [optional] +**Attributes** | Pointer to [**[]PublicIdentityAttributesInner**](public-identity-attributes-inner) | The public identity attributes of the identity | [optional] + +## Examples + +- Prepare the resource +```powershell +$PublicIdentity = Initialize-PSSailpoint.V3PublicIdentity -Id 2c9180857182305e0171993735622948 ` + -Name Alison Ferguso ` + -Alias alison.ferguso ` + -Email alison.ferguso@acme-solar.com ` + -Status Active ` + -IdentityState ACTIVE ` + -Manager null ` + -Attributes null +``` + +- Convert the resource to JSON +```powershell +$PublicIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/PublicIdentityAttributeConfig.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PublicIdentityAttributeConfig.md new file mode 100644 index 000000000..efcac7773 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PublicIdentityAttributeConfig.md @@ -0,0 +1,37 @@ +--- +id: public-identity-attribute-config +title: PublicIdentityAttributeConfig +pagination_label: PublicIdentityAttributeConfig +sidebar_label: PublicIdentityAttributeConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PublicIdentityAttributeConfig', 'PublicIdentityAttributeConfig'] +slug: /tools/sdk/powershell/v3/models/public-identity-attribute-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentityAttributeConfig', 'PublicIdentityAttributeConfig'] +--- + + +# PublicIdentityAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **String** | The attribute key | [optional] +**Name** | Pointer to **String** | The attribute display name | [optional] + +## Examples + +- Prepare the resource +```powershell +$PublicIdentityAttributeConfig = Initialize-PSSailpoint.V3PublicIdentityAttributeConfig -Key country ` + -Name Country +``` + +- Convert the resource to JSON +```powershell +$PublicIdentityAttributeConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/PublicIdentityAttributesInner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PublicIdentityAttributesInner.md new file mode 100644 index 000000000..46c555b59 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PublicIdentityAttributesInner.md @@ -0,0 +1,39 @@ +--- +id: public-identity-attributes-inner +title: PublicIdentityAttributesInner +pagination_label: PublicIdentityAttributesInner +sidebar_label: PublicIdentityAttributesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PublicIdentityAttributesInner', 'PublicIdentityAttributesInner'] +slug: /tools/sdk/powershell/v3/models/public-identity-attributes-inner +tags: ['SDK', 'Software Development Kit', 'PublicIdentityAttributesInner', 'PublicIdentityAttributesInner'] +--- + + +# PublicIdentityAttributesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | Pointer to **String** | The attribute key | [optional] +**Name** | Pointer to **String** | Human-readable display name of the attribute | [optional] +**Value** | Pointer to **String** | The attribute value | [optional] + +## Examples + +- Prepare the resource +```powershell +$PublicIdentityAttributesInner = Initialize-PSSailpoint.V3PublicIdentityAttributesInner -Key country ` + -Name Country ` + -Value US +``` + +- Convert the resource to JSON +```powershell +$PublicIdentityAttributesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/PublicIdentityConfig.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PublicIdentityConfig.md new file mode 100644 index 000000000..ce79f4957 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PublicIdentityConfig.md @@ -0,0 +1,39 @@ +--- +id: public-identity-config +title: PublicIdentityConfig +pagination_label: PublicIdentityConfig +sidebar_label: PublicIdentityConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PublicIdentityConfig', 'PublicIdentityConfig'] +slug: /tools/sdk/powershell/v3/models/public-identity-config +tags: ['SDK', 'Software Development Kit', 'PublicIdentityConfig', 'PublicIdentityConfig'] +--- + + +# PublicIdentityConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Attributes** | Pointer to [**[]PublicIdentityAttributeConfig**](public-identity-attribute-config) | Up to 5 identity attributes that will be available to everyone in the org for all users in the org. | [optional] +**Modified** | Pointer to **System.DateTime** | When this configuration was last modified. | [optional] +**ModifiedBy** | Pointer to [**IdentityReference**](identity-reference) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PublicIdentityConfig = Initialize-PSSailpoint.V3PublicIdentityConfig -Attributes null ` + -Modified 2018-06-25T20:22:28.104Z ` + -ModifiedBy null +``` + +- Convert the resource to JSON +```powershell +$PublicIdentityConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/PutClientLogConfigurationRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PutClientLogConfigurationRequest.md new file mode 100644 index 000000000..9a79236d8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PutClientLogConfigurationRequest.md @@ -0,0 +1,43 @@ +--- +id: put-client-log-configuration-request +title: PutClientLogConfigurationRequest +pagination_label: PutClientLogConfigurationRequest +sidebar_label: PutClientLogConfigurationRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PutClientLogConfigurationRequest', 'PutClientLogConfigurationRequest'] +slug: /tools/sdk/powershell/v3/models/put-client-log-configuration-request +tags: ['SDK', 'Software Development Kit', 'PutClientLogConfigurationRequest', 'PutClientLogConfigurationRequest'] +--- + + +# PutClientLogConfigurationRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ClientId** | Pointer to **String** | Log configuration's client ID | [optional] +**DurationMinutes** | Pointer to **Int32** | Duration in minutes for log configuration to remain in effect before resetting to defaults. | [optional] [default to 240] +**RootLevel** | [**StandardLevel**](standard-level) | | [required] +**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] +**Expiration** | Pointer to **System.DateTime** | Expiration date-time of the log configuration request. Can be no greater than 24 hours from current date-time. | [optional] + +## Examples + +- Prepare the resource +```powershell +$PutClientLogConfigurationRequest = Initialize-PSSailpoint.V3PutClientLogConfigurationRequest -ClientId 3a38a51992e8445ab51a549c0a70ee66 ` + -DurationMinutes 120 ` + -RootLevel null ` + -LogLevels INFO ` + -Expiration 2024-11-06T01:31:08.013164Z +``` + +- Convert the resource to JSON +```powershell +$PutClientLogConfigurationRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/PutConnectorSourceConfigRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PutConnectorSourceConfigRequest.md new file mode 100644 index 000000000..6bbe4079f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PutConnectorSourceConfigRequest.md @@ -0,0 +1,35 @@ +--- +id: put-connector-source-config-request +title: PutConnectorSourceConfigRequest +pagination_label: PutConnectorSourceConfigRequest +sidebar_label: PutConnectorSourceConfigRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PutConnectorSourceConfigRequest', 'PutConnectorSourceConfigRequest'] +slug: /tools/sdk/powershell/v3/models/put-connector-source-config-request +tags: ['SDK', 'Software Development Kit', 'PutConnectorSourceConfigRequest', 'PutConnectorSourceConfigRequest'] +--- + + +# PutConnectorSourceConfigRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | **System.IO.FileInfo** | connector source config xml file | [required] + +## Examples + +- Prepare the resource +```powershell +$PutConnectorSourceConfigRequest = Initialize-PSSailpoint.V3PutConnectorSourceConfigRequest -File null +``` + +- Convert the resource to JSON +```powershell +$PutConnectorSourceConfigRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/PutConnectorSourceTemplateRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PutConnectorSourceTemplateRequest.md new file mode 100644 index 000000000..9e096b77b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PutConnectorSourceTemplateRequest.md @@ -0,0 +1,35 @@ +--- +id: put-connector-source-template-request +title: PutConnectorSourceTemplateRequest +pagination_label: PutConnectorSourceTemplateRequest +sidebar_label: PutConnectorSourceTemplateRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PutConnectorSourceTemplateRequest', 'PutConnectorSourceTemplateRequest'] +slug: /tools/sdk/powershell/v3/models/put-connector-source-template-request +tags: ['SDK', 'Software Development Kit', 'PutConnectorSourceTemplateRequest', 'PutConnectorSourceTemplateRequest'] +--- + + +# PutConnectorSourceTemplateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | **System.IO.FileInfo** | connector source template xml file | [required] + +## Examples + +- Prepare the resource +```powershell +$PutConnectorSourceTemplateRequest = Initialize-PSSailpoint.V3PutConnectorSourceTemplateRequest -File null +``` + +- Convert the resource to JSON +```powershell +$PutConnectorSourceTemplateRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/PutPasswordDictionaryRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PutPasswordDictionaryRequest.md new file mode 100644 index 000000000..fcb940bfe --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/PutPasswordDictionaryRequest.md @@ -0,0 +1,35 @@ +--- +id: put-password-dictionary-request +title: PutPasswordDictionaryRequest +pagination_label: PutPasswordDictionaryRequest +sidebar_label: PutPasswordDictionaryRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'PutPasswordDictionaryRequest', 'PutPasswordDictionaryRequest'] +slug: /tools/sdk/powershell/v3/models/put-password-dictionary-request +tags: ['SDK', 'Software Development Kit', 'PutPasswordDictionaryRequest', 'PutPasswordDictionaryRequest'] +--- + + +# PutPasswordDictionaryRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**File** | Pointer to **System.IO.FileInfo** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$PutPasswordDictionaryRequest = Initialize-PSSailpoint.V3PutPasswordDictionaryRequest -File null +``` + +- Convert the resource to JSON +```powershell +$PutPasswordDictionaryRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Query.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Query.md new file mode 100644 index 000000000..23f60e36d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Query.md @@ -0,0 +1,41 @@ +--- +id: query +title: Query +pagination_label: Query +sidebar_label: Query +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Query', 'Query'] +slug: /tools/sdk/powershell/v3/models/query +tags: ['SDK', 'Software Development Kit', 'Query', 'Query'] +--- + + +# Query + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | Pointer to **String** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [optional] +**Fields** | Pointer to **String** | The fields the query will be applied to. Fields provide you with a simple way to add additional fields to search, without making the query too complicated. For example, you can use the fields to specify that you want your query of ""a*"" to be applied to ""name"", ""firstName"", and the ""source.name"". The response will include all results matching the ""a*"" query found in those three fields. A field's availability depends on the indices being searched. For example, if you are searching ""identities"", you can apply your search to the ""firstName"" field, but you couldn't use ""firstName"" with a search on ""access profiles"". Refer to the response schema for the respective lists of available fields. | [optional] +**TimeZone** | Pointer to **String** | The time zone to be applied to any range query related to dates. | [optional] +**InnerHit** | Pointer to [**InnerHit**](inner-hit) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Query = Initialize-PSSailpoint.V3Query -Query name:a* ` + -Fields [firstName,lastName,email] ` + -TimeZone America/Chicago ` + -InnerHit null +``` + +- Convert the resource to JSON +```powershell +$Query | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/QueryResultFilter.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/QueryResultFilter.md new file mode 100644 index 000000000..3a87e4ded --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/QueryResultFilter.md @@ -0,0 +1,37 @@ +--- +id: query-result-filter +title: QueryResultFilter +pagination_label: QueryResultFilter +sidebar_label: QueryResultFilter +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'QueryResultFilter', 'QueryResultFilter'] +slug: /tools/sdk/powershell/v3/models/query-result-filter +tags: ['SDK', 'Software Development Kit', 'QueryResultFilter', 'QueryResultFilter'] +--- + + +# QueryResultFilter + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Includes** | Pointer to **[]String** | The list of field names to include in the result documents. | [optional] +**Excludes** | Pointer to **[]String** | The list of field names to exclude from the result documents. | [optional] + +## Examples + +- Prepare the resource +```powershell +$QueryResultFilter = Initialize-PSSailpoint.V3QueryResultFilter -Includes [name, displayName] ` + -Excludes [stacktrace] +``` + +- Convert the resource to JSON +```powershell +$QueryResultFilter | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/QueryType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/QueryType.md new file mode 100644 index 000000000..58c5b8266 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/QueryType.md @@ -0,0 +1,28 @@ +--- +id: query-type +title: QueryType +pagination_label: QueryType +sidebar_label: QueryType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'QueryType', 'QueryType'] +slug: /tools/sdk/powershell/v3/models/query-type +tags: ['SDK', 'Software Development Kit', 'QueryType', 'QueryType'] +--- + + +# QueryType + +## Enum + + +* `DSL` (value: `"DSL"`) + +* `SAILPOINT` (value: `"SAILPOINT"`) + +* `TEXT` (value: `"TEXT"`) + +* `TYPEAHEAD` (value: `"TYPEAHEAD"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/QueuedCheckConfigDetails.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/QueuedCheckConfigDetails.md new file mode 100644 index 000000000..21b8d8e36 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/QueuedCheckConfigDetails.md @@ -0,0 +1,37 @@ +--- +id: queued-check-config-details +title: QueuedCheckConfigDetails +pagination_label: QueuedCheckConfigDetails +sidebar_label: QueuedCheckConfigDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'QueuedCheckConfigDetails', 'QueuedCheckConfigDetails'] +slug: /tools/sdk/powershell/v3/models/queued-check-config-details +tags: ['SDK', 'Software Development Kit', 'QueuedCheckConfigDetails', 'QueuedCheckConfigDetails'] +--- + + +# QueuedCheckConfigDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ProvisioningStatusCheckIntervalMinutes** | **String** | Interval in minutes between status checks | [required] +**ProvisioningMaxStatusCheckDays** | **String** | Maximum number of days to check | [required] + +## Examples + +- Prepare the resource +```powershell +$QueuedCheckConfigDetails = Initialize-PSSailpoint.V3QueuedCheckConfigDetails -ProvisioningStatusCheckIntervalMinutes 30 ` + -ProvisioningMaxStatusCheckDays 2 +``` + +- Convert the resource to JSON +```powershell +$QueuedCheckConfigDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RandomAlphaNumeric.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RandomAlphaNumeric.md new file mode 100644 index 000000000..cd9f03369 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RandomAlphaNumeric.md @@ -0,0 +1,39 @@ +--- +id: random-alpha-numeric +title: RandomAlphaNumeric +pagination_label: RandomAlphaNumeric +sidebar_label: RandomAlphaNumeric +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RandomAlphaNumeric', 'RandomAlphaNumeric'] +slug: /tools/sdk/powershell/v3/models/random-alpha-numeric +tags: ['SDK', 'Software Development Kit', 'RandomAlphaNumeric', 'RandomAlphaNumeric'] +--- + + +# RandomAlphaNumeric + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Length** | Pointer to **String** | This is an integer value specifying the size/number of characters the random string must contain * This value must be a positive number and cannot be blank * If no length is provided, the transform will default to a value of `32` * Due to identity attribute data constraints, the maximum allowable value is `450` characters | [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] + +## Examples + +- Prepare the resource +```powershell +$RandomAlphaNumeric = Initialize-PSSailpoint.V3RandomAlphaNumeric -Length 10 ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$RandomAlphaNumeric | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RandomNumeric.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RandomNumeric.md new file mode 100644 index 000000000..f08b7d3fd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RandomNumeric.md @@ -0,0 +1,39 @@ +--- +id: random-numeric +title: RandomNumeric +pagination_label: RandomNumeric +sidebar_label: RandomNumeric +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RandomNumeric', 'RandomNumeric'] +slug: /tools/sdk/powershell/v3/models/random-numeric +tags: ['SDK', 'Software Development Kit', 'RandomNumeric', 'RandomNumeric'] +--- + + +# RandomNumeric + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Length** | Pointer to **String** | This is an integer value specifying the size/number of characters the random string must contain * This value must be a positive number and cannot be blank * If no length is provided, the transform will default to a value of `32` * Due to identity attribute data constraints, the maximum allowable value is `450` characters | [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] + +## Examples + +- Prepare the resource +```powershell +$RandomNumeric = Initialize-PSSailpoint.V3RandomNumeric -Length 10 ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$RandomNumeric | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Range.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Range.md new file mode 100644 index 000000000..77da71016 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Range.md @@ -0,0 +1,37 @@ +--- +id: range +title: Range +pagination_label: Range +sidebar_label: Range +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Range', 'Range'] +slug: /tools/sdk/powershell/v3/models/range +tags: ['SDK', 'Software Development Kit', 'Range', 'Range'] +--- + + +# Range + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Lower** | Pointer to [**Bound**](bound) | | [optional] +**Upper** | Pointer to [**Bound**](bound) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Range = Initialize-PSSailpoint.V3Range -Lower null ` + -Upper null +``` + +- Convert the resource to JSON +```powershell +$Range | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReassignReference.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReassignReference.md new file mode 100644 index 000000000..de1678c8e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReassignReference.md @@ -0,0 +1,37 @@ +--- +id: reassign-reference +title: ReassignReference +pagination_label: ReassignReference +sidebar_label: ReassignReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReassignReference', 'ReassignReference'] +slug: /tools/sdk/powershell/v3/models/reassign-reference +tags: ['SDK', 'Software Development Kit', 'ReassignReference', 'ReassignReference'] +--- + + +# ReassignReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The ID of item or identity being reassigned. | [required] +**Type** | **Enum** [ "TARGET_SUMMARY", "ITEM", "IDENTITY_SUMMARY" ] | The type of item or identity being reassigned. | [required] + +## Examples + +- Prepare the resource +```powershell +$ReassignReference = Initialize-PSSailpoint.V3ReassignReference -Id ef38f94347e94562b5bb8424a56397d8 ` + -Type ITEM +``` + +- Convert the resource to JSON +```powershell +$ReassignReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Reassignment.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Reassignment.md new file mode 100644 index 000000000..4632e1f06 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Reassignment.md @@ -0,0 +1,37 @@ +--- +id: reassignment +title: Reassignment +pagination_label: Reassignment +sidebar_label: Reassignment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Reassignment', 'Reassignment'] +slug: /tools/sdk/powershell/v3/models/reassignment +tags: ['SDK', 'Software Development Kit', 'Reassignment', 'Reassignment'] +--- + + +# Reassignment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarFrom** | Pointer to [**CertificationReference**](certification-reference) | | [optional] +**Comment** | Pointer to **String** | The comment entered when the Certification was reassigned | [optional] + +## Examples + +- Prepare the resource +```powershell +$Reassignment = Initialize-PSSailpoint.V3Reassignment -VarFrom null ` + -Comment Reassigned for a reason +``` + +- Convert the resource to JSON +```powershell +$Reassignment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReassignmentReference.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReassignmentReference.md new file mode 100644 index 000000000..7f45738e2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReassignmentReference.md @@ -0,0 +1,37 @@ +--- +id: reassignment-reference +title: ReassignmentReference +pagination_label: ReassignmentReference +sidebar_label: ReassignmentReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReassignmentReference', 'ReassignmentReference'] +slug: /tools/sdk/powershell/v3/models/reassignment-reference +tags: ['SDK', 'Software Development Kit', 'ReassignmentReference', 'ReassignmentReference'] +--- + + +# ReassignmentReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The ID of item or identity being reassigned. | [required] +**Type** | **Enum** [ "TARGET_SUMMARY", "ITEM", "IDENTITY_SUMMARY" ] | The type of item or identity being reassigned. | [required] + +## Examples + +- Prepare the resource +```powershell +$ReassignmentReference = Initialize-PSSailpoint.V3ReassignmentReference -Id ef38f94347e94562b5bb8424a56397d8 ` + -Type ITEM +``` + +- Convert the resource to JSON +```powershell +$ReassignmentReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReassignmentTrailDTO.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReassignmentTrailDTO.md new file mode 100644 index 000000000..fe47d1026 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReassignmentTrailDTO.md @@ -0,0 +1,39 @@ +--- +id: reassignment-trail-dto +title: ReassignmentTrailDTO +pagination_label: ReassignmentTrailDTO +sidebar_label: ReassignmentTrailDTO +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReassignmentTrailDTO', 'ReassignmentTrailDTO'] +slug: /tools/sdk/powershell/v3/models/reassignment-trail-dto +tags: ['SDK', 'Software Development Kit', 'ReassignmentTrailDTO', 'ReassignmentTrailDTO'] +--- + + +# ReassignmentTrailDTO + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PreviousOwner** | Pointer to **String** | The ID of previous owner identity. | [optional] +**NewOwner** | Pointer to **String** | The ID of new owner identity. | [optional] +**ReassignmentType** | Pointer to **String** | The type of reassignment. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReassignmentTrailDTO = Initialize-PSSailpoint.V3ReassignmentTrailDTO -PreviousOwner ef38f94347e94562b5bb8424a56397d8 ` + -NewOwner ef38f94347e94562b5bb8424a56397a3 ` + -ReassignmentType AUTOMATIC_REASSIGNMENT +``` + +- Convert the resource to JSON +```powershell +$ReassignmentTrailDTO | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReassignmentType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReassignmentType.md new file mode 100644 index 000000000..db040f383 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReassignmentType.md @@ -0,0 +1,28 @@ +--- +id: reassignment-type +title: ReassignmentType +pagination_label: ReassignmentType +sidebar_label: ReassignmentType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReassignmentType', 'ReassignmentType'] +slug: /tools/sdk/powershell/v3/models/reassignment-type +tags: ['SDK', 'Software Development Kit', 'ReassignmentType', 'ReassignmentType'] +--- + + +# ReassignmentType + +## Enum + + +* `MANUAL_REASSIGNMENT` (value: `"MANUAL_REASSIGNMENT"`) + +* `AUTOMATIC_REASSIGNMENT` (value: `"AUTOMATIC_REASSIGNMENT"`) + +* `AUTO_ESCALATION` (value: `"AUTO_ESCALATION"`) + +* `SELF_REVIEW_DELEGATION` (value: `"SELF_REVIEW_DELEGATION"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Recommendation.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Recommendation.md new file mode 100644 index 000000000..5c9d3f66e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Recommendation.md @@ -0,0 +1,37 @@ +--- +id: recommendation +title: Recommendation +pagination_label: Recommendation +sidebar_label: Recommendation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Recommendation', 'Recommendation'] +slug: /tools/sdk/powershell/v3/models/recommendation +tags: ['SDK', 'Software Development Kit', 'Recommendation', 'Recommendation'] +--- + + +# Recommendation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "HUMAN", "MACHINE" ] | Recommended type of account. | [required] +**Method** | **Enum** [ "DISCOVERY", "SOURCE", "CRITERIA" ] | Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. | [required] + +## Examples + +- Prepare the resource +```powershell +$Recommendation = Initialize-PSSailpoint.V3Recommendation -Type MACHINE ` + -Method DISCOVERY +``` + +- Convert the resource to JSON +```powershell +$Recommendation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Reference.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Reference.md new file mode 100644 index 000000000..56469d914 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Reference.md @@ -0,0 +1,39 @@ +--- +id: reference +title: Reference +pagination_label: Reference +sidebar_label: Reference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Reference', 'Reference'] +slug: /tools/sdk/powershell/v3/models/reference +tags: ['SDK', 'Software Development Kit', 'Reference', 'Reference'] +--- + + +# Reference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | This ID specifies the name of the pre-existing transform which you want to use within your current transform | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$Reference = Initialize-PSSailpoint.V3Reference -Id Existing Transform ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Reference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Reference1.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Reference1.md new file mode 100644 index 000000000..8d4471e34 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Reference1.md @@ -0,0 +1,37 @@ +--- +id: reference1 +title: Reference1 +pagination_label: Reference1 +sidebar_label: Reference1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Reference1', 'Reference1'] +slug: /tools/sdk/powershell/v3/models/reference1 +tags: ['SDK', 'Software Development Kit', 'Reference1', 'Reference1'] +--- + + +# Reference1 + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$Reference1 = Initialize-PSSailpoint.V3Reference1 -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe +``` + +- Convert the resource to JSON +```powershell +$Reference1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RemediationItemDetails.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RemediationItemDetails.md new file mode 100644 index 000000000..763a7682e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RemediationItemDetails.md @@ -0,0 +1,51 @@ +--- +id: remediation-item-details +title: RemediationItemDetails +pagination_label: RemediationItemDetails +sidebar_label: RemediationItemDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RemediationItemDetails', 'RemediationItemDetails'] +slug: /tools/sdk/powershell/v3/models/remediation-item-details +tags: ['SDK', 'Software Development Kit', 'RemediationItemDetails', 'RemediationItemDetails'] +--- + + +# RemediationItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of the certification | [optional] +**TargetId** | Pointer to **String** | The ID of the certification target | [optional] +**TargetName** | Pointer to **String** | The name of the certification target | [optional] +**TargetDisplayName** | Pointer to **String** | The display name of the certification target | [optional] +**ApplicationName** | Pointer to **String** | The name of the application/source | [optional] +**AttributeName** | Pointer to **String** | The name of the attribute being certified | [optional] +**AttributeOperation** | Pointer to **String** | The operation of the certification on the attribute | [optional] +**AttributeValue** | Pointer to **String** | The value of the attribute being certified | [optional] +**NativeIdentity** | Pointer to **String** | The native identity of the target | [optional] + +## Examples + +- Prepare the resource +```powershell +$RemediationItemDetails = Initialize-PSSailpoint.V3RemediationItemDetails -Id 2c9180835d2e5168015d32f890ca1581 ` + -TargetId 2c9180835d2e5168015d32f890ca1581 ` + -TargetName john.smith ` + -TargetDisplayName emailAddress ` + -ApplicationName Active Directory ` + -AttributeName phoneNumber ` + -AttributeOperation update ` + -AttributeValue 512-555-1212 ` + -NativeIdentity jason.smith2 +``` + +- Convert the resource to JSON +```powershell +$RemediationItemDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RemediationItems.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RemediationItems.md new file mode 100644 index 000000000..c9532b767 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RemediationItems.md @@ -0,0 +1,51 @@ +--- +id: remediation-items +title: RemediationItems +pagination_label: RemediationItems +sidebar_label: RemediationItems +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RemediationItems', 'RemediationItems'] +slug: /tools/sdk/powershell/v3/models/remediation-items +tags: ['SDK', 'Software Development Kit', 'RemediationItems', 'RemediationItems'] +--- + + +# RemediationItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of the certification | [optional] +**TargetId** | Pointer to **String** | The ID of the certification target | [optional] +**TargetName** | Pointer to **String** | The name of the certification target | [optional] +**TargetDisplayName** | Pointer to **String** | The display name of the certification target | [optional] +**ApplicationName** | Pointer to **String** | The name of the application/source | [optional] +**AttributeName** | Pointer to **String** | The name of the attribute being certified | [optional] +**AttributeOperation** | Pointer to **String** | The operation of the certification on the attribute | [optional] +**AttributeValue** | Pointer to **String** | The value of the attribute being certified | [optional] +**NativeIdentity** | Pointer to **String** | The native identity of the target | [optional] + +## Examples + +- Prepare the resource +```powershell +$RemediationItems = Initialize-PSSailpoint.V3RemediationItems -Id 2c9180835d2e5168015d32f890ca1581 ` + -TargetId 2c9180835d2e5168015d32f890ca1581 ` + -TargetName john.smith ` + -TargetDisplayName emailAddress ` + -ApplicationName Active Directory ` + -AttributeName phoneNumber ` + -AttributeOperation update ` + -AttributeValue 512-555-1212 ` + -NativeIdentity jason.smith2 +``` + +- Convert the resource to JSON +```powershell +$RemediationItems | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Replace.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Replace.md new file mode 100644 index 000000000..2496cd528 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Replace.md @@ -0,0 +1,41 @@ +--- +id: replace +title: Replace +pagination_label: Replace +sidebar_label: Replace +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Replace', 'Replace'] +slug: /tools/sdk/powershell/v3/models/replace +tags: ['SDK', 'Software Development Kit', 'Replace', 'Replace'] +--- + + +# Replace + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Regex** | **String** | This can be a string or a regex pattern in which you want to replace. | [required] +**Replacement** | **String** | This is the replacement string that should be substituded wherever the string or pattern is found. | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$Replace = Initialize-PSSailpoint.V3Replace -Regex [^a-zA-Z] ` + -Replacement ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Replace | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReplaceAll.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReplaceAll.md new file mode 100644 index 000000000..052356947 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReplaceAll.md @@ -0,0 +1,39 @@ +--- +id: replace-all +title: ReplaceAll +pagination_label: ReplaceAll +sidebar_label: ReplaceAll +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReplaceAll', 'ReplaceAll'] +slug: /tools/sdk/powershell/v3/models/replace-all +tags: ['SDK', 'Software Development Kit', 'ReplaceAll', 'ReplaceAll'] +--- + + +# ReplaceAll + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Table** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value. | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$ReplaceAll = Initialize-PSSailpoint.V3ReplaceAll -Table {-= , "=', ñ=n} ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$ReplaceAll | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReportDetails.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReportDetails.md new file mode 100644 index 000000000..a50e9c541 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReportDetails.md @@ -0,0 +1,37 @@ +--- +id: report-details +title: ReportDetails +pagination_label: ReportDetails +sidebar_label: ReportDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReportDetails', 'ReportDetails'] +slug: /tools/sdk/powershell/v3/models/report-details +tags: ['SDK', 'Software Development Kit', 'ReportDetails', 'ReportDetails'] +--- + + +# ReportDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReportType** | Pointer to **Enum** [ "ACCOUNTS", "IDENTITIES_DETAILS", "IDENTITIES", "IDENTITY_PROFILE_IDENTITY_ERROR", "ORPHAN_IDENTITIES", "SEARCH_EXPORT", "UNCORRELATED_ACCOUNTS" ] | Use this property to define what report should be processed in the RDE service. | [optional] +**Arguments** | Pointer to [**ReportDetailsArguments**](report-details-arguments) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReportDetails = Initialize-PSSailpoint.V3ReportDetails -ReportType ACCOUNTS ` + -Arguments null +``` + +- Convert the resource to JSON +```powershell +$ReportDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReportDetailsArguments.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReportDetailsArguments.md new file mode 100644 index 000000000..9790bb86a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReportDetailsArguments.md @@ -0,0 +1,51 @@ +--- +id: report-details-arguments +title: ReportDetailsArguments +pagination_label: ReportDetailsArguments +sidebar_label: ReportDetailsArguments +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReportDetailsArguments', 'ReportDetailsArguments'] +slug: /tools/sdk/powershell/v3/models/report-details-arguments +tags: ['SDK', 'Software Development Kit', 'ReportDetailsArguments', 'ReportDetailsArguments'] +--- + + +# ReportDetailsArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Application** | **String** | Source ID. | [required] +**SourceName** | **String** | Source name. | [required] +**CorrelatedOnly** | **Boolean** | Flag to specify if only correlated identities are included in report. | [required][default to $false] +**AuthoritativeSource** | **String** | Source ID. | [required] +**SelectedFormats** | Pointer to **[]String** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] +**Indices** | Pointer to [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**Query** | **String** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [required] +**Columns** | Pointer to **String** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional] +**Sort** | Pointer to **[]String** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReportDetailsArguments = Initialize-PSSailpoint.V3ReportDetailsArguments -Application 2c9180897eSourceIde781782f705b9 ` + -SourceName Active Directory ` + -CorrelatedOnly true ` + -AuthoritativeSource 1234sourceId5678902 ` + -SelectedFormats [CSV] ` + -Indices [entitlements] ` + -Query name:a* ` + -Columns displayName,firstName,lastName,email,created,attributes.cloudLifecycleState ` + -Sort [displayName, +id] +``` + +- Convert the resource to JSON +```powershell +$ReportDetailsArguments | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReportResultReference.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReportResultReference.md new file mode 100644 index 000000000..c765de5a0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReportResultReference.md @@ -0,0 +1,41 @@ +--- +id: report-result-reference +title: ReportResultReference +pagination_label: ReportResultReference +sidebar_label: ReportResultReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReportResultReference', 'ReportResultReference'] +slug: /tools/sdk/powershell/v3/models/report-result-reference +tags: ['SDK', 'Software Development Kit', 'ReportResultReference', 'ReportResultReference'] +--- + + +# ReportResultReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "REPORT_RESULT" ] | SOD policy violation report result DTO type. | [optional] +**Id** | Pointer to **String** | SOD policy violation report result ID. | [optional] +**Name** | Pointer to **String** | Human-readable name of the SOD policy violation report result. | [optional] +**Status** | Pointer to **Enum** [ "SUCCESS", "WARNING", "ERROR", "TERMINATED", "TEMP_ERROR", "PENDING" ] | Status of a SOD policy violation report. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReportResultReference = Initialize-PSSailpoint.V3ReportResultReference -Type REPORT_RESULT ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name SOD Policy 1 Violation ` + -Status PENDING +``` + +- Convert the resource to JSON +```powershell +$ReportResultReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReportResults.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReportResults.md new file mode 100644 index 000000000..c1ca18891 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReportResults.md @@ -0,0 +1,49 @@ +--- +id: report-results +title: ReportResults +pagination_label: ReportResults +sidebar_label: ReportResults +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReportResults', 'ReportResults'] +slug: /tools/sdk/powershell/v3/models/report-results +tags: ['SDK', 'Software Development Kit', 'ReportResults', 'ReportResults'] +--- + + +# ReportResults + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ReportType** | Pointer to **Enum** [ "ACCOUNTS", "IDENTITIES_DETAILS", "IDENTITIES", "IDENTITY_PROFILE_IDENTITY_ERROR", "ORPHAN_IDENTITIES", "SEARCH_EXPORT", "UNCORRELATED_ACCOUNTS" ] | Use this property to define what report should be processed in the RDE service. | [optional] +**TaskDefName** | Pointer to **String** | Name of the task definition which is started to process requesting report. Usually the same as report name | [optional] +**Id** | Pointer to **String** | Unique task definition identifier. | [optional] +**Created** | Pointer to **System.DateTime** | Report processing start date | [optional] +**Status** | Pointer to **Enum** [ "SUCCESS", "FAILURE", "WARNING", "TERMINATED" ] | Report current state or result status. | [optional] +**Duration** | Pointer to **Int64** | Report processing time in ms. | [optional] +**Rows** | Pointer to **Int64** | Report size in rows. | [optional] +**AvailableFormats** | Pointer to **[]String** | Output report file formats. This are formats for calling get endpoint as a query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReportResults = Initialize-PSSailpoint.V3ReportResults -ReportType IDENTITIES_DETAILS ` + -TaskDefName Identities Details Report ` + -Id a248c16fe22222b2bd49615481311111 ` + -Created null ` + -Status SUCCESS ` + -Duration 342 ` + -Rows 37 ` + -AvailableFormats [CSV] +``` + +- Convert the resource to JSON +```powershell +$ReportResults | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReportType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReportType.md new file mode 100644 index 000000000..31266bb4c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReportType.md @@ -0,0 +1,28 @@ +--- +id: report-type +title: ReportType +pagination_label: ReportType +sidebar_label: ReportType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReportType', 'ReportType'] +slug: /tools/sdk/powershell/v3/models/report-type +tags: ['SDK', 'Software Development Kit', 'ReportType', 'ReportType'] +--- + + +# ReportType + +## Enum + + +* `CAMPAIGN_COMPOSITION_REPORT` (value: `"CAMPAIGN_COMPOSITION_REPORT"`) + +* `CAMPAIGN_REMEDIATION_STATUS_REPORT` (value: `"CAMPAIGN_REMEDIATION_STATUS_REPORT"`) + +* `CAMPAIGN_STATUS_REPORT` (value: `"CAMPAIGN_STATUS_REPORT"`) + +* `CERTIFICATION_SIGNOFF_REPORT` (value: `"CERTIFICATION_SIGNOFF_REPORT"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestOnBehalfOfConfig.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestOnBehalfOfConfig.md new file mode 100644 index 000000000..d1698376a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestOnBehalfOfConfig.md @@ -0,0 +1,37 @@ +--- +id: request-on-behalf-of-config +title: RequestOnBehalfOfConfig +pagination_label: RequestOnBehalfOfConfig +sidebar_label: RequestOnBehalfOfConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestOnBehalfOfConfig', 'RequestOnBehalfOfConfig'] +slug: /tools/sdk/powershell/v3/models/request-on-behalf-of-config +tags: ['SDK', 'Software Development Kit', 'RequestOnBehalfOfConfig', 'RequestOnBehalfOfConfig'] +--- + + +# RequestOnBehalfOfConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AllowRequestOnBehalfOfAnyoneByAnyone** | Pointer to **Boolean** | If this is true, anyone can request access for anyone. | [optional] [default to $false] +**AllowRequestOnBehalfOfEmployeeByManager** | Pointer to **Boolean** | If this is true, a manager can request access for his or her direct reports. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$RequestOnBehalfOfConfig = Initialize-PSSailpoint.V3RequestOnBehalfOfConfig -AllowRequestOnBehalfOfAnyoneByAnyone true ` + -AllowRequestOnBehalfOfEmployeeByManager true +``` + +- Convert the resource to JSON +```powershell +$RequestOnBehalfOfConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Requestability.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Requestability.md new file mode 100644 index 000000000..796d7d5de --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Requestability.md @@ -0,0 +1,39 @@ +--- +id: requestability +title: Requestability +pagination_label: Requestability +sidebar_label: Requestability +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Requestability', 'Requestability'] +slug: /tools/sdk/powershell/v3/models/requestability +tags: ['SDK', 'Software Development Kit', 'Requestability', 'Requestability'] +--- + + +# Requestability + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommentsRequired** | Pointer to **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] +**DenialCommentsRequired** | Pointer to **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] +**ApprovalSchemes** | Pointer to [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] + +## Examples + +- Prepare the resource +```powershell +$Requestability = Initialize-PSSailpoint.V3Requestability -CommentsRequired true ` + -DenialCommentsRequired true ` + -ApprovalSchemes null +``` + +- Convert the resource to JSON +```powershell +$Requestability | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestabilityForRole.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestabilityForRole.md new file mode 100644 index 000000000..ee5deb543 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestabilityForRole.md @@ -0,0 +1,39 @@ +--- +id: requestability-for-role +title: RequestabilityForRole +pagination_label: RequestabilityForRole +sidebar_label: RequestabilityForRole +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestabilityForRole', 'RequestabilityForRole'] +slug: /tools/sdk/powershell/v3/models/requestability-for-role +tags: ['SDK', 'Software Development Kit', 'RequestabilityForRole', 'RequestabilityForRole'] +--- + + +# RequestabilityForRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommentsRequired** | Pointer to **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] +**DenialCommentsRequired** | Pointer to **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] +**ApprovalSchemes** | Pointer to [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestabilityForRole = Initialize-PSSailpoint.V3RequestabilityForRole -CommentsRequired true ` + -DenialCommentsRequired true ` + -ApprovalSchemes null +``` + +- Convert the resource to JSON +```powershell +$RequestabilityForRole | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestableObject.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestableObject.md new file mode 100644 index 000000000..2cd8d1e28 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestableObject.md @@ -0,0 +1,53 @@ +--- +id: requestable-object +title: RequestableObject +pagination_label: RequestableObject +sidebar_label: RequestableObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestableObject', 'RequestableObject'] +slug: /tools/sdk/powershell/v3/models/requestable-object +tags: ['SDK', 'Software Development Kit', 'RequestableObject', 'RequestableObject'] +--- + + +# RequestableObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the requestable object itself | [optional] +**Name** | Pointer to **String** | Human-readable display name of the requestable object | [optional] +**Created** | Pointer to **System.DateTime** | The time when the requestable object was created | [optional] +**Modified** | Pointer to **System.DateTime** | The time when the requestable object was last modified | [optional] +**Description** | Pointer to **String** | Description of the requestable object. | [optional] +**Type** | Pointer to [**RequestableObjectType**](requestable-object-type) | | [optional] +**RequestStatus** | Pointer to [**RequestableObjectRequestStatus**](requestable-object-request-status) | | [optional] +**IdentityRequestId** | Pointer to **String** | If *requestStatus* is *PENDING*, indicates the id of the associated account activity. | [optional] +**OwnerRef** | Pointer to [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**RequestCommentsRequired** | Pointer to **Boolean** | Whether the requester must provide comments when requesting the object. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestableObject = Initialize-PSSailpoint.V3RequestableObject -Id 2c9180835d2e5168015d32f890ca1581 ` + -Name Applied Research Access ` + -Created 2017-07-11T18:45:37.098Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Description Access to research information, lab results, and schematics. ` + -Type null ` + -RequestStatus null ` + -IdentityRequestId null ` + -OwnerRef null ` + -RequestCommentsRequired false +``` + +- Convert the resource to JSON +```powershell +$RequestableObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestableObjectReference.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestableObjectReference.md new file mode 100644 index 000000000..a712ce9aa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestableObjectReference.md @@ -0,0 +1,41 @@ +--- +id: requestable-object-reference +title: RequestableObjectReference +pagination_label: RequestableObjectReference +sidebar_label: RequestableObjectReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestableObjectReference', 'RequestableObjectReference'] +slug: /tools/sdk/powershell/v3/models/requestable-object-reference +tags: ['SDK', 'Software Development Kit', 'RequestableObjectReference', 'RequestableObjectReference'] +--- + + +# RequestableObjectReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the object. | [optional] +**Name** | Pointer to **String** | Name of the object. | [optional] +**Description** | Pointer to **String** | Description of the object. | [optional] +**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | Type of the object. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestableObjectReference = Initialize-PSSailpoint.V3RequestableObjectReference -Id 2c9180835d2e5168015d32f890ca1581 ` + -Name Applied Research Access ` + -Description Access to research information, lab results, and schematics ` + -Type ROLE +``` + +- Convert the resource to JSON +```powershell +$RequestableObjectReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestableObjectRequestStatus.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestableObjectRequestStatus.md new file mode 100644 index 000000000..e0dfe8dd5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestableObjectRequestStatus.md @@ -0,0 +1,26 @@ +--- +id: requestable-object-request-status +title: RequestableObjectRequestStatus +pagination_label: RequestableObjectRequestStatus +sidebar_label: RequestableObjectRequestStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestableObjectRequestStatus', 'RequestableObjectRequestStatus'] +slug: /tools/sdk/powershell/v3/models/requestable-object-request-status +tags: ['SDK', 'Software Development Kit', 'RequestableObjectRequestStatus', 'RequestableObjectRequestStatus'] +--- + + +# RequestableObjectRequestStatus + +## Enum + + +* `AVAILABLE` (value: `"AVAILABLE"`) + +* `PENDING` (value: `"PENDING"`) + +* `ASSIGNED` (value: `"ASSIGNED"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestableObjectType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestableObjectType.md new file mode 100644 index 000000000..bc73c43e7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestableObjectType.md @@ -0,0 +1,26 @@ +--- +id: requestable-object-type +title: RequestableObjectType +pagination_label: RequestableObjectType +sidebar_label: RequestableObjectType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestableObjectType', 'RequestableObjectType'] +slug: /tools/sdk/powershell/v3/models/requestable-object-type +tags: ['SDK', 'Software Development Kit', 'RequestableObjectType', 'RequestableObjectType'] +--- + + +# RequestableObjectType + +## Enum + + +* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) + +* `ROLE` (value: `"ROLE"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemDetails.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemDetails.md new file mode 100644 index 000000000..87998b522 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemDetails.md @@ -0,0 +1,37 @@ +--- +id: requested-item-details +title: RequestedItemDetails +pagination_label: RequestedItemDetails +sidebar_label: RequestedItemDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemDetails', 'RequestedItemDetails'] +slug: /tools/sdk/powershell/v3/models/requested-item-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemDetails', 'RequestedItemDetails'] +--- + + +# RequestedItemDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "ENTITLEMENT", "ROLE" ] | The type of access item requested. | [optional] +**Id** | Pointer to **String** | The id of the access item requested. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemDetails = Initialize-PSSailpoint.V3RequestedItemDetails -Type ENTITLEMENT ` + -Id 779c6fd7171540bba1184e5946112c28 +``` + +- Convert the resource to JSON +```powershell +$RequestedItemDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemStatus.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemStatus.md new file mode 100644 index 000000000..51f94f13d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemStatus.md @@ -0,0 +1,81 @@ +--- +id: requested-item-status +title: RequestedItemStatus +pagination_label: RequestedItemStatus +sidebar_label: RequestedItemStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatus', 'RequestedItemStatus'] +slug: /tools/sdk/powershell/v3/models/requested-item-status +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatus', 'RequestedItemStatus'] +--- + + +# RequestedItemStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Human-readable display name of the item being requested. | [optional] +**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | Type of requested object. | [optional] +**CancelledRequestDetails** | Pointer to [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional] +**ErrorMessages** | Pointer to [**[]ErrorMessageDto[]**](error-message-dto) | List of list of localized error messages, if any, encountered during the approval/provisioning process. | [optional] +**State** | Pointer to [**RequestedItemStatusRequestState**](requested-item-status-request-state) | | [optional] +**ApprovalDetails** | Pointer to [**[]ApprovalStatusDto**](approval-status-dto) | Approval details for each item. | [optional] +**ApprovalIds** | Pointer to **[]String** | List of approval IDs associated with the request. | [optional] +**ManualWorkItemDetails** | Pointer to [**[]ManualWorkItemDetails**](manual-work-item-details) | Manual work items created for provisioning the item. | [optional] +**AccountActivityItemId** | Pointer to **String** | Id of associated account activity item. | [optional] +**RequestType** | Pointer to [**AccessRequestType**](access-request-type) | | [optional] +**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] +**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] +**Requester** | Pointer to [**AccessItemRequester**](access-item-requester) | | [optional] +**RequestedFor** | Pointer to [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] +**RequesterComment** | Pointer to [**RequestedItemStatusRequesterComment**](requested-item-status-requester-comment) | | [optional] +**SodViolationContext** | Pointer to [**RequestedItemStatusSodViolationContext**](requested-item-status-sod-violation-context) | | [optional] +**ProvisioningDetails** | Pointer to [**RequestedItemStatusProvisioningDetails**](requested-item-status-provisioning-details) | | [optional] +**PreApprovalTriggerDetails** | Pointer to [**RequestedItemStatusPreApprovalTriggerDetails**](requested-item-status-pre-approval-trigger-details) | | [optional] +**AccessRequestPhases** | Pointer to [**[]AccessRequestPhases**](access-request-phases) | A list of Phases that the Access Request has gone through in order, to help determine the status of the request. | [optional] +**Description** | Pointer to **String** | Description associated to the requested object. | [optional] +**RemoveDate** | Pointer to **System.DateTime** | When the role access is scheduled for removal. | [optional] +**Cancelable** | Pointer to **Boolean** | True if the request can be canceled. | [optional] [default to $false] +**AccessRequestId** | Pointer to **String** | This is the account activity id. | [optional] +**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemStatus = Initialize-PSSailpoint.V3RequestedItemStatus -Name AccessProfile1 ` + -Type ACCESS_PROFILE ` + -CancelledRequestDetails null ` + -ErrorMessages null ` + -State null ` + -ApprovalDetails null ` + -ApprovalIds [85f0cf482dd44327b593624c07906c21, fa57e1bfa36f41ee85e33ee59fcbeac5] ` + -ManualWorkItemDetails null ` + -AccountActivityItemId 2c9180926cbfbddd016cbfc7c3b10010 ` + -RequestType null ` + -Modified 2019-08-23T18:52:59.162Z ` + -Created 2019-08-23T18:40:35.772Z ` + -Requester null ` + -RequestedFor null ` + -RequesterComment null ` + -SodViolationContext null ` + -ProvisioningDetails null ` + -PreApprovalTriggerDetails null ` + -AccessRequestPhases null ` + -Description This is the Engineering role that engineers are granted. ` + -RemoveDate 2019-10-23T00:00Z ` + -Cancelable true ` + -AccessRequestId 2b838de9-db9b-abcf-e646-d4f274ad4238 ` + -ClientMetadata {key1=value1, key2=value2} +``` + +- Convert the resource to JSON +```powershell +$RequestedItemStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemStatusCancelledRequestDetails.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemStatusCancelledRequestDetails.md new file mode 100644 index 000000000..274915ecb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemStatusCancelledRequestDetails.md @@ -0,0 +1,39 @@ +--- +id: requested-item-status-cancelled-request-details +title: RequestedItemStatusCancelledRequestDetails +pagination_label: RequestedItemStatusCancelledRequestDetails +sidebar_label: RequestedItemStatusCancelledRequestDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusCancelledRequestDetails', 'RequestedItemStatusCancelledRequestDetails'] +slug: /tools/sdk/powershell/v3/models/requested-item-status-cancelled-request-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusCancelledRequestDetails', 'RequestedItemStatusCancelledRequestDetails'] +--- + + +# RequestedItemStatusCancelledRequestDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment made by the owner when cancelling the associated request. | [optional] +**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**Modified** | Pointer to **System.DateTime** | Date comment was added by the owner when cancelling the associated request. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemStatusCancelledRequestDetails = Initialize-PSSailpoint.V3RequestedItemStatusCancelledRequestDetails -Comment This request must be cancelled. ` + -Owner null ` + -Modified 2019-12-20T09:17:12.192Z +``` + +- Convert the resource to JSON +```powershell +$RequestedItemStatusCancelledRequestDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemStatusPreApprovalTriggerDetails.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemStatusPreApprovalTriggerDetails.md new file mode 100644 index 000000000..7ac36938c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemStatusPreApprovalTriggerDetails.md @@ -0,0 +1,39 @@ +--- +id: requested-item-status-pre-approval-trigger-details +title: RequestedItemStatusPreApprovalTriggerDetails +pagination_label: RequestedItemStatusPreApprovalTriggerDetails +sidebar_label: RequestedItemStatusPreApprovalTriggerDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusPreApprovalTriggerDetails', 'RequestedItemStatusPreApprovalTriggerDetails'] +slug: /tools/sdk/powershell/v3/models/requested-item-status-pre-approval-trigger-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusPreApprovalTriggerDetails', 'RequestedItemStatusPreApprovalTriggerDetails'] +--- + + +# RequestedItemStatusPreApprovalTriggerDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment left for the pre-approval decision | [optional] +**Reviewer** | Pointer to **String** | The reviewer of the pre-approval decision | [optional] +**Decision** | Pointer to **Enum** [ "APPROVED", "REJECTED" ] | The decision of the pre-approval trigger | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemStatusPreApprovalTriggerDetails = Initialize-PSSailpoint.V3RequestedItemStatusPreApprovalTriggerDetails -Comment Access is Approved ` + -Reviewer John Doe ` + -Decision APPROVED +``` + +- Convert the resource to JSON +```powershell +$RequestedItemStatusPreApprovalTriggerDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemStatusProvisioningDetails.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemStatusProvisioningDetails.md new file mode 100644 index 000000000..44a55bea0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemStatusProvisioningDetails.md @@ -0,0 +1,35 @@ +--- +id: requested-item-status-provisioning-details +title: RequestedItemStatusProvisioningDetails +pagination_label: RequestedItemStatusProvisioningDetails +sidebar_label: RequestedItemStatusProvisioningDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusProvisioningDetails', 'RequestedItemStatusProvisioningDetails'] +slug: /tools/sdk/powershell/v3/models/requested-item-status-provisioning-details +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusProvisioningDetails', 'RequestedItemStatusProvisioningDetails'] +--- + + +# RequestedItemStatusProvisioningDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**OrderedSubPhaseReferences** | Pointer to **String** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain ""manualWorkItemDetails"" which indicate that there is further information in that object for this phase. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemStatusProvisioningDetails = Initialize-PSSailpoint.V3RequestedItemStatusProvisioningDetails -OrderedSubPhaseReferences manualWorkItemDetails +``` + +- Convert the resource to JSON +```powershell +$RequestedItemStatusProvisioningDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemStatusRequestState.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemStatusRequestState.md new file mode 100644 index 000000000..ea864391b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemStatusRequestState.md @@ -0,0 +1,38 @@ +--- +id: requested-item-status-request-state +title: RequestedItemStatusRequestState +pagination_label: RequestedItemStatusRequestState +sidebar_label: RequestedItemStatusRequestState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusRequestState', 'RequestedItemStatusRequestState'] +slug: /tools/sdk/powershell/v3/models/requested-item-status-request-state +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequestState', 'RequestedItemStatusRequestState'] +--- + + +# RequestedItemStatusRequestState + +## Enum + + +* `EXECUTING` (value: `"EXECUTING"`) + +* `REQUEST_COMPLETED` (value: `"REQUEST_COMPLETED"`) + +* `CANCELLED` (value: `"CANCELLED"`) + +* `TERMINATED` (value: `"TERMINATED"`) + +* `PROVISIONING_VERIFICATION_PENDING` (value: `"PROVISIONING_VERIFICATION_PENDING"`) + +* `REJECTED` (value: `"REJECTED"`) + +* `PROVISIONING_FAILED` (value: `"PROVISIONING_FAILED"`) + +* `NOT_ALL_ITEMS_PROVISIONED` (value: `"NOT_ALL_ITEMS_PROVISIONED"`) + +* `ERROR` (value: `"ERROR"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemStatusRequestedFor.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemStatusRequestedFor.md new file mode 100644 index 000000000..7f2e585e0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemStatusRequestedFor.md @@ -0,0 +1,39 @@ +--- +id: requested-item-status-requested-for +title: RequestedItemStatusRequestedFor +pagination_label: RequestedItemStatusRequestedFor +sidebar_label: RequestedItemStatusRequestedFor +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusRequestedFor', 'RequestedItemStatusRequestedFor'] +slug: /tools/sdk/powershell/v3/models/requested-item-status-requested-for +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequestedFor', 'RequestedItemStatusRequestedFor'] +--- + + +# RequestedItemStatusRequestedFor + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Type of the object to which this reference applies | [optional] +**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemStatusRequestedFor = Initialize-PSSailpoint.V3RequestedItemStatusRequestedFor -Type IDENTITY ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$RequestedItemStatusRequestedFor | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemStatusRequesterComment.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemStatusRequesterComment.md new file mode 100644 index 000000000..f62d3952a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemStatusRequesterComment.md @@ -0,0 +1,39 @@ +--- +id: requested-item-status-requester-comment +title: RequestedItemStatusRequesterComment +pagination_label: RequestedItemStatusRequesterComment +sidebar_label: RequestedItemStatusRequesterComment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusRequesterComment', 'RequestedItemStatusRequesterComment'] +slug: /tools/sdk/powershell/v3/models/requested-item-status-requester-comment +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequesterComment', 'RequestedItemStatusRequesterComment'] +--- + + +# RequestedItemStatusRequesterComment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Comment** | Pointer to **String** | Comment content. | [optional] +**Created** | Pointer to **System.DateTime** | Date and time comment was created. | [optional] +**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemStatusRequesterComment = Initialize-PSSailpoint.V3RequestedItemStatusRequesterComment -Comment This is a comment. ` + -Created 2017-07-11T18:45:37.098Z ` + -Author null +``` + +- Convert the resource to JSON +```powershell +$RequestedItemStatusRequesterComment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemStatusSodViolationContext.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemStatusSodViolationContext.md new file mode 100644 index 000000000..bbc93be84 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RequestedItemStatusSodViolationContext.md @@ -0,0 +1,39 @@ +--- +id: requested-item-status-sod-violation-context +title: RequestedItemStatusSodViolationContext +pagination_label: RequestedItemStatusSodViolationContext +sidebar_label: RequestedItemStatusSodViolationContext +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusSodViolationContext', 'RequestedItemStatusSodViolationContext'] +slug: /tools/sdk/powershell/v3/models/requested-item-status-sod-violation-context +tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusSodViolationContext', 'RequestedItemStatusSodViolationContext'] +--- + + +# RequestedItemStatusSodViolationContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **Enum** [ "SUCCESS", "ERROR" ] | The status of SOD violation check | [optional] +**Uuid** | Pointer to **String** | The id of the Violation check event | [optional] +**ViolationCheckResult** | Pointer to [**SodViolationCheckResult**](sod-violation-check-result) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemStatusSodViolationContext = Initialize-PSSailpoint.V3RequestedItemStatusSodViolationContext -State SUCCESS ` + -Uuid f73d16e9-a038-46c5-b217-1246e15fdbdd ` + -ViolationCheckResult null +``` + +- Convert the resource to JSON +```powershell +$RequestedItemStatusSodViolationContext | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReviewDecision.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReviewDecision.md new file mode 100644 index 000000000..b3065beb3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReviewDecision.md @@ -0,0 +1,45 @@ +--- +id: review-decision +title: ReviewDecision +pagination_label: ReviewDecision +sidebar_label: ReviewDecision +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewDecision', 'ReviewDecision'] +slug: /tools/sdk/powershell/v3/models/review-decision +tags: ['SDK', 'Software Development Kit', 'ReviewDecision', 'ReviewDecision'] +--- + + +# ReviewDecision + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The id of the review decision | [required] +**Decision** | [**CertificationDecision**](certification-decision) | | [required] +**ProposedEndDate** | Pointer to **System.DateTime** | The date at which a user's access should be taken away. Should only be set for `REVOKE` decisions. | [optional] +**Bulk** | **Boolean** | Indicates whether decision should be marked as part of a larger bulk decision | [required] +**Recommendation** | Pointer to [**ReviewRecommendation**](review-recommendation) | | [optional] +**Comments** | Pointer to **String** | Comments recorded when the decision was made | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReviewDecision = Initialize-PSSailpoint.V3ReviewDecision -Id ef38f94347e94562b5bb8424a56397d8 ` + -Decision null ` + -ProposedEndDate 2017-07-11T18:45:37.098Z ` + -Bulk true ` + -Recommendation null ` + -Comments This user no longer needs access to this source +``` + +- Convert the resource to JSON +```powershell +$ReviewDecision | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReviewReassign.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReviewReassign.md new file mode 100644 index 000000000..f234b6429 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReviewReassign.md @@ -0,0 +1,39 @@ +--- +id: review-reassign +title: ReviewReassign +pagination_label: ReviewReassign +sidebar_label: ReviewReassign +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewReassign', 'ReviewReassign'] +slug: /tools/sdk/powershell/v3/models/review-reassign +tags: ['SDK', 'Software Development Kit', 'ReviewReassign', 'ReviewReassign'] +--- + + +# ReviewReassign + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$ReviewReassign = Initialize-PSSailpoint.V3ReviewReassign -Reassign null ` + -ReassignTo ef38f94347e94562b5bb8424a56397d8 ` + -Reason reassigned for some reason +``` + +- Convert the resource to JSON +```powershell +$ReviewReassign | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReviewRecommendation.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReviewRecommendation.md new file mode 100644 index 000000000..a08578256 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReviewRecommendation.md @@ -0,0 +1,39 @@ +--- +id: review-recommendation +title: ReviewRecommendation +pagination_label: ReviewRecommendation +sidebar_label: ReviewRecommendation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewRecommendation', 'ReviewRecommendation'] +slug: /tools/sdk/powershell/v3/models/review-recommendation +tags: ['SDK', 'Software Development Kit', 'ReviewRecommendation', 'ReviewRecommendation'] +--- + + +# ReviewRecommendation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Recommendation** | Pointer to **String** | The recommendation from IAI at the time of the decision. This field will be null if no recommendation was made. | [optional] +**Reasons** | Pointer to **[]String** | A list of reasons for the recommendation. | [optional] +**Timestamp** | Pointer to **System.DateTime** | The time at which the recommendation was recorded. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReviewRecommendation = Initialize-PSSailpoint.V3ReviewRecommendation -Recommendation null ` + -Reasons [Reason 1, Reason 2] ` + -Timestamp 2020-06-01T13:49:37.385Z +``` + +- Convert the resource to JSON +```powershell +$ReviewRecommendation | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReviewableAccessProfile.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReviewableAccessProfile.md new file mode 100644 index 000000000..079f2cf75 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReviewableAccessProfile.md @@ -0,0 +1,53 @@ +--- +id: reviewable-access-profile +title: ReviewableAccessProfile +pagination_label: ReviewableAccessProfile +sidebar_label: ReviewableAccessProfile +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewableAccessProfile', 'ReviewableAccessProfile'] +slug: /tools/sdk/powershell/v3/models/reviewable-access-profile +tags: ['SDK', 'Software Development Kit', 'ReviewableAccessProfile', 'ReviewableAccessProfile'] +--- + + +# ReviewableAccessProfile + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The id of the Access Profile | [optional] +**Name** | Pointer to **String** | Name of the Access Profile | [optional] +**Description** | Pointer to **String** | Information about the Access Profile | [optional] +**Privileged** | Pointer to **Boolean** | Indicates if the entitlement is a privileged entitlement | [optional] +**CloudGoverned** | Pointer to **Boolean** | True if the entitlement is cloud governed | [optional] +**EndDate** | Pointer to **System.DateTime** | The date at which a user's access expires | [optional] +**Owner** | Pointer to [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**Entitlements** | Pointer to [**[]ReviewableEntitlement**](reviewable-entitlement) | A list of entitlements associated with this Access Profile | [optional] +**Created** | Pointer to **System.DateTime** | Date the Access Profile was created. | [optional] +**Modified** | Pointer to **System.DateTime** | Date the Access Profile was last modified. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReviewableAccessProfile = Initialize-PSSailpoint.V3ReviewableAccessProfile -Id 2c91808a7190d06e01719938fcd20792 ` + -Name Employee-database-read-write ` + -Description Collection of entitlements to read/write the employee database ` + -Privileged false ` + -CloudGoverned false ` + -EndDate 2021-12-25T00:00Z ` + -Owner null ` + -Entitlements null ` + -Created 2021-01-01T22:32:58.104Z ` + -Modified 2021-02-01T22:32:58.104Z +``` + +- Convert the resource to JSON +```powershell +$ReviewableAccessProfile | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReviewableEntitlement.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReviewableEntitlement.md new file mode 100644 index 000000000..20542a606 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReviewableEntitlement.md @@ -0,0 +1,69 @@ +--- +id: reviewable-entitlement +title: ReviewableEntitlement +pagination_label: ReviewableEntitlement +sidebar_label: ReviewableEntitlement +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewableEntitlement', 'ReviewableEntitlement'] +slug: /tools/sdk/powershell/v3/models/reviewable-entitlement +tags: ['SDK', 'Software Development Kit', 'ReviewableEntitlement', 'ReviewableEntitlement'] +--- + + +# ReviewableEntitlement + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The id for the entitlement | [optional] +**Name** | Pointer to **String** | The name of the entitlement | [optional] +**Description** | Pointer to **String** | Information about the entitlement | [optional] +**Privileged** | Pointer to **Boolean** | Indicates if the entitlement is a privileged entitlement | [optional] [default to $false] +**Owner** | Pointer to [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**AttributeName** | Pointer to **String** | The name of the attribute on the source | [optional] +**AttributeValue** | Pointer to **String** | The value of the attribute on the source | [optional] +**SourceSchemaObjectType** | Pointer to **String** | The schema object type on the source used to represent the entitlement and its attributes | [optional] +**SourceName** | Pointer to **String** | The name of the source for which this entitlement belongs | [optional] +**SourceType** | Pointer to **String** | The type of the source for which the entitlement belongs | [optional] +**SourceId** | Pointer to **String** | The ID of the source for which the entitlement belongs | [optional] +**HasPermissions** | Pointer to **Boolean** | Indicates if the entitlement has permissions | [optional] [default to $false] +**IsPermission** | Pointer to **Boolean** | Indicates if the entitlement is a representation of an account permission | [optional] [default to $false] +**Revocable** | Pointer to **Boolean** | Indicates whether the entitlement can be revoked | [optional] [default to $false] +**CloudGoverned** | Pointer to **Boolean** | True if the entitlement is cloud governed | [optional] [default to $false] +**ContainsDataAccess** | Pointer to **Boolean** | True if the entitlement has DAS data | [optional] [default to $false] +**DataAccess** | Pointer to [**DataAccess**](data-access) | | [optional] +**Account** | Pointer to [**ReviewableEntitlementAccount**](reviewable-entitlement-account) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReviewableEntitlement = Initialize-PSSailpoint.V3ReviewableEntitlement -Id 2c918085718230600171993742c63558 ` + -Name CN=entitlement.bbb7c650 ` + -Description Gives read/write access to the company database ` + -Privileged false ` + -Owner null ` + -AttributeName memberOf ` + -AttributeValue CN=entitlement.bbb7c650 ` + -SourceSchemaObjectType groups ` + -SourceName ODS-AD-Source ` + -SourceType Active Directory - Direct ` + -SourceId 78ca6be511cb41fbb86dba2fcca7780c ` + -HasPermissions false ` + -IsPermission false ` + -Revocable true ` + -CloudGoverned false ` + -ContainsDataAccess true ` + -DataAccess null ` + -Account null +``` + +- Convert the resource to JSON +```powershell +$ReviewableEntitlement | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReviewableEntitlementAccount.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReviewableEntitlementAccount.md new file mode 100644 index 000000000..ecc7921a8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReviewableEntitlementAccount.md @@ -0,0 +1,57 @@ +--- +id: reviewable-entitlement-account +title: ReviewableEntitlementAccount +pagination_label: ReviewableEntitlementAccount +sidebar_label: ReviewableEntitlementAccount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewableEntitlementAccount', 'ReviewableEntitlementAccount'] +slug: /tools/sdk/powershell/v3/models/reviewable-entitlement-account +tags: ['SDK', 'Software Development Kit', 'ReviewableEntitlementAccount', 'ReviewableEntitlementAccount'] +--- + + +# ReviewableEntitlementAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NativeIdentity** | Pointer to **String** | The native identity for this account | [optional] +**Disabled** | Pointer to **Boolean** | Indicates whether this account is currently disabled | [optional] [default to $false] +**Locked** | Pointer to **Boolean** | Indicates whether this account is currently locked | [optional] [default to $false] +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **String** | The id associated with the account | [optional] +**Name** | Pointer to **String** | The account name | [optional] +**Created** | Pointer to **System.DateTime** | When the account was created | [optional] +**Modified** | Pointer to **System.DateTime** | When the account was last modified | [optional] +**ActivityInsights** | Pointer to [**ActivityInsights**](activity-insights) | | [optional] +**Description** | Pointer to **String** | Information about the account | [optional] +**GovernanceGroupId** | Pointer to **String** | The id associated with the machine Account Governance Group | [optional] +**Owner** | Pointer to [**ReviewableEntitlementAccountOwner**](reviewable-entitlement-account-owner) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReviewableEntitlementAccount = Initialize-PSSailpoint.V3ReviewableEntitlementAccount -NativeIdentity CN=Alison Ferguso ` + -Disabled false ` + -Locked false ` + -Type null ` + -Id 2c9180857182305e0171993737eb29e6 ` + -Name Alison Ferguso ` + -Created 2020-04-20T20:11:05.067Z ` + -Modified 2020-05-20T18:57:16.987Z ` + -ActivityInsights null ` + -Description Account for Read/write to the company database ` + -GovernanceGroupId 2c9180857182305e0171993737eb29e6 ` + -Owner null +``` + +- Convert the resource to JSON +```powershell +$ReviewableEntitlementAccount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReviewableEntitlementAccountOwner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReviewableEntitlementAccountOwner.md new file mode 100644 index 000000000..47cea82e9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReviewableEntitlementAccountOwner.md @@ -0,0 +1,39 @@ +--- +id: reviewable-entitlement-account-owner +title: ReviewableEntitlementAccountOwner +pagination_label: ReviewableEntitlementAccountOwner +sidebar_label: ReviewableEntitlementAccountOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewableEntitlementAccountOwner', 'ReviewableEntitlementAccountOwner'] +slug: /tools/sdk/powershell/v3/models/reviewable-entitlement-account-owner +tags: ['SDK', 'Software Development Kit', 'ReviewableEntitlementAccountOwner', 'ReviewableEntitlementAccountOwner'] +--- + + +# ReviewableEntitlementAccountOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The id associated with the machine account owner | [optional] +**Type** | Pointer to **Enum** [ "IDENTITY" ] | An enumeration of the types of Owner supported within the IdentityNow infrastructure. | [optional] +**DisplayName** | Pointer to **String** | The machine account owner's display name | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReviewableEntitlementAccountOwner = Initialize-PSSailpoint.V3ReviewableEntitlementAccountOwner -Id 2c9180857182305e0171993737eb29e8 ` + -Type IDENTITY ` + -DisplayName Alison Ferguson +``` + +- Convert the resource to JSON +```powershell +$ReviewableEntitlementAccountOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReviewableRole.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReviewableRole.md new file mode 100644 index 000000000..f1fbeca22 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ReviewableRole.md @@ -0,0 +1,51 @@ +--- +id: reviewable-role +title: ReviewableRole +pagination_label: ReviewableRole +sidebar_label: ReviewableRole +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewableRole', 'ReviewableRole'] +slug: /tools/sdk/powershell/v3/models/reviewable-role +tags: ['SDK', 'Software Development Kit', 'ReviewableRole', 'ReviewableRole'] +--- + + +# ReviewableRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The id for the Role | [optional] +**Name** | Pointer to **String** | The name of the Role | [optional] +**Description** | Pointer to **String** | Information about the Role | [optional] +**Privileged** | Pointer to **Boolean** | Indicates if the entitlement is a privileged entitlement | [optional] +**Owner** | Pointer to [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] +**Revocable** | Pointer to **Boolean** | Indicates whether the Role can be revoked or requested | [optional] +**EndDate** | Pointer to **System.DateTime** | The date when a user's access expires. | [optional] +**AccessProfiles** | Pointer to [**[]ReviewableAccessProfile**](reviewable-access-profile) | The list of Access Profiles associated with this Role | [optional] +**Entitlements** | Pointer to [**[]ReviewableEntitlement**](reviewable-entitlement) | The list of entitlements associated with this Role | [optional] + +## Examples + +- Prepare the resource +```powershell +$ReviewableRole = Initialize-PSSailpoint.V3ReviewableRole -Id 2c91808a7190d06e0171993907fd0794 ` + -Name Accounting-Employees ` + -Description Role for members of the accounting department with the necessary Access Profiles ` + -Privileged false ` + -Owner null ` + -Revocable false ` + -EndDate 2021-12-25T00:00Z ` + -AccessProfiles null ` + -Entitlements null +``` + +- Convert the resource to JSON +```powershell +$ReviewableRole | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Reviewer.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Reviewer.md new file mode 100644 index 000000000..e2f9ca7d2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Reviewer.md @@ -0,0 +1,45 @@ +--- +id: reviewer +title: Reviewer +pagination_label: Reviewer +sidebar_label: Reviewer +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Reviewer', 'Reviewer'] +slug: /tools/sdk/powershell/v3/models/reviewer +tags: ['SDK', 'Software Development Kit', 'Reviewer', 'Reviewer'] +--- + + +# Reviewer + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The id of the reviewer. | [optional] +**Name** | Pointer to **String** | The name of the reviewer. | [optional] +**Email** | Pointer to **String** | The email of the reviewing identity. | [optional] +**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of the reviewing identity. | [optional] +**Created** | Pointer to **System.DateTime** | The created date of the reviewing identity. | [optional] +**Modified** | Pointer to **System.DateTime** | The modified date of the reviewing identity. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Reviewer = Initialize-PSSailpoint.V3Reviewer -Id ef38f94347e94562b5bb8424a56397d8 ` + -Name Reviewer Name ` + -Email reviewer@test.com ` + -Type IDENTITY ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z +``` + +- Convert the resource to JSON +```powershell +$Reviewer | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Revocability.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Revocability.md new file mode 100644 index 000000000..eef2f8d6b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Revocability.md @@ -0,0 +1,35 @@ +--- +id: revocability +title: Revocability +pagination_label: Revocability +sidebar_label: Revocability +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Revocability', 'Revocability'] +slug: /tools/sdk/powershell/v3/models/revocability +tags: ['SDK', 'Software Development Kit', 'Revocability', 'Revocability'] +--- + + +# Revocability + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ApprovalSchemes** | Pointer to [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] + +## Examples + +- Prepare the resource +```powershell +$Revocability = Initialize-PSSailpoint.V3Revocability -ApprovalSchemes null +``` + +- Convert the resource to JSON +```powershell +$Revocability | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RevocabilityForRole.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RevocabilityForRole.md new file mode 100644 index 000000000..86ea5148e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RevocabilityForRole.md @@ -0,0 +1,39 @@ +--- +id: revocability-for-role +title: RevocabilityForRole +pagination_label: RevocabilityForRole +sidebar_label: RevocabilityForRole +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RevocabilityForRole', 'RevocabilityForRole'] +slug: /tools/sdk/powershell/v3/models/revocability-for-role +tags: ['SDK', 'Software Development Kit', 'RevocabilityForRole', 'RevocabilityForRole'] +--- + + +# RevocabilityForRole + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CommentsRequired** | Pointer to **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] +**DenialCommentsRequired** | Pointer to **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] +**ApprovalSchemes** | Pointer to [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the revocation request | [optional] + +## Examples + +- Prepare the resource +```powershell +$RevocabilityForRole = Initialize-PSSailpoint.V3RevocabilityForRole -CommentsRequired false ` + -DenialCommentsRequired false ` + -ApprovalSchemes null +``` + +- Convert the resource to JSON +```powershell +$RevocabilityForRole | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RightPad.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RightPad.md new file mode 100644 index 000000000..1209cecb3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RightPad.md @@ -0,0 +1,41 @@ +--- +id: right-pad +title: RightPad +pagination_label: RightPad +sidebar_label: RightPad +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RightPad', 'RightPad'] +slug: /tools/sdk/powershell/v3/models/right-pad +tags: ['SDK', 'Software Development Kit', 'RightPad', 'RightPad'] +--- + + +# RightPad + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Length** | **String** | An integer value for the desired length of the final output string | [required] +**Padding** | Pointer to **String** | A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space ("" "") character for padding | [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] + +## Examples + +- Prepare the resource +```powershell +$RightPad = Initialize-PSSailpoint.V3RightPad -Length 4 ` + -Padding 0 ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$RightPad | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Role.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Role.md new file mode 100644 index 000000000..e35a62296 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Role.md @@ -0,0 +1,69 @@ +--- +id: role +title: Role +pagination_label: Role +sidebar_label: Role +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Role', 'Role'] +slug: /tools/sdk/powershell/v3/models/role +tags: ['SDK', 'Software Development Kit', 'Role', 'Role'] +--- + + +# Role + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result. | [optional] +**Name** | **String** | The human-readable display name of the Role | [required] +**Created** | Pointer to **System.DateTime** | Date the Role was created | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | Date the Role was last modified. | [optional] [readonly] +**Description** | Pointer to **String** | A human-readable description of the Role | [optional] +**Owner** | [**OwnerReference**](owner-reference) | | [required] +**AccessProfiles** | Pointer to [**[]AccessProfileRef**](access-profile-ref) | | [optional] +**Entitlements** | Pointer to [**[]EntitlementRef**](entitlement-ref) | | [optional] +**Membership** | Pointer to [**RoleMembershipSelector**](role-membership-selector) | | [optional] +**LegacyMembershipInfo** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. | [optional] +**Enabled** | Pointer to **Boolean** | Whether the Role is enabled or not. | [optional] [default to $false] +**Requestable** | Pointer to **Boolean** | Whether the Role can be the target of access requests. | [optional] [default to $false] +**AccessRequestConfig** | Pointer to [**RequestabilityForRole**](requestability-for-role) | | [optional] +**RevocationRequestConfig** | Pointer to [**RevocabilityForRole**](revocability-for-role) | | [optional] +**Segments** | Pointer to **[]String** | List of IDs of segments, if any, to which this Role is assigned. | [optional] +**Dimensional** | Pointer to **Boolean** | Whether the Role is dimensional. | [optional] [default to $false] +**DimensionRefs** | Pointer to [**[]DimensionRef**](dimension-ref) | List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional. | [optional] +**AccessModelMetadata** | Pointer to [**AttributeDTOList**](attribute-dto-list) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Role = Initialize-PSSailpoint.V3Role -Id 2c918086749d78830174a1a40e121518 ` + -Name Role 2567 ` + -Created 2021-03-01T22:32:58.104Z ` + -Modified 2021-03-02T20:22:28.104Z ` + -Description Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor. ` + -Owner null ` + -AccessProfiles null ` + -Entitlements null ` + -Membership null ` + -LegacyMembershipInfo {type=IDENTITY_LIST} ` + -Enabled true ` + -Requestable true ` + -AccessRequestConfig null ` + -RevocationRequestConfig null ` + -Segments [f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a] ` + -Dimensional null ` + -DimensionRefs null ` + -AccessModelMetadata null +``` + +- Convert the resource to JSON +```powershell +$Role | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleAssignmentSourceType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleAssignmentSourceType.md new file mode 100644 index 000000000..635d4d88a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleAssignmentSourceType.md @@ -0,0 +1,24 @@ +--- +id: role-assignment-source-type +title: RoleAssignmentSourceType +pagination_label: RoleAssignmentSourceType +sidebar_label: RoleAssignmentSourceType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleAssignmentSourceType', 'RoleAssignmentSourceType'] +slug: /tools/sdk/powershell/v3/models/role-assignment-source-type +tags: ['SDK', 'Software Development Kit', 'RoleAssignmentSourceType', 'RoleAssignmentSourceType'] +--- + + +# RoleAssignmentSourceType + +## Enum + + +* `ACCESS_REQUEST` (value: `"ACCESS_REQUEST"`) + +* `ROLE_MEMBERSHIP` (value: `"ROLE_MEMBERSHIP"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleBulkDeleteRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleBulkDeleteRequest.md new file mode 100644 index 000000000..8f3648336 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleBulkDeleteRequest.md @@ -0,0 +1,35 @@ +--- +id: role-bulk-delete-request +title: RoleBulkDeleteRequest +pagination_label: RoleBulkDeleteRequest +sidebar_label: RoleBulkDeleteRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleBulkDeleteRequest', 'RoleBulkDeleteRequest'] +slug: /tools/sdk/powershell/v3/models/role-bulk-delete-request +tags: ['SDK', 'Software Development Kit', 'RoleBulkDeleteRequest', 'RoleBulkDeleteRequest'] +--- + + +# RoleBulkDeleteRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RoleIds** | **[]String** | List of IDs of Roles to be deleted. | [required] + +## Examples + +- Prepare the resource +```powershell +$RoleBulkDeleteRequest = Initialize-PSSailpoint.V3RoleBulkDeleteRequest -RoleIds [2c9180847812e0b1017817051919ecca, 2c9180887812e0b201781e129f151816] +``` + +- Convert the resource to JSON +```powershell +$RoleBulkDeleteRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleCriteriaKey.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleCriteriaKey.md new file mode 100644 index 000000000..4d8fdcb57 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleCriteriaKey.md @@ -0,0 +1,39 @@ +--- +id: role-criteria-key +title: RoleCriteriaKey +pagination_label: RoleCriteriaKey +sidebar_label: RoleCriteriaKey +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaKey', 'RoleCriteriaKey'] +slug: /tools/sdk/powershell/v3/models/role-criteria-key +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKey', 'RoleCriteriaKey'] +--- + + +# RoleCriteriaKey + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**RoleCriteriaKeyType**](role-criteria-key-type) | | [required] +**Property** | **String** | The name of the attribute or entitlement to which the associated criteria applies. | [required] +**SourceId** | Pointer to **String** | ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleCriteriaKey = Initialize-PSSailpoint.V3RoleCriteriaKey -Type null ` + -Property attribute.email ` + -SourceId 2c9180867427f3a301745aec18211519 +``` + +- Convert the resource to JSON +```powershell +$RoleCriteriaKey | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleCriteriaKeyType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleCriteriaKeyType.md new file mode 100644 index 000000000..7559bb140 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleCriteriaKeyType.md @@ -0,0 +1,26 @@ +--- +id: role-criteria-key-type +title: RoleCriteriaKeyType +pagination_label: RoleCriteriaKeyType +sidebar_label: RoleCriteriaKeyType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaKeyType', 'RoleCriteriaKeyType'] +slug: /tools/sdk/powershell/v3/models/role-criteria-key-type +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKeyType', 'RoleCriteriaKeyType'] +--- + + +# RoleCriteriaKeyType + +## Enum + + +* `IDENTITY` (value: `"IDENTITY"`) + +* `ACCOUNT` (value: `"ACCOUNT"`) + +* `ENTITLEMENT` (value: `"ENTITLEMENT"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleCriteriaLevel1.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleCriteriaLevel1.md new file mode 100644 index 000000000..cda70d9d0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleCriteriaLevel1.md @@ -0,0 +1,41 @@ +--- +id: role-criteria-level1 +title: RoleCriteriaLevel1 +pagination_label: RoleCriteriaLevel1 +sidebar_label: RoleCriteriaLevel1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaLevel1', 'RoleCriteriaLevel1'] +slug: /tools/sdk/powershell/v3/models/role-criteria-level1 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel1', 'RoleCriteriaLevel1'] +--- + + +# RoleCriteriaLevel1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**Key** | Pointer to [**RoleCriteriaKey**](role-criteria-key) | | [optional] +**StringValue** | Pointer to **String** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] +**Children** | Pointer to [**[]RoleCriteriaLevel2**](role-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleCriteriaLevel1 = Initialize-PSSailpoint.V3RoleCriteriaLevel1 -Operation null ` + -Key null ` + -StringValue carlee.cert1c9f9b6fd@mailinator.com ` + -Children null +``` + +- Convert the resource to JSON +```powershell +$RoleCriteriaLevel1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleCriteriaLevel2.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleCriteriaLevel2.md new file mode 100644 index 000000000..f5ba237eb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleCriteriaLevel2.md @@ -0,0 +1,41 @@ +--- +id: role-criteria-level2 +title: RoleCriteriaLevel2 +pagination_label: RoleCriteriaLevel2 +sidebar_label: RoleCriteriaLevel2 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaLevel2', 'RoleCriteriaLevel2'] +slug: /tools/sdk/powershell/v3/models/role-criteria-level2 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel2', 'RoleCriteriaLevel2'] +--- + + +# RoleCriteriaLevel2 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**Key** | Pointer to [**RoleCriteriaKey**](role-criteria-key) | | [optional] +**StringValue** | Pointer to **String** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] +**Children** | Pointer to [**[]RoleCriteriaLevel3**](role-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleCriteriaLevel2 = Initialize-PSSailpoint.V3RoleCriteriaLevel2 -Operation null ` + -Key null ` + -StringValue carlee.cert1c9f9b6fd@mailinator.com ` + -Children null +``` + +- Convert the resource to JSON +```powershell +$RoleCriteriaLevel2 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleCriteriaLevel3.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleCriteriaLevel3.md new file mode 100644 index 000000000..54b9b149b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleCriteriaLevel3.md @@ -0,0 +1,39 @@ +--- +id: role-criteria-level3 +title: RoleCriteriaLevel3 +pagination_label: RoleCriteriaLevel3 +sidebar_label: RoleCriteriaLevel3 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaLevel3', 'RoleCriteriaLevel3'] +slug: /tools/sdk/powershell/v3/models/role-criteria-level3 +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel3', 'RoleCriteriaLevel3'] +--- + + +# RoleCriteriaLevel3 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] +**Key** | Pointer to [**RoleCriteriaKey**](role-criteria-key) | | [optional] +**StringValue** | Pointer to **String** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleCriteriaLevel3 = Initialize-PSSailpoint.V3RoleCriteriaLevel3 -Operation null ` + -Key null ` + -StringValue carlee.cert1c9f9b6fd@mailinator.com +``` + +- Convert the resource to JSON +```powershell +$RoleCriteriaLevel3 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleCriteriaOperation.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleCriteriaOperation.md new file mode 100644 index 000000000..fc543c364 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleCriteriaOperation.md @@ -0,0 +1,34 @@ +--- +id: role-criteria-operation +title: RoleCriteriaOperation +pagination_label: RoleCriteriaOperation +sidebar_label: RoleCriteriaOperation +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaOperation', 'RoleCriteriaOperation'] +slug: /tools/sdk/powershell/v3/models/role-criteria-operation +tags: ['SDK', 'Software Development Kit', 'RoleCriteriaOperation', 'RoleCriteriaOperation'] +--- + + +# RoleCriteriaOperation + +## Enum + + +* `EQUALS` (value: `"EQUALS"`) + +* `NOT_EQUALS` (value: `"NOT_EQUALS"`) + +* `CONTAINS` (value: `"CONTAINS"`) + +* `STARTS_WITH` (value: `"STARTS_WITH"`) + +* `ENDS_WITH` (value: `"ENDS_WITH"`) + +* `AND` (value: `"AND"`) + +* `OR` (value: `"OR"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleDocument.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleDocument.md new file mode 100644 index 000000000..23c4daaf1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleDocument.md @@ -0,0 +1,69 @@ +--- +id: role-document +title: RoleDocument +pagination_label: RoleDocument +sidebar_label: RoleDocument +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleDocument', 'RoleDocument'] +slug: /tools/sdk/powershell/v3/models/role-document +tags: ['SDK', 'Software Development Kit', 'RoleDocument', 'RoleDocument'] +--- + + +# RoleDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the referenced object. | [required] +**Name** | **String** | The human readable name of the referenced object. | [required] +**Type** | [**DocumentType**](document-type) | | [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] +**AccessProfiles** | Pointer to [**[]BaseAccessProfile**](base-access-profile) | Access profiles included with the role. | [optional] +**AccessProfileCount** | Pointer to **Int32** | Number of access profiles included with the role. | [optional] +**Tags** | Pointer to **[]String** | Tags that have been applied to the object. | [optional] +**Segments** | Pointer to [**[]BaseSegment**](base-segment) | Segments with the role. | [optional] +**SegmentCount** | Pointer to **Int32** | Number of segments with the role. | [optional] +**Entitlements** | Pointer to [**[]BaseEntitlement**](base-entitlement) | Entitlements included with the role. | [optional] +**EntitlementCount** | Pointer to **Int32** | Number of entitlements included with the role. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleDocument = Initialize-PSSailpoint.V3RoleDocument -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -Type null ` + -Description The admin role ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Synced 2018-06-25T20:22:33.104Z ` + -Enabled true ` + -Requestable true ` + -RequestCommentsRequired false ` + -Owner null ` + -AccessProfiles null ` + -AccessProfileCount 1 ` + -Tags [TAG_1, TAG_2] ` + -Segments null ` + -SegmentCount 1 ` + -Entitlements null ` + -EntitlementCount 3 +``` + +- Convert the resource to JSON +```powershell +$RoleDocument | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleIdentity.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleIdentity.md new file mode 100644 index 000000000..86084b4c2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleIdentity.md @@ -0,0 +1,43 @@ +--- +id: role-identity +title: RoleIdentity +pagination_label: RoleIdentity +sidebar_label: RoleIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleIdentity', 'RoleIdentity'] +slug: /tools/sdk/powershell/v3/models/role-identity +tags: ['SDK', 'Software Development Kit', 'RoleIdentity', 'RoleIdentity'] +--- + + +# RoleIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The ID of the Identity | [optional] +**AliasName** | Pointer to **String** | The alias / username of the Identity | [optional] +**Name** | Pointer to **String** | The human-readable display name of the Identity | [optional] +**Email** | Pointer to **String** | Email address of the Identity | [optional] +**RoleAssignmentSource** | Pointer to [**RoleAssignmentSourceType**](role-assignment-source-type) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleIdentity = Initialize-PSSailpoint.V3RoleIdentity -Id 2c9180a46faadee4016fb4e018c20639 ` + -AliasName t.edison ` + -Name Thomas Edison ` + -Email t.edison@identitynow.com ` + -RoleAssignmentSource null +``` + +- Convert the resource to JSON +```powershell +$RoleIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleMembershipIdentity.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleMembershipIdentity.md new file mode 100644 index 000000000..8a6f07479 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleMembershipIdentity.md @@ -0,0 +1,41 @@ +--- +id: role-membership-identity +title: RoleMembershipIdentity +pagination_label: RoleMembershipIdentity +sidebar_label: RoleMembershipIdentity +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMembershipIdentity', 'RoleMembershipIdentity'] +slug: /tools/sdk/powershell/v3/models/role-membership-identity +tags: ['SDK', 'Software Development Kit', 'RoleMembershipIdentity', 'RoleMembershipIdentity'] +--- + + +# RoleMembershipIdentity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **String** | Identity id | [optional] +**Name** | Pointer to **String** | Human-readable display name of the Identity. | [optional] +**AliasName** | Pointer to **String** | User name of the Identity | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMembershipIdentity = Initialize-PSSailpoint.V3RoleMembershipIdentity -Type null ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Thomas Edison ` + -AliasName t.edison +``` + +- Convert the resource to JSON +```powershell +$RoleMembershipIdentity | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleMembershipSelector.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleMembershipSelector.md new file mode 100644 index 000000000..78e960560 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleMembershipSelector.md @@ -0,0 +1,39 @@ +--- +id: role-membership-selector +title: RoleMembershipSelector +pagination_label: RoleMembershipSelector +sidebar_label: RoleMembershipSelector +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMembershipSelector', 'RoleMembershipSelector'] +slug: /tools/sdk/powershell/v3/models/role-membership-selector +tags: ['SDK', 'Software Development Kit', 'RoleMembershipSelector', 'RoleMembershipSelector'] +--- + + +# RoleMembershipSelector + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**RoleMembershipSelectorType**](role-membership-selector-type) | | [optional] +**Criteria** | Pointer to [**RoleCriteriaLevel1**](role-criteria-level1) | | [optional] +**Identities** | Pointer to [**[]RoleMembershipIdentity**](role-membership-identity) | Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. | [optional] + +## Examples + +- Prepare the resource +```powershell +$RoleMembershipSelector = Initialize-PSSailpoint.V3RoleMembershipSelector -Type null ` + -Criteria null ` + -Identities null +``` + +- Convert the resource to JSON +```powershell +$RoleMembershipSelector | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleMembershipSelectorType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleMembershipSelectorType.md new file mode 100644 index 000000000..7c9dc8f36 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleMembershipSelectorType.md @@ -0,0 +1,24 @@ +--- +id: role-membership-selector-type +title: RoleMembershipSelectorType +pagination_label: RoleMembershipSelectorType +sidebar_label: RoleMembershipSelectorType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMembershipSelectorType', 'RoleMembershipSelectorType'] +slug: /tools/sdk/powershell/v3/models/role-membership-selector-type +tags: ['SDK', 'Software Development Kit', 'RoleMembershipSelectorType', 'RoleMembershipSelectorType'] +--- + + +# RoleMembershipSelectorType + +## Enum + + +* `STANDARD` (value: `"STANDARD"`) + +* `IDENTITY_LIST` (value: `"IDENTITY_LIST"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleSummary.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleSummary.md new file mode 100644 index 000000000..532f22251 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/RoleSummary.md @@ -0,0 +1,49 @@ +--- +id: role-summary +title: RoleSummary +pagination_label: RoleSummary +sidebar_label: RoleSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RoleSummary', 'RoleSummary'] +slug: /tools/sdk/powershell/v3/models/role-summary +tags: ['SDK', 'Software Development Kit', 'RoleSummary', 'RoleSummary'] +--- + + +# RoleSummary + +## Properties + +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] + +## Examples + +- Prepare the resource +```powershell +$RoleSummary = Initialize-PSSailpoint.V3RoleSummary -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -DisplayName John Q. Doe ` + -Type null ` + -Description null ` + -Owner null ` + -Disabled null ` + -Revocable null +``` + +- Convert the resource to JSON +```powershell +$RoleSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Rule.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Rule.md new file mode 100644 index 000000000..2aee9cf61 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Rule.md @@ -0,0 +1,47 @@ +--- +id: rule +title: Rule +pagination_label: Rule +sidebar_label: Rule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Rule', 'Rule'] +slug: /tools/sdk/powershell/v3/models/rule +tags: ['SDK', 'Software Development Kit', 'Rule', 'Rule'] +--- + + +# Rule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | This must always be set to ""Cloud Services Deployment Utility"" | [required] +**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] +**Operation** | **String** | The operation to perform `getReferenceIdentityAttribute` | [required] +**IncludeNumbers** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include numbers | [required] +**IncludeSpecialChars** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include special characters | [required] +**Length** | **String** | This specifies how long the randomly generated string needs to be >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters | [required] +**Uid** | **String** | This is the SailPoint User Name (uid) value of the identity whose attribute is desired As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. | [required] + +## Examples + +- Prepare the resource +```powershell +$Rule = Initialize-PSSailpoint.V3Rule -Name Cloud Services Deployment Utility ` + -RequiresPeriodicRefresh false ` + -Operation getReferenceIdentityAttribute ` + -IncludeNumbers true ` + -IncludeSpecialChars true ` + -Length 10 ` + -Uid 2c91808570313110017040b06f344ec9 +``` + +- Convert the resource to JSON +```powershell +$Rule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SavedSearch.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SavedSearch.md new file mode 100644 index 000000000..db776bf74 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SavedSearch.md @@ -0,0 +1,63 @@ +--- +id: saved-search +title: SavedSearch +pagination_label: SavedSearch +sidebar_label: SavedSearch +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearch', 'SavedSearch'] +slug: /tools/sdk/powershell/v3/models/saved-search +tags: ['SDK', 'Software Development Kit', 'SavedSearch', 'SavedSearch'] +--- + + +# SavedSearch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the saved search. | [optional] +**Description** | Pointer to **String** | The description of the saved search. | [optional] +**Created** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] +**Modified** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] +**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required] +**Columns** | Pointer to [**map[string]Column[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] +**Query** | **String** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required] +**Fields** | Pointer to **[]String** | The fields to be searched against in a multi-field query. | [optional] +**OrderBy** | Pointer to **map[string]String[]** | Sort by index. This takes precedence over the `sort` property. | [optional] +**Sort** | Pointer to **[]String** | The fields to be used to sort the search results. | [optional] +**Filters** | Pointer to [**SavedSearchDetailFilters**](saved-search-detail-filters) | | [optional] +**Id** | Pointer to **String** | The saved search ID. | [optional] +**Owner** | Pointer to [**TypedReference**](typed-reference) | | [optional] +**OwnerId** | Pointer to **String** | The ID of the identity that owns this saved search. | [optional] +**Public** | Pointer to **Boolean** | Whether this saved search is visible to anyone but the owner. This field will always be false as there is no way to set a saved search as public at this time. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$SavedSearch = Initialize-PSSailpoint.V3SavedSearch -Name Disabled accounts ` + -Description Disabled accounts ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Indices [identities] ` + -Columns {identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]} ` + -Query @accounts(disabled:true) ` + -Fields [disabled] ` + -OrderBy {identity=[lastName, firstName], role=[name]} ` + -Sort [displayName] ` + -Filters null ` + -Id 0de46054-fe90-434a-b84e-c6b3359d0c64 ` + -Owner null ` + -OwnerId 2c91808568c529c60168cca6f90c1313 ` + -Public false +``` + +- Convert the resource to JSON +```powershell +$SavedSearch | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SavedSearchDetail.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SavedSearchDetail.md new file mode 100644 index 000000000..aa358d564 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SavedSearchDetail.md @@ -0,0 +1,51 @@ +--- +id: saved-search-detail +title: SavedSearchDetail +pagination_label: SavedSearchDetail +sidebar_label: SavedSearchDetail +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearchDetail', 'SavedSearchDetail'] +slug: /tools/sdk/powershell/v3/models/saved-search-detail +tags: ['SDK', 'Software Development Kit', 'SavedSearchDetail', 'SavedSearchDetail'] +--- + + +# SavedSearchDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Created** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] +**Modified** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] +**Indices** | [**[]Index**](index) | The names of the Elasticsearch indices in which to search. | [required] +**Columns** | Pointer to [**map[string]Column[]**](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4) | The columns to be returned (specifies the order in which they will be presented) for each document type. The currently supported document types are: _accessprofile_, _accountactivity_, _account_, _aggregation_, _entitlement_, _event_, _identity_, and _role_. | [optional] +**Query** | **String** | The search query using Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL. | [required] +**Fields** | Pointer to **[]String** | The fields to be searched against in a multi-field query. | [optional] +**OrderBy** | Pointer to **map[string]String[]** | Sort by index. This takes precedence over the `sort` property. | [optional] +**Sort** | Pointer to **[]String** | The fields to be used to sort the search results. | [optional] +**Filters** | Pointer to [**SavedSearchDetailFilters**](saved-search-detail-filters) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SavedSearchDetail = Initialize-PSSailpoint.V3SavedSearchDetail -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Indices [identities] ` + -Columns {identity=[{field=displayName, header=Display Name}, {field=e-mail, header=Work Email}]} ` + -Query @accounts(disabled:true) ` + -Fields [disabled] ` + -OrderBy {identity=[lastName, firstName], role=[name]} ` + -Sort [displayName] ` + -Filters null +``` + +- Convert the resource to JSON +```powershell +$SavedSearchDetail | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SavedSearchDetailFilters.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SavedSearchDetailFilters.md new file mode 100644 index 000000000..da4273e32 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SavedSearchDetailFilters.md @@ -0,0 +1,41 @@ +--- +id: saved-search-detail-filters +title: SavedSearchDetailFilters +pagination_label: SavedSearchDetailFilters +sidebar_label: SavedSearchDetailFilters +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearchDetailFilters', 'SavedSearchDetailFilters'] +slug: /tools/sdk/powershell/v3/models/saved-search-detail-filters +tags: ['SDK', 'Software Development Kit', 'SavedSearchDetailFilters', 'SavedSearchDetailFilters'] +--- + + +# SavedSearchDetailFilters + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to [**FilterType**](filter-type) | | [optional] +**Range** | Pointer to [**Range**](range) | | [optional] +**Terms** | Pointer to **[]String** | The terms to be filtered. | [optional] +**Exclude** | Pointer to **Boolean** | Indicates if the filter excludes results. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$SavedSearchDetailFilters = Initialize-PSSailpoint.V3SavedSearchDetailFilters -Type null ` + -Range null ` + -Terms null ` + -Exclude false +``` + +- Convert the resource to JSON +```powershell +$SavedSearchDetailFilters | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SavedSearchName.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SavedSearchName.md new file mode 100644 index 000000000..4e07527aa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SavedSearchName.md @@ -0,0 +1,37 @@ +--- +id: saved-search-name +title: SavedSearchName +pagination_label: SavedSearchName +sidebar_label: SavedSearchName +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearchName', 'SavedSearchName'] +slug: /tools/sdk/powershell/v3/models/saved-search-name +tags: ['SDK', 'Software Development Kit', 'SavedSearchName', 'SavedSearchName'] +--- + + +# SavedSearchName + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the saved search. | [optional] +**Description** | Pointer to **String** | The description of the saved search. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SavedSearchName = Initialize-PSSailpoint.V3SavedSearchName -Name Disabled accounts ` + -Description Disabled accounts +``` + +- Convert the resource to JSON +```powershell +$SavedSearchName | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Schedule.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Schedule.md new file mode 100644 index 000000000..268b8a2bb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Schedule.md @@ -0,0 +1,45 @@ +--- +id: schedule +title: Schedule +pagination_label: Schedule +sidebar_label: Schedule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule', 'Schedule'] +slug: /tools/sdk/powershell/v3/models/schedule +tags: ['SDK', 'Software Development Kit', 'Schedule', 'Schedule'] +--- + + +# Schedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "WEEKLY", "MONTHLY", "ANNUALLY", "CALENDAR" ] | Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type can be configured. For example, a DAILY schedule can have 'hours' set, but not 'days'; a WEEKLY schedule can have both 'hours' and 'days' set. | [required] +**Months** | Pointer to [**ScheduleMonths**](schedule-months) | | [optional] +**Days** | Pointer to [**ScheduleDays**](schedule-days) | | [optional] +**Hours** | [**ScheduleHours**](schedule-hours) | | [required] +**Expiration** | Pointer to **System.DateTime** | Specifies the time after which this schedule will no longer occur. | [optional] +**TimeZoneId** | Pointer to **String** | The time zone to use when running the schedule. For instance, if the schedule is scheduled to run at 1AM, and this field is set to ""CST"", the schedule will run at 1AM CST. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Schedule = Initialize-PSSailpoint.V3Schedule -Type WEEKLY ` + -Months null ` + -Days null ` + -Hours null ` + -Expiration null ` + -TimeZoneId CST +``` + +- Convert the resource to JSON +```powershell +$Schedule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Schedule1.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Schedule1.md new file mode 100644 index 000000000..e835f5e20 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Schedule1.md @@ -0,0 +1,45 @@ +--- +id: schedule1 +title: Schedule1 +pagination_label: Schedule1 +sidebar_label: Schedule1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule1', 'Schedule1'] +slug: /tools/sdk/powershell/v3/models/schedule1 +tags: ['SDK', 'Software Development Kit', 'Schedule1', 'Schedule1'] +--- + + +# Schedule1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**ScheduleType**](schedule-type) | | [required] +**Months** | Pointer to [**Schedule1Months**](schedule1-months) | | [optional] +**Days** | Pointer to [**Schedule1Days**](schedule1-days) | | [optional] +**Hours** | [**Schedule1Hours**](schedule1-hours) | | [required] +**Expiration** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] +**TimeZoneId** | Pointer to **String** | The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org's default timezone is used. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Schedule1 = Initialize-PSSailpoint.V3Schedule1 -Type null ` + -Months null ` + -Days null ` + -Hours null ` + -Expiration 2018-06-25T20:22:28.104Z ` + -TimeZoneId America/Chicago +``` + +- Convert the resource to JSON +```powershell +$Schedule1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Schedule1Days.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Schedule1Days.md new file mode 100644 index 000000000..85be5e7f3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Schedule1Days.md @@ -0,0 +1,39 @@ +--- +id: schedule1-days +title: Schedule1Days +pagination_label: Schedule1Days +sidebar_label: Schedule1Days +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule1Days', 'Schedule1Days'] +slug: /tools/sdk/powershell/v3/models/schedule1-days +tags: ['SDK', 'Software Development Kit', 'Schedule1Days', 'Schedule1Days'] +--- + + +# Schedule1Days + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**SelectorType**](selector-type) | | [required] +**Values** | **[]String** | The selected values. | [required] +**Interval** | Pointer to **Int32** | The selected interval for RANGE selectors. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Schedule1Days = Initialize-PSSailpoint.V3Schedule1Days -Type null ` + -Values [MON, WED] ` + -Interval 3 +``` + +- Convert the resource to JSON +```powershell +$Schedule1Days | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Schedule1Hours.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Schedule1Hours.md new file mode 100644 index 000000000..bca3fb8c2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Schedule1Hours.md @@ -0,0 +1,39 @@ +--- +id: schedule1-hours +title: Schedule1Hours +pagination_label: Schedule1Hours +sidebar_label: Schedule1Hours +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule1Hours', 'Schedule1Hours'] +slug: /tools/sdk/powershell/v3/models/schedule1-hours +tags: ['SDK', 'Software Development Kit', 'Schedule1Hours', 'Schedule1Hours'] +--- + + +# Schedule1Hours + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**SelectorType**](selector-type) | | [required] +**Values** | **[]String** | The selected values. | [required] +**Interval** | Pointer to **Int32** | The selected interval for RANGE selectors. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Schedule1Hours = Initialize-PSSailpoint.V3Schedule1Hours -Type null ` + -Values [MON, WED] ` + -Interval 3 +``` + +- Convert the resource to JSON +```powershell +$Schedule1Hours | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Schedule1Months.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Schedule1Months.md new file mode 100644 index 000000000..26551ca21 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Schedule1Months.md @@ -0,0 +1,39 @@ +--- +id: schedule1-months +title: Schedule1Months +pagination_label: Schedule1Months +sidebar_label: Schedule1Months +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule1Months', 'Schedule1Months'] +slug: /tools/sdk/powershell/v3/models/schedule1-months +tags: ['SDK', 'Software Development Kit', 'Schedule1Months', 'Schedule1Months'] +--- + + +# Schedule1Months + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**SelectorType**](selector-type) | | [required] +**Values** | **[]String** | The selected values. | [required] +**Interval** | Pointer to **Int32** | The selected interval for RANGE selectors. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Schedule1Months = Initialize-PSSailpoint.V3Schedule1Months -Type null ` + -Values [MON, WED] ` + -Interval 3 +``` + +- Convert the resource to JSON +```powershell +$Schedule1Months | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ScheduleDays.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ScheduleDays.md new file mode 100644 index 000000000..9ca170be5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ScheduleDays.md @@ -0,0 +1,39 @@ +--- +id: schedule-days +title: ScheduleDays +pagination_label: ScheduleDays +sidebar_label: ScheduleDays +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduleDays', 'ScheduleDays'] +slug: /tools/sdk/powershell/v3/models/schedule-days +tags: ['SDK', 'Software Development Kit', 'ScheduleDays', 'ScheduleDays'] +--- + + +# ScheduleDays + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "LIST", "RANGE" ] | Enum type to specify days value | [required] +**Values** | **[]String** | Values of the days based on the enum type mentioned above | [required] +**Interval** | Pointer to **Int64** | Interval between the cert generations | [optional] + +## Examples + +- Prepare the resource +```powershell +$ScheduleDays = Initialize-PSSailpoint.V3ScheduleDays -Type LIST ` + -Values [1] ` + -Interval 2 +``` + +- Convert the resource to JSON +```powershell +$ScheduleDays | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ScheduleHours.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ScheduleHours.md new file mode 100644 index 000000000..cbee9bca7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ScheduleHours.md @@ -0,0 +1,39 @@ +--- +id: schedule-hours +title: ScheduleHours +pagination_label: ScheduleHours +sidebar_label: ScheduleHours +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduleHours', 'ScheduleHours'] +slug: /tools/sdk/powershell/v3/models/schedule-hours +tags: ['SDK', 'Software Development Kit', 'ScheduleHours', 'ScheduleHours'] +--- + + +# ScheduleHours + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "LIST", "RANGE" ] | Enum type to specify hours value | [required] +**Values** | **[]String** | Values of the days based on the enum type mentioned above | [required] +**Interval** | Pointer to **Int64** | Interval between the cert generations | [optional] + +## Examples + +- Prepare the resource +```powershell +$ScheduleHours = Initialize-PSSailpoint.V3ScheduleHours -Type LIST ` + -Values [1] ` + -Interval 2 +``` + +- Convert the resource to JSON +```powershell +$ScheduleHours | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ScheduleMonths.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ScheduleMonths.md new file mode 100644 index 000000000..b3efd5487 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ScheduleMonths.md @@ -0,0 +1,39 @@ +--- +id: schedule-months +title: ScheduleMonths +pagination_label: ScheduleMonths +sidebar_label: ScheduleMonths +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduleMonths', 'ScheduleMonths'] +slug: /tools/sdk/powershell/v3/models/schedule-months +tags: ['SDK', 'Software Development Kit', 'ScheduleMonths', 'ScheduleMonths'] +--- + + +# ScheduleMonths + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "LIST", "RANGE" ] | Enum type to specify months value | [required] +**Values** | **[]String** | Values of the months based on the enum type mentioned above | [required] +**Interval** | Pointer to **Int64** | Interval between the cert generations | [optional] + +## Examples + +- Prepare the resource +```powershell +$ScheduleMonths = Initialize-PSSailpoint.V3ScheduleMonths -Type LIST ` + -Values [1] ` + -Interval 2 +``` + +- Convert the resource to JSON +```powershell +$ScheduleMonths | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ScheduleType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ScheduleType.md new file mode 100644 index 000000000..252336690 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ScheduleType.md @@ -0,0 +1,30 @@ +--- +id: schedule-type +title: ScheduleType +pagination_label: ScheduleType +sidebar_label: ScheduleType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduleType', 'ScheduleType'] +slug: /tools/sdk/powershell/v3/models/schedule-type +tags: ['SDK', 'Software Development Kit', 'ScheduleType', 'ScheduleType'] +--- + + +# ScheduleType + +## Enum + + +* `DAILY` (value: `"DAILY"`) + +* `WEEKLY` (value: `"WEEKLY"`) + +* `MONTHLY` (value: `"MONTHLY"`) + +* `CALENDAR` (value: `"CALENDAR"`) + +* `ANNUALLY` (value: `"ANNUALLY"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ScheduledAttributes.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ScheduledAttributes.md new file mode 100644 index 000000000..3c3ac2c0f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ScheduledAttributes.md @@ -0,0 +1,43 @@ +--- +id: scheduled-attributes +title: ScheduledAttributes +pagination_label: ScheduledAttributes +sidebar_label: ScheduledAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledAttributes', 'ScheduledAttributes'] +slug: /tools/sdk/powershell/v3/models/scheduled-attributes +tags: ['SDK', 'Software Development Kit', 'ScheduledAttributes', 'ScheduledAttributes'] +--- + + +# ScheduledAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CronString** | Pointer to **String** | A valid CRON expression | [optional] +**Frequency** | **Enum** [ "daily", "weekly", "monthly", "yearly", "cronSchedule" ] | Frequency of execution | [required] +**TimeZone** | Pointer to **String** | Time zone identifier | [optional] +**WeeklyDays** | Pointer to **[]String** | Scheduled days of the week for execution | [optional] +**WeeklyTimes** | Pointer to **[]String** | Scheduled execution times | [optional] + +## Examples + +- Prepare the resource +```powershell +$ScheduledAttributes = Initialize-PSSailpoint.V3ScheduledAttributes -CronString 0 9 * * 1 ` + -Frequency null ` + -TimeZone America/Chicago ` + -WeeklyDays Monday ` + -WeeklyTimes Monday +``` + +- Convert the resource to JSON +```powershell +$ScheduledAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ScheduledSearch.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ScheduledSearch.md new file mode 100644 index 000000000..3a21afc79 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ScheduledSearch.md @@ -0,0 +1,59 @@ +--- +id: scheduled-search +title: ScheduledSearch +pagination_label: ScheduledSearch +sidebar_label: ScheduledSearch +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledSearch', 'ScheduledSearch'] +slug: /tools/sdk/powershell/v3/models/scheduled-search +tags: ['SDK', 'Software Development Kit', 'ScheduledSearch', 'ScheduledSearch'] +--- + + +# ScheduledSearch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the scheduled search. | [optional] +**Description** | Pointer to **String** | The description of the scheduled search. | [optional] +**SavedSearchId** | **String** | The ID of the saved search that will be executed. | [required] +**Created** | Pointer to **System.DateTime** | The date the scheduled search was initially created. | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | The last date the scheduled search was modified. | [optional] [readonly] +**Schedule** | [**Schedule1**](schedule1) | | [required] +**Recipients** | [**[]SearchScheduleRecipientsInner**](search-schedule-recipients-inner) | A list of identities that should receive the scheduled search report via email. | [required] +**Enabled** | Pointer to **Boolean** | Indicates if the scheduled search is enabled. | [optional] [default to $false] +**EmailEmptyResults** | Pointer to **Boolean** | Indicates if email generation should occur when search returns no results. | [optional] [default to $false] +**DisplayQueryDetails** | Pointer to **Boolean** | Indicates if the generated email should include the query and search results preview (which could include PII). | [optional] [default to $false] +**Id** | **String** | The scheduled search ID. | [required][readonly] +**Owner** | [**ScheduledSearchAllOfOwner**](scheduled-search-all-of-owner) | | [required] +**OwnerId** | **String** | The ID of the scheduled search owner. Please use the `id` in the `owner` object instead. | [required][readonly] + +## Examples + +- Prepare the resource +```powershell +$ScheduledSearch = Initialize-PSSailpoint.V3ScheduledSearch -Name Daily disabled accounts ` + -Description Daily disabled accounts ` + -SavedSearchId 554f1511-f0a1-4744-ab14-599514d3e57c ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Schedule null ` + -Recipients null ` + -Enabled false ` + -EmailEmptyResults false ` + -DisplayQueryDetails false ` + -Id 0de46054-fe90-434a-b84e-c6b3359d0c64 ` + -Owner null ` + -OwnerId 2c9180867624cbd7017642d8c8c81f67 +``` + +- Convert the resource to JSON +```powershell +$ScheduledSearch | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ScheduledSearchAllOfOwner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ScheduledSearchAllOfOwner.md new file mode 100644 index 000000000..1e7818883 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ScheduledSearchAllOfOwner.md @@ -0,0 +1,37 @@ +--- +id: scheduled-search-all-of-owner +title: ScheduledSearchAllOfOwner +pagination_label: ScheduledSearchAllOfOwner +sidebar_label: ScheduledSearchAllOfOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledSearchAllOfOwner', 'ScheduledSearchAllOfOwner'] +slug: /tools/sdk/powershell/v3/models/scheduled-search-all-of-owner +tags: ['SDK', 'Software Development Kit', 'ScheduledSearchAllOfOwner', 'ScheduledSearchAllOfOwner'] +--- + + +# ScheduledSearchAllOfOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | The type of object being referenced | [required] +**Id** | **String** | The ID of the referenced object | [required] + +## Examples + +- Prepare the resource +```powershell +$ScheduledSearchAllOfOwner = Initialize-PSSailpoint.V3ScheduledSearchAllOfOwner -Type IDENTITY ` + -Id 2c9180867624cbd7017642d8c8c81f67 +``` + +- Convert the resource to JSON +```powershell +$ScheduledSearchAllOfOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ScheduledSearchName.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ScheduledSearchName.md new file mode 100644 index 000000000..811b74a91 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ScheduledSearchName.md @@ -0,0 +1,37 @@ +--- +id: scheduled-search-name +title: ScheduledSearchName +pagination_label: ScheduledSearchName +sidebar_label: ScheduledSearchName +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledSearchName', 'ScheduledSearchName'] +slug: /tools/sdk/powershell/v3/models/scheduled-search-name +tags: ['SDK', 'Software Development Kit', 'ScheduledSearchName', 'ScheduledSearchName'] +--- + + +# ScheduledSearchName + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the scheduled search. | [optional] +**Description** | Pointer to **String** | The description of the scheduled search. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ScheduledSearchName = Initialize-PSSailpoint.V3ScheduledSearchName -Name Daily disabled accounts ` + -Description Daily disabled accounts +``` + +- Convert the resource to JSON +```powershell +$ScheduledSearchName | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Schema.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Schema.md new file mode 100644 index 000000000..1c609010d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Schema.md @@ -0,0 +1,57 @@ +--- +id: schema +title: Schema +pagination_label: Schema +sidebar_label: Schema +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Schema', 'Schema'] +slug: /tools/sdk/powershell/v3/models/schema +tags: ['SDK', 'Software Development Kit', 'Schema', 'Schema'] +--- + + +# Schema + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The id of the Schema. | [optional] +**Name** | Pointer to **String** | The name of the Schema. | [optional] +**NativeObjectType** | Pointer to **String** | The name of the object type on the native system that the schema represents. | [optional] +**IdentityAttribute** | Pointer to **String** | The name of the attribute used to calculate the unique identifier for an object in the schema. | [optional] +**DisplayAttribute** | Pointer to **String** | The name of the attribute used to calculate the display value for an object in the schema. | [optional] +**HierarchyAttribute** | Pointer to **String** | The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. | [optional] +**IncludePermissions** | Pointer to **Boolean** | Flag indicating whether or not the include permissions with the object data when aggregating the schema. | [optional] +**Features** | Pointer to **[]String** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**Configuration** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Holds any extra configuration data that the schema may require. | [optional] +**Attributes** | Pointer to [**[]AttributeDefinition**](attribute-definition) | The attribute definitions which form the schema. | [optional] +**Created** | Pointer to **System.DateTime** | The date the Schema was created. | [optional] +**Modified** | Pointer to **System.DateTime** | The date the Schema was last modified. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Schema = Initialize-PSSailpoint.V3Schema -Id 2c9180835d191a86015d28455b4a2329 ` + -Name account ` + -NativeObjectType User ` + -IdentityAttribute sAMAccountName ` + -DisplayAttribute distinguishedName ` + -HierarchyAttribute memberOf ` + -IncludePermissions false ` + -Features [PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS] ` + -Configuration {groupMemberAttribute=member} ` + -Attributes [{name=sAMAccountName, type=STRING, isMultiValued=false, isEntitlement=false, isGroup=false}, {name=memberOf, type=STRING, schema={type=CONNECTOR_SCHEMA, id=2c9180887671ff8c01767b4671fc7d60, name=group}, description=Group membership, isMultiValued=true, isEntitlement=true, isGroup=true}] ` + -Created 2019-12-24T22:32:58.104Z ` + -Modified 2019-12-31T20:22:28.104Z +``` + +- Convert the resource to JSON +```powershell +$Schema | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Search.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Search.md new file mode 100644 index 000000000..fdb4fe19b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Search.md @@ -0,0 +1,65 @@ +--- +id: search +title: Search +pagination_label: Search +sidebar_label: Search +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Search', 'Search'] +slug: /tools/sdk/powershell/v3/models/search +tags: ['SDK', 'Software Development Kit', 'Search', 'Search'] +--- + + +# Search + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Indices** | Pointer to [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**QueryType** | Pointer to [**QueryType**](query-type) | | [optional] +**QueryVersion** | Pointer to **String** | | [optional] +**Query** | Pointer to [**Query**](query) | | [optional] +**QueryDsl** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The search query using the Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/7.10/query-dsl.html) syntax. | [optional] +**TextQuery** | Pointer to [**TextQuery**](text-query) | | [optional] +**TypeAheadQuery** | Pointer to [**TypeAheadQuery**](type-ahead-query) | | [optional] +**IncludeNested** | Pointer to **Boolean** | Indicates whether nested objects from returned search results should be included. | [optional] [default to $true] +**QueryResultFilter** | Pointer to [**QueryResultFilter**](query-result-filter) | | [optional] +**AggregationType** | Pointer to [**AggregationType**](aggregation-type) | | [optional] +**AggregationsVersion** | Pointer to **String** | | [optional] +**AggregationsDsl** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The aggregation search query using Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) syntax. | [optional] +**Aggregations** | Pointer to [**SearchAggregationSpecification**](search-aggregation-specification) | | [optional] +**Sort** | Pointer to **[]String** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] +**SearchAfter** | Pointer to **[]String** | Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging. For example, when searching for identities, if you are sorting by displayName you will also want to include ID, for example [""displayName"", ""id""]. If the last identity ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last displayName is ""John Doe"", then using that displayName and ID will start a new search after this identity. The searchAfter value will look like [""John Doe"",""2c91808375d8e80a0175e1f88a575221""] | [optional] +**Filters** | Pointer to [**map[string]ModelFilter**](model-filter) | The filters to be applied for each filtered field name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Search = Initialize-PSSailpoint.V3Search -Indices [identities] ` + -QueryType null ` + -QueryVersion null ` + -Query null ` + -QueryDsl {match={name=john.doe}} ` + -TextQuery null ` + -TypeAheadQuery null ` + -IncludeNested true ` + -QueryResultFilter null ` + -AggregationType null ` + -AggregationsVersion null ` + -AggregationsDsl {} ` + -Aggregations null ` + -Sort [displayName, +id] ` + -SearchAfter [John Doe, 2c91808375d8e80a0175e1f88a575221] ` + -Filters {} +``` + +- Convert the resource to JSON +```powershell +$Search | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SearchAggregationSpecification.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SearchAggregationSpecification.md new file mode 100644 index 000000000..737f865f7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SearchAggregationSpecification.md @@ -0,0 +1,43 @@ +--- +id: search-aggregation-specification +title: SearchAggregationSpecification +pagination_label: SearchAggregationSpecification +sidebar_label: SearchAggregationSpecification +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchAggregationSpecification', 'SearchAggregationSpecification'] +slug: /tools/sdk/powershell/v3/models/search-aggregation-specification +tags: ['SDK', 'Software Development Kit', 'SearchAggregationSpecification', 'SearchAggregationSpecification'] +--- + + +# SearchAggregationSpecification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Nested** | Pointer to [**NestedAggregation**](nested-aggregation) | | [optional] +**Metric** | Pointer to [**MetricAggregation**](metric-aggregation) | | [optional] +**VarFilter** | Pointer to [**FilterAggregation**](filter-aggregation) | | [optional] +**Bucket** | Pointer to [**BucketAggregation**](bucket-aggregation) | | [optional] +**SubAggregation** | Pointer to [**SubSearchAggregationSpecification**](sub-search-aggregation-specification) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchAggregationSpecification = Initialize-PSSailpoint.V3SearchAggregationSpecification -Nested null ` + -Metric null ` + -VarFilter null ` + -Bucket null ` + -SubAggregation null +``` + +- Convert the resource to JSON +```powershell +$SearchAggregationSpecification | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SearchArguments.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SearchArguments.md new file mode 100644 index 000000000..c4ab43cef --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SearchArguments.md @@ -0,0 +1,39 @@ +--- +id: search-arguments +title: SearchArguments +pagination_label: SearchArguments +sidebar_label: SearchArguments +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchArguments', 'SearchArguments'] +slug: /tools/sdk/powershell/v3/models/search-arguments +tags: ['SDK', 'Software Development Kit', 'SearchArguments', 'SearchArguments'] +--- + + +# SearchArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ScheduleId** | Pointer to **String** | The ID of the scheduled search that triggered the saved search execution. | [optional] +**Owner** | Pointer to [**TypedReference**](typed-reference) | The owner of the scheduled search being tested. | [optional] +**Recipients** | Pointer to [**[]TypedReference**](typed-reference) | The email recipients of the scheduled search being tested. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchArguments = Initialize-PSSailpoint.V3SearchArguments -ScheduleId 7a724640-0c17-4ce9-a8c3-4a89738459c8 ` + -Owner null ` + -Recipients null +``` + +- Convert the resource to JSON +```powershell +$SearchArguments | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SearchAttributeConfig.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SearchAttributeConfig.md new file mode 100644 index 000000000..75247c838 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SearchAttributeConfig.md @@ -0,0 +1,39 @@ +--- +id: search-attribute-config +title: SearchAttributeConfig +pagination_label: SearchAttributeConfig +sidebar_label: SearchAttributeConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchAttributeConfig', 'SearchAttributeConfig'] +slug: /tools/sdk/powershell/v3/models/search-attribute-config +tags: ['SDK', 'Software Development Kit', 'SearchAttributeConfig', 'SearchAttributeConfig'] +--- + + +# SearchAttributeConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Name of the new attribute | [optional] +**DisplayName** | Pointer to **String** | The display name of the new attribute | [optional] +**ApplicationAttributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Map of application id and their associated attribute. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchAttributeConfig = Initialize-PSSailpoint.V3SearchAttributeConfig -Name newMailAttribute ` + -DisplayName New Mail Attribute ` + -ApplicationAttributes {2c91808b79fd2422017a0b35d30f3968=employeeNumber, 2c91808b79fd2422017a0b36008f396b=employeeNumber} +``` + +- Convert the resource to JSON +```powershell +$SearchAttributeConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SearchDocument.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SearchDocument.md new file mode 100644 index 000000000..449d27684 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SearchDocument.md @@ -0,0 +1,169 @@ +--- +id: search-document +title: SearchDocument +pagination_label: SearchDocument +sidebar_label: SearchDocument +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchDocument', 'SearchDocument'] +slug: /tools/sdk/powershell/v3/models/search-document +tags: ['SDK', 'Software Development Kit', 'SearchDocument', 'SearchDocument'] +--- + + +# SearchDocument + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the referenced object. | [required] +**Name** | **String** | The human readable name of the referenced object. | [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** | [**DocumentType**](document-type) | | [required] +**Source** | Pointer to [**IdentityDocumentAllOfSource**](identity-document-all-of-source) | | [optional] +**Entitlements** | Pointer to [**[]BaseEntitlement**](base-entitlement) | Entitlements included with the role. | [optional] +**EntitlementCount** | Pointer to **Int32** | Number of entitlements included with the role. | [optional] +**Tags** | Pointer to **[]String** | Tags that have been applied to the object. | [optional] +**Action** | Pointer to **String** | Name of the event as it's displayed in audit reports. | [optional] +**Stage** | Pointer to **String** | Activity's current stage. | [optional] +**Origin** | Pointer to **String** | Activity's origin. | [optional] +**Status** | Pointer to **String** | Identity's status in SailPoint. | [optional] +**Requester** | Pointer to [**AccountSource**](account-source) | | [optional] +**Recipient** | Pointer to [**AccountSource**](account-source) | | [optional] +**TrackingNumber** | Pointer to **String** | ID of the group of events. | [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] +**DisplayName** | Pointer to **String** | Identity's display name. | [optional] +**Segments** | Pointer to [**[]BaseSegment**](base-segment) | Segments with the role. | [optional] +**SegmentCount** | Pointer to **Int32** | Number of segments with the role. | [optional] +**CloudGoverned** | Pointer to **Boolean** | Indicates whether the entitlement is cloud governed. | [optional] [default to $false] +**Privileged** | Pointer to **Boolean** | Indicates whether the entitlement is privileged. | [optional] [default to $false] +**IdentityCount** | Pointer to **Int32** | Number of identities who have access to the entitlement. | [optional] +**Type** | Pointer to **String** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional] +**Actor** | Pointer to **String** | Name of the actor that generated the event. | [optional] +**Target** | Pointer to **String** | Name of the target, or recipient, of the event. | [optional] +**Stack** | Pointer to **String** | The event's stack. | [optional] +**IpAddress** | Pointer to **String** | Target system's IP address. | [optional] +**Details** | Pointer to **String** | ID of event's details. | [optional] +**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Map or dictionary of key/value pairs. | [optional] +**Objects** | Pointer to **[]String** | Objects the event is happening to. | [optional] +**Operation** | Pointer to **String** | Operation, or action, performed during the event. | [optional] +**TechnicalName** | Pointer to **String** | Event's normalized name. This normalized name always follows the pattern of 'objects_operation_status'. | [optional] +**FirstName** | Pointer to **String** | Identity's first name. | [optional] +**LastName** | Pointer to **String** | Identity's last name. | [optional] +**Email** | Pointer to **String** | Identity's primary email address. | [optional] +**Phone** | Pointer to **String** | Identity's phone number. | [optional] +**Inactive** | Pointer to **Boolean** | Indicates whether the identity is inactive. | [optional] [default to $false] +**Protected** | Pointer to **Boolean** | Indicates whether the identity is protected. | [optional] [default to $false] +**EmployeeNumber** | Pointer to **String** | Identity's employee number. | [optional] +**Manager** | Pointer to [**IdentityDocumentAllOfManager**](identity-document-all-of-manager) | | [optional] +**IsManager** | Pointer to **Boolean** | Indicates whether the identity is a manager of other identities. | [optional] +**IdentityProfile** | Pointer to [**IdentityDocumentAllOfIdentityProfile**](identity-document-all-of-identity-profile) | | [optional] +**ProcessingState** | Pointer to **String** | Identity's processing state. | [optional] +**ProcessingDetails** | Pointer to [**ProcessingDetails**](processing-details) | | [optional] +**Accounts** | Pointer to [**[]BaseAccount**](base-account) | List of accounts associated with the identity. | [optional] +**AccountCount** | Pointer to **Int32** | Number of accounts associated with the identity. | [optional] +**Apps** | Pointer to [**[]App**](app) | List of applications the identity has access to. | [optional] +**AppCount** | Pointer to **Int32** | Number of applications the identity has access to. | [optional] +**Access** | Pointer to [**[]IdentityAccess**](identity-access) | List of access items assigned to the identity. | [optional] +**AccessCount** | Pointer to **Int32** | Number of access items assigned to the identity. | [optional] +**RoleCount** | Pointer to **Int32** | Number of roles assigned to the identity. | [optional] +**AccessProfileCount** | Pointer to **Int32** | Number of access profiles included with the role. | [optional] +**Owns** | Pointer to [**[]Owns**](owns) | Access items the identity owns. | [optional] +**OwnsCount** | Pointer to **Int32** | Number of access items the identity owns. | [optional] +**AccessProfiles** | Pointer to [**[]BaseAccessProfile**](base-access-profile) | Access profiles included with the role. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchDocument = Initialize-PSSailpoint.V3SearchDocument -Id 2c91808568c529c60168cca6f90c1313 ` + -Name John Doe ` + -Description The admin role ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Synced 2018-06-25T20:22:33.104Z ` + -Enabled true ` + -Requestable true ` + -RequestCommentsRequired false ` + -Owner null ` + -Type null ` + -Source null ` + -Entitlements null ` + -EntitlementCount 3 ` + -Tags [TAG_1, TAG_2] ` + -Action update ` + -Stage Completed ` + -Origin null ` + -Status UNREGISTERED ` + -Requester null ` + -Recipient null ` + -TrackingNumber 63f891e0735f4cc8bf1968144a1e7440 ` + -Errors null ` + -Warnings null ` + -Approvals null ` + -OriginalRequests null ` + -ExpansionItems null ` + -AccountRequests null ` + -Sources smartsheet-test, airtable-v4, IdentityNow ` + -DisplayName Carol.Adams ` + -Segments null ` + -SegmentCount 1 ` + -CloudGoverned false ` + -Privileged false ` + -IdentityCount 3 ` + -Type SYSTEM_CONFIG ` + -Actor System ` + -Target Carol.Adams ` + -Stack tpe ` + -IpAddress 52.52.97.85 ` + -Details 73b65dfbed1842548c207432a18c84b0 ` + -Attributes {country=US, firstname=Carol, cloudStatus=UNREGISTERED} ` + -Objects null ` + -Operation REQUEST ` + -TechnicalName AUTHENTICATION_REQUEST_PASSED ` + -FirstName Carol ` + -LastName Adams ` + -Email Carol.Adams@sailpointdemo.com ` + -Phone +1 440-527-3672 ` + -Inactive false ` + -Protected false ` + -EmployeeNumber 1a2a3d4e ` + -Manager null ` + -IsManager false ` + -IdentityProfile null ` + -ProcessingState null ` + -ProcessingDetails null ` + -Accounts null ` + -AccountCount 3 ` + -Apps null ` + -AppCount 2 ` + -Access null ` + -AccessCount 5 ` + -RoleCount 1 ` + -AccessProfileCount 1 ` + -Owns null ` + -OwnsCount 5 ` + -AccessProfiles null +``` + +- Convert the resource to JSON +```powershell +$SearchDocument | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SearchExportReportArguments.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SearchExportReportArguments.md new file mode 100644 index 000000000..5573facde --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SearchExportReportArguments.md @@ -0,0 +1,41 @@ +--- +id: search-export-report-arguments +title: SearchExportReportArguments +pagination_label: SearchExportReportArguments +sidebar_label: SearchExportReportArguments +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchExportReportArguments', 'SearchExportReportArguments'] +slug: /tools/sdk/powershell/v3/models/search-export-report-arguments +tags: ['SDK', 'Software Development Kit', 'SearchExportReportArguments', 'SearchExportReportArguments'] +--- + + +# SearchExportReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Indices** | Pointer to [**[]Index**](index) | The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. | [optional] +**Query** | **String** | The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. | [required] +**Columns** | Pointer to **String** | Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. | [optional] +**Sort** | Pointer to **[]String** | The fields to be used to sort the search results. Use + or - to specify the sort direction. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchExportReportArguments = Initialize-PSSailpoint.V3SearchExportReportArguments -Indices [entitlements] ` + -Query name:a* ` + -Columns displayName,firstName,lastName,email,created,attributes.cloudLifecycleState ` + -Sort [displayName, +id] +``` + +- Convert the resource to JSON +```powershell +$SearchExportReportArguments | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SearchFilterType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SearchFilterType.md new file mode 100644 index 000000000..be260588f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SearchFilterType.md @@ -0,0 +1,22 @@ +--- +id: search-filter-type +title: SearchFilterType +pagination_label: SearchFilterType +sidebar_label: SearchFilterType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchFilterType', 'SearchFilterType'] +slug: /tools/sdk/powershell/v3/models/search-filter-type +tags: ['SDK', 'Software Development Kit', 'SearchFilterType', 'SearchFilterType'] +--- + + +# SearchFilterType + +## Enum + + +* `TERM` (value: `"TERM"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SearchSchedule.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SearchSchedule.md new file mode 100644 index 000000000..a3d9c14dc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SearchSchedule.md @@ -0,0 +1,49 @@ +--- +id: search-schedule +title: SearchSchedule +pagination_label: SearchSchedule +sidebar_label: SearchSchedule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchSchedule', 'SearchSchedule'] +slug: /tools/sdk/powershell/v3/models/search-schedule +tags: ['SDK', 'Software Development Kit', 'SearchSchedule', 'SearchSchedule'] +--- + + +# SearchSchedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SavedSearchId** | **String** | The ID of the saved search that will be executed. | [required] +**Created** | Pointer to **System.DateTime** | The date the scheduled search was initially created. | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | The last date the scheduled search was modified. | [optional] [readonly] +**Schedule** | [**Schedule1**](schedule1) | | [required] +**Recipients** | [**[]SearchScheduleRecipientsInner**](search-schedule-recipients-inner) | A list of identities that should receive the scheduled search report via email. | [required] +**Enabled** | Pointer to **Boolean** | Indicates if the scheduled search is enabled. | [optional] [default to $false] +**EmailEmptyResults** | Pointer to **Boolean** | Indicates if email generation should occur when search returns no results. | [optional] [default to $false] +**DisplayQueryDetails** | Pointer to **Boolean** | Indicates if the generated email should include the query and search results preview (which could include PII). | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$SearchSchedule = Initialize-PSSailpoint.V3SearchSchedule -SavedSearchId 554f1511-f0a1-4744-ab14-599514d3e57c ` + -Created 2018-06-25T20:22:28.104Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Schedule null ` + -Recipients null ` + -Enabled false ` + -EmailEmptyResults false ` + -DisplayQueryDetails false +``` + +- Convert the resource to JSON +```powershell +$SearchSchedule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SearchScheduleRecipientsInner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SearchScheduleRecipientsInner.md new file mode 100644 index 000000000..885e84639 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SearchScheduleRecipientsInner.md @@ -0,0 +1,37 @@ +--- +id: search-schedule-recipients-inner +title: SearchScheduleRecipientsInner +pagination_label: SearchScheduleRecipientsInner +sidebar_label: SearchScheduleRecipientsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchScheduleRecipientsInner', 'SearchScheduleRecipientsInner'] +slug: /tools/sdk/powershell/v3/models/search-schedule-recipients-inner +tags: ['SDK', 'Software Development Kit', 'SearchScheduleRecipientsInner', 'SearchScheduleRecipientsInner'] +--- + + +# SearchScheduleRecipientsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "IDENTITY" ] | The type of object being referenced | [required] +**Id** | **String** | The ID of the referenced object | [required] + +## Examples + +- Prepare the resource +```powershell +$SearchScheduleRecipientsInner = Initialize-PSSailpoint.V3SearchScheduleRecipientsInner -Type IDENTITY ` + -Id 2c9180867624cbd7017642d8c8c81f67 +``` + +- Convert the resource to JSON +```powershell +$SearchScheduleRecipientsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SectionDetails.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SectionDetails.md new file mode 100644 index 000000000..c9f749cf0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SectionDetails.md @@ -0,0 +1,39 @@ +--- +id: section-details +title: SectionDetails +pagination_label: SectionDetails +sidebar_label: SectionDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SectionDetails', 'SectionDetails'] +slug: /tools/sdk/powershell/v3/models/section-details +tags: ['SDK', 'Software Development Kit', 'SectionDetails', 'SectionDetails'] +--- + + +# SectionDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | Name of the FormItem | [optional] +**Label** | Pointer to **String** | Label of the section | [optional] +**FormItems** | Pointer to [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | List of FormItems. FormItems can be SectionDetails and/or FieldDetails | [optional] + +## Examples + +- Prepare the resource +```powershell +$SectionDetails = Initialize-PSSailpoint.V3SectionDetails -Name Field1 ` + -Label Section 1 ` + -FormItems [] +``` + +- Convert the resource to JSON +```powershell +$SectionDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Segment.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Segment.md new file mode 100644 index 000000000..adb76c618 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Segment.md @@ -0,0 +1,49 @@ +--- +id: segment +title: Segment +pagination_label: Segment +sidebar_label: Segment +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Segment', 'Segment'] +slug: /tools/sdk/powershell/v3/models/segment +tags: ['SDK', 'Software Development Kit', 'Segment', 'Segment'] +--- + + +# Segment + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The segment's ID. | [optional] +**Name** | Pointer to **String** | The segment's business name. | [optional] +**Created** | Pointer to **System.DateTime** | The time when the segment is created. | [optional] +**Modified** | Pointer to **System.DateTime** | The time when the segment is modified. | [optional] +**Description** | Pointer to **String** | The segment's optional description. | [optional] +**Owner** | Pointer to [**OwnerReferenceSegments**](owner-reference-segments) | | [optional] +**VisibilityCriteria** | Pointer to [**SegmentVisibilityCriteria**](segment-visibility-criteria) | | [optional] +**Active** | Pointer to **Boolean** | This boolean indicates whether the segment is currently active. Inactive segments have no effect. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$Segment = Initialize-PSSailpoint.V3Segment -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -Name segment-xyz ` + -Created 2020-01-01T00:00Z ` + -Modified 2020-01-01T00:00Z ` + -Description This segment represents xyz ` + -Owner null ` + -VisibilityCriteria null ` + -Active true +``` + +- Convert the resource to JSON +```powershell +$Segment | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SegmentVisibilityCriteria.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SegmentVisibilityCriteria.md new file mode 100644 index 000000000..d1ec6e9b7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SegmentVisibilityCriteria.md @@ -0,0 +1,35 @@ +--- +id: segment-visibility-criteria +title: SegmentVisibilityCriteria +pagination_label: SegmentVisibilityCriteria +sidebar_label: SegmentVisibilityCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SegmentVisibilityCriteria', 'SegmentVisibilityCriteria'] +slug: /tools/sdk/powershell/v3/models/segment-visibility-criteria +tags: ['SDK', 'Software Development Kit', 'SegmentVisibilityCriteria', 'SegmentVisibilityCriteria'] +--- + + +# SegmentVisibilityCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Expression** | Pointer to [**Expression**](expression) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SegmentVisibilityCriteria = Initialize-PSSailpoint.V3SegmentVisibilityCriteria -Expression null +``` + +- Convert the resource to JSON +```powershell +$SegmentVisibilityCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Selector.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Selector.md new file mode 100644 index 000000000..3eb32a38d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Selector.md @@ -0,0 +1,39 @@ +--- +id: selector +title: Selector +pagination_label: Selector +sidebar_label: Selector +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Selector', 'Selector'] +slug: /tools/sdk/powershell/v3/models/selector +tags: ['SDK', 'Software Development Kit', 'Selector', 'Selector'] +--- + + +# Selector + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**SelectorType**](selector-type) | | [required] +**Values** | **[]String** | The selected values. | [required] +**Interval** | Pointer to **Int32** | The selected interval for RANGE selectors. | [optional] + +## Examples + +- Prepare the resource +```powershell +$Selector = Initialize-PSSailpoint.V3Selector -Type null ` + -Values [MON, WED] ` + -Interval 3 +``` + +- Convert the resource to JSON +```powershell +$Selector | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SelectorType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SelectorType.md new file mode 100644 index 000000000..f7d96c10b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SelectorType.md @@ -0,0 +1,24 @@ +--- +id: selector-type +title: SelectorType +pagination_label: SelectorType +sidebar_label: SelectorType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SelectorType', 'SelectorType'] +slug: /tools/sdk/powershell/v3/models/selector-type +tags: ['SDK', 'Software Development Kit', 'SelectorType', 'SelectorType'] +--- + + +# SelectorType + +## Enum + + +* `LIST` (value: `"LIST"`) + +* `RANGE` (value: `"RANGE"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SendTokenRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SendTokenRequest.md new file mode 100644 index 000000000..0970e6746 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SendTokenRequest.md @@ -0,0 +1,37 @@ +--- +id: send-token-request +title: SendTokenRequest +pagination_label: SendTokenRequest +sidebar_label: SendTokenRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SendTokenRequest', 'SendTokenRequest'] +slug: /tools/sdk/powershell/v3/models/send-token-request +tags: ['SDK', 'Software Development Kit', 'SendTokenRequest', 'SendTokenRequest'] +--- + + +# SendTokenRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**UserAlias** | **String** | User alias from table spt_identity field named 'name' | [required] +**DeliveryType** | **Enum** [ "SMS_PERSONAL", "VOICE_PERSONAL", "SMS_WORK", "VOICE_WORK", "EMAIL_WORK", "EMAIL_PERSONAL" ] | Token delivery type | [required] + +## Examples + +- Prepare the resource +```powershell +$SendTokenRequest = Initialize-PSSailpoint.V3SendTokenRequest -UserAlias will.albin ` + -DeliveryType EMAIL_WORK +``` + +- Convert the resource to JSON +```powershell +$SendTokenRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SendTokenResponse.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SendTokenResponse.md new file mode 100644 index 000000000..2c516470c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SendTokenResponse.md @@ -0,0 +1,39 @@ +--- +id: send-token-response +title: SendTokenResponse +pagination_label: SendTokenResponse +sidebar_label: SendTokenResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SendTokenResponse', 'SendTokenResponse'] +slug: /tools/sdk/powershell/v3/models/send-token-response +tags: ['SDK', 'Software Development Kit', 'SendTokenResponse', 'SendTokenResponse'] +--- + + +# SendTokenResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | Pointer to **String** | The token request ID | [optional] +**Status** | Pointer to **Enum** [ "SUCCESS", "FAILED" ] | Status of sending token | [optional] +**ErrorMessage** | Pointer to **String** | Error messages from token send request | [optional] + +## Examples + +- Prepare the resource +```powershell +$SendTokenResponse = Initialize-PSSailpoint.V3SendTokenResponse -RequestId 089899f13a8f4da7824996191587bab9 ` + -Status SUCCESS ` + -ErrorMessage Unable to sent text message +``` + +- Convert the resource to JSON +```powershell +$SendTokenResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ServiceDeskIntegrationDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ServiceDeskIntegrationDto.md new file mode 100644 index 000000000..29564d897 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ServiceDeskIntegrationDto.md @@ -0,0 +1,59 @@ +--- +id: service-desk-integration-dto +title: ServiceDeskIntegrationDto +pagination_label: ServiceDeskIntegrationDto +sidebar_label: ServiceDeskIntegrationDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskIntegrationDto', 'ServiceDeskIntegrationDto'] +slug: /tools/sdk/powershell/v3/models/service-desk-integration-dto +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationDto', 'ServiceDeskIntegrationDto'] +--- + + +# ServiceDeskIntegrationDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Unique identifier for the Service Desk integration | [optional] +**Name** | **String** | Service Desk integration's name. The name must be unique. | [required] +**Created** | Pointer to **System.DateTime** | The date and time the Service Desk integration was created | [optional] +**Modified** | Pointer to **System.DateTime** | The date and time the Service Desk integration was last modified | [optional] +**Description** | **String** | Service Desk integration's description. | [required] +**Type** | **String** | Service Desk integration types: - ServiceNowSDIM - ServiceNow | [required][default to "ServiceNowSDIM"] +**OwnerRef** | Pointer to [**OwnerDto**](owner-dto) | | [optional] +**ClusterRef** | Pointer to [**SourceClusterDto**](source-cluster-dto) | | [optional] +**Cluster** | Pointer to **String** | Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). | [optional] +**ManagedSources** | Pointer to **[]String** | Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). | [optional] +**ProvisioningConfig** | Pointer to [**ProvisioningConfig**](provisioning-config) | | [optional] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Service Desk integration's attributes. Validation constraints enforced by the implementation. | [required] +**BeforeProvisioningRule** | Pointer to [**BeforeProvisioningRuleDto**](before-provisioning-rule-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ServiceDeskIntegrationDto = Initialize-PSSailpoint.V3ServiceDeskIntegrationDto -Id 62945a496ef440189b1f03e3623411c8 ` + -Name Service Desk Integration Name ` + -Created 2024-01-17T18:45:25.994Z ` + -Modified 2024-02-18T18:45:25.994Z ` + -Description A very nice Service Desk integration ` + -Type ServiceNowSDIM ` + -OwnerRef null ` + -ClusterRef null ` + -Cluster xyzzy999 ` + -ManagedSources [2c9180835d191a86015d28455b4a2329, 2c5680835d191a85765d28455b4a9823] ` + -ProvisioningConfig null ` + -Attributes {property=value, key=value} ` + -BeforeProvisioningRule null +``` + +- Convert the resource to JSON +```powershell +$ServiceDeskIntegrationDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ServiceDeskIntegrationTemplateDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ServiceDeskIntegrationTemplateDto.md new file mode 100644 index 000000000..84ff42e58 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ServiceDeskIntegrationTemplateDto.md @@ -0,0 +1,47 @@ +--- +id: service-desk-integration-template-dto +title: ServiceDeskIntegrationTemplateDto +pagination_label: ServiceDeskIntegrationTemplateDto +sidebar_label: ServiceDeskIntegrationTemplateDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskIntegrationTemplateDto', 'ServiceDeskIntegrationTemplateDto'] +slug: /tools/sdk/powershell/v3/models/service-desk-integration-template-dto +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationTemplateDto', 'ServiceDeskIntegrationTemplateDto'] +--- + + +# ServiceDeskIntegrationTemplateDto + +## Properties + +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] +**Type** | **String** | The 'type' property specifies the type of the Service Desk integration template. | [required][default to "Web Service SDIM"] +**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template. | [required] +**ProvisioningConfig** | [**ProvisioningConfig**](provisioning-config) | | [required] + +## Examples + +- Prepare the resource +```powershell +$ServiceDeskIntegrationTemplateDto = Initialize-PSSailpoint.V3ServiceDeskIntegrationTemplateDto -Id id12345 ` + -Name aName ` + -Created 2015-05-28T14:07:17Z ` + -Modified 2015-05-28T14:07:17Z ` + -Type Web Service SDIM ` + -Attributes {property=value, key=value} ` + -ProvisioningConfig null +``` + +- Convert the resource to JSON +```powershell +$ServiceDeskIntegrationTemplateDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ServiceDeskIntegrationTemplateType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ServiceDeskIntegrationTemplateType.md new file mode 100644 index 000000000..dadfe2a17 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ServiceDeskIntegrationTemplateType.md @@ -0,0 +1,39 @@ +--- +id: service-desk-integration-template-type +title: ServiceDeskIntegrationTemplateType +pagination_label: ServiceDeskIntegrationTemplateType +sidebar_label: ServiceDeskIntegrationTemplateType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskIntegrationTemplateType', 'ServiceDeskIntegrationTemplateType'] +slug: /tools/sdk/powershell/v3/models/service-desk-integration-template-type +tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationTemplateType', 'ServiceDeskIntegrationTemplateType'] +--- + + +# ServiceDeskIntegrationTemplateType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | This is the name of the type. | [optional] +**Type** | **String** | This is the type value for the type. | [required] +**ScriptName** | **String** | This is the scriptName attribute value for the type. | [required] + +## Examples + +- Prepare the resource +```powershell +$ServiceDeskIntegrationTemplateType = Initialize-PSSailpoint.V3ServiceDeskIntegrationTemplateType -Name aName ` + -Type aType ` + -ScriptName aScriptName +``` + +- Convert the resource to JSON +```powershell +$ServiceDeskIntegrationTemplateType | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ServiceDeskSource.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ServiceDeskSource.md new file mode 100644 index 000000000..d172c9733 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ServiceDeskSource.md @@ -0,0 +1,39 @@ +--- +id: service-desk-source +title: ServiceDeskSource +pagination_label: ServiceDeskSource +sidebar_label: ServiceDeskSource +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskSource', 'ServiceDeskSource'] +slug: /tools/sdk/powershell/v3/models/service-desk-source +tags: ['SDK', 'Software Development Kit', 'ServiceDeskSource', 'ServiceDeskSource'] +--- + + +# ServiceDeskSource + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "SOURCE" ] | DTO type of source for service desk integration template. | [optional] +**Id** | Pointer to **String** | ID of source for service desk integration template. | [optional] +**Name** | Pointer to **String** | Human-readable name of source for service desk integration template. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ServiceDeskSource = Initialize-PSSailpoint.V3ServiceDeskSource -Type SOURCE ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name HR Active Directory +``` + +- Convert the resource to JSON +```powershell +$ServiceDeskSource | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ServiceProviderConfiguration.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ServiceProviderConfiguration.md new file mode 100644 index 000000000..dab76a60b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ServiceProviderConfiguration.md @@ -0,0 +1,41 @@ +--- +id: service-provider-configuration +title: ServiceProviderConfiguration +pagination_label: ServiceProviderConfiguration +sidebar_label: ServiceProviderConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceProviderConfiguration', 'ServiceProviderConfiguration'] +slug: /tools/sdk/powershell/v3/models/service-provider-configuration +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfiguration', 'ServiceProviderConfiguration'] +--- + + +# ServiceProviderConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | Pointer to **Boolean** | This determines whether or not the SAML authentication flow is enabled for an org | [optional] [default to $false] +**BypassIdp** | Pointer to **Boolean** | This allows basic login with the parameter prompt=true. This is often toggled on when debugging SAML authentication setup. When false, only org admins with MFA-enabled can bypass the IDP. | [optional] [default to $false] +**SamlConfigurationValid** | Pointer to **Boolean** | This indicates whether or not the SAML configuration is valid. | [optional] [default to $false] +**FederationProtocolDetails** | Pointer to [**[]ServiceProviderConfigurationFederationProtocolDetailsInner**](service-provider-configuration-federation-protocol-details-inner) | A list of the abstract implementations of the Federation Protocol details. Typically, this will include on SpDetails object and one IdpDetails object used in tandem to define a SAML integration between a customer's identity provider and a customer's SailPoint instance (i.e., the service provider). | [optional] + +## Examples + +- Prepare the resource +```powershell +$ServiceProviderConfiguration = Initialize-PSSailpoint.V3ServiceProviderConfiguration -Enabled true ` + -BypassIdp true ` + -SamlConfigurationValid true ` + -FederationProtocolDetails [{role=SAML_IDP, entityId=http://www.okta.com/exktq4o24bmQA4fr60h7, cert=MIIDpDCCAoygAwIBAgIGAYhZ+b29MA0GCSqGSIb3DQEBCwUAMIGSMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEzARBgNVBAMMCmRldi0yMDY0NDUxHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMjMwNTI2MjEzMDU5WhcNMzMwNTI2MjEzMTU5WjCBkjELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRMwEQYDVQQDDApkZXYtMjA2NDQ1MRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwvi1+WbF2ceGlLCrLl5PrG1lpj04IsrHX6OE666ObC2WFh+Nxvpxy+Vmzon9c9+akhK3bTv+9ifEoVc6tA1qWuCfXISAn9g81JqI68I1PGUbe6eF8pmOA18rjOrt7x94k4QukpR3+I8DfPJ+TynatltB51laLb8H4jchMafA4rDTjV/ZiYPxV0LMEIbprVyGuvBEhiEWha3wwVdDuJq996okX36YNS8PcGH+5CJ8c3YWZp/wrspgJmfCooMXeV+6zBpZfXqPpMWlUo0gcZqDOFgy3r4vkXehJdVYRlInMfDv04Lvy8VI1YAZClG/duO/6o9YVUFLjD9s+mQfhgaF5wIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQB1CTrA/pTHkarbhMHsdSFAjVoYWwdAfrssG99rIjwwr/CW9tavTC3keaoUmUeddcnLY4V/TfL07+xgQGHCBR88cnzG9h6rC9qWxt6C3nug3YDVQfkdCDgnW9A8QEvLeq/KVLoRccpJNEENb2Y5ESUXHi1+PtjkFBtvfSgZ4eEhVggirL0bJdWVm700hCnjb2iCGSbSX7WflfPi0GSmjht983caG9OwZDnDzNFt8qGWCxo4bNSThT00JnWEN/6f1BWNOt9YDrxqEyNclqhLL+RDqFsPBFIrQlsoXzqpWqCL8oS9UMNxbGATK2v3d5ueE9+SswBAFBhirCuqZw19Ri2W, loginUrlPost=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, loginUrlRedirect=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, logoutUrl=https://dev-206445.oktapreview.com/login/signout, nameId=urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, binding=urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST, authnContext=urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport, includeAuthnContext=true, mappingAttribute=email, jitConfiguration={enabled=true, sourceId=2c9180897427f3a501745042afc83144, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email}}, certificateExpirationDate=Thu May 26 21:31:59 GMT 2033, certificateName=EMAILADDRESS=info@okta.com, CN=dev-206445, OU=SSOProvider, O=Okta, L=San Francisco, ST=California, C=US}, {role=SAML_SP, entityId=https://acme.identitysoon.com/sp, alias=acme-sp, callbackUrl=https://acme.test-login.sailpoint.com/saml/SSO/alias/acme-sp, legacyAcsUrl=https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp}] +``` + +- Convert the resource to JSON +```powershell +$ServiceProviderConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md new file mode 100644 index 000000000..0603962ae --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md @@ -0,0 +1,65 @@ +--- +id: service-provider-configuration-federation-protocol-details-inner +title: ServiceProviderConfigurationFederationProtocolDetailsInner +pagination_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'ServiceProviderConfigurationFederationProtocolDetailsInner'] +slug: /tools/sdk/powershell/v3/models/service-provider-configuration-federation-protocol-details-inner +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'ServiceProviderConfigurationFederationProtocolDetailsInner'] +--- + + +# ServiceProviderConfigurationFederationProtocolDetailsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | Pointer to **Enum** [ "SAML_SP" ] | Federation protocol role | [optional] +**EntityId** | Pointer to **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**Binding** | Pointer to **String** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**AuthContext** | Pointer to **String** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**LogoutUrl** | Pointer to **String** | The IDP logout URL. Used with IDP configurations. | [optional] +**IncludeAuthContext** | Pointer to **Boolean** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to $false] +**NameId** | Pointer to **String** | The name id format to use. Used with IDP configurations. | [optional] +**JitConfiguration** | Pointer to [**JITConfiguration**](jit-configuration) | | [optional] +**Cert** | Pointer to **String** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**LoginUrlPost** | Pointer to **String** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**LoginUrlRedirect** | Pointer to **String** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**MappingAttribute** | Pointer to **String** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [optional] +**CertificateExpirationDate** | Pointer to **String** | The expiration date extracted from the certificate. | [optional] +**CertificateName** | Pointer to **String** | The name extracted from the certificate. | [optional] +**Alias** | Pointer to **String** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**CallbackUrl** | Pointer to **String** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ServiceProviderConfigurationFederationProtocolDetailsInner = Initialize-PSSailpoint.V3ServiceProviderConfigurationFederationProtocolDetailsInner -Role SAML_SP ` + -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 ` + -Binding urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST ` + -AuthContext urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport ` + -LogoutUrl https://dev-206445.oktapreview.com/login/signout ` + -IncludeAuthContext false ` + -NameId urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress ` + -JitConfiguration null ` + -Cert -----BEGIN CERTIFICATE-----****-----END CERTIFICATE----- ` + -LoginUrlPost https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` + -LoginUrlRedirect https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` + -MappingAttribute email ` + -CertificateExpirationDate Fri Mar 08 08:54:24 UTC 2013 ` + -CertificateName OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL ` + -Alias acme-sp ` + -CallbackUrl https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp +``` + +- Convert the resource to JSON +```powershell +$ServiceProviderConfigurationFederationProtocolDetailsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SessionConfiguration.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SessionConfiguration.md new file mode 100644 index 000000000..185fe3776 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SessionConfiguration.md @@ -0,0 +1,39 @@ +--- +id: session-configuration +title: SessionConfiguration +pagination_label: SessionConfiguration +sidebar_label: SessionConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SessionConfiguration', 'SessionConfiguration'] +slug: /tools/sdk/powershell/v3/models/session-configuration +tags: ['SDK', 'Software Development Kit', 'SessionConfiguration', 'SessionConfiguration'] +--- + + +# SessionConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxIdleTime** | Pointer to **Int32** | The maximum time in minutes a session can be idle. | [optional] +**RememberMe** | Pointer to **Boolean** | Denotes if 'remember me' is enabled. | [optional] [default to $false] +**MaxSessionTime** | Pointer to **Int32** | The maximum allowable session time in minutes. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SessionConfiguration = Initialize-PSSailpoint.V3SessionConfiguration -MaxIdleTime 15 ` + -RememberMe true ` + -MaxSessionTime 45 +``` + +- Convert the resource to JSON +```powershell +$SessionConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SetLifecycleState200Response.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SetLifecycleState200Response.md new file mode 100644 index 000000000..1ce94432f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SetLifecycleState200Response.md @@ -0,0 +1,35 @@ +--- +id: set-lifecycle-state200-response +title: SetLifecycleState200Response +pagination_label: SetLifecycleState200Response +sidebar_label: SetLifecycleState200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SetLifecycleState200Response', 'SetLifecycleState200Response'] +slug: /tools/sdk/powershell/v3/models/set-lifecycle-state200-response +tags: ['SDK', 'Software Development Kit', 'SetLifecycleState200Response', 'SetLifecycleState200Response'] +--- + + +# SetLifecycleState200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountActivityId** | Pointer to **String** | ID of the IdentityRequest object that is generated when the workflow launches. To follow the IdentityRequest, you can provide this ID with a [Get Account Activity request](https://developer.sailpoint.com/docs/api/v3/get-account-activity/). The response will contain relevant information about the IdentityRequest, such as its status. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SetLifecycleState200Response = Initialize-PSSailpoint.V3SetLifecycleState200Response -AccountActivityId 2c9180837ab5b716017ab7c6c9ef1e20 +``` + +- Convert the resource to JSON +```powershell +$SetLifecycleState200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SetLifecycleStateRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SetLifecycleStateRequest.md new file mode 100644 index 000000000..3f607f860 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SetLifecycleStateRequest.md @@ -0,0 +1,35 @@ +--- +id: set-lifecycle-state-request +title: SetLifecycleStateRequest +pagination_label: SetLifecycleStateRequest +sidebar_label: SetLifecycleStateRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SetLifecycleStateRequest', 'SetLifecycleStateRequest'] +slug: /tools/sdk/powershell/v3/models/set-lifecycle-state-request +tags: ['SDK', 'Software Development Kit', 'SetLifecycleStateRequest', 'SetLifecycleStateRequest'] +--- + + +# SetLifecycleStateRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LifecycleStateId** | Pointer to **String** | ID of the lifecycle state to set. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SetLifecycleStateRequest = Initialize-PSSailpoint.V3SetLifecycleStateRequest -LifecycleStateId 2c9180877a86e408017a8c19fefe046c +``` + +- Convert the resource to JSON +```powershell +$SetLifecycleStateRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SlimCampaign.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SlimCampaign.md new file mode 100644 index 000000000..027406cb5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SlimCampaign.md @@ -0,0 +1,61 @@ +--- +id: slim-campaign +title: SlimCampaign +pagination_label: SlimCampaign +sidebar_label: SlimCampaign +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SlimCampaign', 'SlimCampaign'] +slug: /tools/sdk/powershell/v3/models/slim-campaign +tags: ['SDK', 'Software Development Kit', 'SlimCampaign', 'SlimCampaign'] +--- + + +# SlimCampaign + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Id of the campaign | [optional] [readonly] +**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Deadline** | Pointer to **System.DateTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required] +**EmailNotificationEnabled** | Pointer to **Boolean** | Enables email notification for this campaign | [optional] [default to $false] +**AutoRevokeAllowed** | Pointer to **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] +**RecommendationsEnabled** | Pointer to **Boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to $false] +**Status** | Pointer to **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | Pointer to **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | Pointer to **System.DateTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | Pointer to **Int32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | Pointer to **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$SlimCampaign = Initialize-PSSailpoint.V3SlimCampaign -Id 2c9079b270a266a60170a2779fcb0007 ` + -Name Manager Campaign ` + -Description Everyone needs to be reviewed by their manager ` + -Deadline 2020-03-15T10:00:01.456Z ` + -Type MANAGER ` + -EmailNotificationEnabled false ` + -AutoRevokeAllowed false ` + -RecommendationsEnabled true ` + -Status ACTIVE ` + -CorrelatedStatus CORRELATED ` + -Created 2020-03-03T22:15:13.611Z ` + -TotalCertifications 100 ` + -CompletedCertifications 10 ` + -Alerts null +``` + +- Convert the resource to JSON +```powershell +$SlimCampaign | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SlimDiscoveredApplications.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SlimDiscoveredApplications.md new file mode 100644 index 000000000..b2f74f62e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SlimDiscoveredApplications.md @@ -0,0 +1,51 @@ +--- +id: slim-discovered-applications +title: SlimDiscoveredApplications +pagination_label: SlimDiscoveredApplications +sidebar_label: SlimDiscoveredApplications +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SlimDiscoveredApplications', 'SlimDiscoveredApplications'] +slug: /tools/sdk/powershell/v3/models/slim-discovered-applications +tags: ['SDK', 'Software Development Kit', 'SlimDiscoveredApplications', 'SlimDiscoveredApplications'] +--- + + +# SlimDiscoveredApplications + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Unique identifier for the discovered application. | [optional] +**Name** | Pointer to **String** | Name of the discovered application. | [optional] +**DiscoverySource** | Pointer to **String** | Source from which the application was discovered. | [optional] +**DiscoveredVendor** | Pointer to **String** | The vendor associated with the discovered application. | [optional] +**Description** | Pointer to **String** | A brief description of the discovered application. | [optional] +**RecommendedConnectors** | Pointer to **[]String** | List of recommended connectors for the application. | [optional] +**DiscoveredAt** | Pointer to **System.DateTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] +**CreatedAt** | Pointer to **System.DateTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] +**Status** | Pointer to **String** | The status of an application within the discovery source. By default this field is set to ""ACTIVE"" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to ""INACTIVE"". | [optional] + +## Examples + +- Prepare the resource +```powershell +$SlimDiscoveredApplications = Initialize-PSSailpoint.V3SlimDiscoveredApplications -Id null ` + -Name ExampleApp ` + -DiscoverySource csv ` + -DiscoveredVendor ExampleVendor ` + -Description An application for managing examples. ` + -RecommendedConnectors [ConnectorA, ConnectorB] ` + -DiscoveredAt 2023-01-01T12:00Z ` + -CreatedAt 2023-01-01T12:00Z ` + -Status ACTIVE +``` + +- Convert the resource to JSON +```powershell +$SlimDiscoveredApplications | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodExemptCriteria.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodExemptCriteria.md new file mode 100644 index 000000000..91f61a6b4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodExemptCriteria.md @@ -0,0 +1,41 @@ +--- +id: sod-exempt-criteria +title: SodExemptCriteria +pagination_label: SodExemptCriteria +sidebar_label: SodExemptCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodExemptCriteria', 'SodExemptCriteria'] +slug: /tools/sdk/powershell/v3/models/sod-exempt-criteria +tags: ['SDK', 'Software Development Kit', 'SodExemptCriteria', 'SodExemptCriteria'] +--- + + +# SodExemptCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Existing** | Pointer to **Boolean** | If the entitlement already belonged to the user or not. | [optional] [default to $false] +**Type** | Pointer to [**DtoType**](dto-type) | | [optional] +**Id** | Pointer to **String** | Entitlement ID | [optional] +**Name** | Pointer to **String** | Entitlement name | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodExemptCriteria = Initialize-PSSailpoint.V3SodExemptCriteria -Existing true ` + -Type null ` + -Id 2c918085771e9d3301773b3cb66f6398 ` + -Name My HR Entitlement +``` + +- Convert the resource to JSON +```powershell +$SodExemptCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodPolicy.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodPolicy.md new file mode 100644 index 000000000..0fa2ed26f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodPolicy.md @@ -0,0 +1,69 @@ +--- +id: sod-policy +title: SodPolicy +pagination_label: SodPolicy +sidebar_label: SodPolicy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicy', 'SodPolicy'] +slug: /tools/sdk/powershell/v3/models/sod-policy +tags: ['SDK', 'Software Development Kit', 'SodPolicy', 'SodPolicy'] +--- + + +# SodPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Policy id | [optional] [readonly] +**Name** | Pointer to **String** | Policy Business Name | [optional] +**Created** | Pointer to **System.DateTime** | The time when this SOD policy is created. | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | The time when this SOD policy is modified. | [optional] [readonly] +**Description** | Pointer to **String** | Optional description of the SOD policy | [optional] +**OwnerRef** | Pointer to [**SodPolicyOwnerRef**](sod-policy-owner-ref) | | [optional] +**ExternalPolicyReference** | Pointer to **String** | Optional External Policy Reference | [optional] +**PolicyQuery** | Pointer to **String** | Search query of the SOD policy | [optional] +**CompensatingControls** | Pointer to **String** | Optional compensating controls(Mitigating Controls) | [optional] +**CorrectionAdvice** | Pointer to **String** | Optional correction advice | [optional] +**State** | Pointer to **Enum** [ "ENFORCED", "NOT_ENFORCED" ] | whether the policy is enforced or not | [optional] +**Tags** | Pointer to **[]String** | tags for this policy object | [optional] +**CreatorId** | Pointer to **String** | Policy's creator ID | [optional] [readonly] +**ModifierId** | Pointer to **String** | Policy's modifier ID | [optional] [readonly] +**ViolationOwnerAssignmentConfig** | Pointer to [**ViolationOwnerAssignmentConfig**](violation-owner-assignment-config) | | [optional] +**Scheduled** | Pointer to **Boolean** | defines whether a policy has been scheduled or not | [optional] [default to $false] +**Type** | Pointer to **Enum** [ "GENERAL", "CONFLICTING_ACCESS_BASED" ] | whether a policy is query based or conflicting access based | [optional] [default to "GENERAL"] +**ConflictingAccessCriteria** | Pointer to [**SodPolicyConflictingAccessCriteria**](sod-policy-conflicting-access-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodPolicy = Initialize-PSSailpoint.V3SodPolicy -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -Name policy-xyz ` + -Created 2020-01-01T00:00Z ` + -Modified 2020-01-01T00:00Z ` + -Description This policy ensures compliance of xyz ` + -OwnerRef null ` + -ExternalPolicyReference XYZ policy ` + -PolicyQuery @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf) ` + -CompensatingControls Have a manager review the transaction decisions for their "out of compliance" employee ` + -CorrectionAdvice Based on the role of the employee, managers should remove access that is not required for their job function. ` + -State ENFORCED ` + -Tags [TAG1, TAG2] ` + -CreatorId 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -ModifierId 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -ViolationOwnerAssignmentConfig null ` + -Scheduled true ` + -Type GENERAL ` + -ConflictingAccessCriteria null +``` + +- Convert the resource to JSON +```powershell +$SodPolicy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodPolicyConflictingAccessCriteria.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodPolicyConflictingAccessCriteria.md new file mode 100644 index 000000000..a445b149d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodPolicyConflictingAccessCriteria.md @@ -0,0 +1,37 @@ +--- +id: sod-policy-conflicting-access-criteria +title: SodPolicyConflictingAccessCriteria +pagination_label: SodPolicyConflictingAccessCriteria +sidebar_label: SodPolicyConflictingAccessCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicyConflictingAccessCriteria', 'SodPolicyConflictingAccessCriteria'] +slug: /tools/sdk/powershell/v3/models/sod-policy-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodPolicyConflictingAccessCriteria', 'SodPolicyConflictingAccessCriteria'] +--- + + +# SodPolicyConflictingAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] +**RightCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodPolicyConflictingAccessCriteria = Initialize-PSSailpoint.V3SodPolicyConflictingAccessCriteria -LeftCriteria null ` + -RightCriteria null +``` + +- Convert the resource to JSON +```powershell +$SodPolicyConflictingAccessCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodPolicyDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodPolicyDto.md new file mode 100644 index 000000000..b06e61f25 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodPolicyDto.md @@ -0,0 +1,39 @@ +--- +id: sod-policy-dto +title: SodPolicyDto +pagination_label: SodPolicyDto +sidebar_label: SodPolicyDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicyDto', 'SodPolicyDto'] +slug: /tools/sdk/powershell/v3/models/sod-policy-dto +tags: ['SDK', 'Software Development Kit', 'SodPolicyDto', 'SodPolicyDto'] +--- + + +# SodPolicyDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "SOD_POLICY" ] | SOD policy DTO type. | [optional] +**Id** | Pointer to **String** | SOD policy ID. | [optional] +**Name** | Pointer to **String** | SOD policy display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodPolicyDto = Initialize-PSSailpoint.V3SodPolicyDto -Type SOD_POLICY ` + -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -Name Business SOD Policy +``` + +- Convert the resource to JSON +```powershell +$SodPolicyDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodPolicyOwnerRef.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodPolicyOwnerRef.md new file mode 100644 index 000000000..069a1e808 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodPolicyOwnerRef.md @@ -0,0 +1,39 @@ +--- +id: sod-policy-owner-ref +title: SodPolicyOwnerRef +pagination_label: SodPolicyOwnerRef +sidebar_label: SodPolicyOwnerRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicyOwnerRef', 'SodPolicyOwnerRef'] +slug: /tools/sdk/powershell/v3/models/sod-policy-owner-ref +tags: ['SDK', 'Software Development Kit', 'SodPolicyOwnerRef', 'SodPolicyOwnerRef'] +--- + + +# SodPolicyOwnerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY", "GOVERNANCE_GROUP" ] | Owner type. | [optional] +**Id** | Pointer to **String** | Owner's ID. | [optional] +**Name** | Pointer to **String** | Owner's name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodPolicyOwnerRef = Initialize-PSSailpoint.V3SodPolicyOwnerRef -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Support +``` + +- Convert the resource to JSON +```powershell +$SodPolicyOwnerRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodPolicySchedule.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodPolicySchedule.md new file mode 100644 index 000000000..4152b6259 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodPolicySchedule.md @@ -0,0 +1,51 @@ +--- +id: sod-policy-schedule +title: SodPolicySchedule +pagination_label: SodPolicySchedule +sidebar_label: SodPolicySchedule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicySchedule', 'SodPolicySchedule'] +slug: /tools/sdk/powershell/v3/models/sod-policy-schedule +tags: ['SDK', 'Software Development Kit', 'SodPolicySchedule', 'SodPolicySchedule'] +--- + + +# SodPolicySchedule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | SOD Policy schedule name | [optional] +**Created** | Pointer to **System.DateTime** | The time when this SOD policy schedule is created. | [optional] [readonly] +**Modified** | Pointer to **System.DateTime** | The time when this SOD policy schedule is modified. | [optional] [readonly] +**Description** | Pointer to **String** | SOD Policy schedule description | [optional] +**Schedule** | Pointer to [**Schedule1**](schedule1) | | [optional] +**Recipients** | Pointer to [**[]SodRecipient**](sod-recipient) | | [optional] +**EmailEmptyResults** | Pointer to **Boolean** | Indicates if empty results need to be emailed | [optional] [default to $false] +**CreatorId** | Pointer to **String** | Policy's creator ID | [optional] [readonly] +**ModifierId** | Pointer to **String** | Policy's modifier ID | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$SodPolicySchedule = Initialize-PSSailpoint.V3SodPolicySchedule -Name SCH-1584312283015 ` + -Created 2020-01-01T00:00Z ` + -Modified 2020-01-01T00:00Z ` + -Description Schedule for policy xyz ` + -Schedule null ` + -Recipients null ` + -EmailEmptyResults false ` + -CreatorId 0f11f2a47c944bf3a2bd742580fe3bde ` + -ModifierId 0f11f2a47c944bf3a2bd742580fe3bde +``` + +- Convert the resource to JSON +```powershell +$SodPolicySchedule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodRecipient.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodRecipient.md new file mode 100644 index 000000000..2fd9d2cac --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodRecipient.md @@ -0,0 +1,39 @@ +--- +id: sod-recipient +title: SodRecipient +pagination_label: SodRecipient +sidebar_label: SodRecipient +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodRecipient', 'SodRecipient'] +slug: /tools/sdk/powershell/v3/models/sod-recipient +tags: ['SDK', 'Software Development Kit', 'SodRecipient', 'SodRecipient'] +--- + + +# SodRecipient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | SOD policy recipient DTO type. | [optional] +**Id** | Pointer to **String** | SOD policy recipient's identity ID. | [optional] +**Name** | Pointer to **String** | SOD policy recipient's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodRecipient = Initialize-PSSailpoint.V3SodRecipient -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$SodRecipient | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodReportResultDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodReportResultDto.md new file mode 100644 index 000000000..85f2efd9f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodReportResultDto.md @@ -0,0 +1,39 @@ +--- +id: sod-report-result-dto +title: SodReportResultDto +pagination_label: SodReportResultDto +sidebar_label: SodReportResultDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodReportResultDto', 'SodReportResultDto'] +slug: /tools/sdk/powershell/v3/models/sod-report-result-dto +tags: ['SDK', 'Software Development Kit', 'SodReportResultDto', 'SodReportResultDto'] +--- + + +# SodReportResultDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "REPORT_RESULT" ] | SOD policy violation report result DTO type. | [optional] +**Id** | Pointer to **String** | SOD policy violation report result ID. | [optional] +**Name** | Pointer to **String** | Human-readable name of the SOD policy violation report result. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodReportResultDto = Initialize-PSSailpoint.V3SodReportResultDto -Type REPORT_RESULT ` + -Id 2c9180835d191a86015d28455b4b232a ` + -Name SOD Policy 1 Violation +``` + +- Convert the resource to JSON +```powershell +$SodReportResultDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodViolationCheck.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodViolationCheck.md new file mode 100644 index 000000000..972db8b91 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodViolationCheck.md @@ -0,0 +1,37 @@ +--- +id: sod-violation-check +title: SodViolationCheck +pagination_label: SodViolationCheck +sidebar_label: SodViolationCheck +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationCheck', 'SodViolationCheck'] +slug: /tools/sdk/powershell/v3/models/sod-violation-check +tags: ['SDK', 'Software Development Kit', 'SodViolationCheck', 'SodViolationCheck'] +--- + + +# SodViolationCheck + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | **String** | The id of the original request | [required] +**Created** | Pointer to **System.DateTime** | The date-time when this request was created. | [optional] [readonly] + +## Examples + +- Prepare the resource +```powershell +$SodViolationCheck = Initialize-PSSailpoint.V3SodViolationCheck -RequestId 089899f13a8f4da7824996191587bab9 ` + -Created 2020-01-01T00:00Z +``` + +- Convert the resource to JSON +```powershell +$SodViolationCheck | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodViolationCheckResult.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodViolationCheckResult.md new file mode 100644 index 000000000..e5640d316 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodViolationCheckResult.md @@ -0,0 +1,41 @@ +--- +id: sod-violation-check-result +title: SodViolationCheckResult +pagination_label: SodViolationCheckResult +sidebar_label: SodViolationCheckResult +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationCheckResult', 'SodViolationCheckResult'] +slug: /tools/sdk/powershell/v3/models/sod-violation-check-result +tags: ['SDK', 'Software Development Kit', 'SodViolationCheckResult', 'SodViolationCheckResult'] +--- + + +# SodViolationCheckResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to [**ErrorMessageDto**](error-message-dto) | | [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 completion of the violation check. | [optional] +**ViolationContexts** | Pointer to [**[]SodViolationContext**](sod-violation-context) | | [optional] +**ViolatedPolicies** | Pointer to [**[]SodPolicyDto**](sod-policy-dto) | A list of the SOD policies that were violated. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationCheckResult = Initialize-PSSailpoint.V3SodViolationCheckResult -Message null ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -ViolationContexts null ` + -ViolatedPolicies null +``` + +- Convert the resource to JSON +```powershell +$SodViolationCheckResult | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodViolationContext.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodViolationContext.md new file mode 100644 index 000000000..0fe816f3d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodViolationContext.md @@ -0,0 +1,37 @@ +--- +id: sod-violation-context +title: SodViolationContext +pagination_label: SodViolationContext +sidebar_label: SodViolationContext +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContext', 'SodViolationContext'] +slug: /tools/sdk/powershell/v3/models/sod-violation-context +tags: ['SDK', 'Software Development Kit', 'SodViolationContext', 'SodViolationContext'] +--- + + +# SodViolationContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policy** | Pointer to [**SodPolicyDto**](sod-policy-dto) | | [optional] +**ConflictingAccessCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteria**](sod-violation-context-conflicting-access-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationContext = Initialize-PSSailpoint.V3SodViolationContext -Policy null ` + -ConflictingAccessCriteria null +``` + +- Convert the resource to JSON +```powershell +$SodViolationContext | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodViolationContextCheckCompleted.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodViolationContextCheckCompleted.md new file mode 100644 index 000000000..a4aa79495 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodViolationContextCheckCompleted.md @@ -0,0 +1,39 @@ +--- +id: sod-violation-context-check-completed +title: SodViolationContextCheckCompleted +pagination_label: SodViolationContextCheckCompleted +sidebar_label: SodViolationContextCheckCompleted +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContextCheckCompleted', 'SodViolationContextCheckCompleted'] +slug: /tools/sdk/powershell/v3/models/sod-violation-context-check-completed +tags: ['SDK', 'Software Development Kit', 'SodViolationContextCheckCompleted', 'SodViolationContextCheckCompleted'] +--- + + +# SodViolationContextCheckCompleted + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**State** | Pointer to **Enum** [ "SUCCESS", "ERROR" ] | The status of SOD violation check | [optional] +**Uuid** | Pointer to **String** | The id of the Violation check event | [optional] +**ViolationCheckResult** | Pointer to [**SodViolationCheckResult**](sod-violation-check-result) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationContextCheckCompleted = Initialize-PSSailpoint.V3SodViolationContextCheckCompleted -State SUCCESS ` + -Uuid f73d16e9-a038-46c5-b217-1246e15fdbdd ` + -ViolationCheckResult null +``` + +- Convert the resource to JSON +```powershell +$SodViolationContextCheckCompleted | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodViolationContextConflictingAccessCriteria.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodViolationContextConflictingAccessCriteria.md new file mode 100644 index 000000000..f376e9ec7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodViolationContextConflictingAccessCriteria.md @@ -0,0 +1,37 @@ +--- +id: sod-violation-context-conflicting-access-criteria +title: SodViolationContextConflictingAccessCriteria +pagination_label: SodViolationContextConflictingAccessCriteria +sidebar_label: SodViolationContextConflictingAccessCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContextConflictingAccessCriteria', 'SodViolationContextConflictingAccessCriteria'] +slug: /tools/sdk/powershell/v3/models/sod-violation-context-conflicting-access-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContextConflictingAccessCriteria', 'SodViolationContextConflictingAccessCriteria'] +--- + + +# SodViolationContextConflictingAccessCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**LeftCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteriaLeftCriteria**](sod-violation-context-conflicting-access-criteria-left-criteria) | | [optional] +**RightCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteriaLeftCriteria**](sod-violation-context-conflicting-access-criteria-left-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationContextConflictingAccessCriteria = Initialize-PSSailpoint.V3SodViolationContextConflictingAccessCriteria -LeftCriteria null ` + -RightCriteria null +``` + +- Convert the resource to JSON +```powershell +$SodViolationContextConflictingAccessCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md new file mode 100644 index 000000000..30b20cc1d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md @@ -0,0 +1,35 @@ +--- +id: sod-violation-context-conflicting-access-criteria-left-criteria +title: SodViolationContextConflictingAccessCriteriaLeftCriteria +pagination_label: SodViolationContextConflictingAccessCriteriaLeftCriteria +sidebar_label: SodViolationContextConflictingAccessCriteriaLeftCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContextConflictingAccessCriteriaLeftCriteria', 'SodViolationContextConflictingAccessCriteriaLeftCriteria'] +slug: /tools/sdk/powershell/v3/models/sod-violation-context-conflicting-access-criteria-left-criteria +tags: ['SDK', 'Software Development Kit', 'SodViolationContextConflictingAccessCriteriaLeftCriteria', 'SodViolationContextConflictingAccessCriteriaLeftCriteria'] +--- + + +# SodViolationContextConflictingAccessCriteriaLeftCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**CriteriaList** | Pointer to [**[]SodExemptCriteria**](sod-exempt-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SodViolationContextConflictingAccessCriteriaLeftCriteria = Initialize-PSSailpoint.V3SodViolationContextConflictingAccessCriteriaLeftCriteria -CriteriaList null +``` + +- Convert the resource to JSON +```powershell +$SodViolationContextConflictingAccessCriteriaLeftCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Source.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Source.md new file mode 100644 index 000000000..f4f36c0f1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Source.md @@ -0,0 +1,95 @@ +--- +id: source +title: Source +pagination_label: Source +sidebar_label: Source +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Source', 'Source'] +slug: /tools/sdk/powershell/v3/models/source +tags: ['SDK', 'Software Development Kit', 'Source', 'Source'] +--- + + +# Source + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Source ID. | [optional] [readonly] +**Name** | **String** | Source's human-readable name. | [required] +**Description** | Pointer to **String** | Source's human-readable description. | [optional] +**Owner** | [**SourceOwner**](source-owner) | | [required] +**Cluster** | Pointer to [**SourceCluster**](source-cluster) | | [optional] +**AccountCorrelationConfig** | Pointer to [**SourceAccountCorrelationConfig**](source-account-correlation-config) | | [optional] +**AccountCorrelationRule** | Pointer to [**SourceAccountCorrelationRule**](source-account-correlation-rule) | | [optional] +**ManagerCorrelationMapping** | Pointer to [**SourceManagerCorrelationMapping**](source-manager-correlation-mapping) | | [optional] +**ManagerCorrelationRule** | Pointer to [**SourceManagerCorrelationRule**](source-manager-correlation-rule) | | [optional] +**BeforeProvisioningRule** | Pointer to [**SourceBeforeProvisioningRule**](source-before-provisioning-rule) | | [optional] +**Schemas** | Pointer to [**[]SourceSchemasInner**](source-schemas-inner) | List of references to schema objects. | [optional] +**PasswordPolicies** | Pointer to [**[]SourcePasswordPoliciesInner**](source-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional] +**Features** | Pointer to **[]String** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] +**Type** | Pointer to **String** | Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional] +**Connector** | **String** | Connector script name. | [required] +**ConnectorClass** | Pointer to **String** | Fully qualified name of the Java class that implements the connector interface. | [optional] +**ConnectorAttributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Connector specific configuration. This configuration will differ from type to type. | [optional] +**DeleteThreshold** | Pointer to **Int32** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional] +**Authoritative** | Pointer to **Boolean** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to $false] +**ManagementWorkgroup** | Pointer to [**SourceManagementWorkgroup**](source-management-workgroup) | | [optional] +**Healthy** | Pointer to **Boolean** | When this is true, it indicates that the source is healthy. | [optional] [default to $false] +**Status** | Pointer to **Enum** [ "SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT", "SOURCE_STATE_ERROR_CLUSTER", "SOURCE_STATE_ERROR_SOURCE", "SOURCE_STATE_ERROR_VA", "SOURCE_STATE_FAILURE_CLUSTER", "SOURCE_STATE_FAILURE_SOURCE", "SOURCE_STATE_HEALTHY", "SOURCE_STATE_UNCHECKED_CLUSTER", "SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES", "SOURCE_STATE_UNCHECKED_SOURCE", "SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS" ] | Status identifier that gives specific information about why a source is or isn't healthy. | [optional] +**Since** | Pointer to **String** | Timestamp that shows when a source health check was last performed. | [optional] +**ConnectorId** | Pointer to **String** | Connector ID | [optional] +**ConnectorName** | Pointer to **String** | Name of the connector that was chosen during source creation. | [optional] +**ConnectionType** | Pointer to **String** | Type of connection (direct or file). | [optional] +**ConnectorImplementationId** | Pointer to **String** | Connector implementation ID. | [optional] +**Created** | Pointer to **System.DateTime** | Date-time when the source was created | [optional] +**Modified** | Pointer to **System.DateTime** | Date-time when the source was last modified. | [optional] +**CredentialProviderEnabled** | Pointer to **Boolean** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to $false] +**Category** | Pointer to **String** | Source category (e.g. null, CredentialProvider). | [optional] + +## Examples + +- Prepare the resource +```powershell +$Source = Initialize-PSSailpoint.V3Source -Id 2c91808568c529c60168cca6f90c1324 ` + -Name My Source ` + -Description This is the corporate directory. ` + -Owner null ` + -Cluster null ` + -AccountCorrelationConfig null ` + -AccountCorrelationRule null ` + -ManagerCorrelationMapping null ` + -ManagerCorrelationRule null ` + -BeforeProvisioningRule null ` + -Schemas [{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}] ` + -PasswordPolicies [{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}] ` + -Features [PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS] ` + -Type OpenLDAP - Direct ` + -Connector active-directory ` + -ConnectorClass sailpoint.connector.LDAPConnector ` + -ConnectorAttributes {healthCheckTimeout=30, authSearchAttributes=[cn, uid, mail]} ` + -DeleteThreshold 10 ` + -Authoritative false ` + -ManagementWorkgroup null ` + -Healthy true ` + -Status SOURCE_STATE_HEALTHY ` + -Since 2021-09-28T15:48:29.3801666300Z ` + -ConnectorId active-directory ` + -ConnectorName Active Directory ` + -ConnectionType file ` + -ConnectorImplementationId delimited-file ` + -Created 2022-02-08T14:50:03.827Z ` + -Modified 2024-01-23T18:08:50.897Z ` + -CredentialProviderEnabled false ` + -Category CredentialProvider +``` + +- Convert the resource to JSON +```powershell +$Source | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceAccountCorrelationConfig.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceAccountCorrelationConfig.md new file mode 100644 index 000000000..7c991a984 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceAccountCorrelationConfig.md @@ -0,0 +1,39 @@ +--- +id: source-account-correlation-config +title: SourceAccountCorrelationConfig +pagination_label: SourceAccountCorrelationConfig +sidebar_label: SourceAccountCorrelationConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAccountCorrelationConfig', 'SourceAccountCorrelationConfig'] +slug: /tools/sdk/powershell/v3/models/source-account-correlation-config +tags: ['SDK', 'Software Development Kit', 'SourceAccountCorrelationConfig', 'SourceAccountCorrelationConfig'] +--- + + +# SourceAccountCorrelationConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ACCOUNT_CORRELATION_CONFIG" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Account correlation config ID. | [optional] +**Name** | Pointer to **String** | Account correlation config's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceAccountCorrelationConfig = Initialize-PSSailpoint.V3SourceAccountCorrelationConfig -Type ACCOUNT_CORRELATION_CONFIG ` + -Id 2c9180855d191c59015d28583727245a ` + -Name Directory [source-62867] Account Correlation +``` + +- Convert the resource to JSON +```powershell +$SourceAccountCorrelationConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceAccountCorrelationRule.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceAccountCorrelationRule.md new file mode 100644 index 000000000..fef36a224 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceAccountCorrelationRule.md @@ -0,0 +1,39 @@ +--- +id: source-account-correlation-rule +title: SourceAccountCorrelationRule +pagination_label: SourceAccountCorrelationRule +sidebar_label: SourceAccountCorrelationRule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAccountCorrelationRule', 'SourceAccountCorrelationRule'] +slug: /tools/sdk/powershell/v3/models/source-account-correlation-rule +tags: ['SDK', 'Software Development Kit', 'SourceAccountCorrelationRule', 'SourceAccountCorrelationRule'] +--- + + +# SourceAccountCorrelationRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "RULE" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Rule ID. | [optional] +**Name** | Pointer to **String** | Rule's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceAccountCorrelationRule = Initialize-PSSailpoint.V3SourceAccountCorrelationRule -Type RULE ` + -Id 2c918085708c274401708c2a8a760001 ` + -Name Example Rule +``` + +- Convert the resource to JSON +```powershell +$SourceAccountCorrelationRule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceBeforeProvisioningRule.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceBeforeProvisioningRule.md new file mode 100644 index 000000000..3d244f535 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceBeforeProvisioningRule.md @@ -0,0 +1,39 @@ +--- +id: source-before-provisioning-rule +title: SourceBeforeProvisioningRule +pagination_label: SourceBeforeProvisioningRule +sidebar_label: SourceBeforeProvisioningRule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceBeforeProvisioningRule', 'SourceBeforeProvisioningRule'] +slug: /tools/sdk/powershell/v3/models/source-before-provisioning-rule +tags: ['SDK', 'Software Development Kit', 'SourceBeforeProvisioningRule', 'SourceBeforeProvisioningRule'] +--- + + +# SourceBeforeProvisioningRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "RULE" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Rule ID. | [optional] +**Name** | Pointer to **String** | Rule's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceBeforeProvisioningRule = Initialize-PSSailpoint.V3SourceBeforeProvisioningRule -Type RULE ` + -Id 2c918085708c274401708c2a8a760001 ` + -Name Example Rule +``` + +- Convert the resource to JSON +```powershell +$SourceBeforeProvisioningRule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceCluster.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceCluster.md new file mode 100644 index 000000000..432f416ef --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceCluster.md @@ -0,0 +1,39 @@ +--- +id: source-cluster +title: SourceCluster +pagination_label: SourceCluster +sidebar_label: SourceCluster +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceCluster', 'SourceCluster'] +slug: /tools/sdk/powershell/v3/models/source-cluster +tags: ['SDK', 'Software Development Kit', 'SourceCluster', 'SourceCluster'] +--- + + +# SourceCluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "CLUSTER" ] | Type of object being referenced. | [required] +**Id** | **String** | Cluster ID. | [required] +**Name** | **String** | Cluster's human-readable display name. | [required] + +## Examples + +- Prepare the resource +```powershell +$SourceCluster = Initialize-PSSailpoint.V3SourceCluster -Type CLUSTER ` + -Id 2c9180866166b5b0016167c32ef31a66 ` + -Name Corporate Cluster +``` + +- Convert the resource to JSON +```powershell +$SourceCluster | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceClusterDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceClusterDto.md new file mode 100644 index 000000000..7dea84b8e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceClusterDto.md @@ -0,0 +1,39 @@ +--- +id: source-cluster-dto +title: SourceClusterDto +pagination_label: SourceClusterDto +sidebar_label: SourceClusterDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceClusterDto', 'SourceClusterDto'] +slug: /tools/sdk/powershell/v3/models/source-cluster-dto +tags: ['SDK', 'Software Development Kit', 'SourceClusterDto', 'SourceClusterDto'] +--- + + +# SourceClusterDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "CLUSTER" ] | Source cluster DTO type. | [optional] +**Id** | Pointer to **String** | Source cluster ID. | [optional] +**Name** | Pointer to **String** | Source cluster display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceClusterDto = Initialize-PSSailpoint.V3SourceClusterDto -Type CLUSTER ` + -Id 2c9180847a7fccdd017aa5896f9f4f6f ` + -Name Training VA +``` + +- Convert the resource to JSON +```powershell +$SourceClusterDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceConnectionsDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceConnectionsDto.md new file mode 100644 index 000000000..41801d14e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceConnectionsDto.md @@ -0,0 +1,47 @@ +--- +id: source-connections-dto +title: SourceConnectionsDto +pagination_label: SourceConnectionsDto +sidebar_label: SourceConnectionsDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceConnectionsDto', 'SourceConnectionsDto'] +slug: /tools/sdk/powershell/v3/models/source-connections-dto +tags: ['SDK', 'Software Development Kit', 'SourceConnectionsDto', 'SourceConnectionsDto'] +--- + + +# SourceConnectionsDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityProfiles** | Pointer to [**[]IdentityProfilesConnections**](identity-profiles-connections) | The IdentityProfile attached to this source | [optional] +**CredentialProfiles** | Pointer to **[]String** | Name of the CredentialProfile attached to this source | [optional] +**SourceAttributes** | Pointer to **[]String** | The attributes attached to this source | [optional] +**MappingProfiles** | Pointer to **[]String** | The profiles attached to this source | [optional] +**DependentCustomTransforms** | Pointer to [**[]Transform**](transform) | | [optional] +**DependentApps** | Pointer to [**[]DependantAppConnections**](dependant-app-connections) | | [optional] +**MissingDependents** | Pointer to [**[]DependantConnectionsMissingDto**](dependant-connections-missing-dto) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceConnectionsDto = Initialize-PSSailpoint.V3SourceConnectionsDto -IdentityProfiles null ` + -CredentialProfiles null ` + -SourceAttributes null ` + -MappingProfiles [ODS-AD-Profile, ODS-Profile2] ` + -DependentCustomTransforms null ` + -DependentApps null ` + -MissingDependents null +``` + +- Convert the resource to JSON +```powershell +$SourceConnectionsDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceHealthDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceHealthDto.md new file mode 100644 index 000000000..31940b438 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceHealthDto.md @@ -0,0 +1,53 @@ +--- +id: source-health-dto +title: SourceHealthDto +pagination_label: SourceHealthDto +sidebar_label: SourceHealthDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceHealthDto', 'SourceHealthDto'] +slug: /tools/sdk/powershell/v3/models/source-health-dto +tags: ['SDK', 'Software Development Kit', 'SourceHealthDto', 'SourceHealthDto'] +--- + + +# SourceHealthDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | the id of the Source | [optional] [readonly] +**Type** | Pointer to **String** | Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. | [optional] +**Name** | Pointer to **String** | the name of the source | [optional] +**Org** | Pointer to **String** | source's org | [optional] +**IsAuthoritative** | Pointer to **Boolean** | Is the source authoritative | [optional] +**IsCluster** | Pointer to **Boolean** | Is the source in a cluster | [optional] +**Hostname** | Pointer to **String** | source's hostname | [optional] +**Pod** | Pointer to **String** | source's pod | [optional] +**IqServiceVersion** | Pointer to **String** | The version of the iqService | [optional] +**Status** | Pointer to **Enum** [ "SOURCE_STATE_ERROR_CLUSTER", "SOURCE_STATE_ERROR_SOURCE", "SOURCE_STATE_ERROR_VA", "SOURCE_STATE_FAILURE_CLUSTER", "SOURCE_STATE_FAILURE_SOURCE", "SOURCE_STATE_HEALTHY", "SOURCE_STATE_UNCHECKED_CLUSTER", "SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES", "SOURCE_STATE_UNCHECKED_SOURCE", "SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS" ] | connection test result | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceHealthDto = Initialize-PSSailpoint.V3SourceHealthDto -Id 2c91808568c529c60168cca6f90c1324 ` + -Type OpenLDAP - Direct ` + -Name Source1234 ` + -Org denali-cjh ` + -IsAuthoritative false ` + -IsCluster false ` + -Hostname megapod-useast1-secret-hostname.sailpoint.com ` + -Pod megapod-useast1 ` + -IqServiceVersion iqVersion123 ` + -Status SOURCE_STATE_UNCHECKED_SOURCE +``` + +- Convert the resource to JSON +```powershell +$SourceHealthDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceManagementWorkgroup.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceManagementWorkgroup.md new file mode 100644 index 000000000..2f0013293 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceManagementWorkgroup.md @@ -0,0 +1,39 @@ +--- +id: source-management-workgroup +title: SourceManagementWorkgroup +pagination_label: SourceManagementWorkgroup +sidebar_label: SourceManagementWorkgroup +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceManagementWorkgroup', 'SourceManagementWorkgroup'] +slug: /tools/sdk/powershell/v3/models/source-management-workgroup +tags: ['SDK', 'Software Development Kit', 'SourceManagementWorkgroup', 'SourceManagementWorkgroup'] +--- + + +# SourceManagementWorkgroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Management workgroup ID. | [optional] +**Name** | Pointer to **String** | Management workgroup's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceManagementWorkgroup = Initialize-PSSailpoint.V3SourceManagementWorkgroup -Type GOVERNANCE_GROUP ` + -Id 2c91808568c529c60168cca6f90c2222 ` + -Name My Management Workgroup +``` + +- Convert the resource to JSON +```powershell +$SourceManagementWorkgroup | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceManagerCorrelationMapping.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceManagerCorrelationMapping.md new file mode 100644 index 000000000..a066f18d5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceManagerCorrelationMapping.md @@ -0,0 +1,37 @@ +--- +id: source-manager-correlation-mapping +title: SourceManagerCorrelationMapping +pagination_label: SourceManagerCorrelationMapping +sidebar_label: SourceManagerCorrelationMapping +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceManagerCorrelationMapping', 'SourceManagerCorrelationMapping'] +slug: /tools/sdk/powershell/v3/models/source-manager-correlation-mapping +tags: ['SDK', 'Software Development Kit', 'SourceManagerCorrelationMapping', 'SourceManagerCorrelationMapping'] +--- + + +# SourceManagerCorrelationMapping + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountAttributeName** | Pointer to **String** | Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. | [optional] +**IdentityAttributeName** | Pointer to **String** | Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceManagerCorrelationMapping = Initialize-PSSailpoint.V3SourceManagerCorrelationMapping -AccountAttributeName manager ` + -IdentityAttributeName manager +``` + +- Convert the resource to JSON +```powershell +$SourceManagerCorrelationMapping | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceManagerCorrelationRule.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceManagerCorrelationRule.md new file mode 100644 index 000000000..912124bde --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceManagerCorrelationRule.md @@ -0,0 +1,39 @@ +--- +id: source-manager-correlation-rule +title: SourceManagerCorrelationRule +pagination_label: SourceManagerCorrelationRule +sidebar_label: SourceManagerCorrelationRule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceManagerCorrelationRule', 'SourceManagerCorrelationRule'] +slug: /tools/sdk/powershell/v3/models/source-manager-correlation-rule +tags: ['SDK', 'Software Development Kit', 'SourceManagerCorrelationRule', 'SourceManagerCorrelationRule'] +--- + + +# SourceManagerCorrelationRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "RULE" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Rule ID. | [optional] +**Name** | Pointer to **String** | Rule's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceManagerCorrelationRule = Initialize-PSSailpoint.V3SourceManagerCorrelationRule -Type RULE ` + -Id 2c918085708c274401708c2a8a760001 ` + -Name Example Rule +``` + +- Convert the resource to JSON +```powershell +$SourceManagerCorrelationRule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceOwner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceOwner.md new file mode 100644 index 000000000..dcc2b2bdd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceOwner.md @@ -0,0 +1,39 @@ +--- +id: source-owner +title: SourceOwner +pagination_label: SourceOwner +sidebar_label: SourceOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceOwner', 'SourceOwner'] +slug: /tools/sdk/powershell/v3/models/source-owner +tags: ['SDK', 'Software Development Kit', 'SourceOwner', 'SourceOwner'] +--- + + +# SourceOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Owner identity's ID. | [optional] +**Name** | Pointer to **String** | Owner identity's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceOwner = Initialize-PSSailpoint.V3SourceOwner -Type IDENTITY ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name MyName +``` + +- Convert the resource to JSON +```powershell +$SourceOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourcePasswordPoliciesInner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourcePasswordPoliciesInner.md new file mode 100644 index 000000000..f25c184e1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourcePasswordPoliciesInner.md @@ -0,0 +1,39 @@ +--- +id: source-password-policies-inner +title: SourcePasswordPoliciesInner +pagination_label: SourcePasswordPoliciesInner +sidebar_label: SourcePasswordPoliciesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourcePasswordPoliciesInner', 'SourcePasswordPoliciesInner'] +slug: /tools/sdk/powershell/v3/models/source-password-policies-inner +tags: ['SDK', 'Software Development Kit', 'SourcePasswordPoliciesInner', 'SourcePasswordPoliciesInner'] +--- + + +# SourcePasswordPoliciesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "PASSWORD_POLICY" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Policy ID. | [optional] +**Name** | Pointer to **String** | Policy's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourcePasswordPoliciesInner = Initialize-PSSailpoint.V3SourcePasswordPoliciesInner -Type PASSWORD_POLICY ` + -Id 2c91808568c529c60168cca6f90c1777 ` + -Name My Password Policy +``` + +- Convert the resource to JSON +```powershell +$SourcePasswordPoliciesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceSchemasInner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceSchemasInner.md new file mode 100644 index 000000000..d3957c66b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceSchemasInner.md @@ -0,0 +1,39 @@ +--- +id: source-schemas-inner +title: SourceSchemasInner +pagination_label: SourceSchemasInner +sidebar_label: SourceSchemasInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceSchemasInner', 'SourceSchemasInner'] +slug: /tools/sdk/powershell/v3/models/source-schemas-inner +tags: ['SDK', 'Software Development Kit', 'SourceSchemasInner', 'SourceSchemasInner'] +--- + + +# SourceSchemasInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "CONNECTOR_SCHEMA" ] | Type of object being referenced. | [optional] +**Id** | Pointer to **String** | Schema ID. | [optional] +**Name** | Pointer to **String** | Schema's human-readable display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceSchemasInner = Initialize-PSSailpoint.V3SourceSchemasInner -Type CONNECTOR_SCHEMA ` + -Id 2c91808568c529c60168cca6f90c1777 ` + -Name MySchema +``` + +- Convert the resource to JSON +```powershell +$SourceSchemasInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceUsage.md new file mode 100644 index 000000000..f8d6dda87 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceUsage.md @@ -0,0 +1,37 @@ +--- +id: source-usage +title: SourceUsage +pagination_label: SourceUsage +sidebar_label: SourceUsage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceUsage', 'SourceUsage'] +slug: /tools/sdk/powershell/v3/models/source-usage +tags: ['SDK', 'Software Development Kit', 'SourceUsage', 'SourceUsage'] +--- + + +# SourceUsage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Date** | Pointer to **System.DateTime** | The first day of the month for which activity is aggregated. | [optional] +**Count** | Pointer to **Double** | The average number of days that accounts were active within this source, for the month. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceUsage = Initialize-PSSailpoint.V3SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` + -Count 10.45 +``` + +- Convert the resource to JSON +```powershell +$SourceUsage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceUsageStatus.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceUsageStatus.md new file mode 100644 index 000000000..9b0dcd408 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SourceUsageStatus.md @@ -0,0 +1,35 @@ +--- +id: source-usage-status +title: SourceUsageStatus +pagination_label: SourceUsageStatus +sidebar_label: SourceUsageStatus +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceUsageStatus', 'SourceUsageStatus'] +slug: /tools/sdk/powershell/v3/models/source-usage-status +tags: ['SDK', 'Software Development Kit', 'SourceUsageStatus', 'SourceUsageStatus'] +--- + + +# SourceUsageStatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **Enum** [ "COMPLETE", "INCOMPLETE" ] | Source Usage Status. Acceptable values are: - COMPLETE - This status means that an activity data source has been setup and usage insights are available for the source. - INCOMPLETE - This status means that an activity data source has not been setup and usage insights are not available for the source. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceUsageStatus = Initialize-PSSailpoint.V3SourceUsageStatus -Status COMPLETE +``` + +- Convert the resource to JSON +```powershell +$SourceUsageStatus | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SpConfigMessage.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SpConfigMessage.md new file mode 100644 index 000000000..8fd2153bb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SpConfigMessage.md @@ -0,0 +1,39 @@ +--- +id: sp-config-message +title: SpConfigMessage +pagination_label: SpConfigMessage +sidebar_label: SpConfigMessage +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigMessage', 'SpConfigMessage'] +slug: /tools/sdk/powershell/v3/models/sp-config-message +tags: ['SDK', 'Software Development Kit', 'SpConfigMessage', 'SpConfigMessage'] +--- + + +# SpConfigMessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | **String** | Message key. | [required] +**Text** | **String** | Message text. | [required] +**Details** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Message details if any, in key:value pairs. | [required] + +## Examples + +- Prepare the resource +```powershell +$SpConfigMessage = Initialize-PSSailpoint.V3SpConfigMessage -Key UNKNOWN_REFERENCE_RESOLVER ` + -Text Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity] ` + -Details {details=message details} +``` + +- Convert the resource to JSON +```powershell +$SpConfigMessage | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SpDetails.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SpDetails.md new file mode 100644 index 000000000..2792d48c1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SpDetails.md @@ -0,0 +1,41 @@ +--- +id: sp-details +title: SpDetails +pagination_label: SpDetails +sidebar_label: SpDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpDetails', 'SpDetails'] +slug: /tools/sdk/powershell/v3/models/sp-details +tags: ['SDK', 'Software Development Kit', 'SpDetails', 'SpDetails'] +--- + + +# SpDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | Pointer to **Enum** [ "SAML_SP" ] | Federation protocol role | [optional] +**EntityId** | Pointer to **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**Alias** | Pointer to **String** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**CallbackUrl** | Pointer to **String** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SpDetails = Initialize-PSSailpoint.V3SpDetails -Role SAML_SP ` + -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 ` + -Alias acme-sp ` + -CallbackUrl https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp +``` + +- Convert the resource to JSON +```powershell +$SpDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Split.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Split.md new file mode 100644 index 000000000..67874d4d5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Split.md @@ -0,0 +1,43 @@ +--- +id: split +title: Split +pagination_label: Split +sidebar_label: Split +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Split', 'Split'] +slug: /tools/sdk/powershell/v3/models/split +tags: ['SDK', 'Software Development Kit', 'Split', 'Split'] +--- + + +# Split + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Delimiter** | **String** | This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data | [required] +**Index** | **String** | An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc. | [required] +**Throws** | Pointer to **Boolean** | A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) `true` - The transform should return ""IndexOutOfBoundsException"" `false` - The transform should return null If not provided, the transform will default to false and return a null | [optional] [default to $false] +**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] + +## Examples + +- Prepare the resource +```powershell +$Split = Initialize-PSSailpoint.V3Split -Delimiter , ` + -Index 5 ` + -Throws true ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Split | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/StandardLevel.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/StandardLevel.md new file mode 100644 index 000000000..accbbfe5c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/StandardLevel.md @@ -0,0 +1,34 @@ +--- +id: standard-level +title: StandardLevel +pagination_label: StandardLevel +sidebar_label: StandardLevel +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'StandardLevel', 'StandardLevel'] +slug: /tools/sdk/powershell/v3/models/standard-level +tags: ['SDK', 'Software Development Kit', 'StandardLevel', 'StandardLevel'] +--- + + +# StandardLevel + +## Enum + + +* `false` (value: `"false"`) + +* `FATAL` (value: `"FATAL"`) + +* `ERROR` (value: `"ERROR"`) + +* `WARN` (value: `"WARN"`) + +* `INFO` (value: `"INFO"`) + +* `DEBUG` (value: `"DEBUG"`) + +* `TRACE` (value: `"TRACE"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Static.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Static.md new file mode 100644 index 000000000..eabd0dfd2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Static.md @@ -0,0 +1,37 @@ +--- +id: static +title: Static +pagination_label: Static +sidebar_label: Static +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Static', 'Static'] +slug: /tools/sdk/powershell/v3/models/static +tags: ['SDK', 'Software Development Kit', 'Static', 'Static'] +--- + + +# Static + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Values** | **String** | This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language. | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$Static = Initialize-PSSailpoint.V3Static -Values string$variable ` + -RequiresPeriodicRefresh false +``` + +- Convert the resource to JSON +```powershell +$Static | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/SubSearchAggregationSpecification.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SubSearchAggregationSpecification.md new file mode 100644 index 000000000..afaa8fef4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/SubSearchAggregationSpecification.md @@ -0,0 +1,43 @@ +--- +id: sub-search-aggregation-specification +title: SubSearchAggregationSpecification +pagination_label: SubSearchAggregationSpecification +sidebar_label: SubSearchAggregationSpecification +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SubSearchAggregationSpecification', 'SubSearchAggregationSpecification'] +slug: /tools/sdk/powershell/v3/models/sub-search-aggregation-specification +tags: ['SDK', 'Software Development Kit', 'SubSearchAggregationSpecification', 'SubSearchAggregationSpecification'] +--- + + +# SubSearchAggregationSpecification + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Nested** | Pointer to [**NestedAggregation**](nested-aggregation) | | [optional] +**Metric** | Pointer to [**MetricAggregation**](metric-aggregation) | | [optional] +**VarFilter** | Pointer to [**FilterAggregation**](filter-aggregation) | | [optional] +**Bucket** | Pointer to [**BucketAggregation**](bucket-aggregation) | | [optional] +**SubAggregation** | Pointer to [**Aggregations**](aggregations) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SubSearchAggregationSpecification = Initialize-PSSailpoint.V3SubSearchAggregationSpecification -Nested null ` + -Metric null ` + -VarFilter null ` + -Bucket null ` + -SubAggregation null +``` + +- Convert the resource to JSON +```powershell +$SubSearchAggregationSpecification | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Substring.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Substring.md new file mode 100644 index 000000000..d07280328 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Substring.md @@ -0,0 +1,45 @@ +--- +id: substring +title: Substring +pagination_label: Substring +sidebar_label: Substring +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Substring', 'Substring'] +slug: /tools/sdk/powershell/v3/models/substring +tags: ['SDK', 'Software Development Kit', 'Substring', 'Substring'] +--- + + +# Substring + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarBegin** | **Int32** | The index of the first character to include in the returned substring. If `begin` is set to -1, the transform will begin at character 0 of the input data | [required] +**BeginOffset** | Pointer to **Int32** | This integer value is the number of characters to add to the begin attribute when returning a substring. This attribute is only used if begin is not -1. | [optional] +**VarEnd** | Pointer to **Int32** | The index of the first character to exclude from the returned substring. If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. | [optional] +**EndOffset** | Pointer to **Int32** | This integer value is the number of characters to add to the end attribute when returning a substring. This attribute is only used if end is provided and is not -1. | [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] + +## Examples + +- Prepare the resource +```powershell +$Substring = Initialize-PSSailpoint.V3Substring -VarBegin 1 ` + -BeginOffset 3 ` + -VarEnd 6 ` + -EndOffset 1 ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Substring | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/TaggedObject.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TaggedObject.md new file mode 100644 index 000000000..068cf429f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TaggedObject.md @@ -0,0 +1,37 @@ +--- +id: tagged-object +title: TaggedObject +pagination_label: TaggedObject +sidebar_label: TaggedObject +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaggedObject', 'TaggedObject'] +slug: /tools/sdk/powershell/v3/models/tagged-object +tags: ['SDK', 'Software Development Kit', 'TaggedObject', 'TaggedObject'] +--- + + +# TaggedObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ObjectRef** | Pointer to [**TaggedObjectDto**](tagged-object-dto) | | [optional] +**Tags** | Pointer to **[]String** | Labels to be applied to an Object | [optional] + +## Examples + +- Prepare the resource +```powershell +$TaggedObject = Initialize-PSSailpoint.V3TaggedObject -ObjectRef null ` + -Tags [BU_FINANCE, PCI] +``` + +- Convert the resource to JSON +```powershell +$TaggedObject | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/TaggedObjectDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TaggedObjectDto.md new file mode 100644 index 000000000..99855d1a5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TaggedObjectDto.md @@ -0,0 +1,39 @@ +--- +id: tagged-object-dto +title: TaggedObjectDto +pagination_label: TaggedObjectDto +sidebar_label: TaggedObjectDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaggedObjectDto', 'TaggedObjectDto'] +slug: /tools/sdk/powershell/v3/models/tagged-object-dto +tags: ['SDK', 'Software Development Kit', 'TaggedObjectDto', 'TaggedObjectDto'] +--- + + +# TaggedObjectDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "APPLICATION", "CAMPAIGN", "ENTITLEMENT", "IDENTITY", "ROLE", "SOD_POLICY", "SOURCE" ] | DTO type | [optional] +**Id** | Pointer to **String** | ID of the object this reference applies to | [optional] +**Name** | Pointer to **String** | Human-readable display name of the object this reference applies to | [optional] + +## Examples + +- Prepare the resource +```powershell +$TaggedObjectDto = Initialize-PSSailpoint.V3TaggedObjectDto -Type IDENTITY ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$TaggedObjectDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/TaskResultDetails.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TaskResultDetails.md new file mode 100644 index 000000000..b183a4650 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TaskResultDetails.md @@ -0,0 +1,61 @@ +--- +id: task-result-details +title: TaskResultDetails +pagination_label: TaskResultDetails +sidebar_label: TaskResultDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskResultDetails', 'TaskResultDetails'] +slug: /tools/sdk/powershell/v3/models/task-result-details +tags: ['SDK', 'Software Development Kit', 'TaskResultDetails', 'TaskResultDetails'] +--- + + +# TaskResultDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "QUARTZ", "QPOC", "MENTOS", "QUEUED_TASK" ] | Type of the job or task underlying in the report processing. It could be a quartz task, QPOC or MENTOS jobs or a refresh/sync task. | [optional] +**Id** | Pointer to **String** | Unique task definition identifier. | [optional] +**ReportType** | Pointer to **Enum** [ "ACCOUNTS", "IDENTITIES_DETAILS", "IDENTITIES", "IDENTITY_PROFILE_IDENTITY_ERROR", "ORPHAN_IDENTITIES", "SEARCH_EXPORT", "UNCORRELATED_ACCOUNTS" ] | Use this property to define what report should be processed in the RDE service. | [optional] +**Description** | Pointer to **String** | Description of the report purpose and/or contents. | [optional] +**ParentName** | Pointer to **String** | Name of the parent task/report if exists. | [optional] +**Launcher** | Pointer to **String** | Name of the report processing initiator. | [optional] +**Created** | Pointer to **System.DateTime** | Report creation date | [optional] +**Launched** | Pointer to **System.DateTime** | Report start date | [optional] +**Completed** | Pointer to **System.DateTime** | Report completion date | [optional] +**CompletionStatus** | Pointer to **Enum** [ "SUCCESS", "WARNING", "ERROR", "TERMINATED", "TEMP_ERROR" ] | Report completion status. | [optional] +**Messages** | Pointer to [**[]TaskResultDetailsMessagesInner**](task-result-details-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional] +**Returns** | Pointer to [**[]TaskResultDetailsReturnsInner**](task-result-details-returns-inner) | Task definition results, if necessary. | [optional] +**Attributes** | Pointer to [**map[string]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Extra attributes map(dictionary) needed for the report. | [optional] +**Progress** | Pointer to **String** | Current report state. | [optional] + +## Examples + +- Prepare the resource +```powershell +$TaskResultDetails = Initialize-PSSailpoint.V3TaskResultDetails -Type MENTOS ` + -Id a248c16fe22222b2bd49615481311111 ` + -ReportType IDENTITIES_DETAILS ` + -Description A detailed view of the identities in the system. ` + -ParentName Audit Report ` + -Launcher cloudadmin ` + -Created null ` + -Launched null ` + -Completed null ` + -CompletionStatus Success ` + -Messages [] ` + -Returns [] ` + -Attributes {org=an-org} ` + -Progress Initializing... +``` + +- Convert the resource to JSON +```powershell +$TaskResultDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/TaskResultDetailsMessagesInner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TaskResultDetailsMessagesInner.md new file mode 100644 index 000000000..7933d2c59 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TaskResultDetailsMessagesInner.md @@ -0,0 +1,43 @@ +--- +id: task-result-details-messages-inner +title: TaskResultDetailsMessagesInner +pagination_label: TaskResultDetailsMessagesInner +sidebar_label: TaskResultDetailsMessagesInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskResultDetailsMessagesInner', 'TaskResultDetailsMessagesInner'] +slug: /tools/sdk/powershell/v3/models/task-result-details-messages-inner +tags: ['SDK', 'Software Development Kit', 'TaskResultDetailsMessagesInner', 'TaskResultDetailsMessagesInner'] +--- + + +# TaskResultDetailsMessagesInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "INFO", "WARN", "ERROR" ] | Type of the message. | [optional] +**VarError** | Pointer to **Boolean** | Flag whether message is an error. | [optional] [default to $false] +**Warning** | Pointer to **Boolean** | Flag whether message is a warning. | [optional] [default to $false] +**Key** | Pointer to **String** | Message string identifier. | [optional] +**LocalizedText** | Pointer to **String** | Message context with the locale based language. | [optional] + +## Examples + +- Prepare the resource +```powershell +$TaskResultDetailsMessagesInner = Initialize-PSSailpoint.V3TaskResultDetailsMessagesInner -Type WARN ` + -VarError false ` + -Warning true ` + -Key The following account(s) failed to correlate: A,B,C ` + -LocalizedText The following account(s) failed to correlate: A,B,C +``` + +- Convert the resource to JSON +```powershell +$TaskResultDetailsMessagesInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/TaskResultDetailsReturnsInner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TaskResultDetailsReturnsInner.md new file mode 100644 index 000000000..c74511e2a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TaskResultDetailsReturnsInner.md @@ -0,0 +1,37 @@ +--- +id: task-result-details-returns-inner +title: TaskResultDetailsReturnsInner +pagination_label: TaskResultDetailsReturnsInner +sidebar_label: TaskResultDetailsReturnsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskResultDetailsReturnsInner', 'TaskResultDetailsReturnsInner'] +slug: /tools/sdk/powershell/v3/models/task-result-details-returns-inner +tags: ['SDK', 'Software Development Kit', 'TaskResultDetailsReturnsInner', 'TaskResultDetailsReturnsInner'] +--- + + +# TaskResultDetailsReturnsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DisplayLabel** | Pointer to **String** | Attribute description. | [optional] +**AttributeName** | Pointer to **String** | System or database attribute name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$TaskResultDetailsReturnsInner = Initialize-PSSailpoint.V3TaskResultDetailsReturnsInner -DisplayLabel ` + -AttributeName +``` + +- Convert the resource to JSON +```powershell +$TaskResultDetailsReturnsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/TaskResultDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TaskResultDto.md new file mode 100644 index 000000000..10450ba3a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TaskResultDto.md @@ -0,0 +1,39 @@ +--- +id: task-result-dto +title: TaskResultDto +pagination_label: TaskResultDto +sidebar_label: TaskResultDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskResultDto', 'TaskResultDto'] +slug: /tools/sdk/powershell/v3/models/task-result-dto +tags: ['SDK', 'Software Development Kit', 'TaskResultDto', 'TaskResultDto'] +--- + + +# TaskResultDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "TASK_RESULT" ] | Task result DTO type. | [optional] +**Id** | Pointer to **String** | Task result ID. | [optional] +**Name** | Pointer to **String** | Task result display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$TaskResultDto = Initialize-PSSailpoint.V3TaskResultDto -Type TASK_RESULT ` + -Id 464ae7bf791e49fdb74606a2e4a89635 ` + -Name null +``` + +- Convert the resource to JSON +```powershell +$TaskResultDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/TaskResultSimplified.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TaskResultSimplified.md new file mode 100644 index 000000000..fa62dcf27 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TaskResultSimplified.md @@ -0,0 +1,47 @@ +--- +id: task-result-simplified +title: TaskResultSimplified +pagination_label: TaskResultSimplified +sidebar_label: TaskResultSimplified +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TaskResultSimplified', 'TaskResultSimplified'] +slug: /tools/sdk/powershell/v3/models/task-result-simplified +tags: ['SDK', 'Software Development Kit', 'TaskResultSimplified', 'TaskResultSimplified'] +--- + + +# TaskResultSimplified + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Task identifier | [optional] +**Name** | Pointer to **String** | Task name | [optional] +**Description** | Pointer to **String** | Task description | [optional] +**Launcher** | Pointer to **String** | User or process who launched the task | [optional] +**Completed** | Pointer to **System.DateTime** | Date time of completion | [optional] +**Launched** | Pointer to **System.DateTime** | Date time when the task was launched | [optional] +**CompletionStatus** | Pointer to **Enum** [ "Success", "Warning", "Error", "Terminated", "TempError" ] | Task result status | [optional] + +## Examples + +- Prepare the resource +```powershell +$TaskResultSimplified = Initialize-PSSailpoint.V3TaskResultSimplified -Id ff8081814d977c21014da056804a0af3 ` + -Name Background Object Terminator c8f030f2-b1a6-4e33-99e8-6935bc18735d ` + -Description Generic task for terminating data in the overlay, used by the TerminationService. ` + -Launcher support ` + -Completed null ` + -Launched null ` + -CompletionStatus Success +``` + +- Convert the resource to JSON +```powershell +$TaskResultSimplified | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/TestExternalExecuteWorkflow200Response.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TestExternalExecuteWorkflow200Response.md new file mode 100644 index 000000000..3e058623e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TestExternalExecuteWorkflow200Response.md @@ -0,0 +1,35 @@ +--- +id: test-external-execute-workflow200-response +title: TestExternalExecuteWorkflow200Response +pagination_label: TestExternalExecuteWorkflow200Response +sidebar_label: TestExternalExecuteWorkflow200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TestExternalExecuteWorkflow200Response', 'TestExternalExecuteWorkflow200Response'] +slug: /tools/sdk/powershell/v3/models/test-external-execute-workflow200-response +tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflow200Response', 'TestExternalExecuteWorkflow200Response'] +--- + + +# TestExternalExecuteWorkflow200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Payload** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The input that was received | [optional] + +## Examples + +- Prepare the resource +```powershell +$TestExternalExecuteWorkflow200Response = Initialize-PSSailpoint.V3TestExternalExecuteWorkflow200Response -Payload {test=hello world} +``` + +- Convert the resource to JSON +```powershell +$TestExternalExecuteWorkflow200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/TestExternalExecuteWorkflowRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TestExternalExecuteWorkflowRequest.md new file mode 100644 index 000000000..d6bf44bb2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TestExternalExecuteWorkflowRequest.md @@ -0,0 +1,35 @@ +--- +id: test-external-execute-workflow-request +title: TestExternalExecuteWorkflowRequest +pagination_label: TestExternalExecuteWorkflowRequest +sidebar_label: TestExternalExecuteWorkflowRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TestExternalExecuteWorkflowRequest', 'TestExternalExecuteWorkflowRequest'] +slug: /tools/sdk/powershell/v3/models/test-external-execute-workflow-request +tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflowRequest', 'TestExternalExecuteWorkflowRequest'] +--- + + +# TestExternalExecuteWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarInput** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The test input for the workflow | [optional] + +## Examples + +- Prepare the resource +```powershell +$TestExternalExecuteWorkflowRequest = Initialize-PSSailpoint.V3TestExternalExecuteWorkflowRequest -VarInput {test=hello world} +``` + +- Convert the resource to JSON +```powershell +$TestExternalExecuteWorkflowRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/TestWorkflow200Response.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TestWorkflow200Response.md new file mode 100644 index 000000000..4387864a5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TestWorkflow200Response.md @@ -0,0 +1,35 @@ +--- +id: test-workflow200-response +title: TestWorkflow200Response +pagination_label: TestWorkflow200Response +sidebar_label: TestWorkflow200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TestWorkflow200Response', 'TestWorkflow200Response'] +slug: /tools/sdk/powershell/v3/models/test-workflow200-response +tags: ['SDK', 'Software Development Kit', 'TestWorkflow200Response', 'TestWorkflow200Response'] +--- + + +# TestWorkflow200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**WorkflowExecutionId** | Pointer to **String** | The workflow execution id | [optional] + +## Examples + +- Prepare the resource +```powershell +$TestWorkflow200Response = Initialize-PSSailpoint.V3TestWorkflow200Response -WorkflowExecutionId 0e11cefa-96e7-4b67-90d0-065bc1da5753 +``` + +- Convert the resource to JSON +```powershell +$TestWorkflow200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/TestWorkflowRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TestWorkflowRequest.md new file mode 100644 index 000000000..62b05e306 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TestWorkflowRequest.md @@ -0,0 +1,35 @@ +--- +id: test-workflow-request +title: TestWorkflowRequest +pagination_label: TestWorkflowRequest +sidebar_label: TestWorkflowRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TestWorkflowRequest', 'TestWorkflowRequest'] +slug: /tools/sdk/powershell/v3/models/test-workflow-request +tags: ['SDK', 'Software Development Kit', 'TestWorkflowRequest', 'TestWorkflowRequest'] +--- + + +# TestWorkflowRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**VarInput** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The test input for the workflow. | [required] + +## Examples + +- Prepare the resource +```powershell +$TestWorkflowRequest = Initialize-PSSailpoint.V3TestWorkflowRequest -VarInput null +``` + +- Convert the resource to JSON +```powershell +$TestWorkflowRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/TextQuery.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TextQuery.md new file mode 100644 index 000000000..bfdcc6e5f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TextQuery.md @@ -0,0 +1,41 @@ +--- +id: text-query +title: TextQuery +pagination_label: TextQuery +sidebar_label: TextQuery +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TextQuery', 'TextQuery'] +slug: /tools/sdk/powershell/v3/models/text-query +tags: ['SDK', 'Software Development Kit', 'TextQuery', 'TextQuery'] +--- + + +# TextQuery + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Terms** | **[]String** | Words or characters that specify a particular thing to be searched for. | [required] +**Fields** | **[]String** | The fields to be searched. | [required] +**MatchAny** | Pointer to **Boolean** | Indicates that at least one of the terms must be found in the specified fields; otherwise, all terms must be found. | [optional] [default to $false] +**Contains** | Pointer to **Boolean** | Indicates that the terms can be located anywhere in the specified fields; otherwise, the fields must begin with the terms. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$TextQuery = Initialize-PSSailpoint.V3TextQuery -Terms [The quick brown fox, 3141592, 7] ` + -Fields [displayName, employeeNumber, roleCount] ` + -MatchAny false ` + -Contains true +``` + +- Convert the resource to JSON +```powershell +$TextQuery | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/TokenAuthRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TokenAuthRequest.md new file mode 100644 index 000000000..76945a3e9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TokenAuthRequest.md @@ -0,0 +1,39 @@ +--- +id: token-auth-request +title: TokenAuthRequest +pagination_label: TokenAuthRequest +sidebar_label: TokenAuthRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TokenAuthRequest', 'TokenAuthRequest'] +slug: /tools/sdk/powershell/v3/models/token-auth-request +tags: ['SDK', 'Software Development Kit', 'TokenAuthRequest', 'TokenAuthRequest'] +--- + + +# TokenAuthRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Token** | **String** | Token value | [required] +**UserAlias** | **String** | User alias from table spt_identity field named 'name' | [required] +**DeliveryType** | **Enum** [ "SMS_PERSONAL", "VOICE_PERSONAL", "SMS_WORK", "VOICE_WORK", "EMAIL_WORK", "EMAIL_PERSONAL" ] | Token delivery type | [required] + +## Examples + +- Prepare the resource +```powershell +$TokenAuthRequest = Initialize-PSSailpoint.V3TokenAuthRequest -Token 12345 ` + -UserAlias will.albin ` + -DeliveryType EMAIL_WORK +``` + +- Convert the resource to JSON +```powershell +$TokenAuthRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/TokenAuthResponse.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TokenAuthResponse.md new file mode 100644 index 000000000..323ce035d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TokenAuthResponse.md @@ -0,0 +1,35 @@ +--- +id: token-auth-response +title: TokenAuthResponse +pagination_label: TokenAuthResponse +sidebar_label: TokenAuthResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TokenAuthResponse', 'TokenAuthResponse'] +slug: /tools/sdk/powershell/v3/models/token-auth-response +tags: ['SDK', 'Software Development Kit', 'TokenAuthResponse', 'TokenAuthResponse'] +--- + + +# TokenAuthResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Status** | Pointer to **Enum** [ "PENDING", "SUCCESS", "FAILED", "LOCKOUT", "NOT_ENOUGH_DATA" ] | MFA Authentication status | [optional] + +## Examples + +- Prepare the resource +```powershell +$TokenAuthResponse = Initialize-PSSailpoint.V3TokenAuthResponse -Status PENDING +``` + +- Convert the resource to JSON +```powershell +$TokenAuthResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Transform.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Transform.md new file mode 100644 index 000000000..63dfcf861 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Transform.md @@ -0,0 +1,39 @@ +--- +id: transform +title: Transform +pagination_label: Transform +sidebar_label: Transform +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Transform', 'Transform'] +slug: /tools/sdk/powershell/v3/models/transform +tags: ['SDK', 'Software Development Kit', 'Transform', 'Transform'] +--- + + +# Transform + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Unique name of this transform | [required] +**Type** | **Enum** [ "accountAttribute", "base64Decode", "base64Encode", "concat", "conditional", "dateCompare", "dateFormat", "dateMath", "decomposeDiacriticalMarks", "e164phone", "firstValid", "rule", "identityAttribute", "indexOf", "iso3166", "lastIndexOf", "leftPad", "lookup", "lower", "normalizeNames", "randomAlphaNumeric", "randomNumeric", "reference", "replaceAll", "replace", "rightPad", "split", "static", "substring", "trim", "upper", "usernameGenerator", "uuid", "displayName", "rfc5646" ] | The type of transform operation | [required] +**Attributes** | [**TransformAttributes**](transform-attributes) | | [required] + +## Examples + +- Prepare the resource +```powershell +$Transform = Initialize-PSSailpoint.V3Transform -Name Timestamp To Date ` + -Type dateFormat ` + -Attributes null +``` + +- Convert the resource to JSON +```powershell +$Transform | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/TransformAttributes.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TransformAttributes.md new file mode 100644 index 000000000..b33b7edf8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TransformAttributes.md @@ -0,0 +1,115 @@ +--- +id: transform-attributes +title: TransformAttributes +pagination_label: TransformAttributes +sidebar_label: TransformAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TransformAttributes', 'TransformAttributes'] +slug: /tools/sdk/powershell/v3/models/transform-attributes +tags: ['SDK', 'Software Development Kit', 'TransformAttributes', 'TransformAttributes'] +--- + + +# TransformAttributes + +## Properties + +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] +**Values** | **String** | This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language. | [required] +**Expression** | **String** | A string value of the date and time components to operation on, along with the math operations to execute. | [required] +**PositiveCondition** | **String** | The output of the transform if the expression evalutes to true | [required] +**NegativeCondition** | **String** | The output of the transform if the expression evalutes to false | [required] +**FirstDate** | [**DateCompareFirstDate**](date-compare-first-date) | | [required] +**SecondDate** | [**DateCompareSecondDate**](date-compare-second-date) | | [required] +**Operator** | **Enum** [ "LT", "LTE", "GT", "GTE" ] | This is the comparison to perform. | Operation | Description | | --------- | ------- | | LT | Strictly less than: `firstDate < secondDate` | | LTE | Less than or equal to: `firstDate <= secondDate` | | GT | Strictly greater than: `firstDate > secondDate` | | GTE | Greater than or equal to: `firstDate >= secondDate` | | [required] +**InputFormat** | Pointer to [**DateFormatInputFormat**](date-format-input-format) | | [optional] +**OutputFormat** | Pointer to [**DateFormatOutputFormat**](date-format-output-format) | | [optional] +**RoundUp** | Pointer to **Boolean** | A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. If not provided, the transform will default to `false` `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) | [optional] [default to $false] +**DefaultRegion** | Pointer to **String** | This is an optional attribute that can be used to define the region of the phone number to format into. If defaultRegion is not provided, it will take US as the default country. The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) | [optional] +**IgnoreErrors** | Pointer to **Boolean** | a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. | [optional] [default to $false] +**Name** | **String** | The system (camel-cased) name of the identity attribute to bring in | [required] +**Operation** | **String** | The operation to perform `getReferenceIdentityAttribute` | [required] +**IncludeNumbers** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include numbers | [required] +**IncludeSpecialChars** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include special characters | [required] +**Length** | **String** | An integer value for the desired length of the final output string | [required] +**Uid** | **String** | This is the SailPoint User Name (uid) value of the identity whose attribute is desired As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. | [required] +**Substring** | **String** | A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring. | [required] +**Format** | Pointer to **String** | An optional value to denote which ISO 3166 format to return. Valid values are: `alpha2` - Two-character country code (e.g., ""US""); this is the default value if no format is supplied `alpha3` - Three-character country code (e.g., ""USA"") `numeric` - The numeric country code (e.g., ""840"") | [optional] +**Padding** | Pointer to **String** | A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space ("" "") character for padding | [optional] +**Table** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value. | [required] +**Id** | **String** | This ID specifies the name of the pre-existing transform which you want to use within your current transform | [required] +**Regex** | **String** | This can be a string or a regex pattern in which you want to replace. | [required] +**Replacement** | **String** | This is the replacement string that should be substituded wherever the string or pattern is found. | [required] +**Delimiter** | **String** | This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data | [required] +**Index** | **String** | An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc. | [required] +**Throws** | Pointer to **Boolean** | A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) `true` - The transform should return ""IndexOutOfBoundsException"" `false` - The transform should return null If not provided, the transform will default to false and return a null | [optional] [default to $false] +**VarBegin** | **Int32** | The index of the first character to include in the returned substring. If `begin` is set to -1, the transform will begin at character 0 of the input data | [required] +**BeginOffset** | Pointer to **Int32** | This integer value is the number of characters to add to the begin attribute when returning a substring. This attribute is only used if begin is not -1. | [optional] +**VarEnd** | Pointer to **Int32** | The index of the first character to exclude from the returned substring. If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. | [optional] +**EndOffset** | Pointer to **Int32** | This integer value is the number of characters to add to the end attribute when returning a substring. This attribute is only used if end is provided and is not -1. | [optional] + +## Examples + +- Prepare the resource +```powershell +$TransformAttributes = Initialize-PSSailpoint.V3TransformAttributes -SourceName Workday ` + -AttributeName DEPARTMENT ` + -AccountSortAttribute created ` + -AccountSortDescending false ` + -AccountReturnFirstLink false ` + -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` + -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` + -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` + -Values string$variable ` + -Expression now+1w ` + -PositiveCondition true ` + -NegativeCondition false ` + -FirstDate null ` + -SecondDate null ` + -Operator LT ` + -InputFormat null ` + -OutputFormat null ` + -RoundUp false ` + -DefaultRegion US ` + -IgnoreErrors false ` + -Name email ` + -Operation getReferenceIdentityAttribute ` + -IncludeNumbers true ` + -IncludeSpecialChars true ` + -Length 4 ` + -Uid 2c91808570313110017040b06f344ec9 ` + -Substring admin_ ` + -Format alpha2 ` + -Padding 0 ` + -Table {-= , "=', ñ=n} ` + -Id Existing Transform ` + -Regex [^a-zA-Z] ` + -Replacement ` + -Delimiter , ` + -Index 5 ` + -Throws true ` + -VarBegin 1 ` + -BeginOffset 3 ` + -VarEnd 6 ` + -EndOffset 1 +``` + +- Convert the resource to JSON +```powershell +$TransformAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/TransformDefinition.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TransformDefinition.md new file mode 100644 index 000000000..da65bd5e4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TransformDefinition.md @@ -0,0 +1,37 @@ +--- +id: transform-definition +title: TransformDefinition +pagination_label: TransformDefinition +sidebar_label: TransformDefinition +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TransformDefinition', 'TransformDefinition'] +slug: /tools/sdk/powershell/v3/models/transform-definition +tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'TransformDefinition'] +--- + + +# TransformDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **String** | The type of the transform definition. | [optional] +**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Arbitrary key-value pairs to store any metadata for the object | [optional] + +## Examples + +- Prepare the resource +```powershell +$TransformDefinition = Initialize-PSSailpoint.V3TransformDefinition -Type accountAttribute ` + -Attributes {attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53} +``` + +- Convert the resource to JSON +```powershell +$TransformDefinition | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/TransformRead.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TransformRead.md new file mode 100644 index 000000000..1d20ee39e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TransformRead.md @@ -0,0 +1,43 @@ +--- +id: transform-read +title: TransformRead +pagination_label: TransformRead +sidebar_label: TransformRead +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TransformRead', 'TransformRead'] +slug: /tools/sdk/powershell/v3/models/transform-read +tags: ['SDK', 'Software Development Kit', 'TransformRead', 'TransformRead'] +--- + + +# TransformRead + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | Unique name of this transform | [required] +**Type** | **Enum** [ "accountAttribute", "base64Decode", "base64Encode", "concat", "conditional", "dateCompare", "dateFormat", "dateMath", "decomposeDiacriticalMarks", "e164phone", "firstValid", "rule", "identityAttribute", "indexOf", "iso3166", "lastIndexOf", "leftPad", "lookup", "lower", "normalizeNames", "randomAlphaNumeric", "randomNumeric", "reference", "replaceAll", "replace", "rightPad", "split", "static", "substring", "trim", "upper", "usernameGenerator", "uuid", "displayName", "rfc5646" ] | The type of transform operation | [required] +**Attributes** | [**TransformAttributes**](transform-attributes) | | [required] +**Id** | **String** | Unique ID of this transform | [required] +**Internal** | **Boolean** | Indicates whether this is an internal SailPoint-created transform or a customer-created transform | [required][default to $false] + +## Examples + +- Prepare the resource +```powershell +$TransformRead = Initialize-PSSailpoint.V3TransformRead -Name Timestamp To Date ` + -Type dateFormat ` + -Attributes null ` + -Id 2cd78adghjkja34jh2b1hkjhasuecd ` + -Internal false +``` + +- Convert the resource to JSON +```powershell +$TransformRead | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/TransformRule.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TransformRule.md new file mode 100644 index 000000000..b29c72d68 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TransformRule.md @@ -0,0 +1,37 @@ +--- +id: transform-rule +title: TransformRule +pagination_label: TransformRule +sidebar_label: TransformRule +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TransformRule', 'TransformRule'] +slug: /tools/sdk/powershell/v3/models/transform-rule +tags: ['SDK', 'Software Development Kit', 'TransformRule', 'TransformRule'] +--- + + +# TransformRule + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | This is the name of the Transform rule that needs to be invoked by the transform | [required] +**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] + +## Examples + +- Prepare the resource +```powershell +$TransformRule = Initialize-PSSailpoint.V3TransformRule -Name Transform Calculation Rule ` + -RequiresPeriodicRefresh false +``` + +- Convert the resource to JSON +```powershell +$TransformRule | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Trim.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Trim.md new file mode 100644 index 000000000..eccfb25f3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Trim.md @@ -0,0 +1,37 @@ +--- +id: trim +title: Trim +pagination_label: Trim +sidebar_label: Trim +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Trim', 'Trim'] +slug: /tools/sdk/powershell/v3/models/trim +tags: ['SDK', 'Software Development Kit', 'Trim', 'Trim'] +--- + + +# Trim + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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] + +## Examples + +- Prepare the resource +```powershell +$Trim = Initialize-PSSailpoint.V3Trim -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Trim | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/TypeAheadQuery.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TypeAheadQuery.md new file mode 100644 index 000000000..55f3c38e4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TypeAheadQuery.md @@ -0,0 +1,47 @@ +--- +id: type-ahead-query +title: TypeAheadQuery +pagination_label: TypeAheadQuery +sidebar_label: TypeAheadQuery +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TypeAheadQuery', 'TypeAheadQuery'] +slug: /tools/sdk/powershell/v3/models/type-ahead-query +tags: ['SDK', 'Software Development Kit', 'TypeAheadQuery', 'TypeAheadQuery'] +--- + + +# TypeAheadQuery + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | **String** | The type ahead query string used to construct a phrase prefix match query. | [required] +**Field** | **String** | The field on which to perform the type ahead search. | [required] +**NestedType** | Pointer to **String** | The nested type. | [optional] +**MaxExpansions** | Pointer to **Int32** | The number of suffixes the last term will be expanded into. Influences the performance of the query and the number results returned. Valid values: 1 to 1000. | [optional] [default to 10] +**Size** | Pointer to **Int32** | The max amount of records the search will return. | [optional] [default to 100] +**Sort** | Pointer to **String** | The sort order of the returned records. | [optional] [default to "desc"] +**SortByValue** | Pointer to **Boolean** | The flag that defines the sort type, by count or value. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$TypeAheadQuery = Initialize-PSSailpoint.V3TypeAheadQuery -Query Work ` + -Field source.name ` + -NestedType access ` + -MaxExpansions 10 ` + -Size 100 ` + -Sort asc ` + -SortByValue true +``` + +- Convert the resource to JSON +```powershell +$TypeAheadQuery | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/TypedReference.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TypedReference.md new file mode 100644 index 000000000..26fea51b0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/TypedReference.md @@ -0,0 +1,37 @@ +--- +id: typed-reference +title: TypedReference +pagination_label: TypedReference +sidebar_label: TypedReference +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'TypedReference', 'TypedReference'] +slug: /tools/sdk/powershell/v3/models/typed-reference +tags: ['SDK', 'Software Development Kit', 'TypedReference', 'TypedReference'] +--- + + +# TypedReference + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**DtoType**](dto-type) | | [required] +**Id** | **String** | The id of the object. | [required] + +## Examples + +- Prepare the resource +```powershell +$TypedReference = Initialize-PSSailpoint.V3TypedReference -Type null ` + -Id 2c91808568c529c60168cca6f90c1313 +``` + +- Convert the resource to JSON +```powershell +$TypedReference | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/UUIDGenerator.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/UUIDGenerator.md new file mode 100644 index 000000000..e26e414dc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/UUIDGenerator.md @@ -0,0 +1,35 @@ +--- +id: uuid-generator +title: UUIDGenerator +pagination_label: UUIDGenerator +sidebar_label: UUIDGenerator +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UUIDGenerator', 'UUIDGenerator'] +slug: /tools/sdk/powershell/v3/models/uuid-generator +tags: ['SDK', 'Software Development Kit', 'UUIDGenerator', 'UUIDGenerator'] +--- + + +# UUIDGenerator + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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] + +## Examples + +- Prepare the resource +```powershell +$UUIDGenerator = Initialize-PSSailpoint.V3UUIDGenerator -RequiresPeriodicRefresh false +``` + +- Convert the resource to JSON +```powershell +$UUIDGenerator | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/UncorrelatedAccountsReportArguments.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/UncorrelatedAccountsReportArguments.md new file mode 100644 index 000000000..a8ff5eed3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/UncorrelatedAccountsReportArguments.md @@ -0,0 +1,35 @@ +--- +id: uncorrelated-accounts-report-arguments +title: UncorrelatedAccountsReportArguments +pagination_label: UncorrelatedAccountsReportArguments +sidebar_label: UncorrelatedAccountsReportArguments +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UncorrelatedAccountsReportArguments', 'UncorrelatedAccountsReportArguments'] +slug: /tools/sdk/powershell/v3/models/uncorrelated-accounts-report-arguments +tags: ['SDK', 'Software Development Kit', 'UncorrelatedAccountsReportArguments', 'UncorrelatedAccountsReportArguments'] +--- + + +# UncorrelatedAccountsReportArguments + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SelectedFormats** | Pointer to **[]String** | Output report file formats. These are formats for calling GET endpoint as query parameter 'fileFormat'. In case report won't have this argument there will be ['CSV', 'PDF'] as default. | [optional] + +## Examples + +- Prepare the resource +```powershell +$UncorrelatedAccountsReportArguments = Initialize-PSSailpoint.V3UncorrelatedAccountsReportArguments -SelectedFormats [CSV] +``` + +- Convert the resource to JSON +```powershell +$UncorrelatedAccountsReportArguments | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/UpdateDetail.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/UpdateDetail.md new file mode 100644 index 000000000..8cca88b94 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/UpdateDetail.md @@ -0,0 +1,41 @@ +--- +id: update-detail +title: UpdateDetail +pagination_label: UpdateDetail +sidebar_label: UpdateDetail +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UpdateDetail', 'UpdateDetail'] +slug: /tools/sdk/powershell/v3/models/update-detail +tags: ['SDK', 'Software Development Kit', 'UpdateDetail', 'UpdateDetail'] +--- + + +# UpdateDetail + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Message** | Pointer to **String** | The detailed message for an update. Typically the relevent error message when status is error. | [optional] +**ScriptName** | Pointer to **String** | The connector script name | [optional] +**UpdatedFiles** | Pointer to **[]String** | The list of updated files supported by the connector | [optional] +**Status** | Pointer to **Enum** [ "ERROR", "UPDATED", "UNCHANGED", "SKIPPED" ] | The connector update status | [optional] + +## Examples + +- Prepare the resource +```powershell +$UpdateDetail = Initialize-PSSailpoint.V3UpdateDetail -Message unsupported xsd version, please ensure latest xsd version http://www.sailpoint.com/xsd/sailpoint_form_2_0.xsd is used for source config ` + -ScriptName servicenow ` + -UpdatedFiles [pod/org/connectorFiles/testconnector/test1.jar] ` + -Status ERROR +``` + +- Convert the resource to JSON +```powershell +$UpdateDetail | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Upper.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Upper.md new file mode 100644 index 000000000..2caf6a43c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Upper.md @@ -0,0 +1,37 @@ +--- +id: upper +title: Upper +pagination_label: Upper +sidebar_label: Upper +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Upper', 'Upper'] +slug: /tools/sdk/powershell/v3/models/upper +tags: ['SDK', 'Software Development Kit', 'Upper', 'Upper'] +--- + + +# Upper + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**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] + +## Examples + +- Prepare the resource +```powershell +$Upper = Initialize-PSSailpoint.V3Upper -RequiresPeriodicRefresh false ` + -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} +``` + +- Convert the resource to JSON +```powershell +$Upper | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/UsageType.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/UsageType.md new file mode 100644 index 000000000..8b3ef89cb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/UsageType.md @@ -0,0 +1,52 @@ +--- +id: usage-type +title: UsageType +pagination_label: UsageType +sidebar_label: UsageType +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'UsageType', 'UsageType'] +slug: /tools/sdk/powershell/v3/models/usage-type +tags: ['SDK', 'Software Development Kit', 'UsageType', 'UsageType'] +--- + + +# UsageType + +## Enum + + +* `CREATE` (value: `"CREATE"`) + +* `UPDATE` (value: `"UPDATE"`) + +* `ENABLE` (value: `"ENABLE"`) + +* `DISABLE` (value: `"DISABLE"`) + +* `DELETE` (value: `"DELETE"`) + +* `ASSIGN` (value: `"ASSIGN"`) + +* `UNASSIGN` (value: `"UNASSIGN"`) + +* `CREATE_GROUP` (value: `"CREATE_GROUP"`) + +* `UPDATE_GROUP` (value: `"UPDATE_GROUP"`) + +* `DELETE_GROUP` (value: `"DELETE_GROUP"`) + +* `REGISTER` (value: `"REGISTER"`) + +* `CREATE_IDENTITY` (value: `"CREATE_IDENTITY"`) + +* `UPDATE_IDENTITY` (value: `"UPDATE_IDENTITY"`) + +* `EDIT_GROUP` (value: `"EDIT_GROUP"`) + +* `UNLOCK` (value: `"UNLOCK"`) + +* `CHANGE_PASSWORD` (value: `"CHANGE_PASSWORD"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/V3ConnectorDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/V3ConnectorDto.md new file mode 100644 index 000000000..6520b6153 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/V3ConnectorDto.md @@ -0,0 +1,49 @@ +--- +id: v3-connector-dto +title: V3ConnectorDto +pagination_label: V3ConnectorDto +sidebar_label: V3ConnectorDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'V3ConnectorDto', 'V3ConnectorDto'] +slug: /tools/sdk/powershell/v3/models/v3-connector-dto +tags: ['SDK', 'Software Development Kit', 'V3ConnectorDto', 'V3ConnectorDto'] +--- + + +# V3ConnectorDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The connector name | [optional] +**Type** | Pointer to **String** | The connector type | [optional] +**ScriptName** | Pointer to **String** | The connector script name | [optional] +**ClassName** | Pointer to **String** | The connector class name. | [optional] +**Features** | Pointer to **[]String** | The list of features supported by the connector | [optional] +**DirectConnect** | Pointer to **Boolean** | true if the source is a direct connect source | [optional] [default to $false] +**ConnectorMetadata** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map containing metadata pertinent to the connector | [optional] +**Status** | Pointer to **Enum** [ "DEPRECATED", "DEVELOPMENT", "DEMO", "RELEASED" ] | The connector status | [optional] + +## Examples + +- Prepare the resource +```powershell +$V3ConnectorDto = Initialize-PSSailpoint.V3V3ConnectorDto -Name name ` + -Type ServiceNow ` + -ScriptName servicenow ` + -ClassName sailpoint.connector.OpenConnectorAdapter ` + -Features [PROVISIONING, SYNC_PROVISIONING, SEARCH, UNSTRUCTURED_TARGETS] ` + -DirectConnect true ` + -ConnectorMetadata {supportedUI=ANGULAR, platform=ccg, shortDesc=connector description} ` + -Status RELEASED +``` + +- Convert the resource to JSON +```powershell +$V3ConnectorDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/V3CreateConnectorDto.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/V3CreateConnectorDto.md new file mode 100644 index 000000000..3e13399c4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/V3CreateConnectorDto.md @@ -0,0 +1,43 @@ +--- +id: v3-create-connector-dto +title: V3CreateConnectorDto +pagination_label: V3CreateConnectorDto +sidebar_label: V3CreateConnectorDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'V3CreateConnectorDto', 'V3CreateConnectorDto'] +slug: /tools/sdk/powershell/v3/models/v3-create-connector-dto +tags: ['SDK', 'Software Development Kit', 'V3CreateConnectorDto', 'V3CreateConnectorDto'] +--- + + +# V3CreateConnectorDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **String** | The connector name. Need to be unique per tenant. The name will able be used to derive a url friendly unique scriptname that will be in response. Script name can then be used for all update endpoints | [required] +**Type** | Pointer to **String** | The connector type. If not specified will be defaulted to 'custom '+name | [optional] +**ClassName** | **String** | The connector class name. If you are implementing openconnector standard (what is recommended), then this need to be set to sailpoint.connector.OpenConnectorAdapter | [required] +**DirectConnect** | Pointer to **Boolean** | true if the source is a direct connect source | [optional] [default to $true] +**Status** | Pointer to **Enum** [ "DEVELOPMENT", "DEMO", "RELEASED" ] | The connector status | [optional] + +## Examples + +- Prepare the resource +```powershell +$V3CreateConnectorDto = Initialize-PSSailpoint.V3V3CreateConnectorDto -Name custom connector ` + -Type custom connector type ` + -ClassName sailpoint.connector.OpenConnectorAdapter ` + -DirectConnect true ` + -Status RELEASED +``` + +- Convert the resource to JSON +```powershell +$V3CreateConnectorDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Value.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Value.md new file mode 100644 index 000000000..d1526eaa1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Value.md @@ -0,0 +1,37 @@ +--- +id: value +title: Value +pagination_label: Value +sidebar_label: Value +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Value', 'Value'] +slug: /tools/sdk/powershell/v3/models/value +tags: ['SDK', 'Software Development Kit', 'Value', 'Value'] +--- + + +# Value + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **String** | The type of attribute value | [optional] +**Value** | Pointer to **String** | The attribute value | [optional] + +## Examples + +- Prepare the resource +```powershell +$Value = Initialize-PSSailpoint.V3Value -Type STRING ` + -Value Austin +``` + +- Convert the resource to JSON +```powershell +$Value | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/VendorConnectorMapping.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/VendorConnectorMapping.md new file mode 100644 index 000000000..ffec80b8b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/VendorConnectorMapping.md @@ -0,0 +1,51 @@ +--- +id: vendor-connector-mapping +title: VendorConnectorMapping +pagination_label: VendorConnectorMapping +sidebar_label: VendorConnectorMapping +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMapping', 'VendorConnectorMapping'] +slug: /tools/sdk/powershell/v3/models/vendor-connector-mapping +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMapping', 'VendorConnectorMapping'] +--- + + +# VendorConnectorMapping + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | The unique identifier for the vendor-connector mapping. | [optional] +**Vendor** | Pointer to **String** | The name of the vendor. | [optional] +**Connector** | Pointer to **String** | The name of the connector. | [optional] +**CreatedAt** | Pointer to **System.DateTime** | The creation timestamp of the mapping. | [optional] +**CreatedBy** | Pointer to **String** | The identifier of the user who created the mapping. | [optional] +**UpdatedAt** | Pointer to [**VendorConnectorMappingUpdatedAt**](vendor-connector-mapping-updated-at) | | [optional] +**UpdatedBy** | Pointer to [**VendorConnectorMappingUpdatedBy**](vendor-connector-mapping-updated-by) | | [optional] +**DeletedAt** | Pointer to [**VendorConnectorMappingDeletedAt**](vendor-connector-mapping-deleted-at) | | [optional] +**DeletedBy** | Pointer to [**VendorConnectorMappingDeletedBy**](vendor-connector-mapping-deleted-by) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$VendorConnectorMapping = Initialize-PSSailpoint.V3VendorConnectorMapping -Id 78733556-9ea3-4f59-bf69-e5cd92b011b4 ` + -Vendor Example vendor ` + -Connector Example connector ` + -CreatedAt 2024-03-13T12:56:19.391294Z ` + -CreatedBy admin ` + -UpdatedAt null ` + -UpdatedBy null ` + -DeletedAt null ` + -DeletedBy null +``` + +- Convert the resource to JSON +```powershell +$VendorConnectorMapping | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/VendorConnectorMappingDeletedAt.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/VendorConnectorMappingDeletedAt.md new file mode 100644 index 000000000..8b18bb48b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/VendorConnectorMappingDeletedAt.md @@ -0,0 +1,37 @@ +--- +id: vendor-connector-mapping-deleted-at +title: VendorConnectorMappingDeletedAt +pagination_label: VendorConnectorMappingDeletedAt +sidebar_label: VendorConnectorMappingDeletedAt +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMappingDeletedAt', 'VendorConnectorMappingDeletedAt'] +slug: /tools/sdk/powershell/v3/models/vendor-connector-mapping-deleted-at +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingDeletedAt', 'VendorConnectorMappingDeletedAt'] +--- + + +# VendorConnectorMappingDeletedAt + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Time** | Pointer to **System.DateTime** | The timestamp when the mapping was deleted, represented in ISO 8601 format, if applicable. | [optional] +**Valid** | Pointer to **Boolean** | A flag indicating if the 'Time' field is set and valid, i.e., if the mapping has been deleted. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$VendorConnectorMappingDeletedAt = Initialize-PSSailpoint.V3VendorConnectorMappingDeletedAt -Time 0001-01-01T00:00Z ` + -Valid false +``` + +- Convert the resource to JSON +```powershell +$VendorConnectorMappingDeletedAt | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/VendorConnectorMappingDeletedBy.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/VendorConnectorMappingDeletedBy.md new file mode 100644 index 000000000..f91e6dbd1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/VendorConnectorMappingDeletedBy.md @@ -0,0 +1,37 @@ +--- +id: vendor-connector-mapping-deleted-by +title: VendorConnectorMappingDeletedBy +pagination_label: VendorConnectorMappingDeletedBy +sidebar_label: VendorConnectorMappingDeletedBy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMappingDeletedBy', 'VendorConnectorMappingDeletedBy'] +slug: /tools/sdk/powershell/v3/models/vendor-connector-mapping-deleted-by +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingDeletedBy', 'VendorConnectorMappingDeletedBy'] +--- + + +# VendorConnectorMappingDeletedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**String** | Pointer to **String** | The identifier of the user who deleted the mapping, if applicable. | [optional] +**Valid** | Pointer to **Boolean** | A flag indicating if the 'String' field is set and valid, i.e., if the mapping has been deleted. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$VendorConnectorMappingDeletedBy = Initialize-PSSailpoint.V3VendorConnectorMappingDeletedBy -String ` + -Valid false +``` + +- Convert the resource to JSON +```powershell +$VendorConnectorMappingDeletedBy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/VendorConnectorMappingUpdatedAt.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/VendorConnectorMappingUpdatedAt.md new file mode 100644 index 000000000..6ef581f1a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/VendorConnectorMappingUpdatedAt.md @@ -0,0 +1,37 @@ +--- +id: vendor-connector-mapping-updated-at +title: VendorConnectorMappingUpdatedAt +pagination_label: VendorConnectorMappingUpdatedAt +sidebar_label: VendorConnectorMappingUpdatedAt +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMappingUpdatedAt', 'VendorConnectorMappingUpdatedAt'] +slug: /tools/sdk/powershell/v3/models/vendor-connector-mapping-updated-at +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingUpdatedAt', 'VendorConnectorMappingUpdatedAt'] +--- + + +# VendorConnectorMappingUpdatedAt + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Time** | Pointer to **System.DateTime** | The timestamp when the mapping was last updated, represented in ISO 8601 format. | [optional] +**Valid** | Pointer to **Boolean** | A flag indicating if the 'Time' field is set and valid. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$VendorConnectorMappingUpdatedAt = Initialize-PSSailpoint.V3VendorConnectorMappingUpdatedAt -Time 2024-03-14T12:56:19.391294Z ` + -Valid true +``` + +- Convert the resource to JSON +```powershell +$VendorConnectorMappingUpdatedAt | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/VendorConnectorMappingUpdatedBy.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/VendorConnectorMappingUpdatedBy.md new file mode 100644 index 000000000..d9cf7e72c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/VendorConnectorMappingUpdatedBy.md @@ -0,0 +1,37 @@ +--- +id: vendor-connector-mapping-updated-by +title: VendorConnectorMappingUpdatedBy +pagination_label: VendorConnectorMappingUpdatedBy +sidebar_label: VendorConnectorMappingUpdatedBy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMappingUpdatedBy', 'VendorConnectorMappingUpdatedBy'] +slug: /tools/sdk/powershell/v3/models/vendor-connector-mapping-updated-by +tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingUpdatedBy', 'VendorConnectorMappingUpdatedBy'] +--- + + +# VendorConnectorMappingUpdatedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**String** | Pointer to **String** | The identifier of the user who last updated the mapping, if available. | [optional] +**Valid** | Pointer to **Boolean** | A flag indicating if the 'String' field is set and valid. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$VendorConnectorMappingUpdatedBy = Initialize-PSSailpoint.V3VendorConnectorMappingUpdatedBy -String user-67891 ` + -Valid true +``` + +- Convert the resource to JSON +```powershell +$VendorConnectorMappingUpdatedBy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/VerificationPollRequest.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/VerificationPollRequest.md new file mode 100644 index 000000000..c6399244e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/VerificationPollRequest.md @@ -0,0 +1,35 @@ +--- +id: verification-poll-request +title: VerificationPollRequest +pagination_label: VerificationPollRequest +sidebar_label: VerificationPollRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VerificationPollRequest', 'VerificationPollRequest'] +slug: /tools/sdk/powershell/v3/models/verification-poll-request +tags: ['SDK', 'Software Development Kit', 'VerificationPollRequest', 'VerificationPollRequest'] +--- + + +# VerificationPollRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | **String** | Verification request Id | [required] + +## Examples + +- Prepare the resource +```powershell +$VerificationPollRequest = Initialize-PSSailpoint.V3VerificationPollRequest -RequestId 089899f13a8f4da7824996191587bab9 +``` + +- Convert the resource to JSON +```powershell +$VerificationPollRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/VerificationResponse.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/VerificationResponse.md new file mode 100644 index 000000000..5ae6b9922 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/VerificationResponse.md @@ -0,0 +1,39 @@ +--- +id: verification-response +title: VerificationResponse +pagination_label: VerificationResponse +sidebar_label: VerificationResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VerificationResponse', 'VerificationResponse'] +slug: /tools/sdk/powershell/v3/models/verification-response +tags: ['SDK', 'Software Development Kit', 'VerificationResponse', 'VerificationResponse'] +--- + + +# VerificationResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestId** | Pointer to **String** | The verificationPollRequest request ID | [optional] +**Status** | Pointer to **Enum** [ "PENDING", "SUCCESS", "FAILED", "LOCKOUT", "NOT_ENOUGH_DATA" ] | MFA Authentication status | [optional] +**VarError** | Pointer to **String** | Error messages from MFA verification request | [optional] + +## Examples + +- Prepare the resource +```powershell +$VerificationResponse = Initialize-PSSailpoint.V3VerificationResponse -RequestId 089899f13a8f4da7824996191587bab9 ` + -Status SUCCESS ` + -VarError Unable to connect DUO Service during verification +``` + +- Convert the resource to JSON +```powershell +$VerificationResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ViolationContext.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ViolationContext.md new file mode 100644 index 000000000..6115f7532 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ViolationContext.md @@ -0,0 +1,37 @@ +--- +id: violation-context +title: ViolationContext +pagination_label: ViolationContext +sidebar_label: ViolationContext +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationContext', 'ViolationContext'] +slug: /tools/sdk/powershell/v3/models/violation-context +tags: ['SDK', 'Software Development Kit', 'ViolationContext', 'ViolationContext'] +--- + + +# ViolationContext + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Policy** | Pointer to [**ViolationContextPolicy**](violation-context-policy) | | [optional] +**ConflictingAccessCriteria** | Pointer to [**ExceptionAccessCriteria**](exception-access-criteria) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ViolationContext = Initialize-PSSailpoint.V3ViolationContext -Policy null ` + -ConflictingAccessCriteria null +``` + +- Convert the resource to JSON +```powershell +$ViolationContext | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ViolationContextPolicy.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ViolationContextPolicy.md new file mode 100644 index 000000000..1990915d7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ViolationContextPolicy.md @@ -0,0 +1,39 @@ +--- +id: violation-context-policy +title: ViolationContextPolicy +pagination_label: ViolationContextPolicy +sidebar_label: ViolationContextPolicy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationContextPolicy', 'ViolationContextPolicy'] +slug: /tools/sdk/powershell/v3/models/violation-context-policy +tags: ['SDK', 'Software Development Kit', 'ViolationContextPolicy', 'ViolationContextPolicy'] +--- + + +# ViolationContextPolicy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | The type of object that is referenced | [optional] +**Id** | Pointer to **String** | SOD policy ID. | [optional] +**Name** | Pointer to **String** | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ViolationContextPolicy = Initialize-PSSailpoint.V3ViolationContextPolicy -Type ENTITLEMENT ` + -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` + -Name A very cool policy name +``` + +- Convert the resource to JSON +```powershell +$ViolationContextPolicy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ViolationOwnerAssignmentConfig.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ViolationOwnerAssignmentConfig.md new file mode 100644 index 000000000..0215ceb7e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ViolationOwnerAssignmentConfig.md @@ -0,0 +1,37 @@ +--- +id: violation-owner-assignment-config +title: ViolationOwnerAssignmentConfig +pagination_label: ViolationOwnerAssignmentConfig +sidebar_label: ViolationOwnerAssignmentConfig +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationOwnerAssignmentConfig', 'ViolationOwnerAssignmentConfig'] +slug: /tools/sdk/powershell/v3/models/violation-owner-assignment-config +tags: ['SDK', 'Software Development Kit', 'ViolationOwnerAssignmentConfig', 'ViolationOwnerAssignmentConfig'] +--- + + +# ViolationOwnerAssignmentConfig + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AssignmentRule** | Pointer to **Enum** [ "MANAGER", "STATIC" ] | Details about the violations owner. MANAGER - identity's manager STATIC - Governance Group or Identity | [optional] +**OwnerRef** | Pointer to [**ViolationOwnerAssignmentConfigOwnerRef**](violation-owner-assignment-config-owner-ref) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$ViolationOwnerAssignmentConfig = Initialize-PSSailpoint.V3ViolationOwnerAssignmentConfig -AssignmentRule MANAGER ` + -OwnerRef null +``` + +- Convert the resource to JSON +```powershell +$ViolationOwnerAssignmentConfig | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ViolationOwnerAssignmentConfigOwnerRef.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ViolationOwnerAssignmentConfigOwnerRef.md new file mode 100644 index 000000000..93834d1a7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ViolationOwnerAssignmentConfigOwnerRef.md @@ -0,0 +1,39 @@ +--- +id: violation-owner-assignment-config-owner-ref +title: ViolationOwnerAssignmentConfigOwnerRef +pagination_label: ViolationOwnerAssignmentConfigOwnerRef +sidebar_label: ViolationOwnerAssignmentConfigOwnerRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationOwnerAssignmentConfigOwnerRef', 'ViolationOwnerAssignmentConfigOwnerRef'] +slug: /tools/sdk/powershell/v3/models/violation-owner-assignment-config-owner-ref +tags: ['SDK', 'Software Development Kit', 'ViolationOwnerAssignmentConfigOwnerRef', 'ViolationOwnerAssignmentConfigOwnerRef'] +--- + + +# ViolationOwnerAssignmentConfigOwnerRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY", "GOVERNANCE_GROUP", "MANAGER" ] | Owner type. | [optional] +**Id** | Pointer to **String** | Owner's ID. | [optional] +**Name** | Pointer to **String** | Owner's name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ViolationOwnerAssignmentConfigOwnerRef = Initialize-PSSailpoint.V3ViolationOwnerAssignmentConfigOwnerRef -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Support +``` + +- Convert the resource to JSON +```powershell +$ViolationOwnerAssignmentConfigOwnerRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/ViolationPrediction.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ViolationPrediction.md new file mode 100644 index 000000000..0f3507146 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/ViolationPrediction.md @@ -0,0 +1,35 @@ +--- +id: violation-prediction +title: ViolationPrediction +pagination_label: ViolationPrediction +sidebar_label: ViolationPrediction +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationPrediction', 'ViolationPrediction'] +slug: /tools/sdk/powershell/v3/models/violation-prediction +tags: ['SDK', 'Software Development Kit', 'ViolationPrediction', 'ViolationPrediction'] +--- + + +# ViolationPrediction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ViolationContexts** | Pointer to [**[]ViolationContext**](violation-context) | List of Violation Contexts | [optional] + +## Examples + +- Prepare the resource +```powershell +$ViolationPrediction = Initialize-PSSailpoint.V3ViolationPrediction -ViolationContexts null +``` + +- Convert the resource to JSON +```powershell +$ViolationPrediction | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/VisibilityCriteria.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/VisibilityCriteria.md new file mode 100644 index 000000000..30bc22365 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/VisibilityCriteria.md @@ -0,0 +1,35 @@ +--- +id: visibility-criteria +title: VisibilityCriteria +pagination_label: VisibilityCriteria +sidebar_label: VisibilityCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'VisibilityCriteria', 'VisibilityCriteria'] +slug: /tools/sdk/powershell/v3/models/visibility-criteria +tags: ['SDK', 'Software Development Kit', 'VisibilityCriteria', 'VisibilityCriteria'] +--- + + +# VisibilityCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Expression** | Pointer to [**Expression**](expression) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$VisibilityCriteria = Initialize-PSSailpoint.V3VisibilityCriteria -Expression null +``` + +- Convert the resource to JSON +```powershell +$VisibilityCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkItemForward.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkItemForward.md new file mode 100644 index 000000000..6d3e0b62e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkItemForward.md @@ -0,0 +1,39 @@ +--- +id: work-item-forward +title: WorkItemForward +pagination_label: WorkItemForward +sidebar_label: WorkItemForward +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemForward', 'WorkItemForward'] +slug: /tools/sdk/powershell/v3/models/work-item-forward +tags: ['SDK', 'Software Development Kit', 'WorkItemForward', 'WorkItemForward'] +--- + + +# WorkItemForward + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TargetOwnerId** | **String** | The ID of the identity to forward this work item to. | [required] +**Comment** | **String** | Comments to send to the target owner | [required] +**SendNotifications** | Pointer to **Boolean** | If true, send a notification to the target owner. | [optional] [default to $true] + +## Examples + +- Prepare the resource +```powershell +$WorkItemForward = Initialize-PSSailpoint.V3WorkItemForward -TargetOwnerId 2c9180835d2e5168015d32f890ca1581 ` + -Comment I'm going on vacation. ` + -SendNotifications true +``` + +- Convert the resource to JSON +```powershell +$WorkItemForward | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkItemState.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkItemState.md new file mode 100644 index 000000000..98183e7d8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkItemState.md @@ -0,0 +1,32 @@ +--- +id: work-item-state +title: WorkItemState +pagination_label: WorkItemState +sidebar_label: WorkItemState +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemState', 'WorkItemState'] +slug: /tools/sdk/powershell/v3/models/work-item-state +tags: ['SDK', 'Software Development Kit', 'WorkItemState', 'WorkItemState'] +--- + + +# WorkItemState + +## Enum + + +* `Finished` (value: `"Finished"`) + +* `Rejected` (value: `"Rejected"`) + +* `Returned` (value: `"Returned"`) + +* `Expired` (value: `"Expired"`) + +* `Pending` (value: `"Pending"`) + +* `Canceled` (value: `"Canceled"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkItemStateManualWorkItems.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkItemStateManualWorkItems.md new file mode 100644 index 000000000..be35bc8b5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkItemStateManualWorkItems.md @@ -0,0 +1,32 @@ +--- +id: work-item-state-manual-work-items +title: WorkItemStateManualWorkItems +pagination_label: WorkItemStateManualWorkItems +sidebar_label: WorkItemStateManualWorkItems +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemStateManualWorkItems', 'WorkItemStateManualWorkItems'] +slug: /tools/sdk/powershell/v3/models/work-item-state-manual-work-items +tags: ['SDK', 'Software Development Kit', 'WorkItemStateManualWorkItems', 'WorkItemStateManualWorkItems'] +--- + + +# WorkItemStateManualWorkItems + +## Enum + + +* `Finished` (value: `"Finished"`) + +* `Rejected` (value: `"Rejected"`) + +* `Returned` (value: `"Returned"`) + +* `Expired` (value: `"Expired"`) + +* `Pending` (value: `"Pending"`) + +* `Canceled` (value: `"Canceled"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkItemTypeManualWorkItems.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkItemTypeManualWorkItems.md new file mode 100644 index 000000000..94c575362 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkItemTypeManualWorkItems.md @@ -0,0 +1,48 @@ +--- +id: work-item-type-manual-work-items +title: WorkItemTypeManualWorkItems +pagination_label: WorkItemTypeManualWorkItems +sidebar_label: WorkItemTypeManualWorkItems +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemTypeManualWorkItems', 'WorkItemTypeManualWorkItems'] +slug: /tools/sdk/powershell/v3/models/work-item-type-manual-work-items +tags: ['SDK', 'Software Development Kit', 'WorkItemTypeManualWorkItems', 'WorkItemTypeManualWorkItems'] +--- + + +# WorkItemTypeManualWorkItems + +## Enum + + +* `Generic` (value: `"Generic"`) + +* `Certification` (value: `"Certification"`) + +* `Remediation` (value: `"Remediation"`) + +* `Delegation` (value: `"Delegation"`) + +* `Approval` (value: `"Approval"`) + +* `ViolationReview` (value: `"ViolationReview"`) + +* `Form` (value: `"Form"`) + +* `PolicyVioloation` (value: `"PolicyVioloation"`) + +* `Challenge` (value: `"Challenge"`) + +* `ImpactAnalysis` (value: `"ImpactAnalysis"`) + +* `Signoff` (value: `"Signoff"`) + +* `Event` (value: `"Event"`) + +* `ManualAction` (value: `"ManualAction"`) + +* `Test` (value: `"Test"`) + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkItems.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkItems.md new file mode 100644 index 000000000..8ca3097fd --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkItems.md @@ -0,0 +1,67 @@ +--- +id: work-items +title: WorkItems +pagination_label: WorkItems +sidebar_label: WorkItems +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItems', 'WorkItems'] +slug: /tools/sdk/powershell/v3/models/work-items +tags: ['SDK', 'Software Development Kit', 'WorkItems', 'WorkItems'] +--- + + +# WorkItems + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the work item | [optional] +**RequesterId** | Pointer to **String** | ID of the requester | [optional] +**RequesterDisplayName** | Pointer to **String** | The displayname of the requester | [optional] +**OwnerId** | Pointer to **String** | The ID of the owner | [optional] +**OwnerName** | Pointer to **String** | The name of the owner | [optional] +**Created** | Pointer to **System.DateTime** | Time when the work item was created | [optional] +**Modified** | Pointer to **System.DateTime** | Time when the work item was last updated | [optional] +**Description** | Pointer to **String** | The description of the work item | [optional] +**State** | Pointer to [**WorkItemStateManualWorkItems**](work-item-state-manual-work-items) | | [optional] +**Type** | Pointer to [**WorkItemTypeManualWorkItems**](work-item-type-manual-work-items) | | [optional] +**RemediationItems** | Pointer to [**[]RemediationItemDetails**](remediation-item-details) | A list of remediation items | [optional] +**ApprovalItems** | Pointer to [**[]ApprovalItemDetails**](approval-item-details) | A list of items that need to be approved | [optional] +**Name** | Pointer to **String** | The work item name | [optional] +**Completed** | Pointer to **System.DateTime** | The time at which the work item completed | [optional] +**NumItems** | Pointer to **Int32** | The number of items in the work item | [optional] +**Form** | Pointer to [**WorkItemsForm**](work-items-form) | | [optional] +**Errors** | Pointer to **[]String** | An array of errors that ocurred during the work item | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkItems = Initialize-PSSailpoint.V3WorkItems -Id 2c9180835d2e5168015d32f890ca1581 ` + -RequesterId 2c9180835d2e5168015d32f890ca1581 ` + -RequesterDisplayName John Smith ` + -OwnerId 2c9180835d2e5168015d32f890ca1581 ` + -OwnerName Jason Smith ` + -Created 2017-07-11T18:45:37.098Z ` + -Modified 2018-06-25T20:22:28.104Z ` + -Description Create account on source 'AD' ` + -State null ` + -Type null ` + -RemediationItems null ` + -ApprovalItems null ` + -Name Account Create ` + -Completed 2018-10-19T13:49:37.385Z ` + -NumItems 19 ` + -Form null ` + -Errors [The work item ID that was specified was not found.] +``` + +- Convert the resource to JSON +```powershell +$WorkItems | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkItemsCount.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkItemsCount.md new file mode 100644 index 000000000..523623ce5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkItemsCount.md @@ -0,0 +1,35 @@ +--- +id: work-items-count +title: WorkItemsCount +pagination_label: WorkItemsCount +sidebar_label: WorkItemsCount +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemsCount', 'WorkItemsCount'] +slug: /tools/sdk/powershell/v3/models/work-items-count +tags: ['SDK', 'Software Development Kit', 'WorkItemsCount', 'WorkItemsCount'] +--- + + +# WorkItemsCount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Count** | Pointer to **Int32** | The count of work items | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkItemsCount = Initialize-PSSailpoint.V3WorkItemsCount -Count 29 +``` + +- Convert the resource to JSON +```powershell +$WorkItemsCount | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkItemsForm.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkItemsForm.md new file mode 100644 index 000000000..a53a8f5ed --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkItemsForm.md @@ -0,0 +1,45 @@ +--- +id: work-items-form +title: WorkItemsForm +pagination_label: WorkItemsForm +sidebar_label: WorkItemsForm +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemsForm', 'WorkItemsForm'] +slug: /tools/sdk/powershell/v3/models/work-items-form +tags: ['SDK', 'Software Development Kit', 'WorkItemsForm', 'WorkItemsForm'] +--- + + +# WorkItemsForm + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | ID of the form | [optional] +**Name** | Pointer to **String** | Name of the form | [optional] +**Title** | Pointer to **String** | The form title | [optional] +**Subtitle** | Pointer to **String** | The form subtitle. | [optional] +**TargetUser** | Pointer to **String** | The name of the user that should be shown this form | [optional] +**Sections** | Pointer to [**[]SectionDetails**](section-details) | Sections of the form | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkItemsForm = Initialize-PSSailpoint.V3WorkItemsForm -Id 2c9180835d2e5168015d32f890ca1581 ` + -Name AccountSelection Form ` + -Title Account Selection for John.Doe ` + -Subtitle Please select from the following ` + -TargetUser Jane.Doe ` + -Sections null +``` + +- Convert the resource to JSON +```powershell +$WorkItemsForm | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkItemsSummary.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkItemsSummary.md new file mode 100644 index 000000000..d559bc00f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkItemsSummary.md @@ -0,0 +1,39 @@ +--- +id: work-items-summary +title: WorkItemsSummary +pagination_label: WorkItemsSummary +sidebar_label: WorkItemsSummary +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemsSummary', 'WorkItemsSummary'] +slug: /tools/sdk/powershell/v3/models/work-items-summary +tags: ['SDK', 'Software Development Kit', 'WorkItemsSummary', 'WorkItemsSummary'] +--- + + +# WorkItemsSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Open** | Pointer to **Int32** | The count of open work items | [optional] +**Completed** | Pointer to **Int32** | The count of completed work items | [optional] +**Total** | Pointer to **Int32** | The count of total work items | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkItemsSummary = Initialize-PSSailpoint.V3WorkItemsSummary -Open 29 ` + -Completed 1 ` + -Total 30 +``` + +- Convert the resource to JSON +```powershell +$WorkItemsSummary | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/Workflow.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Workflow.md new file mode 100644 index 000000000..40dbf21ce --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/Workflow.md @@ -0,0 +1,59 @@ +--- +id: workflow +title: Workflow +pagination_label: Workflow +sidebar_label: Workflow +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Workflow', 'Workflow'] +slug: /tools/sdk/powershell/v3/models/workflow +tags: ['SDK', 'Software Development Kit', 'Workflow', 'Workflow'] +--- + + +# Workflow + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the workflow | [optional] +**Owner** | Pointer to [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] +**Description** | Pointer to **String** | Description of what the workflow accomplishes | [optional] +**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] +**Enabled** | Pointer to **Boolean** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to $false] +**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] +**Id** | Pointer to **String** | Workflow ID. This is a UUID generated upon creation. | [optional] +**ExecutionCount** | Pointer to **Int32** | The number of times this workflow has been executed. | [optional] +**FailureCount** | Pointer to **Int32** | The number of times this workflow has failed during execution. | [optional] +**Created** | Pointer to **System.DateTime** | The date and time the workflow was created. | [optional] +**Modified** | Pointer to **System.DateTime** | The date and time the workflow was modified. | [optional] +**ModifiedBy** | Pointer to [**WorkflowModifiedBy**](workflow-modified-by) | | [optional] +**Creator** | Pointer to [**WorkflowAllOfCreator**](workflow-all-of-creator) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$Workflow = Initialize-PSSailpoint.V3Workflow -Name Send Email ` + -Owner null ` + -Description Send an email to the identity who's attributes changed. ` + -Definition null ` + -Enabled false ` + -Trigger null ` + -Id d201c5e9-d37b-4aff-af14-66414f39d569 ` + -ExecutionCount 2 ` + -FailureCount 0 ` + -Created 2022-01-10T16:06:16.636381447Z ` + -Modified 2023-12-05T15:18:27.699132301Z ` + -ModifiedBy null ` + -Creator null +``` + +- Convert the resource to JSON +```powershell +$Workflow | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowAllOfCreator.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowAllOfCreator.md new file mode 100644 index 000000000..19889baff --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowAllOfCreator.md @@ -0,0 +1,39 @@ +--- +id: workflow-all-of-creator +title: WorkflowAllOfCreator +pagination_label: WorkflowAllOfCreator +sidebar_label: WorkflowAllOfCreator +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowAllOfCreator', 'WorkflowAllOfCreator'] +slug: /tools/sdk/powershell/v3/models/workflow-all-of-creator +tags: ['SDK', 'Software Development Kit', 'WorkflowAllOfCreator', 'WorkflowAllOfCreator'] +--- + + +# WorkflowAllOfCreator + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | Workflow creator's DTO type. | [optional] +**Id** | Pointer to **String** | Workflow creator's identity ID. | [optional] +**Name** | Pointer to **String** | Workflow creator's display name. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowAllOfCreator = Initialize-PSSailpoint.V3WorkflowAllOfCreator -Type IDENTITY ` + -Id 2c7180a46faadee4016fb4e018c20642 ` + -Name Michael Michaels +``` + +- Convert the resource to JSON +```powershell +$WorkflowAllOfCreator | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowBody.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowBody.md new file mode 100644 index 000000000..d574998d0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowBody.md @@ -0,0 +1,45 @@ +--- +id: workflow-body +title: WorkflowBody +pagination_label: WorkflowBody +sidebar_label: WorkflowBody +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowBody', 'WorkflowBody'] +slug: /tools/sdk/powershell/v3/models/workflow-body +tags: ['SDK', 'Software Development Kit', 'WorkflowBody', 'WorkflowBody'] +--- + + +# WorkflowBody + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | Pointer to **String** | The name of the workflow | [optional] +**Owner** | Pointer to [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] +**Description** | Pointer to **String** | Description of what the workflow accomplishes | [optional] +**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] +**Enabled** | Pointer to **Boolean** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to $false] +**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowBody = Initialize-PSSailpoint.V3WorkflowBody -Name Send Email ` + -Owner null ` + -Description Send an email to the identity who's attributes changed. ` + -Definition null ` + -Enabled false ` + -Trigger null +``` + +- Convert the resource to JSON +```powershell +$WorkflowBody | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowBodyOwner.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowBodyOwner.md new file mode 100644 index 000000000..9c90689c4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowBodyOwner.md @@ -0,0 +1,39 @@ +--- +id: workflow-body-owner +title: WorkflowBodyOwner +pagination_label: WorkflowBodyOwner +sidebar_label: WorkflowBodyOwner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowBodyOwner', 'WorkflowBodyOwner'] +slug: /tools/sdk/powershell/v3/models/workflow-body-owner +tags: ['SDK', 'Software Development Kit', 'WorkflowBodyOwner', 'WorkflowBodyOwner'] +--- + + +# WorkflowBodyOwner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of object that is referenced | [optional] +**Id** | Pointer to **String** | The unique ID of the object | [optional] +**Name** | Pointer to **String** | The name of the object | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowBodyOwner = Initialize-PSSailpoint.V3WorkflowBodyOwner -Type IDENTITY ` + -Id 2c91808568c529c60168cca6f90c1313 ` + -Name William Wilson +``` + +- Convert the resource to JSON +```powershell +$WorkflowBodyOwner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowDefinition.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowDefinition.md new file mode 100644 index 000000000..a273a49cf --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowDefinition.md @@ -0,0 +1,37 @@ +--- +id: workflow-definition +title: WorkflowDefinition +pagination_label: WorkflowDefinition +sidebar_label: WorkflowDefinition +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowDefinition', 'WorkflowDefinition'] +slug: /tools/sdk/powershell/v3/models/workflow-definition +tags: ['SDK', 'Software Development Kit', 'WorkflowDefinition', 'WorkflowDefinition'] +--- + + +# WorkflowDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Start** | Pointer to **String** | The name of the starting step. | [optional] +**Steps** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowDefinition = Initialize-PSSailpoint.V3WorkflowDefinition -Start Send Email Test ` + -Steps {Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=ACTION}, success={type=success}} +``` + +- Convert the resource to JSON +```powershell +$WorkflowDefinition | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowExecution.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowExecution.md new file mode 100644 index 000000000..cc7dc2655 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowExecution.md @@ -0,0 +1,45 @@ +--- +id: workflow-execution +title: WorkflowExecution +pagination_label: WorkflowExecution +sidebar_label: WorkflowExecution +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowExecution', 'WorkflowExecution'] +slug: /tools/sdk/powershell/v3/models/workflow-execution +tags: ['SDK', 'Software Development Kit', 'WorkflowExecution', 'WorkflowExecution'] +--- + + +# WorkflowExecution + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Workflow execution ID. | [optional] +**WorkflowId** | Pointer to **String** | Workflow ID. | [optional] +**RequestId** | Pointer to **String** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] +**StartTime** | Pointer to **System.DateTime** | Date/time when the workflow started. | [optional] +**CloseTime** | Pointer to **System.DateTime** | Date/time when the workflow ended. | [optional] +**Status** | Pointer to **Enum** [ "Completed", "Failed", "Canceled", "Executing" ] | Workflow execution status. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowExecution = Initialize-PSSailpoint.V3WorkflowExecution -Id b393f4e2-4785-4d7f-ab27-3a6b8ded4c81 ` + -WorkflowId d201c5d9-d37b-4a2f-af14-66414f39d568 ` + -RequestId 41e12a74fa7b4a6a98ae47887b64acdb ` + -StartTime 2022-02-07T20:13:29.356648026Z ` + -CloseTime 2022-02-07T20:13:31.682410165Z ` + -Status Completed +``` + +- Convert the resource to JSON +```powershell +$WorkflowExecution | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowExecutionEvent.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowExecutionEvent.md new file mode 100644 index 000000000..a09dcece7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowExecutionEvent.md @@ -0,0 +1,39 @@ +--- +id: workflow-execution-event +title: WorkflowExecutionEvent +pagination_label: WorkflowExecutionEvent +sidebar_label: WorkflowExecutionEvent +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowExecutionEvent', 'WorkflowExecutionEvent'] +slug: /tools/sdk/powershell/v3/models/workflow-execution-event +tags: ['SDK', 'Software Development Kit', 'WorkflowExecutionEvent', 'WorkflowExecutionEvent'] +--- + + +# WorkflowExecutionEvent + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "WorkflowExecutionScheduled", "WorkflowExecutionStarted", "WorkflowExecutionCompleted", "WorkflowExecutionFailed", "WorkflowTaskScheduled", "WorkflowTaskStarted", "WorkflowTaskCompleted", "WorkflowTaskFailed", "ActivityTaskScheduled", "ActivityTaskStarted", "ActivityTaskCompleted", "ActivityTaskFailed", "StartChildWorkflowExecutionInitiated", "ChildWorkflowExecutionStarted", "ChildWorkflowExecutionCompleted", "ChildWorkflowExecutionFailed" ] | The type of event | [optional] +**Timestamp** | Pointer to **System.DateTime** | The date-time when the event occurred | [optional] +**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Additional attributes associated with the event | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowExecutionEvent = Initialize-PSSailpoint.V3WorkflowExecutionEvent -Type WorkflowTaskScheduled ` + -Timestamp 2022-02-07T20:13:31.640618296Z ` + -Attributes {} +``` + +- Convert the resource to JSON +```powershell +$WorkflowExecutionEvent | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowLibraryAction.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowLibraryAction.md new file mode 100644 index 000000000..757c4e5a4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowLibraryAction.md @@ -0,0 +1,57 @@ +--- +id: workflow-library-action +title: WorkflowLibraryAction +pagination_label: WorkflowLibraryAction +sidebar_label: WorkflowLibraryAction +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryAction', 'WorkflowLibraryAction'] +slug: /tools/sdk/powershell/v3/models/workflow-library-action +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryAction', 'WorkflowLibraryAction'] +--- + + +# WorkflowLibraryAction + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Action ID. This is a static namespaced ID for the action | [optional] +**Name** | Pointer to **String** | Action Name | [optional] +**Type** | Pointer to **String** | Action type | [optional] +**Description** | Pointer to **String** | Action Description | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the action accepts | [optional] +**ExampleOutput** | Pointer to [**WorkflowLibraryActionExampleOutput**](workflow-library-action-example-output) | | [optional] +**Deprecated** | Pointer to **Boolean** | | [optional] +**DeprecatedBy** | Pointer to **System.DateTime** | | [optional] +**VersionNumber** | Pointer to **Int32** | Version number | [optional] +**IsSimulationEnabled** | Pointer to **Boolean** | | [optional] +**IsDynamicSchema** | Pointer to **Boolean** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] [default to $false] +**OutputSchema** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Defines the output schema, if any, that this action produces. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowLibraryAction = Initialize-PSSailpoint.V3WorkflowLibraryAction -Id sp:create-campaign ` + -Name Create Certification Campaign ` + -Type ACTION ` + -Description Generates a certification campaign. ` + -FormFields null ` + -ExampleOutput null ` + -Deprecated null ` + -DeprecatedBy null ` + -VersionNumber null ` + -IsSimulationEnabled null ` + -IsDynamicSchema false ` + -OutputSchema {definitions={}, properties={autoRevokeAllowed={$id=#sp:create-campaign/autoRevokeAllowed, default=true, examples=[false], title=autoRevokeAllowed, type=boolean}, deadline={$id=#sp:create-campaign/deadline, default=, examples=[2020-12-25T06:00:00.468Z], format=date-time, pattern=^.*$, title=deadline, type=string}, description={$id=#sp:create-campaign/description, default=, examples=[A review of everyone's access by their manager.], pattern=^.*$, title=description, type=string}, emailNotificationEnabled={$id=#sp:create-campaign/emailNotificationEnabled, default=true, examples=[false], title=emailNotificationEnabled, type=boolean}, filter={$id=#sp:create-campaign/filter, properties={id={$id=#sp:create-campaign/filter/id, default=, examples=[e0adaae69852e8fe8b8a3d48e5ce757c], pattern=^.*$, title=id, type=string}, type={$id=#sp:create-campaign/filter/type, default=, examples=[CAMPAIGN_FILTER], pattern=^.*$, title=type, type=string}}, title=filter, type=object}, id={$id=#sp:create-campaign/id, default=, examples=[2c918086719eec070171a7e3355a360a], pattern=^.*$, title=id, type=string}, name={$id=#sp:create-campaign/name, default=, examples=[Manager Review], pattern=^.*$, title=name, type=string}, recommendationsEnabled={$id=#sp:create-campaign/recommendationsEnabled, default=true, examples=[false], title=recommendationEnabled, type=boolean}, type={$id=#sp:create-campaign/type, default=, examples=[MANAGER], pattern=^.*$, title=type, type=string}}, title=sp:create-campaign, type=object} +``` + +- Convert the resource to JSON +```powershell +$WorkflowLibraryAction | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowLibraryActionExampleOutput.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowLibraryActionExampleOutput.md new file mode 100644 index 000000000..b6ebef128 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowLibraryActionExampleOutput.md @@ -0,0 +1,34 @@ +--- +id: workflow-library-action-example-output +title: WorkflowLibraryActionExampleOutput +pagination_label: WorkflowLibraryActionExampleOutput +sidebar_label: WorkflowLibraryActionExampleOutput +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryActionExampleOutput', 'WorkflowLibraryActionExampleOutput'] +slug: /tools/sdk/powershell/v3/models/workflow-library-action-example-output +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryActionExampleOutput', 'WorkflowLibraryActionExampleOutput'] +--- + + +# WorkflowLibraryActionExampleOutput + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Examples + +- Prepare the resource +```powershell +$WorkflowLibraryActionExampleOutput = Initialize-PSSailpoint.V3WorkflowLibraryActionExampleOutput +``` + +- Convert the resource to JSON +```powershell +$WorkflowLibraryActionExampleOutput | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowLibraryFormFields.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowLibraryFormFields.md new file mode 100644 index 000000000..3385d53e0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowLibraryFormFields.md @@ -0,0 +1,45 @@ +--- +id: workflow-library-form-fields +title: WorkflowLibraryFormFields +pagination_label: WorkflowLibraryFormFields +sidebar_label: WorkflowLibraryFormFields +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryFormFields', 'WorkflowLibraryFormFields'] +slug: /tools/sdk/powershell/v3/models/workflow-library-form-fields +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryFormFields', 'WorkflowLibraryFormFields'] +--- + + +# WorkflowLibraryFormFields + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | Pointer to **String** | Description of the form field | [optional] +**HelpText** | Pointer to **String** | Describes the form field in the UI | [optional] +**Label** | Pointer to **String** | A human readable name for this form field in the UI | [optional] +**Name** | Pointer to **String** | The name of the input attribute | [optional] +**Required** | Pointer to **Boolean** | Denotes if this field is a required attribute | [optional] [default to $false] +**Type** | Pointer to **Enum** [ "text", "textarea", "boolean", "email", "url", "number", "json", "checkbox", "jsonpath", "select", "multiType", "duration", "toggle", "formPicker", "identityPicker", "governanceGroupPicker", "string", "object", "array", "secret", "keyValuePairs", "emailPicker", "advancedToggle", "variableCreator", "htmlEditor" ] | The type of the form field | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowLibraryFormFields = Initialize-PSSailpoint.V3WorkflowLibraryFormFields -Description First value to compare ` + -HelpText The name to give to this certification campaign. ` + -Label Campaign Name ` + -Name name ` + -Required false ` + -Type text +``` + +- Convert the resource to JSON +```powershell +$WorkflowLibraryFormFields | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowLibraryOperator.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowLibraryOperator.md new file mode 100644 index 000000000..a00b0d984 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowLibraryOperator.md @@ -0,0 +1,51 @@ +--- +id: workflow-library-operator +title: WorkflowLibraryOperator +pagination_label: WorkflowLibraryOperator +sidebar_label: WorkflowLibraryOperator +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryOperator', 'WorkflowLibraryOperator'] +slug: /tools/sdk/powershell/v3/models/workflow-library-operator +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryOperator', 'WorkflowLibraryOperator'] +--- + + +# WorkflowLibraryOperator + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Operator ID. | [optional] +**Name** | Pointer to **String** | Operator friendly name | [optional] +**Type** | Pointer to **String** | Operator type | [optional] +**Description** | Pointer to **String** | Description of the operator | [optional] +**IsDynamicSchema** | Pointer to **Boolean** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] +**Deprecated** | Pointer to **Boolean** | | [optional] +**DeprecatedBy** | Pointer to **System.DateTime** | | [optional] +**IsSimulationEnabled** | Pointer to **Boolean** | | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the operator accepts | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowLibraryOperator = Initialize-PSSailpoint.V3WorkflowLibraryOperator -Id sp:compare-boolean ` + -Name Compare Boolean Values ` + -Type OPERATOR ` + -Description Compare two boolean values and decide what happens based on the result. ` + -IsDynamicSchema false ` + -Deprecated null ` + -DeprecatedBy null ` + -IsSimulationEnabled null ` + -FormFields [{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] +``` + +- Convert the resource to JSON +```powershell +$WorkflowLibraryOperator | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowLibraryTrigger.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowLibraryTrigger.md new file mode 100644 index 000000000..642dc2261 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowLibraryTrigger.md @@ -0,0 +1,55 @@ +--- +id: workflow-library-trigger +title: WorkflowLibraryTrigger +pagination_label: WorkflowLibraryTrigger +sidebar_label: WorkflowLibraryTrigger +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryTrigger', 'WorkflowLibraryTrigger'] +slug: /tools/sdk/powershell/v3/models/workflow-library-trigger +tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryTrigger', 'WorkflowLibraryTrigger'] +--- + + +# WorkflowLibraryTrigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | Trigger ID. This is a static namespaced ID for the trigger. | [optional] +**Type** | Pointer to **Enum** [ "EVENT", "SCHEDULED", "EXTERNAL" ] | Trigger type | [optional] +**Deprecated** | Pointer to **Boolean** | | [optional] +**DeprecatedBy** | Pointer to **System.DateTime** | | [optional] +**IsSimulationEnabled** | Pointer to **Boolean** | | [optional] +**OutputSchema** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Example output schema | [optional] +**Name** | Pointer to **String** | Trigger Name | [optional] +**Description** | Pointer to **String** | Trigger Description | [optional] +**IsDynamicSchema** | Pointer to **Boolean** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] [default to $false] +**InputExample** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Example trigger payload if applicable | [optional] +**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the trigger accepts | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowLibraryTrigger = Initialize-PSSailpoint.V3WorkflowLibraryTrigger -Id idn:identity-attributes-changed ` + -Type EVENT ` + -Deprecated null ` + -DeprecatedBy null ` + -IsSimulationEnabled null ` + -OutputSchema null ` + -Name Identity Attributes Changed ` + -Description One or more identity attributes changed. ` + -IsDynamicSchema false ` + -InputExample {changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} ` + -FormFields [] +``` + +- Convert the resource to JSON +```powershell +$WorkflowLibraryTrigger | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowModifiedBy.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowModifiedBy.md new file mode 100644 index 000000000..72313adb9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowModifiedBy.md @@ -0,0 +1,39 @@ +--- +id: workflow-modified-by +title: WorkflowModifiedBy +pagination_label: WorkflowModifiedBy +sidebar_label: WorkflowModifiedBy +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowModifiedBy', 'WorkflowModifiedBy'] +slug: /tools/sdk/powershell/v3/models/workflow-modified-by +tags: ['SDK', 'Software Development Kit', 'WorkflowModifiedBy', 'WorkflowModifiedBy'] +--- + + +# WorkflowModifiedBy + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | Pointer to **Enum** [ "IDENTITY" ] | | [optional] +**Id** | Pointer to **String** | Identity ID | [optional] +**Name** | Pointer to **String** | Human-readable display name of identity. | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowModifiedBy = Initialize-PSSailpoint.V3WorkflowModifiedBy -Type IDENTITY ` + -Id 2c9180a46faadee4016fb4e018c20639 ` + -Name Thomas Edison +``` + +- Convert the resource to JSON +```powershell +$WorkflowModifiedBy | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowOAuthClient.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowOAuthClient.md new file mode 100644 index 000000000..c5129c09a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowOAuthClient.md @@ -0,0 +1,39 @@ +--- +id: workflow-o-auth-client +title: WorkflowOAuthClient +pagination_label: WorkflowOAuthClient +sidebar_label: WorkflowOAuthClient +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowOAuthClient', 'WorkflowOAuthClient'] +slug: /tools/sdk/powershell/v3/models/workflow-o-auth-client +tags: ['SDK', 'Software Development Kit', 'WorkflowOAuthClient', 'WorkflowOAuthClient'] +--- + + +# WorkflowOAuthClient + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | Pointer to **String** | OAuth client ID for the trigger. This is a UUID generated upon creation. | [optional] +**Secret** | Pointer to **String** | OAuthClient secret. | [optional] +**Url** | Pointer to **String** | URL for the external trigger to invoke | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowOAuthClient = Initialize-PSSailpoint.V3WorkflowOAuthClient -Id 1a58c03a6bf64dc2876f6988c6e2c7b7 ` + -Secret 00cc24a7fe810fe06a7cb38bc168ae104d703c7abb296f9944dc68e69ddb578b ` + -Url https://tenant.api.identitynow.com/beta/workflows/execute/external/c17bea3a-574d-453c-9e04-4365fbf5af0b +``` + +- Convert the resource to JSON +```powershell +$WorkflowOAuthClient | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowTrigger.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowTrigger.md new file mode 100644 index 000000000..b2b7b8f89 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowTrigger.md @@ -0,0 +1,39 @@ +--- +id: workflow-trigger +title: WorkflowTrigger +pagination_label: WorkflowTrigger +sidebar_label: WorkflowTrigger +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowTrigger', 'WorkflowTrigger'] +slug: /tools/sdk/powershell/v3/models/workflow-trigger +tags: ['SDK', 'Software Development Kit', 'WorkflowTrigger', 'WorkflowTrigger'] +--- + + +# WorkflowTrigger + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "EVENT", "EXTERNAL", "SCHEDULED", "" ] | The trigger type | [required] +**DisplayName** | Pointer to **String** | | [optional] +**Attributes** | [**WorkflowTriggerAttributes**](workflow-trigger-attributes) | | [required] + +## Examples + +- Prepare the resource +```powershell +$WorkflowTrigger = Initialize-PSSailpoint.V3WorkflowTrigger -Type EVENT ` + -DisplayName null ` + -Attributes null +``` + +- Convert the resource to JSON +```powershell +$WorkflowTrigger | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowTriggerAttributes.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowTriggerAttributes.md new file mode 100644 index 000000000..4a7d7b3cc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/WorkflowTriggerAttributes.md @@ -0,0 +1,57 @@ +--- +id: workflow-trigger-attributes +title: WorkflowTriggerAttributes +pagination_label: WorkflowTriggerAttributes +sidebar_label: WorkflowTriggerAttributes +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowTriggerAttributes', 'WorkflowTriggerAttributes'] +slug: /tools/sdk/powershell/v3/models/workflow-trigger-attributes +tags: ['SDK', 'Software Development Kit', 'WorkflowTriggerAttributes', 'WorkflowTriggerAttributes'] +--- + + +# WorkflowTriggerAttributes + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The unique ID of the trigger | [required] +**VarFilter** | Pointer to **String** | JSON path expression that will limit which events the trigger will fire on | [optional] +**Description** | Pointer to **String** | Additonal context about the external trigger | [optional] +**AttributeToFilter** | Pointer to **String** | The attribute to filter on | [optional] +**Name** | Pointer to **String** | A unique name for the external trigger | [optional] +**ClientId** | Pointer to **String** | OAuth Client ID to authenticate with this trigger | [optional] +**Url** | Pointer to **String** | URL to invoke this workflow | [optional] +**CronString** | Pointer to **String** | A valid CRON expression | [optional] +**Frequency** | **Enum** [ "daily", "weekly", "monthly", "yearly", "cronSchedule" ] | Frequency of execution | [required] +**TimeZone** | Pointer to **String** | Time zone identifier | [optional] +**WeeklyDays** | Pointer to **[]String** | Scheduled days of the week for execution | [optional] +**WeeklyTimes** | Pointer to **[]String** | Scheduled execution times | [optional] + +## Examples + +- Prepare the resource +```powershell +$WorkflowTriggerAttributes = Initialize-PSSailpoint.V3WorkflowTriggerAttributes -Id idn:identity-attributes-changed ` + -VarFilter $.changes[?(@.attribute == 'manager')] ` + -Description Run a search and notify the results ` + -AttributeToFilter LifecycleState ` + -Name search-and-notify ` + -ClientId 87e239b2-b85b-4bde-b9a7-55bf304ddcdc ` + -Url https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d ` + -CronString 0 9 * * 1 ` + -Frequency null ` + -TimeZone America/Chicago ` + -WeeklyDays Monday ` + -WeeklyTimes Monday +``` + +- Convert the resource to JSON +```powershell +$WorkflowTriggerAttributes | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/docs/Models/indices.md b/docs/tools/sdk/powershell/Reference/V3/docs/Models/indices.md new file mode 100644 index 000000000..c580b98b4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/docs/Models/indices.md @@ -0,0 +1,34 @@ +--- +id: index +title: Index +pagination_label: Index +sidebar_label: Index +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'Index', 'Index'] +slug: /tools/sdk/powershell/v3/models/index +tags: ['SDK', 'Software Development Kit', 'Index', 'Index'] +--- + + +# Index + +## Enum + + +* `accessprofiles` (value: `"accessprofiles"`) + +* `accountactivities` (value: `"accountactivities"`) + +* `entitlements` (value: `"entitlements"`) + +* `events` (value: `"events"`) + +* `identities` (value: `"identities"`) + +* `roles` (value: `"roles"`) + +* `STAR` (value: `"*"`) + + +[[Back to top]](#) + diff --git a/static/code-examples/beta/Examples/code_examples_overlay.yaml b/static/code-examples/beta/Examples/code_examples_overlay.yaml new file mode 100644 index 000000000..1d0dec385 --- /dev/null +++ b/static/code-examples/beta/Examples/code_examples_overlay.yaml @@ -0,0 +1,14573 @@ +- path: /access-model-metadata/attributes/{key} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Key = "iscPrivacy" # String | Technical name of the Attribute. + + # Get Access Model Metadata Attribute + + try { + Get-BetaAccessModelMetadataAttribute-BetaKey $Key + + # Below is a request that includes all optional parameters + # Get-BetaAccessModelMetadataAttribute -BetaKey $Key + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute" + Write-Host $_.ErrorDetails + } +- path: /access-model-metadata/attributes/{key}/values/{value} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Key = "iscPrivacy" # String | Technical name of the Attribute. + $Value = "public" # String | Technical name of the Attribute value. + + # Get Access Model Metadata Value + + try { + Get-BetaAccessModelMetadataAttributeValue-BetaKey $Key -BetaValue $Value + + # Below is a request that includes all optional parameters + # Get-BetaAccessModelMetadataAttributeValue -BetaKey $Key -BetaValue $Value + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue" + Write-Host $_.ErrorDetails + } +- path: /access-model-metadata/attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "name eq "Privacy"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) + + # List Access Model Metadata Attributes + + try { + Get-BetaAccessModelMetadataAttribute + + # Below is a request that includes all optional parameters + # Get-BetaAccessModelMetadataAttribute -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute" + Write-Host $_.ErrorDetails + } +- path: /access-model-metadata/attributes/{key}/values + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Key = "iscPrivacy" # String | Technical name of the Attribute. + + # List Access Model Metadata Values + + try { + Get-BetaAccessModelMetadataAttributeValue-BetaKey $Key + + # Below is a request that includes all optional parameters + # Get-BetaAccessModelMetadataAttributeValue -BetaKey $Key + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue" + Write-Host $_.ErrorDetails + } +- path: /access-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessProfile = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "description" : "Collection of entitlements to read/write the employee database", + "source" : { + "name" : "ODS-AD-SOURCE", + "id" : "2c91809773dee3610173fdb0b6061ef4", + "type" : "SOURCE" + }, + "enabled" : true, + "revocationRequestConfig" : { + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ] + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "accessRequestConfig" : { + "commentsRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "name" : "Employee-database-read-write", + "provisioningCriteria" : { + "children" : [ { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, + "modified" : "2021-03-02T20:22:28.104Z", + "id" : "2c91808a7190d06e01719938fcd20792", + "requestable" : true + } + "@ + + # Create Access Profile + + try { + $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile + New-BetaAccessProfile-BetaAccessProfile $Result + + # Below is a request that includes all optional parameters + # New-BetaAccessProfile -BetaAccessProfile $AccessProfile + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete + + # Delete the specified Access Profile + + try { + Remove-BetaAccessProfile-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaAccessProfile -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessProfileBulkDeleteRequest = @" + { + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + } + "@ + + # Delete Access Profile(s) + + try { + $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest + Remove-BetaAccessProfilesInBulk-BetaAccessProfileBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaAccessProfilesInBulk -BetaAccessProfileBulkDeleteRequest $AccessProfileBulkDeleteRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfilesInBulk" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile + + # Get an Access Profile + + try { + Get-BetaAccessProfile-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccessProfile -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + + # List Access Profile's Entitlements + + try { + Get-BetaAccessProfileEntitlements-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccessProfileEntitlements -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfileEntitlements" + Write-Host $_.ErrorDetails + } +- path: /access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin. (optional) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + + # List Access Profiles + + try { + Get-BetaAccessProfiles + + # Below is a request that includes all optional parameters + # Get-BetaAccessProfiles -BetaForSubadmin $ForSubadmin -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -BetaForSegmentIds $ForSegmentIds -BetaIncludeUnsegmented $IncludeUnsegmented + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfiles" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Access Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaAccessProfile-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaAccessProfile -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/bulk-update-requestable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ + + + # Update Access Profile(s) requestable field. + + try { + $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner + Update-BetaAccessProfilesInBulk-BetaAccessProfileBulkUpdateRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaAccessProfilesInBulk -BetaAccessProfileBulkUpdateRequestInner $AccessProfileBulkUpdateRequestInner + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccessProfilesInBulk" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "author" : { + "name" : "Adam Kennedy", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2017-07-11T18:45:37.098Z", + "comment" : "This is a comment." + } + "@ + + # Approve Access Request Approval + + try { + $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto + Approve-BetaAccessRequest-BetaApprovalId $ApprovalId -BetaCommentDto $Result + + # Below is a request that includes all optional parameters + # Approve-BetaAccessRequest -BetaApprovalId $ApprovalId -BetaCommentDto $CommentDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $ForwardApprovalDto = @" + { + "newOwnerId" : "newOwnerId", + "comment" : "comment" + } + "@ + + # Forward Access Request Approval + + try { + $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto + Invoke-BetaForwardAccessRequest-BetaApprovalId $ApprovalId -BetaForwardApprovalDto $Result + + # Below is a request that includes all optional parameters + # Invoke-BetaForwardAccessRequest -BetaApprovalId $ApprovalId -BetaForwardApprovalDto $ForwardApprovalDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/approval-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + + # Get Access Requests Approvals Number + + try { + Get-BetaAccessRequestApprovalSummary + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestApprovalSummary -BetaOwnerId $OwnerId -BetaFromDate $FromDate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestApprovalSummary" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "MyOwnerId" # String | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Completed Access Request Approvals List + + try { + Get-BetaCompletedApprovals + + # Below is a request that includes all optional parameters + # Get-BetaCompletedApprovals -BetaOwnerId $OwnerId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedApprovals" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/pending + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "MyOwnerId" # String | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional) + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Pending Access Request Approvals List + + try { + Get-BetaPendingApprovals + + # Below is a request that includes all optional parameters + # Get-BetaPendingApprovals -BetaOwnerId $OwnerId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingApprovals" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/reject + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "author" : { + "name" : "Adam Kennedy", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2017-07-11T18:45:37.098Z", + "comment" : "This is a comment." + } + "@ + + # Reject Access Request Approval + + try { + $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto + Deny-BetaAccessRequest-BetaApprovalId $ApprovalId -BetaCommentDto $Result + + # Below is a request that includes all optional parameters + # Deny-BetaAccessRequest -BetaApprovalId $ApprovalId -BetaCommentDto $CommentDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID. + $RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID. + $Type = "ENTITLEMENT" # String | Requested access item's type. + + # Return access request identity metrics + + try { + Get-BetaAccessRequestIdentityMetrics-BetaIdentityId $IdentityId -BetaRequestedObjectId $RequestedObjectId -BetaType $Type + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestIdentityMetrics -BetaIdentityId $IdentityId -BetaRequestedObjectId $RequestedObjectId -BetaType $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestIdentityMetrics" + Write-Host $_.ErrorDetails + } +- path: /access-requests/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CancelAccessRequest = @" + { + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + } + "@ + + # Cancel Access Request + + try { + $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest + Suspend-BetaAccessRequest-BetaCancelAccessRequest $Result + + # Below is a request that includes all optional parameters + # Suspend-BetaAccessRequest -BetaCancelAccessRequest $CancelAccessRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-requests/close + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CloseAccessRequest = @" + { + "executionStatus" : "Terminated", + "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "completionStatus" : "Failure", + "message" : "The IdentityNow Administrator manually closed this request." + } + "@ + + # Close Access Request + + try { + $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest + Close-BetaAccessRequest-BetaCloseAccessRequest $Result + + # Below is a request that includes all optional parameters + # Close-BetaAccessRequest -BetaCloseAccessRequest $CloseAccessRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-BetaAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessRequest = @" + { + "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + } ] + } + "@ + + # Submit Access Request + + try { + $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest + New-BetaAccessRequest-BetaAccessRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaAccessRequest -BetaAccessRequest $AccessRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Access Request Configuration + + try { + Get-BetaAccessRequestConfig + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /access-request-status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) + $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) + $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + $Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) + $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + # Access Request Status + + try { + Get-BetaAccessRequestStatus + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestStatus -BetaRequestedFor $RequestedFor -BetaRequestedBy $RequestedBy -BetaRegardingIdentity $RegardingIdentity -BetaAssignedTo $AssignedTo -BetaCount $Count -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters -BetaSorters $Sorters -BetaRequestState $RequestState + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestStatus" + Write-Host $_.ErrorDetails + } +- path: /access-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessRequestConfig = @" + { + "requestOnBehalfOfConfig" : { + "allowRequestOnBehalfOfEmployeeByManager" : true, + "allowRequestOnBehalfOfAnyoneByAnyone" : true + }, + "approvalReminderAndEscalationConfig" : { + "fallbackApproverRef" : { + "name" : "Alison Ferguso", + "id" : "5168015d32f890ca15812c9180835d2e", + "type" : "IDENTITY", + "email" : "alison.ferguso@identitysoon.com" + }, + "maxReminders" : 1, + "daysUntilEscalation" : 0, + "daysBetweenReminders" : 0 + }, + "autoApprovalEnabled" : true, + "entitlementRequestConfig" : { + "requestCommentsRequired" : false, + "deniedCommentsRequired" : false, + "allowEntitlementRequest" : true, + "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + }, + "reauthorizationEnabled" : true, + "approvalsMustBeExternal" : true + } + "@ + + # Update Access Request Configuration + + try { + $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig + Set-BetaAccessRequestConfig-BetaAccessRequestConfig $Result + + # Below is a request that includes all optional parameters + # Set-BetaAccessRequestConfig -BetaAccessRequestConfig $AccessRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaAccessRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /account-activities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id + + # Get Account Activity + + try { + Get-BetaAccountActivity-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccountActivity -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountActivity" + Write-Host $_.ErrorDetails + } +- path: /account-activities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "MyRequestedFor" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "MyRequestedBy" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "MyRegardingIdentity" # String | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + $Type = "MyType" # String | The type of account activity. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) + + # List Account Activities + + try { + Get-BetaAccountActivities + + # Below is a request that includes all optional parameters + # Get-BetaAccountActivities -BetaRequestedFor $RequestedFor -BetaRequestedBy $RequestedBy -BetaRegardingIdentity $RegardingIdentity -BetaType $Type -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountActivities" + Write-Host $_.ErrorDetails + } +- path: /account-aggregations/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id + + # In-progress Account Aggregation status + + try { + Get-BetaAccountAggregationStatus-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccountAggregationStatus -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountAggregationStatus" + Write-Host $_.ErrorDetails + } +- path: /accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccountAttributesCreate = @" + { + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Create Account + + try { + $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate + New-BetaAccount-BetaAccountAttributesCreate $Result + + # Below is a request that includes all optional parameters + # New-BetaAccount -BetaAccountAttributesCreate $AccountAttributesCreate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Delete Account + + try { + Remove-BetaAccount-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaAccount -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id + + # Remove Account + + try { + Remove-BetaAccountAsync-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaAccountAsync -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccountAsync" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Disable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Disable-BetaAccount-BetaId $Id -BetaAccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Disable-BetaAccount -BetaId $Id -BetaAccountToggleRequest $AccountToggleRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccount" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/{id}/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808384203c2d018437e631158309" # String | The identity id. + + # Disable IDN Account for Identity + + try { + Disable-BetaAccountForIdentity-BetaId $Id + + # Below is a request that includes all optional parameters + # Disable-BetaAccountForIdentity -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccountForIdentity" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentitiesAccountsBulkRequest = @" + { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } + "@ + + # Disable IDN Accounts for Identities + + try { + $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest + Disable-BetaAccountsForIdentities-BetaIdentitiesAccountsBulkRequest $Result + + # Below is a request that includes all optional parameters + # Disable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccountsForIdentities" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Enable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Enable-BetaAccount-BetaId $Id -BetaAccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Enable-BetaAccount -BetaId $Id -BetaAccountToggleRequest $AccountToggleRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccount" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/{id}/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808384203c2d018437e631158309" # String | The identity id. + + # Enable IDN Account for Identity + + try { + Enable-BetaAccountForIdentity-BetaId $Id + + # Below is a request that includes all optional parameters + # Enable-BetaAccountForIdentity -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccountForIdentity" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentitiesAccountsBulkRequest = @" + { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } + "@ + + # Enable IDN Accounts for Identities + + try { + $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest + Enable-BetaAccountsForIdentities-BetaIdentitiesAccountsBulkRequest $Result + + # Below is a request that includes all optional parameters + # Enable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccountsForIdentities" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Account Details + + try { + Get-BetaAccount-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccount -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Account Entitlements + + try { + Get-BetaAccountEntitlements-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccountEntitlements -BetaId $Id -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountEntitlements" + Write-Host $_.ErrorDetails + } +- path: /accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + + # Accounts List + + try { + Get-BetaAccounts + + # Below is a request that includes all optional parameters + # Get-BetaAccounts -BetaDetailLevel $DetailLevel -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccounts" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $AccountAttributes = @" + { + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Update Account + + try { + $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes + Send-BetaAccount-BetaId $Id -BetaAccountAttributes $Result + + # Below is a request that includes all optional parameters + # Send-BetaAccount -BetaId $Id -BetaAccountAttributes $AccountAttributes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/reload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + + # Reload Account + + try { + Submit-BetaReloadAccount-BetaId $Id + + # Below is a request that includes all optional parameters + # Submit-BetaReloadAccount -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaReloadAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/unlock + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. + $AccountUnlockRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + } + "@ + + # Unlock Account + + try { + $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest + Unlock-BetaAccount-BetaId $Id -BetaAccountUnlockRequest $Result + + # Below is a request that includes all optional parameters + # Unlock-BetaAccount -BetaId $Id -BetaAccountUnlockRequest $AccountUnlockRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-BetaAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"{Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}}"@ + + + # Update Account + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaAccount-BetaId $Id -BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaAccount -BetaId $Id -BetaRequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccount" + Write-Host $_.ErrorDetails + } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-BetaUsagesByAccountId-BetaAccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-BetaUsagesByAccountId -BetaAccountId $AccountId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesByAccountId" + Write-Host $_.ErrorDetails + } +- path: /discovered-applications/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID. + + # Get Discovered Application by ID + + try { + Get-BetaDiscoveredApplicationByID-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaDiscoveredApplicationByID -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDiscoveredApplicationByID" + Write-Host $_.ErrorDetails + } +- path: /discovered-applications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) + $Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) + + # Retrieve discovered applications for tenant + + try { + Get-BetaDiscoveredApplications + + # Below is a request that includes all optional parameters + # Get-BetaDiscoveredApplications -BetaLimit $Limit -BetaOffset $Offset -BetaDetail $Detail -BetaFilter $Filter -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDiscoveredApplications" + Write-Host $_.ErrorDetails + } +- path: /manual-discover-applications-template + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Download CSV Template for Discovery + + try { + Get-BetaManualDiscoverApplicationsCsvTemplate + + # Below is a request that includes all optional parameters + # Get-BetaManualDiscoverApplicationsCsvTemplate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } +- path: /discovered-applications/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID. + $JsonPatchOperations = @"{ + "op" : "replace", + "path" : "/dismissed", + "value" : true + }"@ + + + # Patch Discovered Application by ID + + try { + Update-BetaDiscoveredApplicationByID-BetaId $Id + + # Below is a request that includes all optional parameters + # Update-BetaDiscoveredApplicationByID -BetaId $Id -BetaJsonPatchOperations $JsonPatchOperations + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaDiscoveredApplicationByID" + Write-Host $_.ErrorDetails + } +- path: /manual-discover-applications + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + + # Upload CSV to Discover Applications + + try { + Send-BetaManualDiscoverApplicationsCsvTemplate-BetaFile $File + + # Below is a request that includes all optional parameters + # Send-BetaManualDiscoverApplicationsCsvTemplate -BetaFile $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } +- path: /generic-approvals/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that to be returned. + + # Get Approval + + try { + Get-BetaApproval-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaApproval -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaApproval" + Write-Host $_.ErrorDetails + } +- path: /generic-approvals + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Mine = $true # Boolean | Returns the list of approvals for the current caller. (optional) + $RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID. (optional) + $Filters = "filters=status eq PENDING" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* (optional) + + # Get Approvals + + try { + Get-BetaApprovals + + # Below is a request that includes all optional parameters + # Get-BetaApprovals -BetaMine $Mine -BetaRequesterId $RequesterId -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaApprovals" + Write-Host $_.ErrorDetails + } +- path: /source-apps + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceAppCreateDto = @" + { + "name" : "my app", + "description" : "the source app for engineers", + "accountSource" : { + "name" : "ODS-AD-Source", + "id" : "2c9180827ca885d7017ca8ce28a000eb", + "type" : "SOURCE" + }, + "matchAllAccounts" : true + } + "@ + + # Create source app + + try { + $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto + New-BetaSourceApp-BetaSourceAppCreateDto $Result + + # Below is a request that includes all optional parameters + # New-BetaSourceApp -BetaSourceAppCreateDto $SourceAppCreateDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id}/access-profiles/bulk-remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ + + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + + # Bulk remove access profiles from the specified source app + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-BetaAccessProfilesFromSourceAppByBulk-BetaId $Id -BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-BetaAccessProfilesFromSourceAppByBulk -BetaId $Id -BetaRequestBody $RequestBody -BetaLimit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfilesFromSourceAppByBulk" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. + + # Delete source app by ID + + try { + Remove-BetaSourceApp-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSourceApp -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + + # Get source app by ID + + try { + Get-BetaSourceApp-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSourceApp -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id}/access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "name eq "developer access profile"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + # List access profiles for the specified source app + + try { + Get-BetaAccessProfilesForSourceApp-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaAccessProfilesForSourceApp -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfilesForSourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/all + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) + $Filters = "enabled eq true" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) + + # List all source apps + + try { + Get-BetaAllSourceApp + + # Below is a request that includes all optional parameters + # Get-BetaAllSourceApp -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllSourceApp" + Write-Host $_.ErrorDetails + } +- path: /user-apps/all + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List all user apps + + try { + Get-BetaAllUserApps-BetaFilters $Filters + + # Below is a request that includes all optional parameters + # Get-BetaAllUserApps -BetaFilters $Filters -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllUserApps" + Write-Host $_.ErrorDetails + } +- path: /source-apps/assigned + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (optional) + $Filters = "name eq "source app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + # List assigned source apps + + try { + Get-BetaAssignedSourceApp + + # Below is a request that includes all optional parameters + # Get-BetaAssignedSourceApp -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAssignedSourceApp" + Write-Host $_.ErrorDetails + } +- path: /user-apps/{id}/available-accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List available accounts for user app + + try { + Get-BetaAvailableAccountsForUserApp-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaAvailableAccountsForUserApp -BetaId $Id -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAvailableAccountsForUserApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) + $Filters = "name eq "source app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + # List available source apps + + try { + Get-BetaAvailableSourceApps + + # Below is a request that includes all optional parameters + # Get-BetaAvailableSourceApps -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAvailableSourceApps" + Write-Host $_.ErrorDetails + } +- path: /user-apps + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) + + # List owned user apps + + try { + Get-BetaOwnedUserApps + + # Below is a request that includes all optional parameters + # Get-BetaOwnedUserApps -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOwnedUserApps" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch source app by ID + + try { + Update-BetaSourceApp-BetaId $Id + + # Below is a request that includes all optional parameters + # Update-BetaSourceApp -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceApp" + Write-Host $_.ErrorDetails + } +- path: /user-apps/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch user app by ID + + try { + Update-BetaUserApp-BetaId $Id + + # Below is a request that includes all optional parameters + # Update-BetaUserApp -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaUserApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceAppBulkUpdateRequest = @" + { + "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : false + }, { + "op" : "replace", + "path" : "/matchAllAccounts", + "value" : false + } ] + } + "@ + + # Bulk update source apps + + try { + Update-BetaSourceAppsInBulk + + # Below is a request that includes all optional parameters + # Update-BetaSourceAppsInBulk -BetaSourceAppBulkUpdateRequest $SourceAppBulkUpdateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceAppsInBulk" + Write-Host $_.ErrorDetails + } +- path: /auth-profiles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to get. + + # Get Auth Profile. + + try { + Get-BetaProfileConfig-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaProfileConfig -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProfileConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get list of Auth Profiles. + + try { + Get-BetaProfileConfigList + + # Below is a request that includes all optional parameters + # Get-BetaProfileConfigList + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProfileConfigList" + Write-Host $_.ErrorDetails + } +- path: /auth-profiles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Auth Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaProfileConfig-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaProfileConfig -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProfileConfig" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/complete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $CompleteCampaignOptions = @" + { + "autoCompleteAction" : "REVOKE" + } + "@ + + # Complete a Campaign + + try { + Complete-BetaCampaign-BetaId $Id + + # Below is a request that includes all optional parameters + # Complete-BetaCampaign -BetaId $Id -BetaCompleteCampaignOptions $CompleteCampaignOptions + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaCampaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Campaign = @" + { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + } + "@ + + # Create Campaign + + try { + $Result = ConvertFrom-JsonToCampaign -Json $Campaign + New-BetaCampaign-BetaCampaign $Result + + # Below is a request that includes all optional parameters + # New-BetaCampaign -BetaCampaign $Campaign + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCampaign" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CampaignTemplate = @" + { + "ownerRef" : { + "name" : "Mister Manager", + "id" : "2c918086676d3e0601677611dbde220f", + "type" : "IDENTITY", + "email" : "mr.manager@example.com" + }, + "deadlineDuration" : "P2W", + "created" : "2020-03-05T22:44:00.364Z", + "scheduled" : false, + "name" : "Manager Campaign Template", + "description" : "Template for the annual manager campaign.", + "modified" : "2020-03-05T22:52:09.969Z", + "campaign" : { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }, + "id" : "2c9079b270a266a60170a277bb960008" + } + "@ + + # Create a Campaign Template + + try { + $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate + New-BetaCampaignTemplate-BetaCampaignTemplate $Result + + # Below is a request that includes all optional parameters + # New-BetaCampaignTemplate -BetaCampaignTemplate $CampaignTemplate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. + + # Delete a Campaign Template + + try { + Remove-BetaCampaignTemplate-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaCampaignTemplate -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. + + # Delete Campaign Template Schedule + + try { + Remove-BetaCampaignTemplateSchedule-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaCampaignTemplateSchedule -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaigns/delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $DeleteCampaignsRequest = @" + { + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + } + "@ + + # Delete Campaigns + + try { + $Result = ConvertFrom-JsonToDeleteCampaignsRequest -Json $DeleteCampaignsRequest + Remove-BetaCampaigns-BetaDeleteCampaignsRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaCampaigns -BetaDeleteCampaignsRequest $DeleteCampaignsRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaigns" + Write-Host $_.ErrorDetails + } +- path: /campaigns + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Manager Campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) + + # List Campaigns + + try { + Get-BetaActiveCampaigns + + # Below is a request that includes all optional parameters + # Get-BetaActiveCampaigns -BetaDetail $Detail -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaActiveCampaigns" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. + + # Get Campaign + + try { + Get-BetaCampaign-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaCampaign -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/reports + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. + + # Get Campaign Reports + + try { + Get-BetaCampaignReports-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaCampaignReports -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignReports" + Write-Host $_.ErrorDetails + } +- path: /campaigns/reports-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Campaign Reports Configuration + + try { + Get-BetaCampaignReportsConfig + + # Below is a request that includes all optional parameters + # Get-BetaCampaignReportsConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignReportsConfig" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. + + # Get a Campaign Template + + try { + Get-BetaCampaignTemplate-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaCampaignTemplate -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. + + # Get Campaign Template Schedule + + try { + Get-BetaCampaignTemplateSchedule-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaCampaignTemplateSchedule -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $Filters = "name eq "manager template"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + + # List Campaign Templates + + try { + Get-BetaCampaignTemplates + + # Below is a request that includes all optional parameters + # Get-BetaCampaignTemplates -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplates" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/reassign + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID + $AdminReviewReassign = @" + { + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } + } + "@ + + # Reassign Certifications + + try { + $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign + Move-Beta-BetaId $Id -BetaAdminReviewReassign $Result + + # Below is a request that includes all optional parameters + # Move-Beta -BetaId $Id -BetaAdminReviewReassign $AdminReviewReassign + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-Beta" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update a Campaign Template + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaCampaignTemplate-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaCampaignTemplate -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaigns/reports-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CampaignReportsConfig = @" + { + "identityAttributeColumns" : [ "firstname", "lastname" ] + } + "@ + + # Set Campaign Reports Configuration + + try { + $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig + Set-BetaCampaignReportsConfig-BetaCampaignReportsConfig $Result + + # Below is a request that includes all optional parameters + # Set-BetaCampaignReportsConfig -BetaCampaignReportsConfig $CampaignReportsConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaCampaignReportsConfig" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template being scheduled. + $Schedule = @" + { + "hours" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "months" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "timeZoneId" : "CST", + "days" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "expiration" : "2000-01-23T04:56:07.000+00:00", + "type" : "WEEKLY" + } + "@ + + # Set Campaign Template Schedule + + try { + Set-BetaCampaignTemplateSchedule-BetaId $Id + + # Below is a request that includes all optional parameters + # Set-BetaCampaignTemplateSchedule -BetaId $Id -BetaSchedule $Schedule + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaCampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/activate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $ActivateCampaignOptions = @" + { + "timeZone" : "-05:00" + } + "@ + + # Activate a Campaign + + try { + Start-BetaCampaign-BetaId $Id + + # Below is a request that includes all optional parameters + # Start-BetaCampaign -BetaId $Id -BetaActivateCampaignOptions $ActivateCampaignOptions + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/run-remediation-scan + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. + + # Run Campaign Remediation Scan + + try { + Start-BetaCampaignRemediationScan-BetaId $Id + + # Below is a request that includes all optional parameters + # Start-BetaCampaignRemediationScan -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaignRemediationScan" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/run-report/{type} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. + $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of report to run. + + # Run Campaign Report + + try { + Start-BetaCampaignReport-BetaId $Id -BetaType $Type + + # Below is a request that includes all optional parameters + # Start-BetaCampaignReport -BetaId $Id -BetaType $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaignReport" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/generate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. + + # Generate a Campaign from Template + + try { + Start-BetaGenerateCampaignTemplate-BetaId $Id + + # Below is a request that includes all optional parameters + # Start-BetaGenerateCampaignTemplate -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaGenerateCampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign being modified. + $RequestBody = # SystemCollectionsHashtable[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline + $RequestBody = @"[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]"@ + + + # Update a Campaign + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaCampaign-BetaId $Id -BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaCampaign -BetaId $Id -BetaRequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCampaign" + Write-Host $_.ErrorDetails + } +- path: /certifications/{certificationId}/access-review-items/{itemId}/permissions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID + $Filters = "target eq "SYS.OBJAUTH2"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Permissions for Entitlement Certification Item + + try { + Get-BetaIdentityCertificationItemPermissions-BetaCertificationId $CertificationId -BetaItemId $ItemId + + # Below is a request that includes all optional parameters + # Get-BetaIdentityCertificationItemPermissions -BetaCertificationId $CertificationId -BetaItemId $ItemId -BetaFilters $Filters -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationItemPermissions" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/tasks-pending + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "MyId" # String | The identity campaign certification ID + + # Pending Certification Tasks + + try { + Get-BetaIdentityCertificationPendingTasks-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentityCertificationPendingTasks -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationPendingTasks" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/tasks/{taskId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "MyId" # String | The identity campaign certification ID + $TaskId = "MyTaskId" # String | The certification task ID + + # Certification Task Status + + try { + Get-BetaIdentityCertificationTaskStatus-BetaId $Id -BetaTaskId $TaskId + + # Below is a request that includes all optional parameters + # Get-BetaIdentityCertificationTaskStatus -BetaId $Id -BetaTaskId $TaskId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationTaskStatus" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reviewers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) + + # List of Reviewers for certification + + try { + Get-BetaCertificationReviewers-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaCertificationReviewers -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCertificationReviewers" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reassign-async + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $ReviewReassign = @" + { + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + } + "@ + + # Reassign Certifications Asynchronously + + try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Submit-BetaReassignCertsAsync-BetaId $Id -BetaReviewReassign $Result + + # Below is a request that includes all optional parameters + # Submit-BetaReassignCertsAsync -BetaId $Id -BetaReviewReassign $ReviewReassign + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaReassignCertsAsync" + Write-Host $_.ErrorDetails + } +- path: /connector-rules + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ConnectorRuleCreateRequest = @" + { + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "type" : "BuildMap" + } + "@ + + # Create Connector Rule + + try { + $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest + New-BetaConnectorRule-BetaConnectorRuleCreateRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaConnectorRule -BetaConnectorRuleCreateRequest $ConnectorRuleCreateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete + + # Delete a Connector-Rule + + try { + Remove-BetaConnectorRule-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaConnectorRule -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to retrieve + + # Connector-Rule by ID + + try { + Get-BetaConnectorRule-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaConnectorRule -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Connector Rules + + try { + Get-BetaConnectorRuleList + + # Below is a request that includes all optional parameters + # Get-BetaConnectorRuleList + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorRuleList" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to update + $ConnectorRuleUpdateRequest = @" + { + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", + "type" : "BuildMap" + } + "@ + + # Update a Connector Rule + + try { + Update-BetaConnectorRule-BetaId $Id + + # Below is a request that includes all optional parameters + # Update-BetaConnectorRule -BetaId $Id -BetaConnectorRuleUpdateRequest $ConnectorRuleUpdateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/validate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceCode = @" + { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + } + "@ + + # Validate Connector Rule + + try { + $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode + Confirm-BetaConnectorRule-BetaSourceCode $Result + + # Below is a request that includes all optional parameters + # Confirm-BetaConnectorRule -BetaSourceCode $SourceCode + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Confirm-BetaConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connectors + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "directConnect eq "true"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Get Connector List + + try { + Get-BetaConnectorList + + # Below is a request that includes all optional parameters + # Get-BetaConnectorList -BetaFilters $Filters -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaLocale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorList" + Write-Host $_.ErrorDetails + } +- path: /form-definitions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreateFormDefinitionRequest = @" + { + "owner" : { + "name" : "Grant Smith", + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "formConditions" : [ { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + }, { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + } ], + "formInput" : [ { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + }, { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + } ], + "name" : "My form", + "description" : "My form description", + "usedBy" : [ { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + }, { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + } ], + "formElements" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + } ] + } + "@ + + # Creates a form definition. + + try { + New-BetaFormDefinition + + # Below is a request that includes all optional parameters + # New-BetaFormDefinition -BetaCreateFormDefinitionRequest $CreateFormDefinitionRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinition" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/template + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreateFormDefinitionRequest = @" + { + "owner" : { + "name" : "Grant Smith", + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "formConditions" : [ { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + }, { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + } ], + "formInput" : [ { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + }, { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + } ], + "name" : "My form", + "description" : "My form description", + "usedBy" : [ { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + }, { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + } ], + "formElements" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + } ] + } + "@ + + # Create a form definition by template. + + try { + New-BetaFormDefinitionByTemplate + + # Below is a request that includes all optional parameters + # New-BetaFormDefinitionByTemplate -BetaCreateFormDefinitionRequest $CreateFormDefinitionRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionByTemplate" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/forms-action-dynamic-schema + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Body = @" + { + "description" : "A description", + "attributes" : { + "formDefinitionId" : "00000000-0000-0000-0000-000000000000" + }, + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "action", + "versionNumber" : 1 + } + "@ + + # Generate JSON Schema dynamically. + + try { + New-BetaFormDefinitionDynamicSchema + + # Below is a request that includes all optional parameters + # New-BetaFormDefinitionDynamicSchema -BetaBody $Body + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionDynamicSchema" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID}/upload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID + $File = # System.IO.FileInfo | File specifying the multipart + + # Upload new form definition file. + + try { + New-BetaFormDefinitionFileRequest-BetaFormDefinitionID $FormDefinitionID -BetaFile $File + + # Below is a request that includes all optional parameters + # New-BetaFormDefinitionFileRequest -BetaFormDefinitionID $FormDefinitionID -BetaFile $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionFileRequest" + Write-Host $_.ErrorDetails + } +- path: /form-instances + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Body = @" + { + "formInput" : { + "input1" : "Sales" + }, + "standAloneForm" : false, + "createdBy" : { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "WORKFLOW_EXECUTION" + }, + "recipients" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + } ], + "expire" : "2023-08-12T20:14:57.74486Z", + "formDefinitionId" : "00000000-0000-0000-0000-000000000000", + "state" : "ASSIGNED", + "ttl" : 1571827560 + } + "@ + + # Creates a form instance. + + try { + New-BetaFormInstance + + # Below is a request that includes all optional parameters + # New-BetaFormInstance -BetaBody $Body + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormInstance" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + + # Deletes a form definition. + + try { + Remove-BetaFormDefinition-BetaFormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Remove-BetaFormDefinition -BetaFormDefinitionID $FormDefinitionID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaFormDefinition" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + $Filters = "name sw "my form"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") + + # List form definitions by tenant. + + try { + Export-BetaFormDefinitionsByTenant + + # Below is a request that includes all optional parameters + # Export-BetaFormDefinitionsByTenant -BetaOffset $Offset -BetaLimit $Limit -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaFormDefinitionsByTenant" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID}/file/{fileID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID Form definition ID + $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. + + # Download definition file by fileId. + + try { + Get-BetaFileFromS3-BetaFormDefinitionID $FormDefinitionID -BetaFileID $FileID + + # Below is a request that includes all optional parameters + # Get-BetaFileFromS3 -BetaFormDefinitionID $FormDefinitionID -BetaFileID $FileID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFileFromS3" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + + # Return a form definition. + + try { + Get-BetaFormDefinitionByKey-BetaFormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Get-BetaFormDefinitionByKey -BetaFormDefinitionID $FormDefinitionID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormDefinitionByKey" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID + + # Returns a form instance. + + try { + Get-BetaFormInstanceByKey-BetaFormInstanceID $FormInstanceID + + # Below is a request that includes all optional parameters + # Get-BetaFormInstanceByKey -BetaFormInstanceID $FormInstanceID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormInstanceByKey" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID}/file/{fileID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | FormInstanceID Form instance ID + $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. + + # Download instance file by fileId. + + try { + Get-BetaFormInstanceFile-BetaFormInstanceID $FormInstanceID -BetaFileID $FileID + + # Below is a request that includes all optional parameters + # Get-BetaFormInstanceFile -BetaFormInstanceID $FormInstanceID -BetaFileID $FileID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormInstanceFile" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + + + + + + $Body = @"[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]"@ + + + # Import form definitions from export. + + try { + Import-BetaFormDefinitions + + # Below is a request that includes all optional parameters + # Import-BetaFormDefinitions -BetaBody $Body + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaFormDefinitions" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) + $Body = @"[{op=replace, path=/description, value=test-description}]"@ + + + # Patch a form definition. + + try { + Update-BetaFormDefinition-BetaFormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Update-BetaFormDefinition -BetaFormDefinitionID $FormDefinitionID -BetaBody $Body + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaFormDefinition" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID + $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) + $Body = @"[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]"@ + + + # Patch a form instance. + + try { + Update-BetaFormInstance-BetaFormInstanceID $FormInstanceID + + # Below is a request that includes all optional parameters + # Update-BetaFormInstance -BetaFormInstanceID $FormInstanceID -BetaBody $Body + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaFormInstance" + Write-Host $_.ErrorDetails + } +- path: /form-definitions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 250 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + $Filters = "name sw "my form"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") + + # Export form definitions by tenant. + + try { + Search-BetaFormDefinitionsByTenant + + # Below is a request that includes all optional parameters + # Search-BetaFormDefinitionsByTenant -BetaOffset $Offset -BetaLimit $Limit -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormDefinitionsByTenant" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID}/data-source/{formElementID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID + $FormElementID = "1" # String | Form element ID + $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + $Filters = "value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) + $Query = "support" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) + + # Retrieves dynamic data by element. + + try { + Search-BetaFormElementDataByElementID-BetaFormInstanceID $FormInstanceID -BetaFormElementID $FormElementID + + # Below is a request that includes all optional parameters + # Search-BetaFormElementDataByElementID -BetaFormInstanceID $FormInstanceID -BetaFormElementID $FormElementID -BetaLimit $Limit -BetaFilters $Filters -BetaQuery $Query + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormElementDataByElementID" + Write-Host $_.ErrorDetails + } +- path: /form-instances + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List form instances by tenant. + + try { + Search-BetaFormInstancesByTenant + + # Below is a request that includes all optional parameters + # Search-BetaFormInstancesByTenant + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormInstancesByTenant" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/predefined-select-options + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List predefined select options. + + try { + Search-BetaPreDefinedSelectOptions + + # Below is a request that includes all optional parameters + # Search-BetaPreDefinedSelectOptions + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaPreDefinedSelectOptions" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID}/data-source + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + $Limit = 10 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) + $Filters = "value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) + $Query = "ac" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) + $FormElementPreviewRequest = @" + { + "dataSource" : { + "config" : { + "indices" : [ "identities" ], + "query" : "*", + "aggregationBucketField" : "attributes.cloudStatus.exact", + "objectType" : "IDENTITY" + }, + "dataSourceType" : "STATIC" + } + } + "@ + + # Preview form definition data source. + + try { + Show-BetaPreviewDataSource-BetaFormDefinitionID $FormDefinitionID + + # Below is a request that includes all optional parameters + # Show-BetaPreviewDataSource -BetaFormDefinitionID $FormDefinitionID -BetaLimit $Limit -BetaFilters $Filters -BetaQuery $Query -BetaFormElementPreviewRequest $FormElementPreviewRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-BetaPreviewDataSource" + Write-Host $_.ErrorDetails + } +- path: /custom-password-instructions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CustomPasswordInstruction = @" + { + "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", + "pageId" : "change-password:enter-password", + "locale" : "en" + } + "@ + + # Create Custom Password Instructions + + try { + $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction + New-BetaCustomPasswordInstructions-BetaCustomPasswordInstruction $Result + + # Below is a request that includes all optional parameters + # New-BetaCustomPasswordInstructions -BetaCustomPasswordInstruction $CustomPasswordInstruction + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCustomPasswordInstructions" + Write-Host $_.ErrorDetails + } +- path: /custom-password-instructions/{pageId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to delete. + $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) + + # Delete Custom Password Instructions by page ID + + try { + Remove-BetaCustomPasswordInstructions-BetaPageId $PageId + + # Below is a request that includes all optional parameters + # Remove-BetaCustomPasswordInstructions -BetaPageId $PageId -BetaLocale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCustomPasswordInstructions" + Write-Host $_.ErrorDetails + } +- path: /custom-password-instructions/{pageId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to query. + $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) + + # Get Custom Password Instructions by Page ID + + try { + Get-BetaCustomPasswordInstructions-BetaPageId $PageId + + # Below is a request that includes all optional parameters + # Get-BetaCustomPasswordInstructions -BetaPageId $PageId -BetaLocale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomPasswordInstructions" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + + # Add metadata to an entitlement. + + try { + New-BetaAccessModelMetadataForEntitlement-BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue + + # Below is a request that includes all optional parameters + # New-BetaAccessModelMetadataForEntitlement -BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessModelMetadataForEntitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + + # Remove metadata from an entitlement. + + try { + Remove-BetaAccessModelMetadataFromEntitlement-BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue + + # Below is a request that includes all optional parameters + # Remove-BetaAccessModelMetadataFromEntitlement -BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessModelMetadataFromEntitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID + + # Get an entitlement + + try { + Get-BetaEntitlement-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaEntitlement -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/entitlement-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id + + # Get Entitlement Request Config + + try { + Get-BetaEntitlementRequestConfig-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementRequestConfig -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /entitlements/aggregate/sources/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id + $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) + + # Aggregate Entitlements + + try { + Import-BetaEntitlementsBySource-BetaId $Id + + # Below is a request that includes all optional parameters + # Import-BetaEntitlementsBySource -BetaId $Id -BetaCsvFile $CsvFile + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaEntitlementsBySource" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/children + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + # List of entitlements children + + try { + Get-BetaEntitlementChildren-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementChildren -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementChildren" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/parents + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + # List of entitlements parents + + try { + Get-BetaEntitlementParents-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementParents -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementParents" + Write-Host $_.ErrorDetails + } +- path: /entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (optional) + $SegmentedForIdentity = "me" # String | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) + $ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) + $IncludeUnsegmented = $true # Boolean | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to $true) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) + + # Gets a list of entitlements. + + try { + Get-BetaEntitlements + + # Below is a request that includes all optional parameters + # Get-BetaEntitlements -BetaAccountId $AccountId -BetaSegmentedForIdentity $SegmentedForIdentity -BetaForSegmentIds $ForSegmentIds -BetaIncludeUnsegmented $IncludeUnsegmented -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlements" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch an entitlement + + try { + Update-BetaEntitlement-BetaId $Id + + # Below is a request that includes all optional parameters + # Update-BetaEntitlement -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/entitlement-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID + $EntitlementRequestConfig = @" + { + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + } + "@ + + # Replace Entitlement Request Config + + try { + $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig + Send-BetaEntitlementRequestConfig-BetaId $Id -BetaEntitlementRequestConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaEntitlementRequestConfig -BetaId $Id -BetaEntitlementRequestConfig $EntitlementRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /entitlements/reset/sources/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset + + # Reset Source Entitlements + + try { + Reset-BetaSourceEntitlements-BetaId $Id + + # Below is a request that includes all optional parameters + # Reset-BetaSourceEntitlements -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-BetaSourceEntitlements" + Write-Host $_.ErrorDetails + } +- path: /entitlements/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $EntitlementBulkUpdateRequest = @" + { + "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/privileged", + "value" : false + }, { + "op" : "replace", + "path" : "/requestable", + "value" : false + } ] + } + "@ + + # Bulk update an entitlement list + + try { + $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest + Update-BetaEntitlementsInBulk-BetaEntitlementBulkUpdateRequest $Result + + # Below is a request that includes all optional parameters + # Update-BetaEntitlementsInBulk -BetaEntitlementBulkUpdateRequest $EntitlementBulkUpdateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlementsInBulk" + Write-Host $_.ErrorDetails + } +- path: /workgroups + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $WorkgroupDto = @" + { + "owner" : { + "emailAddress" : "support@sailpoint.com", + "displayName" : "Support", + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "connectionCount" : 1641498673000, + "created" : "2022-01-06T19:51:13Z", + "memberCount" : 1641498673000, + "name" : "DB Access Governance Group", + "description" : "Description of the Governance Group", + "modified" : "2022-01-06T19:51:13Z", + "id" : "2c91808568c529c60168cca6f90c1313" + } + "@ + + # Create a new Governance Group. + + try { + $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto + New-BetaWorkgroup-BetaWorkgroupDto $Result + + # Below is a request that includes all optional parameters + # New-BetaWorkgroup -BetaWorkgroupDto $WorkgroupDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + + # Delete a Governance Group + + try { + Remove-BetaWorkgroup-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaWorkgroup -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/members/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $BulkWorkgroupMembersRequestInner = @""@ + + + # Remove members from Governance Group + + try { + $Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner + Remove-BetaWorkgroupMembers-BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result + + # Below is a request that includes all optional parameters + # Remove-BetaWorkgroupMembers -BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $BulkWorkgroupMembersRequestInner + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroupMembers" + Write-Host $_.ErrorDetails + } +- path: /workgroups/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $WorkgroupBulkDeleteRequest = @" + { + "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] + } + "@ + + # Delete Governance Group(s) + + try { + $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest + Remove-BetaWorkgroupsInBulk-BetaWorkgroupBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaWorkgroupsInBulk -BetaWorkgroupBulkDeleteRequest $WorkgroupBulkDeleteRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroupsInBulk" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + + # Get Governance Group by Id + + try { + Get-BetaWorkgroup-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkgroup -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/connections + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + + # List connections for Governance Group + + try { + Get-BetaConnections-BetaWorkgroupId $WorkgroupId + + # Below is a request that includes all optional parameters + # Get-BetaConnections -BetaWorkgroupId $WorkgroupId -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnections" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/members + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + + # List Governance Group Members + + try { + Get-BetaWorkgroupMembers-BetaWorkgroupId $WorkgroupId + + # Below is a request that includes all optional parameters + # Get-BetaWorkgroupMembers -BetaWorkgroupId $WorkgroupId -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroupMembers" + Write-Host $_.ErrorDetails + } +- path: /workgroups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw "Test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional) + + # List Governance Groups + + try { + Get-BetaWorkgroups + + # Below is a request that includes all optional parameters + # Get-BetaWorkgroups -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroups" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Governance Group + + try { + Update-BetaWorkgroup-BetaId $Id + + # Below is a request that includes all optional parameters + # Update-BetaWorkgroup -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/members/bulk-add + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $BulkWorkgroupMembersRequestInner = @""@ + + + # Add members to Governance Group + + try { + $Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner + Update-BetaWorkgroupMembers-BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaWorkgroupMembers -BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $BulkWorkgroupMembersRequestInner + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkgroupMembers" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/ignored-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessRequestRecommendationActionItemDto = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Notification of Ignored Access Request Recommendations + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-BetaAccessRequestRecommendationsIgnoredItem-BetaAccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-BetaAccessRequestRecommendationsIgnoredItem -BetaAccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsIgnoredItem" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/requested-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessRequestRecommendationActionItemDto = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Notification of Requested Access Request Recommendations + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-BetaAccessRequestRecommendationsRequestedItem-BetaAccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-BetaAccessRequestRecommendationsRequestedItem -BetaAccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsRequestedItem" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/viewed-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessRequestRecommendationActionItemDto = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Notification of Viewed Access Request Recommendations + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-BetaAccessRequestRecommendationsViewedItem-BetaAccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-BetaAccessRequestRecommendationsViewedItem -BetaAccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsViewedItem" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/viewed-items/bulk-create + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessRequestRecommendationActionItemDto = @"{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }"@ + + + # Notification of Viewed Access Request Recommendations in Bulk + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-BetaAccessRequestRecommendationsViewedItems-BetaAccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-BetaAccessRequestRecommendationsViewedItems -BetaAccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsViewedItems" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "2c91808570313110017040b06f344ec9" # String | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") + $Limit = 56 # Int32 | Max number of results to return. (optional) (default to 15) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $IncludeTranslationMessages = $false # Boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to $false) + $Filters = "access.name co "admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) + + # Identity Access Request Recommendations + + try { + Get-BetaAccessRequestRecommendations + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestRecommendations -BetaIdentityId $IdentityId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaIncludeTranslationMessages $IncludeTranslationMessages -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendations" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/ignored-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "identityId eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + + # List of Ignored Access Request Recommendations + + try { + Get-BetaAccessRequestRecommendationsIgnoredItems + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestRecommendationsIgnoredItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsIgnoredItems" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/requested-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + + # List of Requested Access Request Recommendations + + try { + Get-BetaAccessRequestRecommendationsRequestedItems + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestRecommendationsRequestedItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsRequestedItems" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/viewed-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + + # List of Viewed Access Request Recommendations + + try { + Get-BetaAccessRequestRecommendationsViewedItems + + # Below is a request that includes all optional parameters + # Get-BetaAccessRequestRecommendationsViewedItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsViewedItems" + Write-Host $_.ErrorDetails + } +- path: /common-access + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CommonAccessItemRequest = @" + { + "access" : { + "ownerName" : "ownerName", + "name" : "name", + "description" : "description", + "id" : "id", + "type" : "ACCESS_PROFILE", + "ownerId" : "ownerId" + }, + "status" : "CONFIRMED" + } + "@ + + # Create common access items + + try { + $Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest + New-BetaCommonAccess-BetaCommonAccessItemRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaCommonAccess -BetaCommonAccessItemRequest $CommonAccessItemRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCommonAccess" + Write-Host $_.ErrorDetails + } +- path: /common-access + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.type eq "ROLE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) + + # Get a paginated list of common access + + try { + Get-BetaCommonAccess + + # Below is a request that includes all optional parameters + # Get-BetaCommonAccess -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCommonAccess" + Write-Host $_.ErrorDetails + } +- path: /common-access/update-status + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CommonAccessIDStatus = @"{ + "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], + "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] + }"@ + + + # Bulk update common access status + + try { + $Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus + Update-BetaCommonAccessStatusInBulk-BetaCommonAccessIDStatus $Result + + # Below is a request that includes all optional parameters + # Update-BetaCommonAccessStatusInBulk -BetaCommonAccessIDStatus $CommonAccessIDStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCommonAccessStatusInBulk" + Write-Host $_.ErrorDetails + } +- path: /translation-catalogs/{catalog-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CatalogId = "recommender" # String | The ID of the message catalog. + + # Get Message catalogs + + try { + Get-BetaMessageCatalogs-BetaCatalogId $CatalogId + + # Below is a request that includes all optional parameters + # Get-BetaMessageCatalogs -BetaCatalogId $CatalogId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMessageCatalogs" + Write-Host $_.ErrorDetails + } +- path: /outliers/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + + # IAI Identity Outliers Export + + try { + Export-BetaOutliersZip + + # Below is a request that includes all optional parameters + # Export-BetaOutliersZip -BetaType $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaOutliersZip" + Write-Host $_.ErrorDetails + } +- path: /outlier-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + $Filters = "snapshotDate ge "2022-02-07T20:13:29.356648026Z"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* (optional) + $Sorters = "snapshotDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** (optional) + + # IAI Identity Outliers Summary + + try { + Get-BetaIdentityOutlierSnapshots + + # Below is a request that includes all optional parameters + # Get-BetaIdentityOutlierSnapshots -BetaLimit $Limit -BetaOffset $Offset -BetaType $Type -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOutlierSnapshots" + Write-Host $_.ErrorDetails + } +- path: /outliers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + $Filters = "attributes.displayName sw "John" and certStatus eq "false"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) + $Sorters = "attributes.displayName,firstDetectionDate,-score" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** (optional) + + # IAI Get Identity Outliers + + try { + Get-BetaIdentityOutliers + + # Below is a request that includes all optional parameters + # Get-BetaIdentityOutliers -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaType $Type -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOutliers" + Write-Host $_.ErrorDetails + } +- path: /outlier-summaries/latest + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + + # IAI Identity Outliers Latest Summary + + try { + Get-BetaLatestIdentityOutlierSnapshots + + # Below is a request that includes all optional parameters + # Get-BetaLatestIdentityOutlierSnapshots -BetaType $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLatestIdentityOutlierSnapshots" + Write-Host $_.ErrorDetails + } +- path: /outlier-feature-summaries/{outlierFeatureId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OutlierFeatureId = "04654b66-7561-4090-94f9-abee0722a1af" # String | Contributing feature id + + # Get identity outlier contibuting feature summary + + try { + Get-BetaOutlierContributingFeatureSummary-BetaOutlierFeatureId $OutlierFeatureId + + # Below is a request that includes all optional parameters + # Get-BetaOutlierContributingFeatureSummary -BetaOutlierFeatureId $OutlierFeatureId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOutlierContributingFeatureSummary" + Write-Host $_.ErrorDetails + } +- path: /outliers/{outlierId}/contributing-features + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $IncludeTranslationMessages = "include-translation-messages=" # String | Whether or not to include translation messages object in returned response (optional) + $Sorters = "importance" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** (optional) + + # Get identity outlier's contibuting features + + try { + Get-BetaPeerGroupOutliersContributingFeatures-BetaOutlierId $OutlierId + + # Below is a request that includes all optional parameters + # Get-BetaPeerGroupOutliersContributingFeatures -BetaOutlierId $OutlierId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaIncludeTranslationMessages $IncludeTranslationMessages -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPeerGroupOutliersContributingFeatures" + Write-Host $_.ErrorDetails + } +- path: /outliers/ignore + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ + + + # IAI Identity Outliers Ignore + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Invoke-BetaIgnoreIdentityOutliers-BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Invoke-BetaIgnoreIdentityOutliers -BetaRequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaIgnoreIdentityOutliers" + Write-Host $_.ErrorDetails + } +- path: /outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id + $ContributingFeatureName = "radical_entitlement_count" # String | The name of contributing feature + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $AccessType = "ENTITLEMENT" # String | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) + $Sorters = "displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) + + # Gets a list of access items associated with each identity outlier contributing feature + + try { + Get-BetaOutliersContributingFeatureAccessItems-BetaOutlierId $OutlierId -BetaContributingFeatureName $ContributingFeatureName + + # Below is a request that includes all optional parameters + # Get-BetaOutliersContributingFeatureAccessItems -BetaOutlierId $OutlierId -BetaContributingFeatureName $ContributingFeatureName -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaAccessType $AccessType -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOutliersContributingFeatureAccessItems" + Write-Host $_.ErrorDetails + } +- path: /outliers/unignore + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ + + + # IAI Identity Outliers Unignore + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Invoke-BetaUnIgnoreIdentityOutliers-BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Invoke-BetaUnIgnoreIdentityOutliers -BetaRequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaUnIgnoreIdentityOutliers" + Write-Host $_.ErrorDetails + } +- path: /peer-group-strategies/{strategy}/identity-outliers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Strategy = "entitlement" # String | The strategy used to create peer groups. Currently, 'entitlement' is supported. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Identity Outliers List + + try { + Get-BetaPeerGroupOutliers-BetaStrategy $Strategy + + # Below is a request that includes all optional parameters + # Get-BetaPeerGroupOutliers -BetaStrategy $Strategy -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPeerGroupOutliers" + Write-Host $_.ErrorDetails + } +- path: /recommendations/request + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RecommendationRequestDto = @" + { + "prescribeMode" : false, + "excludeInterpretations" : false, + "requests" : [ { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + }, { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + } ], + "includeTranslationMessages" : false, + "includeDebugInformation" : true + } + "@ + + # Returns a Recommendation Based on Object + + try { + $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto + Get-BetaRecommendations-BetaRecommendationRequestDto $Result + + # Below is a request that includes all optional parameters + # Get-BetaRecommendations -BetaRecommendationRequestDto $RecommendationRequestDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRecommendations" + Write-Host $_.ErrorDetails + } +- path: /recommendations/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get certification recommendation config values + + try { + Get-BetaRecommendationsConfig + + # Below is a request that includes all optional parameters + # Get-BetaRecommendationsConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRecommendationsConfig" + Write-Host $_.ErrorDetails + } +- path: /recommendations/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RecommendationConfigDto = @" + { + "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], + "peerGroupPercentageThreshold" : 0.5, + "runAutoSelectOnce" : false, + "onlyTuneThreshold" : false + } + "@ + + # Update certification recommendation config values + + try { + $Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto + Update-BetaRecommendationsConfig-BetaRecommendationConfigDto $Result + + # Below is a request that includes all optional parameters + # Update-BetaRecommendationsConfig -BetaRecommendationConfigDto $RecommendationConfigDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRecommendationsConfig" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $MinEntitlementPopularity = 56 # Int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to $true) + $RoleMiningPotentialRoleProvisionRequest = @" + { + "includeIdentities" : true, + "roleName" : "Finance - Accounting", + "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", + "roleDescription" : "General access for accounting department", + "directlyAssignedEntitlements" : false + } + "@ + + # Create request to provision a potential role into an actual role. + + try { + New-BetaPotentialRoleProvisionRequest-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # New-BetaPotentialRoleProvisionRequest -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaMinEntitlementPopularity $MinEntitlementPopularity -BetaIncludeCommonAccess $IncludeCommonAccess -BetaRoleMiningPotentialRoleProvisionRequest $RoleMiningPotentialRoleProvisionRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPotentialRoleProvisionRequest" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleMiningSessionDto = @" + { + "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", + "prescribedPruneThreshold" : 10, + "pruneThreshold" : 50, + "saved" : true, + "potentialRolesReadyCount" : 0, + "scope" : { + "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], + "attributeFilterCriteria" : { + "displayName" : { + "untranslated" : "Location: Miami" + }, + "ariaLabel" : { + "untranslated" : "Location: Miami" + }, + "data" : { + "displayName" : { + "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" + }, + "name" : "location", + "operator" : "EQUALS", + "values" : [ "Miami" ] + } + }, + "criteria" : "source.name:DataScienceDataset" + }, + "potentialRoleCount" : 0, + "name" : "Saved RM Session - 07/10", + "minNumIdentitiesInPotentialRole" : 20, + "identityCount" : 0, + "type" : "SPECIALIZED" + } + "@ + + # Create a role mining session + + try { + $Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto + New-BetaRoleMiningSessions-BetaRoleMiningSessionDto $Result + + # Below is a request that includes all optional parameters + # New-BetaRoleMiningSessions -BetaRoleMiningSessionDto $RoleMiningSessionDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRoleMiningSessions" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session + $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role + + # Export (download) details for a potential role in a role mining session + + try { + Invoke-BetaDownloadRoleMiningPotentialRoleZip-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId + + # Below is a request that includes all optional parameters + # Invoke-BetaDownloadRoleMiningPotentialRoleZip -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaDownloadRoleMiningPotentialRoleZip" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + + # Export (download) details for a potential role in a role mining session + + try { + Export-BetaRoleMiningPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Export-BetaRoleMiningPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session + $RoleMiningPotentialRoleExportRequest = @" + { + "minEntitlementPopularity" : 0, + "includeCommonAccess" : true + } + "@ + + # Asynchronously export details for a potential role in a role mining session and upload to S3 + + try { + Export-BetaRoleMiningPotentialRoleAsync-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Export-BetaRoleMiningPotentialRoleAsync -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleExportRequest $RoleMiningPotentialRoleExportRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRoleAsync" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session + $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role + + # Retrieve status of a potential role export job + + try { + Export-BetaRoleMiningPotentialRoleStatus-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId + + # Below is a request that includes all optional parameters + # Export-BetaRoleMiningPotentialRoleStatus -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRoleStatus" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) + $Filters = "(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true))" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all potential role summaries + + try { + Get-BetaAllPotentialRoleSummaries + + # Below is a request that includes all optional parameters + # Get-BetaAllPotentialRoleSummaries -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllPotentialRoleSummaries" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) + + # Retrieves entitlement popularity distribution for a potential role in a role mining session + + try { + Get-BetaEntitlementDistributionPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementDistributionPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaIncludeCommonAccess $IncludeCommonAccess + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementDistributionPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) (default to $true) + $Sorters = "popularity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) + $Filters = "applicationName sw "AD"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves entitlements for a potential role in a role mining session + + try { + Get-BetaEntitlementsPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementsPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaIncludeCommonAccess $IncludeCommonAccess -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $Sorters = "populariity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** (optional) + $Filters = "applicationName sw "AD"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves excluded entitlements for a potential role in a role mining session + + try { + Get-BetaExcludedEntitlementsPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaExcludedEntitlementsPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaExcludedEntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves identities for a potential role in a role mining session + + try { + Get-BetaIdentitiesPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaIdentitiesPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitiesPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + + # Retrieve potential role in session + + try { + Get-BetaPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session + $Filters = "applicationName sw "test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves the applications of a potential role for a role mining session + + try { + Get-BetaPotentialRoleApplications-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRoleApplications -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleApplications" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session + $Filters = "entitlementRef.name sw "test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves the entitlements of a potential role for a role mining session + + try { + Get-BetaPotentialRoleEntitlements-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRoleEntitlements -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleEntitlements" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PotentialRoleId = "e0cc5d7d-bf7f-4f81-b2af-8885b09d9923" # String | A potential role id + $SourceId = "2c9180877620c1460176267f336a106f" # String | A source id + $Sorters = "-usageCount" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves potential role source usage + + try { + Get-BetaPotentialRoleSourceIdentityUsage-BetaPotentialRoleId $PotentialRoleId -BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRoleSourceIdentityUsage -BetaPotentialRoleId $PotentialRoleId -BetaSourceId $SourceId -BetaSorters $Sorters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleSourceIdentityUsage" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** (optional) + $Filters = "(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true))" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieve session's potential role summaries + + try { + Get-BetaPotentialRoleSummaries-BetaSessionId $SessionId + + # Below is a request that includes all optional parameters + # Get-BetaPotentialRoleSummaries -BetaSessionId $SessionId -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleSummaries" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/{potentialRoleId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id + + # Retrieves a specific potential role + + try { + Get-BetaRoleMiningPotentialRole-BetaPotentialRoleId $PotentialRoleId + + # Below is a request that includes all optional parameters + # Get-BetaRoleMiningPotentialRole -BetaPotentialRoleId $PotentialRoleId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be retrieved. + + # Get a role mining session + + try { + Get-BetaRoleMiningSession-BetaSessionId $SessionId + + # Below is a request that includes all optional parameters + # Get-BetaRoleMiningSession -BetaSessionId $SessionId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSession" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + + # Get role mining session status state + + try { + Get-BetaRoleMiningSessionStatus-BetaSessionId $SessionId + + # Below is a request that includes all optional parameters + # Get-BetaRoleMiningSessionStatus -BetaSessionId $SessionId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSessionStatus" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "saved eq "true" and name sw "RM Session"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* (optional) + $Sorters = "createdBy,createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all role mining sessions + + try { + Get-BetaRoleMiningSessions + + # Below is a request that includes all optional parameters + # Get-BetaRoleMiningSessions -BetaFilters $Filters -BetaSorters $Sorters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSessions" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/saved + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all saved potential roles + + try { + Get-BetaSavedPotentialRoles + + # Below is a request that includes all optional parameters + # Get-BetaSavedPotentialRoles -BetaSorters $Sorters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSavedPotentialRoles" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id + $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ + + + # Update a potential role in session + + try { + $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner + Update-BetaPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $PatchPotentialRoleRequestInner + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/{potentialRoleId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id + $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ + + + # Update a potential role + + try { + $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner + Update-BetaRoleMiningPotentialRole-BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaRoleMiningPotentialRole -BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $PatchPotentialRoleRequestInner + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRoleMiningPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be patched + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a role mining session + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaRoleMiningSession-BetaSessionId $SessionId -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaRoleMiningSession -BetaSessionId $SessionId -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRoleMiningSession" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $RoleMiningPotentialRoleEditEntitlements = @" + { + "ids" : [ "entId1", "entId2" ], + "exclude" : true + } + "@ + + # Edit entitlements for a potential role to exclude some entitlements + + try { + $Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements + Update-BetaEntitlementsPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleEditEntitlements $Result + + # Below is a request that includes all optional parameters + # Update-BetaEntitlementsPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleEditEntitlements $RoleMiningPotentialRoleEditEntitlements + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /icons/{objectType}/{objectId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ObjectType = "application" # String | Object type + $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. + + # Delete an icon + + try { + Remove-BetaIcon-BetaObjectType $ObjectType -BetaObjectId $ObjectId + + # Below is a request that includes all optional parameters + # Remove-BetaIcon -BetaObjectType $ObjectType -BetaObjectId $ObjectId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIcon" + Write-Host $_.ErrorDetails + } +- path: /icons/{objectType}/{objectId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ObjectType = "application" # String | Object type + $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. + $Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] + + # Update an icon + + try { + Set-BetaIcon-BetaObjectType $ObjectType -BetaObjectId $ObjectId -BetaImage $Image + + # Below is a request that includes all optional parameters + # Set-BetaIcon -BetaObjectType $ObjectType -BetaObjectId $ObjectId -BetaImage $Image + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaIcon" + Write-Host $_.ErrorDetails + } +- path: /identities/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + + # Delete identity + + try { + Remove-BetaIdentity-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaIdentity -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentity" + Write-Host $_.ErrorDetails + } +- path: /identities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + + # Identity Details + + try { + Get-BetaIdentity-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentity -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentity" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/ownership + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "ff8081814d2a8036014d701f3fbf53fa" # String | Identity ID. + + # Get ownership details + + try { + Get-BetaIdentityOwnershipDetails-BetaIdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Get-BetaIdentityOwnershipDetails -BetaIdentityId $IdentityId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOwnershipDetails" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/role-assignments/{assignmentId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + $AssignmentId = "1cbb0705b38c4226b1334eadd8874086" # String | Assignment Id + + # Role assignment details + + try { + Get-BetaRoleAssignment-BetaIdentityId $IdentityId -BetaAssignmentId $AssignmentId + + # Below is a request that includes all optional parameters + # Get-BetaRoleAssignment -BetaIdentityId $IdentityId -BetaAssignmentId $AssignmentId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignment" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/role-assignments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id to get the role assignments for + $RoleId = "e7697a1e96d04db1ac7b0f4544915d2c" # String | Role Id to filter the role assignments with (optional) + $RoleName = "Engineer" # String | Role name to filter the role assignments with (optional) + + # List role assignments + + try { + Get-BetaRoleAssignments-BetaIdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Get-BetaRoleAssignments -BetaIdentityId $IdentityId -BetaRoleId $RoleId -BetaRoleName $RoleName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignments" + Write-Host $_.ErrorDetails + } +- path: /identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) + $Sorters = "name,-cloudStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) + $DefaultFilter = "CORRELATED_ONLY" # String | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to "CORRELATED_ONLY") + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Identities + + try { + Get-BetaIdentities + + # Below is a request that includes all optional parameters + # Get-BetaIdentities -BetaFilters $Filters -BetaSorters $Sorters -BetaDefaultFilter $DefaultFilter -BetaCount $Count -BetaLimit $Limit -BetaOffset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentities" + Write-Host $_.ErrorDetails + } +- path: /identities/{id}/reset + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + + # Reset an identity + + try { + Reset-BetaIdentity-BetaIdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Reset-BetaIdentity -BetaIdentityId $IdentityId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-BetaIdentity" + Write-Host $_.ErrorDetails + } +- path: /identities/{id}/verification/account/send + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + $SendAccountVerificationRequest = @" + { + "sourceName" : "Active Directory Source", + "via" : "EMAIL_WORK" + } + "@ + + # Send password reset email + + try { + $Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest + Send-BetaIdentityVerificationAccountToken-BetaId $Id -BetaSendAccountVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaIdentityVerificationAccountToken -BetaId $Id -BetaSendAccountVerificationRequest $SendAccountVerificationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaIdentityVerificationAccountToken" + Write-Host $_.ErrorDetails + } +- path: /identities/invite + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $InviteIdentitiesRequest = @" + { + "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], + "uninvited" : false + } + "@ + + # Invite identities to register + + try { + $Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest + Start-BetaIdentitiesInvite-BetaInviteIdentitiesRequest $Result + + # Below is a request that includes all optional parameters + # Start-BetaIdentitiesInvite -BetaInviteIdentitiesRequest $InviteIdentitiesRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaIdentitiesInvite" + Write-Host $_.ErrorDetails + } +- path: /identities/process + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ProcessIdentitiesRequest = @" + { + "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] + } + "@ + + # Process a list of identityIds + + try { + $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest + Start-BetaIdentityProcessing-BetaProcessIdentitiesRequest $Result + + # Below is a request that includes all optional parameters + # Start-BetaIdentityProcessing -BetaProcessIdentitiesRequest $ProcessIdentitiesRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaIdentityProcessing" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/synchronize-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "MyIdentityId" # String | The Identity id + + # Attribute synchronization for single identity. + + try { + Sync-BetahronizeAttributesForIdentity-BetaIdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Sync-BetahronizeAttributesForIdentity -BetaIdentityId $IdentityId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetahronizeAttributesForIdentity" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityAttribute = @" + { + "standard" : false, + "system" : false, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + } + "@ + + # Create Identity Attribute + + try { + $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute + New-BetaIdentityAttribute-BetaIdentityAttribute $Result + + # Below is a request that includes all optional parameters + # New-BetaIdentityAttribute -BetaIdentityAttribute $IdentityAttribute + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "displayName" # String | The attribute's technical name. + + # Delete Identity Attribute + + try { + Remove-BetaIdentityAttribute-BetaName $Name + + # Below is a request that includes all optional parameters + # Remove-BetaIdentityAttribute -BetaName $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/bulk-delete + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityAttributeNames = @" + { + "ids" : [ "name", "displayName" ] + } + "@ + + # Bulk delete Identity Attributes + + try { + $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames + Remove-BetaIdentityAttributesInBulk-BetaIdentityAttributeNames $Result + + # Below is a request that includes all optional parameters + # Remove-BetaIdentityAttributesInBulk -BetaIdentityAttributeNames $IdentityAttributeNames + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttributesInBulk" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "displayName" # String | The attribute's technical name. + + # Get Identity Attribute + + try { + Get-BetaIdentityAttribute-BetaName $Name + + # Below is a request that includes all optional parameters + # Get-BetaIdentityAttribute -BetaName $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IncludeSystem = $false # Boolean | Include 'system' attributes in the response. (optional) (default to $false) + $IncludeSilent = $false # Boolean | Include 'silent' attributes in the response. (optional) (default to $false) + $SearchableOnly = $false # Boolean | Include only 'searchable' attributes in the response. (optional) (default to $false) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Identity Attributes + + try { + Get-BetaIdentityAttributes + + # Below is a request that includes all optional parameters + # Get-BetaIdentityAttributes -BetaIncludeSystem $IncludeSystem -BetaIncludeSilent $IncludeSilent -BetaSearchableOnly $SearchableOnly -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAttributes" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/{name} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "displayName" # String | The attribute's technical name. + $IdentityAttribute = @" + { + "standard" : false, + "system" : false, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + } + "@ + + # Update Identity Attribute + + try { + $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute + Send-BetaIdentityAttribute-BetaName $Name -BetaIdentityAttribute $Result + + # Below is a request that includes all optional parameters + # Send-BetaIdentityAttribute -BetaName $Name -BetaIdentityAttribute $IdentityAttribute + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaIdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/compare + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Snapshot1 = "2007-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) + $Snapshot2 = "2008-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) + $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) + + + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Gets a difference of count for each access item types for the given identity between 2 snapshots + + try { + Compare-BetaIdentitySnapshots-BetaId $Id + + # Below is a request that includes all optional parameters + # Compare-BetaIdentitySnapshots -BetaId $Id -BetaSnapshot1 $Snapshot1 -BetaSnapshot2 $Snapshot2 -BetaAccessItemTypes $AccessItemTypes -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-BetaIdentitySnapshots" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/compare/{access-type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $AccessType = "accessProfile" # String | The specific type which needs to be compared + $AccessAssociated = $false # Boolean | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) + $Snapshot1 = "2008-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) + $Snapshot2 = "2009-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Gets a list of differences of specific accessType for the given identity between 2 snapshots + + try { + Compare-BetaIdentitySnapshotsAccessType-BetaId $Id -BetaAccessType $AccessType + + # Below is a request that includes all optional parameters + # Compare-BetaIdentitySnapshotsAccessType -BetaId $Id -BetaAccessType $AccessType -BetaAccessAssociated $AccessAssociated -BetaSnapshot1 $Snapshot1 -BetaSnapshot2 $Snapshot2 -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-BetaIdentitySnapshotsAccessType" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + + # Get latest snapshot of identity + + try { + Get-BetaHistoricalIdentity-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaHistoricalIdentity -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentity" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/events + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $From = "2024-03-01T13:00:00Z" # String | The optional instant until which access events are returned (optional) + $EventTypes = "MyEventTypes" # String[] | An optional list of event types to return. If null or empty, all events are returned (optional) + + $EventTypes = @"[AccessAddedEvent, AccessRemovedEvent]"@ + $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) + + $AccessItemTypes = @"[entitlement, account]"@ + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Lists all events for the given identity + + try { + Get-BetaHistoricalIdentityEvents-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaHistoricalIdentityEvents -BetaId $Id -BetaFrom $From -BetaEventTypes $EventTypes -BetaAccessItemTypes $AccessItemTypes -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentityEvents" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshots/{date} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Date = "2007-03-01T13:00:00Z" # String | The specified date + + # Gets an identity snapshot at a given date + + try { + Get-BetaIdentitySnapshot-BetaId $Id -BetaDate $Date + + # Below is a request that includes all optional parameters + # Get-BetaIdentitySnapshot -BetaId $Id -BetaDate $Date + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshot" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshot-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Before = "2007-03-01T13:00:00Z" # String | The date before which snapshot summary is required (optional) + $Interval = "day" # String | The interval indicating day or month. Defaults to month if not specified (optional) + $TimeZone = "UTC" # String | The time zone. Defaults to UTC if not provided (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Gets the summary for the event count for a specific identity + + try { + Get-BetaIdentitySnapshotSummary-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentitySnapshotSummary -BetaId $Id -BetaBefore $Before -BetaInterval $Interval -BetaTimeZone $TimeZone -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshotSummary" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/start-date + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + + # Gets the start date of the identity + + try { + Get-BetaIdentityStartDate-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentityStartDate -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityStartDate" + Write-Host $_.ErrorDetails + } +- path: /historical-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $StartsWithQuery = "Ada" # String | This param is used for starts-with search for first, last and display name of the identity (optional) + $IsDeleted = $true # Boolean | Indicates if we want to only list down deleted identities or not. (optional) + $IsActive = $true # Boolean | Indicates if we want to only list active or inactive identities. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # Lists all the identities + + try { + Get-BetaHistoricalIdentities + + # Below is a request that includes all optional parameters + # Get-BetaHistoricalIdentities -BetaStartsWithQuery $StartsWithQuery -BetaIsDeleted $IsDeleted -BetaIsActive $IsActive -BetaLimit $Limit -BetaOffset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentities" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Type = "account" # String | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) + $Filters = "source eq "DataScienceDataset"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** (optional) + $Query = "Dr. Arden" # String | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Access Items by Identity + + try { + Get-BetaIdentityAccessItems-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentityAccessItems -BetaId $Id -BetaType $Type -BetaFilters $Filters -BetaSorters $Sorters -BetaQuery $Query -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAccessItems" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshots/{date}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Identity ID. + $Date = "2007-03-01T13:00:00Z" # String | Specified date. + $Type = "role" # String | Access item type. (optional) + + # Get Identity Access Items Snapshot + + try { + Get-BetaIdentitySnapshotAccessItems-BetaId $Id -BetaDate $Date + + # Below is a request that includes all optional parameters + # Get-BetaIdentitySnapshotAccessItems -BetaId $Id -BetaDate $Date -BetaType $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshotAccessItems" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshots + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Start = "2007-03-01T13:00:00Z" # String | The specified start date (optional) + $Interval = "day" # String | The interval indicating the range in day or month for the specified interval-name (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Lists all the snapshots for the identity + + try { + Get-BetaIdentitySnapshots-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentitySnapshots -BetaId $Id -BetaStart $Start -BetaInterval $Interval -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshots" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfile = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2023-01-03T21:16:22.432Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "id" : "id12345" + } + "@ + + # Create an Identity Profile + + try { + $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile + New-BetaIdentityProfile-BetaIdentityProfile $Result + + # Below is a request that includes all optional parameters + # New-BetaIdentityProfile -BetaIdentityProfile $IdentityProfile + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. + + # Delete an Identity Profile + + try { + Remove-BetaIdentityProfile-BetaIdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Remove-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body. + $RequestBody = @""@ + + + # Delete Identity Profiles + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-BetaIdentityProfiles-BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-BetaIdentityProfiles -BetaRequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq 8c190e6787aa4ed9a90bd9d5344523fb" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) + $Sorters = "name,-priority" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) + + # Export Identity Profiles + + try { + Export-BetaIdentityProfiles + + # Below is a request that includes all optional parameters + # Export-BetaIdentityProfiles -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaIdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + + # Default identity attribute config + + try { + Get-BetaDefaultIdentityAttributeConfig-BetaIdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-BetaDefaultIdentityAttributeConfig -BetaIdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultIdentityAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + + # Gets a single Identity Profile + + try { + Get-BetaIdentityProfile-BetaIdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + + + + + $IdentityProfileExportedObject = @"{ + "self" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "version" : 1, + "object" : { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + } + }"@ + + + # Import Identity Profiles + + try { + $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject + Import-BetaIdentityProfiles-BetaIdentityProfileExportedObject $Result + + # Below is a request that includes all optional parameters + # Import-BetaIdentityProfiles -BetaIdentityProfileExportedObject $IdentityProfileExportedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaIdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq 8c190e6787aa4ed9a90bd9d5344523fb" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional) + $Sorters = "name,-priority" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) + + # Identity Profiles List + + try { + Get-BetaIdentityProfiles + + # Below is a request that includes all optional parameters + # Get-BetaIdentityProfiles -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/identity-preview + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityPreviewRequest = @" + { + "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + } + } + "@ + + # Generate Identity Profile Preview + + try { + $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest + Show-BetaGenerateIdentityPreview-BetaIdentityPreviewRequest $Result + + # Below is a request that includes all optional parameters + # Show-BetaGenerateIdentityPreview -BetaIdentityPreviewRequest $IdentityPreviewRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-BetaGenerateIdentityPreview" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/process-identities + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed + + # Process identities under profile + + try { + Sync-BetaIdentityProfile-BetaIdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Sync-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetaIdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update the Identity Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaIdentityProfile-BetaIdentityProfileId $IdentityProfileId -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaIdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /launchers + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $LauncherRequest = @" + { + "reference" : { + "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", + "type" : "WORKFLOW" + }, + "name" : "Group Create", + "description" : "Create a new Active Directory Group", + "disabled" : false, + "type" : "INTERACTIVE_PROCESS", + "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" + } + "@ + + # Create launcher + + try { + $Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest + New-BetaLauncher-BetaLauncherRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaLauncher -BetaLauncherRequest $LauncherRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaLauncher" + Write-Host $_.ErrorDetails + } +- path: /launchers/{launcherID} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be deleted + + # Delete Launcher + + try { + Remove-BetaLauncher-BetaLauncherID $LauncherID + + # Below is a request that includes all optional parameters + # Remove-BetaLauncher -BetaLauncherID $LauncherID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaLauncher" + Write-Host $_.ErrorDetails + } +- path: /launchers/{launcherID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be retrieved + + # Get Launcher by ID + + try { + Get-BetaLauncher-BetaLauncherID $LauncherID + + # Below is a request that includes all optional parameters + # Get-BetaLauncher -BetaLauncherID $LauncherID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLauncher" + Write-Host $_.ErrorDetails + } +- path: /launchers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "disabled eq "true"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional) + $Next = "eyJuZXh0IjoxMjN9Cg==" # String | Pagination marker (optional) + $Limit = 42 # Int32 | Number of Launchers to return (optional) (default to 10) + + # List all Launchers for tenant + + try { + Get-BetaLaunchers + + # Below is a request that includes all optional parameters + # Get-BetaLaunchers -BetaFilters $Filters -BetaNext $Next -BetaLimit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLaunchers" + Write-Host $_.ErrorDetails + } +- path: /launchers/{launcherID} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be replaced + $LauncherRequest = @" + { + "reference" : { + "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", + "type" : "WORKFLOW" + }, + "name" : "Group Create", + "description" : "Create a new Active Directory Group", + "disabled" : false, + "type" : "INTERACTIVE_PROCESS", + "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" + } + "@ + + # Replace Launcher + + try { + $Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest + Send-BetaLauncher-BetaLauncherID $LauncherID -BetaLauncherRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaLauncher -BetaLauncherID $LauncherID -BetaLauncherRequest $LauncherRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaLauncher" + Write-Host $_.ErrorDetails + } +- path: /beta/launchers/{launcherID}/launch + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be launched + + # Launch a Launcher + + try { + Start-BetaLauncher-BetaLauncherID $LauncherID + + # Below is a request that includes all optional parameters + # Start-BetaLauncher -BetaLauncherID $LauncherID + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaLauncher" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity Profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle State ID. + + # Get Lifecycle State + + try { + Get-BetaLifecycleStates-BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Get-BetaLifecycleStates -BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLifecycleStates" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity Profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle State ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Lifecycle State + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaLifecycleStates-BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaLifecycleStates -BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaLifecycleStates" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "aClientId" # String | ID of the Managed Client Status to get + $Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get + + # Specified Managed Client Status. + + try { + Get-BetaManagedClientStatus-BetaId $Id -BetaType $Type + + # Below is a request that includes all optional parameters + # Get-BetaManagedClientStatus -BetaId $Id -BetaType $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id}/status + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "aClientId" # String | ID of the Managed Client Status to update + $ManagedClientStatus = @" + { + "body" : { + "alertKey" : "", + "id" : "5678", + "clusterId" : "1234", + "ccg_etag" : "ccg_etag123xyz456", + "ccg_pin" : "NONE", + "cookbook_etag" : "20210420125956-20210511144538", + "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", + "internal_ip" : "127.0.0.1", + "lastSeen" : "1620843964604", + "sinceSeen" : "14708", + "sinceSeenMillis" : "14708", + "localDev" : false, + "stacktrace" : "", + "status" : "NORMAL", + "product" : "idn", + "platform_version" : "2", + "os_version" : "2345.3.1", + "os_type" : "flatcar", + "hypervisor" : "unknown" + }, + "type" : "CCG", + "status" : "NORMAL", + "timestamp" : "2020-01-01T00:00:00Z" + } + "@ + + # Handle status request from client + + try { + $Result = ConvertFrom-JsonToManagedClientStatus -Json $ManagedClientStatus + Update-BetaManagedClientStatus-BetaId $Id -BetaManagedClientStatus $Result + + # Below is a request that includes all optional parameters + # Update-BetaManagedClientStatus -BetaId $Id -BetaManagedClientStatus $ManagedClientStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "aClusterId" # String | ID of ManagedCluster to get log configuration for + + # Get managed cluster's log configuration + + try { + Get-BetaClientLogConfiguration-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaClientLogConfiguration -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "aClusterId" # String | ID of the ManagedCluster to get + + # Get a specified ManagedCluster. + + try { + Get-BetaManagedCluster-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaManagedCluster -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "operational eq operation" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + + # Retrieve all Managed Clusters. + + try { + Get-BetaManagedClusters + + # Below is a request that includes all optional parameters + # Get-BetaManagedClusters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClusters" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "aClusterId" # String | ID of ManagedCluster to update log configuration for + $ClientLogConfiguration = @" + { + "durationMinutes" : 120, + "rootLevel" : "INFO", + "clientId" : "aClientId", + "expiration" : "2020-12-15T19:13:36.079Z", + "logLevels" : "INFO" + } + "@ + + # Update managed cluster's log configuration + + try { + Send-BetaClientLogConfiguration-BetaId $Id -BetaClientLogConfiguration $Result + + # Below is a request that includes all optional parameters + # Send-BetaClientLogConfiguration -BetaId $Id -BetaClientLogConfiguration $ClientLogConfiguration + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/delete + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + # Delete MFA method configuration + + try { + Remove-BetaMFAConfig-BetaMethod $Method + + # Below is a request that includes all optional parameters + # Remove-BetaMFAConfig -BetaMethod $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaMFAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Configuration of Duo MFA method + + try { + Get-BetaMFADuoConfig + + # Below is a request that includes all optional parameters + # Get-BetaMFADuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + # Configuration of KBA MFA method + + try { + Get-BetaMFAKbaConfig + + # Below is a request that includes all optional parameters + # Get-BetaMFAKbaConfig -BetaAllLanguages $AllLanguages + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFAKbaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Configuration of Okta MFA method + + try { + Get-BetaMFAOktaConfig + + # Below is a request that includes all optional parameters + # Get-BetaMFAOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MfaDuoConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Duo MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-BetaMFADuoConfig-BetaMfaDuoConfig $Result + + # Below is a request that includes all optional parameters + # Set-BetaMFADuoConfig -BetaMfaDuoConfig $MfaDuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ + + + # Set MFA KBA configuration + + try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-BetaMFAKBAConfig-BetaKbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Set-BetaMFAKBAConfig -BetaKbaAnswerRequestItem $KbaAnswerRequestItem + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFAKBAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MfaOktaConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Okta MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-BetaMFAOktaConfig-BetaMfaOktaConfig $Result + + # Below is a request that includes all optional parameters + # Set-BetaMFAOktaConfig -BetaMfaOktaConfig $MfaOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + # MFA method's test configuration + + try { + Test-BetaMFAConfig-BetaMethod $Method + + # Below is a request that includes all optional parameters + # Test-BetaMFAConfig -BetaMethod $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaMFAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/token/send + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SendTokenRequest = @" + { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK" + } + "@ + + # Create and send user token + + try { + $Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest + New-BetaSendToken-BetaSendTokenRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaSendToken -BetaSendTokenRequest $SendTokenRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSendToken" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/poll + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' + $VerificationPollRequest = @" + { + "requestId" : "089899f13a8f4da7824996191587bab9" + } + "@ + + # Polling MFA method by VerificationPollRequest + + try { + $Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest + Ping-BetaVerificationStatus-BetaMethod $Method -BetaVerificationPollRequest $Result + + # Below is a request that includes all optional parameters + # Ping-BetaVerificationStatus -BetaMethod $Method -BetaVerificationPollRequest $VerificationPollRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-BetaVerificationStatus" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/verify + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $DuoVerificationRequest = @" + { + "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", + "userId" : "2c9180947f0ef465017f215cbcfd004b" + } + "@ + + # Verifying authentication via Duo method + + try { + $Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest + Send-BetaDuoVerifyRequest-BetaDuoVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaDuoVerifyRequest -BetaDuoVerificationRequest $DuoVerificationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaDuoVerifyRequest" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/authenticate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ + + + # Authenticate KBA provided MFA method + + try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Send-BetaKbaAnswers-BetaKbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Send-BetaKbaAnswers -BetaKbaAnswerRequestItem $KbaAnswerRequestItem + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaKbaAnswers" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/verify + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OktaVerificationRequest = @" + { + "userId" : "example@mail.com" + } + "@ + + # Verifying authentication via Okta method + + try { + $Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest + Send-BetaOktaVerifyRequest-BetaOktaVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaOktaVerifyRequest -BetaOktaVerificationRequest $OktaVerificationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaOktaVerifyRequest" + Write-Host $_.ErrorDetails + } +- path: /mfa/token/authenticate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TokenAuthRequest = @" + { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK", + "token" : "12345" + } + "@ + + # Authenticate Token provided MFA method + + try { + $Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest + Send-BetaTokenAuthRequest-BetaTokenAuthRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaTokenAuthRequest -BetaTokenAuthRequest $TokenAuthRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTokenAuthRequest" + Write-Host $_.ErrorDetails + } +- path: /multihosts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MultiHostIntegrationsCreate = @" + { + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "connector" : "multihost-microsoft-sql-server", + "connectorAttributes" : { + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "created" : "2022-02-08T14:50:03.827Z", + "name" : "My Multi-Host Integration", + "description" : "This is the Multi-Host Integration.", + "modified" : "2024-01-23T18:08:50.897Z" + } + "@ + + # Create Multi-Host Integration + + try { + $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate + New-BetaMultiHostIntegration-BetaMultiHostIntegrationsCreate $Result + + # Below is a request that includes all optional parameters + # New-BetaMultiHostIntegration -BetaMultiHostIntegrationsCreate $MultiHostIntegrationsCreate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaMultiHostIntegration" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. + $MultiHostIntegrationsCreateSources = @"{ + "connectorAttributes" : { + "authType" : "SQLAuthentication", + "url" : "jdbc:sqlserver://178.18.41.118:1433", + "user" : "username", + "driverClass" : "com.microsoft.sqlserver.jdbc.SQLServerDriver", + "maxSourcesPerAggGroup" : 10, + "maxAllowedSources" : 300 + }, + "name" : "My Source", + "description" : "This is the corporate directory." + }"@ + + + # Create Sources Within Multi-Host Integration + + try { + $Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources + New-BetaSourcesWithinMultiHost-BetaId $Id -BetaMultiHostIntegrationsCreateSources $Result + + # Below is a request that includes all optional parameters + # New-BetaSourcesWithinMultiHost -BetaId $Id -BetaMultiHostIntegrationsCreateSources $MultiHostIntegrationsCreateSources + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourcesWithinMultiHost" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete. + + # Delete Multi-Host Integration + + try { + Remove-BetaMultiHost-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaMultiHost -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaMultiHost" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihostId}/acctAggregationGroups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update + + # Get Account Aggregation Groups Within Multi-Host Integration ID + + try { + Get-BetaAcctAggregationGroups-BetaMultiHostId $MultiHostId + + # Below is a request that includes all optional parameters + # Get-BetaAcctAggregationGroups -BetaMultiHostId $MultiHostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAcctAggregationGroups" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multiHostId}/entitlementAggregationGroups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update + + # Get Entitlement Aggregation Groups Within Multi-Host Integration ID + + try { + Get-BetaEntitlementAggregationGroups-BetaMultiHostId $MultiHostId + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementAggregationGroups -BetaMultiHostId $MultiHostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementAggregationGroups" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. + + # Get Multi-Host Integration By ID + + try { + Get-BetaMultiHostIntegrations-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaMultiHostIntegrations -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostIntegrations" + Write-Host $_.ErrorDetails + } +- path: /multihosts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *in* **forSubAdminId**: *in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + + # List All Existing Multi-Host Integrations + + try { + Get-BetaMultiHostIntegrationsList + + # Below is a request that includes all optional parameters + # Get-BetaMultiHostIntegrationsList -BetaOffset $Offset -BetaLimit $Limit -BetaSorters $Sorters -BetaFilters $Filters -BetaCount $Count -BetaForSubadmin $ForSubadmin + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostIntegrationsList" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multiHostId}/sources/errors + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration + + # List Multi-Host Source Creation Errors + + try { + Get-BetaMultiHostSourceCreationErrors-BetaMultiHostId $MultiHostId + + # Below is a request that includes all optional parameters + # Get-BetaMultiHostSourceCreationErrors -BetaMultiHostId $MultiHostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostSourceCreationErrors" + Write-Host $_.ErrorDetails + } +- path: /multihosts/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Multi-Host Integration Types + + try { + Get-BetaMultihostIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-BetaMultihostIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultihostIntegrationTypes" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{id}/sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Sources Within Multi-Host Integration + + try { + Get-BetaSourcesWithinMultiHost + + # Below is a request that includes all optional parameters + # Get-BetaSourcesWithinMultiHost -BetaOffset $Offset -BetaLimit $Limit -BetaSorters $Sorters -BetaFilters $Filters -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourcesWithinMultiHost" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihost_id}/sources/testConnection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration + + # Test Configuration For Multi-Host Integration + + try { + Test-BetaConnectionMultiHostSources-BetaMultihostId $MultihostId + + # Below is a request that includes all optional parameters + # Test-BetaConnectionMultiHostSources -BetaMultihostId $MultihostId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaConnectionMultiHostSources" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{multihost_id}/sources/{sourceId}/testConnection + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration + $SourceId = "2c91808568c529f60168cca6f90c1324" # String | ID of the source within the Multi-Host Integration + + # Test Configuration For Multi-Host Integration's Single Source + + try { + Test-BetaSourceConnectionMultihost-BetaMultihostId $MultihostId -BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Test-BetaSourceConnectionMultihost -BetaMultihostId $MultihostId -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConnectionMultihost" + Write-Host $_.ErrorDetails + } +- path: /multihosts/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MultihostId = "anId" # String | ID of the Multi-Host Integration to update. + $UpdateMultiHostSourcesRequestInner = @"[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]"@ + + + # Update Multi-Host Integration + + try { + $Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner + Update-BetaMultiHostSources-BetaMultihostId $MultihostId -BetaUpdateMultiHostSourcesRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaMultiHostSources -BetaMultihostId $MultihostId -BetaUpdateMultiHostSourcesRequestInner $UpdateMultiHostSourcesRequestInner + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaMultiHostSources" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "MyId" # String | Non-Employee approval item id (UUID) + $NonEmployeeApprovalDecision = @" + { + "comment" : "comment" + } + "@ + + # Approve a Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision + Approve-BetaNonEmployeeRequest-BetaId $Id -BetaNonEmployeeApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Approve-BetaNonEmployeeRequest -BetaId $Id -BetaNonEmployeeApprovalDecision $NonEmployeeApprovalDecision + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Create Non-Employee Record + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-BetaNonEmployeeRecord-BetaNonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-BetaNonEmployeeRecord -BetaNonEmployeeRequestBody $NonEmployeeRequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Create Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-BetaNonEmployeeRequest-BetaNonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-BetaNonEmployeeRequest -BetaNonEmployeeRequestBody $NonEmployeeRequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $NonEmployeeSourceRequestBody = @" + { + "owner" : { + "id" : "2c91808570313110017040b06f344ec9" + }, + "managementWorkgroup" : "123299", + "accountManagers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ], + "name" : "Retail", + "description" : "Source description", + "approvers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ] + } + "@ + + # Create Non-Employee Source + + try { + $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody + New-BetaNonEmployeeSource-BetaNonEmployeeSourceRequestBody $Result + + # Below is a request that includes all optional parameters + # New-BetaNonEmployeeSource -BetaNonEmployeeSourceRequestBody $NonEmployeeSourceRequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id + $NonEmployeeSchemaAttributeBody = @" + { + "helpText" : "The unique identifier for the account", + "label" : "Account Name", + "placeholder" : "Enter a unique user name for this account.", + "type" : "TEXT", + "technicalName" : "account.name", + "required" : true + } + "@ + + # Create Non-Employee Source Schema Attribute + + try { + $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody + New-BetaNonEmployeeSourceSchemaAttributes-BetaSourceId $SourceId -BetaNonEmployeeSchemaAttributeBody $Result + + # Below is a request that includes all optional parameters + # New-BetaNonEmployeeSourceSchemaAttributes -BetaSourceId $SourceId -BetaNonEmployeeSchemaAttributeBody $NonEmployeeSchemaAttributeBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID) + + # Delete Non-Employee Record + + try { + Remove-BetaNonEmployeeRecord-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeRecord -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $DeleteNonEmployeeRecordInBulkRequest = @" + + "@ + + # Delete Multiple Non-Employee Records + + try { + $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordInBulkRequest -Json $DeleteNonEmployeeRecordInBulkRequest + Remove-BetaNonEmployeeRecordInBulk-BetaDeleteNonEmployeeRecordInBulkRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeRecordInBulk -BetaDeleteNonEmployeeRecordInBulkRequest $DeleteNonEmployeeRecordInBulkRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRecordInBulk" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id in the UUID format + + # Delete Non-Employee Request + + try { + Remove-BetaNonEmployeeRequest-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeRequest -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AttributeId = "2c91808b6ef1d43e016efba0ce470904" # String | The Schema Attribute Id (UUID) + $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id + + # Delete Non-Employee Source's Schema Attribute + + try { + Remove-BetaNonEmployeeSchemaAttribute-BetaAttributeId $AttributeId -BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeSchemaAttribute -BetaAttributeId $AttributeId -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id + + # Delete Non-Employee Source + + try { + Remove-BetaNonEmployeeSource-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeSource -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id + + # Delete all custom schema attributes + + try { + Remove-BetaNonEmployeeSourceSchemaAttributes-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-BetaNonEmployeeSourceSchemaAttributes -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employees/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID) + + # Exports Non-Employee Records to CSV + + try { + Export-BetaNonEmployeeRecords-BetaId $Id + + # Below is a request that includes all optional parameters + # Export-BetaNonEmployeeRecords -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaNonEmployeeRecords" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/schema-attributes-template/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID) + + # Exports Source Schema Template + + try { + Export-BetaNonEmployeeSourceSchemaTemplate-BetaId $Id + + # Below is a request that includes all optional parameters + # Export-BetaNonEmployeeSourceSchemaTemplate -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaNonEmployeeSourceSchemaTemplate" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | Non-Employee approval item id (UUID) + $IncludeDetail = "include-detail=false" # String | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) + + # Get a non-employee approval item detail + + try { + Get-BetaNonEmployeeApproval-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeApproval -BetaId $Id -BetaIncludeDetail $IncludeDetail + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApproval" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/summary/{requested-for} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + + # Get Summary of Non-Employee Approval Requests + + try { + Get-BetaNonEmployeeApprovalSummary-BetaRequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeApprovalSummary -BetaRequestedFor $RequestedFor + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApprovalSummary" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c918085842e69ae018432d22ccb212f" # String | Source ID (UUID) + + # Bulk upload status on source + + try { + Get-BetaNonEmployeeBulkUploadStatus-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeBulkUploadStatus -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeBulkUploadStatus" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID) + + # Get a Non-Employee Record + + try { + Get-BetaNonEmployeeRecord-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRecord -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id (UUID) + + # Get a Non-Employee Request + + try { + Get-BetaNonEmployeeRequest-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRequest -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/summary/{requested-for} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + + # Get Summary of Non-Employee Requests + + try { + Get-BetaNonEmployeeRequestSummary-BetaRequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRequestSummary -BetaRequestedFor $RequestedFor + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequestSummary" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AttributeId = "2c918085842e69ae018432d22ccb212f" # String | The Schema Attribute Id (UUID) + $SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id + + # Get Schema Attribute Non-Employee Source + + try { + Get-BetaNonEmployeeSchemaAttribute-BetaAttributeId $AttributeId -BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeSchemaAttribute -BetaAttributeId $AttributeId -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id + + # Get a Non-Employee Source + + try { + Get-BetaNonEmployeeSource-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeSource -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id + + # List Schema Attributes Non-Employee Source + + try { + Get-BetaNonEmployeeSourceSchemaAttributes-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeSourceSchemaAttributes -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) + $Data = # System.IO.FileInfo | + + # Imports, or Updates, Non-Employee Records + + try { + Import-BetaNonEmployeeRecordsInBulk-BetaId $Id -BetaData $Data + + # Below is a request that includes all optional parameters + # Import-BetaNonEmployeeRecordsInBulk -BetaId $Id -BetaData $Data + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaNonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity for whom the request was made. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "approvalStatus eq "PENDING"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Get List of Non-Employee Approval Requests + + try { + Get-BetaNonEmployeeApproval + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeApproval -BetaRequestedFor $RequestedFor -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApproval" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "accountName,sourceId" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) + $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + + # List Non-Employee Records + + try { + Get-BetaNonEmployeeRecords + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRecords -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRecords" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "approvalStatus,firstName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) + $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + + # List Non-Employee Requests + + try { + Get-BetaNonEmployeeRequests-BetaRequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeRequests -BetaRequestedFor $RequestedFor -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequests" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. + $NonEmployeeCount = $false # Boolean | The flag to determine whether return a non-employee count associate with source. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) + + # List Non-Employee Sources + + try { + Get-BetaNonEmployeeSources-BetaRequestedFor $RequestedFor -BetaNonEmployeeCount $NonEmployeeCount + + # Below is a request that includes all optional parameters + # Get-BetaNonEmployeeSources -BetaRequestedFor $RequestedFor -BetaNonEmployeeCount $NonEmployeeCount -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSources" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-employee record id (UUID) + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Non-Employee Record + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaNonEmployeeRecord-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaNonEmployeeRecord -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AttributeId = "2c91808b6ef1d43e016efba0ce470904" # String | The Schema Attribute Id (UUID) + $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Non-Employee Source's Schema Attribute + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaNonEmployeeSchemaAttribute-BetaAttributeId $AttributeId -BetaSourceId $SourceId -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaNonEmployeeSchemaAttribute -BetaAttributeId $AttributeId -BetaSourceId $SourceId -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Non-Employee Source + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaNonEmployeeSource-BetaSourceId $SourceId -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaNonEmployeeSource -BetaSourceId $SourceId -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id}/reject + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "MyId" # String | Non-Employee approval item id (UUID) + $NonEmployeeRejectApprovalDecision = @" + { + "comment" : "comment" + } + "@ + + # Reject a Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision + Deny-BetaNonEmployeeRequest-BetaId $Id -BetaNonEmployeeRejectApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Deny-BetaNonEmployeeRequest -BetaId $Id -BetaNonEmployeeRejectApprovalDecision $NonEmployeeRejectApprovalDecision + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaNonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-employee record id (UUID) + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Update Non-Employee Record + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + Update-BetaNonEmployeeRecord-BetaId $Id -BetaNonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaNonEmployeeRecord -BetaId $Id -BetaNonEmployeeRequestBody $NonEmployeeRequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /verified-domains + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $DomainAddress = @" + { + "domain" : "sailpoint.com" + } + "@ + + # Verify domain address via DKIM + + try { + $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress + New-BetaDomainDkim-BetaDomainAddress $Result + + # Below is a request that includes all optional parameters + # New-BetaDomainDkim -BetaDomainAddress $DomainAddress + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDomainDkim" + Write-Host $_.ErrorDetails + } +- path: /notification-templates + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TemplateDto = @" + { + "slackTemplate" : "slackTemplate", + "footer" : "footer", + "teamsTemplate" : "teamsTemplate", + "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", + "created" : "2020-01-01T00:00:00Z", + "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", + "medium" : "EMAIL", + "locale" : "en", + "body" : "Please go to the task manager", + "name" : "Task Manager Subscription", + "replyTo" : "$__global.emailFromAddress", + "header" : "header", + "modified" : "2020-01-01T00:00:00Z", + "from" : "$__global.emailFromAddress", + "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", + "key" : "cloud_manual_work_item_summary" + } + "@ + + # Create Notification Template + + try { + $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto + New-BetaNotificationTemplate-BetaTemplateDto $Result + + # Below is a request that includes all optional parameters + # New-BetaNotificationTemplate -BetaTemplateDto $TemplateDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNotificationTemplate" + Write-Host $_.ErrorDetails + } +- path: /verified-from-addresses + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $EmailStatusDto = @" + { + "isVerifiedByDomain" : false, + "verificationStatus" : "PENDING", + "id" : "id", + "email" : "sender@example.com" + } + "@ + + # Create Verified From Address + + try { + $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto + New-BetaVerifiedFromAddress-BetaEmailStatusDto $Result + + # Below is a request that includes all optional parameters + # New-BetaVerifiedFromAddress -BetaEmailStatusDto $EmailStatusDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaVerifiedFromAddress" + Write-Host $_.ErrorDetails + } +- path: /notification-templates/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TemplateBulkDeleteDto = @"{ + "medium" : "EMAIL", + "locale" : "en", + "key" : "cloud_manual_work_item_summary" + }"@ + + + # Bulk Delete Notification Templates + + try { + $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto + Remove-BetaNotificationTemplatesInBulk-BetaTemplateBulkDeleteDto $Result + + # Below is a request that includes all optional parameters + # Remove-BetaNotificationTemplatesInBulk -BetaTemplateBulkDeleteDto $TemplateBulkDeleteDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNotificationTemplatesInBulk" + Write-Host $_.ErrorDetails + } +- path: /verified-from-addresses/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "MyId" # String | + + # Delete Verified From Address + + try { + Remove-BetaVerifiedFromAddress-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaVerifiedFromAddress -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaVerifiedFromAddress" + Write-Host $_.ErrorDetails + } +- path: /verified-domains + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get DKIM Attributes + + try { + Get-BetaDkimAttributes + + # Below is a request that includes all optional parameters + # Get-BetaDkimAttributes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDkimAttributes" + Write-Host $_.ErrorDetails + } +- path: /mail-from-attributes/{identity} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status + + # Get MAIL FROM Attributes + + try { + Get-BetaMailFromAttributes-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaMailFromAttributes -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMailFromAttributes" + Write-Host $_.ErrorDetails + } +- path: /notification-templates/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template + + # Get Notification Template By Id + + try { + Get-BetaNotificationTemplate-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaNotificationTemplate -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplate" + Write-Host $_.ErrorDetails + } +- path: /notification-template-context + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Notification Template Context + + try { + Get-BetaNotificationsTemplateContext + + # Below is a request that includes all optional parameters + # Get-BetaNotificationsTemplateContext + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationsTemplateContext" + Write-Host $_.ErrorDetails + } +- path: /verified-from-addresses + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "email eq "john.doe@company.com"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* (optional) + $Sorters = "email" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) + + # List From Addresses + + try { + Get-BetaFromAddresses + + # Below is a request that includes all optional parameters + # Get-BetaFromAddresses -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFromAddresses" + Write-Host $_.ErrorDetails + } +- path: /notification-preferences/{key} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Notification Preferences for tenant. + + try { + Get-BetaNotificationPreferences + + # Below is a request that includes all optional parameters + # Get-BetaNotificationPreferences + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationPreferences" + Write-Host $_.ErrorDetails + } +- path: /notification-template-defaults + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "key eq "cloud_manual_work_item_summary"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + # List Notification Template Defaults + + try { + Get-BetaNotificationTemplateDefaults + + # Below is a request that includes all optional parameters + # Get-BetaNotificationTemplateDefaults -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplateDefaults" + Write-Host $_.ErrorDetails + } +- path: /notification-templates + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "medium eq "EMAIL"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + # List Notification Templates + + try { + Get-BetaNotificationTemplates + + # Below is a request that includes all optional parameters + # Get-BetaNotificationTemplates -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplates" + Write-Host $_.ErrorDetails + } +- path: /mail-from-attributes + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MailFromAttributesDto = @" + { + "identity" : "BobSmith@sailpoint.com", + "mailFromDomain" : "example.sailpoint.com" + } + "@ + + # Change MAIL FROM domain + + try { + $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto + Send-BetaMailFromAttributes-BetaMailFromAttributesDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaMailFromAttributes -BetaMailFromAttributesDto $MailFromAttributesDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaMailFromAttributes" + Write-Host $_.ErrorDetails + } +- path: /send-test-notification + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SendTestNotificationRequestDto = @" + { + "context" : "{}", + "medium" : "EMAIL", + "key" : "cloud_manual_work_item_summary" + } + "@ + + # Send Test Notification + + try { + $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto + Send-BetaTestNotification-BetaSendTestNotificationRequestDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaTestNotification -BetaSendTestNotificationRequestDto $SendTestNotificationRequestDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTestNotification" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreateOAuthClientRequest = @" + { + "internal" : false, + "businessName" : "Acme-Solar", + "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", + "refreshTokenValiditySeconds" : 86400, + "type" : "CONFIDENTIAL", + "redirectUris" : [ "http://localhost:12345", "http://localhost:67890" ], + "enabled" : true, + "accessType" : "OFFLINE", + "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], + "strongAuthSupported" : false, + "homepageUrl" : "http://localhost:12345", + "accessTokenValiditySeconds" : 750, + "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], + "name" : "Demo API Client", + "claimsSupported" : false + } + "@ + + # Create OAuth Client + + try { + $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest + New-BetaOauthClient-BetaCreateOAuthClientRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaOauthClient -BetaCreateOAuthClientRequest $CreateOAuthClientRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaOauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + + # Delete OAuth Client + + try { + Remove-BetaOauthClient-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaOauthClient -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaOauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + + # Get OAuth Client + + try { + Get-BetaOauthClient-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaOauthClient -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + + # List OAuth Clients + + try { + Get-BetaOauthClients + + # Below is a request that includes all optional parameters + # Get-BetaOauthClients -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOauthClients" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch OAuth Client + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaOauthClient-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaOauthClient -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaOauthClient" + Write-Host $_.ErrorDetails + } +- path: /org-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Org configuration settings + + try { + Get-BetaOrgConfig + + # Below is a request that includes all optional parameters + # Get-BetaOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /org-config/valid-time-zones + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get list of time zones + + try { + Get-BetaValidTimeZones + + # Below is a request that includes all optional parameters + # Get-BetaValidTimeZones + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaValidTimeZones" + Write-Host $_.ErrorDetails + } +- path: /org-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch an Org configuration property + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaOrgConfig-BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaOrgConfig -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Create Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + New-BetaPasswordOrgConfig-BetaPasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # New-BetaPasswordOrgConfig -BetaPasswordOrgConfig $PasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Password Org Config + + try { + Get-BetaPasswordOrgConfig + + # Below is a request that includes all optional parameters + # Get-BetaPasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Update Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + Send-BetaPasswordOrgConfig-BetaPasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaPasswordOrgConfig -BetaPasswordOrgConfig $PasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-dictionary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Password Dictionary + + try { + Get-BetaPasswordDictionary + + # Below is a request that includes all optional parameters + # Get-BetaPasswordDictionary + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordDictionary" + Write-Host $_.ErrorDetails + } +- path: /password-dictionary + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $File = # System.IO.FileInfo | (optional) + + # Update Password Dictionary + + try { + Send-BetaPasswordDictionary + + # Below is a request that includes all optional parameters + # Send-BetaPasswordDictionary -BetaFile $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPasswordDictionary" + Write-Host $_.ErrorDetails + } +- path: /generate-password-reset-token/digit + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordDigitTokenReset = @" + { + "durationMinutes" : 5, + "length" : 8, + "userId" : "Abby.Smith" + } + "@ + + # Generate a digit token + + try { + $Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset + New-BetaDigitToken-BetaPasswordDigitTokenReset $Result + + # Below is a request that includes all optional parameters + # New-BetaDigitToken -BetaPasswordDigitTokenReset $PasswordDigitTokenReset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDigitToken" + Write-Host $_.ErrorDetails + } +- path: /password-change-status/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "MyId" # String | + + # Get Password Change Request Status + + try { + Get-BetaIdentityPasswordChangeStatus-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaIdentityPasswordChangeStatus -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityPasswordChangeStatus" + Write-Host $_.ErrorDetails + } +- path: /query-password-info + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordInfoQueryDTO = @" + { + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + } + "@ + + # Query Password Info + + try { + $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO + Search-BetaPasswordInfo-BetaPasswordInfoQueryDTO $Result + + # Below is a request that includes all optional parameters + # Search-BetaPasswordInfo -BetaPasswordInfoQueryDTO $PasswordInfoQueryDTO + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaPasswordInfo" + Write-Host $_.ErrorDetails + } +- path: /set-password + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordChangeRequest = @" + { + "sourceId" : "8a807d4c73c545510173c545d4b60246", + "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "identityId" : "8a807d4c73c545510173c545f0a002ff", + "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" + } + "@ + + # Set Identity's Password + + try { + $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest + Set-BetaIdentityPassword-BetaPasswordChangeRequest $Result + + # Below is a request that includes all optional parameters + # Set-BetaIdentityPassword -BetaPasswordChangeRequest $PasswordChangeRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaIdentityPassword" + Write-Host $_.ErrorDetails + } +- path: /password-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordPolicyV3Dto = @" + { + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + } + "@ + + # Create Password Policy + + try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + New-BetaPasswordPolicy-BetaPasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # New-BetaPasswordPolicy -BetaPasswordPolicyV3Dto $PasswordPolicyV3Dto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. + + # Delete Password Policy by ID + + try { + Remove-BetaPasswordPolicy-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaPasswordPolicy -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. + + # Get Password Policy by ID + + try { + Get-BetaPasswordPolicyById-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaPasswordPolicyById -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordPolicyById" + Write-Host $_.ErrorDetails + } +- path: /password-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Password Policies + + try { + Get-BetaPasswordPolicies + + # Below is a request that includes all optional parameters + # Get-BetaPasswordPolicies -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordPolicies" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update. + $PasswordPolicyV3Dto = @" + { + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + } + "@ + + # Update Password Policy by ID + + try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + Set-BetaPasswordPolicy-BetaId $Id -BetaPasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # Set-BetaPasswordPolicy -BetaId $Id -BetaPasswordPolicyV3Dto $PasswordPolicyV3Dto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaPasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordSyncGroup = @" + { + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } + "@ + + # Create Password Sync Group + + try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + New-BetaPasswordSyncGroup-BetaPasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # New-BetaPasswordSyncGroup -BetaPasswordSyncGroup $PasswordSyncGroup + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. + + # Delete Password Sync Group by ID + + try { + Remove-BetaPasswordSyncGroup-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaPasswordSyncGroup -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. + + # Get Password Sync Group by ID + + try { + Get-BetaPasswordSyncGroup-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaPasswordSyncGroup -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Get Password Sync Group List + + try { + Get-BetaPasswordSyncGroups + + # Below is a request that includes all optional parameters + # Get-BetaPasswordSyncGroups -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroups" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to update. + $PasswordSyncGroup = @" + { + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } + "@ + + # Update Password Sync Group by ID + + try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + Update-BetaPasswordSyncGroup-BetaId $Id -BetaPasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # Update-BetaPasswordSyncGroup -BetaId $Id -BetaPasswordSyncGroup $PasswordSyncGroup + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreatePersonalAccessTokenRequest = @" + { + "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], + "accessTokenValiditySeconds" : 36900, + "name" : "NodeJS Integration" + } + "@ + + # Create Personal Access Token + + try { + $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest + New-BetaPersonalAccessToken-BetaCreatePersonalAccessTokenRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaPersonalAccessToken -BetaCreatePersonalAccessTokenRequest $CreatePersonalAccessTokenRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id + + # Delete Personal Access Token + + try { + Remove-BetaPersonalAccessToken-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaPersonalAccessToken -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "2c9180867b50d088017b554662fb281e" # String | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) + $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + + # List Personal Access Tokens + + try { + Get-BetaPersonalAccessTokens + + # Below is a request that includes all optional parameters + # Get-BetaPersonalAccessTokens -BetaOwnerId $OwnerId -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPersonalAccessTokens" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Personal Access Token + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaPersonalAccessToken-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaPersonalAccessToken -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /public-identities-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Public Identity Config + + try { + Get-BetaPublicIdentityConfig + + # Below is a request that includes all optional parameters + # Get-BetaPublicIdentityConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPublicIdentityConfig" + Write-Host $_.ErrorDetails + } +- path: /public-identities-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PublicIdentityConfig = @" + { + "modified" : "2018-06-25T20:22:28.104Z", + "attributes" : [ { + "name" : "Country", + "key" : "country" + }, { + "name" : "Country", + "key" : "country" + } ], + "modifiedBy" : { + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + } + "@ + + # Update Public Identity Config + + try { + $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig + Update-BetaPublicIdentityConfig-BetaPublicIdentityConfig $Result + + # Below is a request that includes all optional parameters + # Update-BetaPublicIdentityConfig -BetaPublicIdentityConfig $PublicIdentityConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPublicIdentityConfig" + Write-Host $_.ErrorDetails + } +- path: /requestable-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) + $Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. (optional) + + $Types = @"ROLE,ACCESS_PROFILE"@ + $Term = "Finance Role" # String | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) + $Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional) + + $Statuses = @"[ASSIGNED, PENDING]"@ + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw "bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Requestable Objects List + + try { + Get-BetaRequestableObjects + + # Below is a request that includes all optional parameters + # Get-BetaRequestableObjects -BetaIdentityId $IdentityId -BetaTypes $Types -BetaTerm $Term -BetaStatuses $Statuses -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRequestableObjects" + Write-Host $_.ErrorDetails + } +- path: /role-insights/requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Generate insights for roles + + try { + New-BetaRoleInsightRequests + + # Below is a request that includes all optional parameters + # New-BetaRoleInsightRequests + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRoleInsightRequests" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/entitlement-changes/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $Sorters = "identitiesWithAccess" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) + $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + + # Download entitlement insights for a role + + try { + Invoke-BetaDownloadRoleInsightsEntitlementsChanges-BetaInsightId $InsightId + + # Below is a request that includes all optional parameters + # Invoke-BetaDownloadRoleInsightsEntitlementsChanges -BetaInsightId $InsightId -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaDownloadRoleInsightsEntitlementsChanges" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/entitlement-changes/{entitlementId}/identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $EntitlementId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The entitlement id + $HasEntitlement = $true # Boolean | Identity has this entitlement or not (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "name sw "Jan"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) + + # Get identities for a suggested entitlement (for a role) + + try { + Get-BetaEntitlementChangesIdentities-BetaInsightId $InsightId -BetaEntitlementId $EntitlementId + + # Below is a request that includes all optional parameters + # Get-BetaEntitlementChangesIdentities -BetaInsightId $InsightId -BetaEntitlementId $EntitlementId -BetaHasEntitlement $HasEntitlement -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementChangesIdentities" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + + # Get a single role insight + + try { + Get-BetaRoleInsight-BetaInsightId $InsightId + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsight -BetaInsightId $InsightId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsight" + Write-Host $_.ErrorDetails + } +- path: /role-insights + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "numberOfUpdates" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) + $Filters = "name sw "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) + + # Get role insights + + try { + Get-BetaRoleInsights + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsights -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsights" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/current-entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + + # Get current entitlement for a role + + try { + Get-BetaRoleInsightsCurrentEntitlements-BetaInsightId $InsightId + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsightsCurrentEntitlements -BetaInsightId $InsightId -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsCurrentEntitlements" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/entitlement-changes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) + $Filters = "name sw "Admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + + # Get entitlement insights for a role + + try { + Get-BetaRoleInsightsEntitlementsChanges-BetaInsightId $InsightId + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsightsEntitlementsChanges -BetaInsightId $InsightId -BetaSorters $Sorters -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsEntitlementsChanges" + Write-Host $_.ErrorDetails + } +- path: /role-insights/requests/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insights request id + + # Returns metadata from prior request. + + try { + Get-BetaRoleInsightsRequests-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsightsRequests -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsRequests" + Write-Host $_.ErrorDetails + } +- path: /role-insights/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get role insights summary information + + try { + Get-BetaRoleInsightsSummary + + # Below is a request that includes all optional parameters + # Get-BetaRoleInsightsSummary + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsSummary" + Write-Host $_.ErrorDetails + } +- path: /roles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Role = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "dimensional" : false, + "created" : "2021-03-01T22:32:58.104Z", + "dimensionRefs" : [ { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + }, { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + } ], + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "membership" : { + "identities" : [ { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } ], + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, + "type" : "IDENTITY_LIST" + }, + "enabled" : true, + "revocationRequestConfig" : { + "commentsRequired" : false, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : false + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "legacyMembershipInfo" : { + "type" : "IDENTITY_LIST" + }, + "accessRequestConfig" : { + "commentsRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "name" : "Role 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "accessModelMetadata" : { + "attributes" : [ { + "key" : "iscPrivacy", + "name" : "Privacy", + "multiselect" : false, + "status" : "active", + "type" : "governance", + "objectTypes" : [ "all" ], + "description" : "Specifies the level of privacy associated with an access item.", + "values" : [ { + "value" : "public", + "name" : "Public", + "status" : "active" + } ] + } ] + }, + "id" : "2c918086749d78830174a1a40e121518", + "requestable" : true + } + "@ + + # Create a Role + + try { + $Result = ConvertFrom-JsonToRole -Json $Role + New-BetaRole-BetaRole $Result + + # Below is a request that includes all optional parameters + # New-BetaRole -BetaRole $Role + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRole" + Write-Host $_.ErrorDetails + } +- path: /roles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleBulkDeleteRequest = @" + { + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } + "@ + + # Delete Role(s) + + try { + $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest + Remove-BetaBulkRoles-BetaRoleBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BetaBulkRoles -BetaRoleBulkDeleteRequest $RoleBulkDeleteRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaBulkRoles" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + + # Delete a Role + + try { + Remove-BetaRole-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaRole -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaRole" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + + # Get a Role + + try { + Get-BetaRole-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaRole -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRole" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/assigned-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role for which the assigned Identities are to be listed + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw Joe" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) + $Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) + + # Identities assigned a Role + + try { + Get-BetaRoleAssignedIdentities-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaRoleAssignedIdentities -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignedIdentities" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the containing role + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + + # List role's Entitlements + + try { + Get-BetaRoleEntitlements-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaRoleEntitlements -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleEntitlements" + Write-Host $_.ErrorDetails + } +- path: /roles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + + # List Roles + + try { + Get-BetaRoles + + # Below is a request that includes all optional parameters + # Get-BetaRoles -BetaForSubadmin $ForSubadmin -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -BetaForSegmentIds $ForSegmentIds -BetaIncludeUnsegmented $IncludeUnsegmented + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoles" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Role + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaRole-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaRole -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRole" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SearchAttributeConfig = @" + { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } + "@ + + # Create Extended Search Attributes + + try { + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-BetaSearchAttributeConfig-BetaSearchAttributeConfig $Result + + # Below is a request that includes all optional parameters + # New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $SearchAttributeConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. + + # Delete Extended Search Attribute + + try { + Remove-BetaSearchAttributeConfig-BetaName $Name + + # Below is a request that includes all optional parameters + # Remove-BetaSearchAttributeConfig -BetaName $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Extended Search Attributes + + try { + Get-BetaSearchAttributeConfig + + # Below is a request that includes all optional parameters + # Get-BetaSearchAttributeConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. + + # Get Extended Search Attribute + + try { + Get-BetaSingleSearchAttributeConfig-BetaName $Name + + # Below is a request that includes all optional parameters + # Get-BetaSingleSearchAttributeConfig -BetaName $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "promotedMailAttribute" # String | Name of the extended search attribute configuration to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Extended Search Attribute + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaSearchAttributeConfig-BetaName $Name -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaSearchAttributeConfig -BetaName $Name -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /segments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Segment = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + } + "@ + + # Create Segment + + try { + $Result = ConvertFrom-JsonToSegment -Json $Segment + New-BetaSegment-BetaSegment $Result + + # Below is a request that includes all optional parameters + # New-BetaSegment -BetaSegment $Segment + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + + # Delete Segment by ID + + try { + Remove-BetaSegment-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSegment -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + + # Get Segment by ID + + try { + Get-BetaSegment-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSegment -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /segments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Segments + + try { + Get-BetaSegments + + # Below is a request that includes all optional parameters + # Get-BetaSegments -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. + $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ + + + # Update Segment + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaSegment-BetaId $Id -BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaSegment -BetaId $Id -BetaRequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } + "@ + + # Create new Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-BetaServiceDeskIntegration-BetaServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $ServiceDeskIntegrationDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "anId" # String | ID of Service Desk integration to delete + + # Delete a Service Desk integration + + try { + Remove-BetaServiceDeskIntegration-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaServiceDeskIntegration -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "anId" # String | ID of the Service Desk integration to get + + # Get a Service Desk integration + + try { + Get-BetaServiceDeskIntegration-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegration -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List existing Service Desk integrations + + try { + Get-BetaServiceDeskIntegrationList + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationList -BetaOffset $Offset -BetaLimit $Limit -BetaSorters $Sorters -BetaFilters $Filters -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + + # Service Desk integration template by scriptName + + try { + Get-BetaServiceDeskIntegrationTemplate-BetaScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationTemplate -BetaScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTemplate" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Service Desk integration types + + try { + Get-BetaServiceDeskIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTypes" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get the time check configuration + + try { + Get-BetaStatusCheckDetails + + # Below is a request that includes all optional parameters + # Get-BetaStatusCheckDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $PatchServiceDeskIntegrationRequest = @" + + "@ + + # Patch a Service Desk Integration + + try { + $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest + Update-BetaServiceDeskIntegration-BetaId $Id -BetaPatchServiceDeskIntegrationRequest $Result + + # Below is a request that includes all optional parameters + # Update-BetaServiceDeskIntegration -BetaId $Id -BetaPatchServiceDeskIntegrationRequest $PatchServiceDeskIntegrationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } + "@ + + # Update a Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-BetaServiceDeskIntegration-BetaId $Id -BetaServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaServiceDeskIntegration -BetaId $Id -BetaServiceDeskIntegrationDto $ServiceDeskIntegrationDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $QueuedCheckConfigDetails = @" + { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } + "@ + + # Update the time check configuration + + try { + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-BetaStatusCheckDetails-BetaQueuedCheckConfigDetails $Result + + # Below is a request that includes all optional parameters + # Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $QueuedCheckConfigDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Create new SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-BetaSIMIntegration-BetaSimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # New-BetaSIMIntegration -BetaSimIntegrationDetails $SimIntegrationDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "12345" # String | The id of the integration to delete. + + # Delete a SIM integration + + try { + Remove-BetaSIMIntegration-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSIMIntegration -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "12345" # String | The id of the integration. + + # Get a SIM integration details. + + try { + Get-BetaSIMIntegration-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSIMIntegration -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List the existing SIM integrations. + + try { + Get-BetaSIMIntegrations + + # Below is a request that includes all optional parameters + # Get-BetaSIMIntegrations + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegrations" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "12345" # String | SIM integration id + $JsonPatch = @" + "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" + "@ + + # Patch a SIM beforeProvisioningRule attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-BetaBeforeProvisioningRule-BetaId $Id -BetaJsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-BetaBeforeProvisioningRule -BetaId $Id -BetaJsonPatch $JsonPatch + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaBeforeProvisioningRule" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "12345" # String | SIM integration id + $JsonPatch = @" + "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" + "@ + + # Patch a SIM attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-BetaSIMAttributes-BetaId $Id -BetaJsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-BetaSIMAttributes -BetaId $Id -BetaJsonPatch $JsonPatch + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSIMAttributes" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "12345" # String | The id of the integration. + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Update an existing SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + Send-BetaSIMIntegration-BetaId $Id -BetaSimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # Send-BetaSIMIntegration -BetaId $Id -BetaSimIntegrationDetails $SimIntegrationDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Create SOD policy + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-BetaSodPolicy-BetaSodPolicy $Result + + # Below is a request that includes all optional parameters + # New-BetaSodPolicy -BetaSodPolicy $SodPolicy + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-BetaSodPolicy-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSodPolicy -BetaId $Id -BetaLogical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-BetaSodPolicySchedule-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSodPolicySchedule -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. + + # Download custom violation report + + try { + Get-BetaCustomViolationReport-BetaReportResultId $ReportResultId -BetaFileName $FileName + + # Below is a request that includes all optional parameters + # Get-BetaCustomViolationReport -BetaReportResultId $ReportResultId -BetaFileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-BetaDefaultViolationReport-BetaReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-BetaDefaultViolationReport -BetaReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get multi-report run task status + + try { + Get-BetaSodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-BetaSodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodAllReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + + # Get SOD policy by ID + + try { + Get-BetaSodPolicy-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSodPolicy -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + + # Get SOD policy schedule + + try { + Get-BetaSodPolicySchedule-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSodPolicySchedule -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + + # Get violation report run status + + try { + Get-BetaSodViolationReportRunStatus-BetaReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-BetaSodViolationReportRunStatus -BetaReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + + # Get SOD violation report status + + try { + Get-BetaSodViolationReportStatus-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSodViolationReportStatus -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + + # List SOD policies + + try { + Get-BetaSodPolicies + + # Below is a request that includes all optional parameters + # Get-BetaSodPolicies -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicies" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The ID of the SOD policy being modified. + $RequestBody = # SystemCollectionsHashtable[] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria + $RequestBody = @"[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]"@ + + + # Patch a SOD policy + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaSodPolicy-BetaId $Id -BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaSodPolicy -BetaId $Id -BetaRequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-BetaPolicySchedule-BetaId $Id -BetaSodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-BetaPolicySchedule -BetaId $Id -BetaSodPolicySchedule $SodPolicySchedule + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-BetaSodPolicy-BetaId $Id -BetaSodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-BetaSodPolicy -BetaId $Id -BetaSodPolicy $SodPolicy + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "filteredPolicyList", "filteredPolicyList" ] + } + "@ + + # Runs all policies for org + + try { + Start-BetaSodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-BetaSodAllPoliciesForOrg -BetaMultiPolicyRequest $MultiPolicyRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-BetaSodPolicy-BetaId $Id + + # Below is a request that includes all optional parameters + # Start-BetaSodPolicy -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityWithNewAccess = @" + { + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-BetaPredictSodViolations-BetaIdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-BetaPredictSodViolations -BetaIdentityWithNewAccess $IdentityWithNewAccess + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaPredictSodViolations" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + $ProvisioningPolicyDto = @" + { + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + } + "@ + + # Create Provisioning Policy + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + New-BetaProvisioningPolicy-BetaSourceId $SourceId -BetaProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # New-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaProvisioningPolicyDto $ProvisioningPolicyDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Source = @" + { + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + } + "@ + $ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) + + # Creates a source in IdentityNow. + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + New-BetaSource-BetaSource $Result + + # Below is a request that includes all optional parameters + # New-BetaSource -BetaSource $Source -BetaProvisionAsCsv $ProvisionAsCsv + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSource" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Create Schema on Source + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + New-BetaSourceSchema-BetaSourceId $SourceId -BetaSchema $Result + + # Below is a request that includes all optional parameters + # New-BetaSourceSchema -BetaSourceId $SourceId -BetaSchema $Schema + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Delete Source by ID + + try { + Remove-Beta-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-Beta -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Beta" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/remove-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ebbf35756e1140699ce52b233121384a" # String | The source id + + # Remove All Accounts in a Source + + try { + Remove-BetaAccountsAsync-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaAccountsAsync -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccountsAsync" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/native-change-detection-config + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + + # Delete Native Change Detection Configuration + + try { + Remove-BetaNativeChangeDetectionConfig-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaNativeChangeDetectionConfig -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + # Delete Provisioning Policy by UsageType + + try { + Remove-BetaProvisioningPolicy-BetaSourceId $SourceId -BetaUsageType $UsageType + + # Below is a request that includes all optional parameters + # Remove-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaUsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. + + # Delete Source Schema by ID + + try { + Remove-BetaSourceSchema-BetaSourceId $SourceId -BetaSchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Remove-BetaSourceSchema -BetaSourceId $SourceId -BetaSchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/correlation-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + + # Get Source Correlation Configuration + + try { + Get-BetaCorrelationConfig-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaCorrelationConfig -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCorrelationConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/native-change-detection-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + + # Native Change Detection Configuration + + try { + Get-BetaNativeChangeDetectionConfig-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaNativeChangeDetectionConfig -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + # Get Provisioning Policy by UsageType + + try { + Get-BetaProvisioningPolicy-BetaSourceId $SourceId -BetaUsageType $UsageType + + # Below is a request that includes all optional parameters + # Get-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaUsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Get Source by ID + + try { + Get-BetaSource-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSource -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSource" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + + # Downloads source accounts schema template + + try { + Get-BetaSourceAccountsSchema-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSourceAccountsSchema -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceAccountsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/attribute-sync-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + + # Attribute Sync Config + + try { + Get-BetaSourceAttrSyncConfig-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSourceAttrSyncConfig -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceAttrSyncConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/connectors/source-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "MyId" # String | The Source id + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Gets source config with language translations + + try { + Get-BetaSourceConfig-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSourceConfig -BetaId $Id -BetaLocale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/entitlement-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Source Entitlement Request Configuration + + try { + Get-BetaSourceEntitlementRequestConfig + + # Below is a request that includes all optional parameters + # Get-BetaSourceEntitlementRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + + # Downloads source entitlements schema template + + try { + Get-BetaSourceEntitlementsSchema-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSourceEntitlementsSchema -BetaId $Id -BetaSchemaName $SchemaName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceEntitlementsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. + + # Get Source Schema by ID + + try { + Get-BetaSourceSchema-BetaSourceId $SourceId -BetaSchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Get-BetaSourceSchema -BetaSourceId $SourceId -BetaSchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) + $IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional) + + # List Schemas on Source + + try { + Get-BetaSourceSchemas-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaSourceSchemas -BetaSourceId $SourceId -BetaIncludeTypes $IncludeTypes -BetaIncludeNames $IncludeNames + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceSchemas" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/load-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id + $File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) + $DisableOptimization = "true" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) + + # Account Aggregation + + try { + Import-BetaAccounts-BetaId $Id + + # Below is a request that includes all optional parameters + # Import-BetaAccounts -BetaId $Id -BetaFile $File -BetaDisableOptimization $DisableOptimization + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaAccounts" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/load-entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id + $File = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) + + # Entitlement Aggregation + + try { + Import-BetaEntitlements-BetaId $Id + + # Below is a request that includes all optional parameters + # Import-BetaEntitlements -BetaId $Id -BetaFile $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaEntitlements" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $File = # System.IO.FileInfo | (optional) + + # Uploads source accounts schema template + + try { + Import-BetaSourceAccountsSchema-BetaId $Id + + # Below is a request that includes all optional parameters + # Import-BetaSourceAccountsSchema -BetaId $Id -BetaFile $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceAccountsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/upload-connector-file + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $File = # System.IO.FileInfo | (optional) + + # Upload connector file to source + + try { + Import-BetaSourceConnectorFile-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-BetaSourceConnectorFile -BetaSourceId $SourceId -BetaFile $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceConnectorFile" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + $File = # System.IO.FileInfo | (optional) + + # Uploads source entitlements schema template + + try { + Import-BetaSourceEntitlementsSchema-BetaId $Id + + # Below is a request that includes all optional parameters + # Import-BetaSourceEntitlementsSchema -BetaId $Id -BetaSchemaName $SchemaName -BetaFile $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceEntitlementsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/load-uncorrelated-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id + $File = # System.IO.FileInfo | (optional) + + # Process Uncorrelated Accounts + + try { + Import-BetaUncorrelatedAccounts-BetaId $Id + + # Below is a request that includes all optional parameters + # Import-BetaUncorrelatedAccounts -BetaId $Id -BetaFile $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaUncorrelatedAccounts" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + + # Lists ProvisioningPolicies + + try { + Get-BetaProvisioningPolicies-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaProvisioningPolicies -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProvisioningPolicies" + Write-Host $_.ErrorDetails + } +- path: /sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Employees"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq* **modified**: *eq* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) + $ForSubadmin = "name" # String | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) + $IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false) + + # Lists all sources in IdentityNow. + + try { + Get-BetaSources + + # Below is a request that includes all optional parameters + # Get-BetaSources -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -BetaForSubadmin $ForSubadmin -BetaIncludeIDNSource $IncludeIDNSource + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSources" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/peek-resource-objects + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + $ResourceObjectsRequest = @" + { + "maxCount" : 100, + "objectType" : "group" + } + "@ + + # Peek source connector's resource objects + + try { + $Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest + Receive-BetaResourceObjects-BetaSourceId $SourceId -BetaResourceObjectsRequest $Result + + # Below is a request that includes all optional parameters + # Receive-BetaResourceObjects -BetaSourceId $SourceId -BetaResourceObjectsRequest $ResourceObjectsRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Receive-BetaResourceObjects" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/ping-cluster + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + + # Ping cluster for source connector + + try { + Ping-BetaCluster-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Ping-BetaCluster -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-BetaCluster" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/correlation-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $CorrelationConfig = @" + { + "attributeAssignments" : [ { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + }, { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + } ], + "name" : "Source [source] Account Correlation", + "id" : "2c9180835d191a86015d28455b4a2329" + } + "@ + + # Update Source Correlation Configuration + + try { + $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig + Send-BetaCorrelationConfig-BetaId $Id -BetaCorrelationConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaCorrelationConfig -BetaId $Id -BetaCorrelationConfig $CorrelationConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaCorrelationConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/native-change-detection-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $NativeChangeDetectionConfig = @" + { + "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], + "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], + "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], + "allNonEntitlementAttributes" : false, + "allEntitlements" : false, + "enabled" : true + } + "@ + + # Update Native Change Detection Configuration + + try { + $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig + Send-BetaNativeChangeDetectionConfig-BetaId $Id -BetaNativeChangeDetectionConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaNativeChangeDetectionConfig -BetaId $Id -BetaNativeChangeDetectionConfig $NativeChangeDetectionConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaNativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $ProvisioningPolicyDto = @" + { + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + } + "@ + + # Update Provisioning Policy by UsageType + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Send-BetaProvisioningPolicy-BetaSourceId $SourceId -BetaUsageType $UsageType -BetaProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaUsageType $UsageType -BetaProvisioningPolicyDto $ProvisioningPolicyDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Source = @" + { + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + } + "@ + + # Update Source (Full) + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + Send-BetaSource-BetaId $Id -BetaSource $Result + + # Below is a request that includes all optional parameters + # Send-BetaSource -BetaId $Id -BetaSource $Source + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSource" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/attribute-sync-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $AttrSyncSourceConfig = @" + { + "attributes" : [ { + "name" : "email", + "displayName" : "Email", + "enabled" : true, + "target" : "mail" + }, { + "name" : "firstname", + "displayName" : "First Name", + "enabled" : false, + "target" : "givenName" + } ], + "source" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + } + } + "@ + + # Update Attribute Sync Config + + try { + $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig + Send-BetaSourceAttrSyncConfig-BetaId $Id -BetaAttrSyncSourceConfig $Result + + # Below is a request that includes all optional parameters + # Send-BetaSourceAttrSyncConfig -BetaId $Id -BetaAttrSyncSourceConfig $AttrSyncSourceConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSourceAttrSyncConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Update Source Schema (Full) + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + Send-BetaSourceSchema-BetaSourceId $SourceId -BetaSchemaId $SchemaId -BetaSchema $Result + + # Below is a request that includes all optional parameters + # Send-BetaSourceSchema -BetaSourceId $SourceId -BetaSchemaId $SchemaId -BetaSchema $Schema + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/synchronize-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "MyId" # String | The Source id + + # Synchronize single source attributes. + + try { + Sync-BetaAttributesForSource-BetaId $Id + + # Below is a request that includes all optional parameters + # Sync-BetaAttributesForSource -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetaAttributesForSource" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/test-configuration + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + + # Test configuration for source connector + + try { + Test-BetaSourceConfiguration-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Test-BetaSourceConfiguration -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConfiguration" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/check-connection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source. + + # Check connection for source connector. + + try { + Test-BetaSourceConnection-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Test-BetaSourceConnection -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConnection" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ProvisioningPolicyDto = @"{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }"@ + + + # Bulk Update Provisioning Policies + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Update-BetaProvisioningPoliciesInBulk-BetaSourceId $SourceId -BetaProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Update-BetaProvisioningPoliciesInBulk -BetaSourceId $SourceId -BetaProvisioningPolicyDto $ProvisioningPolicyDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProvisioningPoliciesInBulk" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Partial update of Provisioning Policy + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaProvisioningPolicy-BetaSourceId $SourceId -BetaUsageType $UsageType -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaUsageType $UsageType -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaSource-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaSource -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSource" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/entitlement-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceEntitlementRequestConfig = @" + { + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + } + "@ + + # Update Source Entitlement Request Configuration + + try { + $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig + Update-BetaSourceEntitlementRequestConfig-BetaSourceEntitlementRequestConfig $Result + + # Below is a request that includes all optional parameters + # Update-BetaSourceEntitlementRequestConfig -BetaSourceEntitlementRequestConfig $SourceEntitlementRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source Schema (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaSourceSchema-BetaSourceId $SourceId -BetaSchemaId $SchemaId -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaSourceSchema -BetaSourceId $SourceId -BetaSchemaId $SchemaId -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceSchema" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-BetaStatusBySourceId-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaStatusBySourceId -BetaSourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusBySourceId" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns source usage insights + + try { + Get-BetaUsagesBySourceId-BetaSourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaUsagesBySourceId -BetaSourceId $SourceId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesBySourceId" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ExportPayload = @" + { + "description" : "Export Job 1 Test" + } + "@ + + # Initiates configuration objects export job + + try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-BetaSpConfig-BetaExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-BetaSpConfig -BetaExportPayload $ExportPayload + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. + + # Download export job result. + + try { + Get-BetaSpConfigExport-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigExport -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. + + # Get export job status + + try { + Get-BetaSpConfigExportStatus-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigExportStatus -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. + + # Download import job result + + try { + Get-BetaSpConfigImport-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigImport -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. + + # Get import job status + + try { + Get-BetaSpConfigImportStatus-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigImportStatus -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) + $Options = @" + "@ + + # Initiates configuration objects import job + + try { + Import-BetaSpConfig-BetaData $Data + + # Below is a request that includes all optional parameters + # Import-BetaSpConfig -BetaData $Data -BetaPreview $Preview -BetaOptions $Options + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get config object details + + try { + Get-BetaSpConfigObjects + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigObjects + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigObjects" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-batches/{batchId}/stats + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id + + # Submit Sed Batch Stats Request + + try { + Get-BetaSedBatchStats-BetaBatchId $BatchId + + # Below is a request that includes all optional parameters + # Get-BetaSedBatchStats -BetaBatchId $BatchId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSedBatchStats" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-batches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Sed Batch Request + + try { + Get-BetaSedBatches + + # Below is a request that includes all optional parameters + # Get-BetaSedBatches + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSedBatches" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-descriptions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = limit=25 # Int64 | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) + $Filters = "displayName co "Read and Write"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) + $Sorters = "sorters=displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) + $Count = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) + $CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) + $RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) + $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) + + # List Suggested Entitlement Descriptions + + try { + Get-BetaSeds + + # Below is a request that includes all optional parameters + # Get-BetaSeds -BetaLimit $Limit -BetaFilters $Filters -BetaSorters $Sorters -BetaCount $Count -BetaCountOnly $CountOnly -BetaRequestedByAnyone $RequestedByAnyone -BetaShowPendingStatusOnly $ShowPendingStatusOnly + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSeds" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-descriptions + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id + $SedPatch = @"{ + "op" : "replace", + "path" : "status", + "value" : "approved" + }"@ + + + # Patch Suggested Entitlement Description + + try { + $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch + Update-BetaSed-BetaId $Id -BetaSedPatch $Result + + # Below is a request that includes all optional parameters + # Update-BetaSed -BetaId $Id -BetaSedPatch $SedPatch + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSed" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-approvals + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SedApproval = @"{ + "items" : "016629d1-1d25-463f-97f3-c6686846650" + }"@ + + + # Submit Bulk Approval Request + + try { + $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval + Submit-BetaSedApproval-BetaSedApproval $Result + + # Below is a request that includes all optional parameters + # Submit-BetaSedApproval -BetaSedApproval $SedApproval + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedApproval" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-assignments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SedAssignment = @" + { + "assignee" : { + "type" : "SOURCE_OWNER", + "value" : "016629d1-1d25-463f-97f3-c6686846650" + }, + "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] + } + "@ + + # Submit Sed Assignment Request + + try { + $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment + Submit-BetaSedAssignment-BetaSedAssignment $Result + + # Below is a request that includes all optional parameters + # Submit-BetaSedAssignment -BetaSedAssignment $SedAssignment + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedAssignment" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-batches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SedBatchRequest = @" + { + "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + } + "@ + + # Submit Sed Batch Request + + try { + Submit-BetaSedBatchRequest + + # Below is a request that includes all optional parameters + # Submit-BetaSedBatchRequest -BetaSedBatchRequest $SedBatchRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedBatchRequest" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "ACCESS_PROFILE" # String | The type of object to delete tags from. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from. + + # Delete Object Tags + + try { + Remove-BetaTaggedObject-BetaType $Type -BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaTaggedObject -BetaType $Type -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/bulk-remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $BulkTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Remove Tags from Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject + Remove-BetaTagsToManyObject-BetaBulkTaggedObject $Result + + # Below is a request that includes all optional parameters + # Remove-BetaTagsToManyObject -BetaBulkTaggedObject $BulkTaggedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTagsToManyObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + + # Get Tagged Object + + try { + Get-BetaTaggedObject-BetaType $Type -BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaTaggedObject -BetaType $Type -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "tagName eq "BU_FINANCE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + + # List Tagged Objects + + try { + Get-BetaTaggedObjects + + # Below is a request that includes all optional parameters + # Get-BetaTaggedObjects -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObjects" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "objectRef.id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + + # List Tagged Objects by Type + + try { + Get-BetaTaggedObjectsByType-BetaType $Type + + # Below is a request that includes all optional parameters + # Get-BetaTaggedObjectsByType -BetaType $Type -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObjectsByType" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to update. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to update. + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Update Tagged Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Send-BetaTaggedObject-BetaType $Type -BetaId $Id -BetaTaggedObject $Result + + # Below is a request that includes all optional parameters + # Send-BetaTaggedObject -BetaType $Type -BetaId $Id -BetaTaggedObject $TaggedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Add Tag to Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Set-BetaTagToObject-BetaTaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-BetaTagToObject -BetaTaggedObject $TaggedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTagToObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/bulk-add + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $BulkTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Tag Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject + Set-BetaTagsToManyObjects-BetaBulkTaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-BetaTagsToManyObjects -BetaBulkTaggedObject $BulkTaggedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTagsToManyObjects" + Write-Host $_.ErrorDetails + } +- path: /tags + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Tag = @" + { + "created" : "2022-05-04T14:48:49Z", + "tagCategoryRefs" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "name" : "PCI", + "modified" : "2022-07-14T16:31:11Z", + "id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f" + } + "@ + + # Create Tag + + try { + $Result = ConvertFrom-JsonToTag -Json $Tag + New-BetaTag-BetaTag $Result + + # Below is a request that includes all optional parameters + # New-BetaTag -BetaTag $Tag + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTag" + Write-Host $_.ErrorDetails + } +- path: /tags/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to delete. + + # Delete Tag + + try { + Remove-BetaTagById-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaTagById -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTagById" + Write-Host $_.ErrorDetails + } +- path: /tags/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to retrieve. + + # Get Tag By Id + + try { + Get-BetaTagById-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaTagById -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTagById" + Write-Host $_.ErrorDetails + } +- path: /tags + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "27462f54-61c7-4140-b5da-d5dbe27fc6db"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified** (optional) + + # List Tags + + try { + Get-BetaTags + + # Below is a request that includes all optional parameters + # Get-BetaTags -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTags" + Write-Host $_.ErrorDetails + } +- path: /task-status/pending-tasks + method: HEAD + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieve Pending Task List Headers + + try { + Get-BetaPendingTaskHeaders + + # Below is a request that includes all optional parameters + # Get-BetaPendingTaskHeaders -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingTaskHeaders" + Write-Host $_.ErrorDetails + } +- path: /task-status/pending-tasks + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieve Pending Task Status List + + try { + Get-BetaPendingTasks + + # Below is a request that includes all optional parameters + # Get-BetaPendingTasks -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingTasks" + Write-Host $_.ErrorDetails + } +- path: /task-status/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. + + # Get Task Status by ID + + try { + Get-BetaTaskStatus-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaTaskStatus -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaskStatus" + Write-Host $_.ErrorDetails + } +- path: /task-status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "completionStatus eq "Success"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) + $Sorters = "-created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) + + # Retrieve Task Status List + + try { + Get-BetaTaskStatusList + + # Below is a request that includes all optional parameters + # Get-BetaTaskStatusList -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaskStatusList" + Write-Host $_.ErrorDetails + } +- path: /task-status/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Task Status by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaTaskStatus-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaTaskStatus -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaTaskStatus" + Write-Host $_.ErrorDetails + } +- path: /tenant + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Tenant Information. + + try { + Get-BetaTenant + + # Below is a request that includes all optional parameters + # Get-BetaTenant + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenant" + Write-Host $_.ErrorDetails + } +- path: /transforms + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Create transform + + try { + $Result = ConvertFrom-JsonToTransform -Json $Transform + New-BetaTransform-BetaTransform $Result + + # Below is a request that includes all optional parameters + # New-BetaTransform -BetaTransform $Transform + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTransform" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete + + # Delete a transform + + try { + Remove-BetaTransform-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaTransform -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTransform" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve + + # Transform by ID + + try { + Get-BetaTransform-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaTransform -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTransform" + Write-Host $_.ErrorDetails + } +- path: /transforms + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional) + $Filters = "name eq "Uppercase"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) + + # List transforms + + try { + Get-BetaTransforms + + # Below is a request that includes all optional parameters + # Get-BetaTransforms -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaName $Name -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTransforms" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Update a transform + + try { + Update-BetaTransform-BetaId $Id + + # Below is a request that includes all optional parameters + # Update-BetaTransform -BetaId $Id -BetaTransform $Transform + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaTransform" + Write-Host $_.ErrorDetails + } +- path: /trigger-invocations/{id}/complete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the invocation to complete. + $CompleteInvocation = @" + { + "output" : { + "approved" : false + }, + "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "error" : "Access request is denied." + } + "@ + + # Complete Trigger Invocation + + try { + $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation + Complete-BetaTriggerInvocation-BetaId $Id -BetaCompleteInvocation $Result + + # Below is a request that includes all optional parameters + # Complete-BetaTriggerInvocation -BetaId $Id -BetaCompleteInvocation $CompleteInvocation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaTriggerInvocation" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SubscriptionPostRequest = @" + { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "triggerId" : "idn:access-requested", + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + } + "@ + + # Create a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest + New-BetaSubscription-BetaSubscriptionPostRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaSubscription -BetaSubscriptionPostRequest $SubscriptionPostRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSubscription" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID + + # Delete a Subscription + + try { + Remove-BetaSubscription-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSubscription -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSubscription" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional) + $Sorters = "triggerName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) + + # List Subscriptions + + try { + Get-BetaSubscriptions + + # Below is a request that includes all optional parameters + # Get-BetaSubscriptions -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSubscriptions" + Write-Host $_.ErrorDetails + } +- path: /trigger-invocations/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "triggerId eq "idn:access-request-dynamic-approver"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) + + # List Latest Invocation Statuses + + try { + Get-BetaTriggerInvocationStatus + + # Below is a request that includes all optional parameters + # Get-BetaTriggerInvocationStatus -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTriggerInvocationStatus" + Write-Host $_.ErrorDetails + } +- path: /triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "idn:access-request-post-approval"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** (optional) + + # List Triggers + + try { + Get-BetaTriggers + + # Below is a request that includes all optional parameters + # Get-BetaTriggers -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTriggers" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription to patch + $SubscriptionPatchRequestInner = @""@ + + + # Patch a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner + Update-BetaSubscription-BetaId $Id -BetaSubscriptionPatchRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-BetaSubscription -BetaId $Id -BetaSubscriptionPatchRequestInner $SubscriptionPatchRequestInner + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSubscription" + Write-Host $_.ErrorDetails + } +- path: /trigger-invocations/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TestInvocation = @" + { + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + }, + "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], + "triggerId" : "idn:access-request-post-approval", + "contentJson" : { + "workflowId" : 1234 + } + } + "@ + + # Start a Test Invocation + + try { + $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation + Start-BetaTestTriggerInvocation-BetaTestInvocation $Result + + # Below is a request that includes all optional parameters + # Start-BetaTestTriggerInvocation -BetaTestInvocation $TestInvocation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaTestTriggerInvocation" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/validate-filter + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ValidateFilterInputDto = @" + { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + } + } + "@ + + # Validate a Subscription Filter + + try { + $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto + Test-BetaSubscriptionFilter-BetaValidateFilterInputDto $Result + + # Below is a request that includes all optional parameters + # Test-BetaSubscriptionFilter -BetaValidateFilterInputDto $ValidateFilterInputDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSubscriptionFilter" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID + $SubscriptionPutRequest = @" + { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + } + "@ + + # Update a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest + Update-BetaSubscription-BetaId $Id -BetaSubscriptionPutRequest $Result + + # Below is a request that includes all optional parameters + # Update-BetaSubscription -BetaId $Id -BetaSubscriptionPutRequest $SubscriptionPutRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSubscription" + Write-Host $_.ErrorDetails + } +- path: /ui-metadata/tenant + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get a tenant UI metadata + + try { + Get-BetaTenantUiMetadata + + # Below is a request that includes all optional parameters + # Get-BetaTenantUiMetadata + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantUiMetadata" + Write-Host $_.ErrorDetails + } +- path: /ui-metadata/tenant + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TenantUiMetadataItemUpdateRequest = @" + { + "usernameEmptyText" : "Please provide your work email address...", + "usernameLabel" : "Email", + "iframeWhiteList" : "http://example.com http://example2.com" + } + "@ + + # Update tenant UI metadata + + try { + $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest + Set-BetaTenantUiMetadata-BetaTenantUiMetadataItemUpdateRequest $Result + + # Below is a request that includes all optional parameters + # Set-BetaTenantUiMetadata -BetaTenantUiMetadataItemUpdateRequest $TenantUiMetadataItemUpdateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTenantUiMetadata" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $VendorConnectorMapping = @" + { + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + } + "@ + + # Create Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + New-BetaVendorConnectorMapping-BetaVendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # New-BetaVendorConnectorMapping -BetaVendorConnectorMapping $VendorConnectorMapping + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaVendorConnectorMapping" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $VendorConnectorMapping = @" + { + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + } + "@ + + # Delete Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + Remove-BetaVendorConnectorMapping-BetaVendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # Remove-BetaVendorConnectorMapping -BetaVendorConnectorMapping $VendorConnectorMapping + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaVendorConnectorMapping" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Vendor Connector Mappings + + try { + Get-BetaVendorConnectorMappings + + # Below is a request that includes all optional parameters + # Get-BetaVendorConnectorMappings + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaVendorConnectorMappings" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-BetaWorkflowExecution-BetaId $Id + + # Below is a request that includes all optional parameters + # Suspend-BetaWorkflowExecution -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreateWorkflowRequest = @" + {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-BetaWorkflow-BetaCreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaWorkflow -BetaCreateWorkflowRequest $CreateWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-BetaWorkflow-BetaId $Id + + # Below is a request that includes all optional parameters + # Remove-BetaWorkflow -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Get Workflow By Id + + try { + Get-BetaWorkflow-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflow -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-BetaWorkflowExecution-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecution -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + + # Get Workflow Execution History + + try { + Get-BetaWorkflowExecutionHistory-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecutionHistory -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-BetaWorkflowExecutions-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecutions -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Complete Workflow Library + + try { + Get-BetaCompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-BetaCompleteWorkflowLibrary -BetaLimit $Limit -BetaOffset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Actions + + try { + Get-BetaWorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryActions -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Workflow Library Operators + + try { + Get-BetaWorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Triggers + + try { + Get-BetaWorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryTriggers -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Workflows + + try { + Get-BetaWorkflows + + # Below is a request that includes all optional parameters + # Get-BetaWorkflows + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaWorkflow-BetaId $Id -BetaJsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaWorkflow -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $PostExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + Submit-BetaExternalExecuteWorkflow-BetaId $Id + + # Below is a request that includes all optional parameters + # Submit-BetaExternalExecuteWorkflow -BetaId $Id -BetaPostExternalExecuteWorkflowRequest $PostExternalExecuteWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + Submit-BetaWorkflowExternalTrigger-BetaId $Id + + # Below is a request that includes all optional parameters + # Submit-BetaWorkflowExternalTrigger -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-BetaExternalExecuteWorkflow-BetaId $Id + + # Below is a request that includes all optional parameters + # Test-BetaExternalExecuteWorkflow -BetaId $Id -BetaTestExternalExecuteWorkflowRequest $TestExternalExecuteWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-BetaWorkflow-BetaId $Id -BetaTestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-BetaWorkflow -BetaId $Id -BetaTestWorkflowRequest $TestWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "description", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Update-BetaWorkflow-BetaId $Id -BetaWorkflowBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaWorkflow -BetaId $Id -BetaWorkflowBody $WorkflowBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Approve an Approval Item + + try { + Approve-BetaApprovalItem-BetaId $Id -BetaApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Approve-BetaApprovalItem -BetaId $Id -BetaApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk approve Approval Items + + try { + Approve-BetaApprovalItemsInBulk-BetaId $Id + + # Below is a request that includes all optional parameters + # Approve-BetaApprovalItemsInBulk -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Complete a Work Item + + try { + Complete-BetaWorkItem-BetaId $Id + + # Below is a request that includes all optional parameters + # Complete-BetaWorkItem -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaWorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $WorkItemForward = @" + { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } + "@ + + # Forward a Work Item + + try { + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Invoke-BetaForwardWorkItem-BetaId $Id -BetaWorkItemForward $Result + + # Below is a request that includes all optional parameters + # Invoke-BetaForwardWorkItem -BetaId $Id -BetaWorkItemForward $WorkItemForward + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardWorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "MyOwnerId" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Completed Work Items + + try { + Get-BetaCompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-BetaCompletedWorkItems -BetaOwnerId $OwnerId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + + # Count Completed Work Items + + try { + Get-BetaCountCompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-BetaCountCompletedWorkItems -BetaOwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountCompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + + # Count Work Items + + try { + Get-BetaCountWorkItems + + # Below is a request that includes all optional parameters + # Get-BetaCountWorkItems -BetaOwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "MyId" # String | ID of the work item. + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + + # Get a Work Item + + try { + Get-BetaWorkItem-BetaId $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkItem -BetaId $Id -BetaOwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + + # Work Items Summary + + try { + Get-BetaWorkItemsSummary + + # Below is a request that includes all optional parameters + # Get-BetaWorkItemsSummary -BetaOwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItemsSummary" + Write-Host $_.ErrorDetails + } +- path: /work-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) + + # List Work Items + + try { + Get-BetaWorkItems + + # Below is a request that includes all optional parameters + # Get-BetaWorkItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaOwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Reject an Approval Item + + try { + Deny-BetaApprovalItem-BetaId $Id -BetaApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Deny-BetaApprovalItem -BetaId $Id -BetaApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk reject Approval Items + + try { + Deny-BetaApprovalItemsInBulk-BetaId $Id + + # Below is a request that includes all optional parameters + # Deny-BetaApprovalItemsInBulk -BetaId $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName + + # Submit Account Selections + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-BetaAccountSelection-BetaId $Id -BetaRequestBody $Result + + # Below is a request that includes all optional parameters + # Submit-BetaAccountSelection -BetaId $Id -BetaRequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaAccountSelection" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ + + # Create a Reassignment Configuration + + try { + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + New-BetaReassignmentConfiguration-BetaConfigurationItemRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaReassignmentConfiguration -BetaConfigurationItemRequest $ConfigurationItemRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId}/{configType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | + + # Delete Reassignment Configuration + + try { + Remove-BetaReassignmentConfiguration-BetaIdentityId $IdentityId -BetaConfigType $ConfigType + + # Below is a request that includes all optional parameters + # Remove-BetaReassignmentConfiguration -BetaIdentityId $IdentityId -BetaConfigType $ConfigType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId}/evaluate/{configType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type + $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) + + $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ + + # Evaluate Reassignment Configuration + + try { + Get-BetaEvaluateReassignmentConfiguration-BetaIdentityId $IdentityId -BetaConfigType $ConfigType + + # Below is a request that includes all optional parameters + # Get-BetaEvaluateReassignmentConfiguration -BetaIdentityId $IdentityId -BetaConfigType $ConfigType -BetaExclusionFilters $ExclusionFilters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEvaluateReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Reassignment Config Types + + try { + Get-BetaReassignmentConfigTypes + + # Below is a request that includes all optional parameters + # Get-BetaReassignmentConfigTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigTypes" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id + + # Get Reassignment Configuration + + try { + Get-BetaReassignmentConfiguration-BetaIdentityId $IdentityId + + # Below is a request that includes all optional parameters + # Get-BetaReassignmentConfiguration -BetaIdentityId $IdentityId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/tenant-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Tenant-wide Reassignment Configuration settings + + try { + Get-BetaTenantConfigConfiguration + + # Below is a request that includes all optional parameters + # Get-BetaTenantConfigConfiguration + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantConfigConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Reassignment Configurations + + try { + Get-BetaReassignmentConfigurations + + # Below is a request that includes all optional parameters + # Get-BetaReassignmentConfigurations + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigurations" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ + + # Update Reassignment Configuration + + try { + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + Send-BetaReassignmentConfig-BetaIdentityId $IdentityId -BetaConfigurationItemRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaReassignmentConfig -BetaIdentityId $IdentityId -BetaConfigurationItemRequest $ConfigurationItemRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaReassignmentConfig" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/tenant-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TenantConfigurationRequest = @" + { + "configDetails" : { + "disabled" : true + } + } + "@ + + # Update Tenant-wide Reassignment Configuration settings + + try { + $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest + Send-BetaTenantConfiguration-BetaTenantConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-BetaTenantConfiguration -BetaTenantConfigurationRequest $TenantConfigurationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTenantConfiguration" + Write-Host $_.ErrorDetails + } diff --git a/static/code-examples/v2024/Examples/code_examples_overlay.yaml b/static/code-examples/v2024/Examples/code_examples_overlay.yaml new file mode 100644 index 000000000..f33a5cbbb --- /dev/null +++ b/static/code-examples/v2024/Examples/code_examples_overlay.yaml @@ -0,0 +1,17122 @@ +- path: /access-model-metadata/attributes/{key} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Key = "iscPrivacy" # String | Technical name of the Attribute. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Access Model Metadata Attribute + + try { + Get-V2024AccessModelMetadataAttribute-V2024Key $Key -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessModelMetadataAttribute -V2024Key $Key -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute" + Write-Host $_.ErrorDetails + } +- path: /access-model-metadata/attributes/{key}/values/{value} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Key = "iscPrivacy" # String | Technical name of the Attribute. + $Value = "public" # String | Technical name of the Attribute value. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Access Model Metadata Value + + try { + Get-V2024AccessModelMetadataAttributeValue-V2024Key $Key -V2024Value $Value -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessModelMetadataAttributeValue -V2024Key $Key -V2024Value $Value -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue" + Write-Host $_.ErrorDetails + } +- path: /access-model-metadata/attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "name eq "Privacy"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) + + # List Access Model Metadata Attributes + + try { + Get-V2024AccessModelMetadataAttribute-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessModelMetadataAttribute -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttribute" + Write-Host $_.ErrorDetails + } +- path: /access-model-metadata/attributes/{key}/values + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Key = "iscPrivacy" # String | Technical name of the Attribute. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List Access Model Metadata Values + + try { + Get-V2024AccessModelMetadataAttributeValue-V2024Key $Key -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessModelMetadataAttributeValue -V2024Key $Key -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessModelMetadataAttributeValue" + Write-Host $_.ErrorDetails + } +- path: /access-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessProfile = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "description" : "Collection of entitlements to read/write the employee database", + "source" : { + "name" : "ODS-AD-SOURCE", + "id" : "2c91809773dee3610173fdb0b6061ef4", + "type" : "SOURCE" + }, + "enabled" : true, + "revocationRequestConfig" : { + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ] + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "accessRequestConfig" : { + "commentsRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "name" : "Employee-database-read-write", + "provisioningCriteria" : { + "children" : [ { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, + "modified" : "2021-03-02T20:22:28.104Z", + "id" : "2c91808a7190d06e01719938fcd20792", + "requestable" : true + } + "@ + + # Create Access Profile + + try { + $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile + New-V2024AccessProfile-V2024AccessProfile $Result + + # Below is a request that includes all optional parameters + # New-V2024AccessProfile -V2024AccessProfile $AccessProfile + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete + + # Delete the specified Access Profile + + try { + Remove-V2024AccessProfile-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024AccessProfile -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessProfileBulkDeleteRequest = @" + { + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + } + "@ + + # Delete Access Profile(s) + + try { + $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest + Remove-V2024AccessProfilesInBulk-V2024AccessProfileBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024AccessProfilesInBulk -V2024AccessProfileBulkDeleteRequest $AccessProfileBulkDeleteRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfilesInBulk" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile + + # Get an Access Profile + + try { + Get-V2024AccessProfile-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccessProfile -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + + # List Access Profile's Entitlements + + try { + Get-V2024AccessProfileEntitlements-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccessProfileEntitlements -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfileEntitlements" + Write-Host $_.ErrorDetails + } +- path: /access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin. (optional) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Composite operators supported: *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + + # List Access Profiles + + try { + Get-V2024AccessProfiles + + # Below is a request that includes all optional parameters + # Get-V2024AccessProfiles -V2024ForSubadmin $ForSubadmin -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters -V2024ForSegmentIds $ForSegmentIds -V2024IncludeUnsegmented $IncludeUnsegmented + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfiles" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Access Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AccessProfile-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AccessProfile -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/bulk-update-requestable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ + + + # Update Access Profile(s) requestable field. + + try { + $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner + Update-V2024AccessProfilesInBulk-V2024XSailPointExperimental $XSailPointExperimental -V2024AccessProfileBulkUpdateRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-V2024AccessProfilesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessProfileBulkUpdateRequestInner $AccessProfileBulkUpdateRequestInner + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AccessProfilesInBulk" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + } + "@ + + # Approve Access Request Approval + + try { + Approve-V2024AccessRequest-V2024ApprovalId $ApprovalId + + # Below is a request that includes all optional parameters + # Approve-V2024AccessRequest -V2024ApprovalId $ApprovalId -V2024CommentDto $CommentDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $ForwardApprovalDto = @" + { + "newOwnerId" : "2c91808568c529c60168cca6f90c1314", + "comment" : "2c91808568c529c60168cca6f90c1313" + } + "@ + + # Forward Access Request Approval + + try { + $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto + Invoke-V2024ForwardAccessRequest-V2024ApprovalId $ApprovalId -V2024ForwardApprovalDto $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024ForwardAccessRequest -V2024ApprovalId $ApprovalId -V2024ForwardApprovalDto $ForwardApprovalDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ForwardAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/approval-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + + # Get Access Requests Approvals Number + + try { + Get-V2024AccessRequestApprovalSummary + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestApprovalSummary -V2024OwnerId $OwnerId -V2024FromDate $FromDate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestApprovalSummary" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{accessRequestId}/approvers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessRequestId = "2c91808568c529c60168cca6f90c1313" # String | Access Request ID. + $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) + $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) + + # Access Request Approvers + + try { + Get-V2024AccessRequestApprovers-V2024AccessRequestId $AccessRequestId + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestApprovers -V2024AccessRequestId $AccessRequestId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestApprovers" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) + $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Completed Access Request Approvals List + + try { + Get-V2024CompletedApprovals + + # Below is a request that includes all optional parameters + # Get-V2024CompletedApprovals -V2024OwnerId $OwnerId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompletedApprovals" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/pending + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional) + $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Pending Access Request Approvals List + + try { + Get-V2024PendingApprovals + + # Below is a request that includes all optional parameters + # Get-V2024PendingApprovals -V2024OwnerId $OwnerId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingApprovals" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/reject + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + } + "@ + + # Reject Access Request Approval + + try { + $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto + Deny-V2024AccessRequest-V2024ApprovalId $ApprovalId -V2024CommentDto $Result + + # Below is a request that includes all optional parameters + # Deny-V2024AccessRequest -V2024ApprovalId $ApprovalId -V2024CommentDto $CommentDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID. + $RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID. + $Type = "ENTITLEMENT" # String | Requested access item's type. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Return access request identity metrics + + try { + Get-V2024AccessRequestIdentityMetrics-V2024IdentityId $IdentityId -V2024RequestedObjectId $RequestedObjectId -V2024Type $Type -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestIdentityMetrics -V2024IdentityId $IdentityId -V2024RequestedObjectId $RequestedObjectId -V2024Type $Type -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestIdentityMetrics" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/bulk-approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $BulkApproveAccessRequest = @" + { + "comment" : "I approve these request items", + "approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ] + } + "@ + + # Bulk Approve Access Request + + try { + $Result = ConvertFrom-JsonToBulkApproveAccessRequest -Json $BulkApproveAccessRequest + Approve-V2024BulkAccessRequest-V2024BulkApproveAccessRequest $Result + + # Below is a request that includes all optional parameters + # Approve-V2024BulkAccessRequest -V2024BulkApproveAccessRequest $BulkApproveAccessRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024BulkAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-requests/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CancelAccessRequest = @" + { + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + } + "@ + + # Cancel Access Request + + try { + $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest + Suspend-V2024AccessRequest-V2024CancelAccessRequest $Result + + # Below is a request that includes all optional parameters + # Suspend-V2024AccessRequest -V2024CancelAccessRequest $CancelAccessRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-requests/bulk-cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $BulkCancelAccessRequest = @" + { + "accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ], + "comment" : "I requested this role by mistake." + } + "@ + + # Bulk Cancel Access Request + + try { + $Result = ConvertFrom-JsonToBulkCancelAccessRequest -Json $BulkCancelAccessRequest + Suspend-V2024AccessRequestInBulk-V2024BulkCancelAccessRequest $Result + + # Below is a request that includes all optional parameters + # Suspend-V2024AccessRequestInBulk -V2024BulkCancelAccessRequest $BulkCancelAccessRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024AccessRequestInBulk" + Write-Host $_.ErrorDetails + } +- path: /access-requests/close + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CloseAccessRequest = @" + { + "executionStatus" : "Terminated", + "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "completionStatus" : "Failure", + "message" : "The IdentityNow Administrator manually closed this request." + } + "@ + + # Close Access Request + + try { + $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest + Close-V2024AccessRequest-V2024XSailPointExperimental $XSailPointExperimental -V2024CloseAccessRequest $Result + + # Below is a request that includes all optional parameters + # Close-V2024AccessRequest -V2024XSailPointExperimental $XSailPointExperimental -V2024CloseAccessRequest $CloseAccessRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-V2024AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessRequest = @" + { + "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + } ] + } + "@ + + # Submit Access Request + + try { + $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest + New-V2024AccessRequest-V2024AccessRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024AccessRequest -V2024AccessRequest $AccessRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Access Request Configuration + + try { + Get-V2024AccessRequestConfig + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /access-request-status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) + $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) + $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + $Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) + $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + # Access Request Status + + try { + Get-V2024AccessRequestStatus + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestStatus -V2024RequestedFor $RequestedFor -V2024RequestedBy $RequestedBy -V2024RegardingIdentity $RegardingIdentity -V2024AssignedTo $AssignedTo -V2024Count $Count -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters -V2024Sorters $Sorters -V2024RequestState $RequestState + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestStatus" + Write-Host $_.ErrorDetails + } +- path: /access-request-administration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) + $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) + $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + $Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **accessRequestId**: *in* **status**: *in, eq, ne* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name, accessRequestId** (optional) + $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + # Access Request Status for Administrators + + try { + Get-V2024AdministratorsAccessRequestStatus + + # Below is a request that includes all optional parameters + # Get-V2024AdministratorsAccessRequestStatus -V2024RequestedFor $RequestedFor -V2024RequestedBy $RequestedBy -V2024RegardingIdentity $RegardingIdentity -V2024AssignedTo $AssignedTo -V2024Count $Count -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters -V2024Sorters $Sorters -V2024RequestState $RequestState + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AdministratorsAccessRequestStatus" + Write-Host $_.ErrorDetails + } +- path: /access-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessRequestConfig = @" + { + "requestOnBehalfOfConfig" : { + "allowRequestOnBehalfOfEmployeeByManager" : true, + "allowRequestOnBehalfOfAnyoneByAnyone" : true + }, + "approvalReminderAndEscalationConfig" : { + "fallbackApproverRef" : { + "name" : "Alison Ferguso", + "id" : "5168015d32f890ca15812c9180835d2e", + "type" : "IDENTITY", + "email" : "alison.ferguso@identitysoon.com" + }, + "maxReminders" : 1, + "daysUntilEscalation" : 0, + "daysBetweenReminders" : 0 + }, + "autoApprovalEnabled" : true, + "entitlementRequestConfig" : { + "requestCommentsRequired" : false, + "deniedCommentsRequired" : false, + "allowEntitlementRequest" : true, + "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + }, + "reauthorizationEnabled" : true, + "approvalsMustBeExternal" : true + } + "@ + + # Update Access Request Configuration + + try { + $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig + Set-V2024AccessRequestConfig-V2024AccessRequestConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024AccessRequestConfig -V2024AccessRequestConfig $AccessRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024AccessRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /account-activities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id + + # Get an Account Activity + + try { + Get-V2024AccountActivity-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccountActivity -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountActivity" + Write-Host $_.ErrorDetails + } +- path: /account-activities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "2c91808568c529c60168cca6f90c1313" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c91808568c529c60168cca6f90c1313" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c91808568c529c60168cca6f90c1313" # String | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "type eq "Identity Refresh"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) + + # List Account Activities + + try { + Get-V2024AccountActivities + + # Below is a request that includes all optional parameters + # Get-V2024AccountActivities -V2024RequestedFor $RequestedFor -V2024RequestedBy $RequestedBy -V2024RegardingIdentity $RegardingIdentity -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountActivities" + Write-Host $_.ErrorDetails + } +- path: /account-aggregations/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # In-progress Account Aggregation status + + try { + Get-V2024AccountAggregationStatus-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccountAggregationStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountAggregationStatus" + Write-Host $_.ErrorDetails + } +- path: /accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccountAttributesCreate = @" + { + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Create Account + + try { + $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate + New-V2024Account-V2024AccountAttributesCreate $Result + + # Below is a request that includes all optional parameters + # New-V2024Account -V2024AccountAttributesCreate $AccountAttributesCreate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Delete Account + + try { + Remove-V2024Account-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Account -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Remove Account + + try { + Remove-V2024AccountAsync-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024AccountAsync -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountAsync" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Disable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Disable-V2024Account-V2024Id $Id -V2024AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Disable-V2024Account -V2024Id $Id -V2024AccountToggleRequest $AccountToggleRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024Account" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/{id}/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808384203c2d018437e631158309" # String | The identity id. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Disable IDN Account for Identity + + try { + Disable-V2024AccountForIdentity-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Disable-V2024AccountForIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountForIdentity" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentitiesAccountsBulkRequest = @" + { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } + "@ + + # Disable IDN Accounts for Identities + + try { + $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest + Disable-V2024AccountsForIdentities-V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result + + # Below is a request that includes all optional parameters + # Disable-V2024AccountsForIdentities -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountsForIdentities" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Enable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Enable-V2024Account-V2024Id $Id -V2024AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Enable-V2024Account -V2024Id $Id -V2024AccountToggleRequest $AccountToggleRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024Account" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/{id}/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808384203c2d018437e631158309" # String | The identity id. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Enable IDN Account for Identity + + try { + Enable-V2024AccountForIdentity-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Enable-V2024AccountForIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountForIdentity" + Write-Host $_.ErrorDetails + } +- path: /identities-accounts/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentitiesAccountsBulkRequest = @" + { + "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] + } + "@ + + # Enable IDN Accounts for Identities + + try { + $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest + Enable-V2024AccountsForIdentities-V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result + + # Below is a request that includes all optional parameters + # Enable-V2024AccountsForIdentities -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountsForIdentities" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Account Details + + try { + Get-V2024Account-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Account -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Account Entitlements + + try { + Get-V2024AccountEntitlements-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccountEntitlements -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountEntitlements" + Write-Host $_.ErrorDetails + } +- path: /accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) + $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + + # Accounts List + + try { + Get-V2024Accounts + + # Below is a request that includes all optional parameters + # Get-V2024Accounts -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024DetailLevel $DetailLevel -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Accounts" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $AccountAttributes = @" + { + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Update Account + + try { + $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes + Send-V2024Account-V2024Id $Id -V2024AccountAttributes $Result + + # Below is a request that includes all optional parameters + # Send-V2024Account -V2024Id $Id -V2024AccountAttributes $AccountAttributes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/reload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + + # Reload Account + + try { + Submit-V2024ReloadAccount-V2024Id $Id + + # Below is a request that includes all optional parameters + # Submit-V2024ReloadAccount -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReloadAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/unlock + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. + $AccountUnlockRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + } + "@ + + # Unlock Account + + try { + $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest + Unlock-V2024Account-V2024Id $Id -V2024AccountUnlockRequest $Result + + # Below is a request that includes all optional parameters + # Unlock-V2024Account -V2024Id $Id -V2024AccountUnlockRequest $AccountUnlockRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-V2024Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"[{op=remove, path=/identityId}]"@ + + + # Update Account + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2024Account-V2024Id $Id -V2024RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024Account -V2024Id $Id -V2024RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Account" + Write-Host $_.ErrorDetails + } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-V2024UsagesByAccountId-V2024AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-V2024UsagesByAccountId -V2024AccountId $AccountId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesByAccountId" + Write-Host $_.ErrorDetails + } +- path: /discovered-applications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) + $Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) + + # Get Discovered Applications for Tenant + + try { + Get-V2024DiscoveredApplications + + # Below is a request that includes all optional parameters + # Get-V2024DiscoveredApplications -V2024Limit $Limit -V2024Offset $Offset -V2024Detail $Detail -V2024Filter $Filter -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DiscoveredApplications" + Write-Host $_.ErrorDetails + } +- path: /manual-discover-applications-template + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Download CSV Template for Discovery + + try { + Get-V2024ManualDiscoverApplicationsCsvTemplate + + # Below is a request that includes all optional parameters + # Get-V2024ManualDiscoverApplicationsCsvTemplate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } +- path: /manual-discover-applications + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + + # Upload CSV to Discover Applications + + try { + Send-V2024ManualDiscoverApplicationsCsvTemplate-V2024File $File + + # Below is a request that includes all optional parameters + # Send-V2024ManualDiscoverApplicationsCsvTemplate -V2024File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } +- path: /generic-approvals/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that is to be returned + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get an approval + + try { + Get-V2024Approval-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Approval -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Approval" + Write-Host $_.ErrorDetails + } +- path: /generic-approvals + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Mine = $true # Boolean | Returns the list of approvals for the current caller (optional) + $RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID (optional) + $Filters = "filters=status eq PENDING" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* (optional) + + # Get Approvals + + try { + Get-V2024Approvals-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Approvals -V2024XSailPointExperimental $XSailPointExperimental -V2024Mine $Mine -V2024RequesterId $RequesterId -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Approvals" + Write-Host $_.ErrorDetails + } +- path: /source-apps + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceAppCreateDto = @" + { + "name" : "my app", + "description" : "the source app for engineers", + "accountSource" : { + "name" : "ODS-AD-Source", + "id" : "2c9180827ca885d7017ca8ce28a000eb", + "type" : "SOURCE" + }, + "matchAllAccounts" : true + } + "@ + + # Create source app + + try { + $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto + New-V2024SourceApp-V2024XSailPointExperimental $XSailPointExperimental -V2024SourceAppCreateDto $Result + + # Below is a request that includes all optional parameters + # New-V2024SourceApp -V2024XSailPointExperimental $XSailPointExperimental -V2024SourceAppCreateDto $SourceAppCreateDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id}/access-profiles/bulk-remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @"[c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9]"@ + + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + + # Bulk remove access profiles from the specified source app + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-V2024AccessProfilesFromSourceAppByBulk-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-V2024AccessProfilesFromSourceAppByBulk -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $RequestBody -V2024Limit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessProfilesFromSourceAppByBulk" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete source app by ID + + try { + Remove-V2024SourceApp-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024SourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get source app by ID + + try { + Get-V2024SourceApp-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id}/access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "name eq "developer access profile"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + # List access profiles for the specified source app + + try { + Get-V2024AccessProfilesForSourceApp-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessProfilesForSourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessProfilesForSourceApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/all + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) + $Filters = "enabled eq true" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) + + # List all source apps + + try { + Get-V2024AllSourceApp-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AllSourceApp -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllSourceApp" + Write-Host $_.ErrorDetails + } +- path: /user-apps/all + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List all user apps + + try { + Get-V2024AllUserApps-V2024Filters $Filters -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AllUserApps -V2024Filters $Filters -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllUserApps" + Write-Host $_.ErrorDetails + } +- path: /source-apps/assigned + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (optional) + $Filters = "name eq "source app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + # List assigned source apps + + try { + Get-V2024AssignedSourceApp-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AssignedSourceApp -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AssignedSourceApp" + Write-Host $_.ErrorDetails + } +- path: /user-apps/{id}/available-accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List available accounts for user app + + try { + Get-V2024AvailableAccountsForUserApp-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AvailableAccountsForUserApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AvailableAccountsForUserApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) + $Filters = "name eq "source app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) + + # List available source apps + + try { + Get-V2024AvailableSourceApps-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AvailableSourceApps -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AvailableSourceApps" + Write-Host $_.ErrorDetails + } +- path: /user-apps + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "name eq "user app name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) + + # List owned user apps + + try { + Get-V2024OwnedUserApps-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024OwnedUserApps -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OwnedUserApps" + Write-Host $_.ErrorDetails + } +- path: /source-apps/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app to patch + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch source app by ID + + try { + Update-V2024SourceApp-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024SourceApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceApp" + Write-Host $_.ErrorDetails + } +- path: /user-apps/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app to patch + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch user app by ID + + try { + Update-V2024UserApp-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024UserApp -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024UserApp" + Write-Host $_.ErrorDetails + } +- path: /source-apps/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceAppBulkUpdateRequest = @" + { + "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : false + }, { + "op" : "replace", + "path" : "/matchAllAccounts", + "value" : false + } ] + } + "@ + + # Bulk update source apps + + try { + Update-V2024SourceAppsInBulk-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024SourceAppsInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024SourceAppBulkUpdateRequest $SourceAppBulkUpdateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceAppsInBulk" + Write-Host $_.ErrorDetails + } +- path: /auth-profiles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. + + # Get Auth Profile. + + try { + Get-V2024ProfileConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ProfileConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProfileConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get list of Auth Profiles. + + try { + Get-V2024ProfileConfigList-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ProfileConfigList -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProfileConfigList" + Write-Host $_.ErrorDetails + } +- path: /auth-profiles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Auth Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ProfileConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ProfileConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProfileConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-users/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + + # Auth User Details + + try { + Get-V2024AuthUser-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AuthUser -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthUser" + Write-Host $_.ErrorDetails + } +- path: /auth-users/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Auth User Update + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthUser-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthUser -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthUser" + Write-Host $_.ErrorDetails + } +- path: /brandings + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "MyName" # String | name of branding item + $ProductName = "MyProductName" # String | product name + $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) + $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) + $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) + $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) + $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) + $FileStandard = # System.IO.FileInfo | png file with logo (optional) + + # Create a branding item + + try { + New-V2024BrandingItem-V2024Name $Name -V2024ProductName $ProductName + + # Below is a request that includes all optional parameters + # New-V2024BrandingItem -V2024Name $Name -V2024ProductName $ProductName -V2024ActionButtonColor $ActionButtonColor -V2024ActiveLinkColor $ActiveLinkColor -V2024NavigationColor $NavigationColor -V2024EmailFromAddress $EmailFromAddress -V2024LoginInformationalMessage $LoginInformationalMessage -V2024FileStandard $FileStandard + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024BrandingItem" + Write-Host $_.ErrorDetails + } +- path: /brandings/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "default" # String | The name of the branding item to be deleted + + # Delete a branding item + + try { + Remove-V2024Branding-V2024Name $Name + + # Below is a request that includes all optional parameters + # Remove-V2024Branding -V2024Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Branding" + Write-Host $_.ErrorDetails + } +- path: /brandings/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "default" # String | The name of the branding item to be retrieved + + # Get a branding item + + try { + Get-V2024Branding-V2024Name $Name + + # Below is a request that includes all optional parameters + # Get-V2024Branding -V2024Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Branding" + Write-Host $_.ErrorDetails + } +- path: /brandings + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List of branding items + + try { + Get-V2024BrandingList + + # Below is a request that includes all optional parameters + # Get-V2024BrandingList + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BrandingList" + Write-Host $_.ErrorDetails + } +- path: /brandings/{name} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "default" # String | The name of the branding item to be retrieved + $Name2 = "Name_example" # String | name of branding item + $ProductName = "MyProductName" # String | product name + $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) + $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) + $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) + $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) + $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) + $FileStandard = # System.IO.FileInfo | png file with logo (optional) + + # Update a branding item + + try { + Set-V2024BrandingItem-V2024Name $Name -V2024Name2 $Name2 -V2024ProductName $ProductName + + # Below is a request that includes all optional parameters + # Set-V2024BrandingItem -V2024Name $Name -V2024Name2 $Name2 -V2024ProductName $ProductName -V2024ActionButtonColor $ActionButtonColor -V2024ActiveLinkColor $ActiveLinkColor -V2024NavigationColor $NavigationColor -V2024EmailFromAddress $EmailFromAddress -V2024LoginInformationalMessage $LoginInformationalMessage -V2024FileStandard $FileStandard + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024BrandingItem" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CampaignFilterDetails = @" + { + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + } + "@ + + # Create Campaign Filter + + try { + $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails + New-V2024CampaignFilter-V2024CampaignFilterDetails $Result + + # Below is a request that includes all optional parameters + # New-V2024CampaignFilter -V2024CampaignFilterDetails $CampaignFilterDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CampaignFilter" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters/delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filters to delete. + $RequestBody = @""@ + + + # Deletes Campaign Filters + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-V2024CampaignFilters-V2024RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-V2024CampaignFilters -V2024RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignFilters" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved. + + # Get Campaign Filter by ID + + try { + Get-V2024CampaignFilterById-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CampaignFilterById -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignFilterById" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Start = 0 # Int32 | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $IncludeSystemFilters = $true # Boolean | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to $true) + + # List Campaign Filters + + try { + Get-V2024CampaignFilters + + # Below is a request that includes all optional parameters + # Get-V2024CampaignFilters -V2024Limit $Limit -V2024Start $Start -V2024IncludeSystemFilters $IncludeSystemFilters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignFilters" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FilterId = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter being modified. + $CampaignFilterDetails = @" + { + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + } + "@ + + # Updates a Campaign Filter + + try { + $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails + Update-V2024CampaignFilter-V2024FilterId $FilterId -V2024CampaignFilterDetails $Result + + # Below is a request that includes all optional parameters + # Update-V2024CampaignFilter -V2024FilterId $FilterId -V2024CampaignFilterDetails $CampaignFilterDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CampaignFilter" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/complete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $CampaignCompleteOptions = @" + { + "autoCompleteAction" : "REVOKE" + } + "@ + + # Complete a Campaign + + try { + Complete-V2024Campaign-V2024Id $Id + + # Below is a request that includes all optional parameters + # Complete-V2024Campaign -V2024Id $Id -V2024CampaignCompleteOptions $CampaignCompleteOptions + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Campaign = @" + { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + } + "@ + + # Create a campaign + + try { + $Result = ConvertFrom-JsonToCampaign -Json $Campaign + New-V2024Campaign-V2024Campaign $Result + + # Below is a request that includes all optional parameters + # New-V2024Campaign -V2024Campaign $Campaign + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CampaignTemplate = @" + { + "ownerRef" : { + "name" : "Mister Manager", + "id" : "2c918086676d3e0601677611dbde220f", + "type" : "IDENTITY", + "email" : "mr.manager@example.com" + }, + "deadlineDuration" : "P2W", + "created" : "2020-03-05T22:44:00.364Z", + "scheduled" : false, + "name" : "Manager Campaign Template", + "description" : "Template for the annual manager campaign.", + "modified" : "2020-03-05T22:52:09.969Z", + "campaign" : { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }, + "id" : "2c9079b270a266a60170a277bb960008" + } + "@ + + # Create a Campaign Template + + try { + $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate + New-V2024CampaignTemplate-V2024CampaignTemplate $Result + + # Below is a request that includes all optional parameters + # New-V2024CampaignTemplate -V2024CampaignTemplate $CampaignTemplate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. + + # Delete a Campaign Template + + try { + Remove-V2024CampaignTemplate-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024CampaignTemplate -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. + + # Delete Campaign Template Schedule + + try { + Remove-V2024CampaignTemplateSchedule-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024CampaignTemplateSchedule -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaigns/delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CampaignsDeleteRequest = @" + { + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + } + "@ + + # Delete Campaigns + + try { + $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest + Remove-V2024Campaigns-V2024CampaignsDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024Campaigns -V2024CampaignsDeleteRequest $CampaignsDeleteRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Campaigns" + Write-Host $_.ErrorDetails + } +- path: /campaigns + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Manager Campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) + + # List Campaigns + + try { + Get-V2024ActiveCampaigns + + # Below is a request that includes all optional parameters + # Get-V2024ActiveCampaigns -V2024Detail $Detail -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ActiveCampaigns" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + + # Get Campaign + + try { + Get-V2024Campaign-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Campaign -V2024Id $Id -V2024Detail $Detail + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/reports + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. + + # Get Campaign Reports + + try { + Get-V2024CampaignReports-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CampaignReports -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignReports" + Write-Host $_.ErrorDetails + } +- path: /campaigns/reports-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Campaign Reports Configuration + + try { + Get-V2024CampaignReportsConfig + + # Below is a request that includes all optional parameters + # Get-V2024CampaignReportsConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignReportsConfig" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. + + # Get a Campaign Template + + try { + Get-V2024CampaignTemplate-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CampaignTemplate -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. + + # Get Campaign Template Schedule + + try { + Get-V2024CampaignTemplateSchedule-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CampaignTemplateSchedule -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $Filters = "name eq "manager template"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + + # List Campaign Templates + + try { + Get-V2024CampaignTemplates + + # Below is a request that includes all optional parameters + # Get-V2024CampaignTemplates -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CampaignTemplates" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/reassign + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID + $AdminReviewReassign = @" + { + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } + } + "@ + + # Reassign Certifications + + try { + $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign + Move-V2024-V2024Id $Id -V2024AdminReviewReassign $Result + + # Below is a request that includes all optional parameters + # Move-V2024 -V2024Id $Id -V2024AdminReviewReassign $AdminReviewReassign + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-V2024" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update a Campaign Template + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024CampaignTemplate-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024CampaignTemplate -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaigns/reports-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CampaignReportsConfig = @" + { + "identityAttributeColumns" : [ "firstname", "lastname" ] + } + "@ + + # Set Campaign Reports Configuration + + try { + $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig + Set-V2024CampaignReportsConfig-V2024CampaignReportsConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024CampaignReportsConfig -V2024CampaignReportsConfig $CampaignReportsConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024CampaignReportsConfig" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template being scheduled. + $Schedule = @" + { + "hours" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "months" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "timeZoneId" : "CST", + "days" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "expiration" : "2000-01-23T04:56:07.000+00:00", + "type" : "WEEKLY" + } + "@ + + # Set Campaign Template Schedule + + try { + Set-V2024CampaignTemplateSchedule-V2024Id $Id + + # Below is a request that includes all optional parameters + # Set-V2024CampaignTemplateSchedule -V2024Id $Id -V2024Schedule $Schedule + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/activate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $ActivateCampaignOptions = @" + { + "timeZone" : "-05:00" + } + "@ + + # Activate a Campaign + + try { + Start-V2024Campaign-V2024Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024Campaign -V2024Id $Id -V2024ActivateCampaignOptions $ActivateCampaignOptions + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/run-remediation-scan + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. + + # Run Campaign Remediation Scan + + try { + Start-V2024CampaignRemediationScan-V2024Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024CampaignRemediationScan -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024CampaignRemediationScan" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/run-report/{type} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. + $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run. + + # Run Campaign Report + + try { + Start-V2024CampaignReport-V2024Id $Id -V2024Type $Type + + # Below is a request that includes all optional parameters + # Start-V2024CampaignReport -V2024Id $Id -V2024Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024CampaignReport" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/generate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. + + # Generate a Campaign from Template + + try { + Start-V2024GenerateCampaignTemplate-V2024Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024GenerateCampaignTemplate -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024GenerateCampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update a Campaign + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Campaign-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Campaign -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Campaign" + Write-Host $_.ErrorDetails + } +- path: /certification-tasks/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID + + # Certification Task by ID + + try { + Get-V2024CertificationTask-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CertificationTask -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CertificationTask" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id + + # Identity Certification by ID + + try { + Get-V2024IdentityCertification-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentityCertification -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertification" + Write-Host $_.ErrorDetails + } +- path: /certifications/{certificationId}/access-review-items/{itemId}/permissions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID + $Filters = "target eq "SYS.OBJAUTH2"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Permissions for Entitlement Certification Item + + try { + Get-V2024IdentityCertificationItemPermissions-V2024CertificationId $CertificationId -V2024ItemId $ItemId + + # Below is a request that includes all optional parameters + # Get-V2024IdentityCertificationItemPermissions -V2024CertificationId $CertificationId -V2024ItemId $ItemId -V2024Filters $Filters -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertificationItemPermissions" + Write-Host $_.ErrorDetails + } +- path: /certification-tasks + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReviewerIdentity = "Ada.1de82e55078344" # String | The ID of reviewer identity. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "type eq "ADMIN_REASSIGN"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) + + # List of Pending Certification Tasks + + try { + Get-V2024PendingCertificationTasks + + # Below is a request that includes all optional parameters + # Get-V2024PendingCertificationTasks -V2024ReviewerIdentity $ReviewerIdentity -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingCertificationTasks" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reviewers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) + + # List of Reviewers for certification + + try { + Get-V2024CertificationReviewers-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CertificationReviewers -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CertificationReviewers" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/access-review-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name,-accessProfile.sourceName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) + $Entitlements = "identityEntitlement" # String | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) + $AccessProfiles = "accessProfile1" # String | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) + $Roles = "userRole" # String | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) + + # List of Access Review Items + + try { + Get-V2024IdentityAccessReviewItems-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAccessReviewItems -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters -V2024Entitlements $Entitlements -V2024AccessProfiles $AccessProfiles -V2024Roles $Roles + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessReviewItems" + Write-Host $_.ErrorDetails + } +- path: /certifications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReviewerIdentity = "me" # String | Reviewer's identity. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) + $Sorters = "name,due" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) + + # List Identity Campaign Certifications + + try { + Get-V2024IdentityCertifications + + # Below is a request that includes all optional parameters + # Get-V2024IdentityCertifications -V2024ReviewerIdentity $ReviewerIdentity -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityCertifications" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decide + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campaign certification on which to make decisions + $ReviewDecision = @"{ + "comments" : "This user no longer needs access to this source", + "decision" : "APPROVE", + "proposedEndDate" : "2017-07-11T18:45:37.098Z", + "recommendation" : { + "reasons" : [ "Reason 1", "Reason 2" ], + "recommendation" : "recommendation", + "timestamp" : "2020-06-01T13:49:37.385Z" + }, + "id" : "ef38f94347e94562b5bb8424a56397d8", + "bulk" : true + }"@ + + + # Decide on a Certification Item + + try { + $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision + Select-V2024IdentityDecision-V2024Id $Id -V2024ReviewDecision $Result + + # Below is a request that includes all optional parameters + # Select-V2024IdentityDecision -V2024Id $Id -V2024ReviewDecision $ReviewDecision + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-V2024IdentityDecision" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reassign + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $ReviewReassign = @" + { + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + } + "@ + + # Reassign Identities or Items + + try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Invoke-V2024ReassignIdentityCertifications-V2024Id $Id -V2024ReviewReassign $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024ReassignIdentityCertifications -V2024Id $Id -V2024ReviewReassign $ReviewReassign + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ReassignIdentityCertifications" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/sign-off + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + + # Finalize Identity Certification Decisions + + try { + Invoke-V2024SignOffIdentityCertification-V2024Id $Id + + # Below is a request that includes all optional parameters + # Invoke-V2024SignOffIdentityCertification -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024SignOffIdentityCertification" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reassign-async + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $ReviewReassign = @" + { + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + } + "@ + + # Reassign Certifications Asynchronously + + try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Submit-V2024ReassignCertsAsync-V2024Id $Id -V2024ReviewReassign $Result + + # Below is a request that includes all optional parameters + # Submit-V2024ReassignCertsAsync -V2024Id $Id -V2024ReviewReassign $ReviewReassign + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReassignCertsAsync" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + + # Access Summaries + + try { + Get-V2024IdentityAccessSummaries-V2024Id $Id -V2024Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAccessSummaries -V2024Id $Id -V2024Type $Type -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-V2024IdentityDecisionSummary-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentityDecisionSummary -V2024Id $Id -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Identity Summaries for Campaign Certification + + try { + Get-V2024IdentitySummaries-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySummaries -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-V2024IdentitySummary-V2024Id $Id -V2024IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySummary -V2024Id $Id -V2024IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummary" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/deploys + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $DeployRequest = @" + { + "draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" + } + "@ + + # Create a Deploy + + try { + $Result = ConvertFrom-JsonToDeployRequest -Json $DeployRequest + New-V2024Deploy-V2024DeployRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024Deploy -V2024DeployRequest $DeployRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Deploy" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingRequest = @" + { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } + "@ + + # Creates an object mapping + + try { + $Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest + New-V2024ObjectMapping-V2024SourceOrg $SourceOrg -V2024ObjectMappingRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ObjectMapping -V2024SourceOrg $SourceOrg -V2024ObjectMappingRequest $ObjectMappingRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMapping" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-create + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingBulkCreateRequest = @" + { + "newObjectsMappings" : [ { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + }, { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } ] + } + "@ + + # Bulk creates object mappings + + try { + $Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest + New-V2024ObjectMappings-V2024SourceOrg $SourceOrg -V2024ObjectMappingBulkCreateRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ObjectMappings -V2024SourceOrg $SourceOrg -V2024ObjectMappingBulkCreateRequest $ObjectMappingBulkCreateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMappings" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Name = "MyName" # String | Name that will be assigned to the uploaded configuration file. + + # Upload a Configuration + + try { + New-V2024UploadedConfiguration-V2024Data $Data -V2024Name $Name + + # Below is a request that includes all optional parameters + # New-V2024UploadedConfiguration -V2024Data $Data -V2024Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024UploadedConfiguration" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the backup to delete. + + # Delete a Backup + + try { + Remove-V2024Backup-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Backup -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Backup" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/drafts/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the draft to delete. + + # Delete a draft + + try { + Remove-V2024Draft-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Draft -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Draft" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of the object mapping to be deleted. + + # Deletes an object mapping + + try { + Remove-V2024ObjectMapping-V2024SourceOrg $SourceOrg -V2024ObjectMappingId $ObjectMappingId + + # Below is a request that includes all optional parameters + # Remove-V2024ObjectMapping -V2024SourceOrg $SourceOrg -V2024ObjectMappingId $ObjectMappingId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ObjectMapping" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. + + # Delete an Uploaded Configuration + + try { + Remove-V2024UploadedConfiguration-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024UploadedConfiguration -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024UploadedConfiguration" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/deploys/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the deploy. + + # Get a Deploy + + try { + Get-V2024Deploy-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Deploy -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Deploy" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceOrg = "source-org" # String | The name of the source org. + + # Gets list of object mappings + + try { + Get-V2024ObjectMappings-V2024SourceOrg $SourceOrg + + # Below is a request that includes all optional parameters + # Get-V2024ObjectMappings -V2024SourceOrg $SourceOrg + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ObjectMappings" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. + + # Get an Uploaded Configuration + + try { + Get-V2024UploadedConfiguration-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024UploadedConfiguration -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UploadedConfiguration" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) + + # List Backups + + try { + Get-V2024Backups + + # Below is a request that includes all optional parameters + # Get-V2024Backups -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Backups" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/deploys + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Deploys + + try { + Get-V2024Deploys + + # Below is a request that includes all optional parameters + # Get-V2024Deploys + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Deploys" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/drafts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* (optional) + + # List Drafts + + try { + Get-V2024Drafts + + # Below is a request that includes all optional parameters + # Get-V2024Drafts -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Drafts" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) + + # List Uploaded Configurations + + try { + Get-V2024UploadedConfigurations + + # Below is a request that includes all optional parameters + # Get-V2024UploadedConfigurations -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UploadedConfigurations" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingBulkPatchRequest = @" + { + "patches" : { + "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : true + } ], + "00bece34-f50d-4227-8878-76f620b5a971" : [ { + "op" : "replace", + "path" : "/targetValue", + "value" : "New Target Value" + } ] + } + } + "@ + + # Bulk updates object mappings + + try { + $Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest + Update-V2024ObjectMappings-V2024SourceOrg $SourceOrg -V2024ObjectMappingBulkPatchRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024ObjectMappings -V2024SourceOrg $SourceOrg -V2024ObjectMappingBulkPatchRequest $ObjectMappingBulkPatchRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ObjectMappings" + Write-Host $_.ErrorDetails + } +- path: /connector-rules + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ConnectorRuleCreateRequest = @" + { + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "type" : "BuildMap" + } + "@ + + # Create Connector Rule + + try { + $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest + New-V2024ConnectorRule-V2024XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleCreateRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ConnectorRule -V2024XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleCreateRequest $ConnectorRuleCreateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete Connector Rule + + try { + Remove-V2024ConnectorRule-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024ConnectorRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to get. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Connector Rule + + try { + Get-V2024ConnectorRule-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Connector Rules + + try { + Get-V2024ConnectorRuleList-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorRuleList -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorRuleList" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to update. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ConnectorRuleUpdateRequest = @" + { + "sourceCode" : { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + }, + "signature" : { + "output" : { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, + "input" : [ { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + }, { + "name" : "firstName", + "description" : "the first name of the identity", + "type" : "String" + } ] + }, + "name" : "WebServiceBeforeOperationRule", + "description" : "This rule does that", + "attributes" : { }, + "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", + "type" : "BuildMap" + } + "@ + + # Update Connector Rule + + try { + Send-V2024ConnectorRule-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024ConnectorRuleUpdateRequest $ConnectorRuleUpdateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connector-rules/validate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceCode = @" + { + "version" : "1.0", + "script" : "return \"Mr. \" + firstName;" + } + "@ + + # Validate Connector Rule + + try { + $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode + Test-V2024ConnectorRule-V2024XSailPointExperimental $XSailPointExperimental -V2024SourceCode $Result + + # Below is a request that includes all optional parameters + # Test-V2024ConnectorRule -V2024XSailPointExperimental $XSailPointExperimental -V2024SourceCode $SourceCode + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ConnectorRule" + Write-Host $_.ErrorDetails + } +- path: /connectors + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $V3CreateConnectorDto = @" + { + "name" : "custom connector", + "directConnect" : true, + "className" : "sailpoint.connector.OpenConnectorAdapter", + "type" : "custom connector type", + "status" : "RELEASED" + } + "@ + + # Create Custom Connector + + try { + $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto + New-V2024CustomConnector-V2024V3CreateConnectorDto $Result + + # Below is a request that includes all optional parameters + # New-V2024CustomConnector -V2024V3CreateConnectorDto $V3CreateConnectorDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CustomConnector" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + # Delete Connector by Script Name + + try { + Remove-V2024CustomConnector-V2024ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Remove-V2024CustomConnector -V2024ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CustomConnector" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Get Connector by Script Name + + try { + Get-V2024Connector-V2024ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024Connector -V2024ScriptName $ScriptName -V2024Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Connector" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/correlation-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + + # Get Connector Correlation Configuration + + try { + Get-V2024ConnectorCorrelationConfig-V2024ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorCorrelationConfig -V2024ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorCorrelationConfig" + Write-Host $_.ErrorDetails + } +- path: /connectors + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "directConnect eq "true"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Get Connector List + + try { + Get-V2024ConnectorList + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorList -V2024Filters $Filters -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorList" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + # Get Connector Source Configuration + + try { + Get-V2024ConnectorSourceConfig-V2024ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorSourceConfig -V2024ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorSourceConfig" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-template + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + # Get Connector Source Template + + try { + Get-V2024ConnectorSourceTemplate-V2024ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorSourceTemplate -V2024ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorSourceTemplate" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/translations/{locale} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + + # Get Connector Translations + + try { + Get-V2024ConnectorTranslations-V2024ScriptName $ScriptName -V2024Locale $Locale + + # Below is a request that includes all optional parameters + # Get-V2024ConnectorTranslations -V2024ScriptName $ScriptName -V2024Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorTranslations" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/correlation-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + $File = # System.IO.FileInfo | connector correlation config xml file + + # Update Connector Correlation Configuration + + try { + Send-V2024ConnectorCorrelationConfig-V2024ScriptName $ScriptName -V2024File $File + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorCorrelationConfig -V2024ScriptName $ScriptName -V2024File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorCorrelationConfig" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $File = # System.IO.FileInfo | connector source config xml file + + # Update Connector Source Configuration + + try { + Send-V2024ConnectorSourceConfig-V2024ScriptName $ScriptName -V2024File $File + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorSourceConfig -V2024ScriptName $ScriptName -V2024File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorSourceConfig" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-template + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $File = # System.IO.FileInfo | connector source template xml file + + # Update Connector Source Template + + try { + Send-V2024ConnectorSourceTemplate-V2024ScriptName $ScriptName -V2024File $File + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorSourceTemplate -V2024ScriptName $ScriptName -V2024File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorSourceTemplate" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/translations/{locale} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + + # Update Connector Translations + + try { + Send-V2024ConnectorTranslations-V2024ScriptName $ScriptName -V2024Locale $Locale + + # Below is a request that includes all optional parameters + # Send-V2024ConnectorTranslations -V2024ScriptName $ScriptName -V2024Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorTranslations" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Connector by Script Name + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Connector-V2024ScriptName $ScriptName -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Connector -V2024ScriptName $ScriptName -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Connector" + Write-Host $_.ErrorDetails + } +- path: /form-definitions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Body = @" + { + "owner" : { + "name" : "Grant Smith", + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "formConditions" : [ { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + }, { + "ruleOperator" : "AND", + "effects" : [ { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + }, { + "config" : { + "defaultValueLabel" : "Access to Remove", + "element" : "8110662963316867" + }, + "effectType" : "HIDE" + } ], + "rules" : [ { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + }, { + "sourceType" : "ELEMENT", + "valueType" : "STRING", + "source" : "department", + "value" : "Engineering", + "operator" : "EQ" + } ] + } ], + "formInput" : [ { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + }, { + "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", + "id" : "00000000-0000-0000-0000-000000000000", + "label" : "input1", + "type" : "STRING" + } ], + "name" : "My form", + "description" : "My form description", + "usedBy" : [ { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + }, { + "name" : "Access Request Form", + "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", + "type" : "WORKFLOW" + } ], + "formElements" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "validations" : [ { + "validationType" : "REQUIRED" + }, { + "validationType" : "REQUIRED" + } ], + "elementType" : "TEXT", + "config" : { + "label" : "Department" + }, + "key" : "department" + } ] + } + "@ + + # Creates a form definition. + + try { + New-V2024FormDefinition-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2024FormDefinition -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinition" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/forms-action-dynamic-schema + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Body = @" + { + "description" : "A description", + "attributes" : { + "formDefinitionId" : "00000000-0000-0000-0000-000000000000" + }, + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "action", + "versionNumber" : 1 + } + "@ + + # Generate JSON Schema dynamically. + + try { + New-V2024FormDefinitionDynamicSchema-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2024FormDefinitionDynamicSchema -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionDynamicSchema" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID}/upload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $File = # System.IO.FileInfo | File specifying the multipart + + # Upload new form definition file. + + try { + New-V2024FormDefinitionFileRequest-V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024File $File + + # Below is a request that includes all optional parameters + # New-V2024FormDefinitionFileRequest -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormDefinitionFileRequest" + Write-Host $_.ErrorDetails + } +- path: /form-instances + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Body = @" + { + "formInput" : { + "input1" : "Sales" + }, + "standAloneForm" : false, + "createdBy" : { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "WORKFLOW_EXECUTION" + }, + "recipients" : [ { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + }, { + "id" : "00000000-0000-0000-0000-000000000000", + "type" : "IDENTITY" + } ], + "expire" : "2023-08-12T20:14:57.74486Z", + "formDefinitionId" : "00000000-0000-0000-0000-000000000000", + "state" : "ASSIGNED", + "ttl" : 1571827560 + } + "@ + + # Creates a form instance. + + try { + New-V2024FormInstance-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2024FormInstance -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024FormInstance" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Deletes a form definition. + + try { + Remove-V2024FormDefinition-V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024FormDefinition -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024FormDefinition" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + $Filters = "name sw "my form"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") + + # List form definitions by tenant. + + try { + Export-V2024FormDefinitionsByTenant-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2024FormDefinitionsByTenant -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024FormDefinitionsByTenant" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID}/file/{fileID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID Form definition ID + $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Download definition file by fileId. + + try { + Get-V2024FileFromS3-V2024FormDefinitionID $FormDefinitionID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024FileFromS3 -V2024FormDefinitionID $FormDefinitionID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FileFromS3" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Return a form definition. + + try { + Get-V2024FormDefinitionByKey-V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024FormDefinitionByKey -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormDefinitionByKey" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Returns a form instance. + + try { + Get-V2024FormInstanceByKey-V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024FormInstanceByKey -V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceByKey" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID}/file/{fileID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | FormInstanceID Form instance ID + $FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Download instance file by fileId. + + try { + Get-V2024FormInstanceFile-V2024FormInstanceID $FormInstanceID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024FormInstanceFile -V2024FormInstanceID $FormInstanceID -V2024FileID $FileID -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FormInstanceFile" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + + + + + + $Body = @"[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]"@ + + + # Import form definitions from export. + + try { + Import-V2024FormDefinitions-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Import-V2024FormDefinitions -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024FormDefinitions" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) + $Body = @"[{op=replace, path=/description, value=test-description}]"@ + + + # Patch a form definition. + + try { + Update-V2024FormDefinition-V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024FormDefinition -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormDefinition" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Body = @{ key_example = } # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) + $Body = @"[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]"@ + + + # Patch a form instance. + + try { + Update-V2024FormInstance-V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024FormInstance -V2024FormInstanceID $FormInstanceID -V2024XSailPointExperimental $XSailPointExperimental -V2024Body $Body + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024FormInstance" + Write-Host $_.ErrorDetails + } +- path: /form-definitions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 250 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + $Filters = "name sw "my form"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") + + # Export form definitions by tenant. + + try { + Search-V2024FormDefinitionsByTenant-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Search-V2024FormDefinitionsByTenant -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormDefinitionsByTenant" + Write-Host $_.ErrorDetails + } +- path: /form-instances/{formInstanceID}/data-source/{formElementID} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID + $FormElementID = "1" # String | Form element ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + $Filters = "value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) + $Query = "support" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) + + # Retrieves dynamic data by element. + + try { + Search-V2024FormElementDataByElementID-V2024FormInstanceID $FormInstanceID -V2024FormElementID $FormElementID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Search-V2024FormElementDataByElementID -V2024FormInstanceID $FormInstanceID -V2024FormElementID $FormElementID -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Filters $Filters -V2024Query $Query + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormElementDataByElementID" + Write-Host $_.ErrorDetails + } +- path: /form-instances + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List form instances by tenant. + + try { + Search-V2024FormInstancesByTenant-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Search-V2024FormInstancesByTenant -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024FormInstancesByTenant" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/predefined-select-options + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List predefined select options. + + try { + Search-V2024PreDefinedSelectOptions-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Search-V2024PreDefinedSelectOptions -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PreDefinedSelectOptions" + Write-Host $_.ErrorDetails + } +- path: /form-definitions/{formDefinitionID}/data-source + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 10 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) + $Filters = "value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` (optional) + $Query = "ac" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) + $FormElementPreviewRequest = @" + { + "dataSource" : { + "config" : { + "indices" : [ "identities" ], + "query" : "*", + "aggregationBucketField" : "attributes.cloudStatus.exact", + "objectType" : "IDENTITY" + }, + "dataSourceType" : "STATIC" + } + } + "@ + + # Preview form definition data source. + + try { + Show-V2024PreviewDataSource-V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Show-V2024PreviewDataSource -V2024FormDefinitionID $FormDefinitionID -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Filters $Filters -V2024Query $Query -V2024FormElementPreviewRequest $FormElementPreviewRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024PreviewDataSource" + Write-Host $_.ErrorDetails + } +- path: /custom-password-instructions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CustomPasswordInstruction = @" + { + "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", + "pageId" : "change-password:enter-password", + "locale" : "en" + } + "@ + + # Create Custom Password Instructions + + try { + $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction + New-V2024CustomPasswordInstructions-V2024XSailPointExperimental $XSailPointExperimental -V2024CustomPasswordInstruction $Result + + # Below is a request that includes all optional parameters + # New-V2024CustomPasswordInstructions -V2024XSailPointExperimental $XSailPointExperimental -V2024CustomPasswordInstruction $CustomPasswordInstruction + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CustomPasswordInstructions" + Write-Host $_.ErrorDetails + } +- path: /custom-password-instructions/{pageId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to delete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) + + # Delete Custom Password Instructions by page ID + + try { + Remove-V2024CustomPasswordInstructions-V2024PageId $PageId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024CustomPasswordInstructions -V2024PageId $PageId -V2024XSailPointExperimental $XSailPointExperimental -V2024Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024CustomPasswordInstructions" + Write-Host $_.ErrorDetails + } +- path: /custom-password-instructions/{pageId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PageId = "change-password:enter-password" # String | The page ID of custom password instructions to query. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) + + # Get Custom Password Instructions by Page ID + + try { + Get-V2024CustomPasswordInstructions-V2024PageId $PageId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024CustomPasswordInstructions -V2024PageId $PageId -V2024XSailPointExperimental $XSailPointExperimental -V2024Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomPasswordInstructions" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $Dimension = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "name" : "Dimension 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "id" : "2c918086749d78830174a1a40e121518", + "membership" : { + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + } ], + "operation" : "EQUALS", + "key" : { + "property" : "attribute.email", + "type" : "IDENTITY" + } + }, + "type" : "STANDARD" + }, + "parentId" : "2c918086749d78830174a1a40e121518" + } + "@ + + # Create a Dimension + + try { + $Result = ConvertFrom-JsonToDimension -Json $Dimension + New-V2024Dimension-V2024RoleId $RoleId -V2024Dimension $Result + + # Below is a request that includes all optional parameters + # New-V2024Dimension -V2024RoleId $RoleId -V2024Dimension $Dimension + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Dimension" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimensions. + $DimensionBulkDeleteRequest = @" + { + "dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } + "@ + + # Delete Dimension(s) + + try { + $Result = ConvertFrom-JsonToDimensionBulkDeleteRequest -Json $DimensionBulkDeleteRequest + Remove-V2024BulkDimensions-V2024RoleId $RoleId -V2024DimensionBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024BulkDimensions -V2024RoleId $RoleId -V2024DimensionBulkDeleteRequest $DimensionBulkDeleteRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024BulkDimensions" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions/{dimensionId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + + # Delete a Dimension + + try { + Remove-V2024Dimension-V2024RoleId $RoleId -V2024DimensionId $DimensionId + + # Below is a request that includes all optional parameters + # Remove-V2024Dimension -V2024RoleId $RoleId -V2024DimensionId $DimensionId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Dimension" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions/{dimensionId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + + # Get a Dimension under Role. + + try { + Get-V2024Dimension-V2024RoleId $RoleId -V2024DimensionId $DimensionId + + # Below is a request that includes all optional parameters + # Get-V2024Dimension -V2024RoleId $RoleId -V2024DimensionId $DimensionId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Dimension" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions/{dimensionId}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + + # List Dimension's Entitlements + + try { + Get-V2024DimensionEntitlements-V2024RoleId $RoleId -V2024DimensionId $DimensionId + + # Below is a request that includes all optional parameters + # Get-V2024DimensionEntitlements -V2024RoleId $RoleId -V2024DimensionId $DimensionId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DimensionEntitlements" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions/{dimensionId}/access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | ID of the Dimension + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "source.id eq "2c91808982f979270182f99e386d00fa"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + + # List Dimension's Access Profiles + + try { + Get-V2024DimensionAccessProfiles-V2024RoleId $RoleId -V2024DimensionId $DimensionId + + # Below is a request that includes all optional parameters + # Get-V2024DimensionAccessProfiles -V2024RoleId $RoleId -V2024DimensionId $DimensionId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DimensionAccessProfiles" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq '2c918086749d78830174a1a40e121518'" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + + # List Dimensions + + try { + Get-V2024Dimensions-V2024RoleId $RoleId + + # Below is a request that includes all optional parameters + # Get-V2024Dimensions -V2024RoleId $RoleId -V2024ForSubadmin $ForSubadmin -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Dimensions" + Write-Host $_.ErrorDetails + } +- path: /roles/{roleId}/dimensions/{dimensionId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. + $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Dimension + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Dimension-V2024RoleId $RoleId -V2024DimensionId $DimensionId -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Dimension -V2024RoleId $RoleId -V2024DimensionId $DimensionId -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Dimension" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Add metadata to an entitlement. + + try { + New-V2024AccessModelMetadataForEntitlement-V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2024AccessModelMetadataForEntitlement -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AccessModelMetadataForEntitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Remove metadata from an entitlement. + + try { + Remove-V2024AccessModelMetadataFromEntitlement-V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024AccessModelMetadataFromEntitlement -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccessModelMetadataFromEntitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get an entitlement + + try { + Get-V2024Entitlement-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Entitlement -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/entitlement-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Entitlement Request Config + + try { + Get-V2024EntitlementRequestConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementRequestConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /entitlements/aggregate/sources/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) + + # Aggregate Entitlements + + try { + Import-V2024EntitlementsBySource-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Import-V2024EntitlementsBySource -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024CsvFile $CsvFile + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024EntitlementsBySource" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/children + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + # List of entitlements children + + try { + Get-V2024EntitlementChildren-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementChildren -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChildren" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/parents + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) + + # List of entitlements parents + + try { + Get-V2024EntitlementParents-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementParents -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementParents" + Write-Host $_.ErrorDetails + } +- path: /entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) + $SegmentedForIdentity = "me" # String | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) + $ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) + $IncludeUnsegmented = $true # Boolean | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to $true) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) + + # Gets a list of entitlements. + + try { + Get-V2024Entitlements-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Entitlements -V2024XSailPointExperimental $XSailPointExperimental -V2024AccountId $AccountId -V2024SegmentedForIdentity $SegmentedForIdentity -V2024ForSegmentIds $ForSegmentIds -V2024IncludeUnsegmented $IncludeUnsegmented -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Entitlements" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch an entitlement + + try { + Update-V2024Entitlement-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024Entitlement -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Entitlement" + Write-Host $_.ErrorDetails + } +- path: /entitlements/{id}/entitlement-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $EntitlementRequestConfig = @" + { + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + } + "@ + + # Replace Entitlement Request Config + + try { + $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig + Send-V2024EntitlementRequestConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024EntitlementRequestConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024EntitlementRequestConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024EntitlementRequestConfig $EntitlementRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024EntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /entitlements/reset/sources/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Reset Source Entitlements + + try { + Reset-V2024SourceEntitlements-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Reset-V2024SourceEntitlements -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024SourceEntitlements" + Write-Host $_.ErrorDetails + } +- path: /entitlements/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $EntitlementBulkUpdateRequest = @" + { + "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], + "jsonPatch" : [ { + "op" : "replace", + "path" : "/privileged", + "value" : false + }, { + "op" : "replace", + "path" : "/requestable", + "value" : false + } ] + } + "@ + + # Bulk update an entitlement list + + try { + $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest + Update-V2024EntitlementsInBulk-V2024XSailPointExperimental $XSailPointExperimental -V2024EntitlementBulkUpdateRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024EntitlementsInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024EntitlementBulkUpdateRequest $EntitlementBulkUpdateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsInBulk" + Write-Host $_.ErrorDetails + } +- path: /auth-org/network-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $NetworkConfiguration = @" + { + "range" : [ "1.3.7.2", "255.255.255.252/30" ], + "whitelisted" : true, + "geolocation" : [ "CA", "FR", "HT" ] + } + "@ + + # Create security network configuration. + + try { + $Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration + New-V2024AuthOrgNetworkConfig-V2024NetworkConfiguration $Result + + # Below is a request that includes all optional parameters + # New-V2024AuthOrgNetworkConfig -V2024NetworkConfiguration $NetworkConfiguration + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/network-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get security network configuration. + + try { + Get-V2024AuthOrgNetworkConfig + + # Below is a request that includes all optional parameters + # Get-V2024AuthOrgNetworkConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/network-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update security network configuration. + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthOrgNetworkConfig-V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthOrgNetworkConfig -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } +- path: /workgroups + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $WorkgroupDto = @" + { + "owner" : { + "emailAddress" : "support@sailpoint.com", + "displayName" : "Support", + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "connectionCount" : 1641498673000, + "created" : "2022-01-06T19:51:13Z", + "memberCount" : 1641498673000, + "name" : "DB Access Governance Group", + "description" : "Description of the Governance Group", + "modified" : "2022-01-06T19:51:13Z", + "id" : "2c91808568c529c60168cca6f90c1313" + } + "@ + + # Create a new Governance Group. + + try { + $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto + New-V2024Workgroup-V2024XSailPointExperimental $XSailPointExperimental -V2024WorkgroupDto $Result + + # Below is a request that includes all optional parameters + # New-V2024Workgroup -V2024XSailPointExperimental $XSailPointExperimental -V2024WorkgroupDto $WorkgroupDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete a Governance Group + + try { + Remove-V2024Workgroup-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/members/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityPreviewResponseIdentity = @""@ + + + # Remove members from Governance Group + + try { + $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity + Remove-V2024WorkgroupMembers-V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result + + # Below is a request that includes all optional parameters + # Remove-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $IdentityPreviewResponseIdentity + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupMembers" + Write-Host $_.ErrorDetails + } +- path: /workgroups/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $WorkgroupBulkDeleteRequest = @" + { + "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] + } + "@ + + # Delete Governance Group(s) + + try { + $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest + Remove-V2024WorkgroupsInBulk-V2024XSailPointExperimental $XSailPointExperimental -V2024WorkgroupBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024WorkgroupsInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024WorkgroupBulkDeleteRequest $WorkgroupBulkDeleteRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024WorkgroupsInBulk" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Governance Group by Id + + try { + Get-V2024Workgroup-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/connections + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + + # List connections for Governance Group + + try { + Get-V2024Connections-V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Connections -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Connections" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/members + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + + # List Governance Group Members + + try { + Get-V2024WorkgroupMembers-V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkgroupMembers" + Write-Host $_.ErrorDetails + } +- path: /workgroups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw "Test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional) + + # List Governance Groups + + try { + Get-V2024Workgroups-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Workgroups -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workgroups" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Governance Group + + try { + Update-V2024Workgroup-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Update-V2024Workgroup -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workgroup" + Write-Host $_.ErrorDetails + } +- path: /workgroups/{workgroupId}/members/bulk-add + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityPreviewResponseIdentity = @""@ + + + # Add members to Governance Group + + try { + $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity + Update-V2024WorkgroupMembers-V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $Result + + # Below is a request that includes all optional parameters + # Update-V2024WorkgroupMembers -V2024WorkgroupId $WorkgroupId -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityPreviewResponseIdentity $IdentityPreviewResponseIdentity + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024WorkgroupMembers" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/ignored-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessRequestRecommendationActionItemDto = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Notification of Ignored Access Request Recommendations + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-V2024AccessRequestRecommendationsIgnoredItem-V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-V2024AccessRequestRecommendationsIgnoredItem -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsIgnoredItem" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/requested-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessRequestRecommendationActionItemDto = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Notification of Requested Access Request Recommendations + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-V2024AccessRequestRecommendationsRequestedItem-V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-V2024AccessRequestRecommendationsRequestedItem -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsRequestedItem" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/viewed-items + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessRequestRecommendationActionItemDto = @" + { + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + } + "@ + + # Notification of Viewed Access Request Recommendations + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-V2024AccessRequestRecommendationsViewedItem-V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-V2024AccessRequestRecommendationsViewedItem -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsViewedItem" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/viewed-items/bulk-create + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessRequestRecommendationActionItemDto = @"{ + "access" : { + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, + "identityId" : "2c91808570313110017040b06f344ec9" + }"@ + + + # Notification of Viewed Access Request Recommendations in Bulk + + try { + $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto + Add-V2024AccessRequestRecommendationsViewedItems-V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $Result + + # Below is a request that includes all optional parameters + # Add-V2024AccessRequestRecommendationsViewedItems -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-V2024AccessRequestRecommendationsViewedItems" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityId = "2c91808570313110017040b06f344ec9" # String | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") + $Limit = 56 # Int32 | Max number of results to return. (optional) (default to 15) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $IncludeTranslationMessages = $false # Boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to $false) + $Filters = "access.name co "admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) + + # Identity Access Request Recommendations + + try { + Get-V2024AccessRequestRecommendations-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestRecommendations -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityId $IdentityId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024IncludeTranslationMessages $IncludeTranslationMessages -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendations" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/ignored-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "identityId eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + + # List of Ignored Access Request Recommendations + + try { + Get-V2024AccessRequestRecommendationsIgnoredItems-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestRecommendationsIgnoredItems -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsIgnoredItems" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/requested-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + + # List of Requested Access Request Recommendations + + try { + Get-V2024AccessRequestRecommendationsRequestedItems-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestRecommendationsRequestedItems -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsRequestedItems" + Write-Host $_.ErrorDetails + } +- path: /ai-access-request-recommendations/viewed-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) + + # List of Viewed Access Request Recommendations + + try { + Get-V2024AccessRequestRecommendationsViewedItems-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AccessRequestRecommendationsViewedItems -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsViewedItems" + Write-Host $_.ErrorDetails + } +- path: /common-access + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CommonAccessItemRequest = @" + { + "access" : { + "ownerName" : "ownerName", + "name" : "name", + "description" : "description", + "id" : "id", + "type" : "ACCESS_PROFILE", + "ownerId" : "ownerId" + }, + "status" : "CONFIRMED" + } + "@ + + # Create common access items + + try { + $Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest + New-V2024CommonAccess-V2024XSailPointExperimental $XSailPointExperimental -V2024CommonAccessItemRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024CommonAccess -V2024XSailPointExperimental $XSailPointExperimental -V2024CommonAccessItemRequest $CommonAccessItemRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024CommonAccess" + Write-Host $_.ErrorDetails + } +- path: /common-access + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.type eq "ROLE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) + + # Get a paginated list of common access + + try { + Get-V2024CommonAccess-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024CommonAccess -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CommonAccess" + Write-Host $_.ErrorDetails + } +- path: /common-access/update-status + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CommonAccessIDStatus = @"{ + "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], + "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] + }"@ + + + # Bulk update common access status + + try { + $Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus + Update-V2024CommonAccessStatusInBulk-V2024XSailPointExperimental $XSailPointExperimental -V2024CommonAccessIDStatus $Result + + # Below is a request that includes all optional parameters + # Update-V2024CommonAccessStatusInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024CommonAccessIDStatus $CommonAccessIDStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024CommonAccessStatusInBulk" + Write-Host $_.ErrorDetails + } +- path: /outliers/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + + # IAI Identity Outliers Export + + try { + Export-V2024OutliersZip-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2024OutliersZip -V2024XSailPointExperimental $XSailPointExperimental -V2024Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024OutliersZip" + Write-Host $_.ErrorDetails + } +- path: /outlier-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + $Filters = "snapshotDate ge "2022-02-07T20:13:29.356648026Z"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* (optional) + $Sorters = "snapshotDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** (optional) + + # IAI Identity Outliers Summary + + try { + Get-V2024IdentityOutlierSnapshots-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityOutlierSnapshots -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Type $Type -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOutlierSnapshots" + Write-Host $_.ErrorDetails + } +- path: /outliers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + $Filters = "attributes.displayName sw "John" and certStatus eq "false"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) + $Sorters = "attributes.displayName,firstDetectionDate,-score" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** (optional) + + # IAI Get Identity Outliers + + try { + Get-V2024IdentityOutliers-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityOutliers -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Type $Type -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOutliers" + Write-Host $_.ErrorDetails + } +- path: /outlier-summaries/latest + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) + + # IAI Identity Outliers Latest Summary + + try { + Get-V2024LatestIdentityOutlierSnapshots-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024LatestIdentityOutlierSnapshots -V2024XSailPointExperimental $XSailPointExperimental -V2024Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LatestIdentityOutlierSnapshots" + Write-Host $_.ErrorDetails + } +- path: /outlier-feature-summaries/{outlierFeatureId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OutlierFeatureId = "04654b66-7561-4090-94f9-abee0722a1af" # String | Contributing feature id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get identity outlier contibuting feature summary + + try { + Get-V2024OutlierContributingFeatureSummary-V2024OutlierFeatureId $OutlierFeatureId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024OutlierContributingFeatureSummary -V2024OutlierFeatureId $OutlierFeatureId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OutlierContributingFeatureSummary" + Write-Host $_.ErrorDetails + } +- path: /outliers/{outlierId}/contributing-features + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $IncludeTranslationMessages = "include-translation-messages=" # String | Whether or not to include translation messages object in returned response (optional) + $Sorters = "importance" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** (optional) + + # Get identity outlier's contibuting features + + try { + Get-V2024PeerGroupOutliersContributingFeatures-V2024OutlierId $OutlierId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PeerGroupOutliersContributingFeatures -V2024OutlierId $OutlierId -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024IncludeTranslationMessages $IncludeTranslationMessages -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PeerGroupOutliersContributingFeatures" + Write-Host $_.ErrorDetails + } +- path: /outliers/ignore + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ + + + # IAI Identity Outliers Ignore + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Invoke-V2024IgnoreIdentityOutliers-V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024IgnoreIdentityOutliers -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024IgnoreIdentityOutliers" + Write-Host $_.ErrorDetails + } +- path: /outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id + $ContributingFeatureName = "radical_entitlement_count" # String | The name of contributing feature + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $AccessType = "ENTITLEMENT" # String | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) + $Sorters = "displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) + + # Gets a list of access items associated with each identity outlier contributing feature + + try { + Get-V2024OutliersContributingFeatureAccessItems-V2024OutlierId $OutlierId -V2024ContributingFeatureName $ContributingFeatureName -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024OutliersContributingFeatureAccessItems -V2024OutlierId $OutlierId -V2024ContributingFeatureName $ContributingFeatureName -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024AccessType $AccessType -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OutliersContributingFeatureAccessItems" + Write-Host $_.ErrorDetails + } +- path: /outliers/unignore + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = "MyRequestBody" # String[] | + $RequestBody = @""@ + + + # IAI Identity Outliers Unignore + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Invoke-V2024UnIgnoreIdentityOutliers-V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024UnIgnoreIdentityOutliers -V2024XSailPointExperimental $XSailPointExperimental -V2024RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnIgnoreIdentityOutliers" + Write-Host $_.ErrorDetails + } +- path: /peer-group-strategies/{strategy}/identity-outliers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Strategy = "entitlement" # String | The strategy used to create peer groups. Currently, 'entitlement' is supported. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Identity Outliers List + + try { + Get-V2024PeerGroupOutliers-V2024Strategy $Strategy -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PeerGroupOutliers -V2024Strategy $Strategy -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PeerGroupOutliers" + Write-Host $_.ErrorDetails + } +- path: /recommendations/request + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RecommendationRequestDto = @" + { + "prescribeMode" : false, + "excludeInterpretations" : false, + "requests" : [ { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + }, { + "item" : { + "id" : "2c938083633d259901633d2623ec0375", + "type" : "ENTITLEMENT" + }, + "identityId" : "2c938083633d259901633d25c68c00fa" + } ], + "includeTranslationMessages" : false, + "includeDebugInformation" : true + } + "@ + + # Returns a Recommendation Based on Object + + try { + $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto + Get-V2024Recommendations-V2024XSailPointExperimental $XSailPointExperimental -V2024RecommendationRequestDto $Result + + # Below is a request that includes all optional parameters + # Get-V2024Recommendations -V2024XSailPointExperimental $XSailPointExperimental -V2024RecommendationRequestDto $RecommendationRequestDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Recommendations" + Write-Host $_.ErrorDetails + } +- path: /recommendations/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get certification recommendation config values + + try { + Get-V2024RecommendationsConfig-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RecommendationsConfig -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RecommendationsConfig" + Write-Host $_.ErrorDetails + } +- path: /recommendations/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RecommendationConfigDto = @" + { + "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], + "peerGroupPercentageThreshold" : 0.5, + "runAutoSelectOnce" : false, + "onlyTuneThreshold" : false + } + "@ + + # Update certification recommendation config values + + try { + $Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto + Update-V2024RecommendationsConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024RecommendationConfigDto $Result + + # Below is a request that includes all optional parameters + # Update-V2024RecommendationsConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024RecommendationConfigDto $RecommendationConfigDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RecommendationsConfig" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $MinEntitlementPopularity = 56 # Int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to $true) + $RoleMiningPotentialRoleProvisionRequest = @" + { + "includeIdentities" : true, + "roleName" : "Finance - Accounting", + "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", + "roleDescription" : "General access for accounting department", + "directlyAssignedEntitlements" : false + } + "@ + + # Create request to provision a potential role into an actual role. + + try { + New-V2024PotentialRoleProvisionRequest-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2024PotentialRoleProvisionRequest -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024MinEntitlementPopularity $MinEntitlementPopularity -V2024IncludeCommonAccess $IncludeCommonAccess -V2024RoleMiningPotentialRoleProvisionRequest $RoleMiningPotentialRoleProvisionRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PotentialRoleProvisionRequest" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RoleMiningSessionDto = @" + { + "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", + "prescribedPruneThreshold" : 10, + "pruneThreshold" : 50, + "saved" : true, + "potentialRolesReadyCount" : 0, + "scope" : { + "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], + "attributeFilterCriteria" : { + "displayName" : { + "untranslated" : "Location: Miami" + }, + "ariaLabel" : { + "untranslated" : "Location: Miami" + }, + "data" : { + "displayName" : { + "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" + }, + "name" : "location", + "operator" : "EQUALS", + "values" : [ "Miami" ] + } + }, + "criteria" : "source.name:DataScienceDataset" + }, + "potentialRoleCount" : 0, + "name" : "Saved RM Session - 07/10", + "minNumIdentitiesInPotentialRole" : 20, + "identityCount" : 0, + "type" : "SPECIALIZED" + } + "@ + + # Create a role mining session + + try { + $Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto + New-V2024RoleMiningSessions-V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningSessionDto $Result + + # Below is a request that includes all optional parameters + # New-V2024RoleMiningSessions -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningSessionDto $RoleMiningSessionDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024RoleMiningSessions" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session + $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Export (download) details for a potential role in a role mining session + + try { + Invoke-V2024DownloadRoleMiningPotentialRoleZip-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024ExportId $ExportId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Invoke-V2024DownloadRoleMiningPotentialRoleZip -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024ExportId $ExportId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024DownloadRoleMiningPotentialRoleZip" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Export (download) details for a potential role in a role mining session + + try { + Export-V2024RoleMiningPotentialRole-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2024RoleMiningPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RoleMiningPotentialRoleExportRequest = @" + { + "minEntitlementPopularity" : 0, + "includeCommonAccess" : true + } + "@ + + # Asynchronously export details for a potential role in a role mining session and upload to S3 + + try { + Export-V2024RoleMiningPotentialRoleAsync-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2024RoleMiningPotentialRoleAsync -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleExportRequest $RoleMiningPotentialRoleExportRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRoleAsync" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session + $ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Retrieve status of a potential role export job + + try { + Export-V2024RoleMiningPotentialRoleStatus-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024ExportId $ExportId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Export-V2024RoleMiningPotentialRoleStatus -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024ExportId $ExportId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024RoleMiningPotentialRoleStatus" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) + $Filters = "(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true))" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all potential role summaries + + try { + Get-V2024AllPotentialRoleSummaries-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024AllPotentialRoleSummaries -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AllPotentialRoleSummaries" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) + + # Retrieves entitlement popularity distribution for a potential role in a role mining session + + try { + Get-V2024EntitlementDistributionPotentialRole-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementDistributionPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024IncludeCommonAccess $IncludeCommonAccess + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementDistributionPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) (default to $true) + $Sorters = "popularity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) + $Filters = "applicationName sw "AD"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves entitlements for a potential role in a role mining session + + try { + Get-V2024EntitlementsPotentialRole-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementsPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024IncludeCommonAccess $IncludeCommonAccess -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "populariity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** (optional) + $Filters = "applicationName sw "AD"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves excluded entitlements for a potential role in a role mining session + + try { + Get-V2024ExcludedEntitlementsPotentialRole-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ExcludedEntitlementsPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ExcludedEntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "MyFilters" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves identities for a potential role in a role mining session + + try { + Get-V2024IdentitiesPotentialRole-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentitiesPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitiesPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Retrieves a specific potential role + + try { + Get-V2024PotentialRole-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "applicationName sw "test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves the applications of a potential role for a role mining session + + try { + Get-V2024PotentialRoleApplications-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PotentialRoleApplications -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleApplications" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "entitlementRef.name sw "test"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves the entitlements of a potential role for a role mining session + + try { + Get-V2024PotentialRoleEntitlements-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PotentialRoleEntitlements -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleEntitlements" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PotentialRoleId = "e0cc5d7d-bf7f-4f81-b2af-8885b09d9923" # String | A potential role id + $SourceId = "2c9180877620c1460176267f336a106f" # String | A source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "-usageCount" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves potential role source usage + + try { + Get-V2024PotentialRoleSourceIdentityUsage-V2024PotentialRoleId $PotentialRoleId -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PotentialRoleSourceIdentityUsage -V2024PotentialRoleId $PotentialRoleId -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleSourceIdentityUsage" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** (optional) + $Filters = "(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true))" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all potential role summaries + + try { + Get-V2024PotentialRoleSummaries-V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PotentialRoleSummaries -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PotentialRoleSummaries" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/{potentialRoleId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Retrieves a specific potential role + + try { + Get-V2024RoleMiningPotentialRole-V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleMiningPotentialRole -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be retrieved. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get a role mining session + + try { + Get-V2024RoleMiningSession-V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleMiningSession -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSession" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get role mining session status state + + try { + Get-V2024RoleMiningSessionStatus-V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleMiningSessionStatus -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSessionStatus" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "saved eq "true" and name sw "RM Session"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* (optional) + $Sorters = "createdBy,createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all role mining sessions + + try { + Get-V2024RoleMiningSessions-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleMiningSessions -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters -V2024Sorters $Sorters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSessions" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/saved + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieves all saved potential roles + + try { + Get-V2024SavedPotentialRoles-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SavedPotentialRoles -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedPotentialRoles" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ + + + # Update a potential role + + try { + $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner + Update-V2024PotentialRole-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-V2024PotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $PatchPotentialRoleRequestInner + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PotentialRole" + Write-Host $_.ErrorDetails + } +- path: /role-mining-potential-roles/{potentialRoleId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ + + + # Update a potential role + + try { + $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner + Update-V2024PotentialRole0-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-V2024PotentialRole0 -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024PatchPotentialRoleRequestInner $PatchPotentialRoleRequestInner + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PotentialRole0" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be patched + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a role mining session + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024RoleMiningSession-V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024RoleMiningSession -V2024SessionId $SessionId -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RoleMiningSession" + Write-Host $_.ErrorDetails + } +- path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id + $PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RoleMiningPotentialRoleEditEntitlements = @" + { + "ids" : [ "entId1", "entId2" ], + "exclude" : true + } + "@ + + # Edit entitlements for a potential role to exclude some entitlements + + try { + $Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements + Update-V2024EntitlementsPotentialRole-V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleEditEntitlements $Result + + # Below is a request that includes all optional parameters + # Update-V2024EntitlementsPotentialRole -V2024SessionId $SessionId -V2024PotentialRoleId $PotentialRoleId -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleMiningPotentialRoleEditEntitlements $RoleMiningPotentialRoleEditEntitlements + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024EntitlementsPotentialRole" + Write-Host $_.ErrorDetails + } +- path: /icons/{objectType}/{objectId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ObjectType = "application" # String | Object type. Available options ['application'] + $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete an icon + + try { + Remove-V2024Icon-V2024ObjectType $ObjectType -V2024ObjectId $ObjectId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024Icon -V2024ObjectType $ObjectType -V2024ObjectId $ObjectId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Icon" + Write-Host $_.ErrorDetails + } +- path: /icons/{objectType}/{objectId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ObjectType = "application" # String | Object type. Available options ['application'] + $ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] + + # Update an icon + + try { + Set-V2024Icon-V2024ObjectType $ObjectType -V2024ObjectId $ObjectId -V2024XSailPointExperimental $XSailPointExperimental -V2024Image $Image + + # Below is a request that includes all optional parameters + # Set-V2024Icon -V2024ObjectType $ObjectType -V2024ObjectId $ObjectId -V2024XSailPointExperimental $XSailPointExperimental -V2024Image $Image + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024Icon" + Write-Host $_.ErrorDetails + } +- path: /identities/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete identity + + try { + Remove-V2024Identity-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024Identity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Identity" + Write-Host $_.ErrorDetails + } +- path: /identities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Identity Details + + try { + Get-V2024Identity-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Identity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Identity" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/ownership + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "ff8081814d2a8036014d701f3fbf53fa" # String | Identity ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get ownership details + + try { + Get-V2024IdentityOwnershipDetails-V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityOwnershipDetails -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityOwnershipDetails" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/role-assignments/{assignmentId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + $AssignmentId = "1cbb0705b38c4226b1334eadd8874086" # String | Assignment Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Role assignment details + + try { + Get-V2024RoleAssignment-V2024IdentityId $IdentityId -V2024AssignmentId $AssignmentId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleAssignment -V2024IdentityId $IdentityId -V2024AssignmentId $AssignmentId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignment" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/role-assignments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id to get the role assignments for + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RoleId = "e7697a1e96d04db1ac7b0f4544915d2c" # String | Role Id to filter the role assignments with (optional) + $RoleName = "Engineer" # String | Role name to filter the role assignments with (optional) + + # List role assignments + + try { + Get-V2024RoleAssignments-V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleAssignments -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental -V2024RoleId $RoleId -V2024RoleName $RoleName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignments" + Write-Host $_.ErrorDetails + } +- path: /identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) + $Sorters = "name,-cloudStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) + $DefaultFilter = "CORRELATED_ONLY" # String | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to "CORRELATED_ONLY") + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Identities + + try { + Get-V2024Identities-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Identities -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters -V2024Sorters $Sorters -V2024DefaultFilter $DefaultFilter -V2024Count $Count -V2024Limit $Limit -V2024Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Identities" + Write-Host $_.ErrorDetails + } +- path: /identities/{id}/reset + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Reset an identity + + try { + Reset-V2024Identity-V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Reset-V2024Identity -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-V2024Identity" + Write-Host $_.ErrorDetails + } +- path: /identities/{id}/verification/account/send + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + $SendAccountVerificationRequest = @" + { + "sourceName" : "Active Directory Source", + "via" : "EMAIL_WORK" + } + "@ + + # Send password reset email + + try { + $Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest + Send-V2024IdentityVerificationAccountToken-V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id -V2024SendAccountVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2024IdentityVerificationAccountToken -V2024XSailPointExperimental $XSailPointExperimental -V2024Id $Id -V2024SendAccountVerificationRequest $SendAccountVerificationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityVerificationAccountToken" + Write-Host $_.ErrorDetails + } +- path: /identities/invite + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $InviteIdentitiesRequest = @" + { + "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], + "uninvited" : false + } + "@ + + # Invite identities to register + + try { + $Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest + Start-V2024IdentitiesInvite-V2024XSailPointExperimental $XSailPointExperimental -V2024InviteIdentitiesRequest $Result + + # Below is a request that includes all optional parameters + # Start-V2024IdentitiesInvite -V2024XSailPointExperimental $XSailPointExperimental -V2024InviteIdentitiesRequest $InviteIdentitiesRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentitiesInvite" + Write-Host $_.ErrorDetails + } +- path: /identities/process + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ProcessIdentitiesRequest = @" + { + "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] + } + "@ + + # Process a list of identityIds + + try { + $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest + Start-V2024IdentityProcessing-V2024XSailPointExperimental $XSailPointExperimental -V2024ProcessIdentitiesRequest $Result + + # Below is a request that includes all optional parameters + # Start-V2024IdentityProcessing -V2024XSailPointExperimental $XSailPointExperimental -V2024ProcessIdentitiesRequest $ProcessIdentitiesRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024IdentityProcessing" + Write-Host $_.ErrorDetails + } +- path: /identities/{identityId}/synchronize-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "MyIdentityId" # String | The Identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Attribute synchronization for single identity. + + try { + Sync-V2024hronizeAttributesForIdentity-V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Sync-V2024hronizeAttributesForIdentity -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024hronizeAttributesForIdentity" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityAttribute = @" + { + "standard" : false, + "system" : false, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + } + "@ + + # Create Identity Attribute + + try { + $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute + New-V2024IdentityAttribute-V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result + + # Below is a request that includes all optional parameters + # New-V2024IdentityAttribute -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $IdentityAttribute + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "displayName" # String | The attribute's technical name. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete Identity Attribute + + try { + Remove-V2024IdentityAttribute-V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/bulk-delete + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityAttributeNames = @" + { + "ids" : [ "name", "displayName" ] + } + "@ + + # Bulk delete Identity Attributes + + try { + $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames + Remove-V2024IdentityAttributesInBulk-V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttributeNames $Result + + # Below is a request that includes all optional parameters + # Remove-V2024IdentityAttributesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttributeNames $IdentityAttributeNames + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttributesInBulk" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "displayName" # String | The attribute's technical name. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Identity Attribute + + try { + Get-V2024IdentityAttribute-V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IncludeSystem = $false # Boolean | Include 'system' attributes in the response. (optional) (default to $false) + $IncludeSilent = $false # Boolean | Include 'silent' attributes in the response. (optional) (default to $false) + $SearchableOnly = $false # Boolean | Include only 'searchable' attributes in the response. (optional) (default to $false) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Identity Attributes + + try { + Get-V2024IdentityAttributes-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAttributes -V2024XSailPointExperimental $XSailPointExperimental -V2024IncludeSystem $IncludeSystem -V2024IncludeSilent $IncludeSilent -V2024SearchableOnly $SearchableOnly -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAttributes" + Write-Host $_.ErrorDetails + } +- path: /identity-attributes/{name} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "displayName" # String | The attribute's technical name. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityAttribute = @" + { + "standard" : false, + "system" : false, + "sources" : [ { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + }, { + "type" : "rule", + "properties" : { + "ruleType" : "IdentityAttribute", + "ruleName" : "Cloud Promote Identity Attribute" + } + } ], + "displayName" : "Cost Center", + "name" : "costCenter", + "type" : "string", + "searchable" : false, + "multi" : false + } + "@ + + # Update Identity Attribute + + try { + $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute + Send-V2024IdentityAttribute-V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result + + # Below is a request that includes all optional parameters + # Send-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $IdentityAttribute + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityAttribute" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/compare + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Snapshot1 = "2007-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) + $Snapshot2 = "2008-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) + $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) + + + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Gets a difference of count for each access item types for the given identity between 2 snapshots + + try { + Compare-V2024IdentitySnapshots-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Compare-V2024IdentitySnapshots -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Snapshot1 $Snapshot1 -V2024Snapshot2 $Snapshot2 -V2024AccessItemTypes $AccessItemTypes -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2024IdentitySnapshots" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/compare/{access-type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $AccessType = "accessProfile" # String | The specific type which needs to be compared + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AccessAssociated = $false # Boolean | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) + $Snapshot1 = "2008-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) + $Snapshot2 = "2009-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Gets a list of differences of specific accessType for the given identity between 2 snapshots + + try { + Compare-V2024IdentitySnapshotsAccessType-V2024Id $Id -V2024AccessType $AccessType -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Compare-V2024IdentitySnapshotsAccessType -V2024Id $Id -V2024AccessType $AccessType -V2024XSailPointExperimental $XSailPointExperimental -V2024AccessAssociated $AccessAssociated -V2024Snapshot1 $Snapshot1 -V2024Snapshot2 $Snapshot2 -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-V2024IdentitySnapshotsAccessType" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get latest snapshot of identity + + try { + Get-V2024HistoricalIdentity-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024HistoricalIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentity" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/events + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $From = "2024-03-01T13:00:00Z" # String | The optional instant until which access events are returned (optional) + $EventTypes = "MyEventTypes" # String[] | An optional list of event types to return. If null or empty, all events are returned (optional) + + $EventTypes = @"[AccessAddedEvent, AccessRemovedEvent]"@ + $AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) + + $AccessItemTypes = @"[entitlement, account]"@ + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Lists all events for the given identity + + try { + Get-V2024HistoricalIdentityEvents-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024HistoricalIdentityEvents -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024From $From -V2024EventTypes $EventTypes -V2024AccessItemTypes $AccessItemTypes -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentityEvents" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshots/{date} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Date = "2007-03-01T13:00:00Z" # String | The specified date + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Gets an identity snapshot at a given date + + try { + Get-V2024IdentitySnapshot-V2024Id $Id -V2024Date $Date -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySnapshot -V2024Id $Id -V2024Date $Date -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshot" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshot-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Before = "2007-03-01T13:00:00Z" # String | The date before which snapshot summary is required (optional) + $Interval = "day" # String | The interval indicating day or month. Defaults to month if not specified (optional) + $TimeZone = "UTC" # String | The time zone. Defaults to UTC if not provided (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Gets the summary for the event count for a specific identity + + try { + Get-V2024IdentitySnapshotSummary-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySnapshotSummary -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Before $Before -V2024Interval $Interval -V2024TimeZone $TimeZone -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshotSummary" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/start-date + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Gets the start date of the identity + + try { + Get-V2024IdentityStartDate-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityStartDate -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityStartDate" + Write-Host $_.ErrorDetails + } +- path: /historical-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $StartsWithQuery = "Ada" # String | This param is used for starts-with search for first, last and display name of the identity (optional) + $IsDeleted = $true # Boolean | Indicates if we want to only list down deleted identities or not. (optional) + $IsActive = $true # Boolean | Indicates if we want to only list active or inactive identities. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # Lists all the identities + + try { + Get-V2024HistoricalIdentities-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024HistoricalIdentities -V2024XSailPointExperimental $XSailPointExperimental -V2024StartsWithQuery $StartsWithQuery -V2024IsDeleted $IsDeleted -V2024IsActive $IsActive -V2024Limit $Limit -V2024Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024HistoricalIdentities" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Type = "account" # String | The type of access item for the identity. If not provided, it defaults to account (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Access Items by Identity + + try { + Get-V2024IdentityAccessItems-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAccessItems -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Type $Type -V2024Limit $Limit -V2024Count $Count -V2024Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessItems" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshots/{date}/access-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $Date = "2007-03-01T13:00:00Z" # String | The specified date + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Type = "account" # String | The access item type (optional) + + # Gets the list of identity access items at a given date filterd by item type + + try { + Get-V2024IdentitySnapshotAccessItems-V2024Id $Id -V2024Date $Date -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySnapshotAccessItems -V2024Id $Id -V2024Date $Date -V2024XSailPointExperimental $XSailPointExperimental -V2024Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshotAccessItems" + Write-Host $_.ErrorDetails + } +- path: /historical-identities/{id}/snapshots + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Start = "2007-03-01T13:00:00Z" # String | The specified start date (optional) + $Interval = "day" # String | The interval indicating the range in day or month for the specified interval-name (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Lists all the snapshots for the identity + + try { + Get-V2024IdentitySnapshots-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySnapshots -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Start $Start -V2024Interval $Interval -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySnapshots" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfile = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + } + "@ + + # Create an Identity Profile + + try { + $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile + New-V2024IdentityProfile-V2024IdentityProfile $Result + + # Below is a request that includes all optional parameters + # New-V2024IdentityProfile -V2024IdentityProfile $IdentityProfile + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. + + # Delete an Identity Profile + + try { + Remove-V2024IdentityProfile-V2024IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Remove-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body. + $RequestBody = @""@ + + + # Delete Identity Profiles + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-V2024IdentityProfiles-V2024RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-V2024IdentityProfiles -V2024RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) + + # Export Identity Profiles + + try { + Export-V2024IdentityProfiles + + # Below is a request that includes all optional parameters + # Export-V2024IdentityProfiles -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. + + # Get default Identity Attribute Config + + try { + Get-V2024DefaultIdentityAttributeConfig-V2024IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-V2024DefaultIdentityAttributeConfig -V2024IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultIdentityAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. + + # Get single Identity Profile + + try { + Get-V2024IdentityProfile-V2024IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + + + + + $IdentityProfileExportedObject = @"{ + "self" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "version" : 1, + "object" : { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + } + }"@ + + + # Import Identity Profiles + + try { + $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject + Import-V2024IdentityProfiles-V2024IdentityProfileExportedObject $Result + + # Below is a request that includes all optional parameters + # Import-V2024IdentityProfiles -V2024IdentityProfileExportedObject $IdentityProfileExportedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) + + # Identity Profiles List + + try { + Get-V2024IdentityProfiles + + # Below is a request that includes all optional parameters + # Get-V2024IdentityProfiles -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/identity-preview + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityPreviewRequest = @" + { + "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + } + } + "@ + + # Generate Identity Profile Preview + + try { + $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest + Show-V2024IdentityPreview-V2024IdentityPreviewRequest $Result + + # Below is a request that includes all optional parameters + # Show-V2024IdentityPreview -V2024IdentityPreviewRequest $IdentityPreviewRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024IdentityPreview" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/process-identities + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed + + # Process identities under profile + + try { + Sync-V2024IdentityProfile-V2024IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Sync-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update the Identity Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024IdentityProfile-V2024IdentityProfileId $IdentityProfileId -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024IdentityProfile -V2024IdentityProfileId $IdentityProfileId -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleState = @" + { + "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], + "emailNotificationOption" : { + "notifyManagers" : true, + "notifySpecificUsers" : true, + "emailAddressList" : [ "test@test.com", "test2@test.com" ], + "notifyAllAdmins" : true + }, + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Lifecycle description", + "accountActions" : [ { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }, { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } ], + "id" : "id12345", + "identityCount" : 42, + "technicalName" : "Technical Name", + "identityState" : "identityState", + "enabled" : true + } + "@ + + # Create Lifecycle State + + try { + $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState + New-V2024LifecycleState-V2024IdentityProfileId $IdentityProfileId -V2024LifecycleState $Result + + # Below is a request that includes all optional parameters + # New-V2024LifecycleState -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleState $LifecycleState + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + + # Delete Lifecycle State + + try { + Remove-V2024LifecycleState-V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Remove-V2024LifecycleState -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + + # Get Lifecycle State + + try { + Get-V2024LifecycleState-V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Get-V2024LifecycleState -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Lists LifecycleStates + + try { + Get-V2024LifecycleStates-V2024IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-V2024LifecycleStates -V2024IdentityProfileId $IdentityProfileId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024LifecycleStates" + Write-Host $_.ErrorDetails + } +- path: /identities/{identity-id}/set-lifecycle-state + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "2c9180857893f1290178944561990364" # String | ID of the identity to update. + $SetLifecycleStateRequest = @" + + "@ + + # Set Lifecycle State + + try { + $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest + Set-V2024LifecycleState-V2024IdentityId $IdentityId -V2024SetLifecycleStateRequest $Result + + # Below is a request that includes all optional parameters + # Set-V2024LifecycleState -V2024IdentityId $IdentityId -V2024SetLifecycleStateRequest $SetLifecycleStateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Lifecycle State + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024LifecycleStates-V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024LifecycleStates -V2024IdentityProfileId $IdentityProfileId -V2024LifecycleStateId $LifecycleStateId -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024LifecycleStates" + Write-Host $_.ErrorDetails + } +- path: /managed-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ManagedClientRequest = @" + { + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + } + "@ + + # Create Managed Client + + try { + $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest + New-V2024ManagedClient-V2024ManagedClientRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ManagedClient -V2024ManagedClientRequest $ManagedClientRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Delete Managed Client + + try { + Remove-V2024ManagedClient-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ManagedClient -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Get Managed Client + + try { + Get-V2024ManagedClient-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClient -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "aClientId" # String | Managed client ID to get status for. + $Type = "CCG" # ManagedClientType | Managed client type to get status for. + + # Get Managed Client Status + + try { + Get-V2024ManagedClientStatus-V2024Id $Id -V2024Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClientStatus -V2024Id $Id -V2024Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + + # Get Managed Clients + + try { + Get-V2024ManagedClients + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClients -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClients" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Client + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ManagedClient-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ManagedClient -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ManagedClusterRequest = @" + { + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + } + "@ + + # Create Create Managed Cluster + + try { + $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest + New-V2024ManagedCluster-V2024ManagedClusterRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ManagedCluster -V2024ManagedClusterRequest $ManagedClusterRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) + + # Delete Managed Cluster + + try { + Remove-V2024ManagedCluster-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ManagedCluster -V2024Id $Id -V2024RemoveClients $RemoveClients + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. + + # Get Managed Cluster Log Configuration + + try { + Get-V2024ClientLogConfiguration-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ClientLogConfiguration -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + + # Get Managed Cluster + + try { + Get-V2024ManagedCluster-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ManagedCluster -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + + # Get Managed Clusters + + try { + Get-V2024ManagedClusters + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClusters -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusters" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. + $PutClientLogConfigurationRequest = @" + + "@ + + # Update Managed Cluster Log Configuration + + try { + $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest + Send-V2024ClientLogConfiguration-V2024Id $Id -V2024PutClientLogConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2024ClientLogConfiguration -V2024Id $Id -V2024PutClientLogConfigurationRequest $PutClientLogConfigurationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Cluster + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ManagedCluster-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ManagedCluster -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Configuration of Duo MFA method + + try { + Get-V2024MFADuoConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFADuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + # Configuration of KBA MFA method + + try { + Get-V2024MFAKbaConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFAKbaConfig -V2024AllLanguages $AllLanguages + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAKbaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Configuration of Okta MFA method + + try { + Get-V2024MFAOktaConfig + + # Below is a request that includes all optional parameters + # Get-V2024MFAOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MfaDuoConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Duo MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-V2024MFADuoConfig-V2024MfaDuoConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFADuoConfig -V2024MfaDuoConfig $MfaDuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ + + + # Set MFA KBA configuration + + try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-V2024MFAKBAConfig-V2024KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFAKBAConfig -V2024KbaAnswerRequestItem $KbaAnswerRequestItem + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAKBAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MfaOktaConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Okta MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-V2024MFAOktaConfig-V2024MfaOktaConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2024MFAOktaConfig -V2024MfaOktaConfig $MfaOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + # MFA method's test configuration + + try { + Test-V2024MFAConfig-V2024Method $Method + + # Below is a request that includes all optional parameters + # Test-V2024MFAConfig -V2024Method $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024MFAConfig" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) + $NonEmployeeApprovalDecision = @" + { + "comment" : "Approved by manager" + } + "@ + + # Approve a Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision + Approve-V2024NonEmployeeRequest-V2024Id $Id -V2024NonEmployeeApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Approve-V2024NonEmployeeRequest -V2024Id $Id -V2024NonEmployeeApprovalDecision $NonEmployeeApprovalDecision + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Create Non-Employee Record + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-V2024NonEmployeeRecord-V2024NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-V2024NonEmployeeRecord -V2024NonEmployeeRequestBody $NonEmployeeRequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Create Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-V2024NonEmployeeRequest-V2024NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-V2024NonEmployeeRequest -V2024NonEmployeeRequestBody $NonEmployeeRequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $NonEmployeeSourceRequestBody = @" + { + "owner" : { + "id" : "2c91808570313110017040b06f344ec9" + }, + "managementWorkgroup" : "123299", + "accountManagers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ], + "name" : "Retail", + "description" : "Source description", + "approvers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ] + } + "@ + + # Create Non-Employee Source + + try { + $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody + New-V2024NonEmployeeSource-V2024NonEmployeeSourceRequestBody $Result + + # Below is a request that includes all optional parameters + # New-V2024NonEmployeeSource -V2024NonEmployeeSourceRequestBody $NonEmployeeSourceRequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + $NonEmployeeSchemaAttributeBody = @" + { + "helpText" : "The unique identifier for the account", + "label" : "Account Name", + "placeholder" : "Enter a unique user name for this account.", + "type" : "TEXT", + "technicalName" : "account.name", + "required" : true + } + "@ + + # Create a new Schema Attribute for Non-Employee Source + + try { + $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody + New-V2024NonEmployeeSourceSchemaAttributes-V2024SourceId $SourceId -V2024NonEmployeeSchemaAttributeBody $Result + + # Below is a request that includes all optional parameters + # New-V2024NonEmployeeSourceSchemaAttributes -V2024SourceId $SourceId -V2024NonEmployeeSchemaAttributeBody $NonEmployeeSchemaAttributeBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) + + # Delete Non-Employee Record + + try { + Remove-V2024NonEmployeeRecord-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeRecord -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $DeleteNonEmployeeRecordsInBulkRequest = @" + + "@ + + # Delete Multiple Non-Employee Records + + try { + $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest + Remove-V2024NonEmployeeRecordsInBulk-V2024DeleteNonEmployeeRecordsInBulkRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeRecordsInBulk -V2024DeleteNonEmployeeRecordsInBulkRequest $DeleteNonEmployeeRecordsInBulkRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format + + # Delete Non-Employee Request + + try { + Remove-V2024NonEmployeeRequest-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeRequest -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # Delete a Schema Attribute for Non-Employee Source + + try { + Remove-V2024NonEmployeeSchemaAttribute-V2024AttributeId $AttributeId -V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeSchemaAttribute -V2024AttributeId $AttributeId -V2024SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id + + # Delete Non-Employee Source + + try { + Remove-V2024NonEmployeeSource-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeSource -V2024SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # Delete all custom schema attributes for Non-Employee Source + + try { + Remove-V2024NonEmployeeSourceSchemaAttributes-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-V2024NonEmployeeSourceSchemaAttributes -V2024SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employees/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) + + # Exports Non-Employee Records to CSV + + try { + Export-V2024NonEmployeeRecords-V2024Id $Id + + # Below is a request that includes all optional parameters + # Export-V2024NonEmployeeRecords -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024NonEmployeeRecords" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/schema-attributes-template/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID) + + # Exports Source Schema Template + + try { + Export-V2024NonEmployeeSourceSchemaTemplate-V2024Id $Id + + # Below is a request that includes all optional parameters + # Export-V2024NonEmployeeSourceSchemaTemplate -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024NonEmployeeSourceSchemaTemplate" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) + $IncludeDetail = $true # Boolean | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) + + # Get a non-employee approval item detail + + try { + Get-V2024NonEmployeeApproval-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeApproval -V2024Id $Id -V2024IncludeDetail $IncludeDetail + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApproval" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/summary/{requested-for} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + + # Get Summary of Non-Employee Approval Requests + + try { + Get-V2024NonEmployeeApprovalSummary-V2024RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeApprovalSummary -V2024RequestedFor $RequestedFor + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApprovalSummary" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source ID (UUID) + + # Obtain the status of bulk upload on the source + + try { + Get-V2024NonEmployeeBulkUploadStatus-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeBulkUploadStatus -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeBulkUploadStatus" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) + + # Get a Non-Employee Record + + try { + Get-V2024NonEmployeeRecord-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRecord -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID) + + # Get a Non-Employee Request + + try { + Get-V2024NonEmployeeRequest-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRequest -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/summary/{requested-for} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + + # Get Summary of Non-Employee Requests + + try { + Get-V2024NonEmployeeRequestSummary-V2024RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRequestSummary -V2024RequestedFor $RequestedFor + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequestSummary" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # Get Schema Attribute Non-Employee Source + + try { + Get-V2024NonEmployeeSchemaAttribute-V2024AttributeId $AttributeId -V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeSchemaAttribute -V2024AttributeId $AttributeId -V2024SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id + + # Get a Non-Employee Source + + try { + Get-V2024NonEmployeeSource-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeSource -V2024SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # List Schema Attributes Non-Employee Source + + try { + Get-V2024NonEmployeeSourceSchemaAttributes-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeSourceSchemaAttributes -V2024SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) + $Data = # System.IO.FileInfo | + + # Imports, or Updates, Non-Employee Records + + try { + Import-V2024NonEmployeeRecordsInBulk-V2024Id $Id -V2024Data $Data + + # Below is a request that includes all optional parameters + # Import-V2024NonEmployeeRecordsInBulk -V2024Id $Id -V2024Data $Data + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024NonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity for whom the request was made. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "approvalStatus eq "Pending"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Get List of Non-Employee Approval Requests + + try { + Get-V2024NonEmployeeApprovals + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeApprovals -V2024RequestedFor $RequestedFor -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeApprovals" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "accountName,sourceId" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) + $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + + # List Non-Employee Records + + try { + Get-V2024NonEmployeeRecords + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRecords -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRecords" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "e136567de87e4d029e60b3c3c55db56d" # String | The identity for whom the request was made. *me* indicates the current user. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "created,approvalStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) + $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + + # List Non-Employee Requests + + try { + Get-V2024NonEmployeeRequests-V2024RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeRequests -V2024RequestedFor $RequestedFor -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeRequests" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $NonEmployeeCount = $true # Boolean | The flag to determine whether return a non-employee count associate with source. (optional) + $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) + + # List Non-Employee Sources + + try { + Get-V2024NonEmployeeSources-V2024RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-V2024NonEmployeeSources -V2024RequestedFor $RequestedFor -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024NonEmployeeCount $NonEmployeeCount -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSources" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Non-Employee Record + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024NonEmployeeRecord-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024NonEmployeeRecord -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Schema Attribute for Non-Employee Source + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024NonEmployeeSchemaAttribute-V2024AttributeId $AttributeId -V2024SourceId $SourceId -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024NonEmployeeSchemaAttribute -V2024AttributeId $AttributeId -V2024SourceId $SourceId -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Non-Employee Source + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024NonEmployeeSource-V2024SourceId $SourceId -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024NonEmployeeSource -V2024SourceId $SourceId -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id}/reject + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) + $NonEmployeeRejectApprovalDecision = @" + { + "comment" : "approved" + } + "@ + + # Reject a Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision + Deny-V2024NonEmployeeRequest-V2024Id $Id -V2024NonEmployeeRejectApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Deny-V2024NonEmployeeRequest -V2024Id $Id -V2024NonEmployeeRejectApprovalDecision $NonEmployeeRejectApprovalDecision + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Update Non-Employee Record + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + Update-V2024NonEmployeeRecord-V2024Id $Id -V2024NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024NonEmployeeRecord -V2024Id $Id -V2024NonEmployeeRequestBody $NonEmployeeRequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /verified-domains + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $DomainAddress = @" + { + "domain" : "sailpoint.com" + } + "@ + + # Verify domain address via DKIM + + try { + $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress + New-V2024DomainDkim-V2024XSailPointExperimental $XSailPointExperimental -V2024DomainAddress $Result + + # Below is a request that includes all optional parameters + # New-V2024DomainDkim -V2024XSailPointExperimental $XSailPointExperimental -V2024DomainAddress $DomainAddress + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DomainDkim" + Write-Host $_.ErrorDetails + } +- path: /notification-templates + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TemplateDto = @" + { + "slackTemplate" : "slackTemplate", + "footer" : "footer", + "teamsTemplate" : "teamsTemplate", + "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", + "created" : "2020-01-01T00:00:00Z", + "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", + "medium" : "EMAIL", + "locale" : "en", + "body" : "Please go to the task manager", + "name" : "Task Manager Subscription", + "replyTo" : "$__global.emailFromAddress", + "header" : "header", + "modified" : "2020-01-01T00:00:00Z", + "from" : "$__global.emailFromAddress", + "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", + "key" : "cloud_manual_work_item_summary" + } + "@ + + # Create Notification Template + + try { + $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto + New-V2024NotificationTemplate-V2024XSailPointExperimental $XSailPointExperimental -V2024TemplateDto $Result + + # Below is a request that includes all optional parameters + # New-V2024NotificationTemplate -V2024XSailPointExperimental $XSailPointExperimental -V2024TemplateDto $TemplateDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NotificationTemplate" + Write-Host $_.ErrorDetails + } +- path: /verified-from-addresses + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $EmailStatusDto = @" + { + "isVerifiedByDomain" : false, + "verificationStatus" : "PENDING", + "id" : "id", + "email" : "sender@example.com" + } + "@ + + # Create Verified From Address + + try { + $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto + New-V2024VerifiedFromAddress-V2024XSailPointExperimental $XSailPointExperimental -V2024EmailStatusDto $Result + + # Below is a request that includes all optional parameters + # New-V2024VerifiedFromAddress -V2024XSailPointExperimental $XSailPointExperimental -V2024EmailStatusDto $EmailStatusDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VerifiedFromAddress" + Write-Host $_.ErrorDetails + } +- path: /notification-templates/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TemplateBulkDeleteDto = @"{ + "medium" : "EMAIL", + "locale" : "en", + "key" : "cloud_manual_work_item_summary" + }"@ + + + # Bulk Delete Notification Templates + + try { + $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto + Remove-V2024NotificationTemplatesInBulk-V2024XSailPointExperimental $XSailPointExperimental -V2024TemplateBulkDeleteDto $Result + + # Below is a request that includes all optional parameters + # Remove-V2024NotificationTemplatesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024TemplateBulkDeleteDto $TemplateBulkDeleteDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NotificationTemplatesInBulk" + Write-Host $_.ErrorDetails + } +- path: /verified-from-addresses/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "MyId" # String | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete Verified From Address + + try { + Remove-V2024VerifiedFromAddress-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024VerifiedFromAddress -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024VerifiedFromAddress" + Write-Host $_.ErrorDetails + } +- path: /verified-domains + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get DKIM Attributes + + try { + Get-V2024DkimAttributes-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024DkimAttributes -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DkimAttributes" + Write-Host $_.ErrorDetails + } +- path: /mail-from-attributes/{identity} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get MAIL FROM Attributes + + try { + Get-V2024MailFromAttributes-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024MailFromAttributes -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MailFromAttributes" + Write-Host $_.ErrorDetails + } +- path: /notification-templates/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Notification Template By Id + + try { + Get-V2024NotificationTemplate-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NotificationTemplate -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplate" + Write-Host $_.ErrorDetails + } +- path: /notification-template-context + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Notification Template Context + + try { + Get-V2024NotificationsTemplateContext-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NotificationsTemplateContext -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationsTemplateContext" + Write-Host $_.ErrorDetails + } +- path: /verified-from-addresses + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "email eq "john.doe@company.com"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* (optional) + $Sorters = "email" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) + + # List From Addresses + + try { + Get-V2024FromAddresses-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024FromAddresses -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FromAddresses" + Write-Host $_.ErrorDetails + } +- path: /notification-preferences/{key} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List Notification Preferences for tenant. + + try { + Get-V2024NotificationPreferences-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NotificationPreferences -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationPreferences" + Write-Host $_.ErrorDetails + } +- path: /notification-template-defaults + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "key eq "cloud_manual_work_item_summary"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + # List Notification Template Defaults + + try { + Get-V2024NotificationTemplateDefaults-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NotificationTemplateDefaults -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplateDefaults" + Write-Host $_.ErrorDetails + } +- path: /notification-templates + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "medium eq "EMAIL"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) + + # List Notification Templates + + try { + Get-V2024NotificationTemplates-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NotificationTemplates -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplates" + Write-Host $_.ErrorDetails + } +- path: /mail-from-attributes + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $MailFromAttributesDto = @" + { + "identity" : "BobSmith@sailpoint.com", + "mailFromDomain" : "example.sailpoint.com" + } + "@ + + # Change MAIL FROM domain + + try { + $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto + Send-V2024MailFromAttributes-V2024XSailPointExperimental $XSailPointExperimental -V2024MailFromAttributesDto $Result + + # Below is a request that includes all optional parameters + # Send-V2024MailFromAttributes -V2024XSailPointExperimental $XSailPointExperimental -V2024MailFromAttributesDto $MailFromAttributesDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024MailFromAttributes" + Write-Host $_.ErrorDetails + } +- path: /send-test-notification + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SendTestNotificationRequestDto = @" + { + "context" : "{}", + "medium" : "EMAIL", + "key" : "cloud_manual_work_item_summary" + } + "@ + + # Send Test Notification + + try { + $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto + Send-V2024TestNotification-V2024XSailPointExperimental $XSailPointExperimental -V2024SendTestNotificationRequestDto $Result + + # Below is a request that includes all optional parameters + # Send-V2024TestNotification -V2024XSailPointExperimental $XSailPointExperimental -V2024SendTestNotificationRequestDto $SendTestNotificationRequestDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TestNotification" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreateOAuthClientRequest = @" + { + "internal" : false, + "businessName" : "Acme-Solar", + "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", + "refreshTokenValiditySeconds" : 86400, + "type" : "CONFIDENTIAL", + "redirectUris" : [ "http://localhost:12345" ], + "enabled" : true, + "accessType" : "OFFLINE", + "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], + "strongAuthSupported" : false, + "homepageUrl" : "http://localhost:12345", + "accessTokenValiditySeconds" : 750, + "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], + "name" : "Demo API Client", + "claimsSupported" : false + } + "@ + + # Create OAuth Client + + try { + $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest + New-V2024OauthClient-V2024CreateOAuthClientRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024OauthClient -V2024CreateOAuthClientRequest $CreateOAuthClientRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024OauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + + # Delete OAuth Client + + try { + Remove-V2024OauthClient-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024OauthClient -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024OauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + + # Get OAuth Client + + try { + Get-V2024OauthClient-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024OauthClient -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + + # List OAuth Clients + + try { + Get-V2024OauthClients + + # Below is a request that includes all optional parameters + # Get-V2024OauthClients -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OauthClients" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch OAuth Client + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024OauthClient-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024OauthClient -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024OauthClient" + Write-Host $_.ErrorDetails + } +- path: /org-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Org Config Settings + + try { + Get-V2024OrgConfig-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024OrgConfig -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OrgConfig" + Write-Host $_.ErrorDetails + } +- path: /org-config/valid-time-zones + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Get Valid Time Zones + + try { + Get-V2024ValidTimeZones-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ValidTimeZones -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ValidTimeZones" + Write-Host $_.ErrorDetails + } +- path: /org-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Org Config + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024OrgConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024OrgConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024OrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Create Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + New-V2024PasswordOrgConfig-V2024PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # New-V2024PasswordOrgConfig -V2024PasswordOrgConfig $PasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Password Org Config + + try { + Get-V2024PasswordOrgConfig + + # Below is a request that includes all optional parameters + # Get-V2024PasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Update Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + Send-V2024PasswordOrgConfig-V2024PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024PasswordOrgConfig -V2024PasswordOrgConfig $PasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-dictionary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Password Dictionary + + try { + Get-V2024PasswordDictionary + + # Below is a request that includes all optional parameters + # Get-V2024PasswordDictionary + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordDictionary" + Write-Host $_.ErrorDetails + } +- path: /password-dictionary + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $File = # System.IO.FileInfo | (optional) + + # Update Password Dictionary + + try { + Send-V2024PasswordDictionary + + # Below is a request that includes all optional parameters + # Send-V2024PasswordDictionary -V2024File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PasswordDictionary" + Write-Host $_.ErrorDetails + } +- path: /generate-password-reset-token/digit + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $PasswordDigitTokenReset = @" + { + "durationMinutes" : 5, + "length" : 8, + "userId" : "Abby.Smith" + } + "@ + + # Generate a digit token + + try { + $Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset + New-V2024DigitToken-V2024XSailPointExperimental $XSailPointExperimental -V2024PasswordDigitTokenReset $Result + + # Below is a request that includes all optional parameters + # New-V2024DigitToken -V2024XSailPointExperimental $XSailPointExperimental -V2024PasswordDigitTokenReset $PasswordDigitTokenReset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DigitToken" + Write-Host $_.ErrorDetails + } +- path: /password-change-status/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID + + # Get Password Change Request Status + + try { + Get-V2024PasswordChangeStatus-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024PasswordChangeStatus -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordChangeStatus" + Write-Host $_.ErrorDetails + } +- path: /query-password-info + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordInfoQueryDTO = @" + { + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + } + "@ + + # Query Password Info + + try { + $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO + Search-V2024PasswordInfo-V2024PasswordInfoQueryDTO $Result + + # Below is a request that includes all optional parameters + # Search-V2024PasswordInfo -V2024PasswordInfoQueryDTO $PasswordInfoQueryDTO + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024PasswordInfo" + Write-Host $_.ErrorDetails + } +- path: /set-password + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordChangeRequest = @" + { + "sourceId" : "8a807d4c73c545510173c545d4b60246", + "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "identityId" : "8a807d4c73c545510173c545f0a002ff", + "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" + } + "@ + + # Set Identity's Password + + try { + $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest + Set-V2024Password-V2024PasswordChangeRequest $Result + + # Below is a request that includes all optional parameters + # Set-V2024Password -V2024PasswordChangeRequest $PasswordChangeRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024Password" + Write-Host $_.ErrorDetails + } +- path: /password-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordPolicyV3Dto = @" + { + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + } + "@ + + # Create Password Policy + + try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + New-V2024PasswordPolicy-V2024PasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # New-V2024PasswordPolicy -V2024PasswordPolicyV3Dto $PasswordPolicyV3Dto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. + + # Delete Password Policy by ID + + try { + Remove-V2024PasswordPolicy-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024PasswordPolicy -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. + + # Get Password Policy by ID + + try { + Get-V2024PasswordPolicyById-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024PasswordPolicyById -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordPolicyById" + Write-Host $_.ErrorDetails + } +- path: /password-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Password Policies + + try { + Get-V2024PasswordPolicies + + # Below is a request that includes all optional parameters + # Get-V2024PasswordPolicies -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordPolicies" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update. + $PasswordPolicyV3Dto = @" + { + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + } + "@ + + # Update Password Policy by ID + + try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + Set-V2024PasswordPolicy-V2024Id $Id -V2024PasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # Set-V2024PasswordPolicy -V2024Id $Id -V2024PasswordPolicyV3Dto $PasswordPolicyV3Dto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024PasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordSyncGroup = @" + { + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } + "@ + + # Create Password Sync Group + + try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + New-V2024PasswordSyncGroup-V2024PasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # New-V2024PasswordSyncGroup -V2024PasswordSyncGroup $PasswordSyncGroup + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. + + # Delete Password Sync Group by ID + + try { + Remove-V2024PasswordSyncGroup-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024PasswordSyncGroup -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. + + # Get Password Sync Group by ID + + try { + Get-V2024PasswordSyncGroup-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024PasswordSyncGroup -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Get Password Sync Group List + + try { + Get-V2024PasswordSyncGroups + + # Below is a request that includes all optional parameters + # Get-V2024PasswordSyncGroups -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PasswordSyncGroups" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to update. + $PasswordSyncGroup = @" + { + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } + "@ + + # Update Password Sync Group by ID + + try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + Update-V2024PasswordSyncGroup-V2024Id $Id -V2024PasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # Update-V2024PasswordSyncGroup -V2024Id $Id -V2024PasswordSyncGroup $PasswordSyncGroup + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreatePersonalAccessTokenRequest = @" + { + "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], + "accessTokenValiditySeconds" : 36900, + "name" : "NodeJS Integration" + } + "@ + + # Create Personal Access Token + + try { + $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest + New-V2024PersonalAccessToken-V2024CreatePersonalAccessTokenRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024PersonalAccessToken -V2024CreatePersonalAccessTokenRequest $CreatePersonalAccessTokenRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024PersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id + + # Delete Personal Access Token + + try { + Remove-V2024PersonalAccessToken-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024PersonalAccessToken -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024PersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "2c9180867b50d088017b554662fb281e" # String | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) + $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + + # List Personal Access Tokens + + try { + Get-V2024PersonalAccessTokens + + # Below is a request that includes all optional parameters + # Get-V2024PersonalAccessTokens -V2024OwnerId $OwnerId -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PersonalAccessTokens" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Personal Access Token + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024PersonalAccessToken-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024PersonalAccessToken -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /public-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "firstname eq "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) + $AddCoreFilters = $false # Boolean | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be ""spadmin"" or ""cloudadmin"". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to $false) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Get list of public identities + + try { + Get-V2024PublicIdentities + + # Below is a request that includes all optional parameters + # Get-V2024PublicIdentities -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024AddCoreFilters $AddCoreFilters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PublicIdentities" + Write-Host $_.ErrorDetails + } +- path: /public-identities-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get the Public Identities Configuration + + try { + Get-V2024PublicIdentityConfig + + # Below is a request that includes all optional parameters + # Get-V2024PublicIdentityConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PublicIdentityConfig" + Write-Host $_.ErrorDetails + } +- path: /public-identities-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PublicIdentityConfig = @" + { + "modified" : "2018-06-25T20:22:28.104Z", + "attributes" : [ { + "name" : "Country", + "key" : "country" + }, { + "name" : "Country", + "key" : "country" + } ], + "modifiedBy" : { + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + } + "@ + + # Update the Public Identities Configuration + + try { + $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig + Update-V2024PublicIdentityConfig-V2024PublicIdentityConfig $Result + + # Below is a request that includes all optional parameters + # Update-V2024PublicIdentityConfig -V2024PublicIdentityConfig $PublicIdentityConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PublicIdentityConfig" + Write-Host $_.ErrorDetails + } +- path: /reports/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel + + # Cancel Report + + try { + Suspend-V2024Report-V2024Id $Id + + # Below is a request that includes all optional parameters + # Suspend-V2024Report -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024Report" + Write-Host $_.ErrorDetails + } +- path: /reports/{taskResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report + $FileFormat = "csv" # String | Output format of the requested report file + $Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional) + $Auditable = $true # Boolean | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to $false) + + # Get Report File + + try { + Get-V2024Report-V2024TaskResultId $TaskResultId -V2024FileFormat $FileFormat + + # Below is a request that includes all optional parameters + # Get-V2024Report -V2024TaskResultId $TaskResultId -V2024FileFormat $FileFormat -V2024Name $Name -V2024Auditable $Auditable + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Report" + Write-Host $_.ErrorDetails + } +- path: /reports/{taskResultId}/result + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report + $Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false) + + # Get Report Result + + try { + Get-V2024ReportResult-V2024TaskResultId $TaskResultId + + # Below is a request that includes all optional parameters + # Get-V2024ReportResult -V2024TaskResultId $TaskResultId -V2024Completed $Completed + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReportResult" + Write-Host $_.ErrorDetails + } +- path: /reports/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReportDetails = @" + { + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } + } + "@ + + # Run Report + + try { + $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails + Start-V2024Report-V2024ReportDetails $Result + + # Below is a request that includes all optional parameters + # Start-V2024Report -V2024ReportDetails $ReportDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024Report" + Write-Host $_.ErrorDetails + } +- path: /requestable-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) + $Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. (optional) + + $Types = @"ROLE,ACCESS_PROFILE"@ + $Term = "Finance Role" # String | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) + $Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional) + + $Statuses = @"[ASSIGNED, PENDING]"@ + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw "bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Requestable Objects List + + try { + Get-V2024RequestableObjects + + # Below is a request that includes all optional parameters + # Get-V2024RequestableObjects -V2024IdentityId $IdentityId -V2024Types $Types -V2024Term $Term -V2024Statuses $Statuses -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RequestableObjects" + Write-Host $_.ErrorDetails + } +- path: /role-insights/requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Generate insights for roles + + try { + New-V2024RoleInsightRequests-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # New-V2024RoleInsightRequests -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024RoleInsightRequests" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/entitlement-changes/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "identitiesWithAccess" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) + $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + + # Download entitlement insights for a role + + try { + Invoke-V2024DownloadRoleInsightsEntitlementsChanges-V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Invoke-V2024DownloadRoleInsightsEntitlementsChanges -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024DownloadRoleInsightsEntitlementsChanges" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/entitlement-changes/{entitlementId}/identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $EntitlementId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The entitlement id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $HasEntitlement = $true # Boolean | Identity has this entitlement or not (optional) (default to $false) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "name sw "Jan"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) + + # Get identities for a suggested entitlement (for a role) + + try { + Get-V2024EntitlementChangesIdentities-V2024InsightId $InsightId -V2024EntitlementId $EntitlementId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementChangesIdentities -V2024InsightId $InsightId -V2024EntitlementId $EntitlementId -V2024XSailPointExperimental $XSailPointExperimental -V2024HasEntitlement $HasEntitlement -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementChangesIdentities" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get a single role insight + + try { + Get-V2024RoleInsight-V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsight -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsight" + Write-Host $_.ErrorDetails + } +- path: /role-insights + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "numberOfUpdates" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) + $Filters = "name sw "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) + + # Get role insights + + try { + Get-V2024RoleInsights-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsights -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsights" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/current-entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "name sw "r"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + + # Get current entitlement for a role + + try { + Get-V2024RoleInsightsCurrentEntitlements-V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsightsCurrentEntitlements -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsCurrentEntitlements" + Write-Host $_.ErrorDetails + } +- path: /role-insights/{insightId}/entitlement-changes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) + $Filters = "name sw "Admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) + + # Get entitlement insights for a role + + try { + Get-V2024RoleInsightsEntitlementsChanges-V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsightsEntitlementsChanges -V2024InsightId $InsightId -V2024XSailPointExperimental $XSailPointExperimental -V2024Sorters $Sorters -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsEntitlementsChanges" + Write-Host $_.ErrorDetails + } +- path: /role-insights/requests/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insights request id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Returns metadata from prior request. + + try { + Get-V2024RoleInsightsRequests-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsightsRequests -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsRequests" + Write-Host $_.ErrorDetails + } +- path: /role-insights/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get role insights summary information + + try { + Get-V2024RoleInsightsSummary-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleInsightsSummary -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleInsightsSummary" + Write-Host $_.ErrorDetails + } +- path: /roles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Role = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "dimensional" : false, + "created" : "2021-03-01T22:32:58.104Z", + "dimensionRefs" : [ { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + }, { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + } ], + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "membership" : { + "identities" : [ { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } ], + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, + "type" : "IDENTITY_LIST" + }, + "enabled" : true, + "revocationRequestConfig" : { + "commentsRequired" : false, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : false + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "legacyMembershipInfo" : { + "type" : "IDENTITY_LIST" + }, + "accessRequestConfig" : { + "commentsRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "name" : "Role 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "accessModelMetadata" : { + "attributes" : [ { + "key" : "iscPrivacy", + "name" : "Privacy", + "multiselect" : false, + "status" : "active", + "type" : "governance", + "objectTypes" : [ "all" ], + "description" : "Specifies the level of privacy associated with an access item.", + "values" : [ { + "value" : "public", + "name" : "Public", + "status" : "active" + } ] + } ] + }, + "id" : "2c918086749d78830174a1a40e121518", + "requestable" : true + } + "@ + + # Create a Role + + try { + $Result = ConvertFrom-JsonToRole -Json $Role + New-V2024Role-V2024Role $Result + + # Below is a request that includes all optional parameters + # New-V2024Role -V2024Role $Role + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Role" + Write-Host $_.ErrorDetails + } +- path: /roles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleBulkDeleteRequest = @" + { + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } + "@ + + # Delete Role(s) + + try { + $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest + Remove-V2024BulkRoles-V2024RoleBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-V2024BulkRoles -V2024RoleBulkDeleteRequest $RoleBulkDeleteRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024BulkRoles" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The role's id. + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + + # Remove a Metadata From Role. + + try { + Remove-V2024MetadataFromRoleByKeyAndValue-V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue + + # Below is a request that includes all optional parameters + # Remove-V2024MetadataFromRoleByKeyAndValue -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MetadataFromRoleByKeyAndValue" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + + # Delete a Role + + try { + Remove-V2024Role-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Role -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Role" + Write-Host $_.ErrorDetails + } +- path: /roles/access-model-metadata/bulk-update + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Bulk-Update Statuses + + try { + Get-V2024BulkUpdateStatus + + # Below is a request that includes all optional parameters + # Get-V2024BulkUpdateStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BulkUpdateStatus" + Write-Host $_.ErrorDetails + } +- path: /roles/access-model-metadata/bulk-update/id + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of the bulk update task. + + # Get Bulk-Update Status by ID + + try { + Get-V2024BulkUpdateStatusById-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024BulkUpdateStatusById -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024BulkUpdateStatusById" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + + # Get a Role + + try { + Get-V2024Role-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Role -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Role" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/assigned-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role for which the assigned Identities are to be listed + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw Joe" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) + $Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) + + # List Identities assigned a Role + + try { + Get-V2024RoleAssignedIdentities-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024RoleAssignedIdentities -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleAssignedIdentities" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the containing role + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + + # List role's Entitlements + + try { + Get-V2024RoleEntitlements-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024RoleEntitlements -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleEntitlements" + Write-Host $_.ErrorDetails + } +- path: /roles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + + # List Roles + + try { + Get-V2024Roles + + # Below is a request that includes all optional parameters + # Get-V2024Roles -V2024ForSubadmin $ForSubadmin -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters -V2024ForSegmentIds $ForSegmentIds -V2024IncludeUnsegmented $IncludeUnsegmented + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Roles" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Role + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Role-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Role -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Role" + Write-Host $_.ErrorDetails + } +- path: /roles/filter + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + $Limit = 50 # Int32 | Max number of results to return See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + $RoleListFilterDTO = @" + { + "ammKeyValues" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "secret" ] + } ], + "filters" : "dimensional eq false" + } + "@ + + # Filter Roles by Metadata + + try { + Search-V2024RolesByFilter + + # Below is a request that includes all optional parameters + # Search-V2024RolesByFilter -V2024ForSubadmin $ForSubadmin -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters -V2024ForSegmentIds $ForSegmentIds -V2024IncludeUnsegmented $IncludeUnsegmented -V2024RoleListFilterDTO $RoleListFilterDTO + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024RolesByFilter" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of a role + $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. + $AttributeValue = "public" # String | Technical name of the Attribute Value. + + # Add a Metadata to Role. + + try { + Update-V2024AttributeKeyAndValueToRole-V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue + + # Below is a request that includes all optional parameters + # Update-V2024AttributeKeyAndValueToRole -V2024Id $Id -V2024AttributeKey $AttributeKey -V2024AttributeValue $AttributeValue + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AttributeKeyAndValueToRole" + Write-Host $_.ErrorDetails + } +- path: /roles/access-model-metadata/bulk-update/filter + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleMetadataBulkUpdateByFilterRequest = @" + { + "values" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "topSecret" ] + } ], + "filters" : " requestable eq false", + "replaceScope" : "ALL", + "operation" : "REPLACE" + } + "@ + + # Bulk-Update Roles' Metadata by Filters + + try { + $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByFilterRequest -Json $RoleMetadataBulkUpdateByFilterRequest + Update-V2024RolesMetadataByFilter-V2024RoleMetadataBulkUpdateByFilterRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024RolesMetadataByFilter -V2024RoleMetadataBulkUpdateByFilterRequest $RoleMetadataBulkUpdateByFilterRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByFilter" + Write-Host $_.ErrorDetails + } +- path: /roles/access-model-metadata/bulk-update/ids + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleMetadataBulkUpdateByIdRequest = @" + { + "roles" : [ "b1db89554cfa431cb8b9921ea38d9367" ], + "values" : [ { + "attribute" : "iscFederalClassifications", + "values" : [ "topSecret" ] + } ], + "replaceScope" : "ALL", + "operation" : "REPLACE" + } + "@ + + # Bulk-Update Roles' Metadata by ID + + try { + $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByIdRequest -Json $RoleMetadataBulkUpdateByIdRequest + Update-V2024RolesMetadataByIds-V2024RoleMetadataBulkUpdateByIdRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024RolesMetadataByIds -V2024RoleMetadataBulkUpdateByIdRequest $RoleMetadataBulkUpdateByIdRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByIds" + Write-Host $_.ErrorDetails + } +- path: /roles/access-model-metadata/bulk-update/query + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleMetadataBulkUpdateByQueryRequest = @" + { + "query" : { + "query\"" : { + "indices" : [ "roles" ], + "queryType" : "TEXT", + "textQuery" : { + "terms" : [ "test123" ], + "fields" : [ "id" ], + "matchAny" : false, + "contains" : true + }, + "includeNested" : false + } + }, + "values" : [ { + "attributeValue" : [ "topSecret" ], + "attributeKey" : "iscFederalClassifications" + }, { + "attributeValue" : [ "topSecret" ], + "attributeKey" : "iscFederalClassifications" + } ], + "replaceScope" : "ALL", + "operation" : "REPLACE" + } + "@ + + # Bulk-Update Roles' Metadata by Query + + try { + $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByQueryRequest -Json $RoleMetadataBulkUpdateByQueryRequest + Update-V2024RolesMetadataByQuery-V2024RoleMetadataBulkUpdateByQueryRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024RolesMetadataByQuery -V2024RoleMetadataBulkUpdateByQueryRequest $RoleMetadataBulkUpdateByQueryRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByQuery" + Write-Host $_.ErrorDetails + } +- path: /saved-searches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreateSavedSearchRequest = @" + + "@ + + # Create a saved search + + try { + $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest + New-V2024SavedSearch-V2024CreateSavedSearchRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024SavedSearch -V2024CreateSavedSearchRequest $CreateSavedSearchRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Delete document by ID + + try { + Remove-V2024SavedSearch-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SavedSearch -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id}/execute + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $SearchArguments = @" + { + "owner" : "", + "recipients" : [ { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" + } + "@ + + # Execute a saved search by ID + + try { + $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments + Invoke-V2024ExecuteSavedSearch-V2024Id $Id -V2024SearchArguments $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024ExecuteSavedSearch -V2024Id $Id -V2024SearchArguments $SearchArguments + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ExecuteSavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Return saved search by ID + + try { + Get-V2024SavedSearch-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SavedSearch -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) + + # A list of Saved Searches + + try { + Get-V2024SavedSearches + + # Below is a request that includes all optional parameters + # Get-V2024SavedSearches -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SavedSearches" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $SavedSearch = @" + { + "owner" : { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2018-06-25T20:22:28.104Z", + "columns" : { + "identity" : [ { + "field" : "displayName", + "header" : "Display Name" + }, { + "field" : "e-mail", + "header" : "Work Email" + } ] + }, + "query" : "@accounts(disabled:true)", + "description" : "Disabled accounts", + "orderBy" : { + "identity" : [ "lastName", "firstName" ], + "role" : [ "name" ] + }, + "sort" : [ "displayName" ], + "filters" : { + "terms" : [ "account_count", "account_count" ], + "range" : { + "lower" : { + "inclusive" : false, + "value" : "1" + }, + "upper" : { + "inclusive" : false, + "value" : "1" + } + }, + "exclude" : false, + "type" : "RANGE" + }, + "ownerId" : "2c91808568c529c60168cca6f90c1313", + "indices" : [ "identities" ], + "public" : false, + "name" : "Disabled accounts", + "modified" : "2018-06-25T20:22:28.104Z", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "fields" : [ "disabled" ] + } + "@ + + # Updates an existing saved search + + try { + $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch + Send-V2024SavedSearch-V2024Id $Id -V2024SavedSearch $Result + + # Below is a request that includes all optional parameters + # Send-V2024SavedSearch -V2024Id $Id -V2024SavedSearch $SavedSearch + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreateScheduledSearchRequest = @" + {savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]} + "@ + + # Create a new scheduled search + + try { + $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest + New-V2024ScheduledSearch-V2024CreateScheduledSearchRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ScheduledSearch -V2024CreateScheduledSearchRequest $CreateScheduledSearchRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Delete a Scheduled Search + + try { + Remove-V2024ScheduledSearch-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ScheduledSearch -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Get a Scheduled Search + + try { + Get-V2024ScheduledSearch-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ScheduledSearch -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional) + + # List scheduled searches + + try { + Get-V2024ScheduledSearch + + # Below is a request that includes all optional parameters + # Get-V2024ScheduledSearch -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id}/unsubscribe + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $TypedReference = @" + { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + "@ + + # Unsubscribe a recipient from Scheduled Search + + try { + $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference + Invoke-V2024UnsubscribeScheduledSearch-V2024Id $Id -V2024TypedReference $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024UnsubscribeScheduledSearch -V2024Id $Id -V2024TypedReference $TypedReference + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024UnsubscribeScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $ScheduledSearch = @" + { + "owner" : { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "displayQueryDetails" : false, + "created" : "", + "description" : "Daily disabled accounts", + "ownerId" : "2c9180867624cbd7017642d8c8c81f67", + "enabled" : false, + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "recipients" : [ { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + } ], + "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", + "name" : "Daily disabled accounts", + "modified" : "", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "emailEmptyResults" : false + } + "@ + + # Update an existing Scheduled Search + + try { + $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch + Update-V2024ScheduledSearch-V2024Id $Id -V2024ScheduledSearch $Result + + # Below is a request that includes all optional parameters + # Update-V2024ScheduledSearch -V2024Id $Id -V2024ScheduledSearch $ScheduledSearch + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /search/aggregate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + } + "@ + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Perform a Search Query Aggregation + + try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-V2024Aggregate-V2024Search $Result + + # Below is a request that includes all optional parameters + # Search-V2024Aggregate -V2024Search $Search -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Aggregate" + Write-Host $_.ErrorDetails + } +- path: /search/count + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + } + "@ + + # Count Documents Satisfying a Query + + try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-V2024Count-V2024Search $Result + + # Below is a request that includes all optional parameters + # Search-V2024Count -V2024Search $Search + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Count" + Write-Host $_.ErrorDetails + } +- path: /search/{index}/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Get a Document by ID + + try { + Search-V2024Get-V2024Index $Index -V2024Id $Id + + # Below is a request that includes all optional parameters + # Search-V2024Get -V2024Index $Index -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Get" + Write-Host $_.ErrorDetails + } +- path: /search + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + } + "@ + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Perform Search + + try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-V2024Post-V2024Search $Result + + # Below is a request that includes all optional parameters + # Search-V2024Post -V2024Search $Search -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024Post" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SearchAttributeConfig = @" + { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } + "@ + + # Create Extended Search Attributes + + try { + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-V2024SearchAttributeConfig-V2024SearchAttributeConfig $Result + + # Below is a request that includes all optional parameters + # New-V2024SearchAttributeConfig -V2024SearchAttributeConfig $SearchAttributeConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. + + # Delete Extended Search Attribute + + try { + Remove-V2024SearchAttributeConfig-V2024Name $Name + + # Below is a request that includes all optional parameters + # Remove-V2024SearchAttributeConfig -V2024Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Extended Search Attributes + + try { + Get-V2024SearchAttributeConfig + + # Below is a request that includes all optional parameters + # Get-V2024SearchAttributeConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to retrieve. + + # Get Extended Search Attribute + + try { + Get-V2024SingleSearchAttributeConfig-V2024Name $Name + + # Below is a request that includes all optional parameters + # Get-V2024SingleSearchAttributeConfig -V2024Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SingleSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Extended Search Attribute + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SearchAttributeConfig-V2024Name $Name -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SearchAttributeConfig -V2024Name $Name -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /segments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Segment = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + } + "@ + + # Create Segment + + try { + $Result = ConvertFrom-JsonToSegment -Json $Segment + New-V2024Segment-V2024Segment $Result + + # Below is a request that includes all optional parameters + # New-V2024Segment -V2024Segment $Segment + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Segment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + + # Delete Segment by ID + + try { + Remove-V2024Segment-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Segment -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Segment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + + # Get Segment by ID + + try { + Get-V2024Segment-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Segment -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segment" + Write-Host $_.ErrorDetails + } +- path: /segments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Segments + + try { + Get-V2024Segments + + # Below is a request that includes all optional parameters + # Get-V2024Segments -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Segments" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. + $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ + + + # Update Segment + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2024Segment-V2024Id $Id -V2024RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024Segment -V2024Id $Id -V2024RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Segment" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } + "@ + + # Create new Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-V2024ServiceDeskIntegration-V2024ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # New-V2024ServiceDeskIntegration -V2024ServiceDeskIntegrationDto $ServiceDeskIntegrationDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "anId" # String | ID of Service Desk integration to delete + + # Delete a Service Desk integration + + try { + Remove-V2024ServiceDeskIntegration-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ServiceDeskIntegration -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "anId" # String | ID of the Service Desk integration to get + + # Get a Service Desk integration + + try { + Get-V2024ServiceDeskIntegration-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ServiceDeskIntegration -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + + # Service Desk integration template by scriptName + + try { + Get-V2024ServiceDeskIntegrationTemplate-V2024ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-V2024ServiceDeskIntegrationTemplate -V2024ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrationTemplate" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Service Desk integration types + + try { + Get-V2024ServiceDeskIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-V2024ServiceDeskIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrationTypes" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "name eq "John Doe"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List existing Service Desk integrations + + try { + Get-V2024ServiceDeskIntegrations + + # Below is a request that includes all optional parameters + # Get-V2024ServiceDeskIntegrations -V2024Offset $Offset -V2024Limit $Limit -V2024Sorters $Sorters -V2024Filters $Filters -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ServiceDeskIntegrations" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get the time check configuration + + try { + Get-V2024StatusCheckDetails + + # Below is a request that includes all optional parameters + # Get-V2024StatusCheckDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $PatchServiceDeskIntegrationRequest = @" + + "@ + + # Patch a Service Desk Integration + + try { + $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest + Update-V2024ServiceDeskIntegration-V2024Id $Id -V2024PatchServiceDeskIntegrationRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024ServiceDeskIntegration -V2024Id $Id -V2024PatchServiceDeskIntegrationRequest $PatchServiceDeskIntegrationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } + "@ + + # Update a Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-V2024ServiceDeskIntegration-V2024Id $Id -V2024ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # Send-V2024ServiceDeskIntegration -V2024Id $Id -V2024ServiceDeskIntegrationDto $ServiceDeskIntegrationDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $QueuedCheckConfigDetails = @" + { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } + "@ + + # Update the time check configuration + + try { + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-V2024StatusCheckDetails-V2024QueuedCheckConfigDetails $Result + + # Below is a request that includes all optional parameters + # Update-V2024StatusCheckDetails -V2024QueuedCheckConfigDetails $QueuedCheckConfigDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024StatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Create new SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-V2024SIMIntegration-V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # New-V2024SIMIntegration -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $SimIntegrationDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "12345" # String | The id of the integration to delete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete a SIM integration + + try { + Remove-V2024SIMIntegration-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get a SIM integration details. + + try { + Get-V2024SIMIntegration-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List the existing SIM integrations. + + try { + Get-V2024SIMIntegrations-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SIMIntegrations -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegrations" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" + "@ + + # Patch a SIM beforeProvisioningRule attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024BeforeProvisioningRule-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024BeforeProvisioningRule -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $JsonPatch + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" + "@ + + # Patch a SIM attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024SIMAttributes-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024SIMAttributes -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatch $JsonPatch + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2023-01-03T21:16:22.432Z", + "name" : "aName", + "modified" : "2023-01-03T21:16:22.432Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Update an existing SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + Send-V2024SIMIntegration-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # Send-V2024SIMIntegration -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SimIntegrationDetails $SimIntegrationDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Create SOD policy + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-V2024SodPolicy-V2024SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-V2024SodPolicy -V2024SodPolicy $SodPolicy + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-V2024SodPolicy-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SodPolicy -V2024Id $Id -V2024Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-V2024SodPolicySchedule-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SodPolicySchedule -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. + + # Download custom violation report + + try { + Get-V2024CustomViolationReport-V2024ReportResultId $ReportResultId -V2024FileName $FileName + + # Below is a request that includes all optional parameters + # Get-V2024CustomViolationReport -V2024ReportResultId $ReportResultId -V2024FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-V2024DefaultViolationReport-V2024ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2024DefaultViolationReport -V2024ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get multi-report run task status + + try { + Get-V2024SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-V2024SodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodAllReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + + # Get SOD policy by ID + + try { + Get-V2024SodPolicy-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicy -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + + # Get SOD policy schedule + + try { + Get-V2024SodPolicySchedule-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicySchedule -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + + # Get violation report run status + + try { + Get-V2024SodViolationReportRunStatus-V2024ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2024SodViolationReportRunStatus -V2024ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + + # Get SOD violation report status + + try { + Get-V2024SodViolationReportStatus-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodViolationReportStatus -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + + # List SOD policies + + try { + Get-V2024SodPolicies + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicies -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicies" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch SOD policy by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SodPolicy-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SodPolicy -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-V2024PolicySchedule-V2024Id $Id -V2024SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-V2024PolicySchedule -V2024Id $Id -V2024SodPolicySchedule $SodPolicySchedule + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-V2024SodPolicy-V2024Id $Id -V2024SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-V2024SodPolicy -V2024Id $Id -V2024SodPolicy $SodPolicy + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Evaluate one policy by ID + + try { + Start-V2024EvaluateSodPolicy-V2024Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024EvaluateSodPolicy -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024EvaluateSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + } + "@ + + # Runs all policies for org + + try { + Start-V2024SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-V2024SodAllPoliciesForOrg -V2024MultiPolicyRequest $MultiPolicyRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-V2024SodPolicy-V2024Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024SodPolicy -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityWithNewAccess = @" + { + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-V2024PredictSodViolations-V2024IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-V2024PredictSodViolations -V2024IdentityWithNewAccess $IdentityWithNewAccess + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityWithNewAccess1 = @" + {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} + "@ + + # Check SOD violations + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-V2024ViolationCheck-V2024IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-V2024ViolationCheck -V2024IdentityWithNewAccess1 $IdentityWithNewAccess1 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + $ProvisioningPolicyDto = @" + { + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + } + "@ + + # Create Provisioning Policy + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + New-V2024ProvisioningPolicy-V2024SourceId $SourceId -V2024ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # New-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024ProvisioningPolicyDto $ProvisioningPolicyDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Source = @" + { + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + } + "@ + $ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) + + # Creates a source in IdentityNow. + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + New-V2024Source-V2024Source $Result + + # Below is a request that includes all optional parameters + # New-V2024Source -V2024Source $Source -V2024ProvisionAsCsv $ProvisionAsCsv + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schedules + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Schedule1 = @" + + "@ + + # Create Schedule on Source + + try { + $Result = ConvertFrom-JsonToSchedule1 -Json $Schedule1 + New-V2024SourceSchedule-V2024SourceId $SourceId -V2024Schedule1 $Result + + # Below is a request that includes all optional parameters + # New-V2024SourceSchedule -V2024SourceId $SourceId -V2024Schedule1 $Schedule1 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceSchedule" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Create Schema on Source + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + New-V2024SourceSchema-V2024SourceId $SourceId -V2024Schema $Result + + # Below is a request that includes all optional parameters + # New-V2024SourceSchema -V2024SourceId $SourceId -V2024Schema $Schema + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/remove-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ebbf35756e1140699ce52b233121384a" # String | The source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Remove All Accounts in a Source + + try { + Remove-V2024AccountsAsync-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024AccountsAsync -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountsAsync" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/native-change-detection-config + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete Native Change Detection Configuration + + try { + Remove-V2024NativeChangeDetectionConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024NativeChangeDetectionConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + # Delete Provisioning Policy by UsageType + + try { + Remove-V2024ProvisioningPolicy-V2024SourceId $SourceId -V2024UsageType $UsageType + + # Below is a request that includes all optional parameters + # Remove-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024UsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Delete Source by ID + + try { + Remove-V2024Source-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Source -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schedules/{scheduleType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. + + # Delete Source Schedule by type. + + try { + Remove-V2024SourceSchedule-V2024SourceId $SourceId -V2024ScheduleType $ScheduleType + + # Below is a request that includes all optional parameters + # Remove-V2024SourceSchedule -V2024SourceId $SourceId -V2024ScheduleType $ScheduleType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceSchedule" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + + # Delete Source Schema by ID + + try { + Remove-V2024SourceSchema-V2024SourceId $SourceId -V2024SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Remove-V2024SourceSchema -V2024SourceId $SourceId -V2024SchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + + # Downloads source accounts schema template + + try { + Get-V2024AccountsSchema-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024AccountsSchema -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/correlation-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + + # Get Source Correlation Configuration + + try { + Get-V2024CorrelationConfig-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024CorrelationConfig -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CorrelationConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + + # Downloads source entitlements schema template + + try { + Get-V2024EntitlementsSchema-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024EntitlementsSchema -V2024Id $Id -V2024SchemaName $SchemaName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/native-change-detection-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Native Change Detection Configuration + + try { + Get-V2024NativeChangeDetectionConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024NativeChangeDetectionConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + # Get Provisioning Policy by UsageType + + try { + Get-V2024ProvisioningPolicy-V2024SourceId $SourceId -V2024UsageType $UsageType + + # Below is a request that includes all optional parameters + # Get-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024UsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Get Source by ID + + try { + Get-V2024Source-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Source -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/attribute-sync-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Attribute Sync Config + + try { + Get-V2024SourceAttrSyncConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SourceAttrSyncConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceAttrSyncConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/connectors/source-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "MyId" # String | The Source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Gets source config with language translations + + try { + Get-V2024SourceConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SourceConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/entitlement-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Source Entitlement Request Configuration + + try { + Get-V2024SourceEntitlementRequestConfig-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SourceEntitlementRequestConfig -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/source-health + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + + # Fetches source health by id + + try { + Get-V2024SourceHealth-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024SourceHealth -V2024SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceHealth" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schedules/{scheduleType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. + + # Get Source Schedule by Type + + try { + Get-V2024SourceSchedule-V2024SourceId $SourceId -V2024ScheduleType $ScheduleType + + # Below is a request that includes all optional parameters + # Get-V2024SourceSchedule -V2024SourceId $SourceId -V2024ScheduleType $ScheduleType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchedule" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schedules + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # List Schedules on Source + + try { + Get-V2024SourceSchedules-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024SourceSchedules -V2024SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchedules" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + + # Get Source Schema by ID + + try { + Get-V2024SourceSchema-V2024SourceId $SourceId -V2024SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Get-V2024SourceSchema -V2024SourceId $SourceId -V2024SchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) + $IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional) + + # List Schemas on Source + + try { + Get-V2024SourceSchemas-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024SourceSchemas -V2024SourceId $SourceId -V2024IncludeTypes $IncludeTypes -V2024IncludeNames $IncludeNames + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceSchemas" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/load-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) + $DisableOptimization = "MyDisableOptimization" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) + + # Account Aggregation + + try { + Import-V2024Accounts-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Import-V2024Accounts -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024File $File -V2024DisableOptimization $DisableOptimization + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024Accounts" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $File = # System.IO.FileInfo | (optional) + + # Uploads source accounts schema template + + try { + Import-V2024AccountsSchema-V2024Id $Id + + # Below is a request that includes all optional parameters + # Import-V2024AccountsSchema -V2024Id $Id -V2024File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024AccountsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/upload-connector-file + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $File = # System.IO.FileInfo | (optional) + + # Upload connector file to source + + try { + Import-V2024ConnectorFile-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-V2024ConnectorFile -V2024SourceId $SourceId -V2024File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024ConnectorFile" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + $File = # System.IO.FileInfo | (optional) + + # Uploads source entitlements schema template + + try { + Import-V2024EntitlementsSchema-V2024Id $Id + + # Below is a request that includes all optional parameters + # Import-V2024EntitlementsSchema -V2024Id $Id -V2024SchemaName $SchemaName -V2024File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024EntitlementsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/load-uncorrelated-accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $File = # System.IO.FileInfo | (optional) + + # Process Uncorrelated Accounts + + try { + Import-V2024UncorrelatedAccounts-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Import-V2024UncorrelatedAccounts -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024UncorrelatedAccounts" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + + # Lists ProvisioningPolicies + + try { + Get-V2024ProvisioningPolicies-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024ProvisioningPolicies -V2024SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ProvisioningPolicies" + Write-Host $_.ErrorDetails + } +- path: /sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Employees"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) + $ForSubadmin = "name" # String | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) + $IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false) + + # Lists all sources in IdentityNow. + + try { + Get-V2024Sources + + # Below is a request that includes all optional parameters + # Get-V2024Sources -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters -V2024ForSubadmin $ForSubadmin -V2024IncludeIDNSource $IncludeIDNSource + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Sources" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/peek-resource-objects + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ResourceObjectsRequest = @" + { + "maxCount" : 100, + "objectType" : "group" + } + "@ + + # Peek source connector's resource objects + + try { + $Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest + Receive-V2024ResourceObjects-V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental -V2024ResourceObjectsRequest $Result + + # Below is a request that includes all optional parameters + # Receive-V2024ResourceObjects -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental -V2024ResourceObjectsRequest $ResourceObjectsRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Receive-V2024ResourceObjects" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/ping-cluster + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Ping cluster for source connector + + try { + Ping-V2024Cluster-V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Ping-V2024Cluster -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-V2024Cluster" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/correlation-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $CorrelationConfig = @" + { + "attributeAssignments" : [ { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + }, { + "filterString" : "first_name == \"John\"", + "ignoreCase" : false, + "complex" : false, + "property" : "first_name", + "value" : "firstName", + "operation" : "EQ", + "matchMode" : "ANYWHERE" + } ], + "name" : "Source [source] Account Correlation", + "id" : "2c9180835d191a86015d28455b4a2329" + } + "@ + + # Update Source Correlation Configuration + + try { + $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig + Send-V2024CorrelationConfig-V2024Id $Id -V2024CorrelationConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024CorrelationConfig -V2024Id $Id -V2024CorrelationConfig $CorrelationConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024CorrelationConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/native-change-detection-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $NativeChangeDetectionConfig = @" + { + "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], + "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], + "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], + "allNonEntitlementAttributes" : false, + "allEntitlements" : false, + "enabled" : true + } + "@ + + # Update Native Change Detection Configuration + + try { + $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig + Send-V2024NativeChangeDetectionConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024NativeChangeDetectionConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024NativeChangeDetectionConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024NativeChangeDetectionConfig $NativeChangeDetectionConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024NativeChangeDetectionConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $ProvisioningPolicyDto = @" + { + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + } + "@ + + # Update Provisioning Policy by UsageType + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Send-V2024ProvisioningPolicy-V2024SourceId $SourceId -V2024UsageType $UsageType -V2024ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Send-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024UsageType $UsageType -V2024ProvisioningPolicyDto $ProvisioningPolicyDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Source = @" + { + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + } + "@ + + # Update Source (Full) + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + Send-V2024Source-V2024Id $Id -V2024Source $Result + + # Below is a request that includes all optional parameters + # Send-V2024Source -V2024Id $Id -V2024Source $Source + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/attribute-sync-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $AttrSyncSourceConfig = @" + { + "attributes" : [ { + "name" : "email", + "displayName" : "Email", + "enabled" : true, + "target" : "mail" + }, { + "name" : "firstname", + "displayName" : "First Name", + "enabled" : false, + "target" : "givenName" + } ], + "source" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + } + } + "@ + + # Update Attribute Sync Config + + try { + $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig + Send-V2024SourceAttrSyncConfig-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024AttrSyncSourceConfig $Result + + # Below is a request that includes all optional parameters + # Send-V2024SourceAttrSyncConfig -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024AttrSyncSourceConfig $AttrSyncSourceConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SourceAttrSyncConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Update Source Schema (Full) + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + Send-V2024SourceSchema-V2024SourceId $SourceId -V2024SchemaId $SchemaId -V2024Schema $Result + + # Below is a request that includes all optional parameters + # Send-V2024SourceSchema -V2024SourceId $SourceId -V2024SchemaId $SchemaId -V2024Schema $Schema + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/synchronize-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "MyId" # String | The Source id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Synchronize single source attributes. + + try { + Sync-V2024AttributesForSource-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Sync-V2024AttributesForSource -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-V2024AttributesForSource" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/test-configuration + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Test configuration for source connector + + try { + Test-V2024SourceConfiguration-V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Test-V2024SourceConfiguration -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SourceConfiguration" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connector/check-connection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Check connection for source connector. + + try { + Test-V2024SourceConnection-V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Test-V2024SourceConnection -V2024SourceId $SourceId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SourceConnection" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/password-policies + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $PasswordPolicyHoldersDtoInner = @""@ + + + # Update Password Policy + + try { + $Result = ConvertFrom-JsonToPasswordPolicyHoldersDtoInner -Json $PasswordPolicyHoldersDtoInner + Update-V2024PasswordPolicyHolders-V2024SourceId $SourceId -V2024PasswordPolicyHoldersDtoInner $Result + + # Below is a request that includes all optional parameters + # Update-V2024PasswordPolicyHolders -V2024SourceId $SourceId -V2024PasswordPolicyHoldersDtoInner $PasswordPolicyHoldersDtoInner + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024PasswordPolicyHolders" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ProvisioningPolicyDto = @"{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }"@ + + + # Bulk Update Provisioning Policies + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Update-V2024ProvisioningPoliciesInBulk-V2024SourceId $SourceId -V2024ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Update-V2024ProvisioningPoliciesInBulk -V2024SourceId $SourceId -V2024ProvisioningPolicyDto $ProvisioningPolicyDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPoliciesInBulk" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Partial update of Provisioning Policy + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ProvisioningPolicy-V2024SourceId $SourceId -V2024UsageType $UsageType -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ProvisioningPolicy -V2024SourceId $SourceId -V2024UsageType $UsageType -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Source-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Source -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/entitlement-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SourceEntitlementRequestConfig = @" + { + "accessRequestConfig" : { + "denialCommentRequired" : false, + "approvalSchemes" : [ { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", + "approverType" : "GOVERNANCE_GROUP" + } ], + "requestCommentRequired" : true + } + } + "@ + + # Update Source Entitlement Request Configuration + + try { + $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig + Update-V2024SourceEntitlementRequestConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024SourceEntitlementRequestConfig $Result + + # Below is a request that includes all optional parameters + # Update-V2024SourceEntitlementRequestConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024SourceEntitlementRequestConfig $SourceEntitlementRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceEntitlementRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schedules/{scheduleType} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source Schedule (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SourceSchedule-V2024SourceId $SourceId -V2024ScheduleType $ScheduleType -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SourceSchedule -V2024SourceId $SourceId -V2024ScheduleType $ScheduleType -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchedule" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source Schema (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SourceSchema-V2024SourceId $SourceId -V2024SchemaId $SchemaId -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SourceSchema -V2024SourceId $SourceId -V2024SchemaId $SchemaId -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-V2024StatusBySourceId-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024StatusBySourceId -V2024SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusBySourceId" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns source usage insights + + try { + Get-V2024UsagesBySourceId-V2024SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024UsagesBySourceId -V2024SourceId $SourceId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesBySourceId" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ExportPayload = @" + { + "description" : "Export Job 1 Test" + } + "@ + + # Initiates configuration objects export job + + try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-V2024SpConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024ExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-V2024SpConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024ExportPayload $ExportPayload + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Download export job result. + + try { + Get-V2024SpConfigExport-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigExport -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get export job status + + try { + Get-V2024SpConfigExportStatus-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigExportStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Download import job result + + try { + Get-V2024SpConfigImport-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigImport -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get import job status + + try { + Get-V2024SpConfigImportStatus-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigImportStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) + $Options = @" + "@ + + # Initiates configuration objects import job + + try { + Import-V2024SpConfig-V2024XSailPointExperimental $XSailPointExperimental -V2024Data $Data + + # Below is a request that includes all optional parameters + # Import-V2024SpConfig -V2024XSailPointExperimental $XSailPointExperimental -V2024Data $Data -V2024Preview $Preview -V2024Options $Options + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get config object details + + try { + Get-V2024SpConfigObjects-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigObjects -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-batches/{batchId}/stats + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Submit Sed Batch Stats Request + + try { + Get-V2024SedBatchStats-V2024BatchId $BatchId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SedBatchStats -V2024BatchId $BatchId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatchStats" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-batches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List Sed Batch Request + + try { + Get-V2024SedBatches-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SedBatches -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatches" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-descriptions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = limit=25 # Int64 | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) + $Filters = "displayName co "Read and Write"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) + $Sorters = "sorters=displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) + $Count = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) + $CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) + $RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) + $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) + + # List Suggested Entitlement Descriptions + + try { + Get-V2024Seds-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Seds -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Filters $Filters -V2024Sorters $Sorters -V2024Count $Count -V2024CountOnly $CountOnly -V2024RequestedByAnyone $RequestedByAnyone -V2024ShowPendingStatusOnly $ShowPendingStatusOnly + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Seds" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-descriptions + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SedPatch = @"{ + "op" : "replace", + "path" : "status", + "value" : "approved" + }"@ + + + # Patch Suggested Entitlement Description + + try { + $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch + Update-V2024Sed-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SedPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024Sed -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SedPatch $SedPatch + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Sed" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-approvals + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SedApproval = @"{ + "items" : "016629d1-1d25-463f-97f3-c6686846650" + }"@ + + + # Submit Bulk Approval Request + + try { + $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval + Submit-V2024SedApproval-V2024XSailPointExperimental $XSailPointExperimental -V2024SedApproval $Result + + # Below is a request that includes all optional parameters + # Submit-V2024SedApproval -V2024XSailPointExperimental $XSailPointExperimental -V2024SedApproval $SedApproval + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedApproval" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-assignments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SedAssignment = @" + { + "assignee" : { + "type" : "SOURCE_OWNER", + "value" : "016629d1-1d25-463f-97f3-c6686846650" + }, + "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] + } + "@ + + # Submit Sed Assignment Request + + try { + $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment + Submit-V2024SedAssignment-V2024XSailPointExperimental $XSailPointExperimental -V2024SedAssignment $Result + + # Below is a request that includes all optional parameters + # Submit-V2024SedAssignment -V2024XSailPointExperimental $XSailPointExperimental -V2024SedAssignment $SedAssignment + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedAssignment" + Write-Host $_.ErrorDetails + } +- path: /suggested-entitlement-description-batches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SedBatchRequest = @" + { + "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + } + "@ + + # Submit Sed Batch Request + + try { + Submit-V2024SedBatchRequest-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Submit-V2024SedBatchRequest -V2024XSailPointExperimental $XSailPointExperimental -V2024SedBatchRequest $SedBatchRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024SedBatchRequest" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "ACCESS_PROFILE" # String | The type of object to delete tags from. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from. + + # Delete Object Tags + + try { + Remove-V2024TaggedObject-V2024Type $Type -V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024TaggedObject -V2024Type $Type -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/bulk-remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $BulkRemoveTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Remove Tags from Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject + Remove-V2024TagsToManyObject-V2024BulkRemoveTaggedObject $Result + + # Below is a request that includes all optional parameters + # Remove-V2024TagsToManyObject -V2024BulkRemoveTaggedObject $BulkRemoveTaggedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TagsToManyObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + + # Get Tagged Object + + try { + Get-V2024TaggedObject-V2024Type $Type -V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024TaggedObject -V2024Type $Type -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "tagName eq "BU_FINANCE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + + # List Tagged Objects + + try { + Get-V2024TaggedObjects + + # Below is a request that includes all optional parameters + # Get-V2024TaggedObjects -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObjects" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "objectRef.id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + + # List Tagged Objects by Type + + try { + Get-V2024TaggedObjectsByType-V2024Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024TaggedObjectsByType -V2024Type $Type -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObjectsByType" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to update. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to update. + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Update Tagged Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Send-V2024TaggedObject-V2024Type $Type -V2024Id $Id -V2024TaggedObject $Result + + # Below is a request that includes all optional parameters + # Send-V2024TaggedObject -V2024Type $Type -V2024Id $Id -V2024TaggedObject $TaggedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Add Tag to Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Set-V2024TagToObject-V2024TaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-V2024TagToObject -V2024TaggedObject $TaggedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagToObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/bulk-add + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $BulkAddTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Tag Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject + Set-V2024TagsToManyObjects-V2024BulkAddTaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-V2024TagsToManyObjects -V2024BulkAddTaggedObject $BulkAddTaggedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagsToManyObjects" + Write-Host $_.ErrorDetails + } +- path: /task-status/pending-tasks + method: HEAD + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieve Pending Task List Headers + + try { + Get-V2024PendingTaskHeaders-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PendingTaskHeaders -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingTaskHeaders" + Write-Host $_.ErrorDetails + } +- path: /task-status/pending-tasks + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Retrieve Pending Task Status List + + try { + Get-V2024PendingTasks-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024PendingTasks -V2024XSailPointExperimental $XSailPointExperimental -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024PendingTasks" + Write-Host $_.ErrorDetails + } +- path: /task-status/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Task Status by ID + + try { + Get-V2024TaskStatus-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024TaskStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaskStatus" + Write-Host $_.ErrorDetails + } +- path: /task-status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "completionStatus eq "Success"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) + $Sorters = "-created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) + + # Retrieve Task Status List + + try { + Get-V2024TaskStatusList-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024TaskStatusList -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaskStatusList" + Write-Host $_.ErrorDetails + } +- path: /task-status/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Task Status by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024TaskStatus-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024TaskStatus -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024TaskStatus" + Write-Host $_.ErrorDetails + } +- path: /tenant + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Tenant Information. + + try { + Get-V2024Tenant-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Tenant -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Tenant" + Write-Host $_.ErrorDetails + } +- path: /transforms + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Create transform + + try { + $Result = ConvertFrom-JsonToTransform -Json $Transform + New-V2024Transform-V2024Transform $Result + + # Below is a request that includes all optional parameters + # New-V2024Transform -V2024Transform $Transform + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Transform" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete + + # Delete a transform + + try { + Remove-V2024Transform-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Transform -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Transform" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve + + # Transform by ID + + try { + Get-V2024Transform-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Transform -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Transform" + Write-Host $_.ErrorDetails + } +- path: /transforms + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional) + $Filters = "name eq "Uppercase"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) + + # List transforms + + try { + Get-V2024Transforms + + # Below is a request that includes all optional parameters + # Get-V2024Transforms -V2024Offset $Offset -V2024Limit $Limit -V2024Count $Count -V2024Name $Name -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Transforms" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Update a transform + + try { + Update-V2024Transform-V2024Id $Id + + # Below is a request that includes all optional parameters + # Update-V2024Transform -V2024Id $Id -V2024Transform $Transform + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Transform" + Write-Host $_.ErrorDetails + } +- path: /trigger-invocations/{id}/complete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the invocation to complete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $CompleteInvocation = @" + { + "output" : { + "approved" : false + }, + "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "error" : "Access request is denied." + } + "@ + + # Complete Trigger Invocation + + try { + $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation + Complete-V2024TriggerInvocation-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024CompleteInvocation $Result + + # Below is a request that includes all optional parameters + # Complete-V2024TriggerInvocation -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024CompleteInvocation $CompleteInvocation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024TriggerInvocation" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SubscriptionPostRequest = @" + { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "triggerId" : "idn:access-requested", + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + } + "@ + + # Create a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest + New-V2024Subscription-V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPostRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024Subscription -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPostRequest $SubscriptionPostRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Subscription" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete a Subscription + + try { + Remove-V2024Subscription-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024Subscription -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Subscription" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional) + $Sorters = "triggerName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) + + # List Subscriptions + + try { + Get-V2024Subscriptions-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Subscriptions -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Subscriptions" + Write-Host $_.ErrorDetails + } +- path: /trigger-invocations/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "triggerId eq "idn:access-request-dynamic-approver"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) + + # List Latest Invocation Statuses + + try { + Get-V2024TriggerInvocationStatus-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024TriggerInvocationStatus -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TriggerInvocationStatus" + Write-Host $_.ErrorDetails + } +- path: /triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "idn:access-request-post-approval"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** (optional) + + # List Triggers + + try { + Get-V2024Triggers-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024Triggers -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Triggers" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription to patch + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SubscriptionPatchRequestInner = @""@ + + + # Patch a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner + Update-V2024Subscription-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPatchRequestInner $Result + + # Below is a request that includes all optional parameters + # Update-V2024Subscription -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPatchRequestInner $SubscriptionPatchRequestInner + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription" + Write-Host $_.ErrorDetails + } +- path: /trigger-invocations/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TestInvocation = @" + { + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + }, + "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], + "triggerId" : "idn:access-request-post-approval", + "contentJson" : { + "workflowId" : 1234 + } + } + "@ + + # Start a Test Invocation + + try { + $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation + Start-V2024TestTriggerInvocation-V2024XSailPointExperimental $XSailPointExperimental -V2024TestInvocation $Result + + # Below is a request that includes all optional parameters + # Start-V2024TestTriggerInvocation -V2024XSailPointExperimental $XSailPointExperimental -V2024TestInvocation $TestInvocation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024TestTriggerInvocation" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/validate-filter + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ValidateFilterInputDto = @" + { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "input" : { + "identityId" : "201327fda1c44704ac01181e963d463c" + } + } + "@ + + # Validate a Subscription Filter + + try { + $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto + Test-V2024SubscriptionFilter-V2024XSailPointExperimental $XSailPointExperimental -V2024ValidateFilterInputDto $Result + + # Below is a request that includes all optional parameters + # Test-V2024SubscriptionFilter -V2024XSailPointExperimental $XSailPointExperimental -V2024ValidateFilterInputDto $ValidateFilterInputDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SubscriptionFilter" + Write-Host $_.ErrorDetails + } +- path: /trigger-subscriptions/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SubscriptionPutRequest = @" + { + "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", + "httpConfig" : { + "bearerTokenAuthConfig" : { + "bearerToken" : "bearerToken" + }, + "httpAuthenticationType" : "BASIC_AUTH", + "httpDispatchMode" : "SYNC", + "basicAuthConfig" : { + "password" : "password", + "userName" : "user@example.com" + }, + "url" : "https://www.example.com" + }, + "name" : "Access request subscription", + "description" : "Access requested to site xyz", + "eventBridgeConfig" : { + "awsRegion" : "us-west-1", + "awsAccount" : "123456789012" + }, + "responseDeadline" : "PT1H", + "type" : "HTTP", + "enabled" : true + } + "@ + + # Update a Subscription + + try { + $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest + Update-V2024Subscription-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPutRequest $Result + + # Below is a request that includes all optional parameters + # Update-V2024Subscription -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental -V2024SubscriptionPutRequest $SubscriptionPutRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Subscription" + Write-Host $_.ErrorDetails + } +- path: /ui-metadata/tenant + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get a tenant UI metadata + + try { + Get-V2024TenantUiMetadata-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024TenantUiMetadata -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantUiMetadata" + Write-Host $_.ErrorDetails + } +- path: /ui-metadata/tenant + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TenantUiMetadataItemUpdateRequest = @" + { + "usernameEmptyText" : "Please provide your work email address...", + "usernameLabel" : "Email", + "iframeWhiteList" : "http://example.com http://example2.com" + } + "@ + + # Update tenant UI metadata + + try { + $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest + Set-V2024TenantUiMetadata-V2024XSailPointExperimental $XSailPointExperimental -V2024TenantUiMetadataItemUpdateRequest $Result + + # Below is a request that includes all optional parameters + # Set-V2024TenantUiMetadata -V2024XSailPointExperimental $XSailPointExperimental -V2024TenantUiMetadataItemUpdateRequest $TenantUiMetadataItemUpdateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TenantUiMetadata" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $VendorConnectorMapping = @" + { + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + } + "@ + + # Create Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + New-V2024VendorConnectorMapping-V2024VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # New-V2024VendorConnectorMapping -V2024VendorConnectorMapping $VendorConnectorMapping + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VendorConnectorMapping" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $VendorConnectorMapping = @" + { + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + } + "@ + + # Delete Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + Remove-V2024VendorConnectorMapping-V2024VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # Remove-V2024VendorConnectorMapping -V2024VendorConnectorMapping $VendorConnectorMapping + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024VendorConnectorMapping" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Vendor Connector Mappings + + try { + Get-V2024VendorConnectorMappings + + # Below is a request that includes all optional parameters + # Get-V2024VendorConnectorMappings + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024VendorConnectorMappings" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-V2024WorkflowExecution-V2024Id $Id + + # Below is a request that includes all optional parameters + # Suspend-V2024WorkflowExecution -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $CreateExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + New-V2024ExternalExecuteWorkflow-V2024Id $Id + + # Below is a request that includes all optional parameters + # New-V2024ExternalExecuteWorkflow -V2024Id $Id -V2024CreateExternalExecuteWorkflowRequest $CreateExternalExecuteWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreateWorkflowRequest = @" + {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-V2024Workflow-V2024CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024Workflow -V2024CreateWorkflowRequest $CreateWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + New-V2024WorkflowExternalTrigger-V2024Id $Id + + # Below is a request that includes all optional parameters + # New-V2024WorkflowExternalTrigger -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024WorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-V2024Workflow-V2024Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Workflow -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Get Workflow By Id + + try { + Get-V2024Workflow-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Workflow -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-V2024WorkflowExecution-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecution -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + + # Get Workflow Execution History + + try { + Get-V2024WorkflowExecutionHistory-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecutionHistory -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-V2024WorkflowExecutions-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecutions -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Complete Workflow Library + + try { + Get-V2024CompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-V2024CompleteWorkflowLibrary -V2024Limit $Limit -V2024Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Actions + + try { + Get-V2024WorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryActions -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Workflow Library Operators + + try { + Get-V2024WorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Triggers + + try { + Get-V2024WorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryTriggers -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Workflows + + try { + Get-V2024Workflows + + # Below is a request that includes all optional parameters + # Get-V2024Workflows + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Workflow-V2024Id $Id -V2024JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Workflow -V2024Id $Id -V2024JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-V2024Workflow-V2024Id $Id -V2024WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-V2024Workflow -V2024Id $Id -V2024WorkflowBody $WorkflowBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-V2024ExternalExecuteWorkflow-V2024Id $Id + + # Below is a request that includes all optional parameters + # Test-V2024ExternalExecuteWorkflow -V2024Id $Id -V2024TestExternalExecuteWorkflowRequest $TestExternalExecuteWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-V2024Workflow-V2024Id $Id -V2024TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-V2024Workflow -V2024Id $Id -V2024TestWorkflowRequest $TestWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Approve an Approval Item + + try { + Approve-V2024ApprovalItem-V2024Id $Id -V2024ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Approve-V2024ApprovalItem -V2024Id $Id -V2024ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk approve Approval Items + + try { + Approve-V2024ApprovalItemsInBulk-V2024Id $Id + + # Below is a request that includes all optional parameters + # Approve-V2024ApprovalItemsInBulk -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-V2024ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Complete a Work Item + + try { + Complete-V2024WorkItem-V2024Id $Id + + # Below is a request that includes all optional parameters + # Complete-V2024WorkItem -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024WorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Completed Work Items + + try { + Get-V2024CompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-V2024CompletedWorkItems -V2024OwnerId $OwnerId -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # Count Completed Work Items + + try { + Get-V2024CountCompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-V2024CountCompletedWorkItems -V2024OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountCompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) + + # Count Work Items + + try { + Get-V2024CountWorkItems + + # Below is a request that includes all optional parameters + # Get-V2024CountWorkItems -V2024OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. + + # Get a Work Item + + try { + Get-V2024WorkItem-V2024Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkItem -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # Work Items Summary + + try { + Get-V2024WorkItemsSummary + + # Below is a request that includes all optional parameters + # Get-V2024WorkItemsSummary -V2024OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItemsSummary" + Write-Host $_.ErrorDetails + } +- path: /work-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # List Work Items + + try { + Get-V2024WorkItems + + # Below is a request that includes all optional parameters + # Get-V2024WorkItems -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Reject an Approval Item + + try { + Deny-V2024ApprovalItem-V2024Id $Id -V2024ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Deny-V2024ApprovalItem -V2024Id $Id -V2024ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk reject Approval Items + + try { + Deny-V2024ApprovalItemsInBulk-V2024Id $Id + + # Below is a request that includes all optional parameters + # Deny-V2024ApprovalItemsInBulk -V2024Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $WorkItemForward = @" + { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } + "@ + + # Forward a Work Item + + try { + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Send-V2024WorkItemForward-V2024Id $Id -V2024WorkItemForward $Result + + # Below is a request that includes all optional parameters + # Send-V2024WorkItemForward -V2024Id $Id -V2024WorkItemForward $WorkItemForward + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024WorkItemForward" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName + + # Submit Account Selections + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-V2024AccountSelection-V2024Id $Id -V2024RequestBody $Result + + # Below is a request that includes all optional parameters + # Submit-V2024AccountSelection -V2024Id $Id -V2024RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024AccountSelection" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ + + # Create a Reassignment Configuration + + try { + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + New-V2024ReassignmentConfiguration-V2024XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ReassignmentConfiguration -V2024XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $ConfigurationItemRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId}/{configType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete Reassignment Configuration + + try { + Remove-V2024ReassignmentConfiguration-V2024IdentityId $IdentityId -V2024ConfigType $ConfigType -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024ReassignmentConfiguration -V2024IdentityId $IdentityId -V2024ConfigType $ConfigType -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId}/evaluate/{configType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) + + $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ + + # Evaluate Reassignment Configuration + + try { + Get-V2024EvaluateReassignmentConfiguration-V2024IdentityId $IdentityId -V2024ConfigType $ConfigType -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024EvaluateReassignmentConfiguration -V2024IdentityId $IdentityId -V2024ConfigType $ConfigType -V2024XSailPointExperimental $XSailPointExperimental -V2024ExclusionFilters $ExclusionFilters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EvaluateReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List Reassignment Config Types + + try { + Get-V2024ReassignmentConfigTypes-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ReassignmentConfigTypes -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigTypes" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Reassignment Configuration + + try { + Get-V2024ReassignmentConfiguration-V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ReassignmentConfiguration -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/tenant-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get Tenant-wide Reassignment Configuration settings + + try { + Get-V2024TenantConfigConfiguration-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024TenantConfigConfiguration -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantConfigConfiguration" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List Reassignment Configurations + + try { + Get-V2024ReassignmentConfigurations-V2024XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024ReassignmentConfigurations -V2024XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ReassignmentConfigurations" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/{identityId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $ConfigurationItemRequest = @" + { + "endDate" : "2022-07-30T17:00:00Z", + "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", + "configType" : "ACCESS_REQUESTS", + "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", + "startDate" : "2022-07-21T11:13:12.345Z" + } + "@ + + # Update Reassignment Configuration + + try { + $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest + Send-V2024ReassignmentConfig-V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2024ReassignmentConfig -V2024IdentityId $IdentityId -V2024XSailPointExperimental $XSailPointExperimental -V2024ConfigurationItemRequest $ConfigurationItemRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ReassignmentConfig" + Write-Host $_.ErrorDetails + } +- path: /reassignment-configurations/tenant-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $TenantConfigurationRequest = @" + { + "configDetails" : { + "disabled" : true + } + } + "@ + + # Update Tenant-wide Reassignment Configuration settings + + try { + $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest + Send-V2024TenantConfiguration-V2024XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2024TenantConfiguration -V2024XSailPointExperimental $XSailPointExperimental -V2024TenantConfigurationRequest $TenantConfigurationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TenantConfiguration" + Write-Host $_.ErrorDetails + } diff --git a/static/code-examples/v3/Examples/code_examples_overlay.yaml b/static/code-examples/v3/Examples/code_examples_overlay.yaml new file mode 100644 index 000000000..2cdc18afd --- /dev/null +++ b/static/code-examples/v3/Examples/code_examples_overlay.yaml @@ -0,0 +1,10081 @@ +- path: /access-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessProfile = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "created" : "2021-03-01T22:32:58.104Z", + "description" : "Collection of entitlements to read/write the employee database", + "source" : { + "name" : "ODS-AD-SOURCE", + "id" : "2c91809773dee3610173fdb0b6061ef4", + "type" : "SOURCE" + }, + "enabled" : true, + "revocationRequestConfig" : { + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ] + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "accessRequestConfig" : { + "commentsRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "name" : "Employee-database-read-write", + "provisioningCriteria" : { + "children" : [ { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : [ { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, { + "children" : "children", + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + } ], + "attribute" : "email", + "operation" : "EQUALS", + "value" : "carlee.cert1c9f9b6fd@mailinator.com" + }, + "modified" : "2021-03-02T20:22:28.104Z", + "id" : "2c91808a7190d06e01719938fcd20792", + "requestable" : true + } + "@ + + # Create Access Profile + + try { + $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile + New-AccessProfile-AccessProfile $Result + + # Below is a request that includes all optional parameters + # New-AccessProfile -AccessProfile $AccessProfile + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete + + # Delete the specified Access Profile + + try { + Remove-AccessProfile-Id $Id + + # Below is a request that includes all optional parameters + # Remove-AccessProfile -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessProfileBulkDeleteRequest = @" + { + "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], + "bestEffortOnly" : true + } + "@ + + # Delete Access Profile(s) + + try { + $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest + Remove-AccessProfilesInBulk-AccessProfileBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-AccessProfilesInBulk -AccessProfileBulkDeleteRequest $AccessProfileBulkDeleteRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-AccessProfilesInBulk" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile + + # Get an Access Profile + + try { + Get-AccessProfile-Id $Id + + # Below is a request that includes all optional parameters + # Get-AccessProfile -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) + + # List Access Profile's Entitlements + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessProfileEntitlements" + Write-Host $_.ErrorDetails + } +- path: /access-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin. (optional) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Composite operators supported: *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + + # List Access Profiles + + try { + Get-AccessProfiles + + # Below is a request that includes all optional parameters + # Get-AccessProfiles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessProfiles" + Write-Host $_.ErrorDetails + } +- path: /access-profiles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Access Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AccessProfile-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AccessProfile -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AccessProfile" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + } + "@ + + # Approve Access Request Approval + + try { + Approve-AccessRequest-ApprovalId $ApprovalId + + # Below is a request that includes all optional parameters + # Approve-AccessRequest -ApprovalId $ApprovalId -CommentDto $CommentDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $ForwardApprovalDto = @" + { + "newOwnerId" : "2c91808568c529c60168cca6f90c1314", + "comment" : "2c91808568c529c60168cca6f90c1313" + } + "@ + + # Forward Access Request Approval + + try { + $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto + Invoke-ForwardAccessRequest-ApprovalId $ApprovalId -ForwardApprovalDto $Result + + # Below is a request that includes all optional parameters + # Invoke-ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $ForwardApprovalDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ForwardAccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/approval-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) + + # Get Access Requests Approvals Number + + try { + Get-AccessRequestApprovalSummary + + # Below is a request that includes all optional parameters + # Get-AccessRequestApprovalSummary -OwnerId $OwnerId -FromDate $FromDate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessRequestApprovalSummary" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) + $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Completed Access Request Approvals List + + try { + Get-CompletedApprovals + + # Below is a request that includes all optional parameters + # Get-CompletedApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedApprovals" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/pending + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional) + $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Pending Access Request Approvals List + + try { + Get-PendingApprovals + + # Below is a request that includes all optional parameters + # Get-PendingApprovals -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PendingApprovals" + Write-Host $_.ErrorDetails + } +- path: /access-request-approvals/{approvalId}/reject + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. + $CommentDto = @" + { + "created" : "2017-07-11T18:45:37.098Z", + "author" : { + "name" : "john.doe", + "id" : "2c9180847e25f377017e2ae8cae4650b", + "type" : "IDENTITY" + }, + "comment" : "This is a comment." + } + "@ + + # Reject Access Request Approval + + try { + $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto + Deny-AccessRequest-ApprovalId $ApprovalId -CommentDto $Result + + # Below is a request that includes all optional parameters + # Deny-AccessRequest -ApprovalId $ApprovalId -CommentDto $CommentDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-requests/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CancelAccessRequest = @" + { + "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I requested this role by mistake." + } + "@ + + # Cancel Access Request + + try { + $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest + Suspend-AccessRequest-CancelAccessRequest $Result + + # Below is a request that includes all optional parameters + # Suspend-AccessRequest -CancelAccessRequest $CancelAccessRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessRequest = @" + { + "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE" + } ] + } + "@ + + # Submit Access Request + + try { + $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest + New-AccessRequest-AccessRequest $Result + + # Below is a request that includes all optional parameters + # New-AccessRequest -AccessRequest $AccessRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AccessRequest" + Write-Host $_.ErrorDetails + } +- path: /access-request-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Access Request Configuration + + try { + Get-AccessRequestConfig + + # Below is a request that includes all optional parameters + # Get-AccessRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /access-request-status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + $AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) + $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) + $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) + $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) + $Filters = "accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) + $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) + + # Access Request Status + + try { + Get-AccessRequestStatus + + # Below is a request that includes all optional parameters + # Get-AccessRequestStatus -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -AssignedTo $AssignedTo -Count $Count -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters -RequestState $RequestState + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccessRequestStatus" + Write-Host $_.ErrorDetails + } +- path: /access-request-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccessRequestConfig = @" + { + "requestOnBehalfOfConfig" : { + "allowRequestOnBehalfOfEmployeeByManager" : true, + "allowRequestOnBehalfOfAnyoneByAnyone" : true + }, + "approvalReminderAndEscalationConfig" : { + "fallbackApproverRef" : { + "name" : "Alison Ferguso", + "id" : "5168015d32f890ca15812c9180835d2e", + "type" : "IDENTITY", + "email" : "alison.ferguso@identitysoon.com" + }, + "maxReminders" : 1, + "daysUntilEscalation" : 0, + "daysBetweenReminders" : 0 + }, + "autoApprovalEnabled" : true, + "entitlementRequestConfig" : { + "requestCommentsRequired" : false, + "deniedCommentsRequired" : false, + "allowEntitlementRequest" : true, + "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" + }, + "reauthorizationEnabled" : true, + "approvalsMustBeExternal" : true + } + "@ + + # Update Access Request Configuration + + try { + $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig + Set-AccessRequestConfig-AccessRequestConfig $Result + + # Below is a request that includes all optional parameters + # Set-AccessRequestConfig -AccessRequestConfig $AccessRequestConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-AccessRequestConfig" + Write-Host $_.ErrorDetails + } +- path: /account-activities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id + + # Get an Account Activity + + try { + Get-AccountActivity-Id $Id + + # Below is a request that includes all optional parameters + # Get-AccountActivity -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountActivity" + Write-Host $_.ErrorDetails + } +- path: /account-activities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "2c91808568c529c60168cca6f90c1313" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RequestedBy = "2c91808568c529c60168cca6f90c1313" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) + $RegardingIdentity = "2c91808568c529c60168cca6f90c1313" # String | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "type eq "Identity Refresh"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) + + # List Account Activities + + try { + Get-AccountActivities + + # Below is a request that includes all optional parameters + # Get-AccountActivities -RequestedFor $RequestedFor -RequestedBy $RequestedBy -RegardingIdentity $RegardingIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountActivities" + Write-Host $_.ErrorDetails + } +- path: /accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccountAttributesCreate = @" + { + "attributes" : { + "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Create Account + + try { + $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate + New-Account-AccountAttributesCreate $Result + + # Below is a request that includes all optional parameters + # New-Account -AccountAttributesCreate $AccountAttributesCreate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Delete Account + + try { + Remove-Account-Id $Id + + # Below is a request that includes all optional parameters + # Remove-Account -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/disable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Disable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Disable-Account-Id $Id -AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Disable-Account -Id $Id -AccountToggleRequest $AccountToggleRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/enable + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $AccountToggleRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" + } + "@ + + # Enable Account + + try { + $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest + Enable-Account-Id $Id -AccountToggleRequest $Result + + # Below is a request that includes all optional parameters + # Enable-Account -Id $Id -AccountToggleRequest $AccountToggleRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + + # Account Details + + try { + Get-Account-Id $Id + + # Below is a request that includes all optional parameters + # Get-Account -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Account Entitlements + + try { + Get-AccountEntitlements-Id $Id + + # Below is a request that includes all optional parameters + # Get-AccountEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountEntitlements" + Write-Host $_.ErrorDetails + } +- path: /accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) + $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) + + # Accounts List + + try { + Get-Accounts + + # Below is a request that includes all optional parameters + # Get-Accounts -Limit $Limit -Offset $Offset -Count $Count -DetailLevel $DetailLevel -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Accounts" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $AccountAttributes = @" + { + "attributes" : { + "city" : "Austin", + "displayName" : "John Doe", + "userName" : "jdoe", + "sAMAccountName" : "jDoe", + "mail" : "john.doe@sailpoint.com" + } + } + "@ + + # Update Account + + try { + $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes + Send-Account-Id $Id -AccountAttributes $Result + + # Below is a request that includes all optional parameters + # Send-Account -Id $Id -AccountAttributes $AccountAttributes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/reload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id + + # Reload Account + + try { + Submit-ReloadAccount-Id $Id + + # Below is a request that includes all optional parameters + # Submit-ReloadAccount -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-ReloadAccount" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id}/unlock + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. + $AccountUnlockRequest = @" + { + "forceProvisioning" : false, + "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", + "unlockIDNAccount" : false + } + "@ + + # Unlock Account + + try { + $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest + Unlock-Account-Id $Id -AccountUnlockRequest $Result + + # Below is a request that includes all optional parameters + # Unlock-Account -Id $Id -AccountUnlockRequest $AccountUnlockRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-Account" + Write-Host $_.ErrorDetails + } +- path: /accounts/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. + $RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"[{op=remove, path=/identityId}]"@ + + + # Update Account + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-Account-Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-Account -Id $Id -RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Account" + Write-Host $_.ErrorDetails + } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesByAccountId" + Write-Host $_.ErrorDetails + } +- path: /discovered-applications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) + $Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) + + # Get Discovered Applications for Tenant + + try { + Get-DiscoveredApplications + + # Below is a request that includes all optional parameters + # Get-DiscoveredApplications -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DiscoveredApplications" + Write-Host $_.ErrorDetails + } +- path: /manual-discover-applications-template + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Download CSV Template for Discovery + + try { + Get-ManualDiscoverApplicationsCsvTemplate + + # Below is a request that includes all optional parameters + # Get-ManualDiscoverApplicationsCsvTemplate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } +- path: /manual-discover-applications + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. + + # Upload CSV to Discover Applications + + try { + Send-ManualDiscoverApplicationsCsvTemplate-File $File + + # Below is a request that includes all optional parameters + # Send-ManualDiscoverApplicationsCsvTemplate -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ManualDiscoverApplicationsCsvTemplate" + Write-Host $_.ErrorDetails + } +- path: /auth-users/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + + # Auth User Details + + try { + Get-AuthUser-Id $Id + + # Below is a request that includes all optional parameters + # Get-AuthUser -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthUser" + Write-Host $_.ErrorDetails + } +- path: /auth-users/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Auth User Update + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthUser-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthUser -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthUser" + Write-Host $_.ErrorDetails + } +- path: /brandings + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "MyName" # String | name of branding item + $ProductName = "MyProductName" # String | product name + $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) + $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) + $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) + $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) + $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) + $FileStandard = # System.IO.FileInfo | png file with logo (optional) + + # Create a branding item + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BrandingItem" + Write-Host $_.ErrorDetails + } +- path: /brandings/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "default" # String | The name of the branding item to be deleted + + # Delete a branding item + + try { + Remove-Branding-Name $Name + + # Below is a request that includes all optional parameters + # Remove-Branding -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Branding" + Write-Host $_.ErrorDetails + } +- path: /brandings/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "default" # String | The name of the branding item to be retrieved + + # Get a branding item + + try { + Get-Branding-Name $Name + + # Below is a request that includes all optional parameters + # Get-Branding -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Branding" + Write-Host $_.ErrorDetails + } +- path: /brandings + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List of branding items + + try { + Get-BrandingList + + # Below is a request that includes all optional parameters + # Get-BrandingList + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BrandingList" + Write-Host $_.ErrorDetails + } +- path: /brandings/{name} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "default" # String | The name of the branding item to be retrieved + $Name2 = "Name_example" # String | name of branding item + $ProductName = "MyProductName" # String | product name + $ActionButtonColor = "MyActionButtonColor" # String | hex value of color for action button (optional) + $ActiveLinkColor = "MyActiveLinkColor" # String | hex value of color for link (optional) + $NavigationColor = "MyNavigationColor" # String | hex value of color for navigation bar (optional) + $EmailFromAddress = "MyEmailFromAddress" # String | email from address (optional) + $LoginInformationalMessage = "MyLoginInformationalMessage" # String | login information message (optional) + $FileStandard = # System.IO.FileInfo | png file with logo (optional) + + # Update a branding item + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BrandingItem" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CampaignFilterDetails = @" + { + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + } + "@ + + # Create Campaign Filter + + try { + $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails + New-CampaignFilter-CampaignFilterDetails $Result + + # Below is a request that includes all optional parameters + # New-CampaignFilter -CampaignFilterDetails $CampaignFilterDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CampaignFilter" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters/delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filters to delete. + $RequestBody = @""@ + + + # Deletes Campaign Filters + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-CampaignFilters-RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-CampaignFilters -RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignFilters" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved. + + # Get Campaign Filter by ID + + try { + Get-CampaignFilterById-Id $Id + + # Below is a request that includes all optional parameters + # Get-CampaignFilterById -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignFilterById" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Start = 0 # Int32 | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $IncludeSystemFilters = $true # Boolean | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to $true) + + # List Campaign Filters + + try { + Get-CampaignFilters + + # Below is a request that includes all optional parameters + # Get-CampaignFilters -Limit $Limit -Start $Start -IncludeSystemFilters $IncludeSystemFilters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignFilters" + Write-Host $_.ErrorDetails + } +- path: /campaign-filters/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $FilterId = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter being modified. + $CampaignFilterDetails = @" + { + "owner" : "SailPoint Support", + "mode" : "INCLUSION", + "isSystemFilter" : false, + "name" : "Identity Attribute Campaign Filter", + "description" : "Campaign filter to certify data based on an identity attribute's specified property.", + "id" : "5ec18cef39020d6fd7a60ad3970aba61", + "criteriaList" : [ { + "type" : "IDENTITY_ATTRIBUTE", + "property" : "displayName", + "value" : "support", + "operation" : "CONTAINS", + "negateResult" : false, + "shortCircuit" : false, + "recordChildMatches" : false, + "suppressMatchedItems" : false + } ] + } + "@ + + # Updates a Campaign Filter + + try { + $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails + Update-CampaignFilter-FilterId $FilterId -CampaignFilterDetails $Result + + # Below is a request that includes all optional parameters + # Update-CampaignFilter -FilterId $FilterId -CampaignFilterDetails $CampaignFilterDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-CampaignFilter" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/complete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $CampaignCompleteOptions = @" + { + "autoCompleteAction" : "REVOKE" + } + "@ + + # Complete a Campaign + + try { + Complete-Campaign-Id $Id + + # Below is a request that includes all optional parameters + # Complete-Campaign -Id $Id -CampaignCompleteOptions $CampaignCompleteOptions + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Campaign = @" + { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + } + "@ + + # Create a campaign + + try { + $Result = ConvertFrom-JsonToCampaign -Json $Campaign + New-Campaign-Campaign $Result + + # Below is a request that includes all optional parameters + # New-Campaign -Campaign $Campaign + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CampaignTemplate = @" + { + "ownerRef" : { + "name" : "Mister Manager", + "id" : "2c918086676d3e0601677611dbde220f", + "type" : "IDENTITY", + "email" : "mr.manager@example.com" + }, + "deadlineDuration" : "P2W", + "created" : "2020-03-05T22:44:00.364Z", + "scheduled" : false, + "name" : "Manager Campaign Template", + "description" : "Template for the annual manager campaign.", + "modified" : "2020-03-05T22:52:09.969Z", + "campaign" : { + "totalCertifications" : 100, + "sourcesWithOrphanEntitlements" : [ { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + }, { + "name" : "Source with orphan entitlements", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "SOURCE" + } ], + "recommendationsEnabled" : true, + "sunsetCommentsRequired" : true, + "created" : "2020-03-03T22:15:13.611Z", + "machineAccountCampaignInfo" : { + "reviewerType" : "ACCOUNT_OWNER", + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "description" : "Everyone needs to be reviewed by their manager", + "type" : "MANAGER", + "sourceOwnerCampaignInfo" : { + "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] + }, + "emailNotificationEnabled" : false, + "alerts" : [ { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + }, { + "level" : "ERROR", + "localizations" : [ { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + }, { + "localeOrigin" : "DEFAULT", + "text" : "The request was syntactically correct but its content is semantically invalid.", + "locale" : "en-US" + } ] + } ], + "filter" : { + "name" : "Test Filter", + "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", + "type" : "CAMPAIGN_FILTER" + }, + "searchCampaignInfo" : { + "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], + "query" : "Search Campaign query description", + "description" : "Search Campaign description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "type" : "ACCESS", + "accessConstraints" : [ { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + }, { + "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "type" : "ENTITLEMENT", + "operator" : "SELECTED" + } ] + }, + "autoRevokeAllowed" : false, + "name" : "Manager Campaign", + "mandatoryCommentRequirement" : "NO_DECISIONS", + "modified" : "2020-03-03T22:20:12.674Z", + "roleCompositionCampaignInfo" : { + "remediatorRef" : { + "name" : "Role Admin", + "id" : "2c90ad2a70ace7d50170acf22ca90010", + "type" : "IDENTITY" + }, + "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], + "query" : "Search Query", + "description" : "Role Composition Description", + "reviewer" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + }, + "completedCertifications" : 10, + "id" : "2c9079b270a266a60170a2779fcb0007", + "deadline" : "2020-03-15T10:00:01.456Z", + "status" : "ACTIVE", + "correlatedStatus" : "CORRELATED" + }, + "id" : "2c9079b270a266a60170a277bb960008" + } + "@ + + # Create a Campaign Template + + try { + $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate + New-CampaignTemplate-CampaignTemplate $Result + + # Below is a request that includes all optional parameters + # New-CampaignTemplate -CampaignTemplate $CampaignTemplate + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. + + # Delete a Campaign Template + + try { + Remove-CampaignTemplate-Id $Id + + # Below is a request that includes all optional parameters + # Remove-CampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. + + # Delete Campaign Template Schedule + + try { + Remove-CampaignTemplateSchedule-Id $Id + + # Below is a request that includes all optional parameters + # Remove-CampaignTemplateSchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaigns/delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CampaignsDeleteRequest = @" + { + "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] + } + "@ + + # Delete Campaigns + + try { + $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest + Remove-Campaigns-CampaignsDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-Campaigns -CampaignsDeleteRequest $CampaignsDeleteRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Campaigns" + Write-Host $_.ErrorDetails + } +- path: /campaigns + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Manager Campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) + + # List Campaigns + + try { + Get-ActiveCampaigns + + # Below is a request that includes all optional parameters + # Get-ActiveCampaigns -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ActiveCampaigns" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. + $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) + + # Get Campaign + + try { + Get-Campaign-Id $Id + + # Below is a request that includes all optional parameters + # Get-Campaign -Id $Id -Detail $Detail + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/reports + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. + + # Get Campaign Reports + + try { + Get-CampaignReports-Id $Id + + # Below is a request that includes all optional parameters + # Get-CampaignReports -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignReports" + Write-Host $_.ErrorDetails + } +- path: /campaigns/reports-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Campaign Reports Configuration + + try { + Get-CampaignReportsConfig + + # Below is a request that includes all optional parameters + # Get-CampaignReportsConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignReportsConfig" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. + + # Get a Campaign Template + + try { + Get-CampaignTemplate-Id $Id + + # Below is a request that includes all optional parameters + # Get-CampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. + + # Get Campaign Template Schedule + + try { + Get-CampaignTemplateSchedule-Id $Id + + # Below is a request that includes all optional parameters + # Get-CampaignTemplateSchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $Filters = "name eq "manager template"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) + + # List Campaign Templates + + try { + Get-CampaignTemplates + + # Below is a request that includes all optional parameters + # Get-CampaignTemplates -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplates" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/reassign + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID + $AdminReviewReassign = @" + { + "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], + "reason" : "reassigned for some reason", + "reassignTo" : { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "IDENTITY" + } + } + "@ + + # Reassign Certifications + + try { + $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign + Move--Id $Id -AdminReviewReassign $Result + + # Below is a request that includes all optional parameters + # Move- -Id $Id -AdminReviewReassign $AdminReviewReassign + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update a Campaign Template + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-CampaignTemplate-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-CampaignTemplate -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-CampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaigns/reports-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CampaignReportsConfig = @" + { + "identityAttributeColumns" : [ "firstname", "lastname" ] + } + "@ + + # Set Campaign Reports Configuration + + try { + $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig + Set-CampaignReportsConfig-CampaignReportsConfig $Result + + # Below is a request that includes all optional parameters + # Set-CampaignReportsConfig -CampaignReportsConfig $CampaignReportsConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-CampaignReportsConfig" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template being scheduled. + $Schedule = @" + { + "hours" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "months" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "timeZoneId" : "CST", + "days" : { + "values" : [ "1" ], + "interval" : 2, + "type" : "LIST" + }, + "expiration" : "2000-01-23T04:56:07.000+00:00", + "type" : "WEEKLY" + } + "@ + + # Set Campaign Template Schedule + + try { + Set-CampaignTemplateSchedule-Id $Id + + # Below is a request that includes all optional parameters + # Set-CampaignTemplateSchedule -Id $Id -Schedule $Schedule + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-CampaignTemplateSchedule" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/activate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. + $ActivateCampaignOptions = @" + { + "timeZone" : "-05:00" + } + "@ + + # Activate a Campaign + + try { + Start-Campaign-Id $Id + + # Below is a request that includes all optional parameters + # Start-Campaign -Id $Id -ActivateCampaignOptions $ActivateCampaignOptions + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-Campaign" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/run-remediation-scan + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. + + # Run Campaign Remediation Scan + + try { + Start-CampaignRemediationScan-Id $Id + + # Below is a request that includes all optional parameters + # Start-CampaignRemediationScan -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-CampaignRemediationScan" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id}/run-report/{type} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. + $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run. + + # Run Campaign Report + + try { + Start-CampaignReport-Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Start-CampaignReport -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-CampaignReport" + Write-Host $_.ErrorDetails + } +- path: /campaign-templates/{id}/generate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. + + # Generate a Campaign from Template + + try { + Start-GenerateCampaignTemplate-Id $Id + + # Below is a request that includes all optional parameters + # Start-GenerateCampaignTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-GenerateCampaignTemplate" + Write-Host $_.ErrorDetails + } +- path: /campaigns/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update a Campaign + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Campaign-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-Campaign -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Campaign" + Write-Host $_.ErrorDetails + } +- path: /certification-tasks/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID + + # Certification Task by ID + + try { + Get-CertificationTask-Id $Id + + # Below is a request that includes all optional parameters + # Get-CertificationTask -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CertificationTask" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id + + # Identity Certification by ID + + try { + Get-IdentityCertification-Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentityCertification -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityCertification" + Write-Host $_.ErrorDetails + } +- path: /certifications/{certificationId}/access-review-items/{itemId}/permissions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID + $Filters = "target eq "SYS.OBJAUTH2"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Permissions for Entitlement Certification Item + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityCertificationItemPermissions" + Write-Host $_.ErrorDetails + } +- path: /certification-tasks + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReviewerIdentity = "Ada.1de82e55078344" # String | The ID of reviewer identity. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "type eq "ADMIN_REASSIGN"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) + + # List of Pending Certification Tasks + + try { + Get-PendingCertificationTasks + + # Below is a request that includes all optional parameters + # Get-PendingCertificationTasks -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PendingCertificationTasks" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reviewers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) + + # List of Reviewers for certification + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CertificationReviewers" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/access-review-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **type**: *eq* **access.type**: *eq* **completed**: *eq, ne* **identitySummary.id**: *eq, in* **identitySummary.name**: *eq, sw* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name,-accessProfile.sourceName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitySummary.name, access.name, access.type, entitlement.sourceName, accessProfile.sourceName** (optional) + $Entitlements = "identityEntitlement" # String | Filter results to view access review items that pertain to any of the specified comma-separated entitlement IDs. An error will occur if this param is used with **access-profiles** or **roles** as only one of these query params can be used at a time. (optional) + $AccessProfiles = "accessProfile1" # String | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) + $Roles = "userRole" # String | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) + + # List of Access Review Items + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessReviewItems" + Write-Host $_.ErrorDetails + } +- path: /certifications + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReviewerIdentity = "me" # String | Reviewer's identity. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) + $Sorters = "name,due" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) + + # List Identity Campaign Certifications + + try { + Get-IdentityCertifications + + # Below is a request that includes all optional parameters + # Get-IdentityCertifications -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityCertifications" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decide + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campaign certification on which to make decisions + $ReviewDecision = @"{ + "comments" : "This user no longer needs access to this source", + "decision" : "APPROVE", + "proposedEndDate" : "2017-07-11T18:45:37.098Z", + "recommendation" : { + "reasons" : [ "Reason 1", "Reason 2" ], + "recommendation" : "recommendation", + "timestamp" : "2020-06-01T13:49:37.385Z" + }, + "id" : "ef38f94347e94562b5bb8424a56397d8", + "bulk" : true + }"@ + + + # Decide on a Certification Item + + try { + $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision + Select-IdentityDecision-Id $Id -ReviewDecision $Result + + # Below is a request that includes all optional parameters + # Select-IdentityDecision -Id $Id -ReviewDecision $ReviewDecision + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Select-IdentityDecision" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reassign + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $ReviewReassign = @" + { + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + } + "@ + + # Reassign Identities or Items + + try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Invoke-ReassignIdentityCertifications-Id $Id -ReviewReassign $Result + + # Below is a request that includes all optional parameters + # Invoke-ReassignIdentityCertifications -Id $Id -ReviewReassign $ReviewReassign + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ReassignIdentityCertifications" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/sign-off + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + + # Finalize Identity Certification Decisions + + try { + Invoke-SignOffIdentityCertification-Id $Id + + # Below is a request that includes all optional parameters + # Invoke-SignOffIdentityCertification -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-SignOffIdentityCertification" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/reassign-async + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $ReviewReassign = @" + { + "reason" : "reassigned for some reason", + "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", + "reassign" : [ { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + }, { + "id" : "ef38f94347e94562b5bb8424a56397d8", + "type" : "ITEM" + } ] + } + "@ + + # Reassign Certifications Asynchronously + + try { + $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign + Submit-ReassignCertsAsync-Id $Id -ReviewReassign $Result + + # Below is a request that includes all optional parameters + # Submit-ReassignCertsAsync -Id $Id -ReviewReassign $ReviewReassign + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-ReassignCertsAsync" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + + # Access Summaries + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-IdentityDecisionSummary-Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentityDecisionSummary -Id $Id -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Identity Summaries for Campaign Certification + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-IdentitySummary-Id $Id -IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummary" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingRequest = @" + { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } + "@ + + # Creates an object mapping + + try { + $Result = ConvertFrom-JsonToObjectMappingRequest -Json $ObjectMappingRequest + New-ObjectMapping-SourceOrg $SourceOrg -ObjectMappingRequest $Result + + # Below is a request that includes all optional parameters + # New-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $ObjectMappingRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ObjectMapping" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-create + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingBulkCreateRequest = @" + { + "newObjectsMappings" : [ { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + }, { + "targetValue" : "My New Governance Group Name", + "jsonPath" : "$.name", + "sourceValue" : "My Governance Group Name", + "enabled" : false, + "objectType" : "IDENTITY" + } ] + } + "@ + + # Bulk creates object mappings + + try { + $Result = ConvertFrom-JsonToObjectMappingBulkCreateRequest -Json $ObjectMappingBulkCreateRequest + New-ObjectMappings-SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result + + # Below is a request that includes all optional parameters + # New-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $ObjectMappingBulkCreateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ObjectMappings" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Name = "MyName" # String | Name that will be assigned to the uploaded configuration file. + + # Upload a Configuration + + try { + New-UploadedConfiguration-Data $Data -Name $Name + + # Below is a request that includes all optional parameters + # New-UploadedConfiguration -Data $Data -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-UploadedConfiguration" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg}/{objectMappingId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingId = "3d6e0144-963f-4bd6-8d8d-d77b4e507ce4" # String | The id of the object mapping to be deleted. + + # Deletes an object mapping + + try { + Remove-ObjectMapping-SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId + + # Below is a request that includes all optional parameters + # Remove-ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ObjectMapping" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. + + # Delete an Uploaded Configuration + + try { + Remove-UploadedConfiguration-Id $Id + + # Below is a request that includes all optional parameters + # Remove-UploadedConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-UploadedConfiguration" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceOrg = "source-org" # String | The name of the source org. + + # Gets list of object mappings + + try { + Get-ObjectMappings-SourceOrg $SourceOrg + + # Below is a request that includes all optional parameters + # Get-ObjectMappings -SourceOrg $SourceOrg + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ObjectMappings" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. + + # Get an Uploaded Configuration + + try { + Get-UploadedConfiguration-Id $Id + + # Below is a request that includes all optional parameters + # Get-UploadedConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UploadedConfiguration" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/backups/uploads + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) + + # List Uploaded Configurations + + try { + Get-UploadedConfigurations + + # Below is a request that includes all optional parameters + # Get-UploadedConfigurations -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UploadedConfigurations" + Write-Host $_.ErrorDetails + } +- path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceOrg = "source-org" # String | The name of the source org. + $ObjectMappingBulkPatchRequest = @" + { + "patches" : { + "603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ { + "op" : "replace", + "path" : "/enabled", + "value" : true + } ], + "00bece34-f50d-4227-8878-76f620b5a971" : [ { + "op" : "replace", + "path" : "/targetValue", + "value" : "New Target Value" + } ] + } + } + "@ + + # Bulk updates object mappings + + try { + $Result = ConvertFrom-JsonToObjectMappingBulkPatchRequest -Json $ObjectMappingBulkPatchRequest + Update-ObjectMappings-SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result + + # Below is a request that includes all optional parameters + # Update-ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $ObjectMappingBulkPatchRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ObjectMappings" + Write-Host $_.ErrorDetails + } +- path: /connectors + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $V3CreateConnectorDto = @" + { + "name" : "custom connector", + "directConnect" : true, + "className" : "sailpoint.connector.OpenConnectorAdapter", + "type" : "custom connector type", + "status" : "RELEASED" + } + "@ + + # Create Custom Connector + + try { + $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto + New-CustomConnector-V3CreateConnectorDto $Result + + # Below is a request that includes all optional parameters + # New-CustomConnector -V3CreateConnectorDto $V3CreateConnectorDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-CustomConnector" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + # Delete Connector by Script Name + + try { + Remove-CustomConnector-ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Remove-CustomConnector -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-CustomConnector" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Get Connector by Script Name + + try { + Get-Connector-ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-Connector -ScriptName $ScriptName -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Connector" + Write-Host $_.ErrorDetails + } +- path: /connectors + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "directConnect eq "true"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) + + # Get Connector List + + try { + Get-ConnectorList + + # Below is a request that includes all optional parameters + # Get-ConnectorList -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorList" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + # Get Connector Source Configuration + + try { + Get-ConnectorSourceConfig-ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-ConnectorSourceConfig -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorSourceConfig" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-template + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + + # Get Connector Source Template + + try { + Get-ConnectorSourceTemplate-ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-ConnectorSourceTemplate -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorSourceTemplate" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/translations/{locale} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + + # Get Connector Translations + + try { + Get-ConnectorTranslations-ScriptName $ScriptName -Locale $Locale + + # Below is a request that includes all optional parameters + # Get-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ConnectorTranslations" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $File = # System.IO.FileInfo | connector source config xml file + + # Update Connector Source Configuration + + try { + Send-ConnectorSourceConfig-ScriptName $ScriptName -File $File + + # Below is a request that includes all optional parameters + # Send-ConnectorSourceConfig -ScriptName $ScriptName -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorSourceConfig" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/source-template + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $File = # System.IO.FileInfo | connector source template xml file + + # Update Connector Source Template + + try { + Send-ConnectorSourceTemplate-ScriptName $ScriptName -File $File + + # Below is a request that includes all optional parameters + # Send-ConnectorSourceTemplate -ScriptName $ScriptName -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorSourceTemplate" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName}/translations/{locale} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. + $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" + + # Update Connector Translations + + try { + Send-ConnectorTranslations-ScriptName $ScriptName -Locale $Locale + + # Below is a request that includes all optional parameters + # Send-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ConnectorTranslations" + Write-Host $_.ErrorDetails + } +- path: /connectors/{scriptName} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Connector by Script Name + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Connector-ScriptName $ScriptName -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-Connector -ScriptName $ScriptName -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Connector" + Write-Host $_.ErrorDetails + } +- path: /auth-org/network-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $NetworkConfiguration = @" + { + "range" : [ "1.3.7.2", "255.255.255.252/30" ], + "whitelisted" : true, + "geolocation" : [ "CA", "FR", "HT" ] + } + "@ + + # Create security network configuration. + + try { + $Result = ConvertFrom-JsonToNetworkConfiguration -Json $NetworkConfiguration + New-AuthOrgNetworkConfig-NetworkConfiguration $Result + + # Below is a request that includes all optional parameters + # New-AuthOrgNetworkConfig -NetworkConfiguration $NetworkConfiguration + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/lockout-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Auth Org Lockout Configuration. + + try { + Get-AuthOrgLockoutConfig + + # Below is a request that includes all optional parameters + # Get-AuthOrgLockoutConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/network-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get security network configuration. + + try { + Get-AuthOrgNetworkConfig + + # Below is a request that includes all optional parameters + # Get-AuthOrgNetworkConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/service-provider-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Service Provider Configuration. + + try { + Get-AuthOrgServiceProviderConfig + + # Below is a request that includes all optional parameters + # Get-AuthOrgServiceProviderConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/session-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Auth Org Session Configuration. + + try { + Get-AuthOrgSessionConfig + + # Below is a request that includes all optional parameters + # Get-AuthOrgSessionConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgSessionConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/lockout-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Auth Org Lockout Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthOrgLockoutConfig-JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthOrgLockoutConfig -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/network-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update security network configuration. + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthOrgNetworkConfig-JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthOrgNetworkConfig -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgNetworkConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/service-provider-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Service Provider Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthOrgServiceProviderConfig-JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthOrgServiceProviderConfig -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/session-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Auth Org Session Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-AuthOrgSessionConfig-JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-AuthOrgSessionConfig -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-AuthOrgSessionConfig" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfile = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + } + "@ + + # Create an Identity Profile + + try { + $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile + New-IdentityProfile-IdentityProfile $Result + + # Below is a request that includes all optional parameters + # New-IdentityProfile -IdentityProfile $IdentityProfile + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. + + # Delete an Identity Profile + + try { + Remove-IdentityProfile-IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Remove-IdentityProfile -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body. + $RequestBody = @""@ + + + # Delete Identity Profiles + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Remove-IdentityProfiles-RequestBody $Result + + # Below is a request that includes all optional parameters + # Remove-IdentityProfiles -RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/export + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) + + # Export Identity Profiles + + try { + Export-IdentityProfiles + + # Below is a request that includes all optional parameters + # Export-IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. + + # Get default Identity Attribute Config + + try { + Get-DefaultIdentityAttributeConfig-IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultIdentityAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. + + # Get single Identity Profile + + try { + Get-IdentityProfile-IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Get-IdentityProfile -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + + + + + $IdentityProfileExportedObject = @"{ + "self" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "version" : 1, + "object" : { + "owner" : { + "name" : "William Wilson", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "IDENTITY" + }, + "identityExceptionReportReference" : { + "reportName" : "My annual report", + "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" + }, + "authoritativeSource" : { + "name" : "HR Active Directory", + "id" : "2c9180835d191a86015d28455b4b232a", + "type" : "SOURCE" + }, + "hasTimeBasedAttr" : true, + "created" : "2015-05-28T14:07:17Z", + "description" : "My custom flat file profile", + "identityRefreshRequired" : true, + "identityCount" : 8, + "priority" : 10, + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + }, + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "id" : "id12345" + } + }"@ + + + # Import Identity Profiles + + try { + $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject + Import-IdentityProfiles-IdentityProfileExportedObject $Result + + # Below is a request that includes all optional parameters + # Import-IdentityProfiles -IdentityProfileExportedObject $IdentityProfileExportedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) + + # Identity Profiles List + + try { + Get-IdentityProfiles + + # Below is a request that includes all optional parameters + # Get-IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityProfiles" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/identity-preview + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityPreviewRequest = @" + { + "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", + "identityAttributeConfig" : { + "attributeTransforms" : [ { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + }, { + "transformDefinition" : { + "attributes" : { + "attributeName" : "e-mail", + "sourceName" : "MySource", + "sourceId" : "2c9180877a826e68017a8c0b03da1a53" + }, + "type" : "accountAttribute" + }, + "identityAttributeName" : "email" + } ], + "enabled" : true + } + } + "@ + + # Generate Identity Profile Preview + + try { + $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest + Show-IdentityPreview-IdentityPreviewRequest $Result + + # Below is a request that includes all optional parameters + # Show-IdentityPreview -IdentityPreviewRequest $IdentityPreviewRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-IdentityPreview" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/process-identities + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed + + # Process identities under profile + + try { + Sync-IdentityProfile-IdentityProfileId $IdentityProfileId + + # Below is a request that includes all optional parameters + # Sync-IdentityProfile -IdentityProfileId $IdentityProfileId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update the Identity Profile + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-IdentityProfile-IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-IdentityProfile" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleState = @" + { + "accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ], + "emailNotificationOption" : { + "notifyManagers" : true, + "notifySpecificUsers" : true, + "emailAddressList" : [ "test@test.com", "test2@test.com" ], + "notifyAllAdmins" : true + }, + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Lifecycle description", + "accountActions" : [ { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + }, { + "action" : "ENABLE", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } ], + "id" : "id12345", + "identityCount" : 42, + "technicalName" : "Technical Name", + "identityState" : "identityState", + "enabled" : true + } + "@ + + # Create Lifecycle State + + try { + $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState + New-LifecycleState-IdentityProfileId $IdentityProfileId -LifecycleState $Result + + # Below is a request that includes all optional parameters + # New-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $LifecycleState + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + + # Delete Lifecycle State + + try { + Remove-LifecycleState-IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Remove-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + + # Get Lifecycle State + + try { + Get-LifecycleState-IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + + # Below is a request that includes all optional parameters + # Get-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Lists LifecycleStates + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-LifecycleStates" + Write-Host $_.ErrorDetails + } +- path: /identities/{identity-id}/set-lifecycle-state + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "2c9180857893f1290178944561990364" # String | ID of the identity to update. + $SetLifecycleStateRequest = @" + + "@ + + # Set Lifecycle State + + try { + $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest + Set-LifecycleState-IdentityId $IdentityId -SetLifecycleStateRequest $Result + + # Below is a request that includes all optional parameters + # Set-LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $SetLifecycleStateRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-LifecycleState" + Write-Host $_.ErrorDetails + } +- path: /identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. + $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Lifecycle State + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-LifecycleStates" + Write-Host $_.ErrorDetails + } +- path: /managed-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ManagedClientRequest = @" + { + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + } + "@ + + # Create Managed Client + + try { + $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest + New-ManagedClient-ManagedClientRequest $Result + + # Below is a request that includes all optional parameters + # New-ManagedClient -ManagedClientRequest $ManagedClientRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Delete Managed Client + + try { + Remove-ManagedClient-Id $Id + + # Below is a request that includes all optional parameters + # Remove-ManagedClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Get Managed Client + + try { + Get-ManagedClient-Id $Id + + # Below is a request that includes all optional parameters + # Get-ManagedClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "aClientId" # String | Managed client ID to get status for. + $Type = "CCG" # ManagedClientType | Managed client type to get status for. + + # Get Managed Client Status + + try { + Get-ManagedClientStatus-Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-ManagedClientStatus -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + + # Get Managed Clients + + try { + Get-ManagedClients + + # Below is a request that includes all optional parameters + # Get-ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClients" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Client + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ManagedClient-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-ManagedClient -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ManagedClusterRequest = @" + { + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + } + "@ + + # Create Create Managed Cluster + + try { + $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest + New-ManagedCluster-ManagedClusterRequest $Result + + # Below is a request that includes all optional parameters + # New-ManagedCluster -ManagedClusterRequest $ManagedClusterRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) + + # Delete Managed Cluster + + try { + Remove-ManagedCluster-Id $Id + + # Below is a request that includes all optional parameters + # Remove-ManagedCluster -Id $Id -RemoveClients $RemoveClients + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. + + # Get Managed Cluster Log Configuration + + try { + Get-ClientLogConfiguration-Id $Id + + # Below is a request that includes all optional parameters + # Get-ClientLogConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + + # Get Managed Cluster + + try { + Get-ManagedCluster-Id $Id + + # Below is a request that includes all optional parameters + # Get-ManagedCluster -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + + # Get Managed Clusters + + try { + Get-ManagedClusters + + # Below is a request that includes all optional parameters + # Get-ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClusters" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. + $PutClientLogConfigurationRequest = @" + + "@ + + # Update Managed Cluster Log Configuration + + try { + $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest + Send-ClientLogConfiguration-Id $Id -PutClientLogConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $PutClientLogConfigurationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Cluster + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ManagedCluster-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-ManagedCluster -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/delete + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + # Delete MFA method configuration + + try { + Remove-MFAConfig-Method $Method + + # Below is a request that includes all optional parameters + # Remove-MFAConfig -Method $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-MFAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Configuration of Duo MFA method + + try { + Get-MFADuoConfig + + # Below is a request that includes all optional parameters + # Get-MFADuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + # Configuration of KBA MFA method + + try { + Get-MFAKbaConfig + + # Below is a request that includes all optional parameters + # Get-MFAKbaConfig -AllLanguages $AllLanguages + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFAKbaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Configuration of Okta MFA method + + try { + Get-MFAOktaConfig + + # Below is a request that includes all optional parameters + # Get-MFAOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MfaDuoConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Duo MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-MFADuoConfig-MfaDuoConfig $Result + + # Below is a request that includes all optional parameters + # Set-MFADuoConfig -MfaDuoConfig $MfaDuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ + + + # Set MFA KBA configuration + + try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-MFAKBAConfig-KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Set-MFAKBAConfig -KbaAnswerRequestItem $KbaAnswerRequestItem + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAKBAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MfaOktaConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Okta MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-MFAOktaConfig-MfaOktaConfig $Result + + # Below is a request that includes all optional parameters + # Set-MFAOktaConfig -MfaOktaConfig $MfaOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + # MFA method's test configuration + + try { + Test-MFAConfig-Method $Method + + # Below is a request that includes all optional parameters + # Test-MFAConfig -Method $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-MFAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/token/send + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SendTokenRequest = @" + { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK" + } + "@ + + # Create and send user token + + try { + $Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest + New-SendToken-SendTokenRequest $Result + + # Below is a request that includes all optional parameters + # New-SendToken -SendTokenRequest $SendTokenRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SendToken" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/poll + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' + $VerificationPollRequest = @" + { + "requestId" : "089899f13a8f4da7824996191587bab9" + } + "@ + + # Polling MFA method by VerificationPollRequest + + try { + $Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest + Ping-VerificationStatus-Method $Method -VerificationPollRequest $Result + + # Below is a request that includes all optional parameters + # Ping-VerificationStatus -Method $Method -VerificationPollRequest $VerificationPollRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-VerificationStatus" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/verify + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $DuoVerificationRequest = @" + { + "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", + "userId" : "2c9180947f0ef465017f215cbcfd004b" + } + "@ + + # Verifying authentication via Duo method + + try { + $Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest + Send-DuoVerifyRequest-DuoVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-DuoVerifyRequest -DuoVerificationRequest $DuoVerificationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-DuoVerifyRequest" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/authenticate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ + + + # Authenticate KBA provided MFA method + + try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Send-KbaAnswers-KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Send-KbaAnswers -KbaAnswerRequestItem $KbaAnswerRequestItem + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-KbaAnswers" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/verify + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OktaVerificationRequest = @" + { + "userId" : "example@mail.com" + } + "@ + + # Verifying authentication via Okta method + + try { + $Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest + Send-OktaVerifyRequest-OktaVerificationRequest $Result + + # Below is a request that includes all optional parameters + # Send-OktaVerifyRequest -OktaVerificationRequest $OktaVerificationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-OktaVerifyRequest" + Write-Host $_.ErrorDetails + } +- path: /mfa/token/authenticate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TokenAuthRequest = @" + { + "userAlias" : "will.albin", + "deliveryType" : "EMAIL_WORK", + "token" : "12345" + } + "@ + + # Authenticate Token provided MFA method + + try { + $Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest + Send-TokenAuthRequest-TokenAuthRequest $Result + + # Below is a request that includes all optional parameters + # Send-TokenAuthRequest -TokenAuthRequest $TokenAuthRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TokenAuthRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id}/approve + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) + $NonEmployeeApprovalDecision = @" + { + "comment" : "Approved by manager" + } + "@ + + # Approve a Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision + Approve-NonEmployeeRequest-Id $Id -NonEmployeeApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Approve-NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $NonEmployeeApprovalDecision + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Create Non-Employee Record + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-NonEmployeeRecord-NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-NonEmployeeRecord -NonEmployeeRequestBody $NonEmployeeRequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Create Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + New-NonEmployeeRequest-NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # New-NonEmployeeRequest -NonEmployeeRequestBody $NonEmployeeRequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $NonEmployeeSourceRequestBody = @" + { + "owner" : { + "id" : "2c91808570313110017040b06f344ec9" + }, + "managementWorkgroup" : "123299", + "accountManagers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ], + "name" : "Retail", + "description" : "Source description", + "approvers" : [ { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + }, { + "id" : "2c91808570313110017040b06f344ec9" + } ] + } + "@ + + # Create Non-Employee Source + + try { + $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody + New-NonEmployeeSource-NonEmployeeSourceRequestBody $Result + + # Below is a request that includes all optional parameters + # New-NonEmployeeSource -NonEmployeeSourceRequestBody $NonEmployeeSourceRequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + $NonEmployeeSchemaAttributeBody = @" + { + "helpText" : "The unique identifier for the account", + "label" : "Account Name", + "placeholder" : "Enter a unique user name for this account.", + "type" : "TEXT", + "technicalName" : "account.name", + "required" : true + } + "@ + + # Create a new Schema Attribute for Non-Employee Source + + try { + $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody + New-NonEmployeeSourceSchemaAttributes-SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result + + # Below is a request that includes all optional parameters + # New-NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $NonEmployeeSchemaAttributeBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) + + # Delete Non-Employee Record + + try { + Remove-NonEmployeeRecord-Id $Id + + # Below is a request that includes all optional parameters + # Remove-NonEmployeeRecord -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $DeleteNonEmployeeRecordsInBulkRequest = @" + + "@ + + # Delete Multiple Non-Employee Records + + try { + $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest + Remove-NonEmployeeRecordsInBulk-DeleteNonEmployeeRecordsInBulkRequest $Result + + # Below is a request that includes all optional parameters + # Remove-NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $DeleteNonEmployeeRecordsInBulkRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format + + # Delete Non-Employee Request + + try { + Remove-NonEmployeeRequest-Id $Id + + # Below is a request that includes all optional parameters + # Remove-NonEmployeeRequest -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # Delete a Schema Attribute for Non-Employee Source + + try { + Remove-NonEmployeeSchemaAttribute-AttributeId $AttributeId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id + + # Delete Non-Employee Source + + try { + Remove-NonEmployeeSource-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-NonEmployeeSource -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # Delete all custom schema attributes for Non-Employee Source + + try { + Remove-NonEmployeeSourceSchemaAttributes-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Remove-NonEmployeeSourceSchemaAttributes -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employees/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) + + # Exports Non-Employee Records to CSV + + try { + Export-NonEmployeeRecords-Id $Id + + # Below is a request that includes all optional parameters + # Export-NonEmployeeRecords -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-NonEmployeeRecords" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/schema-attributes-template/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID) + + # Exports Source Schema Template + + try { + Export-NonEmployeeSourceSchemaTemplate-Id $Id + + # Below is a request that includes all optional parameters + # Export-NonEmployeeSourceSchemaTemplate -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-NonEmployeeSourceSchemaTemplate" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) + $IncludeDetail = $true # Boolean | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) + + # Get a non-employee approval item detail + + try { + Get-NonEmployeeApproval-Id $Id + + # Below is a request that includes all optional parameters + # Get-NonEmployeeApproval -Id $Id -IncludeDetail $IncludeDetail + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApproval" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/summary/{requested-for} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + + # Get Summary of Non-Employee Approval Requests + + try { + Get-NonEmployeeApprovalSummary-RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-NonEmployeeApprovalSummary -RequestedFor $RequestedFor + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApprovalSummary" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source ID (UUID) + + # Obtain the status of bulk upload on the source + + try { + Get-NonEmployeeBulkUploadStatus-Id $Id + + # Below is a request that includes all optional parameters + # Get-NonEmployeeBulkUploadStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeBulkUploadStatus" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) + + # Get a Non-Employee Record + + try { + Get-NonEmployeeRecord-Id $Id + + # Below is a request that includes all optional parameters + # Get-NonEmployeeRecord -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID) + + # Get a Non-Employee Request + + try { + Get-NonEmployeeRequest-Id $Id + + # Below is a request that includes all optional parameters + # Get-NonEmployeeRequest -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests/summary/{requested-for} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. + + # Get Summary of Non-Employee Requests + + try { + Get-NonEmployeeRequestSummary-RequestedFor $RequestedFor + + # Below is a request that includes all optional parameters + # Get-NonEmployeeRequestSummary -RequestedFor $RequestedFor + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequestSummary" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # Get Schema Attribute Non-Employee Source + + try { + Get-NonEmployeeSchemaAttribute-AttributeId $AttributeId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id + + # Get a Non-Employee Source + + try { + Get-NonEmployeeSource-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-NonEmployeeSource -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + + # List Schema Attributes Non-Employee Source + + try { + Get-NonEmployeeSourceSchemaAttributes-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-NonEmployeeSourceSchemaAttributes -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSourceSchemaAttributes" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{id}/non-employee-bulk-upload + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) + $Data = # System.IO.FileInfo | + + # Imports, or Updates, Non-Employee Records + + try { + Import-NonEmployeeRecordsInBulk-Id $Id -Data $Data + + # Below is a request that includes all optional parameters + # Import-NonEmployeeRecordsInBulk -Id $Id -Data $Data + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-NonEmployeeRecordsInBulk" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity for whom the request was made. *me* indicates the current user. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "approvalStatus eq "Pending"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) + $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) + + # Get List of Non-Employee Approval Requests + + try { + Get-NonEmployeeApprovals + + # Below is a request that includes all optional parameters + # Get-NonEmployeeApprovals -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeApprovals" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "accountName,sourceId" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) + $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + + # List Non-Employee Records + + try { + Get-NonEmployeeRecords + + # Below is a request that includes all optional parameters + # Get-NonEmployeeRecords -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRecords" + Write-Host $_.ErrorDetails + } +- path: /non-employee-requests + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "e136567de87e4d029e60b3c3c55db56d" # String | The identity for whom the request was made. *me* indicates the current user. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "created,approvalStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) + $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) + + # List Non-Employee Requests + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeRequests" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $NonEmployeeCount = $true # Boolean | The flag to determine whether return a non-employee count associate with source. (optional) + $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) + + # List Non-Employee Sources + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSources" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Non-Employee Record + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-NonEmployeeRecord-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-NonEmployeeRecord -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId}/schema-attributes/{attributeId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) + $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Schema Attribute for Non-Employee Source + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeSchemaAttribute" + Write-Host $_.ErrorDetails + } +- path: /non-employee-sources/{sourceId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Non-Employee Source + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-NonEmployeeSource-SourceId $SourceId -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeSource" + Write-Host $_.ErrorDetails + } +- path: /non-employee-approvals/{id}/reject + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Non-Employee approval item id (UUID) + $NonEmployeeRejectApprovalDecision = @" + { + "comment" : "approved" + } + "@ + + # Reject a Non-Employee Request + + try { + $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision + Deny-NonEmployeeRequest-Id $Id -NonEmployeeRejectApprovalDecision $Result + + # Below is a request that includes all optional parameters + # Deny-NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $NonEmployeeRejectApprovalDecision + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-NonEmployeeRequest" + Write-Host $_.ErrorDetails + } +- path: /non-employee-records/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-employee record id (UUID) + $NonEmployeeRequestBody = @" + { + "sourceId" : "2c91808568c529c60168cca6f90c1313", + "firstName" : "William", + "lastName" : "Smith", + "manager" : "jane.doe", + "data" : { + "description" : "Auditing" + }, + "accountName" : "william.smith", + "phone" : "5125555555", + "endDate" : "2021-03-25T00:00:00-05:00", + "email" : "william.smith@example.com", + "startDate" : "2020-03-24T00:00:00-05:00" + } + "@ + + # Update Non-Employee Record + + try { + $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody + Update-NonEmployeeRecord-Id $Id -NonEmployeeRequestBody $Result + + # Below is a request that includes all optional parameters + # Update-NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $NonEmployeeRequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-NonEmployeeRecord" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreateOAuthClientRequest = @" + { + "internal" : false, + "businessName" : "Acme-Solar", + "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", + "refreshTokenValiditySeconds" : 86400, + "type" : "CONFIDENTIAL", + "redirectUris" : [ "http://localhost:12345" ], + "enabled" : true, + "accessType" : "OFFLINE", + "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], + "strongAuthSupported" : false, + "homepageUrl" : "http://localhost:12345", + "accessTokenValiditySeconds" : 750, + "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], + "name" : "Demo API Client", + "claimsSupported" : false + } + "@ + + # Create OAuth Client + + try { + $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest + New-OauthClient-CreateOAuthClientRequest $Result + + # Below is a request that includes all optional parameters + # New-OauthClient -CreateOAuthClientRequest $CreateOAuthClientRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-OauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + + # Delete OAuth Client + + try { + Remove-OauthClient-Id $Id + + # Below is a request that includes all optional parameters + # Remove-OauthClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-OauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + + # Get OAuth Client + + try { + Get-OauthClient-Id $Id + + # Below is a request that includes all optional parameters + # Get-OauthClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-OauthClient" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + + # List OAuth Clients + + try { + Get-OauthClients + + # Below is a request that includes all optional parameters + # Get-OauthClients -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-OauthClients" + Write-Host $_.ErrorDetails + } +- path: /oauth-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch OAuth Client + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-OauthClient-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-OauthClient -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-OauthClient" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Create Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + New-PasswordOrgConfig-PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # New-PasswordOrgConfig -PasswordOrgConfig $PasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Password Org Config + + try { + Get-PasswordOrgConfig + + # Below is a request that includes all optional parameters + # Get-PasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-org-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordOrgConfig = @" + { + "digitTokenLength" : 9, + "digitTokenEnabled" : true, + "digitTokenDurationMinutes" : 10, + "customInstructionsEnabled" : true + } + "@ + + # Update Password Org Config + + try { + $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig + Send-PasswordOrgConfig-PasswordOrgConfig $Result + + # Below is a request that includes all optional parameters + # Send-PasswordOrgConfig -PasswordOrgConfig $PasswordOrgConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PasswordOrgConfig" + Write-Host $_.ErrorDetails + } +- path: /password-dictionary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get Password Dictionary + + try { + Get-PasswordDictionary + + # Below is a request that includes all optional parameters + # Get-PasswordDictionary + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordDictionary" + Write-Host $_.ErrorDetails + } +- path: /password-dictionary + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $File = # System.IO.FileInfo | (optional) + + # Update Password Dictionary + + try { + Send-PasswordDictionary + + # Below is a request that includes all optional parameters + # Send-PasswordDictionary -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PasswordDictionary" + Write-Host $_.ErrorDetails + } +- path: /password-change-status/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID + + # Get Password Change Request Status + + try { + Get-PasswordChangeStatus-Id $Id + + # Below is a request that includes all optional parameters + # Get-PasswordChangeStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordChangeStatus" + Write-Host $_.ErrorDetails + } +- path: /query-password-info + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordInfoQueryDTO = @" + { + "sourceName" : "My-AD", + "userName" : "Abby.Smith" + } + "@ + + # Query Password Info + + try { + $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO + Search-PasswordInfo-PasswordInfoQueryDTO $Result + + # Below is a request that includes all optional parameters + # Search-PasswordInfo -PasswordInfoQueryDTO $PasswordInfoQueryDTO + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-PasswordInfo" + Write-Host $_.ErrorDetails + } +- path: /set-password + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordChangeRequest = @" + { + "sourceId" : "8a807d4c73c545510173c545d4b60246", + "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", + "identityId" : "8a807d4c73c545510173c545f0a002ff", + "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", + "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" + } + "@ + + # Set Identity's Password + + try { + $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest + Set-Password-PasswordChangeRequest $Result + + # Below is a request that includes all optional parameters + # Set-Password -PasswordChangeRequest $PasswordChangeRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-Password" + Write-Host $_.ErrorDetails + } +- path: /password-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordPolicyV3Dto = @" + { + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + } + "@ + + # Create Password Policy + + try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + New-PasswordPolicy-PasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # New-PasswordPolicy -PasswordPolicyV3Dto $PasswordPolicyV3Dto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. + + # Delete Password Policy by ID + + try { + Remove-PasswordPolicy-Id $Id + + # Below is a request that includes all optional parameters + # Remove-PasswordPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-PasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. + + # Get Password Policy by ID + + try { + Get-PasswordPolicyById-Id $Id + + # Below is a request that includes all optional parameters + # Get-PasswordPolicyById -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordPolicyById" + Write-Host $_.ErrorDetails + } +- path: /password-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Password Policies + + try { + Get-PasswordPolicies + + # Below is a request that includes all optional parameters + # Get-PasswordPolicies -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordPolicies" + Write-Host $_.ErrorDetails + } +- path: /password-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update. + $PasswordPolicyV3Dto = @" + { + "validateAgainstAccountName" : true, + "minLength" : 8, + "description" : "Information about the Password Policy", + "requireStrongAuthUntrustedGeographies" : true, + "enablePasswdExpiration" : true, + "minNumeric" : 8, + "lastUpdated" : "2000-01-23T04:56:07.000+00:00", + "validateAgainstAccountId" : false, + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "accountNameMinWordLength" : 6, + "minUpper" : 8, + "firstExpirationReminder" : 45, + "modified" : "modified", + "id" : "2c91808e7d976f3b017d9f5ceae440c8", + "requireStrongAuthn" : true, + "useDictionary" : false, + "minSpecial" : 8, + "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], + "passwordExpiration" : 8, + "maxRepeatedChars" : 3, + "minCharacterTypes" : 5, + "minAlpha" : 5, + "created" : "created", + "useAccountAttributes" : false, + "accountIdMinWordLength" : 4, + "minLower" : 8, + "useIdentityAttributes" : false, + "defaultPolicy" : true, + "requireStrongAuthOffNetwork" : true, + "name" : "PasswordPolicy Example", + "maxLength" : 25 + } + "@ + + # Update Password Policy by ID + + try { + $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto + Set-PasswordPolicy-Id $Id -PasswordPolicyV3Dto $Result + + # Below is a request that includes all optional parameters + # Set-PasswordPolicy -Id $Id -PasswordPolicyV3Dto $PasswordPolicyV3Dto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-PasswordPolicy" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PasswordSyncGroup = @" + { + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } + "@ + + # Create Password Sync Group + + try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + New-PasswordSyncGroup-PasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # New-PasswordSyncGroup -PasswordSyncGroup $PasswordSyncGroup + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. + + # Delete Password Sync Group by ID + + try { + Remove-PasswordSyncGroup-Id $Id + + # Below is a request that includes all optional parameters + # Remove-PasswordSyncGroup -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. + + # Get Password Sync Group by ID + + try { + Get-PasswordSyncGroup-Id $Id + + # Below is a request that includes all optional parameters + # Get-PasswordSyncGroup -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Get Password Sync Group List + + try { + Get-PasswordSyncGroups + + # Below is a request that includes all optional parameters + # Get-PasswordSyncGroups -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PasswordSyncGroups" + Write-Host $_.ErrorDetails + } +- path: /password-sync-groups/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to update. + $PasswordSyncGroup = @" + { + "created" : "2023-03-16T04:00:00Z", + "name" : "Password Sync Group 1", + "modified" : "2023-03-16T04:00:00Z", + "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", + "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", + "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] + } + "@ + + # Update Password Sync Group by ID + + try { + $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup + Update-PasswordSyncGroup-Id $Id -PasswordSyncGroup $Result + + # Below is a request that includes all optional parameters + # Update-PasswordSyncGroup -Id $Id -PasswordSyncGroup $PasswordSyncGroup + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PasswordSyncGroup" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreatePersonalAccessTokenRequest = @" + { + "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], + "accessTokenValiditySeconds" : 36900, + "name" : "NodeJS Integration" + } + "@ + + # Create Personal Access Token + + try { + $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest + New-PersonalAccessToken-CreatePersonalAccessTokenRequest $Result + + # Below is a request that includes all optional parameters + # New-PersonalAccessToken -CreatePersonalAccessTokenRequest $CreatePersonalAccessTokenRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-PersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id + + # Delete Personal Access Token + + try { + Remove-PersonalAccessToken-Id $Id + + # Below is a request that includes all optional parameters + # Remove-PersonalAccessToken -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-PersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "2c9180867b50d088017b554662fb281e" # String | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) + $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) + + # List Personal Access Tokens + + try { + Get-PersonalAccessTokens + + # Below is a request that includes all optional parameters + # Get-PersonalAccessTokens -OwnerId $OwnerId -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PersonalAccessTokens" + Write-Host $_.ErrorDetails + } +- path: /personal-access-tokens/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Personal Access Token + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-PersonalAccessToken-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-PersonalAccessToken -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PersonalAccessToken" + Write-Host $_.ErrorDetails + } +- path: /public-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "firstname eq "John"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional) + $AddCoreFilters = $false # Boolean | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be ""spadmin"" or ""cloudadmin"". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to $false) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Get list of public identities + + try { + Get-PublicIdentities + + # Below is a request that includes all optional parameters + # Get-PublicIdentities -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -AddCoreFilters $AddCoreFilters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PublicIdentities" + Write-Host $_.ErrorDetails + } +- path: /public-identities-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get the Public Identities Configuration + + try { + Get-PublicIdentityConfig + + # Below is a request that includes all optional parameters + # Get-PublicIdentityConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-PublicIdentityConfig" + Write-Host $_.ErrorDetails + } +- path: /public-identities-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $PublicIdentityConfig = @" + { + "modified" : "2018-06-25T20:22:28.104Z", + "attributes" : [ { + "name" : "Country", + "key" : "country" + }, { + "name" : "Country", + "key" : "country" + } ], + "modifiedBy" : { + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + } + "@ + + # Update the Public Identities Configuration + + try { + $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig + Update-PublicIdentityConfig-PublicIdentityConfig $Result + + # Below is a request that includes all optional parameters + # Update-PublicIdentityConfig -PublicIdentityConfig $PublicIdentityConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-PublicIdentityConfig" + Write-Host $_.ErrorDetails + } +- path: /reports/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel + + # Cancel Report + + try { + Suspend-Report-Id $Id + + # Below is a request that includes all optional parameters + # Suspend-Report -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-Report" + Write-Host $_.ErrorDetails + } +- path: /reports/{taskResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report + $FileFormat = "csv" # String | Output format of the requested report file + $Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional) + $Auditable = $true # Boolean | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to $false) + + # Get Report File + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Report" + Write-Host $_.ErrorDetails + } +- path: /reports/{taskResultId}/result + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report + $Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false) + + # Get Report Result + + try { + Get-ReportResult-TaskResultId $TaskResultId + + # Below is a request that includes all optional parameters + # Get-ReportResult -TaskResultId $TaskResultId -Completed $Completed + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ReportResult" + Write-Host $_.ErrorDetails + } +- path: /reports/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReportDetails = @" + { + "reportType" : "ACCOUNTS", + "arguments" : { + "application" : "2c9180897e7742b2017e781782f705b9", + "sourceName" : "Active Directory" + } + } + "@ + + # Run Report + + try { + $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails + Start-Report-ReportDetails $Result + + # Below is a request that includes all optional parameters + # Start-Report -ReportDetails $ReportDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-Report" + Write-Host $_.ErrorDetails + } +- path: /requestable-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) + $Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. (optional) + + $Types = @"ROLE,ACCESS_PROFILE"@ + $Term = "Finance Role" # String | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) + $Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional) + + $Statuses = @"[ASSIGNED, PENDING]"@ + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw "bob"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Requestable Objects List + + try { + Get-RequestableObjects + + # Below is a request that includes all optional parameters + # Get-RequestableObjects -IdentityId $IdentityId -Types $Types -Term $Term -Statuses $Statuses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-RequestableObjects" + Write-Host $_.ErrorDetails + } +- path: /roles + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Role = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "entitlements" : [ { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + }, { + "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", + "id" : "2c91809773dee32014e13e122092014e", + "type" : "ENTITLEMENT" + } ], + "dimensional" : false, + "created" : "2021-03-01T22:32:58.104Z", + "dimensionRefs" : [ { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + }, { + "name" : "Role 2", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "DIMENSION" + } ], + "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", + "membership" : { + "identities" : [ { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, { + "aliasName" : "t.edison", + "name" : "Thomas Edison", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } ], + "criteria" : { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "children" : [ { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, { + "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + } ], + "operation" : "EQUALS", + "key" : { + "sourceId" : "2c9180867427f3a301745aec18211519", + "property" : "attribute.email", + "type" : "ACCOUNT" + } + }, + "type" : "IDENTITY_LIST" + }, + "enabled" : true, + "revocationRequestConfig" : { + "commentsRequired" : false, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : false + }, + "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], + "legacyMembershipInfo" : { + "type" : "IDENTITY_LIST" + }, + "accessRequestConfig" : { + "commentsRequired" : true, + "approvalSchemes" : [ { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + }, { + "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", + "approverType" : "GOVERNANCE_GROUP" + } ], + "denialCommentsRequired" : true + }, + "accessProfiles" : [ { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + }, { + "name" : "Access Profile 2567", + "id" : "ff808081751e6e129f1518161919ecca", + "type" : "ACCESS_PROFILE" + } ], + "name" : "Role 2567", + "modified" : "2021-03-02T20:22:28.104Z", + "accessModelMetadata" : { + "attributes" : [ { + "key" : "iscPrivacy", + "name" : "Privacy", + "multiselect" : false, + "status" : "active", + "type" : "governance", + "objectTypes" : [ "all" ], + "description" : "Specifies the level of privacy associated with an access item.", + "values" : [ { + "value" : "public", + "name" : "Public", + "status" : "active" + } ] + } ] + }, + "id" : "2c918086749d78830174a1a40e121518", + "requestable" : true + } + "@ + + # Create a Role + + try { + $Result = ConvertFrom-JsonToRole -Json $Role + New-Role-Role $Result + + # Below is a request that includes all optional parameters + # New-Role -Role $Role + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Role" + Write-Host $_.ErrorDetails + } +- path: /roles/bulk-delete + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $RoleBulkDeleteRequest = @" + { + "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] + } + "@ + + # Delete Role(s) + + try { + $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest + Remove-BulkRoles-RoleBulkDeleteRequest $Result + + # Below is a request that includes all optional parameters + # Remove-BulkRoles -RoleBulkDeleteRequest $RoleBulkDeleteRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BulkRoles" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + + # Delete a Role + + try { + Remove-Role-Id $Id + + # Below is a request that includes all optional parameters + # Remove-Role -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Role" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + + # Get a Role + + try { + Get-Role-Id $Id + + # Below is a request that includes all optional parameters + # Get-Role -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Role" + Write-Host $_.ErrorDetails + } +- path: /roles/{id}/assigned-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role for which the assigned Identities are to be listed + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name sw Joe" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) + $Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) + + # List Identities assigned a Role + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-RoleAssignedIdentities" + Write-Host $_.ErrorDetails + } +- path: /roles + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) + $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) + $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) + $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) + + # List Roles + + try { + Get-Roles + + # Below is a request that includes all optional parameters + # Get-Roles -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Roles" + Write-Host $_.ErrorDetails + } +- path: /roles/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a specified Role + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Role-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-Role -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Role" + Write-Host $_.ErrorDetails + } +- path: /saved-searches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreateSavedSearchRequest = @" + + "@ + + # Create a saved search + + try { + $Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest + New-SavedSearch-CreateSavedSearchRequest $Result + + # Below is a request that includes all optional parameters + # New-SavedSearch -CreateSavedSearchRequest $CreateSavedSearchRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Delete document by ID + + try { + Remove-SavedSearch-Id $Id + + # Below is a request that includes all optional parameters + # Remove-SavedSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id}/execute + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $SearchArguments = @" + { + "owner" : "", + "recipients" : [ { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" + } + "@ + + # Execute a saved search by ID + + try { + $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments + Invoke-ExecuteSavedSearch-Id $Id -SearchArguments $Result + + # Below is a request that includes all optional parameters + # Invoke-ExecuteSavedSearch -Id $Id -SearchArguments $SearchArguments + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-ExecuteSavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Return saved search by ID + + try { + Get-SavedSearch-Id $Id + + # Below is a request that includes all optional parameters + # Get-SavedSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /saved-searches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) + + # A list of Saved Searches + + try { + Get-SavedSearches + + # Below is a request that includes all optional parameters + # Get-SavedSearches -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SavedSearches" + Write-Host $_.ErrorDetails + } +- path: /saved-searches/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $SavedSearch = @" + { + "owner" : { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "created" : "2018-06-25T20:22:28.104Z", + "columns" : { + "identity" : [ { + "field" : "displayName", + "header" : "Display Name" + }, { + "field" : "e-mail", + "header" : "Work Email" + } ] + }, + "query" : "@accounts(disabled:true)", + "description" : "Disabled accounts", + "orderBy" : { + "identity" : [ "lastName", "firstName" ], + "role" : [ "name" ] + }, + "sort" : [ "displayName" ], + "filters" : { + "terms" : [ "account_count", "account_count" ], + "range" : { + "lower" : { + "inclusive" : false, + "value" : "1" + }, + "upper" : { + "inclusive" : false, + "value" : "1" + } + }, + "exclude" : false, + "type" : "RANGE" + }, + "ownerId" : "2c91808568c529c60168cca6f90c1313", + "indices" : [ "identities" ], + "public" : false, + "name" : "Disabled accounts", + "modified" : "2018-06-25T20:22:28.104Z", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "fields" : [ "disabled" ] + } + "@ + + # Updates an existing saved search + + try { + $Result = ConvertFrom-JsonToSavedSearch -Json $SavedSearch + Send-SavedSearch-Id $Id -SavedSearch $Result + + # Below is a request that includes all optional parameters + # Send-SavedSearch -Id $Id -SavedSearch $SavedSearch + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SavedSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreateScheduledSearchRequest = @" + {savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]} + "@ + + # Create a new scheduled search + + try { + $Result = ConvertFrom-JsonToCreateScheduledSearchRequest -Json $CreateScheduledSearchRequest + New-ScheduledSearch-CreateScheduledSearchRequest $Result + + # Below is a request that includes all optional parameters + # New-ScheduledSearch -CreateScheduledSearchRequest $CreateScheduledSearchRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Delete a Scheduled Search + + try { + Remove-ScheduledSearch-Id $Id + + # Below is a request that includes all optional parameters + # Remove-ScheduledSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Get a Scheduled Search + + try { + Get-ScheduledSearch-Id $Id + + # Below is a request that includes all optional parameters + # Get-ScheduledSearch -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* **savedSearchId**: *eq* (optional) + + # List scheduled searches + + try { + Get-ScheduledSearch + + # Below is a request that includes all optional parameters + # Get-ScheduledSearch -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id}/unsubscribe + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $TypedReference = @" + { + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } + "@ + + # Unsubscribe a recipient from Scheduled Search + + try { + $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference + Invoke-UnsubscribeScheduledSearch-Id $Id -TypedReference $Result + + # Below is a request that includes all optional parameters + # Invoke-UnsubscribeScheduledSearch -Id $Id -TypedReference $TypedReference + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-UnsubscribeScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /scheduled-searches/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + $ScheduledSearch = @" + { + "owner" : { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, + "displayQueryDetails" : false, + "created" : "", + "description" : "Daily disabled accounts", + "ownerId" : "2c9180867624cbd7017642d8c8c81f67", + "enabled" : false, + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "recipients" : [ { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + }, { + "id" : "2c9180867624cbd7017642d8c8c81f67", + "type" : "IDENTITY" + } ], + "savedSearchId" : "554f1511-f0a1-4744-ab14-599514d3e57c", + "name" : "Daily disabled accounts", + "modified" : "", + "id" : "0de46054-fe90-434a-b84e-c6b3359d0c64", + "emailEmptyResults" : false + } + "@ + + # Update an existing Scheduled Search + + try { + $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch + Update-ScheduledSearch-Id $Id -ScheduledSearch $Result + + # Below is a request that includes all optional parameters + # Update-ScheduledSearch -Id $Id -ScheduledSearch $ScheduledSearch + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ScheduledSearch" + Write-Host $_.ErrorDetails + } +- path: /search/aggregate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + } + "@ + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Perform a Search Query Aggregation + + try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-Aggregate-Search $Result + + # Below is a request that includes all optional parameters + # Search-Aggregate -Search $Search -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Aggregate" + Write-Host $_.ErrorDetails + } +- path: /search/count + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + } + "@ + + # Count Documents Satisfying a Query + + try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-Count-Search $Result + + # Below is a request that includes all optional parameters + # Search-Count -Search $Search + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Count" + Write-Host $_.ErrorDetails + } +- path: /search/{index}/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. + $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. + + # Get a Document by ID + + try { + Search-Get-Index $Index -Id $Id + + # Below is a request that includes all optional parameters + # Search-Get -Index $Index -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Get" + Write-Host $_.ErrorDetails + } +- path: /search + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Search = @" + { + "queryDsl" : { + "match" : { + "name" : "john.doe" + } + }, + "aggregationType" : "DSL", + "aggregationsVersion" : "", + "query" : { + "query" : "name:a*", + "timeZone" : "America/Chicago", + "fields" : "[firstName,lastName,email]", + "innerHit" : { + "query" : "source.name:\\\"Active Directory\\\"", + "type" : "access" + } + }, + "aggregationsDsl" : { }, + "sort" : [ "displayName", "+id" ], + "filters" : { }, + "queryVersion" : "", + "queryType" : "SAILPOINT", + "includeNested" : true, + "queryResultFilter" : { + "excludes" : [ "stacktrace" ], + "includes" : [ "name", "displayName" ] + }, + "indices" : [ "identities" ], + "typeAheadQuery" : { + "field" : "source.name", + "size" : 100, + "query" : "Work", + "sortByValue" : true, + "nestedType" : "access", + "sort" : "asc", + "maxExpansions" : 10 + }, + "textQuery" : { + "contains" : true, + "terms" : [ "The quick brown fox", "3141592", "7" ], + "matchAny" : false, + "fields" : [ "displayName", "employeeNumber", "roleCount" ] + }, + "searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ], + "aggregations" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "subAggregation" : { + "filter" : { + "field" : "access.type", + "name" : "Entitlements", + "type" : "TERM", + "value" : "ENTITLEMENT" + }, + "bucket" : { + "field" : "attributes.city", + "size" : 100, + "minDocCount" : 2, + "name" : "Identity Locations", + "type" : "TERMS" + }, + "metric" : { + "field" : "@access.name", + "name" : "Access Name Count", + "type" : "COUNT" + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + }, + "nested" : { + "name" : "id", + "type" : "access" + } + } + } + "@ + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Perform Search + + try { + $Result = ConvertFrom-JsonToSearch -Json $Search + Search-Post-Search $Result + + # Below is a request that includes all optional parameters + # Search-Post -Search $Search -Offset $Offset -Limit $Limit -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-Post" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SearchAttributeConfig = @" + { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } + "@ + + # Create Extended Search Attributes + + try { + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-SearchAttributeConfig-SearchAttributeConfig $Result + + # Below is a request that includes all optional parameters + # New-SearchAttributeConfig -SearchAttributeConfig $SearchAttributeConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. + + # Delete Extended Search Attribute + + try { + Remove-SearchAttributeConfig-Name $Name + + # Below is a request that includes all optional parameters + # Remove-SearchAttributeConfig -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Extended Search Attributes + + try { + Get-SearchAttributeConfig + + # Below is a request that includes all optional parameters + # Get-SearchAttributeConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to retrieve. + + # Get Extended Search Attribute + + try { + Get-SingleSearchAttributeConfig-Name $Name + + # Below is a request that includes all optional parameters + # Get-SingleSearchAttributeConfig -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SingleSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Extended Search Attribute + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-SearchAttributeConfig-Name $Name -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-SearchAttributeConfig -Name $Name -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /segments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Segment = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + } + "@ + + # Create Segment + + try { + $Result = ConvertFrom-JsonToSegment -Json $Segment + New-Segment-Segment $Result + + # Below is a request that includes all optional parameters + # New-Segment -Segment $Segment + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Segment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + + # Delete Segment by ID + + try { + Remove-Segment-Id $Id + + # Below is a request that includes all optional parameters + # Remove-Segment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Segment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + + # Get Segment by ID + + try { + Get-Segment-Id $Id + + # Below is a request that includes all optional parameters + # Get-Segment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Segment" + Write-Host $_.ErrorDetails + } +- path: /segments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Segments + + try { + Get-Segments + + # Below is a request that includes all optional parameters + # Get-Segments -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Segments" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. + $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ + + + # Update Segment + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-Segment-Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-Segment -Id $Id -RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Segment" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } + "@ + + # Create new Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-ServiceDeskIntegration-ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # New-ServiceDeskIntegration -ServiceDeskIntegrationDto $ServiceDeskIntegrationDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "anId" # String | ID of Service Desk integration to delete + + # Delete a Service Desk integration + + try { + Remove-ServiceDeskIntegration-Id $Id + + # Below is a request that includes all optional parameters + # Remove-ServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "anId" # String | ID of the Service Desk integration to get + + # Get a Service Desk integration + + try { + Get-ServiceDeskIntegration-Id $Id + + # Below is a request that includes all optional parameters + # Get-ServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + + # Service Desk integration template by scriptName + + try { + Get-ServiceDeskIntegrationTemplate-ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-ServiceDeskIntegrationTemplate -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrationTemplate" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Service Desk integration types + + try { + Get-ServiceDeskIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-ServiceDeskIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrationTypes" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "name eq "John Doe"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List existing Service Desk integrations + + try { + Get-ServiceDeskIntegrations + + # Below is a request that includes all optional parameters + # Get-ServiceDeskIntegrations -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ServiceDeskIntegrations" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get the time check configuration + + try { + Get-StatusCheckDetails + + # Below is a request that includes all optional parameters + # Get-StatusCheckDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $PatchServiceDeskIntegrationRequest = @" + + "@ + + # Patch a Service Desk Integration + + try { + $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest + Update-ServiceDeskIntegration-Id $Id -PatchServiceDeskIntegrationRequest $Result + + # Below is a request that includes all optional parameters + # Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $PatchServiceDeskIntegrationRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "created" : "2024-01-17T18:45:25.994Z", + "description" : "A very nice Service Desk integration", + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "modified" : "2024-02-18T18:45:25.994Z", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "id" : "62945a496ef440189b1f03e3623411c8", + "beforeProvisioningRule" : "" + } + "@ + + # Update a Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-ServiceDeskIntegration-Id $Id -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # Send-ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $ServiceDeskIntegrationDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $QueuedCheckConfigDetails = @" + { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } + "@ + + # Update the time check configuration + + try { + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-StatusCheckDetails-QueuedCheckConfigDetails $Result + + # Below is a request that includes all optional parameters + # Update-StatusCheckDetails -QueuedCheckConfigDetails $QueuedCheckConfigDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-StatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Create SOD policy + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-SodPolicy-SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-SodPolicy -SodPolicy $SodPolicy + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-SodPolicy-Id $Id + + # Below is a request that includes all optional parameters + # Remove-SodPolicy -Id $Id -Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-SodPolicySchedule-Id $Id + + # Below is a request that includes all optional parameters + # Remove-SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. + + # Download custom violation report + + try { + Get-CustomViolationReport-ReportResultId $ReportResultId -FileName $FileName + + # Below is a request that includes all optional parameters + # Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CustomViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-DefaultViolationReport-ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-DefaultViolationReport -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # Get multi-report run task status + + try { + Get-SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-SodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodAllReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + + # Get SOD policy by ID + + try { + Get-SodPolicy-Id $Id + + # Below is a request that includes all optional parameters + # Get-SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + + # Get SOD policy schedule + + try { + Get-SodPolicySchedule-Id $Id + + # Below is a request that includes all optional parameters + # Get-SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + + # Get violation report run status + + try { + Get-SodViolationReportRunStatus-ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-SodViolationReportRunStatus -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + + # Get SOD violation report status + + try { + Get-SodViolationReportStatus-Id $Id + + # Below is a request that includes all optional parameters + # Get-SodViolationReportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) + + # List SOD policies + + try { + Get-SodPolicies + + # Below is a request that includes all optional parameters + # Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicies" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch SOD policy by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-SodPolicy-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-SodPolicy -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-PolicySchedule-Id $Id -SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-PolicySchedule -Id $Id -SodPolicySchedule $SodPolicySchedule + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-SodPolicy-Id $Id -SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-SodPolicy -Id $Id -SodPolicy $SodPolicy + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Evaluate one policy by ID + + try { + Start-EvaluateSodPolicy-Id $Id + + # Below is a request that includes all optional parameters + # Start-EvaluateSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-EvaluateSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + } + "@ + + # Runs all policies for org + + try { + Start-SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-SodAllPoliciesForOrg -MultiPolicyRequest $MultiPolicyRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-SodPolicy-Id $Id + + # Below is a request that includes all optional parameters + # Start-SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityWithNewAccess = @" + { + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-PredictSodViolations-IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-PredictSodViolations -IdentityWithNewAccess $IdentityWithNewAccess + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-PredictSodViolations" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $IdentityWithNewAccess1 = @" + {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} + "@ + + # Check SOD violations + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-ViolationCheck-IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-ViolationCheck -IdentityWithNewAccess1 $IdentityWithNewAccess1 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-ViolationCheck" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + $ProvisioningPolicyDto = @" + { + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + } + "@ + + # Create Provisioning Policy + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + New-ProvisioningPolicy-SourceId $SourceId -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # New-ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $ProvisioningPolicyDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Source = @" + { + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + } + "@ + $ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) + + # Creates a source in IdentityNow. + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + New-Source-Source $Result + + # Below is a request that includes all optional parameters + # New-Source -Source $Source -ProvisionAsCsv $ProvisionAsCsv + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Create Schema on Source + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + New-SourceSchema-SourceId $SourceId -Schema $Result + + # Below is a request that includes all optional parameters + # New-SourceSchema -SourceId $SourceId -Schema $Schema + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + # Delete Provisioning Policy by UsageType + + try { + Remove-ProvisioningPolicy-SourceId $SourceId -UsageType $UsageType + + # Below is a request that includes all optional parameters + # Remove-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Delete Source by ID + + try { + Remove-Source-Id $Id + + # Below is a request that includes all optional parameters + # Remove-Source -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + + # Delete Source Schema by ID + + try { + Remove-SourceSchema-SourceId $SourceId -SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Remove-SourceSchema -SourceId $SourceId -SchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + + # Downloads source accounts schema template + + try { + Get-AccountsSchema-Id $Id + + # Below is a request that includes all optional parameters + # Get-AccountsSchema -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/entitlements + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + + # Downloads source entitlements schema template + + try { + Get-EntitlementsSchema-Id $Id + + # Below is a request that includes all optional parameters + # Get-EntitlementsSchema -Id $Id -SchemaName $SchemaName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-EntitlementsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + + # Get Provisioning Policy by UsageType + + try { + Get-ProvisioningPolicy-SourceId $SourceId -UsageType $UsageType + + # Below is a request that includes all optional parameters + # Get-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Get Source by ID + + try { + Get-Source-Id $Id + + # Below is a request that includes all optional parameters + # Get-Source -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/connections + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + + # Get Source Connections by ID + + try { + Get-SourceConnections-Id $Id + + # Below is a request that includes all optional parameters + # Get-SourceConnections -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceConnections" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/source-health + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + + # Fetches source health by id + + try { + Get-SourceHealth-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-SourceHealth -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceHealth" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + + # Get Source Schema by ID + + try { + Get-SourceSchema-SourceId $SourceId -SchemaId $SchemaId + + # Below is a request that includes all optional parameters + # Get-SourceSchema -SourceId $SourceId -SchemaId $SchemaId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) + $IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional) + + # List Schemas on Source + + try { + Get-SourceSchemas-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-SourceSchemas -SourceId $SourceId -IncludeTypes $IncludeTypes -IncludeNames $IncludeNames + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SourceSchemas" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/accounts + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $File = # System.IO.FileInfo | (optional) + + # Uploads source accounts schema template + + try { + Import-AccountsSchema-Id $Id + + # Below is a request that includes all optional parameters + # Import-AccountsSchema -Id $Id -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-AccountsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/upload-connector-file + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $File = # System.IO.FileInfo | (optional) + + # Upload connector file to source + + try { + Import-ConnectorFile-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Import-ConnectorFile -SourceId $SourceId -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-ConnectorFile" + Write-Host $_.ErrorDetails + } +- path: /sources/{id}/schemas/entitlements + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id + $SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) + $File = # System.IO.FileInfo | (optional) + + # Uploads source entitlements schema template + + try { + Import-EntitlementsSchema-Id $Id + + # Below is a request that includes all optional parameters + # Import-EntitlementsSchema -Id $Id -SchemaName $SchemaName -File $File + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-EntitlementsSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id + + # Lists ProvisioningPolicies + + try { + Get-ProvisioningPolicies-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-ProvisioningPolicies -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ProvisioningPolicies" + Write-Host $_.ErrorDetails + } +- path: /sources + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "Employees"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **modified**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) + $ForSubadmin = "name" # String | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) + $IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false) + + # Lists all sources in IdentityNow. + + try { + Get-Sources + + # Below is a request that includes all optional parameters + # Get-Sources -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -ForSubadmin $ForSubadmin -IncludeIDNSource $IncludeIDNSource + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Sources" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $ProvisioningPolicyDto = @" + { + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + } + "@ + + # Update Provisioning Policy by UsageType + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $Source = @" + { + "cluster" : { + "name" : "Corporate Cluster", + "id" : "2c9180866166b5b0016167c32ef31a66", + "type" : "CLUSTER" + }, + "deleteThreshold" : 10, + "connectorId" : "active-directory", + "description" : "This is the corporate directory.", + "type" : "OpenLDAP - Direct", + "connectorClass" : "sailpoint.connector.LDAPConnector", + "connectionType" : "file", + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "passwordPolicies" : [ { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb053980", + "name" : "Corporate Password Policy" + }, { + "type" : "PASSWORD_POLICY", + "id" : "2c9180855d191c59015d291ceb057777", + "name" : "Vendor Password Policy" + } ], + "modified" : "2024-01-23T18:08:50.897Z", + "id" : "2c91808568c529c60168cca6f90c1324", + "connectorImplementationId" : "delimited-file", + "managerCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "owner" : { + "name" : "MyName", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "managementWorkgroup" : { + "name" : "My Management Workgroup", + "id" : "2c91808568c529c60168cca6f90c2222", + "type" : "GOVERNANCE_GROUP" + }, + "accountCorrelationRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "authoritative" : false, + "connectorAttributes" : { + "healthCheckTimeout" : 30, + "authSearchAttributes" : [ "cn", "uid", "mail" ] + }, + "created" : "2022-02-08T14:50:03.827Z", + "managerCorrelationMapping" : { + "accountAttributeName" : "manager", + "identityAttributeName" : "manager" + }, + "credentialProviderEnabled" : false, + "accountCorrelationConfig" : { + "name" : "Directory [source-62867] Account Correlation", + "id" : "2c9180855d191c59015d28583727245a", + "type" : "ACCOUNT_CORRELATION_CONFIG" + }, + "connector" : "active-directory", + "healthy" : true, + "schemas" : [ { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232a", + "name" : "account" + }, { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180835d191a86015d28455b4b232b", + "name" : "group" + } ], + "name" : "My Source", + "connectorName" : "Active Directory", + "category" : "CredentialProvider", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "RULE" + }, + "status" : "SOURCE_STATE_HEALTHY", + "since" : "2021-09-28T15:48:29.3801666300Z" + } + "@ + + # Update Source (Full) + + try { + $Result = ConvertFrom-JsonToSource -Json $Source + Send-Source-Id $Id -Source $Result + + # Below is a request that includes all optional parameters + # Send-Source -Id $Id -Source $Source + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $Schema = @" + { + "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], + "nativeObjectType" : "User", + "configuration" : { + "groupMemberAttribute" : "member" + }, + "created" : "2019-12-24T22:32:58.104Z", + "includePermissions" : false, + "name" : "account", + "hierarchyAttribute" : "memberOf", + "modified" : "2019-12-31T20:22:28.104Z", + "attributes" : [ { + "name" : "sAMAccountName", + "type" : "STRING", + "isMultiValued" : false, + "isEntitlement" : false, + "isGroup" : false + }, { + "name" : "memberOf", + "type" : "STRING", + "schema" : { + "type" : "CONNECTOR_SCHEMA", + "id" : "2c9180887671ff8c01767b4671fc7d60", + "name" : "group" + }, + "description" : "Group membership", + "isMultiValued" : true, + "isEntitlement" : true, + "isGroup" : true + } ], + "id" : "2c9180835d191a86015d28455b4a2329", + "displayAttribute" : "distinguishedName", + "identityAttribute" : "sAMAccountName" + } + "@ + + # Update Source Schema (Full) + + try { + $Result = ConvertFrom-JsonToSchema -Json $Schema + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/bulk-update + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $ProvisioningPolicyDto = @"{ + "name" : "example provisioning policy for inactive identities", + "description" : "this provisioning policy creates access based on an identity going inactive", + "fields" : [ { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + }, { + "isRequired" : false, + "transform" : { + "type" : "rule", + "attributes" : { + "name" : "Create Unique LDAP Attribute" + } + }, + "isMultiValued" : false, + "name" : "userName", + "attributes" : { + "template" : "${firstname}.${lastname}${uniqueCounter}", + "cloudMaxUniqueChecks" : "50", + "cloudMaxSize" : "20", + "cloudRequired" : "true" + }, + "type" : "string" + } ], + "usageType" : "CREATE" + }"@ + + + # Bulk Update Provisioning Policies + + try { + $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto + Update-ProvisioningPoliciesInBulk-SourceId $SourceId -ProvisioningPolicyDto $Result + + # Below is a request that includes all optional parameters + # Update-ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $ProvisioningPolicyDto + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ProvisioningPoliciesInBulk" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/provisioning-policies/{usageType} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Partial update of Provisioning Policy + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ProvisioningPolicy" + Write-Host $_.ErrorDetails + } +- path: /sources/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Source-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-Source -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Source" + Write-Host $_.ErrorDetails + } +- path: /sources/{sourceId}/schemas/{schemaId} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. + $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Source Schema (Partial) + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SourceSchema" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-StatusBySourceId-SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-StatusBySourceId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusBySourceId" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns source usage insights + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesBySourceId" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "ACCESS_PROFILE" # String | The type of object to delete tags from. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from. + + # Delete Object Tags + + try { + Remove-TaggedObject-Type $Type -Id $Id + + # Below is a request that includes all optional parameters + # Remove-TaggedObject -Type $Type -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-TaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/bulk-remove + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $BulkRemoveTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Remove Tags from Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject + Remove-TagsToManyObject-BulkRemoveTaggedObject $Result + + # Below is a request that includes all optional parameters + # Remove-TagsToManyObject -BulkRemoveTaggedObject $BulkRemoveTaggedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-TagsToManyObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. + + # Get Tagged Object + + try { + Get-TaggedObject-Type $Type -Id $Id + + # Below is a request that includes all optional parameters + # Get-TaggedObject -Type $Type -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-TaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "tagName eq "BU_FINANCE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) + + # List Tagged Objects + + try { + Get-TaggedObjects + + # Below is a request that includes all optional parameters + # Get-TaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-TaggedObjects" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "objectRef.id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) + + # List Tagged Objects by Type + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-TaggedObjectsByType" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/{type}/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Type = "ACCESS_PROFILE" # String | The type of tagged object to update. + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to update. + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Update Tagged Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TaggedObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $TaggedObject = @" + { + "objectRef" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Add Tag to Object + + try { + $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject + Set-TagToObject-TaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-TagToObject -TaggedObject $TaggedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-TagToObject" + Write-Host $_.ErrorDetails + } +- path: /tagged-objects/bulk-add + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $BulkAddTaggedObject = @" + { + "objectRefs" : [ { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + } ], + "operation" : "MERGE", + "tags" : [ "BU_FINANCE", "PCI" ] + } + "@ + + # Tag Multiple Objects + + try { + $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject + Set-TagsToManyObjects-BulkAddTaggedObject $Result + + # Below is a request that includes all optional parameters + # Set-TagsToManyObjects -BulkAddTaggedObject $BulkAddTaggedObject + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-TagsToManyObjects" + Write-Host $_.ErrorDetails + } +- path: /transforms + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Create transform + + try { + $Result = ConvertFrom-JsonToTransform -Json $Transform + New-Transform-Transform $Result + + # Below is a request that includes all optional parameters + # New-Transform -Transform $Transform + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Transform" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete + + # Delete a transform + + try { + Remove-Transform-Id $Id + + # Below is a request that includes all optional parameters + # Remove-Transform -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Transform" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve + + # Transform by ID + + try { + Get-Transform-Id $Id + + # Below is a request that includes all optional parameters + # Get-Transform -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Transform" + Write-Host $_.ErrorDetails + } +- path: /transforms + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional) + $Filters = "name eq "Uppercase"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) + + # List transforms + + try { + Get-Transforms + + # Below is a request that includes all optional parameters + # Get-Transforms -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Transforms" + Write-Host $_.ErrorDetails + } +- path: /transforms/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update + $Transform = @" + { + "name" : "Timestamp To Date", + "attributes" : { + "input" : { + "type" : "accountAttribute", + "attributes" : { + "attributeName" : "first_name", + "sourceName" : "Source" + } + }, + "accountSortAttribute" : "created", + "accountReturnFirstLink" : false, + "requiresPeriodicRefresh" : false, + "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", + "attributeName" : "DEPARTMENT", + "accountSortDescending" : false, + "sourceName" : "Workday", + "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" + }, + "type" : "dateFormat" + } + "@ + + # Update a transform + + try { + Update-Transform-Id $Id + + # Below is a request that includes all optional parameters + # Update-Transform -Id $Id -Transform $Transform + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Transform" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $VendorConnectorMapping = @" + { + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + } + "@ + + # Create Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + New-VendorConnectorMapping-VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # New-VendorConnectorMapping -VendorConnectorMapping $VendorConnectorMapping + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-VendorConnectorMapping" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $VendorConnectorMapping = @" + { + "createdAt" : "2024-03-13T12:56:19.391294Z", + "deletedAt" : { + "Valid" : false, + "Time" : "0001-01-01T00:00:00Z" + }, + "updatedBy" : { + "Valid" : true, + "String" : "user-67891" + }, + "connector" : "Example connector", + "createdBy" : "admin", + "vendor" : "Example vendor", + "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", + "deletedBy" : { + "Valid" : false, + "String" : "" + }, + "updatedAt" : { + "Valid" : true, + "Time" : "2024-03-14T12:56:19.391294Z" + } + } + "@ + + # Delete Vendor Connector Mapping + + try { + $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping + Remove-VendorConnectorMapping-VendorConnectorMapping $Result + + # Below is a request that includes all optional parameters + # Remove-VendorConnectorMapping -VendorConnectorMapping $VendorConnectorMapping + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-VendorConnectorMapping" + Write-Host $_.ErrorDetails + } +- path: /vendor-connector-mappings + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Vendor Connector Mappings + + try { + Get-VendorConnectorMappings + + # Below is a request that includes all optional parameters + # Get-VendorConnectorMappings + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-VendorConnectorMappings" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-WorkflowExecution-Id $Id + + # Below is a request that includes all optional parameters + # Suspend-WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $CreateExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + New-ExternalExecuteWorkflow-Id $Id + + # Below is a request that includes all optional parameters + # New-ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $CreateExternalExecuteWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $CreateWorkflowRequest = @" + {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-Workflow-CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-Workflow -CreateWorkflowRequest $CreateWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + New-WorkflowExternalTrigger-Id $Id + + # Below is a request that includes all optional parameters + # New-WorkflowExternalTrigger -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-WorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-Workflow-Id $Id + + # Below is a request that includes all optional parameters + # Remove-Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Get Workflow By Id + + try { + Get-Workflow-Id $Id + + # Below is a request that includes all optional parameters + # Get-Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-WorkflowExecution-Id $Id + + # Below is a request that includes all optional parameters + # Get-WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + + # Get Workflow Execution History + + try { + Get-WorkflowExecutionHistory-Id $Id + + # Below is a request that includes all optional parameters + # Get-WorkflowExecutionHistory -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + 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 + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Complete Workflow Library + + try { + Get-CompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-CompleteWorkflowLibrary -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Actions + + try { + Get-WorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Workflow Library Operators + + try { + Get-WorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-WorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Triggers + + try { + Get-WorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + + # List Workflows + + try { + Get-Workflows + + # Below is a request that includes all optional parameters + # Get-Workflows + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Workflow-Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-Workflow -Id $Id -JsonPatchOperation $JsonPatchOperation + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-Workflow-Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-Workflow -Id $Id -WorkflowBody $WorkflowBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-ExternalExecuteWorkflow-Id $Id + + # Below is a request that includes all optional parameters + # Test-ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $TestExternalExecuteWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-Workflow-Id $Id -TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-Workflow -Id $Id -TestWorkflowRequest $TestWorkflowRequest + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-Workflow" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/approve/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Approve an Approval Item + + try { + Approve-ApprovalItem-Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-approve/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk approve Approval Items + + try { + Approve-ApprovalItemsInBulk-Id $Id + + # Below is a request that includes all optional parameters + # Approve-ApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Complete a Work Item + + try { + Complete-WorkItem-Id $Id + + # Below is a request that includes all optional parameters + # Complete-WorkItem -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-WorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # Completed Work Items + + try { + Get-CompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-CompletedWorkItems -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/completed/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # Count Completed Work Items + + try { + Get-CountCompletedWorkItems + + # Below is a request that includes all optional parameters + # Get-CountCompletedWorkItems -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountCompletedWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/count + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) + + # Count Work Items + + try { + Get-CountWorkItems + + # Below is a request that includes all optional parameters + # Get-CountWorkItems -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CountWorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. + + # Get a Work Item + + try { + Get-WorkItem-Id $Id + + # Below is a request that includes all optional parameters + # Get-WorkItem -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # Work Items Summary + + try { + Get-WorkItemsSummary + + # Below is a request that includes all optional parameters + # Get-WorkItemsSummary -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItemsSummary" + Write-Host $_.ErrorDetails + } +- path: /work-items + method: GET + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) + + # List Work Items + + try { + Get-WorkItems + + # Below is a request that includes all optional parameters + # Get-WorkItems -Limit $Limit -Offset $Offset -Count $Count -OwnerId $OwnerId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkItems" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/reject/{approvalItemId} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. + + # Reject an Approval Item + + try { + Deny-ApprovalItem-Id $Id -ApprovalItemId $ApprovalItemId + + # Below is a request that includes all optional parameters + # Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItem" + Write-Host $_.ErrorDetails + } +- path: /work-items/bulk-reject/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + + # Bulk reject Approval Items + + try { + Deny-ApprovalItemsInBulk-Id $Id + + # Below is a request that includes all optional parameters + # Deny-ApprovalItemsInBulk -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-ApprovalItemsInBulk" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/forward + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $WorkItemForward = @" + { + "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", + "comment" : "I'm going on vacation.", + "sendNotifications" : true + } + "@ + + # Forward a Work Item + + try { + $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward + Send-WorkItemForward-Id $Id -WorkItemForward $Result + + # Below is a request that includes all optional parameters + # Send-WorkItemForward -Id $Id -WorkItemForward $WorkItemForward + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-WorkItemForward" + Write-Host $_.ErrorDetails + } +- path: /work-items/{id}/submit-account-selection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item + $RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName + + # Submit Account Selections + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Submit-AccountSelection-Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Submit-AccountSelection -Id $Id -RequestBody $RequestBody + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-AccountSelection" + Write-Host $_.ErrorDetails + }